ardm-aggregates 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecc4059ba433d1b0f1b8426199e49066d4255056
+  data.tar.gz: 904bc2974761000ee8984d97ca480ccc037fc6d7
+SHA512:
+  metadata.gz: 91b095a0f69ee89c481ca25f3cddc9bb5423c9c676408961f3daf09763aa6f2875f9af3e92a49e0d70d714ab86d9c3b5906b790919fab0fb4bc1bab9f89847d1
+  data.tar.gz: 835503ebe41fb7e7fbc3545674fa5e24c7af261736492547f3e01c612e8a6274734f625be04f3f828e7df7a48b7bdfd40fd3a616f5628486227815b362c68d71

data/.gitignore

@@ -0,0 +1,35 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+
+## PROJECT::GENERAL
+*.gem
+coverage
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.*
+
+## PROJECT::SPECIFIC
+spec/db/

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+matrix:
+  allow_failures:
+    - rvm: 2.1.5
+    - rvm: 2.2.0

data/Gemfile

@@ -0,0 +1,55 @@
+require 'pathname'
+
+source 'https://rubygems.org'
+
+gemspec
+
+SOURCE         = ENV.fetch('SOURCE', :git).to_sym
+REPO_POSTFIX   = SOURCE == :path ? ''                                : '.git'
+DATAMAPPER     = SOURCE == :path ? Pathname(__FILE__).dirname.parent : 'http://github.com/ar-dm'
+DM_VERSION     = '~> 1.2.0'
+DO_VERSION     = '~> 0.10.6'
+DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
+CURRENT_BRANCH = ENV.fetch('GIT_BRANCH', 'master')
+
+gem 'ardm-core',     DM_VERSION,
+  SOURCE  => "#{DATAMAPPER}/ardm-core#{REPO_POSTFIX}",
+  :branch => CURRENT_BRANCH
+
+group :datamapper do
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    do_options = {}
+    do_options[:git] = "#{DATAMAPPER}/do#{REPO_POSTFIX}" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects', DO_VERSION, do_options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, do_options.dup
+    end
+
+    gem 'ardm-do-adapter', DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/ardm-do-adapter#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+  adapters.each do |adapter|
+    gem "ardm-#{adapter}-adapter", DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/ardm-#{adapter}-adapter#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('ardm-migrations').uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/#{plugin}#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Foy Savas
+
+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.rdoc

@@ -0,0 +1,45 @@
+dm-aggregates
+=============
+
+DataMapper plugin providing support for aggregates, functions on collections and datasets.
+
+It provides the following functions:
+
+== count
+
+Count results (given the conditions)
+
+ Friend.count # returns count of all friends
+ Friend.count(:age.gt => 18) # returns count of all friends older then 18
+ Friend.count(:conditions => [ 'gender = ?', 'female' ]) # returns count of all your female friends
+ Friend.count(:address) # returns count of all friends with an address (NULL values are not included)
+ Friend.count(:address, :age.gt => 18) # returns count of all friends with an address that are older then 18
+ Friend.count(:address, :conditions => [ 'gender = ?', 'female' ]) # returns count of all your female friends with an address
+
+== min
+
+Get the lowest value of a property
+
+ Friend.min(:age) # returns the age of the youngest friend
+ Friend.min(:age, :conditions => [ 'gender = ?', 'female' ]) # returns the age of the youngest female friends
+
+== max
+
+Get the highest value of a property
+
+ Friend.max(:age) # returns the age of the oldest friend
+ Friend.max(:age, :conditions => [ 'gender = ?', 'female' ]) # returns the age of the oldest female friends
+
+== avg
+
+Get the average value of a property
+
+ Friend.avg(:age) # returns the average age of friends
+ Friend.avg(:age, :conditions => [ 'gender = ?', 'female' ]) # returns the average age of the female friends
+
+== sum
+
+Get the total value of a property
+
+ Friend.sum(:age) # returns total age of all friends
+ Friend.max(:age, :conditions => [ 'gender = ?', 'female' ]) # returns the total age of all female friends

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rake'
+
+FileList['tasks/**/*.rake'].each { |task| import task }

data/VERSION

@@ -0,0 +1 @@
+1.2.0

