ixtlan-datamapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b50625c5e23298cea7e2f56ab39f7eac2cdd2150
+  data.tar.gz: b98eaa3f4b9ac7eb6a78172617e93bf92db76e2f
+SHA512:
+  metadata.gz: 2fdb5f154e80bd69681295d723ac9af2c7ba05de096ea2c7b057c66a676f9a9f3671353ba40e55250df14ede9614b33a15dfc11872ec35fc188fbf7d8ef1739e
+  data.tar.gz: 5cadca5c14114b50e59d58c20c74c3a69d749245e630aadbb9801a18787ff51e002f02dd7a237e7c144d012c4076d34f6314aa411bfccd6fbf8e839513fff00f

data/Gemfile

@@ -0,0 +1,9 @@
+# -*- mode: ruby -*-
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'copyright-header', '~>1.0', :platform => :mri, :group => :copyright
+
+# vim: syntax=Ruby

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Kristian Meier
+
+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.

data/README.md

@@ -0,0 +1,94 @@
+# Ixtlan DataMapper #
+
+* [![Build Status](https://secure.travis-ci.org/mkristian/ixtlan-datamapper.png)](http://travis-ci.org/mkristian/ixtlan-datamapper)
+* [![Dependency Status](https://gemnasium.com/mkristian/ixtlan-datamapper.png)](https://gemnasium.com/mkristian/ixtlan-datamapper)
+* [![Code Climate](https://codeclimate.com/github/mkristian/ixtlan-datamapper.png)](https://codeclimate.com/github/mkristian/ixtlan-datamapper)
+
+
+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.
+
+
+## optimistic/conditional get ##
+
+just include `require 'ixtlan/datamapper/optimistic'` and have model like:
+
+    class User
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :name, String
+  
+      timestamps :at
+    end
+	
+you need the timestamps to get it to work since the updated_at property will be used to determine if the object is stale or not.
+
+now you get the object in an optimistic manner
+
+    User.optimistic_get!( updated_at, id )
+    User.optimistic_get( updated_at, id )
+
+if will raise an Ixtlan::DataMapper::StaleObjectException in case the object with the given ```id``` exists but does carry a different updated_at timestamp. otherwise the ```optimistic_get``` and ```optimistic_get!``` behave the same as ```get``` and ```get!```.
+
+now you get the object in an conditional manner
+
+    User.conditinal_get!( updated_at, id )
+    User.conditional_get( updated_at, id )
+
+it the ```User``` when the updated_at does not match. when it matches it returns ```false```. in case the ```id``` does not exist, it will return either nil of DataMapper::ObjectNotFoundError. this allows constructs like
+
+    if u = User.conditinal_get!( request.last_modified, id )
+	  response.last_modified = u.updated_at
+	  response.write ....
+    else
+	  # in case request.last_modified was nil
+	  response.last_modified = u.updated_at	  
+	end
+
+## Ixtlan::DataMapper::Immutable ##
+
+    class Group
+      include DataMapper::Resource
+	  include Ixtlan::DataMapper::Immutable
+
+      property :id, Serial
+      property :name, String
+    end
+
+you can create and delete those object but any attempt to change it the name ends in validation error.
+
+## require 'ixtlan/datamapper/use_utc' ##
+
+just convenient file to setup datamapper to use UTC timestamps
+
+## Ixtlan::DataMapper:Collection ##
+
+the collection is [virtus](http://github.com/solnic/virtus) object which helps to transport collections of DataMapper objects around. it has the ```total_count``` and an ```offset``` along an accessor for the list. the contructor deals with offset and limit on the datamapper query.
+
+    class UserCollection < Ixtlan::DataMapper::Collection
+      attribute :users, Array[User]
+      def data=( d )
+        self.users = d
+      end
+    end
+
+this
+
+    UserCollection.new( User.all( :name.like => 'a%' ), 20, 10 )
+
+will return 10 users starting with 'a' starting with 20th user from all possible users (with 'a').
+
+
+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
+-------
+
+enjoy :) 

data/Rakefile

@@ -0,0 +1,29 @@
+# -*- mode: ruby -*-
+
+task :default => [ :spec ]
+
+task :spec do
+  Dir['spec/*_spec.rb'].each { |f| require File.expand_path(f).sub(/.rb$/, '') }
+end
+
+task :headers do
+  require 'rubygems'
+  require 'copyright_header'
+
+  s = Gem::Specification.load( Dir["*gemspec"].first )
+
+  args = {
+    :license => s.license, 
+    :copyright_software => s.name,
+    :copyright_software_description => s.description,
+    :copyright_holders => s.authors,
+    :copyright_years => [Time.now.year],
+    :add_path => 'lib',
+    :output_dir => './'
+  }
+
+  command_line = CopyrightHeader::CommandLine.new( args )
+  command_line.execute
+end
+
+# vim: syntax=Ruby

data/ixtlan-datamapper.gemspec

@@ -0,0 +1,32 @@
+# -*- mode: ruby -*-
+Gem::Specification.new do |s|
+  s.name = 'ixtlan-datamapper'
+  s.version = '0.1.0'
+
+  s.summary = 'collection of utilities for datamapper'
+  s.description = 'collection of utilities for datamapper: optimistic get, conditional get, use-utc timestampt, tag model as immutable, etc'
+  s.homepage = 'http://github.com/mkristian/ixtlan-datamapper'
+
+  s.authors = ['mkristian']
+  s.email = ['m.kristian@web.de']
+
+  s.files = Dir['MIT-LICENSE']
+  s.licenses << 'MIT'
+  #  s.files += Dir['History.txt']
+  s.files += Dir['*.gemspec']
+  s.files += Dir['README.md']
+  s.files += Dir['lib/**/*']
+  s.files += Dir['spec/**/*']
+  s.files += Dir['*file']
+  s.test_files += Dir['spec/**/*_spec.rb']
+  s.add_runtime_dependency 'virtus', '~>1.0'
+  s.add_runtime_dependency 'dm-aggregates', '~>1.2'
+  s.add_development_dependency 'dm-timestamps', '~>1.2'
+  s.add_development_dependency 'dm-migrations', '~>1.2'
+  s.add_development_dependency 'dm-validations', '~>1.2'
+  s.add_development_dependency 'dm-sqlite-adapter', '~>1.2'
+  s.add_development_dependency 'rake', '~>10.3'
+  s.add_development_dependency 'minitest', '~>5.3'
+end
+
+# vim: syntax=Ruby

data/lib/ixtlan-datamapper.rb

@@ -0,0 +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/datamapper/collection.rb

@@ -0,0 +1,28 @@
+require 'virtus'
+module Ixtlan
+  module DataMapper
+    class Collection
+      include Virtus.model( #:mass_assignments => false, 
+                            :coerce => false )
+
+      attribute :offset, Integer
+      attribute :total_count, Integer
+
+      def initialize( data, offset = nil, count = nil )
+        super()
+        self.total_count = data.count
+        self.offset = offset.to_i
+        last = ( count ? count.to_i : self.total_count ) - 1 + self.offset
+        self.data = data[ self.offset..last ]
+      end
+
+      def data=( d )
+        raise "not implemented"
+      end
+
+      def to_s
+        "#{self.class}[ offset=#{offset} total_count=#{total_count} ]"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'virtus'
+module Ixtlan
+  module DataMapper
+    class Collection
+      # TODO no mass-assignments, etc
+      include Virtus.model( :coerce => false )
+
+      attribute :offset, Integer
+      attribute :total_count, Integer
+
+      def initialize( data, offset = nil, count = nil )
+        super()
+        self.total_count = data.count
+        self.offset = offset.to_i
+        last = ( count ? count.to_i : self.total_count ) - 1 + self.offset
+        self.data = data[ self.offset..last ]
+      end
+
+      def data=( d )
+        raise "not implemented"
+      end
+
+      def to_s
+        "#{self.class}[ offset=#{offset} total_count=#{total_count} ]"
+      end
+    end
+  end
+end

data/lib/ixtlan/datamapper/conditional_get.rb

@@ -0,0 +1,46 @@
+require 'dm-aggregates'
+module Ixtlan
+  module DataMapper
+    module ConditionalGet
+
+      def self.included(base)
+        base.extend ConditionalGet
+      end
+
+      private
+
+      ONE_SECOND = 1.0/86400
+
+      def _conditional_get( method, modified_since, *id )
+        if modified_since.is_a? String
+          modified_since = DateTime.parse( modified_since.sub(/[.][0-9]+/, '') )
+        end
+        if modified_since.nil?
+          self.send( method, *id )
+        else
+          query = Hash[ key.collect { |k| k.name }.zip( id ) ]
+          query[ :updated_at.gte ] = modified_since
+          query[ :updated_at.lte ] = modified_since + ONE_SECOND
+          # return false when up-to-date
+          # that helps to distinguish from nil which means not-found
+          self.count( query ) == 0 ? self.send( method, *id ) : false
+        end
+      end
+
+      public
+
+      def conditional_get!( modified_since, *id )
+        _conditional_get( :get!, modified_since, *id )
+      end
+
+      def conditional_get( modified_since, *id )
+        _conditional_get( :get, modified_since, *id )
+      end
+    end
+    ::DataMapper::Model.append_inclusions( ConditionalGet )
+    ::DataMapper::Associations::OneToMany::Collection.send( :include,
+                                                            ConditionalGet )
+    ::DataMapper::Associations::ManyToMany::Collection.send( :include,
+                                                             ConditionalGet )
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'dm-aggregates'
+module Ixtlan
+  module DataMapper
+    module ConditionalGet
+
+      def self.included(base)
+        base.extend ConditionalGet
+      end
+
+      private
+
+      ONE_SECOND = 1.0/86400
+
+      def _conditional_get( method, modified_since, *id )
+        if modified_since.is_a? String
+          modified_since = DateTime.parse( modified_since.sub(/[.][0-9]+/, '') )
+        end
+        if modified_since.nil?
+          self.send( method, *id )
+        else
+          modified_since = modified_since.new_offset( 0 )
+          query = Hash[ key.collect { |k| k.name }.zip( id ) ]
+          query[ :updated_at.gt ] = modified_since
+          query[ :updated_at.lt ] = modified_since + ONE_SECOND
+          # return false when up-to-date
+          # that helps to distinguish from nil which means not-found
+          self.count( query ) == 0 ? self.send( method, *id ) : false
+        end
+      end
+
+      public
+
+      def conditional_get!( modified_since, *id )
+        _conditional_get( :get!, modified_since, *id )
+      end
+
+      def conditional_get( modified_since, *id )
+        _conditional_get( :get, modified_since, *id )
+      end
+    end
+    ::DataMapper::Model.append_inclusions( ConditionalGet )
+    ::DataMapper::Associations::OneToMany::Collection.send( :include,
+                                                            ConditionalGet )
+    ::DataMapper::Associations::ManyToMany::Collection.send( :include,
+                                                             ConditionalGet )
+  end
+end

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

@@ -0,0 +1,74 @@
+module DataMapper
+  module CubaPlugin
+   
+    # matcher
+    def no_path
+      Proc.new { env[ 'PATH_INFO' ].empty? }
+    end
+
+    # matcher
+    def head
+      req.head?
+    end
+
+    def option
+      req.options?
+    end
+
+    # convenient method for status only responses
+    def no_body( status )
+      res.status = ::Rack::Utils.status_code( status )
+      res.write ::Rack::Utils::HTTP_STATUS_CODES[ res.status ]
+      res['Content-Type' ] = 'text/plain'
+    end
+
+    # params
+    def to_float( name, default = nil )
+     v = req[ name ]
+     if v
+       v.to_f
+     else
+       default
+     end
+    end
+
+    def to_int( name, default = nil )
+      v = req[ name ]
+      if v
+        v.to_i
+      else
+        default
+      end
+    end
+
+    def to_boolean( name, default = nil )
+      v = req[ name ]
+      if v
+        v == 'true'
+      else
+        default
+      end
+    end
+
+    def offset_n_limit( method, set )
+      count = set.count
+      offset = to_int( 'offset' ).to_i
+      limit = ( to_int( 'count' ) || count ) - 1 + offset
+      { method => set[ offset..limit ], :offset => offset, :total_count => count }
+    end
+    
+    def last_modified( last )
+      if last
+        res[ 'Last-Modified' ] = rfc2616( last )
+        res[ 'Cache-Control' ] = "private, max-age=0, must-revalidate"
+      end
+    end
+
+    def modified_since
+      @modified_since ||=
+        if date = env[ 'HTTP_IF_MODIFIED_SINCE' ]
+          DateTime.parse( date )
+        end
+    end
+  end
+end