代碼

我們將會在本章實現我們的 mega_lotto 的核心代碼. 然而, 在我們開始之前, 我想要花些時間來討論一下 Ruby 的命名空間和從其他目錄加載 class 時可能發生的情況.

讓我們再次看看我們的 gem 的 API 風格:

MegaLotto::Drawing.new.draw # => [23, 22, 3, 7, 16]

命名空間

我不得不承認, 我建議從一個 Ruby gem 中學習命名空間是如何工作的. 因為我們給我們的gem命名為 mega_lotto, 相應的 Ruby 命名空間是 MegaLotto. 這是最佳實戰, 來避免和其它類庫的命名沖突.
假設名字 MegaLotto 是唯一的, 我們可以確定我們的代碼不會和其它gem的代碼沖突.

一般來說, 一個 Ruby 庫的文件名對應一個相同根命名空間的模塊/類的名字. 下面是幾個例子:

lib/mega_lotto/store.rb => MegaLotto::Store
lib/mega_lotto/lucky_ticket.rb => MegaLotto::LuckyTicket

注意: 命名代碼和模塊是困難的. 我最好的建議是跟隨單一職責原則并且創建只做一件事的文件/模塊, 并且把一件事做好.

包含代碼

記住, 默認情況下, bundler 為我們創建了 lib/mega_lotto.rb 文件.

require "mega_lotto/version"

module MegaLotto
  # Your code goes here...
end

其中, bundler 給我們創建了 MegaLotto 的命名空間并且建議我們的 gem 的代碼應該寫在這里面. 通常來說, 我們只會把配置和初始化代碼放在這個文件里, 把具體實現放在 /lib/mega_lotto 目錄中的其他類庫中.

注意這行:

require "mega_lotto/version"

當我們使用 bundler 初始化我們的 Ruby gem 時, bundler 創建了文件 lib/mega_lotto/version.rb:

module MegaLotto 
  VERSION = "0.0.1"
end

文件 lib/mega_lotto/version.rb 文件定義了一個常量 (VERSION) 來標志我們的 gem 的版本. 當我們發布新版時, 我們會增加 prior 的值來推送我們的新代碼到 Rubygems. 另外, 注意我們如何在文件 lib/mega_lotto/ 目錄中使用相對路徑來包含加載文件的.

實現

作為 Rubyists, 測試我們工作流程中必備的一部分. 測試不僅能保證我們的系統是可用的, 也保證了我們能寫出可維護的代碼. 我們知道我們的API的輸入和輸出, 所以我們可以從一個 spec 開始( spec/mega_lotto/drawing_spec.rb ) 來驅動我們的 Drawing 類的實現:

require "spec_helper"
module MegaLotto
describe Drawing do
    describe "#draw" do
        let(:draw) { MegaLotto::Drawing.new.draw }
        it "returns an array" do
            expect(draw).to be_a(Array)
        end
        it "returns an array with 6 elements" do
            expect(draw.size).to eq(6)
        end
        it "each element is an integer" do
            draw.each do |drawing|
                expect(drawing).to be_a(Integer)
            end
        end
        it "each element is less than 60" do
            draw.each do |drawing|
                expect(drawing).to be < 60
            end
        end
    end
end

簡單來說: 這個 spec 斷言 #draw 方法返回了一個 5 個整數組成的數組, 每一個整數都小于 60.

如果我們運行這個 spec, 我們會得到預期的錯誤:

/Users/bhilkert/Dropbox/code/mega_lotto/spec/mega_lotto/drawing_spec.rb:4:
in `<module:MegaLotto>`: uninitialized constant MegaLotto::Drawing (NameError)

邁著最小的步子來修復我們的失敗 spec, 讓我們在 lib/mega_lotto/drawing.rb 中創建 MegaLotto::Drawing 類 :

module MegaLotto 
  class Drawing 
  end
end

注意: 注意到 Drawing 類是如何在 MegaLotto 命名空間內部的? 文件 lib/mega_lotto.rb 定義了
MegaLotto 的根命名空間, 所以其它在 lib/mega_lotto/ 目錄下的類庫就會在MegaLotto命名空間下.

即使我們創建一個新的類 MegaLotto::Drawing, 我們的 gem 也還不知道它. gem里的文件不會被自動加載. 為了加載我們的 Drawing 類, 我們需要從 lib/mega_lotto.rb 這個入口文件中 require 它:

require "mega_lotto/version"
require "mega_lotto/drawing"

begin
    require "pry"
rescue LoadError
end

module MegaLotto
end

現在, 通過在宿主程序中包含 lib/mega_lotto.rb 入口文件, 我們可以得到在 lib/mega_lotto/drawing.rb 里的功能了!

If we re-run the spec for our Drawing class, we get the following:

如果我們重新運行 Drawing 類的 spec, 我們會得到下面的內容:

MegaLotto::Drawing
#draw
returns an array (FAILED - 1)
each element is less than 60 (FAILED - 2)
returns an array with 5 elements (FAILED - 3)
each element is an integer (FAILED - 4)
Failures:
1) MegaLotto::Drawing#draw returns an array
Failure/Error: let(:draw) { MegaLotto::Drawing.new.draw }
NoMethodError:
undefined method `draw` for #<MegaLotto::Drawing:0x007fef4b0bf198>
# ./spec/mega_lotto/drawing_spec.rb:6
# ./spec/mega_lotto/drawing_spec.rb:9
2) MegaLotto::Drawing#draw each element is less than 60
Failure/Error: let(:draw) { MegaLotto::Drawing.new.draw }
NoMethodError:
undefined method `draw` for #<MegaLotto::Drawing:0x007fef4b0bc510>
# ./spec/mega_lotto/drawing_spec.rb:6
# ./spec/mega_lotto/drawing_spec.rb:23
3) MegaLotto::Drawing#draw returns an array with 5 elements
Failure/Error: let(:draw) { MegaLotto::Drawing.new.draw }
NoMethodError:
undefined method `draw` for #<MegaLotto::Drawing:0x007fef4b0b5fd0>
# ./spec/mega_lotto/drawing_spec.rb:6
# ./spec/mega_lotto/drawing_spec.rb:13
4) MegaLotto::Drawing#draw each element is an integer
Failure/Error: let(:draw) { MegaLotto::Drawing.new.draw }
NoMethodError:
undefined method `draw` for #<MegaLotto::Drawing:0x007fef4b0b4270>
# ./spec/mega_lotto/drawing_spec.rb:6
# ./spec/mega_lotto/drawing_spec.rb:17
Finished in 0.00218 seconds
4 examples, 4 failures