data/ardm-aggregates.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dm-aggregates/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name             = "ardm-aggregates"
+  gem.version          = DataMapper::Aggregates::VERSION
+
+  gem.authors          = [ 'Martin Emde', 'Emmanuel Gomez' ]
+  gem.email            = [ 'me@martinemde.com', "emmanuel.gomez@gmail.com" ]
+  gem.summary          = "Ardm fork of dm-aggregates"
+  gem.description      = "DataMapper plugin providing support for aggregates on collections"
+  gem.homepage         = "https://github.com/ar-dm/ardm-aggregates"
+  gem.license          = 'MIT'
+
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  gem.extra_rdoc_files = %w[LICENSE README.rdoc]
+  gem.require_paths    = [ "lib" ]
+
+  gem.add_runtime_dependency 'ardm-core', '~> 1.2'
+
+  gem.add_development_dependency 'rake',  '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 1.3'
+end

data/lib/ardm-aggregates.rb

@@ -0,0 +1 @@
+require 'dm-aggregates'

data/lib/dm-aggregates.rb

@@ -0,0 +1,60 @@
+require 'dm-core'
+
+require 'dm-aggregates/aggregate_functions'
+require 'dm-aggregates/collection'
+require 'dm-aggregates/core_ext/symbol'
+require 'dm-aggregates/model'
+require 'dm-aggregates/query'
+require 'dm-aggregates/repository'
+
+module DataMapper
+  module Aggregates
+    def self.include_aggregate_api
+      [ :Repository, :Model, :Collection, :Query ].each do |name|
+        DataMapper.const_get(name).send(:include, const_get(name))
+      end
+      Adapters::AbstractAdapter.descendants.each do |adapter_class|
+        Adapters.include_aggregate_api(DataMapper::Inflector.demodulize(adapter_class.name))
+      end
+    end
+  end
+
+  module Adapters
+
+    def self.include_aggregate_api(const_name)
+      require aggregate_extensions(const_name)
+      if Aggregates.const_defined?(const_name)
+        adapter = const_get(const_name)
+        adapter.send(:include, aggregate_module(const_name))
+      end
+    rescue LoadError
+      # Silently ignore the fact that no adapter extensions could be required
+      # This means that the adapter in use doesn't support aggregates
+    end
+
+    def self.aggregate_module(const_name)
+      Aggregates.const_get(const_name)
+    end
+
+    class << self
+    private
+      # @api private
+      def aggregate_extensions(const_name)
+        name = adapter_name(const_name)
+        name = 'do' if name == 'dataobjects'
+        "dm-aggregates/adapters/dm-#{name}-adapter"
+      end
+    end
+
+    extendable do
+      # @api private
+      def const_added(const_name)
+        include_aggregate_api(const_name)
+        super
+      end
+    end
+  end # module Adapters
+
+  Aggregates.include_aggregate_api
+
+end # module DataMapper

data/lib/dm-aggregates/adapters/dm-do-adapter.rb

@@ -0,0 +1,100 @@
+module DataMapper
+  module Aggregates
+    module DataObjectsAdapter
+      extend Chainable
+
+      def aggregate(query)
+        fields = query.fields
+        types  = fields.map { |p| p.respond_to?(:operator) ? String : p.primitive }
+
+        field_size = fields.size
+
+        records = []
+
+        with_connection do |connection|
+          statement, bind_values = select_statement(query)
+
+          command = connection.create_command(statement)
+          command.set_types(types)
+
+          reader = command.execute_reader(*bind_values)
+
+          begin
+            while(reader.next!)
+              row = fields.zip(reader.values).map do |field, value|
+                if field.respond_to?(:operator)
+                  send(field.operator, field.target, value)
+                else
+                  field.load(value)
+                end
+              end
+
+              records << (field_size > 1 ? row : row[0])
+            end
+          ensure
+            reader.close
+          end
+        end
+
+        records
+      end
+
+      private
+
+      def count(property, value)
+        value.to_i
+      end
+
+      def min(property, value)
+        property.load(value)
+      end
+
+      def max(property, value)
+        property.load(value)
+      end
+
+      def avg(property, value)
+        property.primitive == ::Integer ? value.to_f : property.load(value)
+      end
+
+      def sum(property, value)
+        property.load(value)
+      end
+
+      chainable do
+        def property_to_column_name(property, qualify)
+          case property
+            when DataMapper::Query::Operator
+              aggregate_field_statement(property.operator, property.target, qualify)
+
+            when Property, DataMapper::Query::Path
+              super
+
+            else
+              raise ArgumentError, "+property+ must be a DataMapper::Query::Operator, a DataMapper::Property or a Query::Path, but was a #{property.class} (#{property.inspect})"
+          end
+        end
+      end
+
+      def aggregate_field_statement(aggregate_function, property, qualify)
+        column_name = if aggregate_function == :count && property == :all
+          '*'
+        else
+          property_to_column_name(property, qualify)
+        end
+
+        function_name = case aggregate_function
+          when :count then 'COUNT'
+          when :min   then 'MIN'
+          when :max   then 'MAX'
+          when :avg   then 'AVG'
+          when :sum   then 'SUM'
+          else raise "Invalid aggregate function: #{aggregate_function.inspect}"
+        end
+
+        "#{function_name}(#{column_name})"
+      end
+
+    end # class DataObjectsAdapter
+  end # module Aggregates
+end # module DataMapper

