kristopher-scoped-associations 0.0.3

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.0.3. Cleaned up package internals.
+v0.0.2. Initial gem release, github only.
+v0.0.1. Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Kristopher Chambers and Elijah Miller
+
+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/Manifest

@@ -0,0 +1,13 @@
+CHANGELOG
+init.rb
+lib/scope_reflection.rb
+lib/scoped_associations.rb
+LICENSE
+Manifest
+Rakefile
+README.rdoc
+scoped-associations.gemspec
+spec/models.rb
+spec/scoped_associations_spec.rb
+spec/spec_helper.rb
+TODO

data/README.rdoc

@@ -0,0 +1,34 @@
+= ScopedAssociations
+
+Use your named scopes to add conditions to associations! Keep your code DRY
+and allows eager loading of scoped associations.
+
+Currently this only works for has_many associations, and probably only on
+Rails 2.2.
+
+== Example
+
+  class User < ActiveRecord::Base
+    has_many :published_posts, :scope => :published
+    has_many :published_and_approved_posts, :scope => [:published, :approved]
+  end
+
+  class Post < ActiveRecord::Base
+    named_scope :published, :conditions => { :published => true }
+    named_scope :approved, :conditions => { :approved => true }
+  end
+
+== Install
+
+As a Rails plugin:
+
+  ./script_plugin install git://github.com/kristopher/scoped-associations.git 
+
+Prefer gems?
+
+  gem sources -a http://gems.github.com
+  gem install kristopher-scoped-associations
+
+
+Homepage:: http://github.com/kristopher/scoped-associations
+License:: Copyright (c) 2008 Kristopher Chambers <mailto:kristopher.chambers@gmail.com> and Elijah Miller <mailto:elijah.miller@gmail.com>, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'spec/rake/spectask'
+
+require 'echoe'
+Echoe.new 'scoped-associations' do |p|
+  p.description     = "DRY up your associations with named_scope conditions!"
+  # p.url             = "http://scoped-associations.rubyforge.org"
+  p.author          = "Kristopher Chambers"
+  p.email           = "kristopher.chambers@gmail.com"
+  p.retain_gemspec  = true
+  p.need_tar_gz     = false
+  p.extra_deps      = [
+  ]
+  p.ignore_pattern  = ['spec/test.sqlite3']
+end
+
+desc 'Default: run specs'
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :test => :spec

data/TODO

@@ -0,0 +1,9 @@
+A shortcut for generating multiple associations that are scoped:
+  has_many :posts
+  has_many :published_posts, :scope => :published
+  has_many :archived_posts, :scope => :archived
+
+  Could be shortened to:
+
+  has_many :posts, :and_scopes => [:published, :archived]
+  

data/init.rb

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

data/lib/scope_reflection.rb

@@ -0,0 +1,32 @@
+module ActiveRecord
+  module Associations
+    module ScopeReflection
+      def initialize(owner, reflection)
+        scope_reflection(reflection)
+        super
+      end
+
+      def scope_reflection(reflection)
+
+        source_reflection_class = 
+          if reflection.is_a? ActiveRecord::Reflection::ThroughReflection 
+            reflection.source_reflection.klass 
+          else 
+            reflection.klass
+          end
+    
+        scope_names = [reflection.options[:scope]].flatten.compact
+        final_scope = scope_names.inject(source_reflection_class) do |accumulated_scope, scope|
+          if accumulated_scope.respond_to?(scope)
+            accumulated_scope.send(scope)
+          else
+            raise ActiveRecord::UndefinedScopeReflectionError.new(self, scope)
+          end
+        end
+
+        current_scoped_methods = final_scope.send(:current_scoped_methods) || {}
+        reflection.options.merge!(current_scoped_methods[:find] || {}) 
+      end
+    end
+  end
+end

data/lib/scoped_associations.rb

@@ -0,0 +1,18 @@
+module ActiveRecord # :nodoc:
+  class UndefinedScopeReflectionError < ActiveRecordError # :nodoc:
+    def initialize(reflection, scope)
+      super("Undefined Scope '#{scope}' for #{reflection.class_name}.")
+    end 
+  end
+
+  module Associations # :nodoc:
+    module ClassMethods # :nodoc:
+      @@valid_keys_for_has_many_association << :scope
+    end
+  end
+end
+
+require File.join(File.dirname(__FILE__), 'scope_reflection')
+
+ActiveRecord::Associations::HasManyAssociation.send(:include, ActiveRecord::Associations::ScopeReflection)
+ActiveRecord::Associations::HasManyThroughAssociation.send(:include, ActiveRecord::Associations::ScopeReflection)

