dm-adjust 0.9.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sindre Aarsaether
+
+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

@@ -0,0 +1,12 @@
+dm-adjust
+=============
+
+DataMapper plugin providing methods to increment and decrement properties
+
+It provides the following function (for collections and resources):
+
+== adjust
+
+ Person.adjust(:salary => 1000) # increases the salary of all people with 1000.
+ Person.all(:age.gte => 40).adjust(:salary => 2000) # increase salary of them oldies.
+ Children.adjust(:allowance => -100) # less money for candy and concerts

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'pathname'
+
+CLEAN.include '{log,pkg}/'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'dm-adjust'
+  s.version          = '0.9.2'
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = 'DataMapper plugin providing methods to increment and decrement properties'
+  s.description      = s.summary
+  s.author           = 'Sindre Aarsaether'
+  s.email            = 'sindre [a] identu [d] no'
+  s.homepage         = 'http://github.com/sam/dm-more/tree/master/dm-adjust'
+  s.require_path     = 'lib'
+  s.files            = FileList[ '{lib,spec}/**/*.rb', 'spec/spec.opts', 'Rakefile', *s.extra_rdoc_files ]
+  s.add_dependency('dm-core', "=#{s.version}")
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{spec.name} #{spec.version} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{spec.name} #{spec.version} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources}, :verbose => false
+  end
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    # rcov not installed
+  end
+end

data/TODO

@@ -0,0 +1,6 @@
+TODO
+====
+
+---
+TODO tickets may also be found in the DataMapper Issue Tracker:
+http://wm.lighthouseapp.com/projects/4819-datamapper/overview

data/lib/dm-adjust.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+gem 'dm-core', '=0.9.3'
+require 'dm-core'
+
+dir = Pathname(__FILE__).dirname.expand_path / 'dm-adjust'
+
+require dir / 'collection'
+require dir / 'model'
+require dir / 'repository'
+require dir / 'adapters' / 'data_objects_adapter'

data/lib/dm-adjust/adapters/data_objects_adapter.rb

@@ -0,0 +1,34 @@
+module DataMapper
+  module Adapters
+    class DataObjectsAdapter
+      def adjust(attributes, query)
+        statement = adjust_statement(attributes.keys, query)
+        bind_values = attributes.values + query.bind_values
+        execute(statement, *bind_values)
+      end
+
+      module SQL
+        private
+
+        def adjust_statement(properties, query)
+          repository = query.repository
+
+          statement = "UPDATE #{quote_table_name(query.model.storage_name(repository.name))}"
+          statement << " SET #{set_adjustment_statement(repository, properties)}"
+          statement << " WHERE #{conditions_statement(query)}" if query.conditions.any?
+          statement
+        rescue => e
+           DataMapper.logger.error("QUERY INVALID: #{query.inspect} (#{e})")
+           raise e
+        end
+
+        def set_adjustment_statement(repository, properties)
+          properties.map { |p| [quote_column_name(p.field(repository.name))] * 2 * " = " + " + (?)" } * ", "
+        end
+
+      end # module SQL
+
+      include SQL
+    end # class DataObjectsAdapter
+  end # module Adapters
+end # module DataMapper

data/lib/dm-adjust/collection.rb

@@ -0,0 +1,60 @@
+module DataMapper
+  class Collection
+
+    def adjust(attributes = {}, reload = false)
+      raise NotImplementedError, 'adjust *with* validations has not be written yet, try adjust!'
+    end
+
+    ##
+    # increment or decrement attributes on a collection
+    #
+    # @example [Usage]
+    #   * People.all.adjust(:salary => +1000)
+    #   * Children.all(:age.gte => 18).adjust(:allowance => -100)
+    #
+    # @param attributes <Hash> A hash of attributes to adjust, and their adjustment
+    # @param reload <FalseClass,TrueClass> If true, affected objects will be reloaded
+    #
+    # @public
+    def adjust!(attributes = {}, reload = false)
+      return true if attributes.empty?
+
+      adjust_attributes = {}
+
+      model.properties(repository.name).slice(*attributes.keys).each do |property|
+        adjust_attributes[property] = attributes[property.name] if property
+      end
+
+      each { |r| attributes.each_pair{|a,v| r.attribute_set(a,r.send(a) + v) }; r.save } if loaded?
+
+      # if none of the attributes that are adjusted is part of the collection-query
+      # there is no need to load the collection (it will not change after adjustment)
+      # if the query contains a raw sql-string, we cannot (truly) know, and must load.
+      altered = query.conditions.detect{|c| adjust_attributes.include?(c[1]) || c[0] == :raw }
+
+      if identity_map.any? && reload
+        reload_query = @key_properties.zip(identity_map.keys.transpose).to_hash
+        reload_query = all(reload_query.merge(:fields => @key_properties)).send(:keys) if altered
+      end
+
+      repository.adjust(adjust_attributes,scoped_query)
+
+      # Reload affected objects in identity-map. if collection was affected, dont use the scope.
+      (altered ? model : self).all(reload_query).reload(:fields => attributes.keys) if reload_query && reload_query.any?
+
+      # if preload was set to false, and collection was affected by updates,
+      # something is now officially borked. We'll try the best we can (still many cases this is borked for)
+      query.conditions.each do |c|
+        if adjustment = adjust_attributes[c[1]]
+          case c[2]
+            when Numeric then c[2] += adjustment
+            when Range   then c[2] = (c[2].first+adjustment)..(c[2].last+adjustment)
+          end if adjustment = adjust_attributes[c[1]]
+        end
+      end if altered
+
+      return true
+
+    end # adjust
+  end # Collection
+end # DataMapper

