birddog 0.0.4 → 0.0.5

data/Gemfile

@@ -3,6 +3,6 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in birddog.gemspec
 gemspec
 
-group :development do 
-  gem "ruby-debug19", :require => 'ruby-debug'
+group :development, :test do 
+  gem 'pry'
 end

data/birddog.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "minitest"
   s.add_development_dependency "rake"
   s.add_development_dependency "sqlite3-ruby"
+  s.add_development_dependency "pry"
 
   s.add_runtime_dependency "chronic"
   s.add_runtime_dependency "activerecord"

data/lib/birddog/birddog.rb

@@ -8,12 +8,17 @@ module Birddog
     include ::Birddog::FieldConditions
 
     AREL_KEYS = [:select, :limit, :joins, :includes, :group, :from, :where, :having]
-
     attr_reader :fields
 
     def initialize(model)
       @model = model
       @fields = {}
+      @averagable = []
+      @minimumable = []
+      @maximumable = []
+      @sumable = []
+
+      define_common_aggregates_for(model)
     end
 
     def field(name, options={}, &mapping)
@@ -42,6 +47,30 @@ module Birddog
       aggregate?(name) ? define_aggregate_field(name, @fields[name]) : define_field(name, @fields[name])
     end
 
+    def averagable(*fields)
+      fields.flatten.each do |avg_field|
+        @averagable << avg_field
+      end
+    end
+
+    def minimumable(*fields)
+      fields.flatten.each do |min_field|
+        @minimumable << min_field
+      end
+    end
+
+    def maximumable(*fields)
+      fields.flatten.each do |max_field|
+        @maximumable << max_field 
+      end
+    end
+
+    def sumable(*fields)
+      fields.flatten.each do |sum_field|
+        @sumable << sum_field
+      end
+    end
+
     def keyword(name, &block)
       define_scope(name, &block)
     end
@@ -95,12 +124,16 @@ module Birddog
     end
     private :scope_name_for
 
+    def define_static_scope(name, &scope)
+      @model.__send__(:scope, name, scope)
+    end
+    private :define_static_scope
+
     def define_scope(name, &scope)
-      @model.send(:scope, scope_name_for(name), scope)
+      @model.__send__(:scope, scope_name_for(name), scope)
     end
     private :define_scope
 
-
     def callable_or_cast(field, condition, value)
       if field[:cast] && field[:cast].respond_to?(:call) 
         field[:cast].call(value.gsub(condition, ""))
@@ -162,17 +195,106 @@ module Birddog
     end
     private :tokenize
 
+    def define_common_aggregates_for(model)
+      _common_average_for(model)
+      _common_sum_for(model)
+      _common_minimum_for(model)
+      _common_maximum_for(model)
+    end
+    private :define_common_aggregates_for
+
+    def _common_average_for(model)
+      define_static_scope(:_birddog_average) do |field, value|
+        field_name = "average_#{field}"
+        scope = { :select => @model.arel_table[field].average.as(field_name) }
+        warn_common_aggregate_conditional if conditional?(value)
+        scope
+      end
+    end
+    private :_common_average_for
+
+    def _common_sum_for(model)
+      define_static_scope(:_birddog_sum) do |field, value|
+        field_name = "sum_#{field}"
+        scope = { :select => @model.arel_table[field].sum.as(field_name) }
+        warn_common_aggregate_conditional if conditional?(value)
+        scope
+      end
+    end
+    private :_common_sum_for
+      
+    def _common_minimum_for(model)
+      define_static_scope(:_birddog_minimum) do |field, value|
+        field_name = "minimum_#{field}"
+        scope = { :select => @model.arel_table[field].minimum.as(field_name) }
+        warn_common_aggregate_conditional if conditional?(value)
+        scope
+      end
+    end
+    private :_common_minimum_for
+
+    def _common_maximum_for(model)
+      define_static_scope(:_birddog_maximum) do |field, value|
+        field_name = "maximum_#{field}"
+        scope = { :select => @model.arel_table[field].maximum.as(field_name) }
+        warn_common_aggregate_conditional if conditional?(value)
+        scope
+      end
+    end
+    private :_common_maximum_for
+
+    def aggregate_scope_for(model, key, value)
+      aggregate_scope = nil
+      field_name = nil
+      key = key.to_s
+
+      case 
+      when key =~ /^(average_)([a-zA-Z_]*)/ && @averagable.include?($2.to_sym) then
+        aggregate_scope = "_birddog_average"
+        field_name = $2
+      when key =~ /^(sum_)([a-zA-Z_]*)/ && @sumable.include?($2.to_sym) then
+        aggregate_scope = "_birddog_sum"
+        field_name = $2
+      when key =~ /^(minimum_)([a-zA-Z_]*)/ && @minimumable.include?($2.to_sym) then
+        aggregate_scope = "_birddog_minimum"
+        field_name = $2
+      when key =~ /^(maximum_)([a-zA-Z_]*)/ && @maximumable.include?($2.to_sym) then
+        aggregate_scope = "_birddog_maximum"
+        field_name = $2
+      end
+
+      [aggregate_scope, field_name]
+    end
+    private :aggregate_scope_for
+ 
     def scope_for(model, key, value)
-      scope_name = scope_name_for(key)
+      scope_name, field = aggregate_scope_for(model, key, value)
+      scope_name = scope_name_for(key) unless scope_name
 
       if model.respond_to?(scope_name)
-        model.send(scope_name, value)
+        send_params = [field, value].compact
+        model.__send__(scope_name, *send_params)
       else
         model.scoped
       end
     end
     private :scope_for
 