每個失敗都是由于缺少一個 #drawing 方法, 所以讓我們加上它:

module MegaLotto
    class Drawing
        def draw
        end
    end
end

我們的 specs 顯示的信息不同了, 現在的失敗原因是缺少返回的數組:

MegaLotto::Drawing
#draw
returns an array (FAILED - 1)
each element is an integer (FAILED - 2)
returns an array with 5 elements (FAILED - 3)
each element is less than 60 (FAILED - 4)
Failures:
1) MegaLotto::Drawing#draw returns an array
Failure/Error: expect(draw).to be_a(Array)
expected nil to be a kind of Array
# ./spec/mega_lotto/drawing_spec.rb:9
2) MegaLotto::Drawing#draw each element is an integer
Failure/Error: draw.each do |drawing|
NoMethodError:
undefined method `each` for nil:NilClass
# ./spec/mega_lotto/drawing_spec.rb:17
3) MegaLotto::Drawing#draw returns an array with 5 elements
Failure/Error: expect(draw.size).to eq(5)
NoMethodError:
undefined method `size` for nil:NilClass
# ./spec/mega_lotto/drawing_spec.rb:13
4) MegaLotto::Drawing#draw each element is less than 60
Failure/Error: draw.each do |drawing|
NoMethodError:
undefined method `each` for nil:NilClass
# ./spec/mega_lotto/drawing_spec.rb:23
Finished in 0.00181 seconds
4 examples, 4 failures

從第一個失敗開始, 我們來給#draw方法返回一個空的數組, 再看看這會帶來什么結果:

module MegaLotto
    class Drawing
        def draw
            []
        end
    end
end

我們的 specs 的結果:

MegaLotto::Drawing
#draw
returns an array
returns an array with 5 elements (FAILED - 1)
each element is less than 60
each element is an integer
Failures:
1) MegaLotto::Drawing#draw returns an array with 5 elements
Failure/Error: expect(draw.size).to eq(5)
expected: 5
got: 0
(compared using ==)
# ./spec/mega_lotto/drawing_spec.rb:13:
in `block (3 levels) in <module:MegaLotto>`
Finished in 0.00773 seconds
4 examples, 1 failure

已知我們通過返回一個空的數組加入了一個無條理的實現, 讓我們通過返回一個5個元素的數組滿足最后一個失敗:

module MegaLotto
    class Drawing
        def draw
            Array.new(5)
        end
    end
end

我們的 spec 失敗現在產生了特定的關于數組的元素:

MegaLotto::Drawing
#draw
each element is less than 60 (FAILED - 1)
each element is an integer (FAILED - 2)
returns an array
returns an array with 5 elements
Failures:
1) MegaLotto::Drawing#draw each element is less than 60
Failure/Error: expect(drawing).to be < 60
NoMethodError:
undefined method `<` for nil:NilClass
# ./spec/mega_lotto/drawing_spec.rb:24
# ./spec/mega_lotto/drawing_spec.rb:23:in `each`
# ./spec/mega_lotto/drawing_spec.rb:23
2) MegaLotto::Drawing#draw each element is an integer
Failure/Error: expect(drawing).to be_a(Integer)
expected nil to be a kind of Integer
# ./spec/mega_lotto/drawing_spec.rb:18
# ./spec/mega_lotto/drawing_spec.rb:17:in `each`
# ./spec/mega_lotto/drawing_spec.rb:17
Finished in 0.00417 seconds
4 examples, 2 failures

現在讓我們返回0到60之間的數組而不是nil:

module MegaLotto
    class Drawing
        def draw
            5.times.map { single_draw }
        end
        private
        def single_draw
            rand(0...60)
        end
    end
end

現在看看我們的 specs, 可以看到我們滿足了要求:

MegaLotto::Drawing
#draw
each element is less than 60
returns an array
returns an array with 5 elements
each element is an integer
Finished in 0.00551 seconds
4 examples, 0 failures

萬歲! 讓我們提交我們的變更并且慶祝我們的新 gem。我們離發布更近了一步。

總結

驅動測試開發是一個很多 Rubyist 遵照的實踐。如果沒有測試的設置，先寫下你的測試通常會產出高質量可維護的代碼。我給了你我上面的工作流的感覺，但是不是所有的開發者都是一樣的。實驗你的工作流并且確定什么樣的適合你。雖然測試在開始花費額外的時間，但這樣的投資節省了讓我的頭疼的麻煩。我鼓勵你嘗試它如果你沒實踐過TDD。

在下一章, 我們將會看看 bundler 提供的 rake 任務是如何來幫助發布的。

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

構建一個 Ruby Gem 第四章代碼

構建一個 Ruby Gem 第四章代碼

代碼

命名空間

包含代碼

實現

總結

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美 国产 综合 欧美 视频

構建一個 Ruby Gem 第四章 代碼

代碼

命名空間

包含代碼

實現

總結

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

構建一個 Ruby Gem 第四章代碼