gold_mine 1.0.0

data/lib/gold_mine/version.rb

@@ -0,0 +1,3 @@
+module GoldMine
+  VERSION="1.0.0" unless defined? GoldMine::VERSION
+end

data/spec/gold_mine/db_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe GoldMine::DB do
+  add_temp_file
+  subject { GoldMine::DB.new(path: temp_file.path) }
+
+  describe "#initialize" do
+    subject {  GoldMine::DB.new }
+    let(:path) { subject.instance_variable_get("@path") }
+    let(:options) { subject.instance_variable_get("@options") }
+
+    context "without a :path option" do
+      it "assigns built-in database path to the @path" do
+        default_path = File.expand_path("../../../fortunes/fortunes", __FILE__)
+        expect(path).to eq(default_path)
+      end
+    end
+
+    context "without a :delim option" do
+      it "assigns default delimiter to the :delim option" do
+        expect(options[:delim]).to eq("%")
+      end
+    end
+  end
+
+  describe "#random" do
+    temp_file <<-EOF.gsub(/^ {6}/, "")
+      "His mind is like a steel trap ― full of mice."
+              ― Foghorn Leghorn
+      %
+      "Humor is a drug which it's the fashion to abuse."
+              ― William Gilbert
+    EOF
+
+    it "returns the instance of fortune class" do
+      expect(subject.random).to be_a(GoldMine::Fortune)
+    end
+
+    it "returns the random fortune" do
+      results = []
+      1000.times { results << subject.random }
+      expect(results.uniq.size).to be > 1
+    end
+  end
+
+  describe "#fortunes" do
+    temp_file <<-EOF.gsub(/^ {6}/, "")
+      "Deliver yesterday, code today, think tomorrow."
+      %
+      "Die? I should say not, dear fellow. No Barrymore would allow such a
+      conventional thing to happen to him."
+              ― John Barrymore's dying words
+      %
+      "Do not stop to ask what is it;
+       Let us go and make our visit."
+              ― T. S. Eliot, "The Love Song of J. Alfred Prufrock"
+    EOF
+
+    it "returns the array with fortune instances" do
+      array = subject.fortunes.map { |f| f.is_a?(GoldMine::Fortune) }
+      expect(array).to_not include(false)
+    end
+
+    it "returns properly formated fortunes" do
+      expect(subject.fortunes.first.content).to eq("\"Deliver yesterday, code today, think tomorrow.\"")
+    end
+
+    it "returns all fortunes from a database" do
+      expect(subject.fortunes.size).to eq(3)
+    end
+  end
+end

data/spec/gold_mine/fortune_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe GoldMine::Fortune do
+  describe "#initialize" do
+    context "with content" do
+      subject do
+        GoldMine::Fortune.new <<-EOF.gsub(/^ {10}/, "")
+          I hate quotations.
+                  ― Ralph Waldo Emerson
+        EOF
+      end
+
+      it "assigns a text without attribution to the @content" do
+        expect(subject.instance_variable_get("@content")).to eq("I hate quotations.\n")
+      end
+
+      it "assigns an attribution to the @attribution" do
+        expect(subject.instance_variable_get("@attribution")).to eq("Ralph Waldo Emerson")
+      end
+    end
+  end
+
+  describe "#to_s" do
+    shared_examples "a formatting" do |format|
+      it "returns the string in the correct format" do
+        expect(subject.to_s).to eq(format)
+      end
+    end
+
+    context "when a content is empty and an attribution is empty" do
+      it "returns the empty string" do
+        expect(subject.to_s).to eq("")
+      end
+    end
+
+    context "when a content is empty and an attribution is not empty" do
+      before { subject.instance_variable_set("@attribution", "Yogi Berra") }
+
+      it "returns the empty string" do
+        expect(subject.to_s).to eq("")
+      end
+    end
+
+    context "when a content is not empty and an attribution is empty" do
+      before { subject.instance_variable_set("@content", "You can observe a lot just by watching.") }
+
+      include_examples "a formatting", <<-EOS.gsub(/^ {8}/, "")
+
+        You can observe a lot just by watching.
+
+      EOS
+    end
+
+    context "when an content is not empty and an attribution is not empty" do
+      before do
+        subject.instance_variable_set("@attribution", "Yogi Berra")
+        subject.instance_variable_set("@content", "You can observe a lot just by watching.")
+      end
+
+      include_examples "a formatting", <<-EOS.gsub(/^ {8}/, "")
+
+        You can observe a lot just by watching.
+                ― Yogi Berra
+
+      EOS
+    end
+  end
+end