data/scoped-associations.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scoped-associations}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristopher Chambers"]
+  s.date = %q{2008-12-07}
+  s.description = %q{DRY up your associations with named_scope conditions!}
+  s.email = %q{kristopher.chambers@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/scope_reflection.rb", "lib/scoped_associations.rb", "LICENSE", "README.rdoc", "TODO"]
+  s.files = ["CHANGELOG", "init.rb", "lib/scope_reflection.rb", "lib/scoped_associations.rb", "LICENSE", "Manifest", "Rakefile", "README.rdoc", "scoped-associations.gemspec", "spec/models.rb", "spec/scoped_associations_spec.rb", "spec/spec_helper.rb", "TODO"]
+  s.has_rdoc = true
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Scoped-associations", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{scoped-associations}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{DRY up your associations with named_scope conditions!}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/spec/models.rb

@@ -0,0 +1,30 @@
+class GrandChild < ActiveRecord::Base
+  belongs_to :child
+
+  named_scope :alive, :conditions => { :alive => true }
+end
+
+class Child < ActiveRecord::Base
+  belongs_to :parent
+  has_many :grand_children
+
+  named_scope :alive, :conditions => { :alive => true }  
+end
+
+class Parent < ActiveRecord::Base
+  # Standard
+  has_many :children
+  has_many :grand_children, :through => :children
+
+  # Scope on direct assocation
+  has_many :children_direct, :scope => 'alive', :class_name => 'Child'
+  has_many :grand_children_direct, :through => :children_direct, :source => :grand_children
+
+  # Scope on inderect assocation
+  has_many :children_indirect, :class_name => 'Child'
+  has_many :grand_children_indirect, :through => :children_indirect, :scope => 'alive', :source => :grand_children
+
+  # Scope on direct and indirect assocation
+  has_many :children_direct_and_indirect, :scope => 'alive', :class_name => 'Child'
+  has_many :grand_children_direct_and_indirect, :through => :children_direct_and_indirect, :scope => 'alive', :source => :grand_children
+end

data/spec/scoped_associations_spec.rb

@@ -0,0 +1,68 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "ScopedAssociation" do
+  before(:each) do
+    @parent = Parent.first
+  end
+  
+  describe "standard assocations" do
+    describe "has_many" do
+      it "should return all children" do
+        @parent.children.collect(&:name).should == ['aa', 'ab']
+      end
+    end
+
+    describe "has_many :through" do
+      it "should return all grand children" do
+        @parent.grand_children.collect(&:name).should == ['aaa', 'aab', 'aba', 'abb']
+      end
+    end
+  end
+
+
+  describe "scope on direct assocation" do
+    describe "has_many" do
+      it "should should return all live children" do
+        @parent.children_direct.collect(&:name).should == ['aa']
+      end
+    end
+
+    describe "has_many :through" do
+      it "should should return all grand children with a live parent" do
+        @parent.grand_children_direct.collect(&:name).should == ['aaa', 'aab']
+      end
+    end
+  end
+
+
+  describe "scope on indrect assocation" do
+    describe "has_many" do
+      it "should return all children" do
+        @parent.children_indirect.collect(&:name).should == ['aa', 'ab']
+      end
+    end
+
+    describe "has_many :through" do
+      it "should should return all live grand children" do
+        @parent.grand_children_indirect.collect(&:name).should == ['aaa', 'aba']
+      end
+    end
+  end
+
+
+  describe "scope on direct and indrect assocation" do
+    describe "has_many" do
+      it "should return all live children" do
+        @parent.children_direct_and_indirect.collect(&:name).should == ['aa']
+      end
+    end
+
+    describe "has_many :through" do
+      it "should return all live grandchildren with a live parent" do
+        @parent.grand_children_direct_and_indirect.collect(&:name).should == ['aaa']
+      end
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+
+require 'active_record'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'scoped_associations')
+
+require File.join(File.dirname(__FILE__), 'models')
+
+TEST_DATABASE_FILE = File.join(File.dirname(__FILE__), 'test.sqlite3')
+
+def setup_database
+  File.unlink(TEST_DATABASE_FILE) if File.exist?(TEST_DATABASE_FILE)
+  ActiveRecord::Base.establish_connection(
+    "adapter" => "sqlite3", "timeout" => 5000, "database" => TEST_DATABASE_FILE
+  )
+  create_tables
+  load_fixtures
+end
+
+def create_tables
+  c = ActiveRecord::Base.connection
+  
+  c.create_table :parents, :force => true do |t|
+    t.string :name
+    t.boolean :alive, :default => false
+    t.timestamps
+  end
+
+  c.create_table :children, :force => true do |t|
+    t.string :name
+    t.references :parent
+    t.boolean :alive, :default => false
+    t.timestamps
+  end
+  
+  c.create_table :grand_children, :force => true do |t|
+    t.string :name
+    t.references :child
+    t.boolean :alive, :default => false
+    t.timestamps
+  end
+end
+
+def load_fixtures
+  a = Parent.create(:name => 'a', :alive => true)
+  
+  a_a = a.children.create(:name => 'aa', :alive => true)
+  a_a_a = a_a.grand_children.create(:name => 'aaa', :alive => true)
+  a_a_b = a_a.grand_children.create(:name => 'aab', :alive => false)
+  
+  a_b = a.children.create(:name => 'ab', :alive => false)
+  a_b_a = a_b.grand_children.create(:name => 'aba', :alive => true)
+  a_b_b = a_b.grand_children.create(:name => 'abb', :alive => false)
+end
+
+setup_database

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: kristopher-scoped-associations
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Kristopher Chambers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-07 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: DRY up your associations with named_scope conditions!
+email: kristopher.chambers@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/scope_reflection.rb
+- lib/scoped_associations.rb
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- CHANGELOG
+- init.rb
+- lib/scope_reflection.rb
+- lib/scoped_associations.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README.rdoc
+- scoped-associations.gemspec
+- spec/models.rb
+- spec/scoped_associations_spec.rb
+- spec/spec_helper.rb
+- TODO
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Scoped-associations
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: scoped-associations
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: DRY up your associations with named_scope conditions!
+test_files: []
+