rmodel 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1cabda8d90f129c91be844839240e35c667e866
-  data.tar.gz: 63d948217cbee488f8e93be4ef575ff838d9cabf
+  metadata.gz: dc6dc338effa3435151dfc878fb4c211f3e7a389
+  data.tar.gz: 6c794461936c774923c7ebdcf08c762a3ddf8876
 SHA512:
-  metadata.gz: 1eb0276bbb918397139567f1a3c081fa3de431eff3cbffb406f2aa0e524c4d862082d5d5155bad31ce2188d5cb66ea300272a3657edc4d8f1e3debbc54f03628
-  data.tar.gz: 85fa52294b5ee0e0cbed4fb23a443f995ef442114e9ec67738aabbf21b8d437506af32834b26de7fa64f9ff217096577ca4dea48972fb8afd9f61a9bbf691dcb
+  metadata.gz: 363d01b511dfa3a9db13a896701fc624a04ee9a83a64fe4fd33ae6859fa7178cb6a20255d665e938709843cbcc1efa9c781b4d165724d6665119f1860e89f041
+  data.tar.gz: 0aa72c78a0b9f7c110488b6518d1d5a0b706a14ef77a269e5b7f69b0f3061a0d622e43d74e524c47e361355792aa2610a2baac5ea2ac15d12e9834659b2349ed

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/alexei-lexx/rmodel.svg)](https://travis-ci.org/alexei-lexx/rmodel)
+[![Code Climate](https://codeclimate.com/github/alexei-lexx/rmodel/badges/gpa.svg)](https://codeclimate.com/github/alexei-lexx/rmodel)
 
 # Rmodel
 
@@ -8,9 +9,9 @@
   * [Scopes](#scopes)
   * [Timestamps](#timestamps)
   * [Sugar methods](#sugar-methods)
-  * [Advanced creation of repository](#advanced-creation-of-repository)
   * [SQL repository](#sql-repository)
   * [Embedded documents in MongoDB](#embedded-documents-in-mongodb)
+  * [Entity class as a repository](#entity-class-as-a-repository)
 
 Rmodel is an ORM library, which tends to follow the SOLID principles.
 
@@ -165,15 +166,15 @@ a query builder for mongo.
 Also it's possible to use scopes to run the multi-row operations.
 
 ```ruby
+repo.fetch.have_email.find(1) # return an object with a given id or nil
 repo.fetch.have_email.delete_all # simply run the operation against the database
 repo.fetch.have_email.destroy_all # extract users and run repo.destroy for the each one
-p repo.fetch.count # 0
+repo.fetch.count # 0
 ```
 
 If you have no scopes then just call
 
 ```ruby
-repo.all
 repo.delete_all
 repo.destroy_all
 ```
@@ -356,6 +357,67 @@ repo.insert(flat)
 p repo.find(flat.id)
 ```
 
+### Entity class as a repository
+
+Ruby on Rails lovers would like to use the entity's class to fetch, create,
+update and delete objects. For example `User.find(1)`, `User.create(john)`
+instead of addressing to the repository object `user_repository.find(1)`.
+
+Rmodel has a special feature to resemble the Active Record style - the
+repository injector. Look at the example below.
+
+```ruby
+require 'rmodel'
+
+DB = Mongo::Client.new(['localhost'], database: 'test')
+
+class UserRepository < Rmodel::Repository
+  scope :start_with do |s|
+    where(name: { '$regex' => "^#{s}", '$options' => 'i' })
+  end
+
+  def initialize
+    source = Rmodel::Mongo::Source.new(DB, :users)
+    mapper = Rmodel::Mongo::Mapper.new(User).define_attributes(:name, :email)
+
+    super(source, mapper)
+  end
+
+  def fetch_johns
+    fetch.start_with('john')
+  end
+end
+
+User = Struct.new(:id, :name, :email) do
+  include UserRepository.injector
+end
+
+User.delete_all
+
+john = User.new(nil, 'John', 'john@example.com')
+User.insert(john)
+
+john.name = 'John Smith'
+User.update(john)
+
+User.insert(User.new)
+
+p User.fetch.start_with('J').count
+p User.fetch_johns.count
+```
+
+Here is the explanation:
+
+* `UserRepository.injector` is a module that delegates method calls to the
+underlying repository. It can be included to the class (like User) or extend the
+object.
+* UserRepository must have a constructor with an empty list of arguments.
+* UserRepository is defined as usually. It can have scopes and custom instance
+methods. All of them become available as methods of User.
+  * Remember `user_repo.find(1)`. Now it's available as `User.find(1)`.
+  * The same `user.fetch.start_with('a')` becomes `User.fetch.start_with('a')`.
+  * And the custom method is available as `User.fetch_johns`.
+
 ## Contributing
 
 1. Fork it ( https://github.com/alexei-lexx/rmodel/fork )

data/examples/inject_repo.rb

@@ -0,0 +1,37 @@
+require 'rmodel'
+
+DB = Mongo::Client.new(['localhost'], database: 'test')
+
+class UserRepository < Rmodel::Repository
+  scope :start_with do |s|
+    where(name: { '$regex' => "^#{s}", '$options' => 'i' })
+  end
+
+  def initialize
+    source = Rmodel::Mongo::Source.new(DB, :users)
+    mapper = Rmodel::Mongo::Mapper.new(User).define_attributes(:name, :email)
+
+    super(source, mapper)
+  end
+
+  def fetch_johns
+    fetch.start_with('john')
+  end
+end
+
+User = Struct.new(:id, :name, :email) do
+  include UserRepository.injector
+end
+
+User.delete_all
+
+john = User.new(nil, 'John', 'john@example.com')
+User.insert(john)
+
+john.name = 'John Smith'
+User.update(john)
+
+User.insert(User.new)
+
+p User.fetch.start_with('J').count
+p User.fetch_johns.count

data/lib/rmodel.rb

@@ -2,13 +2,16 @@ require 'active_support/inflector'
 require 'rmodel/version'
 require 'rmodel/errors'
 require 'rmodel/scope'
+require 'rmodel/injector'
 require 'rmodel/repository'
 require 'rmodel/uni_hash'
 require 'rmodel/base_mapper'
 require 'rmodel/array_mapper'
 require 'rmodel/dummy_mapper'
+require 'rmodel/mongo/query'
 require 'rmodel/mongo/source'
 require 'rmodel/mongo/mapper'
+require 'rmodel/sequel/query'
 require 'rmodel/sequel/source'
 require 'rmodel/sequel/mapper'
 

data/lib/rmodel/injector.rb

@@ -0,0 +1,42 @@
+require 'lazy_object'
+
+module Rmodel
+  class Injector < Module
+    def initialize(repository_class)
+      @repository = LazyObject.new { repository_class.new }
+    end
+
+    def included(base)
+      add_method_missing(base)
+    end
+
+    def extended(base)
+      included(base)
+    end
+
+    private
+
+    def add_method_missing(base)
+      repository = @repository
+      injector = self
+
+      base.define_singleton_method :method_missing do |name, *args|
+        if repository.respond_to?(name)
+          injector.send(:delegate_to_repository, self, name, *args)
+        else
+          super(name, *args)
+        end
+      end
+    end
+
+    def delegate_to_repository(base, name, *delegated_args)
+      repository = @repository
+
+      base.define_singleton_method name do |*args|
+        repository.public_send(name, *args)
+      end
+
+      base.public_send(name, *delegated_args)
+    end
+  end
+end

data/lib/rmodel/mongo/query.rb

@@ -0,0 +1,13 @@
+require 'origin'
+
+module Rmodel
+  module Mongo
+    class Query
+      include Origin::Queryable
+
+      def find_by_id(id)
+        where('_id' => id)
+      end
+    end
+  end
+end

data/lib/rmodel/mongo/source.rb

@@ -1,13 +1,8 @@
-require 'origin'
 require 'mongo'
 
 module Rmodel
   module Mongo
     class Source
-      class Query
-        include Origin::Queryable
-      end
-
       def initialize(connection, collection)
         @connection = connection
         raise ArgumentError, 'Connection is not setup' unless @connection

data/lib/rmodel/repository.rb

@@ -1,12 +1,14 @@
 require 'rmodel/repository_ext/sugarable'
 require 'rmodel/repository_ext/timestampable'
 require 'rmodel/repository_ext/scopable'
+require 'rmodel/repository_ext/injectable'
 
 module Rmodel
   class Repository
     include RepositoryExt::Sugarable
     include RepositoryExt::Scopable
     prepend RepositoryExt::Timestampable
+    extend RepositoryExt::Injectable
 
     def initialize(source, mapper)
       @source = source or raise ArgumentError, 'Source is not set up'

data/lib/rmodel/repository_ext/injectable.rb

@@ -0,0 +1,9 @@
+module Rmodel
+  module RepositoryExt
+    module Injectable
+      def injector
+        @injector ||= Injector.new(self)
+      end
+    end
+  end
+end

data/lib/rmodel/repository_ext/scopable.rb

@@ -26,10 +26,6 @@ module Rmodel
         find_all(scope).each { |object| destroy(object) }
       end
 
-      def all
-        fetch.to_a
-      end
-
       module ClassMethods
         def scope_class
           @scope_class ||= Class.new(Rmodel::Scope)

data/lib/rmodel/repository_ext/timestampable.rb

@@ -2,7 +2,9 @@ module Rmodel
   module RepositoryExt
     module Timestampable
       def insert_one(object)
-        object.created_at = now if able_to_set_created_at?(object)
+        time = now
+        object.created_at = time if able_to_set_created_at?(object)
+        object.updated_at = time if able_to_set_updated_at?(object)
         super
       end
 

data/lib/rmodel/scope.rb

@@ -21,6 +21,11 @@ module Rmodel
       @repo.destroy_all(self)
     end
 
+    def find(id)
+      new_raw_query = @raw_query.find_by_id(id)
+      self.class.new(@repo, new_raw_query).first
+    end
+
     def self.define_scope(name, &block)
       define_method name do |*args|
         new_raw_query = @raw_query.instance_exec(*args, &block)

data/lib/rmodel/sequel/query.rb

@@ -0,0 +1,11 @@
+require 'origin'
+
+module Rmodel
+  module Sequel
+    class Query < SimpleDelegator
+      def find_by_id(id)
+        where(id: id)
+      end
+    end
+  end
+end

data/lib/rmodel/sequel/source.rb

@@ -28,7 +28,7 @@ module Rmodel
       end
 
       def build_query
-        @connection[@table]
+        Query.new(@connection[@table])
       end
 
       def exec_query(query)

data/lib/rmodel/version.rb

@@ -1,3 +1,3 @@
 module Rmodel
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/rmodel.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mongo', '~> 2.1'
   spec.add_dependency 'origin'
   spec.add_dependency 'sequel'
+  spec.add_dependency 'lazy_object'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'

data/spec/rmodel/mongo/repository_spec.rb

@@ -26,4 +26,8 @@ RSpec.describe 'Repository with MongoDB' do
   it_behaves_like 'scopable repository' do
     include_context 'definitions'
   end
+
+  it_behaves_like 'injectable repository' do
+    include_context 'definitions'
+  end
 end

data/spec/rmodel/sequel/repository_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe 'Repository with Sequel' do
   end
 
   it_behaves_like 'initialization' do
-    before { create_database(true) }
+    before { create_database }
     include_context 'definitions'
   end
 
@@ -50,4 +50,9 @@ RSpec.describe 'Repository with Sequel' do
       end
     end
   end
+
+  it_behaves_like 'injectable repository' do
+    before { create_database }
+    include_context 'definitions'
+  end
 end

data/spec/rmodel/sequel/source_spec.rb

@@ -85,7 +85,8 @@ RSpec.describe Rmodel::Sequel::Source do
 
   describe 'build_query' do
     it 'returns the instance of Sequel::Dataset' do
-      expect(subject.build_query).to be_a_kind_of Sequel::Dataset
+      expect(subject.build_query).to respond_to :select
+      expect(subject.build_query).to respond_to :order
     end
   end
 

data/spec/shared/repository/injectable.rb

@@ -0,0 +1,91 @@
+RSpec.shared_examples 'injectable repository' do
+  describe '.injector' do
+    it 'is a module' do
+      expect(Rmodel::Repository.injector).to be_a Module
+    end
+
+    it 'returns the same instance each time' do
+      expected_injector = Rmodel::Repository.injector
+      expect(Rmodel::Repository.injector).to equal expected_injector
+    end
+  end
+
+  before do
+    stub_const 'Thing', Struct.new(:id, :name)
+    stub_const 'MyRepository', Class.new(Rmodel::Repository)
+
+    a_source = source
+    mapper = mapper_klass.new(Thing).define_attribute(:name)
+
+    MyRepository.class_eval do
+      define_method :initialize do
+        super(a_source, mapper)
+      end
+
+      def custom_method; end
+    end
+  end
+
+  let(:repository) do
+    MyRepository.injector.instance_variable_get('@repository').__target_object__
+  end
+
+  context "when it's included in a class" do
+    before do
+      stub_const 'Host', Class.new
+
+      class Host
+        include MyRepository.injector
+      end
+    end
+
+    context 'when no method is called' do
+      before { allow(MyRepository).to receive(:new) }
+
+      it "doesn't instantiate the repository" do
+        expect(MyRepository).not_to have_received(:new)
+      end
+    end
+
+    describe '.find' do
+      it 'is delegated to the repository' do
+        expect(repository).to receive(:find).with(1)
+        Host.find(1)
+      end
+    end
+
+    describe '.fetch' do
+      it 'is delegated to the repository' do
+        expect(repository).to receive(:fetch)
+        Host.fetch
+      end
+    end
+
+    describe '.custom_method' do
+      it 'is delegated to the repository' do
+        expect(repository).to receive(:custom_method)
+        Host.custom_method
+      end
+    end
+  end
+
+  context 'when it extends an object' do
+    let(:tester) { Object.new }
+
+    before { tester.extend MyRepository.injector }
+
+    describe '.find' do
+      it 'is delegated to the repository' do
+        expect(repository).to receive(:find).with(1)
+        tester.find(1)
+      end
+    end
+
+    describe '.custom_method' do
+      it 'is delegated to the repository' do
+        expect(repository).to receive(:custom_method)
+        tester.custom_method
+      end
+    end
+  end
+end

data/spec/shared/repository/scopable.rb

@@ -20,13 +20,14 @@ RSpec.shared_examples 'scopable repository' do
   end
 
   let(:mapper) { mapper_klass.new(Thing).define_attributes(:a, :b) }
+  let(:one_thing) { Thing.new(nil, 2, 3) }
 
   subject { ThingRepository.new(source, mapper) }
 
   before do
     create_database if defined?(create_database)
 
-    subject.insert(Thing.new(nil, 2, 3))
+    subject.insert(one_thing)
     subject.insert(Thing.new(nil, 2, 4))
     subject.insert(Thing.new(nil, 5, 6))
   end
@@ -103,12 +104,21 @@ RSpec.shared_examples 'scopable repository' do
         end
       end
     end
-  end
 
-  describe '#all' do
-    it 'gets all objects' do
-      objects = subject.all
-      expect(objects.length).to eq 3
+    describe '#find' do
+      context 'when an existent id is given' do
+        it 'returns a proper object' do
+          found = subject.fetch.find(one_thing.id)
+          expect(found.id).to eq one_thing.id
+        end
+      end
+
+      context 'when a non-existent id is given' do
+        it 'returns nil' do
+          found = subject.fetch.find('wrong-id')
+          expect(found).to be_nil
+        end
+      end
     end
   end
 

data/spec/shared/repository/timestampable.rb

@@ -29,6 +29,10 @@ RSpec.shared_examples 'timestampable repository' do
           expect(thing.created_at).not_to be_nil
         end
 
+        it 'sets the same value to updated_at' do
+          expect(thing.updated_at).to eq thing.created_at
+        end
+
         it 'saves created_at in the database' do
           expect(subject.find(thing.id).created_at).not_to be_nil
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rmodel
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-24 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lazy_object
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +209,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/inject_repo.rb
 - examples/mongo_embedded.rb
 - examples/scopes.rb
 - examples/sql_repository.rb
@@ -211,14 +226,18 @@ files:
 - lib/rmodel/base_mapper.rb
 - lib/rmodel/dummy_mapper.rb
 - lib/rmodel/errors.rb
+- lib/rmodel/injector.rb
 - lib/rmodel/mongo/mapper.rb
+- lib/rmodel/mongo/query.rb
 - lib/rmodel/mongo/source.rb
 - lib/rmodel/repository.rb
+- lib/rmodel/repository_ext/injectable.rb
 - lib/rmodel/repository_ext/scopable.rb
 - lib/rmodel/repository_ext/sugarable.rb
 - lib/rmodel/repository_ext/timestampable.rb
 - lib/rmodel/scope.rb
 - lib/rmodel/sequel/mapper.rb
+- lib/rmodel/sequel/query.rb
 - lib/rmodel/sequel/source.rb
 - lib/rmodel/uni_hash.rb
 - lib/rmodel/version.rb
@@ -235,6 +254,7 @@ files:
 - spec/shared/clean_sequel.rb
 - spec/shared/repository/crud.rb
 - spec/shared/repository/initialization.rb
+- spec/shared/repository/injectable.rb
 - spec/shared/repository/scopable.rb
 - spec/shared/repository/sugarable.rb
 - spec/shared/repository/timestampable.rb
@@ -276,6 +296,7 @@ test_files:
 - spec/shared/clean_sequel.rb
 - spec/shared/repository/crud.rb
 - spec/shared/repository/initialization.rb
+- spec/shared/repository/injectable.rb
 - spec/shared/repository/scopable.rb
 - spec/shared/repository/sugarable.rb
 - spec/shared/repository/timestampable.rb