rmodel 0.1.0 → 0.2.0.pre.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d6692638747de91e5cb796e6141d501bca570af
-  data.tar.gz: 5a80109b93f41f8bd2c68ae110420c8b9d20ab8c
+  metadata.gz: 44999ed4c612599521faacd1a1f596d4a2df3d6a
+  data.tar.gz: 550ec35f4c18a10085fe3e9db5551d4e284fca6b
 SHA512:
-  metadata.gz: 468a0b7cefbf30b51321ec32707dd86ef377bba8f0a0238e3f63b43603acec73ac87beefc1f67ddffc80effda796352bd961aec65151fd86d0c2bb0faa3d51a6
-  data.tar.gz: 28cd0af645f741b54336d2da76ea76833f0bfa1e4f5ed069804a58f98f5381672a3bbbc58cae72a294cd944cac3332e0cb208386c808f7bdb4a73b72ee8ddcc4
+  metadata.gz: 7e29bbc798c026d05c25cfa267cbdc635843b6961d031f957a3746673768d6553c93dfbdd63ce93f3184bffb2c7b6a749c264910a517c9f6834d0e7e2f653a05
+  data.tar.gz: 78423c914c99491860007d0d59a9b4b7f2850c3dcccec63d4da249d5ca483416f5f420d2114c929a68bbf66f94d343c242cae00989c26fd74c6c9b9332dca89f

data/README.md

@@ -2,8 +2,18 @@
 
 # Rmodel
 
+* [Installation](#installation)
+* [Usage](#usage)
+  * [CRUD](#crud)
+  * [Scopes](#scopes)
+  * [Timestamps](#timestamps)
+  * [Sugar methods](#sugar-methods)
+  * [Advanced creation of repository](#advanced-creation-of-repository)
+
 Rmodel is an ORM library, which tends to follow the SOLID principles.
 
+**Currently works with MongoDB only.**
+
 The main thoughts behind it are:
 
 * let you models be simple and independent of the persistent layer,
@@ -116,7 +126,6 @@ userRepository.remove(bob)
 
 p userRepository.find(john.id) # #<User:0x000000037237d0 @name="John Smith" ... >
 p userRepository.find(bob.id) # nil
-p userRepository.find!(bob.id) # raises Rmodel::NotFound
 ```
 
 ### Scopes
@@ -184,6 +193,41 @@ p thing.updated_at
 
 To enable time tracking  just add attributes `created_at` and `updated_at` or one of them to your entity.
 
+### Sugar methods
+
+```ruby
+repo.save(thing)
+repo.find!(1)
+```
+
+The `save` method can be used instead of `insert` and `update`.
+If the object has no not-nil id then it gets inserted. Otherwise it gets updated.
+
+The `find!` method works like the simple `find`
+, but instead of nil it raises the Rmodel::NotFound error.
+
+### Advanced creation of repository
+
+```ruby
+require 'rmodel'
+
+class Thing
+  attr_accessor :id, :name
+end
+
+class ThingRepository < Rmodel::Mongo::Repository
+end
+
+client = Mongo::Client.new([ 'localhost:27017' ], database: 'test')
+collection = :things
+factory = Rmodel::Mongo::SimpleFactory.new(Thing, :name)
+
+repo = ThingRepository.new(client, collection, factory)
+repo.find(1)
+```
+
+The `factory` is an object, which has 2 methods: `#fromHash(hash)` and `#toHash(object)`.
+
 ## Contributing
 
 1. Fork it ( https://github.com/alexei-lexx/rmodel/fork )

data/examples/advanced_creation_of_repository.rb

@@ -0,0 +1,15 @@
+require 'rmodel'
+
+class Thing
+  attr_accessor :id, :name
+end
+
+class ThingRepository < Rmodel::Mongo::Repository
+end
+
+client = Mongo::Client.new([ 'localhost:27017' ], database: 'test')
+collection = :things
+factory = Rmodel::Mongo::SimpleFactory.new(Thing, :name)
+
+repo = ThingRepository.new(client, collection, factory)
+p repo.find(1)

data/lib/rmodel/base/repository.rb

@@ -0,0 +1,12 @@
+require 'rmodel/base/repository_ext/sugarable'
+require 'rmodel/base/repository_ext/timestampable'
+
+module Rmodel::Base
+  class Repository
+    include RepositoryExt::Sugarable
+
+    def self.inherited(subclass)
+      subclass.prepend RepositoryExt::Timestampable
+    end
+  end
+end

data/lib/rmodel/base/repository_ext/sugarable.rb

@@ -0,0 +1,17 @@
+module Rmodel::Base
+  module RepositoryExt
+    module Sugarable
+      def find!(id)
+        find(id) or raise Rmodel::NotFound.new(self, { id: id })
+      end
+
+      def save(object)
+        if object.id.nil?
+          insert(object)
+        else
+          update(object)
+        end
+      end
+    end
+  end
+end

data/lib/rmodel/{mongo → base}/repository_ext/timestampable.rb

@@ -1,7 +1,6 @@
-module Rmodel::Mongo
+module Rmodel::Base
   module RepositoryExt
     module Timestampable
-
       def insert(object)
         if object.respond_to?(:created_at) && object.respond_to?(:created_at=)
           object.created_at ||= Time.now

data/lib/rmodel/mongo/repository.rb

@@ -1,22 +1,21 @@
 require 'mongo'
+require 'rmodel/base/repository'
 require 'active_support/inflector'
 require 'rmodel/mongo/repository_ext/queryable'
-require 'rmodel/mongo/repository_ext/timestampable'
 
 module Rmodel::Mongo
-  class Repository
+  class Repository < Rmodel::Base::Repository
     include RepositoryExt::Queryable
-    prepend RepositoryExt::Timestampable
 
-    def initialize
-      @client = Rmodel.setup.establish_mongo_client(self.class.client_name || :default) or
+    def initialize(client = nil, collection = nil, factory = nil)
+      @client = client || Rmodel.setup.establish_mongo_client(self.class.client_name || :default) or
                 raise ArgumentError.new('Client driver is not setup')
 
-      @collection = self.class.setting_collection ||
+      @collection = collection || self.class.setting_collection ||
                     self.class.collection_by_convention or
                     raise ArgumentError.new('Collection can not be guessed')
 
-      @factory = self.class.setting_factory or
+      @factory = factory || self.class.setting_factory or
                  raise ArgumentError.new('Factory can not be guessed')
     end
 
@@ -25,10 +24,6 @@ module Rmodel::Mongo
       result && @factory.fromHash(result)
     end
 
-    def find!(id)
-      find(id) or raise Rmodel::NotFound.new(self, { id: id })
-    end
-
     def insert(object)
       object.id ||= BSON::ObjectId.new
       @client[@collection].insert_one(@factory.toHash(object, true))

data/lib/rmodel/version.rb

@@ -1,3 +1,3 @@
 module Rmodel
-  VERSION = "0.1.0"
+  VERSION = "0.2.0-dev"
 end

data/spec/rmodel/mongo/repository_crud_spec.rb

@@ -3,16 +3,11 @@ RSpec.describe Rmodel::Mongo::Repository do
 
   before do
     stub_const('User', Struct.new(:id, :name, :email))
-    stub_const('UserRepository', Class.new(Rmodel::Mongo::Repository) {
-      simple_factory User, :name, :email
-    })
-    Rmodel.setup do
-      client :default, hosts: [ 'localhost' ], database: 'rmodel_test'
-    end
+    stub_const('UserRepository', Class.new(Rmodel::Mongo::Repository))
   end
 
   let(:factory) { Rmodel::Mongo::SimpleFactory.new(User, :name, :email) }
-  subject(:repo) { UserRepository.new }
+  subject(:repo) { UserRepository.new(mongo_session, :users, factory) }
 
   describe '#find' do
     context 'when an existent id is given' do
@@ -32,26 +27,6 @@ RSpec.describe Rmodel::Mongo::Repository do
     end
   end
 
-  describe '#find!' do
-    context 'when an existent id is given' do
-      before do
-        mongo_session[:users].insert_one(_id: 1, name: 'John', email: 'john@example.com')
-      end
-
-      it 'returns the right instance' do
-        expect(repo.find!(1)).not_to be_nil
-      end
-    end
-
-    context 'when a non-existent id is given' do
-      it 'raises the NotFound error' do
-        expect {
-          repo.find!(1)
-        }.to raise_error Rmodel::NotFound
-      end
-    end
-  end
-
   describe '#insert' do
     context 'when the id is not provided' do
       let(:user) { User.new(nil, 'John', 'john@example.com') }

data/spec/rmodel/mongo/repository_ext/queryable_spec.rb

@@ -2,16 +2,12 @@ RSpec.describe Rmodel::Mongo::Repository do
   include_context 'clean Mongo database'
 
   before do
-    Rmodel.setup do
-      client :default, hosts: [ 'localhost' ], database: 'rmodel_test'
-    end
     stub_const('Thing', Struct.new(:id, :a, :b))
-    stub_const('ThingRepository', Class.new(Rmodel::Mongo::Repository) {
-      simple_factory Thing, :a, :b
-    })
+    stub_const('ThingRepository', Class.new(Rmodel::Mongo::Repository))
   end
 
-  let(:repo) { ThingRepository.new }
+  let(:factory) { Rmodel::Mongo::SimpleFactory.new(Thing, :a, :b) }
+  let(:repo) { ThingRepository.new(mongo_session, :things, factory) }
 
   before do
     repo.insert(Thing.new(nil, 2, 3))

data/spec/rmodel/mongo/repository_ext/sugarable_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe Rmodel::Mongo::Repository do
+  include_examples 'sugarable repository' do
+    include_context 'clean Mongo database'
+
+    before do
+      stub_const('ThingRepository', Class.new(Rmodel::Mongo::Repository))
+    end
+
+    subject do
+      factory = Rmodel::Mongo::SimpleFactory.new(Thing, :name)
+      ThingRepository.new(mongo_session, :things, factory)
+    end
+  end
+end

data/spec/rmodel/mongo/repository_ext/timestampable_spec.rb

@@ -1,73 +1,19 @@
 RSpec.describe Rmodel::Mongo::Repository do
-  describe Rmodel::Mongo::RepositoryExt::Timestampable do
-    subject(:repo) { ThingRepository.new }
+  include_examples 'timestampable repository' do
+    include_context 'clean Mongo database'
 
-    context 'when the entity object has attributes created_at and updated_at' do
-      before do
-        stub_const('Thing', Struct.new(:id, :name, :created_at, :updated_at))
-        stub_const('ThingRepository', Class.new(Rmodel::Mongo::Repository) {
-          simple_factory Thing, :name, :created_at, :updated_at
-        })
-      end
-
-      context 'when we insert(object)' do
-        context 'and the object.created_at is already set' do
-          let(:thing) { Thing.new(nil, 'chair', Time.now) }
-
-          it 'doesnt change the value of created_at' do
-            set_created_at = thing.created_at
-            repo.insert(thing)
-            expect(thing.created_at).to eq set_created_at
-          end
-        end
-
-        context 'and the object.created_at is not set yet' do
-          let(:thing) { Thing.new(nil, 'chair') }
-
-          it 'sets the value of created_at' do
-            repo.insert(thing)
-            expect(thing.created_at).not_to be_nil
-          end
-        end
-      end
-
-      context 'when we update(object)' do
-        let(:thing) { Thing.new(nil, 'chair') }
-        before { repo.insert(thing) }
-
-        it 'sets the value of created_at' do
-          thing.name = 'table'
-          repo.update(thing)
-          expect(thing.updated_at).not_to be_nil
-        end
-      end
+    before do
+      stub_const('ThingRepository', Class.new(Rmodel::Mongo::Repository))
     end
 
-    context 'when the entity has no attributes :created_at and updated_at' do
-      before do
-        stub_const('Thing', Struct.new(:id, :name))
-        stub_const('ThingRepository', Class.new(Rmodel::Mongo::Repository) {
-          simple_factory Thing, :name
-        })
-      end
-      let(:thing) { Thing.new(nil, 'chair') }
-
-      context 'when we insert(object)' do
-        it 'does nothing special' do
-          repo.insert(thing)
-          expect(thing.respond_to?(:created_at)).to be false
-        end
-      end
-
-      context 'when we update(object)' do
-        before { repo.insert(thing) }
+    let(:repo_w_timestamps) do
+      factory = Rmodel::Mongo::SimpleFactory.new(Thing, :name, :created_at, :updated_at)
+      ThingRepository.new(mongo_session, :things, factory)
+    end
 
-        it 'does nothing special' do
-          thing.name = 'table'
-          repo.update(thing)
-          expect(thing.respond_to?(:updated_at)).to be false
-        end
-      end
+    let(:repo_wo_timestamps) do
+      factory = Rmodel::Mongo::SimpleFactory.new(Thing, :name)
+      ThingRepository.new(mongo_session, :things, factory)
     end
   end
 end

data/spec/rmodel/mongo/repository_initialize_spec.rb

@@ -1,15 +1,13 @@
 RSpec.describe Rmodel::Mongo::Repository do
   before do
-    Rmodel.setup.clear
     stub_const('User', Struct.new(:id, :name, :email))
   end
 
-  subject { UserRepository.new }
-
   describe '.client(name)' do
-    before do
-      Rmodel::Setup.send :public, :client
-    end
+    subject { UserRepository.new }
+
+    before { Rmodel::Setup.send :public, :client }
+
     context 'when it is called with an existent name' do
       before do
         Rmodel.setup do
@@ -22,6 +20,7 @@ RSpec.describe Rmodel::Mongo::Repository do
           attr_reader :client
         })
       end
+      after { Rmodel::setup.clear }
 
       it 'sets the appropriate #client' do
         expect(subject.client).to be_an_instance_of Mongo::Client
@@ -56,6 +55,7 @@ RSpec.describe Rmodel::Mongo::Repository do
             client :default, { hosts: [ 'localhost' ] }
           end
         end
+        after { Rmodel::setup.clear }
 
         it 'sets #client to be default' do
           expect(subject.client).to be_an_instance_of Mongo::Client
@@ -71,11 +71,14 @@ RSpec.describe Rmodel::Mongo::Repository do
   end
 
   describe '.collection(name)' do
+    subject { UserRepository.new }
+
     before do
       Rmodel.setup do
         client :default, { hosts: [ 'localhost' ] }
       end
     end
+    after { Rmodel::setup.clear }
 
     context 'when the :people collection is given' do
       before do
@@ -106,11 +109,14 @@ RSpec.describe Rmodel::Mongo::Repository do
   end
 
   describe '.simple_factory(klass, attribute1, attribute2, ...)' do
+    subject { UserRepository.new }
+
     before do
       Rmodel.setup do
         client :default, { hosts: [ 'localhost' ] }
       end
     end
+    after { Rmodel::setup.clear }
 
     context 'when it is called' do
       before do
@@ -137,4 +143,19 @@ RSpec.describe Rmodel::Mongo::Repository do
       end
     end
   end
+
+  describe '#initialize(client, collection, factory)' do
+    context 'when all constructor arguments are passed' do
+      before do
+        stub_const('UserRepository', Class.new(Rmodel::Mongo::Repository))
+      end
+      let(:factory) { Rmodel::Mongo::SimpleFactory.new(User, :name, :email) }
+
+      it 'works!' do
+        expect {
+          UserRepository.new(Object.new, :users, factory)
+        }.not_to raise_error
+      end
+    end
+  end
 end

data/spec/rmodel/mongo/simple_factory_spec.rb

@@ -2,7 +2,7 @@ RSpec.describe Rmodel::Mongo::SimpleFactory do
   context 'when the User(id, name, email) class is defined' do
     before { stub_const('User', Struct.new(:id, :name, :email)) }
 
-    subject(:factory) { Rmodel::Mongo::SimpleFactory.new(User, :name, :email) }
+    subject(:factory) { described_class.new(User, :name, :email) }
 
     describe '#fromHash' do
       context 'when the hash with _id, name and email is given' do

data/spec/shared/repository_ext/sugarable.rb

@@ -0,0 +1,46 @@
+RSpec.shared_examples 'sugarable repository' do
+  describe Rmodel::Base::RepositoryExt::Sugarable do
+    before do
+      stub_const('Thing', Struct.new(:id, :name))
+    end
+
+    describe '#find!' do
+      context 'when an existent id is given' do
+        before { subject.insert(Thing.new(1)) }
+
+        it 'returns the right instance' do
+          expect(subject.find!(1)).not_to be_nil
+        end
+      end
+
+      context 'when a non-existent id is given' do
+        it 'raises NotFound' do
+          expect {
+            subject.find!(1)
+          }.to raise_error Rmodel::NotFound
+        end
+      end
+    end
+
+    describe 'save' do
+      let(:thing) { Thing.new }
+
+      context 'when a new object is given' do
+        it 'gets inserted' do
+          subject.save(thing)
+          expect(subject.find(thing.id)).not_to be_nil
+        end
+      end
+
+      context 'when an existent object is given' do
+        before { subject.insert(thing) }
+
+        it 'gets updated' do
+          thing.name = 'chair'
+          subject.save(thing)
+          expect(subject.find(thing.id).name).to eq 'chair'
+        end
+      end
+    end
+  end
+end

data/spec/shared/repository_ext/timestampable.rb

@@ -0,0 +1,69 @@
+RSpec.shared_examples 'timestampable repository' do
+  describe Rmodel::Base::RepositoryExt::Timestampable do
+    context 'when the entity object has attributes created_at and updated_at' do
+      before do
+        stub_const('Thing', Struct.new(:id, :name, :created_at, :updated_at))
+      end
+
+      subject { repo_w_timestamps }
+
+      context 'when we insert(object)' do
+        context 'and the object.created_at is already set' do
+          let(:thing) { Thing.new(nil, 'chair', Time.now) }
+
+          it 'doesnt change the value of created_at' do
+            set_created_at = thing.created_at
+            subject.insert(thing)
+            expect(thing.created_at).to eq set_created_at
+          end
+        end
+
+        context 'and the object.created_at is not set yet' do
+          let(:thing) { Thing.new(nil, 'chair') }
+
+          it 'sets the value of created_at' do
+            subject.insert(thing)
+            expect(thing.created_at).not_to be_nil
+          end
+        end
+      end
+
+      context 'when we update(object)' do
+        let(:thing) { Thing.new(nil, 'chair') }
+        before { subject.insert(thing) }
+
+        it 'sets the value of created_at' do
+          thing.name = 'table'
+          subject.update(thing)
+          expect(thing.updated_at).not_to be_nil
+        end
+      end
+    end
+
+    context 'when the entity has no attributes :created_at and updated_at' do
+      before do
+        stub_const('Thing', Struct.new(:id, :name))
+      end
+
+      let(:thing) { Thing.new(nil, 'chair') }
+      subject { repo_wo_timestamps }
+
+      context 'when we insert(object)' do
+        it 'does nothing special' do
+          subject.insert(thing)
+          expect(thing.respond_to?(:created_at)).to be false
+        end
+      end
+
+      context 'when we update(object)' do
+        before { subject.insert(thing) }
+
+        it 'does nothing special' do
+          thing.name = 'table'
+          subject.update(thing)
+          expect(thing.respond_to?(:updated_at)).to be false
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rmodel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.pre.dev
 platform: ruby
 authors:
 - Alexei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-25 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -108,14 +108,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/advanced_creation_of_repository.rb
 - examples/timestamps.rb
 - examples/user.rb
 - lib/rmodel.rb
+- lib/rmodel/base/repository.rb
+- lib/rmodel/base/repository_ext/sugarable.rb
+- lib/rmodel/base/repository_ext/timestampable.rb
 - lib/rmodel/errors.rb
 - lib/rmodel/mongo/repository.rb
 - lib/rmodel/mongo/repository_ext/query.rb
 - lib/rmodel/mongo/repository_ext/queryable.rb
-- lib/rmodel/mongo/repository_ext/timestampable.rb
 - lib/rmodel/mongo/setup.rb
 - lib/rmodel/mongo/simple_factory.rb
 - lib/rmodel/setup.rb
@@ -123,11 +126,14 @@ files:
 - rmodel.gemspec
 - spec/rmodel/mongo/repository_crud_spec.rb
 - spec/rmodel/mongo/repository_ext/queryable_spec.rb
+- spec/rmodel/mongo/repository_ext/sugarable_spec.rb
 - spec/rmodel/mongo/repository_ext/timestampable_spec.rb
 - spec/rmodel/mongo/repository_initialize_spec.rb
 - spec/rmodel/mongo/simple_factory_spec.rb
 - spec/rmodel/setup_spec.rb
 - spec/shared/clean_moped.rb
+- spec/shared/repository_ext/sugarable.rb
+- spec/shared/repository_ext/timestampable.rb
 - spec/spec_helper.rb
 homepage: https://github.com/alexei-lexx/rmodel
 licenses:
@@ -144,9 +150,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -156,9 +162,12 @@ summary: Rmodel is an ORM library, which tends to follow the SOLID principles.
 test_files:
 - spec/rmodel/mongo/repository_crud_spec.rb
 - spec/rmodel/mongo/repository_ext/queryable_spec.rb
+- spec/rmodel/mongo/repository_ext/sugarable_spec.rb
 - spec/rmodel/mongo/repository_ext/timestampable_spec.rb
 - spec/rmodel/mongo/repository_initialize_spec.rb
 - spec/rmodel/mongo/simple_factory_spec.rb
 - spec/rmodel/setup_spec.rb
 - spec/shared/clean_moped.rb
+- spec/shared/repository_ext/sugarable.rb
+- spec/shared/repository_ext/timestampable.rb
 - spec/spec_helper.rb