data/lib/dm-aggregates/aggregate_functions.rb

@@ -0,0 +1 @@
+require 'dm-aggregates/functions'

data/lib/dm-aggregates/collection.rb

@@ -0,0 +1,13 @@
+module DataMapper
+  module Aggregates
+    module Collection
+      include Functions
+
+      private
+
+      def property_by_name(property_name)
+        properties[property_name]
+      end
+    end
+  end
+end

data/lib/dm-aggregates/core_ext/symbol.rb

@@ -0,0 +1,7 @@
+require 'dm-aggregates/operators'
+
+class Symbol
+
+  include DataMapper::Aggregates::Operators
+
+end

data/lib/dm-aggregates/functions.rb

@@ -0,0 +1,232 @@
+module DataMapper
+  module Aggregates
+    module Functions
+      include DataMapper::Assertions
+
+      # Count results (given the conditions)
+      #
+      # @example the count of all friends
+      #   Friend.count
+      #
+      # @example the count of all friends older then 18
+      #   Friend.count(:age.gt => 18)
+      #
+      # @example the count of all your female friends
+      #   Friend.count(:conditions => [ 'gender = ?', 'female' ])
+      #
+      # @example the count of all friends with an address (NULL values are not included)
+      #   Friend.count(:address)
+      #
+      # @example the count of all friends with an address that are older then 18
+      #   Friend.count(:address, :age.gt => 18)
+      #
+      # @example the count of all your female friends with an address
+      #   Friend.count(:address, :conditions => [ 'gender = ?', 'female' ])
+      #
+      # @param property [Symbol] of the property you with to count (optional)
+      # @param  opts [Hash, Symbol] the conditions
+      #
+      # @return [Integer] return the count given the conditions
+      #
+      # @api public
+      def count(*args)
+        query         = args.last.kind_of?(Hash) ? args.pop : {}
+        property_name = args.first
+
+        if property_name
+          assert_kind_of 'property', property_by_name(property_name), Property
+        end
+
+        aggregate(query.merge(:fields => [ property_name ? property_name.count : :all.count ])).to_i
+      end
+
+      # Get the lowest value of a property
+      #
+      # @example the age of the youngest friend
+      #   Friend.min(:age)
+      #
+      # @example  the age of the youngest female friend
+      #   Friend.min(:age, :conditions => [ 'gender = ?', 'female' ])
+      #
+      # @param property [Symbol] the property you wish to get the lowest value of
+      # @param  opts [Hash, Symbol] the conditions
+      #
+      # @return [Integer] return the lowest value of a property given the conditions
+      #
+      # @api public
+      def min(*args)
+        query         = args.last.kind_of?(Hash) ? args.pop : {}
+        property_name = args.first
+
+        assert_property_type property_name, ::Integer, ::Float, ::BigDecimal, ::DateTime, ::Date, ::Time
+
+        aggregate(query.merge(:fields => [ property_name.min ]))
+      end
+
+      # Get the highest value of a property
+      #
+      # @example the age of the oldest friend
+      #   Friend.max(:age)
+      #
+      # @example the age of the oldest female friend
+      #   Friend.max(:age, :conditions => [ 'gender = ?', 'female' ])
+      #
+      # @param property [Symbol] the property you wish to get the highest value of
+      # @param  opts [Hash, Symbol] the conditions
+      #
+      # @return [Integer] return the highest value of a property given the conditions
+      #
+      # @api public
+      def max(*args)
+        query         = args.last.kind_of?(Hash) ? args.pop : {}
+        property_name = args.first
+
+        assert_property_type property_name, ::Integer, ::Float, ::BigDecimal, ::DateTime, ::Date, ::Time
+
+        aggregate(query.merge(:fields => [ property_name.max ]))
+      end
+
+      # Get the average value of a property
+      #
+      # @example the average age of all friends
+      #   Friend.avg(:age)
+      #
+      # @example the average age of all female friends
+      #   Friend.avg(:age, :conditions => [ 'gender = ?', 'female' ])
+      #
+      # @param property [Symbol] the property you wish to get the average value of
+      # @param  opts [Hash, Symbol] the conditions
+      #
+      # @return [Integer] return the average value of a property given the conditions
+      #
+      # @api public
+      def avg(*args)
+        query         = args.last.kind_of?(Hash) ? args.pop : {}
+        property_name = args.first
+
+        assert_property_type property_name, ::Integer, ::Float, ::BigDecimal
+
+        aggregate(query.merge(:fields => [ property_name.avg ]))
+      end
+
+      # Get the total value of a property
+      #
+      # @example the total age of all friends
+      #   Friend.sum(:age)
+      #
+      # @example the total age of all female friends
+      #   Friend.max(:age, :conditions => [ 'gender = ?', 'female' ])
+      #
+      # @param property [Symbol] the property you wish to get the total value of
+      # @param  opts [Hash, Symbol] the conditions
+      #
+      # @return [Integer] return the total value of a property given the conditions
+      #
+      # @api public
+      def sum(*args)
+        query         = args.last.kind_of?(::Hash) ? args.pop : {}
+        property_name = args.first
+
+        assert_property_type property_name, ::Integer, ::Float, ::BigDecimal
+
+        aggregate(query.merge(:fields => [ property_name.sum ]))
+      end
+
+      # Perform aggregate queries
+      #
+      # @example the count of friends
+      #   Friend.aggregate(:all.count)
+      #
+      # @example the minimum age, the maximum age and the total age of friends
+      #   Friend.aggregate(:age.min, :age.max, :age.sum)
+      #
+      # @example the average age, grouped by gender
+      #   Friend.aggregate(:age.avg, :fields => [ :gender ])
+      #
+      # @param aggregates [Symbol, ...] operators to aggregate with
+      # @param query [Hash] the conditions
+      #
+      # @return [Array,Numeric,DateTime,Date,Time] the results of the
+      #   aggregate query
+      #
+      # @api public
+      def aggregate(*args)
+        query = args.last.kind_of?(Hash) ? args.pop : {}
+
+        query[:fields] ||= []
+        query[:fields]  |= args
+        query[:fields].map! { |f| normalize_field(f) }
+
+        raise ArgumentError, 'query[:fields] must not be empty' if query[:fields].empty?
+
+        unless query.key?(:order)
+          # the current collection/model is already sorted by attributes
+          # and since we are projecting away some of the attributes,
+          # and then performing aggregate functions on the remainder,
+          # we need to honor the existing order, as if it were already
+          # materialized, and we are looping over the rows in order.
+
+          directions = direction_map
+
+          query[:order] = []
+
+          # use the current query order for each property if available
+          query[:fields].each do |property|
+            next unless property.kind_of?(Property)
+            query[:order] << directions.fetch(property, property)
+          end
+        end
+
+        query = scoped_query(query)
+
+        if query.fields.any? { |p| p.kind_of?(Property) }
+          query.repository.aggregate(query.update(:unique => true))
+        else
+          query.repository.aggregate(query).first  # only return one row
+        end
+      end
+
+      private
+
+      def assert_property_type(name, *types)
+        if name.nil?
+          raise ArgumentError, 'property name must not be nil'
+        end
+
+        property = property_by_name(name)
+        type     = property.primitive
+
+        unless types.include?(type)
+          raise ArgumentError, "#{name} must be #{types * ' or '}, but was #{type}"
+        end
+      end
+
+      def normalize_field(field)
+        assert_kind_of 'field', field, DataMapper::Query::Operator, Symbol, Property
+
+        case field
+          when DataMapper::Query::Operator
+            if field.target == :all
+              field
+            else
+              field.class.new(property_by_name(field.target), field.operator)
+            end
+
+          when Symbol
+            property_by_name(field)
+
+          when Property
+            field
+        end
+      end
+
+      def direction_map
+        direction_map = {}
+        self.query.order.each do |direction|
+          direction_map[direction.target] = direction
+        end
+        direction_map
+      end
+    end
+  end
+end