refined 0.0.1

data/README.md

@@ -0,0 +1,72 @@
+`refined` is a technique for chaining scopes (or class methods as it were. see (http://elabs.se/blog/24-scopes-are-obsolete/ "Scopes Are Obsolete") to faciliate easy filtering of ActiveRecord collections.
+
+Installation
+============
+
+    gem install refined
+
+### When used with Rails 3
+
+in a `Gemfile`:
+
+    gem 'refined'
+
+Example Use
+===========
+
+### A Simple Scenario
+
+Let's say you want to filter a list of candidates for hire by status and skill level. The code might look something like this.
+
+    class Candidate < ActiveRecord::Base; end
+
+    controller Candidates < ApplicationController
+      expose(:candidates) { Candidate.refined(params[:filters] }
+
+      def filter
+        render :index
+      end
+    end
+
+    = form_for :filters, url: filter_candidates_url do |f|
+      %fieldset
+        %dl
+          %dt Status
+          %dd= f.select :status, ["pending", "hired", "rejected"]
+      
+          %dt Skill
+          %dd= f.select :skill, ["beginner", "intermediate", "advanced"]
+      %fieldset.action
+        = f.submit "Filter"
+
+    %table
+      %thead
+        %tr
+          - ["Name", "Status", "Skill"].each do |header|
+            %th header
+      %tbody
+          - candidates.each do |candidate|
+            %tr
+              %td= candidate.name
+              %td= candidate.status
+              %td= candidate.skill
+
+The call to Candidate.refined(params[:filters]) will yield 2 class methods created on Candidate as such:
+
+    def self.status(arg)
+      where(status: arg)
+    end
+
+    def self.skill(arg)
+      where(skill: arg)
+    end
+
+And will chain those methods as `Candidate.status("pending").skill("advanced")` returning the scoped collection of candidates.
+
+### TODO
+
+- Rails 2 support
+- Ruby 1.8 support
+- Multiple parameters
+- More AREL finder methods
+- Accessor methods for parameter values

data/lib/refined.rb

@@ -0,0 +1,10 @@
+require "refined/railtie"
+
+module Refined
+  autoload :ScopeChain, "refined/scope_chain"
+  autoload :Railtie, "refined/railtie"
+
+  def refined(criteria)
+    Refined::ScopeChain.new(self.to_s, criteria).chain!
+  end
+end

data/lib/refined/railtie.rb

@@ -0,0 +1,17 @@
+module Refined
+  if defined? Rails::Railtie
+    class Railtie < Rails::Railtie
+      initializer "refined.extend_active_record_base" do |app|
+        ActiveSupport.on_load(:active_record) do
+          Refined::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.extend(Refined)
+    end
+  end
+end

data/lib/refined/scope_chain.rb

@@ -0,0 +1,27 @@
+class Refined::ScopeChain
+  attr_accessor :criteria
+  attr_reader :constant_name
+
+  def initialize(name, criteria={})
+    self.constant_name = name
+    self.criteria = criteria
+  end
+
+  def constant_name=(name)
+    @constant_name ||= name.constantize
+  end
+
+  def construct(name, value)
+    constant_name.send :define_singleton_method, name do |arg|
+      where(name => value)
+    end unless constant_name.respond_to?(name)
+  end
+
+  def chain!
+    criteria.inject(constant_name) do |model, (method, arg)|
+      construct(method, arg)
+      model.send(method, arg)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: refined
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dave Ott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Refined scopes ActiveRecord collections automagicaly.
+email: daveott@daveott.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/refined/railtie.rb
+- lib/refined/scope_chain.rb
+- lib/refined.rb
+- README.md
+has_rdoc: true
+homepage: http://rubygems.org/gems/refined
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Refined!
+test_files: []
+