pacecar 1.3.0 → 1.4.0

data/README.rdoc

@@ -8,6 +8,17 @@ To get all Pacecar functionality, you need to "include Pacecar" in your class.
 
 To get some subset (for example, only the state functionality), you can do something like "include Pacecar::State" to get only the module(s) you want.
 
+== Installation
+
+For rails 3, just include in your Gemfile
+
+  gem 'pacecar'
+
+For prior rails versions, there is a rails2 branch to use:
+
+  gem 'pacecar', :git => 'git://github.com/thoughtbot/pacecar.git', :branch => 'rails2'
+
+
 == Usage
 
 Assuming a database schema...
@@ -183,6 +194,15 @@ Query methods on instances to check state...
   Post.first.publication_state_draft?
   Post.last.post_type_not_open?
 
+= Numeric columns
+
+Records which are greater than or less than a certain value...
+
+  User.age_greater_than(21)
+  User.age_greater_than_or_equal_to(21)
+  User.age_less_than(21)
+  User.age_less_than_or_equal_to(21)
+
 = Limits
 
 First x records...

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pacecar
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 7
   prerelease: false
   segments: 
   - 1
-  - 3
+  - 4
   - 0
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Matt Jankowski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 -04:00
+date: 2010-12-04 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -29,21 +29,8 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - init.rb
-- lib/pacecar/associations.rb
-- lib/pacecar/boolean.rb
-- lib/pacecar/datetime.rb
-- lib/pacecar/duration.rb
-- lib/pacecar/helpers.rb
-- lib/pacecar/limit.rb
-- lib/pacecar/order.rb
-- lib/pacecar/polymorph.rb
-- lib/pacecar/presence.rb
-- lib/pacecar/ranking.rb
-- lib/pacecar/search.rb
-- lib/pacecar/state.rb
-- lib/pacecar.rb
-- MIT-LICENSE
 - README.rdoc
+- MIT-LICENSE
 has_rdoc: true
 homepage: http://github.com/thoughtbot/pacecar
 licenses: []

data/lib/pacecar.rb

@@ -1,32 +0,0 @@
-require 'pacecar/associations'
-require 'pacecar/boolean'
-require 'pacecar/datetime'
-require 'pacecar/duration'
-require 'pacecar/helpers'
-require 'pacecar/limit'
-require 'pacecar/order'
-require 'pacecar/polymorph'
-require 'pacecar/presence'
-require 'pacecar/ranking'
-require 'pacecar/search'
-require 'pacecar/state'
-
-module Pacecar
-  def self.included(base)
-    base.class_eval do
-      include Pacecar::Associations
-      include Pacecar::Boolean
-      include Pacecar::Datetime
-      include Pacecar::Duration
-      include Pacecar::Limit
-      include Pacecar::Order
-      include Pacecar::Polymorph
-      include Pacecar::Presence
-      include Pacecar::Ranking
-      include Pacecar::Search
-      include Pacecar::State
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, Pacecar::Helpers

data/lib/pacecar/associations.rb

@@ -1,39 +0,0 @@
-module Pacecar
-  module Associations
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-
-      def has_recent_records(*names)
-        names.each do |name|
-          scope "recent_#{name}_since".to_sym, lambda { |since|
-            {
-              :conditions => [conditions_for_name(name), { :since_time => since }]
-            }
-          }
-        end
-        unless names.first == names.last
-          scope "recent_#{names.join('_or_')}_since".to_sym, lambda { |since|
-            {
-              :conditions => [names.collect { |name| conditions_for_name(name) }.join(' or '), { :since_time => since }]
-            }
-          }
-          scope "recent_#{names.join('_and_')}_since".to_sym, lambda { |since|
-            {
-              :conditions => [names.collect { |name| conditions_for_name(name) }.join(' and '), { :since_time => since }]
-            }
-          }
-        end
-      end
-
-      protected
-
-      def conditions_for_name(name)
-        "((select count(*) from \"#{name}\" where \"#{name}\".#{reflections[name].primary_key_name} = #{quoted_table_name}.id and \"#{name}\".created_at > :since_time) > 0)"
-      end
-
-    end
-  end
-end

data/lib/pacecar/boolean.rb

@@ -1,34 +0,0 @@
-module Pacecar
-  module Boolean
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def self.extended(base)
-        base.send :define_boolean_scopes
-        base.send :define_balance_count
-      end
-
-      protected
-
-      def define_boolean_scopes
-        boolean_column_names.each do |name|
-          scope name.to_sym, :conditions => ["#{quoted_table_name}.#{name} = ?", true]
-          scope "not_#{name}".to_sym, :conditions => ["#{quoted_table_name}.#{name} = ?", false]
-        end
-      end
-
-      def define_balance_count
-        boolean_column_names.each do |name|
-          self.class_eval %Q{
-            def self.#{name}_balance
-              #{name}.count - not_#{name}.count
-            end
-          }
-        end
-      end
-
-    end
-  end
-end

data/lib/pacecar/datetime.rb

@@ -1,68 +0,0 @@
-module Pacecar
-  module Datetime
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def self.extended(base)
-        base.send :define_datetime_scopes
-      end
-
-      protected
-
-      def define_datetime_scopes
-        datetime_column_names.each do |name|
-          define_before_after_scopes(name)
-          define_past_future_scopes(name)
-          define_inside_outside_scopes(name)
-          define_in_date_scopes(name)
-        end
-      end
-
-      def define_before_after_scopes(name)
-        scope "#{name}_before".to_sym, lambda { |time|
-          { :conditions => ["#{quoted_table_name}.#{name} <= ?", time] }
-        }
-        scope "#{name}_after".to_sym, lambda { |time|
-          { :conditions => ["#{quoted_table_name}.#{name} >= ?", time] }
-        }
-      end
-
-      def define_past_future_scopes(name)
-        scope "#{name}_in_past", lambda {
-          { :conditions => ["#{quoted_table_name}.#{name} <= ?", now] }
-        }
-        scope "#{name}_in_future", lambda {
-          { :conditions => ["#{quoted_table_name}.#{name} >= ?", now] }
-        }
-      end
-
-      def define_inside_outside_scopes(name)
-        scope "#{name}_inside".to_sym, lambda { |start, stop|
-          { :conditions => ["#{quoted_table_name}.#{name} >= ? and #{quoted_table_name}.#{name} <= ?", start, stop] }
-        }
-        scope "#{name}_outside".to_sym, lambda { |start, stop|
-          { :conditions => ["#{quoted_table_name}.#{name} <= ? and #{quoted_table_name}.#{name} >= ?", start, stop] }
-        }
-      end
-
-      def define_in_date_scopes(name)
-        scope "#{name}_in_year".to_sym, lambda { |year|
-          { :conditions => ["year(#{quoted_table_name}.#{name}) = ?", year] }
-        }
-        scope "#{name}_in_month".to_sym, lambda { |month|
-          { :conditions => ["month(#{quoted_table_name}.#{name}) = ?", month] }
-        }
-        scope "#{name}_in_day".to_sym, lambda { |day|
-          { :conditions => ["day(#{quoted_table_name}.#{name}) = ?", day] }
-        }
-      end
-
-      def now
-        defined?(Time.zone_default) && Time.zone_default ? Time.zone_default.now : Time.now
-      end
-
-    end
-  end
-end

data/lib/pacecar/duration.rb

@@ -1,28 +0,0 @@
-module Pacecar
-  module Duration
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def self.extended(base)
-        base.send :define_duration_scopes
-      end
-
-      protected
-
-      def define_duration_scopes
-        scope :with_duration_of, lambda { |duration, start, stop|
-          { :conditions => ["datediff(#{quoted_table_name}.#{start}, #{quoted_table_name}.#{stop}) = ?", duration] }
-        }
-        scope :with_duration_over, lambda { |duration, start, stop|
-          { :conditions => ["datediff(#{quoted_table_name}.#{start}, #{quoted_table_name}.#{stop}) > ?", duration] }
-        }
-        scope :with_duration_under, lambda { |duration, start, stop|
-          { :conditions => ["datediff(#{quoted_table_name}.#{start}, #{quoted_table_name}.#{stop}) < ?", duration] }
-        }
-      end
-
-    end
-  end
-end

data/lib/pacecar/helpers.rb

@@ -1,54 +0,0 @@
-module Pacecar
-  module Helpers
-
-    mattr_accessor :options
-    self.options = {
-      :state_pattern => /_(type|state)$/i,
-      :default_limit => 10
-    }
-
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-
-      def safe_columns
-        begin
-          columns
-        rescue ActiveRecord::StatementInvalid # If the table does not exist
-          Array.new
-        end
-      end
-      
-      def safe_column_names
-        safe_columns.collect(&:name)
-      end
-
-      def column_names_for_type(*types)
-        safe_columns.select { |column| types.include? column.type }.collect(&:name)
-      end
-
-      def column_names_without_type(*types)
-        safe_columns.select { |column| ! types.include? column.type }.collect(&:name)
-      end
-
-      def boolean_column_names
-        column_names_for_type :boolean
-      end
-
-      def datetime_column_names
-        column_names_for_type :datetime, :date
-      end
-
-      def text_and_string_column_names
-        column_names_for_type :text, :string
-      end
-
-      def non_state_text_and_string_columns
-        text_and_string_column_names.reject { |name| name =~ Pacecar::Helpers.options[:state_pattern] }
-      end
-
-    end
-  end
-end

data/lib/pacecar/limit.rb

@@ -1,22 +0,0 @@
-module Pacecar
-  module Limit
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def self.extended(base)
-        base.send :define_limit_scopes
-      end
-
-      protected
-
-      def define_limit_scopes
-        scope :limited, lambda { |*args|
-          { :limit => args.flatten.first || (defined?(per_page) ? per_page : Pacecar::Helpers.options[:default_limit]) }
-        }
-      end
-
-    end
-  end
-end

data/lib/pacecar/order.rb

