ixtlan-datamapper 0.1.0

data/lib/ixtlan/datamapper/immutable.rb

@@ -0,0 +1,18 @@
+module Ixtlan
+  module DataMapper
+    module Immutable
+      def self.included( model )
+        model.class_eval do
+          validates_with_method :validate_immutable
+        end
+      end
+      def validate_immutable
+        if dirty? && ! new?
+          [ false, 'object is immutable' ]
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/lib/ixtlan/datamapper/immutable.rb~

@@ -0,0 +1,83 @@
+require 'dm-aggregates'
+module Ixtlan
+  module ConditionalGet
+
+    private
+
+    def _conditional_get( method, id, modified_since, attribute )
+      if self.count( attribute => modified_since,
+                     :id => id ) == 0
+        self.send( method, id )
+      else
+        # return false when up-to-date
+        # that helps to distinguish nil from not-found
+        false
+      end
+    end
+
+    public
+
+    def conditional_get!( id, modified_since, attribute = :updated_at )
+      _conditional_get( :get!, id, modified_since, attribute )
+    end
+
+    def conditional_get( id, modified_since, attribute = :updated_at )
+      _conditional_get( :get, id, modified_since, attribute )
+    end
+  end
+  DataMapper::Associations::OneToMany::Collection.send( :include,
+                                                        ConditionalGet )
+  DataMapper::Associations::ManyToMany::Collection.send( :include,
+                                                        ConditionalGet )
+
+  module Immutable
+    def self.included( model )
+      model.class_eval do
+        validates_with_method :validate_immutable
+      end
+    end
+    def validate_immutable
+      if dirty? && ! new?
+        [ false, 'object is immutable' ]
+      else
+        true
+      end
+    end
+  end
+
+  module ModifiedBy
+
+    def current_user=( user )
+      @_current_user = user
+    end
+
+    def current_user
+      @_current_user
+    end
+
+    def _modified_by
+      self.modified_by = @_current_user if dirty? && @_current_user
+    end
+
+    def validate_modified_by
+      if @_current_user || ! dirty?
+        true
+      else
+        [ false, 'current_user was not set' ]
+      end
+    end
+
+    module Methods
+      def modified_by( *args )
+        belongs_to :modified_by, *args
+
+        before :valid?, :_modified_by
+
+        validates_with_method :validate_modified_by
+      end
+    end
+
+    DataMapper::Model.append_inclusions self
+    DataMapper::Model.append_extensions Methods
+  end
+end

data/lib/ixtlan/datamapper/modified.rb~

@@ -0,0 +1,83 @@
+require 'dm-aggregates'
+module Ixtlan
+  module ConditionalGet
+
+    private
+
+    def _conditional_get( method, id, modified_since, attribute )
+      if self.count( attribute => modified_since,
+                     :id => id ) == 0
+        self.send( method, id )
+      else
+        # return false when up-to-date
+        # that helps to distinguish nil from not-found
+        false
+      end
+    end
+
+    public
+
+    def conditional_get!( id, modified_since, attribute = :updated_at )
+      _conditional_get( :get!, id, modified_since, attribute )
+    end
+
+    def conditional_get( id, modified_since, attribute = :updated_at )
+      _conditional_get( :get, id, modified_since, attribute )
+    end
+  end
+  DataMapper::Associations::OneToMany::Collection.send( :include,
+                                                        ConditionalGet )
+  DataMapper::Associations::ManyToMany::Collection.send( :include,
+                                                        ConditionalGet )
+
+  module Immutable
+    def self.included( model )
+      model.class_eval do
+        validates_with_method :validate_immutable
+      end
+    end
+    def validate_immutable
+      if dirty? && ! new?
+        [ false, 'object is immutable' ]
+      else
+        true
+      end
+    end
+  end
+
+  module ModifiedBy
+
+    def current_user=( user )
+      @_current_user = user
+    end
+
+    def current_user
+      @_current_user
+    end
+
+    def _modified_by
+      self.modified_by = @_current_user if dirty? && @_current_user
+    end
+
+    def validate_modified_by
+      if @_current_user || ! dirty?
+        true
+      else
+        [ false, 'current_user was not set' ]
+      end
+    end
+
+    module Methods
+      def modified_by( *args )
+        belongs_to :modified_by, *args
+
+        before :valid?, :_modified_by
+
+        validates_with_method :validate_modified_by
+      end
+    end
+
+    DataMapper::Model.append_inclusions self
+    DataMapper::Model.append_extensions Methods
+  end
+end

data/lib/ixtlan/datamapper/modified_by.rb

@@ -0,0 +1,39 @@
+module Ixtlan
+  module DataMapper
+    module ModifiedBy
+
+      def current_user=( user )
+        @_current_user = user
+      end
+
+      def current_user
+        @_current_user
+      end
+
+      def _modified_by
+        self.modified_by = @_current_user if dirty? && @_current_user
+      end
+
+      def validate_modified_by
+        if @_current_user || ! dirty?
+          true
+        else
+          [ false, 'current_user was not set' ]
+        end
+      end
+
+      module Methods
+        def modified_by( *args )
+          belongs_to :modified_by, *args
+
+          before :valid?, :_modified_by
+
+          validates_with_method :validate_modified_by
+        end
+      end
+
+      ::DataMapper::Model.append_inclusions self
+      ::DataMapper::Model.append_extensions Methods
+    end
+  end
+end