data/spec/gold_mine/index_reader.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe GoldMine::IndexReader do
+  add_temp_file
+  subject { described_class.new(temp_file.path) }
+
+  INDEX_HEADER = {
+    version: 2,
+    numstr: 3,
+    longlen: 612,
+    shortlen: 28,
+    flags: 0,
+    delim: 37
+  }
+
+  temp_file (INDEX_HEADER.values + [0, 12, 154]).pack("N*")
+
+  describe "#initialize" do
+    it "assigns a path to the @path" do
+      expect(subject.instance_variable_get("@path")).to eq(temp_file.path)
+    end
+  end
+
+  describe "#header_fields" do
+    it "returns an array of each value extracted" do
+      expect(subject.header_fields).to be_instance_of(Array)
+    end
+
+    it "returns an array including six elements" do
+      expect(subject.header_fields.size).to eq(6)
+    end
+
+    INDEX_HEADER.each_with_index do |(element, value), index|
+      it "returns an array where element at #{index+1} position is a #{element}" do
+        expect(subject.header_fields[index]).to eq(value)
+      end
+    end
+  end
+
+  describe "#get_pointers" do
+    it "returns an array instance" do
+      expect(subject.get_pointers).to be_instance_of(Array)
+    end
+
+    it "extracts pointers from index file" do
+      expect(subject.get_pointers).to eq([0, 12, 154])
+    end
+  end
+
+  describe "#get_pointer_at" do
+    it "returns pointer by index" do
+      expect(subject.get_pointer_at(1)).to eq(12)
+    end
+  end
+
+  describe "#random_pointer" do
+    it "returns random pointer" do
+      results = []
+      1000.times { results << subject.random_pointer }
+      expect(results.uniq.size).to be > 1
+    end
+  end
+end

data/spec/gold_mine/index_writer_spec.rb

@@ -0,0 +1,202 @@
+require "spec_helper"
+require "tmpdir"
+
+describe GoldMine::IndexWriter do
+  add_temp_file
+  subject { described_class.new(temp_file.path) }
+
+  describe "#initialize" do
+    let(:options) { subject.instance_variable_get("@options") }
+
+    context "without an options" do
+      it "assigns default options to @options" do
+        default_options = {
+          version: 2,
+          delim: "%",
+          randomized: false,
+          ordered: false,
+          rotated: false,
+          comments: false
+        }
+        expect(options).to eq(default_options)
+      end
+    end
+
+    context "with an options" do
+      subject { described_class.new(temp_file.path, version: 12) }
+
+      it "merged them with the default options" do
+        expect(options[:version]).to eq(12)
+      end
+    end
+
+    it "assings to @shortlen very high number" do
+      shortlen = subject.instance_variable_get("@shortlen")
+      expect(shortlen).to be >= 99999
+    end
+
+    context "with an :ordered option and a :randomized option" do
+      subject { described_class.new(temp_file.path, randomized: true, ordered: true) }
+
+      it "excludes :randomized" do
+        flags = subject.instance_variable_get("@flags")
+        expect(flags[:randomized]).to be_false
+      end
+    end
+  end
+
+  describe "#load_pointers" do
+    temp_file <<-EOF.gsub(/^ {6}/, "")
+      %
+      I Like Facebook
+      %
+      "I see fire"
+              -- Ed Sheeran
+      %
+      CTSG
+    EOF
+
+    let(:load_pointers) { subject.load_pointers }
+
+    context "when :comments option is true" do
+      subject { described_class.new(temp_file.path, comments: true) }
+
+      temp_file <<-EOF.gsub(/^ {8}/, "")
+        %% It's new!
+        "Be or not to be"
+        %% What?!
+                -- Shakespeare
+        %
+        %% Todo: Change it!
+      EOF
+
+      describe "omits lines starting with double delimeter" do
+        it { expect(load_pointers.size).to eq(1) }
+        it { expect(load_pointers[0][0]).to eq(13) }
+      end
+    end
+
+    it "returns the array with correct size" do
+      expect(load_pointers.size).to eq(3)
+    end
+
+    it "assings end of file position to @eof" do
+      expect(subject.instance_variable_get("@eof")).to eq(62)
+    end
+
+    it "assings length of shortest fortune to @shortlen" do
+      expect(subject.instance_variable_get("@shortlen")).to eq(5)
+    end
+
+    it "assings length of longest fortune to @longlen" do
+      expect(subject.instance_variable_get("@longlen")).to eq(35)
+    end
+
+    describe "loads a fortune as an array" do
+      it { expect(load_pointers.sample).to be_a(Array) }
+
+      it "where first element is a correct pointer" do
+        expect(load_pointers[1][0]).to eq(20)
+      end
+
+      it "where second element is a first character" do
+        expect(load_pointers[0][1]).to eq("I")
+      end
+
+      it "even when is first and preceded by a delimeter" do
+        expect(load_pointers[0][0]).to eq(2)
+      end
+
+      it "even when is located at the bottom of the file" do
+        expect(load_pointers[2][0]).to eq(57)
+      end
+    end
+  end
+
+  describe "#order_pointers!" do
+    it "organizes @pointers alphabetically" do
+      subject.instance_variable_set("@pointers", [[23, "S"], [43, "A"], [61, "Z"]])
+      subject.order_pointers!
+      expect(subject.instance_variable_get("@pointers")).to eq([[43, "A"], [23, "S"], [61, "Z"]])
+    end
+  end
+
+  describe "#shuffle_pointers!" do
+    it "shuffles @pointers" do
+      input = [[0, "A"], [1, "B"], [2, "C"]]
+      subject.instance_variable_set("@pointers", input)
+      subject.shuffle_pointers!
+      expect(subject.instance_variable_get("@pointers")).to_not eq(input)
+    end
+  end
+
+  describe "#write" do
+    context "when @index_path is presence" do
+      before do
+        subject.instance_variable_set("@index_path", Dir.tmpdir + "/custom.dat")
+      end
+
+      it "saves a file at @index_path" do
+        subject.write
+        expect(File.exists?(subject.instance_variable_get("@index_path"))).to be_true
+      end
+    end
+
+    context "when @index_path is not presence" do
+      it "savas a file at @path.dat" do
+        subject.write
+        expect(File.exists?(subject.instance_variable_get('@path') + ".dat")).to be_true
+      end
+    end
+  end
+
+  describe "#offsets" do
+    it "returns offsets from @pointers" do
+      subject.instance_variable_set("@pointers", [[0, "A"], [1, "B"]])
+      expect(subject.offsets).to eq([0, 1])
+    end
+  end
+
+  describe "#packed_pointers" do
+    describe "packs offsets into binary sequence" do
+      it "32-bit unsigned and big-endian" do
+        subject.instance_variable_set("@pointers", [[0, "A"], [22, "B"], [30, "C"]])
+        expect(subject.packed_pointers).to eq("\x00\x00\x00\x00\x00\x00\x00\x16\x00\x00\x00\x1E")
+      end
+    end
+  end
+
+  describe "#packed_eof" do
+    describe "packs @eof into binary sequence" do
+      it "as 32-bit unsigned big-endian" do
+        subject.instance_variable_set("@eof", 100)
+        expect(subject.packed_eof).to eq("\x00\x00\x00d")
+      end
+    end
+  end
+
+  describe "#packed_header" do
+    before do
+      subject.instance_variable_set("@version", 2)
+      subject.instance_variable_set("@numstr", 23)
+      subject.instance_variable_set("@longlen", 31)
+      subject.instance_variable_set("@shortlen", 7)
+      subject.instance_variable_set("@flags", 0)
+      subject.instance_variable_set("@delim", "%")
+    end
+
+    describe "packs header into binary sequence with big-endian convention where" do
+      let(:unpacked_header) { subject.packed_header.unpack("N*") }
+
+      ["version", "numstr", "longlen", "shortlen", "flags"].each_with_index do |e, i|
+        it "#{i+1} element is a 32-bit unsigned integer representing #{e}" do
+          expect(unpacked_header[i]).to eq(subject.instance_variable_get("@#{e}"))
+        end
+      end
+
+      it "6 element is a 32-bit integer representing delim" do
+        expect(unpacked_header[5]).to eq(subject.instance_variable_get("@delim").ord << 24)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+Bundler.setup
+
+%w{gold_mine}.each { |x| require x }
+
+Dir[GoldMine.base_dir.join("spec", "support", "**", "*.rb")].each { |f| require f }
+
+RSpec.configure do |c|
+  c.include TempFile
+  c.mock_with :rspec
+end

data/spec/support/temp_file.rb

@@ -0,0 +1,25 @@
+require "tempfile"
+
+module TempFile
+  def self.included(example_group)
+    example_group.extend(self)
+  end
+
+  def add_temp_file
+    let(:temp_file) do
+      Tempfile.new("gold_mine")
+    end
+  end
+
+  def temp_file(content = "")
+    before do
+      temp_file.open
+      temp_file.write(content)
+      temp_file.close
+    end
+
+    after do
+      temp_file.unlink
+    end
+  end
+end