+    def warn_common_aggregate_conditional
+      raise "WARNING"
+    rescue => e
+      warn <<-WARNING
+      ===================================================================
+      Birddog currently does not process conditionals on common aggregates
+      your program may not behave as expected.
+
+      Called at:
+
+      #{e.backtrace.join("#{$/}      ")}
+      ===================================================================
+      WARNING
+    end
+
   end
 
 end

data/lib/birddog/version.rb

@@ -1,3 +1,3 @@
 module Birddog
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/specs/common_aggregates_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Birddog::Birddog do
+  before :each do
+    User.destroy_all
+    Product.destroy_all
+    @john = User.create(:first_name => "John", :last_name => "Doe")
+    @ducky = @john.products.create(:name => "Rubber Duck", :value => 10)
+    @tv = @john.products.create(:name => "TV", :value => 200)
+    @bike = @john.products.create(:name => "Bike", :value => 100)
+  end
+
+  describe "averagable" do 
+    it "implements the common average scope" do 
+      Product.must_respond_to(:_birddog_average)
+    end
+
+    it "creates a query on the column desired when scope is average_*" do 
+      sql = Product.scopes_for_query("average_value").to_sql
+      sql.must_match(/value/)
+    end
+
+    it "calculates the average and returns it in the result set" do 
+      avg = Product.scopes_for_query("average_value").first
+      avg.average_value.must_equal((100 + 200 + 10) / 3.0)
+    end
+  end
+
+  describe "minimumable" do 
+    it "implements the common minimum scope" do 
+      Product.must_respond_to(:_birddog_minimum)
+    end
+
+    it "creates a query on the column desired when scope is minimum_*" do 
+      sql = Product.scopes_for_query("minimum_value").to_sql
+      sql.must_match(/minimum/)
+    end
+
+    it "calculates the minimum and returns it in the result set" do 
+      avg = Product.scopes_for_query("minimum_value").first
+      avg.minimum_value.must_equal(10)
+    end
+  end
+
+  describe "maximumable" do 
+    it "implements the common maximum scope" do 
+      Product.must_respond_to(:_birddog_maximum)
+    end
+
+    it "creates a query on the column desired when scope is maximum_*" do 
+      sql = Product.scopes_for_query("maximum_value").to_sql
+      sql.must_match(/maximum/)
+    end
+
+    it "calculates the maximum and returns it in the result set" do 
+      avg = Product.scopes_for_query("maximum_value").first
+      avg.maximum_value.must_equal(200)
+    end
+  end
+
+  describe "sumable" do 
+    it "implements the common sum scope" do 
+      Product.must_respond_to(:_birddog_sum)
+    end
+
+    it "creates a query on the column desired when scope is sum_*" do 
+      sql = Product.scopes_for_query("sum_value").to_sql
+      sql.must_match(/sum/)
+    end
+
+    it "calculates the sum and returns it in the result set" do 
+      avg = Product.scopes_for_query("sum_value").first
+      avg.sum_value.must_equal(310)
+    end
+  end
+end

data/specs/complex_scope_spec.rb

@@ -23,7 +23,6 @@ describe Birddog::Birddog do
 
     it "casts Date when a cast function is provided and is >" do 
       prods = Product.scopes_for_query("cast_val:>9")
-      debugger
       prods.must_include(@ducky)
     end
   end

data/specs/spec_helper.rb

@@ -62,6 +62,10 @@ class Product < ActiveRecord::Base
   belongs_to :user
 
   birddog do |search|
+    search.averagable :value
+    search.minimumable :value
+    search.maximumable :value
+    search.sumable :value
     search.text_search "products.name", "products.value"
 
     search.field :name, :regex => true, :wildcard => true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: birddog
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000Z
+date: 2012-02-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &24507660 !ruby/object:Gem::Requirement
+  requirement: &12855260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24507660
+  version_requirements: *12855260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &24507020 !ruby/object:Gem::Requirement
+  requirement: &12854640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24507020
+  version_requirements: *12854640
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &24506140 !ruby/object:Gem::Requirement
+  requirement: &12854040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24506140
+  version_requirements: *12854040
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &12853440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12853440
 - !ruby/object:Gem::Dependency
   name: chronic
-  requirement: &24505460 !ruby/object:Gem::Requirement
+  requirement: &12852700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *24505460
+  version_requirements: *12852700
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &24504040 !ruby/object:Gem::Requirement
+  requirement: &12852260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *24504040
+  version_requirements: *12852260
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &24503320 !ruby/object:Gem::Requirement
+  requirement: &12851700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *24503320
+  version_requirements: *12851700
 - !ruby/object:Gem::Dependency
   name: squeel
-  requirement: &24502200 !ruby/object:Gem::Requirement
+  requirement: &12850900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *24502200
+  version_requirements: *12850900
 description: Seeeeeeeee Readme
 email:
 - brandonsdewitt@gmail.com
@@ -109,6 +120,7 @@ files:
 - lib/birddog/searchable.rb
 - lib/birddog/version.rb
 - specs/birddog_spec.rb
+- specs/common_aggregates_spec.rb
 - specs/complex_scope_spec.rb
 - specs/field_conditions_spec.rb
 - specs/spec_helper.rb
@@ -127,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -387631044094105301
+      hash: -1855020977643402553
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -136,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -387631044094105301
+      hash: -1855020977643402553
 requirements: []
 rubyforge_project: birddog
 rubygems_version: 1.8.10