thoughtbot-pacecar 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008, Matt Jankowski & thoughtbot, inc.
+
+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,171 @@
+== Pacecar
+
+Pacecar adds named_scope methods to ActiveRecord classes via database column introspection.
+
+== Usage
+
+Assuming a database schema...
+
+  class CreateSchema < ActiveRecord::Migration
+    def self.up
+      create_table :users, :force => true do |t|
+        t.boolean :admin, :default => false, :null => false
+        t.datetime :approved_at
+        t.datetime :rejected_at
+        t.string :first_name
+        t.string :last_name
+        t.text :description
+        t.timestamps
+      end
+      create_table :posts, :force => true do |t|
+        t.string :owner_type
+        t.integer :owner_id
+        t.string :publication_state
+        t.string :post_type
+        t.timestamps
+      end
+      create_table :comments, :force => true do |t|
+        t.integer :user_id
+        t.text :description
+        t.timestamps
+      end
+    end
+  end
+
+And some basic model declarations...
+
+  class User < ActiveRecord::Base
+    has_many :posts, :as => :owner
+    has_many :comments
+    scopes_ranking :comments
+  end
+
+  class Post < ActiveRecord::Base
+    PUBLICATION_STATES = %w(Draft Submitted Rejected Accepted)
+    TYPES = %w(Free Open Private Anonymous PostModern)
+    belongs_to :owner, :polymorphic => true
+    scopes_state :publication_state
+    scopes_state :post_type, :with => TYPES
+    scopes_polymorph :owner
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :user
+  end
+
+= All columns
+
+Records where approved_at is not null, or where it is null...
+
+  User.approved_at_present
+  User.approved_at_missing
+
+Records where first_name is not null, or where it is null...
+
+  User.first_name_present
+  User.first_name_missing
+
+Records ordered by first_name (default to 'asc', can specify to override)...
+
+  User.by_first_name
+  User.by_first_name(:asc)
+  User.by_first_name(:desc)
+
+Records where an attribute matches a search term (column LIKE "%term%")...
+
+  User.first_name_matches('John')
+
+Records where an attribute starts or ends with a search term...
+
+  User.first_name_starts_with('A')
+  User.first_name_ends_with('a')
+
+Records where any non-state text or string column matches term...
+
+  User.search_for('test')
+
+Records where any of a list of columns match the term...
+
+  User.search_for 'test', :on => [:first_name, :last_name]
+
+Records where all of a list of columns match the term...
+
+  User.search_for 'test', :on => [:first_name, :last_name], :require => :all
+
+= Boolean columns
+
+Records that are all admins or non-admins...
+
+  User.admin
+  User.not_admin
+
+= Datetime columns
+
+Records approved before or after certain times...
+
+  User.approved_at_before(5.days.ago)
+  User.approved_at_after(4.weeks.ago)
+
+Records with approved_at in the past or future...
+
+  User.approved_at_in_past
+  User.approved_at_in_future
+
+Records with approved_at inside or outside of two times...
+
+  User.approved_at_inside(10.days.ago, 1.day.ago)
+  User.approved_at_outside(2.days.ago, 1.day.ago)
+
+Records with certain year, month or day...
+
+  User.approved_at_in_year(2000)
+  User.approved_at_in_month(01)
+  User.approved_at_in_day(01)
+
+Records with a duration (time delta between two columns) of, over or under a certain number of days...
+
+  User.with_duration_of(14, :approved_at, :rejected_at)
+  User.with_duration_over(14, :approved_at, :rejected_at)
+  User.with_duration_under(14, :approved_at, :rejected_at)
+
+= Polymorphic relationships
+
+Records which have an owner_type of User...
+
+  Post.for_owner_type(User)
+
+= Associations
+
+Records with the most and least associated records...
+
+  User.maximum_comments
+  User.minimum_comments
+
+= State columns
+
+Records which are in a particular state, or not in a state...
+
+  Post.publication_state_draft
+  Post.post_type_not_open
+
+= Limits
+
+First x records...
+
+  User.limited(10)
+
+= Named scopes
+
+Because these are all named_scope, you can combine them.
+
+To get all users that have a first_name set, who are admins and approved more than 2 weeks ago, ordered by their first name...
+
+  User.first_name_present.admin.approved_at_before(2.weeks.ago).by_first_name
+
+To get the top 10 commenters...
+
+  User.maximim_comments.limited(10)
+
+= License
+
+Pacecar is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/init.rb

@@ -0,0 +1 @@
+require 'pacecar'

data/lib/pacecar.rb

@@ -0,0 +1,47 @@
+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
+      extend ClassMethods
+      class << self
+        alias_method_chain :inherited, :define_scopes
+      end
+    end
+  end
+
+  module ClassMethods
+
+    protected
+
+    def inherited_with_define_scopes(child)
+      inherited_without_define_scopes(child)
+      child.class_eval do
+        include Pacecar::Helpers
+        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
+end
+
+ActiveRecord::Base.send :include, Pacecar

