store2 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 462d37b0c81d0e774272fa08c03f0525d7556a6f
-  data.tar.gz: b9f70df4a2d8b3f02ffdaa184bf9700a598e8d10
+  metadata.gz: f1fb7e50d7080a31af00eaab76aad6dbb8774f89
+  data.tar.gz: e9945689ec31a7df9d31b53d0ab435ac8f062b9d
 SHA512:
-  metadata.gz: db6596b207fa4d09bdcd3df0037095e8513de1dab9ee7930d50dac15cabf93f0c06884583ad2e53b5f11431bf73447e165a12eca251667274759faafc5d38581
-  data.tar.gz: 3f8af30002e9425e0804cbace7eb8ac1e15e1c8577ad62241c5b57198802c66da08b34587a7a4e53d9eb082e2905851cc8527ffae758c80556f9c3e9644d6d1b
+  metadata.gz: d0d209a20596ed072c6c1e22b900b21aed3079c77dd389448fbdf3d21eb4fe3365e16740c9efc139467c2096d40fed6bcaa87087830b4e455b41d710825515aa
+  data.tar.gz: c8e07eddbdccbbc7f83e4e10a48fdb27aa42f40397c7a3e6bbea215f97ffa1f140cef981c3032ae56bea3419aaa48af240d22f879feebf8e9f70c8844776accf

data/.gitignore

@@ -12,3 +12,5 @@
 *.o
 *.a
 mkmf.log
+test.yml
+test_other.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in store2.gemspec
 gemspec
+
+group :test do
+  gem "rspec"
+end

data/README.md

@@ -28,28 +28,28 @@ require "store2"
 
 ```ruby
 store2 = Store2.open("test.yml")
-# => <#Store2::File:0x00f28746a47 @filename = "test.yml">
+# => #<Store2::File:0x00f28746a47 @filename = "test.yml">
 ```
 
 ### Get root-scoped store object
 
 ```ruby
 root_scoped = store2.build
-# => <#Store2::Scoped:0x00f2d746a41 @keys = []>
+# => #<Store2::Scoped:0x00f2d746a41 @keys = []>
 ```
 
 ### Get scoped store object
 
 ```ruby
 user_scoped = store2.scoped("users", "72AC97F03A")
-# => <#Store2::Scoped:0x00a2d746a91 @keys = ["users", "72AC97F03A"]
+# => #<Store2::Scoped:0x00a2d746a91 @keys = ["users", "72AC97F03A"]
 ```
 
 ### Get scoped store object out of another scoped store object
 
 ```ruby
 items_scoped = user_scoped.scoped("items")
-# => <#Store2::Scoped:0x00922faa907 @keys = ["users", "72AC97F03A", "items"]
+# => #<Store2::Scoped:0x00922faa907 @keys = ["users", "72AC97F03A", "items"]
 ```
 
 ### Reading the value

data/lib/store2.rb

@@ -1,5 +1,13 @@
-require "store2/version"
+require "yaml"
+
+%w[
+  version
+
+  facade
+  file
+  scoped
+].each { |name| require "store2/#{name}" }
 
 module Store2
-  # Your code goes here...
+  extend Facade
 end

data/lib/store2/facade.rb

@@ -0,0 +1,17 @@
+module Store2
+  module Facade
+    def open(filename)
+      File.new(filename)
+    end
+
+    def _with_reset
+      _reset
+      yield
+      _reset
+    end
+
+    def _reset
+      File._reset
+    end
+  end
+end

data/lib/store2/file.rb

@@ -0,0 +1,88 @@
+module Store2
+  class File < Struct.new(:filename)
+    def initialize(*args)
+      super
+      @data = load
+      self.class.register(self)
+    end
+
+    def build
+      scoped
+    end
+
+    def scoped(*keys)
+      Scoped.new(self, keys)
+    end
+
+    def get(keys)
+      keys.inject(data) { |data, key| data.fetch(key) }
+    end
+
+    def set(keys, value)
+      get(keys[0...-1])[keys[-1]] = value
+    end
+
+    def has?(keys)
+      get(keys[0...-1]).has_key?(keys[-1])
+    end
+
+    def get_or_set(keys, value)
+      set(keys, value) unless has?(keys)
+      get(keys)
+    end
+
+    def fetch(keys, &block)
+      return block.call unless has?(keys)
+      get(keys)
+    end
+
+    def save
+      ::File.write(filename, to_yaml)
+    end
+
+    def _reset
+      create
+    end
+
+    protected
+
+    attr_reader :data
+
+    private
+
+    def load
+      return create unless ::File.exist?(filename)
+      YAML.load_file(filename)
+    end
+
+    def create
+      clear
+      save
+      data
+    end
+
+    def clear
+      @data = {}
+    end
+
+    def to_yaml
+      data.to_yaml
+    end
+  end
+
+  class << File
+    def register(instance)
+      instances << instance
+    end
+
+    def _reset
+      instances.each(&:_reset)
+    end
+
+    private
+
+    def instances
+      @_instances ||= []
+    end
+  end
+end

data/lib/store2/scoped.rb

@@ -0,0 +1,35 @@
+module Store2
+  class Scoped < Struct.new(:store, :scope)
+    def scoped(*keys)
+      Scoped.new(store, scope + keys)
+    end
+
+    def get(*keys)
+      store.get(scope + keys)
+    end
+
+    def set(*keys, value)
+      store.set(scope + keys, value)
+    end
+
+    def has?(*keys)
+      store.has?(scope + keys)
+    end
+
+    def get_or_set(*keys, value)
+      store.get_or_set(scope + keys, value)
+    end
+
+    def fetch(*keys, &block)
+      store.fetch(scope + keys, &block)
+    end
+
+    def save
+      store.save
+    end
+
+    def _reset
+      store._reset
+    end
+  end
+end

data/lib/store2/version.rb

@@ -1,3 +1,3 @@
 module Store2
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require "store2"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.around do |example|
+    Store2._with_reset do
+      example.run
+    end
+  end
+end

data/spec/store2/file_spec.rb

@@ -0,0 +1,110 @@
+module Store2
+  RSpec.describe File do
+    subject(:store) { File.new("test.yml") }
+
+    it "behaves like a value object" do
+      expect(store).to eq(File.new("test.yml"))
+      expect(store).not_to eq(File.new("test_other.yml"))
+      expect(store).not_to eq(nil)
+      expect(store).not_to eq(Object)
+      expect(store).not_to eq(Object.new)
+    end
+
+    describe "#build" do
+      it "builds root scoped store" do
+        expect(store.build).to eq(Scoped.new(store, []))
+      end
+    end
+
+    describe "#scoped" do
+      it "builds scoped store with passed keys" do
+        expect(store.scoped("users", "72AC97F03A")).to eq(
+          Scoped.new(store, ["users", "72AC97F03A"])
+        )
+      end
+    end
+
+    describe "#save" do
+      it "persists data" do
+        store.set(["my_secret"], {})
+        store.set(["my_secret", "password"], "is very secret")
+
+        store.save
+
+        expect(
+          File.new("test.yml").get(["my_secret", "password"])
+        ).to eq("is very secret")
+      end
+    end
+
+    describe "#get and #set" do
+      it "gets the value given list of keys" do
+        store.set(["hello"], {})
+        store.set(["hello", "world"], {})
+        store.set(["hello", "world", "test"], "12345")
+
+        expect(store.get(["hello", "world", "test"])).to eq("12345")
+      end
+    end
+
+    describe "#has?" do
+      it "is true if key is present" do
+        store.set(["hello"], {})
+        store.set(["hello", "world"], {})
+        store.set(["hello", "world", "test"], "12345")
+
+        expect(store.has?(["hello", "world", "test"])).to eq(true)
+      end
+
+      it "is false if key is not present" do
+        store.set(["hello"], {})
+        store.set(["hello", "world"], {})
+
+        expect(store.has?(["hello", "world", "test"])).to eq(false)
+      end
+    end
+
+    describe "#get_or_set" do
+      it "is current value if it is present" do
+        store.set(["hello"], {})
+        store.set(["hello", "world"], {})
+        store.set(["hello", "world", "test"], "09876")
+
+        expect(store.get_or_set(["hello", "world", "test"], "12345")).to eq("09876")
+      end
+
+      it "is default value if it is not present" do
+        store.set(["hello"], {})
+        store.set(["hello", "world"], {})
+
+        expect(store.get_or_set(["hello", "world", "test"], "12345")).to eq("12345")
+      end
+
+      it "makes the value present if it wasn't" do
+        store.set(["hello"], {})
+        store.set(["hello", "world"], {})
+        store.get_or_set(["hello", "world", "test"], "12345")
+
+        expect(store.get(["hello", "world", "test"])).to eq("12345")
+      end
+    end
+
+    describe "#fetch" do
+      it "behaves like get if value is present" do
+        store.set(["hello"], {})
+        store.set(["hello", "world"], {})
+        store.set(["hello", "world", "test"], "09876")
+
+        expect(store.fetch(["hello", "world", "test"]) { fail }).to eq("09876")
+      end
+
+      it "calls block if value is not present" do
+        store.set(["hello"], {})
+        store.set(["hello", "world"], {})
+
+        expect { store.fetch(["hello", "world", "test"]) { fail } }
+          .to raise_error(RuntimeError)
+      end
+    end
+  end
+end

data/spec/store2/scoped_spec.rb

@@ -0,0 +1,133 @@
+module Store2
+  RSpec.describe Scoped do
+    subject(:root) { Scoped.new(store, []) }
+    subject(:scoped) { Scoped.new(store, ["users", "72AC97F03A"]) }
+
+    let(:store) { File.new("test.yml") }
+    let(:other_store) { File.new("test_other.yml") }
+
+    before do
+      expect(root.get).to eq({})
+
+      root.set("users", { "72AC97F03A" => {} })
+    end
+
+    it "behaves like a value object" do
+      expect(root).to eq(Scoped.new(store, []))
+      expect(scoped).to eq(Scoped.new(store, ["users", "72AC97F03A"]))
+
+      expect(root).not_to eq(Scoped.new(store, ["hello"]))
+      expect(root).not_to eq(Scoped.new(other_store, []))
+
+      expect(root).not_to eq(nil)
+      expect(root).not_to eq(Object)
+      expect(root).not_to eq(Object.new)
+    end
+
+    describe "#scoped" do
+      it "builds further scoped " do
+        expect(root.scoped("items", "99A")).to eq(
+          Scoped.new(store, ["items", "99A"])
+        )
+
+        expect(scoped.scoped("items", "99A")).to eq(
+          Scoped.new(store, ["users", "72AC97F03A", "items", "99A"])
+        )
+      end
+    end
+
+    describe "#save" do
+      it "persists the data" do
+        scoped.set("items", { "123AA" => "sold" })
+
+        scoped.save
+
+        expect(
+          Scoped.new(File.new("test.yml"), ["users", "72AC97F03A"]).get("items", "123AA")
+        ).to eq("sold")
+      end
+    end
+
+    describe "#get and #set" do
+      it "gets the value given list of keys" do
+        scoped.set("hello", {})
+        scoped.set("hello", "world", {})
+        scoped.set("hello", "world", "test", "12345")
+
+        expect(scoped.get("hello", "world", "test")).to eq("12345")
+        expect(root.get("users", "72AC97F03A", "hello", "world", "test")).to eq("12345")
+      end
+    end
+
+    describe "#has?" do
+      it "is true if key is present" do
+        scoped.set("hello", {})
+        scoped.set("hello", "world", {})
+        scoped.set("hello", "world", "test", "12345")
+
+        expect(scoped.has?("hello", "world", "test")).to eq(true)
+        expect(root.has?("users", "72AC97F03A", "hello", "world", "test")).to eq(true)
+      end
+
+      it "is false if key is not present" do
+        scoped.set("hello", {})
+        scoped.set("hello", "world", {})
+
+        expect(scoped.has?("hello", "world", "test")).to eq(false)
+        expect(root.has?("users", "72AC97F03A", "hello", "world", "test")).to eq(false)
+      end
+    end
+
+    describe "#get_or_set" do
+      it "is current value if it is present" do
+        scoped.set("hello", {})
+        scoped.set("hello", "world", {})
+        scoped.set("hello", "world", "test", "09876")
+
+        expect(scoped.get_or_set("hello", "world", "test", "12345")).to eq("09876")
+        expect(root.get_or_set("users", "72AC97F03A", "hello", "world", "test", "12345")).to eq("09876")
+      end
+
+      it "is default value if it is not present" do
+        scoped.set("hello", {})
+        scoped.set("hello", "world", {})
+
+        expect(scoped.get_or_set("hello", "world", "test", "12345")).to eq("12345")
+        expect(root.get_or_set("users", "72AC97F03A", "hello", "world", "test", "12345")).to eq("12345")
+      end
+
+      it "makes the value present if it wasn't" do
+        scoped.set("hello", {})
+        scoped.set("hello", "world", {})
+        scoped.get_or_set("hello", "world", "test", "12345")
+
+        expect(scoped.get("hello", "world", "test")).to eq("12345")
+        expect(root.get("users", "72AC97F03A", "hello", "world", "test")).to eq("12345")
+      end
+    end
+
+    describe "#fetch" do
+      it "behaves like get if value is present" do
+        scoped.set("hello", {})
+        scoped.set("hello", "world", {})
+        scoped.set("hello", "world", "test", "09876")
+
+        expect(scoped.fetch("hello", "world", "test") { fail }).to eq("09876")
+        expect(root.fetch("users", "72AC97F03A", "hello", "world", "test") { fail }).to eq("09876")
+      end
+
+      it "calls block if value is not present" do
+        scoped.set("hello", {})
+        scoped.set("hello", "world", {})
+
+        expect {
+          scoped.fetch("hello", "world", "test") { fail }
+        }.to raise_error(RuntimeError)
+
+        expect {
+          root.fetch("users", "72AC97F03A", "hello", "world", "test") { fail }
+        }.to raise_error(RuntimeError)
+      end
+    end
+  end
+end

data/spec/store2_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe Store2 do
+  describe ".open" do
+    it "opens a file" do
+      expect(Store2.open("test.yml")).to eq(Store2::File.new("test.yml"))
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: store2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Oleksii Fedorov
@@ -46,12 +46,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/store2.rb
+- lib/store2/facade.rb
+- lib/store2/file.rb
+- lib/store2/scoped.rb
 - lib/store2/version.rb
+- spec/spec_helper.rb
+- spec/store2/file_spec.rb
+- spec/store2/scoped_spec.rb
+- spec/store2_spec.rb
 - store2.gemspec
 homepage: ''
 licenses:
@@ -77,4 +85,8 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Persistence in YAML files, yay!
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/store2/file_spec.rb
+- spec/store2/scoped_spec.rb
+- spec/store2_spec.rb