data/lib/dm-adjust/model.rb

@@ -0,0 +1,17 @@
+module DataMapper
+  module Model
+
+    ##
+    # increment or decrement attributes on all objects in a resource
+    #
+    # @example [Usage]
+    #   * People.adjust(:salary => +1000)
+    #   * Children.adjust(:allowance => -100)
+    #
+    # @param attributes <Hash> A hash of attributes to adjust, and their adjustment
+    # @public
+    def adjust!(attributes,reload=false)
+      all.adjust!(attributes,reload)
+    end
+  end
+end

data/lib/dm-adjust/repository.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  class Repository
+    def adjust(attributes, query)
+      adapter.adjust(attributes, query)
+    end
+  end
+end

data/spec/integration/adjust_spec.rb

@@ -0,0 +1,61 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+
+  class Person
+    include DataMapper::Resource
+    property :id, Integer, :serial => true
+    property :name, String
+    property :salary, Integer, :default => 20000
+    property :age, Integer
+  end
+
+  describe 'Adjust' do
+
+    before :all do
+      Person.auto_migrate!(:default)
+      Person.create(:name => 'George', :age => 15)
+      Person.create(:name => 'Puff',   :age => 18)
+      Person.create(:name => 'Danny',  :age => 26)
+      Person.create(:name => 'Selma',  :age => 28)
+      Person.create(:name => 'John',   :age => 49)
+      Person.create(:name => 'Amadeus',:age => 60)
+    end
+
+    describe 'Resource#adjust!' do
+      it 'should adjust values' do
+        repository(:default) do
+          p = Person.get(1)
+          p.salary.should == 20000
+          Person.adjust!({:salary => 1000},true)
+          Person.all.each{|p| p.salary.should == 21000}
+        end
+      end
+    end
+
+    describe 'Collection#adjust!' do
+      it 'should adjust values' do
+        repository(:default) do |repos|
+          @oldies = Person.all(:age.gte => 40)
+          @oldies.adjust!({:salary => 5000},true)
+          @oldies.each{|p| p.salary.should == 25000}
+
+          Person.get(1).salary.should == 20000
+
+          @children = Person.all(:age.lte => 18)
+          @children.adjust!({:salary => -10000},true)
+          @children.each{|p| p.salary.should == 10000}
+        end
+      end
+
+      it 'should load the query if conditions were adjusted' do
+        repository(:default) do |repos|
+          @specific = Person.all(:salary => 25000)
+          @specific.adjust!({:salary => 5000},true)
+          @specific.length.should == 2
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-adjust'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '=0.9.3'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    # DataObjects::Sqlite3.logger = DataObjects::Logger.new(Pathname(__FILE__).dirname+'dm.log',0)
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: dm-adjust
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- Sindre Aarsaether
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-30 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: DataMapper plugin providing methods to increment and decrement properties
+email: sindre [a] identu [d] no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- lib/dm-adjust/adapters/data_objects_adapter.rb
+- lib/dm-adjust/collection.rb
+- lib/dm-adjust/model.rb
+- lib/dm-adjust/repository.rb
+- lib/dm-adjust.rb
+- spec/integration/adjust_spec.rb
+- spec/spec_helper.rb
+- spec/spec.opts
+- Rakefile
+- README
+- LICENSE
+- TODO
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-adjust
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin providing methods to increment and decrement properties
+test_files: []
+