data/lib/ixtlan/datamapper/modified_by.rb~

@@ -0,0 +1,39 @@
+module Ixtlan
+  module DataMapper
+    module ModifiedBy
+
+      def current_user=( user )
+        @_current_user = user
+      end
+
+      def current_user
+        @_current_user
+      end
+
+      def _modified_by
+        self.modified_by = @_current_user if dirty? && @_current_user
+      end
+
+      def validate_modified_by
+        if @_current_user || ! dirty?
+          true
+        else
+          [ false, 'current_user was not set' ]
+        end
+      end
+
+      module Methods
+        def modified_by( *args )
+          belongs_to :modified_by, *args
+
+          before :valid?, :_modified_by
+
+          validates_with_method :validate_modified_by
+        end
+      end
+
+      ::DataMapper::Model.append_inclusions self
+      ::DataMapper::Model.append_extensions Methods
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+#
+# 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/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) 
+            result = get( *args )
+            if result
+              __check( updated_at )
+              __check_stale( updated_at, result )
+            end
+          end
+ 
+          def self.optimistic_get!(updated_at, *args)
+            result = get!( *args )
+            __check( updated_at )
+            __check_stale( updated_at, result )
+          end
+        end
+      end
+
+      ::DataMapper::Model.append_inclusions( Ixtlan::Optimistic::DataMapper )
+      ::DataMapper::Associations::OneToMany::Collection.send( :include,
+                                                              Ixtlan::Optimistic::DataMapper )
+      ::DataMapper::Associations::ManyToMany::Collection.send( :include,
+                                                               Ixtlan::Optimistic::DataMapper )
+    end
+  end
+end

data/lib/ixtlan/datamapper/optimistic_get.rb

@@ -0,0 +1,71 @@
+#
+# 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/datamapper/stale_object_exception'
+module Ixtlan
+  module DataMapper
+    module OptimisticGet
+
+      def self.included(base)
+        base.extend OptimisticGet
+      end
+      
+      public
+
+      def optimistic_get(updated_at, *args) 
+        result = get( *args )
+        if result
+          check_stale( updated_at, result )
+        end
+      end
+      
+      def optimistic_get!(updated_at, *args)
+        result = get!( *args )
+        check_stale( updated_at, result )
+      end
+
+      private
+
+      def check_stale( updated_at, result )
+        unless updated_at
+          raise StaleObjectException.new "no 'updated_at' given for #{self}."
+        end
+        if updated_at.is_a? String
+          updated_at = DateTime.parse( updated_at.sub(/[.][0-9]+/, '') )
+        end
+        # rails hacky-de-hack
+        if defined?( ActiveSupport::TimeWithZone ) && updated_at.is_a?( ActiveSupport::TimeWithZone )
+          updated_at = updated_at.to_datetime
+        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 StaleObjectException.new "#{result.model} with key [#{result.id}] was updated at #{result.updated_at} is newer than #{updated_at}."
+        end
+        result
+      end
+    end
+
+    ::DataMapper::Model.append_inclusions( OptimisticGet )
+    ::DataMapper::Associations::OneToMany::Collection.send( :include,
+                                                            OptimisticGet )
+    ::DataMapper::Associations::ManyToMany::Collection.send( :include,
+                                                             OptimisticGet )
+  end
+end

data/lib/ixtlan/datamapper/optimistic_get.rb~

@@ -0,0 +1,72 @@
+#
+# 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/datamapper/stale_object_exception'
+module Ixtlan
+  module DataMapper
+    module OptimisticGet
+
+      def self.included(base)
+        base.extend OptimisticGet
+      end
+      
+      public
+
+      def optimistic_get(updated_at, *args) 
+        result = get( *args )
+        if result
+          check_stale( updated_at, result )
+        end
+      end
+      
+      def optimistic_get!(updated_at, *args)
+        result = get!( *args )
+        check_stale( updated_at, result )
+      end
+
+      private
+
+      def check_stale( updated_at, result )
+        unless updated_at
+          raise StaleObjectException.new "no 'updated_at' given for #{self}."
+        end
+        if updated_at.is_a? String
+          updated_at = DateTime.parse( updated_at.sub(/[.][0-9]+/, '') )
+        end
+        # rails hacky-de-hack
+        if defined?( ActiveSupport::TimeWithZone ) && updated_at.is_a?( ActiveSupport::TimeWithZone )
+          updated_at = updated_at.to_datetime
+        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.strftime("%Y:%m:%d %H:%M:%S")
+          
+          raise StaleObjectException.new "#{result.model} with key [#{result.id}] was updated at #{result.updated_at} is newer than #{updated_at}."
+        end
+        result
+      end
+    end
+
+    ::DataMapper::Model.append_inclusions( OptimisticGet )
+    ::DataMapper::Associations::OneToMany::Collection.send( :include,
+                                                            OptimisticGet )
+    ::DataMapper::Associations::ManyToMany::Collection.send( :include,
+                                                             OptimisticGet )
+  end
+end