data/lib/pacecar/boolean.rb

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

data/lib/pacecar/datetime.rb

@@ -0,0 +1,64 @@
+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)
+        named_scope "#{name}_before".to_sym, lambda { |time|
+          { :conditions => ["#{quoted_table_name}.#{name} < ?", time] }
+        }
+        named_scope "#{name}_after".to_sym, lambda { |time|
+          { :conditions => ["#{quoted_table_name}.#{name} > ?", time] }
+        }
+      end
+
+      def define_past_future_scopes(name)
+        named_scope "#{name}_in_past", lambda { 
+          { :conditions => ["#{quoted_table_name}.#{name} < ?", Time.now] }
+        }
+        named_scope "#{name}_in_future", lambda {
+          { :conditions => ["#{quoted_table_name}.#{name} > ?", Time.now] }
+        }
+      end
+
+      def define_inside_outside_scopes(name)
+        named_scope "#{name}_inside".to_sym, lambda { |start, stop|
+          { :conditions => ["#{quoted_table_name}.#{name} > ? and #{quoted_table_name}.#{name} < ?", start, stop] }
+        }
+        named_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)
+        named_scope "#{name}_in_year".to_sym, lambda { |year|
+          { :conditions => ["year(#{quoted_table_name}.#{name}) = ?", year] }
+        }
+        named_scope "#{name}_in_month".to_sym, lambda { |month|
+          { :conditions => ["month(#{quoted_table_name}.#{name}) = ?", month] }
+        }
+        named_scope "#{name}_in_day".to_sym, lambda { |day|
+          { :conditions => ["day(#{quoted_table_name}.#{name}) = ?", day] }
+        }
+      end
+
+    end
+  end
+end

data/lib/pacecar/duration.rb

@@ -0,0 +1,28 @@
+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
+        named_scope :with_duration_of, lambda { |duration, start, stop|
+          { :conditions => ["datediff(#{quoted_table_name}.#{start}, #{quoted_table_name}.#{stop}) = ?", duration] }
+        }
+        named_scope :with_duration_over, lambda { |duration, start, stop|
+          { :conditions => ["datediff(#{quoted_table_name}.#{start}, #{quoted_table_name}.#{stop}) > ?", duration] }
+        }
+        named_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

@@ -0,0 +1,46 @@
+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 column_names
+        columns.collect(&:name)
+      end
+
+      def column_names_for_type(*types)
+        columns.select { |column| types.include? column.type }.collect(&:name)
+      end
+
+      def column_names_without_type(*types)
+        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
+      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

@@ -0,0 +1,22 @@
+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
+        named_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

@@ -0,0 +1,24 @@
+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
+        column_names.each do |name|
+          named_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

@@ -0,0 +1,17 @@
+module Pacecar
+  module Polymorph
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def scopes_polymorph(name)
+        named_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

@@ -0,0 +1,23 @@
+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|
+          named_scope "#{name}_present".to_sym, :conditions => "#{quoted_table_name}.#{name} is not null"
+          named_scope "#{name}_missing".to_sym, :conditions => "#{quoted_table_name}.#{name} is null"
+        end
+      end
+
+    end
+  end
+end

data/lib/pacecar/ranking.rb

@@ -0,0 +1,26 @@
+module Pacecar
+  module Ranking
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def scopes_ranking(association)
+        define_ranking_scope association, :maximum, :desc
+        define_ranking_scope association, :minimum, :asc
+      end
+
+      protected
+
+      def define_ranking_scope(association, name, direction)
+        named_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

@@ -0,0 +1,42 @@
+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
+        text_and_string_column_names.each do |name|
+          named_scope "#{name}_matches".to_sym, lambda { |query|
+            { :conditions => ["#{quoted_table_name}.#{name} like :query", { :query => "%#{query}%" }] }
+          }
+          named_scope "#{name}_starts_with".to_sym, lambda { |query|
+            { :conditions => ["#{quoted_table_name}.#{name} like :query", { :query => "#{query}%" }] }
+          }
+          named_scope "#{name}_ends_with".to_sym, lambda { |query|
+            { :conditions => ["#{quoted_table_name}.#{name} like :query", { :query => "%#{query}" }] }
+          }
+        end
+      end
+
+      def define_basic_search_scope
+        named_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

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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: thoughtbot-pacecar
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matt Jankowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Generated scopes for ActiveRecord classes.
+email: mjankowski@thoughtbot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- init.rb
+- lib
+- lib/pacecar
+- 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
+has_rdoc: true
+homepage: http://github.com/thoughtbot/pacecar
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Pacecar adds named_scope methods to ActiveRecord classes via database column introspection.
+test_files: []
+