@@ -1,24 +0,0 @@
-module Pacecar
-  module Order
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def self.extended(base)
-        base.send :define_order_scopes
-      end
-
-      protected
-
-      def define_order_scopes
-        safe_columns.collect(&:name).each do |name|
-          scope "by_#{name}".to_sym, lambda { |*args|
-            { :order => "#{quoted_table_name}.#{name} #{args.flatten.first || 'asc'}" }
-          }
-        end
-      end
-
-    end
-  end
-end

data/lib/pacecar/polymorph.rb

@@ -1,17 +0,0 @@
-module Pacecar
-  module Polymorph
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-
-      def has_polymorph(name)
-        scope "for_#{name}_type".to_sym, lambda { |type|
-          { :conditions => ["#{quoted_table_name}.#{name}_type = ?", type.to_s] }
-        }
-      end
-
-    end
-  end
-end

data/lib/pacecar/presence.rb

@@ -1,23 +0,0 @@
-module Pacecar
-  module Presence
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def self.extended(base)
-        base.send :define_presence_scopes
-      end
-
-      protected
-
-      def define_presence_scopes
-        column_names_without_type(:boolean).each do |name|
-          scope "#{name}_present".to_sym, :conditions => "#{quoted_table_name}.#{name} is not null"
-          scope "#{name}_missing".to_sym, :conditions => "#{quoted_table_name}.#{name} is null"
-        end
-      end
-
-    end
-  end
-end

data/lib/pacecar/ranking.rb

@@ -1,26 +0,0 @@
-module Pacecar
-  module Ranking
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-
-      def has_ranking(association)
-        define_ranking_scope association, :maximum, :desc
-        define_ranking_scope association, :minimum, :asc
-      end
-
-      protected
-
-      def define_ranking_scope(association, name, direction)
-        scope "#{name}_#{association}",
-        :joins => "inner join #{association} on #{association}.#{reflections[association].primary_key_name} = #{quoted_table_name}.#{primary_key}",
-        :select => "#{quoted_table_name}.*, count(#{quoted_table_name}.#{primary_key}) as #{association}_count",
-        :group => "#{association}.#{reflections[association].primary_key_name}",
-        :order => "#{association}_count #{direction}"
-      end
-
-    end
-  end
-end

data/lib/pacecar/search.rb

@@ -1,47 +0,0 @@
-module Pacecar
-  module Search
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def self.extended(base)
-        base.send :define_search_scopes
-        base.send :define_basic_search_scope
-      end
-
-      protected
-
-      def define_search_scopes
-        safe_column_names.each do |name|
-          scope "#{name}_equals".to_sym, lambda { |query|
-            { :conditions => ["#{quoted_table_name}.#{name} = :query", { :query => query }] }
-          }
-        end
-        text_and_string_column_names.each do |name|
-          scope "#{name}_matches".to_sym, lambda { |query|
-            { :conditions => ["#{quoted_table_name}.#{name} like :query", { :query => "%#{query}%" }] }
-          }
-          scope "#{name}_starts_with".to_sym, lambda { |query|
-            { :conditions => ["#{quoted_table_name}.#{name} like :query", { :query => "#{query}%" }] }
-          }
-          scope "#{name}_ends_with".to_sym, lambda { |query|
-            { :conditions => ["#{quoted_table_name}.#{name} like :query", { :query => "%#{query}" }] }
-          }
-        end
-      end
-
-      def define_basic_search_scope
-        scope :search_for, lambda { |*args|
-          opts = args.extract_options!
-          query = args.flatten.first
-          columns = opts[:on] || non_state_text_and_string_columns
-          joiner = opts[:require].eql?(:all) ? 'and' : 'or'
-          match = columns.collect { |name| "#{quoted_table_name}.#{name} like :query" }.join(" #{joiner} ")
-          { :conditions => [match, { :query => "%#{query}%" } ] }
-        }
-      end
-
-    end
-  end
-end

data/lib/pacecar/state.rb

@@ -1,36 +0,0 @@
-module Pacecar
-  module State
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-
-      def has_state(*names)
-        opts = names.extract_options!
-        names.each do |name|
-          constant = opts[:with] || const_get(name.to_s.pluralize.upcase)
-          constant.each do |state|
-            scope "#{name}_#{state.downcase}".to_sym, :conditions => ["#{quoted_table_name}.#{name} = ?", state]
-            scope "#{name}_not_#{state.downcase}".to_sym, :conditions => ["#{quoted_table_name}.#{name} <> ?", state]
-            self.class_eval %Q{
-              def #{name}_#{state.downcase}?
-                #{name} == '#{state}'
-              end
-              def #{name}_not_#{state.downcase}?
-                #{name} != '#{state}'
-              end
-            }
-          end
-          scope "#{name}".to_sym, lambda { |state|
-            { :conditions => ["#{quoted_table_name}.#{name} = ?", state] }
-          }
-          scope "#{name}_not".to_sym, lambda { |state|
-            { :conditions => ["#{quoted_table_name}.#{name} <> ?", state] }
-          }
-        end
-      end
-
-    end
-  end
-end