宫锁Ruby之Class（一）

前言：
前一段时间宫剧（《宫锁连城》）热播，老婆偶尔会看，并和我吐槽剧情的各种不靠谱以及虐心，感觉好比我在初学Ruby编程道路上遇到的各种问题。所以，将这个总结自己学习Ruby编程的文集命名为《宫锁Ruby》。
最后，引用《中国合伙人》中的台词：“在失败中寻找胜利，在绝望中寻求希望。”，激励一下自己。

下文中的代码我已经存储在了Dropbox，可以下载。

一、Class 定义（Definition）

还是回到这篇文章的主题吧。开始学习一个新的概念总要有个定义的，那就遵从惯例从定义开始。（注：惯例也体现在编程的过程中，例如，命名规则等。此外，对于另一个重要概念“惯例重于配置”还没有弄明白，理解后再进行补充、说明。）

还是回到正题，《Programming Ruby》中是这样对“类”进行描述的：

When you write object-oriented programs, you’re normally looking to model concepts from the real world. During this modeling process you’ll discover categories of things that need to be represented in code. In a jukebox, the concept of a “song” could be such a category. In Ruby, you’d define a class to represent each of these entities. A class is a combination of state (for example, the name of the song) and methods that use that state (perhaps a method to play the song).
--
*From:Dave Thomas, with Chad Fowler, Andy Hunt. Programming Ruby 1.9 & 2.0, P2.0 (Kindle Locations 777-780). The Pragmatic Bookshelf, LLC. *

在编写面向对象的代码时，通常你得根据真实世界对概念进行建模。在这个过程中，要挖掘出需要在代码中所表达的事物的种类。在点唱机系统（jukebox）中，“歌曲”的概念可能就是这么一个种类。在Ruby里，需要定义类（class）来表示实体。类是状态（state，比如歌曲名称）和使用这些状态的方法（method，可能是一个播放歌曲的方法）的组合。

引用自：《Programming Ruby中文版第二版》

二、BookStock 练习

最新英文版的《Programming Ruby》中，采用了一个名叫BookStock（书店）的例子对“类”的创建、协作进行演示，按照书上的步骤我完成了这个例子，对“类”和“实例”有了自己的一些理解。

以下所有代码版权归属：
Dave Thomas, with Chad Fowler, Andy Hunt. Programming Ruby 1.9 & 2.0

练习相关说明：

1. bookstock_data.csv

首先，默认我们手上有了一份关于书店图书信息的.CSV数据文件，即：bookstock_data.csv，内容如下：

"Date","ISBN","Price"
"2014-05-15","978-1-9343561-0-4","39.45"
"2014-05-11","978-1-9343561-6-6","45.76"
"2014-03-15","978-1-9343561-7-4","30. 15"

其中我们需要关注的主要是“ISBN”和“Price”（价格）两项数据内容。（关于.CSV后缀的文件请点击.CSV链接查看。）

2. book_in_stock.rb

第二，思考我们需要创建哪些类？即：得根据真实世界对概念进行建模，并挖掘出需要在代码中所表达的事物的种类。我总是试图一次性构想好所有需要建立的类，想得那叫一个纠结啊！
不如先将能够想到的必要的类构建好，JUST DO IT! 所以，将书店中的图书作为一个类是必不可少的。即：BookInStock类。根据书中的描述，我制作了 图书类 的概念图（请大牛批评指正）。如下：

class BookInStock
  attr_reader :isbn, :price

  def initialize(isbn, price)
    @isbn = isbn
    @price = Float(price)
  end

  def to_s
    "ISBN: #{@isbn}, price: #{@price}"
  end

  def price_in_cents
    Integer(price * 100 + 0.5)
  end

  def price_in_cents=(cents)
    @price = cents / 100.0
  end
end

每一个根据 图书类 创建的实例即：每一本书，都含有两个属性，ISBN 和 Price。以及其他方法和虚拟属性。

3. csv_reader.rb

第三，创建了 图书类 以后，我们需要考虑下如何根据 .CSV 中的数据创建 图书实例 ？我的第一想法是通过迭代，循环遍历.CSV 中每一行以逗号分割开的 ISBN 数据和 Price 数据，并根据这两个参数创建图书类。

伪代码如下：

open_.csv_file.do |row|
  [] << BookInStock.new(row["ISBN"], ["Price"])
end

实际的Ruby代码如下：

require 'csv'
require_relative 'book_in_stock'

class CsvReader
  def initialize
    @books_in_stock = []
  end

  def read_in_csv_data(csv_file_name)
    CSV.foreach(csv_file_name, headers: true) do |row|
      @books_in_stock << BookInStock.new(row["ISBN"], row["Price"])
    end
  end

  def total_value_in_stock
    sum = 0.0
    @books_in_stock.each {|book| sum += book.price}
    sum
  end
end

其实，最终目的是通过 .CSV 文件中的数据创建 图书实例 并将它们存储起来。那么，最好的容器就是数组。
个人觉得在这里比较重要的是，可以通过对比 book_in_stock.rb 和 csv_reader.rb 中的两个类，对“属性”、“实例变量”、“方法”，进行区分。

在创建类之初，我们会设定一些“内部状态”或者说“实例变量”。
通过方法暴露出来的外部状态，称之为“属性”。
类可以执行的其他动作，就是一般方法。

那么是否就可以说，CsvReader类中的@book_in_stock为内部状态，而非“属性” ？

4. stock_status.rb

最后，将一些逻辑放入 stock_status.rb 文件中。

require_relative 'csv_reader'
reader = CsvReader.new

ARGV.each do |csv_file_name|
  STDERR.puts "Processing #{csv_file_name}"
  reader.read_in_csv_data(csv_file_name)
end

puts "Total value = #{reader.total_value_in_stock}"

在命令行输入：
$ ruby stock_status.rb bookstock_data.csv

宫锁Ruby之Class（一）