scopes_for_associations 0.1.0 → 0.1.1

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.rdoc

@@ -16,6 +16,47 @@ Define very basic, commonly used scopes for ActiveRecord associations.
   Movie.for(Director.first)
   #=> [#<Movie ..., director_id: 1>]
 
-== Limitations
+== Supported association types
 
-As of now, the gem only defines scopes for non-polymorphic belongs_to associations.
+* belongs_to (non-polymorpic and polymorphic)
+
+If you're like me and prefer learning through looking at code,
+read through the specs.
+The examples here are basically reproductions of the tests.
+
+=== belongs_to (non-polymorphic)
+
+  class Movie < ActiveRecord::Base
+    belongs_to :director
+    scopes_for_associations
+  end
+  
+  Movie.for_director(Director.first)
+  #=> [#<Movie ..., director_id: 1>]
+  Movie.for(Director.first)
+  #=> [#<Movie ..., director_id: 1>]
+
+=== belongs_to (polymorphic)
+
+  class Movie < ActiveRecord::base
+    # It is important to define this association.
+    has_many :comments, :as => :commentable
+  end
+  class Comment < ActiveRecord::Base
+    belongs_to :commentable, :polymorphic => true
+  end
+
+  Commentable.for_movie(Movie.first)
+  #=> [#<Comment ..., commentable_type: "Movie", commentable_id: 1>]
+  Commentable.for(Movie.first)
+  #=> [#<Comment ..., commentable_type: "Movie", commentable_id: 1>]
+
+== Installation
+
+  gem install scopes_for_associations
+
+== Compatibility
+
+works with ActiveRecord >=3.0.0
+
+gem-testers: http://gem-testers.org/gems/scopes_for_associations

data/lib/scopes_for_associations/version.rb

@@ -1,3 +1,3 @@
 module ScopesForAssociations
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/scopes_for_associations.rb

@@ -1,22 +1,57 @@
 module ScopesForAssociations
 
   def scopes_for_associations()
-    # scopes for belongs_to associations.
-    belongs_to_reflections = reflect_on_all_associations(:belongs_to)
-    non_polymorphic_belongs_to_reflections = belongs_to_reflections.reject { |reflection| reflection.options[:polymorphic] }
+    define_scopes_for_non_polymorpic_belongs_to_associations
+    define_scopes_for_polymorpic_belongs_to_associations
+    define_named_scope_for
+  end
+
+  private
+
+  def non_polymorphic_belongs_to_reflections
+    reflect_on_all_associations(:belongs_to).reject { |reflection| reflection.options[:polymorphic] }
+  end
+
+  def polymorphic_belongs_to_reflections
+    reflect_on_all_associations(:belongs_to).select { |reflection| reflection.options[:polymorphic] }
+  end
+
+  def define_scopes_for_non_polymorpic_belongs_to_associations
     non_polymorphic_belongs_to_reflections.each do |reflection|
       name = reflection.name
-      scope :"for_#{name}", proc { |obj| where(:"#{name}_id" => obj) }
+      scope :"for_#{name}", proc { |obj| where(:"#{name}_id" => obj.id) }
     end
-    # scopes for has_many associations.
-    #has_many_reflections = reflect_on_all_associations(:has_many)
-    #non_through_has_many_reflections = has_many_reflections.reject { |reflection| reflection.options[:through] }
-    #non_through_has_many_reflections.each do |reflection|
-      #name = reflection.name
-      #scope :"for_#{name}", proc { |obj| joins(name).where(name => {:"#{self.class.table_name.singularize}_id" => obj.id}) }
-    #end
-    # for scope.
-    scope :for, proc { |obj| send("for_#{obj.class.name.underscore}", obj) }
+  end
+
+  def define_scopes_for_polymorpic_belongs_to_associations
+    polymorphic_belongs_to_reflections.each do |reflection|
+      name = reflection.name
+      scope :"for_#{name}", proc { |obj| where(:"#{name}_type" => obj.class.name, :"#{name}_id" => obj.id) }
+    end
+  end
+
+  # return [name, reflection] from matching reflection.klass and obj.class
+  def reflection_for_object(obj)
+    reflections.detect { |name, reflection| reflection.class_name == obj.class.name }
+  end
+
+  def define_named_scope_for
+    scope :for, proc { |object|
+      name, reflection = reflection_for_object(object)
+      if name
+        send(:"for_#{name}", object)
+      else
+        # see if it's polymorphic from object's associations.
+        reflection = object.class.reflect_on_all_associations(:has_many).detect { |reflection|
+          reflection.options[:as] && reflection.klass == self
+        }
+        if reflection
+          send(:"for_#{reflection.options[:as]}", object)
+        else
+          raise "no scope for #{object.class}"
+        end
+      end
+    }
   end
 
 end

data/scopes_for_associations.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split($/).map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
+  s.add_dependency 'activerecord', '>= 3.0.0'
+
+  s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'rspec', '2.5.0'
-  s.add_development_dependency 'activerecord', '>= 3.0.0'
   s.add_development_dependency 'sqlite3-ruby', '1.2.5'
 end

