schron 0.0.2

data/lib/schron/repository.rb

@@ -0,0 +1,35 @@
+require 'schron/query'
+require 'schron/archive'
+require 'schron/dsl'
+require 'schron/repository/interface'
+
+module Schron
+  module Repository
+    
+    include Schron::Archive::Interface
+    include Schron::Repository::Interface
+    
+    include Schron::Archive
+
+    def self.included(archive_class)
+      archive_class.extend Schron::DSL
+    end
+
+    def update(object)
+      maybe_load(@datastore.update(@kind, dump(object)))
+    end
+    
+    def multi_update(objects)
+      load_all(@datastore.multi_update(@kind, dump_all(objects)))
+    end
+
+    def remove(id)
+      @datastore.remove(@kind, id) && nil
+    end
+    
+    def multi_remove(ids)
+      @datastore.multi_remove(@kind, ids) && nil
+    end
+
+  end
+end

data/lib/schron/repository/interface.rb

@@ -0,0 +1,36 @@
+require 'schron/archive/interface'
+
+module Schron
+  module Repository
+    module Interface
+
+      include Schron::Archive::Interface
+
+      def update(object)
+        raise NotImplementedError
+      end
+
+      def multi_update(objects)
+        raise NotImplementedError
+      end
+      
+      def remove(id)
+        raise NotImplementedError
+      end
+
+      def multi_remove(ids)
+        raise NotImplementedError
+      end
+
+      def dump(object)
+        raise NotImplementedError
+      end
+
+      def load(attributes)
+        raise NotImplementedError
+      end
+
+
+    end
+  end
+end

data/lib/schron/test.rb

@@ -0,0 +1,22 @@
+Dir[File.join(__dir__, 'test', '**', '*.rb')].each do |f|
+  require f
+end
+
+module Schron
+  module Test
+    module_function
+    
+    def expect_same_ids(entity_set1, entity_set2)
+      ids1 = entity_set1.map(&:id)
+      ids2 = entity_set2.map(&:id)
+      expect(ids1.to_set).to eq(ids2.to_set)
+    end
+
+    def expect_same_entity(e1, e2)
+      expect(e1.id).to eq(e2.id)
+      expect(e1.attributes).to eq(e2.attributes)
+    end
+
+
+  end
+end

data/lib/schron/test/archive_examples.rb

@@ -0,0 +1,133 @@
+if defined?(RSpec)
+
+  require 'schron/query'
+  require 'schron/test'
+
+  # Be sure to set the archive before inclusion
+  # let(:archive) { ... }
+  shared_examples "schron archive" do
+    
+    include Schron::Test
+
+    let(:entity_class) { archive.entity_class }
+    
+    describe 'schron archive behavior' do
+
+      describe 'query' do
+        it 'yields a query with the archives database and kind' do
+          entity = archive.insert(entity_class.new)
+          expect(archive.datastore).to receive(:exec_query).and_call_original
+          results = archive.query do |q|
+            expect(q.kind).to eq(archive.kind)
+          end
+          expect_same_entity results.first, entity
+        end
+      end
+      
+      describe 'first' do
+        it 'yields a query, automatically adding limit 1 and returning the first result' do
+          entity = archive.insert(entity_class.new)
+          expect(archive.datastore).to receive(:exec_query).and_call_original
+          result = archive.first do |q|
+            expect(q.kind).to eq(archive.kind)
+          end
+          expect_same_entity result, entity
+        end
+      end
+
+      describe 'get' do
+        it 'returns nil when the id is not found' do
+          expect(archive.get('123')).to be_nil
+        end
+    
+        it 'does not call load if no data is found' do
+          expect(archive).not_to receive(:load)
+          expect(archive.get('123'))
+        end
+    
+        it 'returns the loaded object when present' do
+          david = archive.insert(entity_class.new(id: '1', name: 'david'))
+          expect_same_entity archive.get(david.id), david
+        end
+      end
+  
+      describe 'multi_get' do
+        it 'returns objects by id' do
+          entities = archive.multi_insert([
+            entity_class.new(a: '1'),
+            entity_class.new(b: '2')
+          ])
+
+          results = archive.multi_get(entities.map(&:id))
+          expect_same_ids results, entities
+        end
+    
+        it 'returns an empty array when given an empty array' do
+          expect_same_ids archive.multi_get([]), []
+        end
+    
+        it 'does not call load if no results are found' do
+          expect(archive).not_to receive(:load)
+          archive.multi_get(['123'])
+        end
+    
+        it 'returns an empty array when no ids are found' do
+          expect_same_ids archive.multi_get(['12']), []
+        end
+    
+        it 'ignores non existent ids mixed in with existing ones' do
+          a = archive.insert(entity_class.new)
+          results = archive.multi_get([a.id, 'made-up'])
+          expect_same_ids results, [a]
+        end
+      end
+
+      describe 'insert' do
+        it 'returns the inserted object with an id set when none is provided' do
+          object = archive.insert(entity_class.new)
+          expect(object.id).not_to be_nil
+          expect_same_entity archive.get(object.id), object
+        end
+
+        it 'returns the inserted object, using the id passed in when provided' do
+          object = archive.insert(entity_class.new(id: '23'))
+          expect(object.id).to eq('23')
+          expect_same_entity archive.get('23'), object
+        end
+      end
+
+      describe 'multi_insert' do
+        it 'returns the inserted objects, with ids set when none are provided' do
+          objects = archive.multi_insert([entity_class.new, entity_class.new])
+          objects.each do |object|
+            expect_same_entity archive.get(object.id), object
+          end
+        end
+        
+        it 'returns the inserted objects, using the id passed in if provided' do
+          objects = archive.multi_insert([
+            entity_class.new(id: '23'),
+            entity_class.new(id: 'shrike')
+          ])
+          expect(objects.map(&:id).to_set).to eq(Set.new(['23', 'shrike']))
+        end
+      end
+
+      describe 'load' do
+        it 'should pass the attributes to the constructor of the entity class' do
+          expect(archive.entity_class).to receive(:new).with({a: 'b', c: 'd'})
+          archive.load(a: 'b', c: 'd')
+        end
+      end
+  
+      describe 'dump' do
+        it 'should call attributes on the object' do
+          obj = double(attributes: {id: 3, name: 'david'})
+          hash = archive.dump(obj)
+          expect(hash).to eq(id: 3, name: 'david')
+        end
+      end
+    end
+  end
+
+end

data/lib/schron/test/datastore_examples.rb

@@ -0,0 +1,419 @@
+if defined?(RSpec)
+
+  require 'schron/query'
+  shared_examples 'schron datastore' do
+    let(:entity_kind) { :entities }
+    let(:named_kind) { :named }
+    let(:with_types_kind) { :with_types }
+  
+    describe 'datastore interface' do
+      describe 'get' do
+        it 'should return nil if no matching id is found' do
+          expect(ds.get(entity_kind, 'no-data')).to be_nil
+        end
+    
+        it 'should return the data if present' do
+          data = ds.insert(named_kind, {name: "dave"})
+          expect(ds.get(named_kind, data[:id])).to eq(name: "dave", id: data[:id])
+        end
+    
+        it 'should return a copy of the data' do
+          data = ds.insert(entity_kind, {})
+          data = ds.get(entity_kind, data[:id])
+          data[:change] = 'true'
+          expect(ds.get(entity_kind, data[:id])[:change]).to be_nil
+        end
+      end
+  
+      describe 'multi get' do
+        it 'should return an empty array if passed an empty array' do
+          expect(ds.multi_get(entity_kind, [])).to eq([])
+        end
+
+        it 'should return data by id' do
+          d1 = ds.insert(named_kind, {name: 'a'})
+          d2 = ds.insert(named_kind, {name: 'b'})
+          ids = [d1[:id], d2[:id]]
+          expect(ds.multi_get(named_kind, ids)).to include(d1, d2)
+        end
+    
+        it 'should not return nils when ids dont exist' do
+          d = ds.insert(entity_kind, {})
+          expect(ds.multi_get(entity_kind, ['no-data', d[:id]])).to eq([d])
+        end
+    
+        it 'should return copies of the data' do
+          data = ds.insert(entity_kind, {})
+          data_list = ds.multi_get(entity_kind, [data[:id]])
+          data_list.first[:changed] = 'true'
+          retrieved = ds.multi_get(entity_kind, data_list.map{ |d| d[:id] })
+          expect(retrieved).to eq([{id: data[:id]}])
+        end
+
+        it 'should return the data in the order of the requested ids' do
+          d1 = ds.insert(named_kind, {name: 'a'})
+          d2 = ds.insert(named_kind, {name: 'b'})
+          ids = [d1[:id], d2[:id]]
+          expect(ds.multi_get(named_kind, ids)).to eq([d1, d2])
+        end
+        
+      end
+  
+      describe 'insert' do
+        it 'should assign an id if none is provided' do
+          data = ds.insert(entity_kind, {})
+          expect(data[:id]).not_to be_nil
+        end
+    
+        it 'should use the provided id if present' do
+          data = ds.insert(entity_kind, {id: '123'})
+          expect(data[:id]).to eq('123')
+        end
+    
+        it 'should return a copy of the data' do
+          data = ds.insert(entity_kind, {})
+          data[:a] = 'b'
+          expect(ds.get(entity_kind, data[:id])[:a]).to be_nil
+        end
+    
+      end
+
+      describe 'multi insert' do
+        it 'inserts all the data and returns it' do
+          data = ds.multi_insert(named_kind, [{name: 'a'}, {name: 'b'}])
+          expect(data.map{ |d| d[:name] }).to include('a', 'b')
+          expect(data.size).to eq(2)
+        end
+
+        it 'assigns ids when none are provided' do
+          data = ds.multi_insert(entity_kind, [{}, {}])
+          expect(data.any?{ |d| d[:id].nil? }).to be(false)
+        end
+        
+        it 'uses provided ids when present' do
+          data = ds.multi_insert(entity_kind, [{id: '123'}, {id: '456'}])
+          expect(data.map{ |d| d[:id] }).to eq(['123', '456'])
+        end
+      end
+
+      describe 'update' do
+        it 'should raise an error if no id is provided' do
+          expect { ds.update(entity_kind, {}) }.to raise_error
+        end
+    
+        it 'should update the data by id' do
+          inserted = ds.insert(named_kind, {})
+          inserted[:name] = 'david'
+          updated = ds.update(named_kind, inserted)
+          expect(updated[:name]).to eq('david')
+          expect(updated[:id]).to eq(inserted[:id])
+        end
+
+        it 'should return a copy of the data' do
+          data = ds.insert(named_kind, {})
+          data = ds.update(named_kind, data.merge(name: 'joe'))
+          data[:c] = 'd'
+          expect(ds.get(named_kind, data[:id])[:c]).to be_nil
+        end
+      end
+
+      describe 'multi update' do
+        it 'raises an error if any ids are missing' do
+          expect do
+            ds.multi_update(entity_kind, [{id: '123'}, {}])
+          end.to raise_error
+        end
+        
+        it 'updates the data by ids' do
+          inserted = ds.multi_insert(named_kind, [{}, {}])
+          inserted[0][:name] = 'a'
+          inserted[1][:name] = 'b'
+          updated = ds.multi_update(named_kind, inserted)
+          expect(updated.map{ |d| d[:name] }.to_set).to eq(Set.new(['a', 'b']))
+          expect(updated.map{ |d| d[:id] }.to_set).to eq(Set.new(inserted.map{ |d| d[:id] }))
+        end
+
+        it 'returns copies of the data' do
+          data = ds.insert(named_kind, {})
+          data = ds.multi_update(named_kind, [data.merge(name: 'joe')]).first
+          data[:c] = 'd'
+          expect(ds.get(named_kind, data[:id])[:c]).to be_nil
+        end
+      end
+
+      describe 'remove' do
+        it 'should remove data from the store by id' do
+          data = ds.insert(entity_kind, {})
+          ds.remove(entity_kind, data[:id])
+          expect(ds.get(entity_kind, data[:id])).to be_nil
+        end
+    
+        it 'should return nil' do
+          data = ds.insert(entity_kind, {})
+          expect(ds.remove(entity_kind, data[:id])).to be_nil
+        end
+      end
+
+      describe 'multi remove' do
+        it 'should remove the data from the store by ids' do
+          data = ds.multi_insert(entity_kind, [{}, {}])
+          ids = data.map { |d| d[:id] }
+          ds.multi_remove(entity_kind, ids)
+          expect(ds.multi_get(entity_kind, ids)).to be_empty
+        end
+        
+        it 'should return nil' do
+          data = ds.insert(entity_kind, {})
+          expect(ds.multi_remove(entity_kind, [data[:id]])).to be_nil
+        end
+      end
+
+      describe 'exec query' do
+        let(:query) { Schron::Query.new(named_kind, ds) }
+        let(:no_result_query) { Schron::Query.new(entity_kind, ds) }
+        
+        before(:each) do
+          @c = ds.insert(named_kind, name: 'c')
+          @a1 = ds.insert(named_kind, name: 'a')
+          @b = ds.insert(named_kind, name: 'b')
+          @a2 = ds.insert(named_kind, name: 'a')
+          @nil = ds.insert(named_kind, {name: nil})
+        end
+        
+        describe 'filters' do
+          it 'filters by equality with a hash' do
+            found = query.filter(name: 'b').all
+            expect(found.size).to eq(1)
+            expect(found.first[:id]).to eq(@b[:id])
+          end
+          
+          it 'filters by inclusion with a hash' do
+            found = query.filter(name: ['b', 'c']).all
+            expect(found.size).to eq(2)
+            expect(found.map{ |h| h[:id] }).to include(@b[:id], @c[:id])
+          end
+          
+          it 'filters by "=" operator' do
+            found = query.filter(:name, '=', 'b').all
+            expect(found.size).to eq(1)
+            expect(found.first[:id]).to eq(@b[:id])
+          end
+
+          it 'filters by "in" operator' do
+            found = query.filter(:name, 'in', ['a', 'b']).all
+            expect(found.size).to eq(3)
+            expect(found.map{ |h| h[:id] }).to include(@a1[:id], @a2[:id], @b[:id])
+          end
+          
+          it 'filters by ">" operator' do
+            found = query.filter(:name, '>', 'a').all
+            expect(found.size).to be(2)
+            expect(found.map{ |h| h[:id] }).to include(@b[:id], @c[:id])
+          end
+
+          it 'filters by ">=" operator' do
+            found = query.filter(:name, '>=', 'a').all
+            expect(found.size).to be(4)
+            expect(found.map{ |h| h[:id] }).to include(@a1[:id], @a2[:id], @b[:id], @c[:id])
+          end
+
+          it 'filters by "<" operator' do
+            found = query.filter(:name, '<', 'b').all
+            expect(found.size).to be(2)
+            expect(found.map{ |h| h[:id] }).to include(@a1[:id], @a2[:id])
+          end
+
+          it 'filters by "<=" operator' do
+            found = query.filter(:name, '<=', 'b').all
+            expect(found.size).to be(3)
+            expect(found.map{ |h| h[:id] }).to include(@a1[:id], @a2[:id], @b[:id])
+          end
+          
+          it 'filters by "!=" operator' do
+            found = query.filter(:name, '!=', 'a').all
+            expect(found.size).to eq(3)
+            expect(found.map{ |h| h[:id] }).to include(@c[:id], @b[:id], @nil[:id])
+          end
+
+          it 'returns an empty list if no results match' do
+            expect(query.filter(name: '123').all).to eq([])
+          end
+
+          context 'nil filtering' do
+            it 'filters by = nil' do
+              found = query.filter(name: nil).all
+              expect(found.size).to eq(1)
+              expect(found.first[:id]).to eq(@nil[:id])
+            end
+            
+            it 'filters by != nil' do
+              found = query.filter(:name, '!=', nil).all
+              expect(found.size).to eq(4)
+              expect(found.map{ |h| h[:id] }).to include(@a1[:id], @a2[:id], @b[:id], @c[:id])
+            end
+            
+            it 'filters by in with nil' do
+              found = query.filter(:name, 'in', [nil, 'b']).all
+              expect(found.size).to eq(2)
+              expect(found.map{ |h| h[:id] }).to include(@b[:id], @nil[:id])
+            end
+          end
+        end
+
+        describe 'limit' do
+          it 'limits the results' do
+            found = query.limit(1).all
+            expect(found.size).to eq(1)
+          end
+          
+          it 'returns an empty list if no results match' do
+            q = no_result_query
+            expect(q.limit(2).all).to eq([])
+          end
+        end
+        
+        describe 'offset' do
+          it 'offsets the results' do
+            all = 4.times.reduce([]) do |ary, i|
+              ary + query.limit(1).offset(i).all
+            end
+            all_ids = all.map { |h| h[:id] }
+            expect(all_ids).to include(@a1[:id], @a2[:id], @b[:id], @c[:id])
+          end
+          
+          it 'returns an empty list if no results match' do
+            expect(query.offset(10).all).to eq([])
+          end
+        end
+
+        describe 'sorts' do
+          it 'sorts in asc direction by default' do
+            found = query.sort(:name).all
+            expect(found.map{ |h| h[:name] }).to eq(
+              [nil, 'a', 'a', 'b', 'c']
+            )
+          end
+          
+          it 'sorts ascending' do
+            found = query.sort(:name, :asc).all
+            expect(found.map{ |h| h[:name] }).to eq([nil, 'a', 'a', 'b', 'c'])
+          end
+          
+          it 'sorts descending' do
+            found = query.sort(:name, :desc).all
+            expect(found.map { |h| h[:name] }).to eq(['c', 'b', 'a', 'a', nil])
+          end
+          
+          it 'sorts by multiple fields' do
+            found = query.sort(:name).sort(:id).all
+            expected = [@nil[:id]] + [@a1[:id], @a2[:id]].sort + [@b[:id], @c[:id]]
+            expect(found.map { |h| h[:id] }).to eq(expected)
+          end
+
+          it 'returns an empty list if no results match' do
+            expect(no_result_query.sort(:id).all).to eq([])
+          end
+        end
+
+      end
+    end
+
+    describe 'datastore type handling' do
+
+      describe 'arrays' do
+        xit 'saves and loads empty arrays' do
+          data = ds.insert(with_types_kind, {
+            array: []
+          })
+          loaded = ds.get(with_types_kind, data[:id])
+          expect(loaded[:array]).to eq([])
+        end
+        xit 'stores and loads arrays of strings, numbers and arrays' do
+          data = ds.insert(with_types_kind, {
+            array: [1, "a", ["b"]]
+          })
+          loaded = ds.get(with_types_kind, data[:id])
+          expect(loaded[:array]).to eq([1, "a", ["b"]])
+        end
+      end
+
+      describe 'dates and times' do
+        xit 'saves and loads Date' do
+          data = ds.insert(with_types_kind, {
+            date: Date.new(2010, 10, 6)
+          })
+          loaded = ds.get(with_types_kind, data[:id])
+          expect(loaded[:date]).to eq(Date.new(2010, 10, 6))
+        end
+        
+        xit 'saves and loads Time' do
+          data = ds.insert(with_types_kind, {
+            time: Time.new(2013, 10, 6)
+          })
+          loaded = ds.get(with_types_kind, data[:id])
+          expect(loaded[:time]).to eq(Time.new(2013, 10, 6))
+        end
+        
+        xit 'saves and loads DateTime' do
+          data = ds.insert(with_types_kind, {
+            date_time: DateTime.new(2013, 10, 6)
+          })
+          loaded = ds.get(with_types_kind, data[:id])
+          expect(loaded[:date_time]).to eq(DateTime.new(2013, 10, 6))
+        end
+      end
+
+      describe 'sets' do
+        xit 'saves and loads Sets of numbers, strings and arrays' do
+          data = ds.insert(with_types_kind, {
+            set: Set.new([1, "2", ["a"]])
+          })
+          loaded = ds.get(with_types_kind, data[:id])
+          expect(loaded[:set]).to eq(Set.new([1, "2", ["a"]]))
+        end
+      end
+
+      describe 'nested hashes' do
+        xit 'saves and loads nested hashes' do
+          data = ds.insert(with_types_kind, {
+            hash: {a: {b: 'c'}, d: 3}
+          })
+          loaded = ds.get(with_types_kind, data[:id])
+          expect(loaded[:hash]).to eq({a: {b: 'c'}, d: 3})
+        end
+      end
+      
+      describe 'recursive structure' do
+        xit 'saves and loads' do
+          data = ds.insert(with_types_kind, {
+            name: 'score',
+            children: [
+              {name: 'diet', children: [
+                {name: 'eating'},
+                {name: 'not eating'}
+              ]},
+              {name: 'exercise', children: [
+                {name: 'workout'},
+                {name: 'sit'}
+              ]}
+            ]})
+          loaded = ds.get(with_types_kind, data[:id])
+          loaded.delete(:id)
+          expect(loaded).to eq({
+            name: 'score',
+            children: [
+              {name: 'diet', children: [
+                {name: 'eating'},
+                {name: 'not eating'}
+              ]},
+              {name: 'exercise', children: [
+                {name: 'workout'},
+                {name: 'sit'}
+              ]}
+            ]})
+        end
+      end
+    end
+  end
+
+end