rmodel 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: deb9462cdda8354cf1ae328254df31b82ddd3a74
-  data.tar.gz: 98e72a0ff775b44114b7c90383046806f15948db
+  metadata.gz: 7d6692638747de91e5cb796e6141d501bca570af
+  data.tar.gz: 5a80109b93f41f8bd2c68ae110420c8b9d20ab8c
 SHA512:
-  metadata.gz: dd4006a1d057a592bac459e31f39039c496a89d9c379c7953bea129bc8e3acbd92f13b7cd6d2c32a5ad8ee8a71caebdd8b72a9cd328de1ed41f697ab033b8be3
-  data.tar.gz: d3e1d56effdceeb17d3978b8242f35aaf9689b2eddf5b71fffc30e6665aea25972672bddcf1d1d3f4053559ffe59cc7d74362cacb5d7877befcaf10cf5c33279
+  metadata.gz: 468a0b7cefbf30b51321ec32707dd86ef377bba8f0a0238e3f63b43603acec73ac87beefc1f67ddffc80effda796352bd961aec65151fd86d0c2bb0faa3d51a6
+  data.tar.gz: 28cd0af645f741b54336d2da76ea76833f0bfa1e4f5ed069804a58f98f5381672a3bbbc58cae72a294cd944cac3332e0cb208386c808f7bdb4a73b72ee8ddcc4

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 script: rspec
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.7
   - 2.2.3

data/README.md

@@ -116,7 +116,7 @@ userRepository.remove(bob)
 
 p userRepository.find(john.id) # #<User:0x000000037237d0 @name="John Smith" ... >
 p userRepository.find(bob.id) # nil
-p userRepository.find!(bob.id) # nil
+p userRepository.find!(bob.id) # raises Rmodel::NotFound
 ```
 
 ### Scopes
@@ -156,6 +156,34 @@ userRepository.query.have_email.remove
 p userRepository.query.count # 0
 ```
 
+### Timestamps
+
+Here is an example how to track the time, when the entity was created and updated.
+
+```ruby
+class Thing
+  attr_accessor :id, :name, :created_at, :updated_at
+end
+
+class ThingRepository < Rmodel::Mongo::Repository
+  simple_factory Thing, :name, :created_at, :updated_at
+end
+repo = ThingRepository.new
+
+thing = Thing.new
+thing.name = 'chair'
+repo.insert(thing)
+p thing.created_at
+
+sleep 2
+
+thing.name = 'table'
+repo.update(thing)
+p thing.updated_at
+```
+
+To enable time tracking  just add attributes `created_at` and `updated_at` or one of them to your entity.
+
 ## Contributing
 
 1. Fork it ( https://github.com/alexei-lexx/rmodel/fork )

data/examples/timestamps.rb

@@ -0,0 +1,25 @@
+require 'rmodel'
+
+Rmodel.setup do
+  client :default, { hosts: [ 'localhost' ], database: 'test' }
+end
+
+class Thing
+  attr_accessor :id, :name, :created_at, :updated_at
+end
+
+class ThingRepository < Rmodel::Mongo::Repository
+  simple_factory Thing, :name, :created_at, :updated_at
+end
+repo = ThingRepository.new
+
+thing = Thing.new
+thing.name = 'chair'
+repo.insert(thing)
+p "#{thing.created_at} / #{thing.updated_at}"
+
+sleep 2
+
+thing.name = 'table'
+repo.update(thing)
+p "#{thing.created_at} / #{thing.updated_at}"

data/lib/rmodel/mongo/repository.rb

@@ -1,10 +1,12 @@
 require 'mongo'
 require 'active_support/inflector'
 require 'rmodel/mongo/repository_ext/queryable'
+require 'rmodel/mongo/repository_ext/timestampable'
 
 module Rmodel::Mongo
   class Repository
     include RepositoryExt::Queryable
+    prepend RepositoryExt::Timestampable
 
     def initialize
       @client = Rmodel.setup.establish_mongo_client(self.class.client_name || :default) or

data/lib/rmodel/mongo/repository_ext/timestampable.rb

@@ -0,0 +1,20 @@
+module Rmodel::Mongo
+  module RepositoryExt
+    module Timestampable
+
+      def insert(object)
+        if object.respond_to?(:created_at) && object.respond_to?(:created_at=)
+          object.created_at ||= Time.now
+        end
+        super
+      end
+
+      def update(object)
+        if object.respond_to?(:updated_at) && object.respond_to?(:updated_at=)
+          object.updated_at = Time.now
+        end
+        super
+      end
+    end
+  end
+end

data/lib/rmodel/version.rb

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

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

@@ -0,0 +1,73 @@
+RSpec.describe Rmodel::Mongo::Repository do
+  describe Rmodel::Mongo::RepositoryExt::Timestampable do
+    subject(:repo) { ThingRepository.new }
+
+    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
+    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) }
+
+        it 'does nothing special' do
+          thing.name = 'table'
+          repo.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.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-24 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -108,20 +108,23 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/timestamps.rb
 - examples/user.rb
 - lib/rmodel.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
 - lib/rmodel/version.rb
 - rmodel.gemspec
 - spec/rmodel/mongo/repository_crud_spec.rb
+- spec/rmodel/mongo/repository_ext/queryable_spec.rb
+- spec/rmodel/mongo/repository_ext/timestampable_spec.rb
 - spec/rmodel/mongo/repository_initialize_spec.rb
-- spec/rmodel/mongo/repository_queryable_spec.rb
 - spec/rmodel/mongo/simple_factory_spec.rb
 - spec/rmodel/setup_spec.rb
 - spec/shared/clean_moped.rb
@@ -152,8 +155,9 @@ specification_version: 4
 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/timestampable_spec.rb
 - spec/rmodel/mongo/repository_initialize_spec.rb
-- spec/rmodel/mongo/repository_queryable_spec.rb
 - spec/rmodel/mongo/simple_factory_spec.rb
 - spec/rmodel/setup_spec.rb
 - spec/shared/clean_moped.rb