data/spec/scopes_for_associations_spec.rb

@@ -4,24 +4,55 @@ describe ScopesForAssociations do
 
   let(:director) { Director.create! }
   let(:production_company) { ProductionCompany.create! }
+  let(:movie) { Movie.create!(:director => director, :production_company => production_company) }
+  let(:comment) { Comment.create! :commentable_type => 'Movie', :commentable_id => movie.id }
 
   it 'should be included in ActiveRecord::Base' do
     ActiveRecord::Base.should respond_to('scopes_for_associations')
   end
 
-  it 'should define for_x scopes' do
-    Movie.should respond_to('for_director')
-    Movie.should respond_to('for_production_company')
-  end
+  context 'for non-polymorphic belongs_to associations' do
+
+    it 'should define for_x scopes' do
+      Movie.should respond_to('for_director')
+      Movie.should respond_to('for_production_company')
+    end
+
+    it 'should scope for association as object' do
+      Movie.for_director(director).to_sql.should eq(Movie.where(:director_id => director.id).to_sql)
+      Movie.for_director(director).should eq([movie])
+      Movie.for_production_company(production_company).to_sql.should eq(Movie.where(:production_company_id => production_company.id).to_sql)
+      Movie.for_production_company(director).should eq([movie])
+    end
+
+    it 'should have a "polymorphic" scope :for' do
+      Movie.for(director).to_sql.should eq(Movie.for_director(director).to_sql)
+      Movie.for(director).should eq([movie])
+      Movie.for(production_company).to_sql.should eq(Movie.for_production_company(production_company).to_sql)
+      Movie.for(production_company).should eq([movie])
+    end
 
-  it 'should scope for association as object' do
-    Movie.for_director(director).to_sql.should eq(Movie.where(:director_id => director.id).to_sql)
-    Movie.for_production_company(production_company).to_sql.should eq(Movie.where(:production_company_id => production_company.id).to_sql)
   end
 
-  it 'should have a "polymorphic" scope :for' do
-    Movie.for(director).to_sql.should eq(Movie.for_director(director).to_sql)
-    Movie.for(production_company).to_sql.should eq(Movie.for_production_company(production_company).to_sql)
+  context 'for polymorphic belongs_to associations' do
+
+    it 'should define for_x scopes' do
+      Comment.should respond_to('for_commentable')
+    end
+
+    it 'should scope for association as object' do
+      Comment.for_commentable(movie)
+    end
+
+    it 'should scope for association as object' do
+      Comment.for_commentable(movie).to_sql.should eq(Comment.where(:commentable_type => 'Movie', :commentable_id => movie.id).to_sql)
+      Comment.for_commentable(movie).should eq([comment])
+    end
+
+    it 'should have a "polymorphic" scope :for' do
+      Comment.for(movie).to_sql.should eq(Comment.for_commentable(movie).to_sql)
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -1,11 +1,8 @@
 require 'pathname'
 require 'active_record'
+require 'awesome_print'
 
 require File.join(Pathname(__FILE__).dirname.expand_path, '../lib/scopes_for_associations')
 
 # require support .rb files.
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
-
-#RSpec.configure do |config|
-  #config.include(Macros)
-#end

data/spec/support/models.rb

@@ -1,11 +1,9 @@
 class Movie < ActiveRecord::Base
-
   belongs_to :director
   belongs_to :production_company
   has_one :trailer
-
+  has_many :comments, :as => 'commentable'
   scopes_for_associations
-
 end
 
 class Director < ActiveRecord::Base
@@ -20,3 +18,8 @@ class Trailer < ActiveRecord::Base
   belongs_to :production_company
   scopes_for_associations
 end
+
+class Comment < ActiveRecord::Base
+  belongs_to :commentable, :polymorphic => true
+  scopes_for_associations
+end

data/spec/support/schema.rb

@@ -13,4 +13,7 @@ ActiveRecord::Schema.define do
     t.belongs_to :director
     t.belongs_to :production_company
   end
+  create_table :comments, :force => true do |t|
+    t.belongs_to :commentable, :polymorphic => true
+  end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: scopes_for_associations
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jared Ning
@@ -19,53 +14,49 @@ date: 2011-02-08 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activerecord
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
-        version: 2.5.0
-  type: :development
+        version: 3.0.0
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: awesome_print
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
+        version: "0"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 2
-        - 5
-        version: 1.2.5
+        version: 2.5.0
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.2.5
+  type: :development
+  version_requirements: *id004
 description: Define very basic, commonly used scopes for ActiveRecord associations. E.g. if a Post model has an author and a category association, scopes will be defined like Post.for(author) or Post.for(category).
 email: 
 - jared@redningja.com
@@ -78,6 +69,7 @@ extra_rdoc_files: []
 files: 
 - .gemtest
 - .gitignore
+- .rspec
 - .rvmrc
 - Gemfile
 - README.rdoc
@@ -103,18 +95,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []