ixtlan-optimistic 0.1.0 → 0.2.0

data/README.md

@@ -1,6 +1,12 @@
-# Ixtlan Optimistic [![Build Status](https://secure.travis-ci.org/mkristian/ixtlan-optimistic.png)](http://travis-ci.org/mkristian/ixtlan-optimistic) #
+# Ixtlan Optimistic #
 
-it adds optimistic persistence support to DataMapper and ActveRecord usingg the updated_at property/attribute which is automatically updated on any change of the model (for datamapper you need dm-timestamps for that). to load a model use `optimistic_get`/`optimistic_get!`/`optimistic_find` respectively where the first argument is the last `updated_at` value which the client has. if the client data is uptodate then the `optimistic_XYZ` method will return the database entity otherwise raise an exception or return nil respectively.
+* [![Build Status](https://secure.travis-ci.org/mkristian/ixtlan-optimistic.png)](http://travis-ci.org/mkristian/ixtlan-optimistic)
+* [![Dependency Status](https://gemnasium.com/mkristian/ixtlan-optimistic.png)](https://gemnasium.com/mkristian/ixtlan-optimistic)
+* [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mkristian/ixtlan-optimistic)
+
+
+
+it adds optimistic persistence support to DataMapper and ActveRecord using the updated\_at property/attribute which is automatically updated on any change of the model (for datamapper you need dm-timestamps for that). to load a model use `optimistic_get`/`optimistic_get!`/`optimistic_find` respectively where the first argument is the last `updated_at` value which the client has. if the client data is uptodate then the `optimistic_XYZ` method will return the database entity otherwise raise an exception or return nil respectively.
 
 ## rails setup ##
 
@@ -33,6 +39,16 @@ just add it with
      ::ActiveRecord::Base.send(:include, 
                                Ixtlan::Optimistic::ActiveRecord)
 
-# meta-fu #
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+meta-fu
+-------
 
-bug-reports, feature request and pull request are most welcome.
+enjoy :) 

data/lib/ixtlan-optimistic.rb

@@ -1,3 +1,23 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
 if defined?(Rails)
   require 'ixtlan/optimistic/railtie'
 end

data/lib/ixtlan/optimistic/active_record.rb

@@ -1,28 +1,39 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
 require 'ixtlan/optimistic/object_stale_exception'
+require 'ixtlan/optimistic/stale_check'
 module Ixtlan
   module Optimistic
     module ActiveRecord
 
       def self.included(base)
+        base.extend StaleCheck
         base.class_eval do
-
           def self.optimistic_find(updated_at, *args)
-            if updated_at  
-              dummy = self.new
-              dummy.updated_at = updated_at
-              updated_at_date = dummy.updated_at
-              # try different ways to use the date
-              # TODO maybe there is a nicer way ??
-              # TODO make it work with different PKs
-              result = first(:conditions => ["id = ? and updated_at <= ? and updated_at >= ?", args[0], updated_at_date + 0.0005, updated_at_date - 0.0005])
-p result
-              raise ObjectStaleException.new "#{self.class} with ID=#{args[0]} is stale" unless result
-              result
-            else
-              raise ObjectStaleException.new "no 'updated_at' given. could not dind #{self.class} with ID=#{args[0]}."
+            __check( updated_at )
+            result = find( *args )
+            if result
+              __check_stale( updated_at, result )
             end
           end
-
         end
       end
     end

data/lib/ixtlan/optimistic/data_mapper.rb

@@ -1,32 +1,48 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
 require 'ixtlan/optimistic/object_stale_exception'
+require 'ixtlan/optimistic/stale_check'
 module Ixtlan
   module Optimistic
     module DataMapper
 
       def self.included(base)
+        base.extend StaleCheck
         base.class_eval do
-          
-          def self.optimistic_get(updated_at, *args)
-            if updated_at
-              updated_at_date = new(:updated_at => updated_at).updated_at
-              # TODO make it work with different PKs
-              first(:id => args[0], :updated_at.gte => updated_at_date - 0.0005, :updated_at.lte => updated_at_date + 0.0005)
+
+          def self.optimistic_get(updated_at, *args) 
+            __check( updated_at )
+            result = get( *args )
+            if result
+              __check_stale( updated_at, result )
             end
           end
-
+ 
           def self.optimistic_get!(updated_at, *args)
-            if updated_at
-              result = self.optimistic_get(updated_at, *args)
-              raise ObjectStaleException.new "#{self.class} with ID=#{args[0]} is stale" unless result
-              result
-            else
-              raise ObjectStaleException.new "no 'updated_at' given. could not dind #{self.class} with ID=#{args[0]}."              
-            end
+            __check( updated_at )
+            result = get!( *args )
+            __check_stale( updated_at, result )
           end
         end
-
       end
-
     end
   end
 end

data/lib/ixtlan/optimistic/object_stale_exception.rb

@@ -1,3 +1,23 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
 module Ixtlan
   module Optimistic
     class ObjectStaleException < StandardError

data/lib/ixtlan/optimistic/railtie.rb

@@ -1,3 +1,23 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
 require 'ixtlan/optimistic/active_record'
 require 'ixtlan/optimistic/data_mapper'
 module Ixtlan
@@ -18,4 +38,4 @@ module Ixtlan
       end
     end
   end
-end
+end

data/lib/ixtlan/optimistic/stale_check.rb

@@ -0,0 +1,45 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'ixtlan/optimistic/object_stale_exception'
+module Ixtlan
+  module Optimistic
+    module StaleCheck
+
+      def __check( updated_at )
+        unless updated_at
+          raise ObjectStaleException.new "no 'updated_at' given. could not find #{signature(*args)}."
+        end
+      end
+      
+      def __check_stale( updated_at, result )
+        if updated_at.is_a?( String )
+          updated_at = DateTime.parse( updated_at.sub(/[.][0-9]+/, '') )
+        end
+        updated_at = updated_at.new_offset(0)
+        if updated_at != result.updated_at && updated_at.strftime("%Y:%m:%d %H:%M:%S") != result.updated_at.new_offset(0).strftime("%Y:%m:%d %H:%M:%S")
+          
+          raise ObjectStaleException.new "#{result.inspect} is stale for updated at #{updated_at}."
+        end
+        result
+      end
+    end
+  end
+end

data/lib/ixtlan/optimistic/stale_check.rb~

@@ -0,0 +1,66 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'ixtlan/optimistic/object_stale_exception'
+module Ixtlan
+  module Optimistic
+    module DataMapper
+
+      def self.included(base)
+        base.class_eval do
+          private
+
+          def self.__check( updated_at )
+            unless updated_at
+              raise ObjectStaleException.new "no 'updated_at' given. could not find #{signature(*args)}."
+            end
+          end
+         
+          def self.__check_stale( updated_at, result )
+            if updated_at.is_a?( String )
+              updated_at = DateTime.parse( updated_at.sub(/[.][0-9]+/, '') )
+            end
+            if updated_at != result.updated_at && updated_at.strftime("%Y:%m:%d %H:%M:%S") != result.updated_at.strftime("%Y:%m:%d %H:%M:%S")
+
+              raise ObjectStaleException.new "#{self.class} with key #{result.key} is stale for updated at #{updated_at}."
+            end
+            result
+          end
+
+          public
+
+          def self.optimistic_get(updated_at, *args) 
+            __check( updated_at )
+            result = get( *args )
+            if result
+              __check_stale( updated_at, result )
+            end
+          end
+ 
+          def self.optimistic_get!(updated_at, *args)
+            __check( updated_at )
+            result = get!( *args )
+            __check_stale( updated_at, result )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/datamapper_spec.rb

@@ -23,16 +23,36 @@ describe Ixtlan::Optimistic::DataMapper do
 
   subject { A.create :name => 'huffalump' }
 
-  it 'should load' do
-    A.optimistic_get!(subject.updated_at.to_s, subject.id).must_equal subject
-  end
+  describe "#optimistic_get" do
+
+    it 'should load' do
+      A.optimistic_get(subject.updated_at.to_s, subject.id).must_equal subject
+    end
+
+    it 'should fail with stale exception' do
+      lambda { A.optimistic_get((subject.updated_at - 1000).to_s, subject.id) }.must_raise Ixtlan::Optimistic::ObjectStaleException
+    end
+
+    it 'should fail with nil' do
+      A.optimistic_get(subject.updated_at.to_s, subject.id + 987).must_be_nil
+    end
 
-  it 'should fail with nil' do
-    A.optimistic_get((subject.updated_at - 1000).to_s, subject.id).must_be_nil
   end
 
-  it 'should fail with exception' do
-    lambda { A.optimistic_get!((subject.updated_at - 1000).to_s, subject.id) }.must_raise Ixtlan::Optimistic::ObjectStaleException
+  describe "#optimistic_get!" do
+
+    it 'should load' do
+      A.optimistic_get!(subject.updated_at.to_s, subject.id).must_equal subject
+    end
+    
+    it 'should fail with not-found exception' do
+      lambda { A.optimistic_get!(subject.updated_at.to_s, subject.id + 987) }.must_raise DataMapper::ObjectNotFoundError
+    end
+    
+    it 'should fail with stale exception' do
+      lambda { A.optimistic_get!((subject.updated_at - 1000).to_s, subject.id) }.must_raise Ixtlan::Optimistic::ObjectStaleException
+    end
+
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ixtlan-optimistic
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - mkristian
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-07 00:00:00 Z
+date: 2012-12-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
@@ -23,14 +23,14 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 51
         segments: 
+        - 4
         - 3
-        - 2
         - 0
-        version: 3.2.0
+        version: 4.3.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -87,17 +87,31 @@ dependencies:
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 75
         segments: 
+        - 10
         - 0
-        - 9
         - 2
-        - 2
-        version: 0.9.2.2
+        version: 10.0.2
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: copyright-header
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id006
 description: optimistic find/get on model via updated_at timestamp for datamapper and activerecord
 email: 
 - m.kristian@web.de
@@ -112,14 +126,16 @@ files:
 - README.md
 - lib/ixtlan-optimistic.rb
 - lib/ixtlan/optimistic/active_record.rb
+- lib/ixtlan/optimistic/stale_check.rb~
 - lib/ixtlan/optimistic/data_mapper.rb
+- lib/ixtlan/optimistic/stale_check.rb
 - lib/ixtlan/optimistic/railtie.rb
 - lib/ixtlan/optimistic/object_stale_exception.rb
 - spec/datamapper_spec.rb~
 - spec/datamapper_spec.rb
 homepage: http://github.com/mkristian/ixtlan-optimistic
 licenses: 
-- MIT-LICENSE
+- MIT
 post_install_message: 
 rdoc_options: 
 - --main
@@ -147,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: optimistic find/get on model via updated_at timestamp for datamapper and activerecord