scopes_for_associations 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.*.sw*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.8.7-p249@scopes_for_associations

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in scopes_for_associations.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,21 @@
+= Scopes for Associations
+
+== Description
+
+Define very basic, commonly used scopes for ActiveRecord associations.
+
+== Description through code
+
+  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>]
+
+== Limitations
+
+As of now, the gem only defines scopes for non-polymorphic belongs_to associations.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+desc 'Run rspec tests'
+task :test do
+  sh 'rspec spec/'
+end

data/lib/scopes_for_associations.rb

@@ -0,0 +1,24 @@
+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] }
+    non_polymorphic_belongs_to_reflections.each do |reflection|
+      name = reflection.name
+      scope :"for_#{name}", proc { |obj| where(:"#{name}_id" => obj) }
+    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
+
+end
+
+ActiveRecord::Base.extend ScopesForAssociations

data/lib/scopes_for_associations/version.rb

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

data/scopes_for_associations.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'scopes_for_associations/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'scopes_for_associations'
+  s.version     = ScopesForAssociations::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Jared Ning']
+  s.email       = ['jared@redningja.com']
+  s.homepage    = 'https://github.com/ordinaryzelig/scopes_for_associations'
+  s.summary     = %q{Define very basic, commonly used scopes for ActiveRecord associations}
+  s.description = %q{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).}
+
+  s.rubyforge_project = 'scopes-for-associations'
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split($/)
+  s.executables   = `git ls-files -- bin/*`.split($/).map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  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

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe ScopesForAssociations do
+
+  let(:director) { Director.create! }
+  let(:production_company) { ProductionCompany.create! }
+
+  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
+
+  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)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'pathname'
+require 'active_record'
+
+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

@@ -0,0 +1,22 @@
+class Movie < ActiveRecord::Base
+
+  belongs_to :director
+  belongs_to :production_company
+  has_one :trailer
+
+  scopes_for_associations
+
+end
+
+class Director < ActiveRecord::Base
+end
+
+class ProductionCompany < ActiveRecord::Base
+end
+
+class Trailer < ActiveRecord::Base
+  belongs_to :movie
+  belongs_to :director
+  belongs_to :production_company
+  scopes_for_associations
+end

data/spec/support/schema.rb

@@ -0,0 +1,16 @@
+require 'sqlite3'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define do
+  create_table :movies, :force => true do |t|
+    t.belongs_to :director
+    t.belongs_to :production_company
+  end
+  create_table(:directors, :force => true)# { |t| }
+  create_table(:production_companies, :force => true) { |t| }
+  create_table :trailers, :force => true do |t|
+    t.belongs_to :director
+    t.belongs_to :production_company
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: scopes_for_associations
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jared Ning
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  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_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  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
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  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
+  type: :development
+  version_requirements: *id003
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gemtest
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/scopes_for_associations.rb
+- lib/scopes_for_associations/version.rb
+- scopes_for_associations.gemspec
+- spec/scopes_for_associations_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+has_rdoc: true
+homepage: https://github.com/ordinaryzelig/scopes_for_associations
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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: []
+
+rubyforge_project: scopes-for-associations
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Define very basic, commonly used scopes for ActiveRecord associations
+test_files: 
+- spec/scopes_for_associations_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb