lib/active_record/named_scope/column_scope.rb @@ -5,12 +5,12 @@ Selecting only specified columns can safe you resources and processing time. I wrote this plugin because I do this all the time and I don't want to cripple my code anymore. -ColumnScope is build on top of NamedScope so it should work with Ruby on +ColumnScope is build on top of NamedScope so it only works with Ruby on Rails 2.1+. == Examples: - Item.selects(:name).proxy_options[:select] # => '"items".name' + Item.selects(:name).proxy_options[:select] # => '"items"."name"' content = 'Foo Bar Baz' @@ -31,4 +31,12 @@ Rails 2.1+. See test/column_scope_test.rb for more examples. +== Install (rails): + + $ script/plugin install git://github.com/boof/column_scope.git + + # alternativly: + $ cd vendor/plugins + $ git clone git://github.com/boof/column_scope.git + Copyright (c) 2008 Florian Aßmann, released under the MIT license README.rdoc @@ -1,10 +1,15 @@ -require "#{ File.dirname __FILE__ }/lib/column_scope" -ActiveRecord::NamedScope::Scope.class_eval do - include ColumnScope::ScopeMethods -end +require "#{ File.dirname __FILE__ }/lib/active_record/named_scope/column_scope" + ActiveRecord::Base.class_eval do - extend ColumnScope::ScopeMethods + extend ActiveRecord::NamedScope::ColumnScope::ScopeMethods + def self.values - ColumnScope::ValueExtractor.new self, column_names + ActiveRecord::NamedScope::ColumnScope:: + ValueExtractor.new self, column_names end + +end + +ActiveRecord::NamedScope::Scope.class_eval do + include ActiveRecord::NamedScope::ColumnScope::ScopeMethods end init.rb @@ -1,34 +1,29 @@ require 'test_helper' -module ColumnScopeTestHelper - - def self.content - 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.' - end - - class Item < ActiveRecord::Base - named_scope :with_name, proc { |name| - { :conditions => ['name = ?', name] } - } - end - Item.create :name => 'foo', :value => 1, :content => content - Item.create :name => 'bar', :value => 2, :content => content - Item.create :name => 'baz', :value => 3, :content => content - +class Item < ActiveRecord::Base + named_scope :named, proc { |n| { :conditions => ['name = ?', n] } } end +CONTENT = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.' + +Item.create :name => 'foo', :value => 1, :content => CONTENT +Item.create :name => 'bar', :value => 2, :content => CONTENT +Item.create :name => 'baz', :value => 3, :content => CONTENT class ColumnScopeTest < ActiveSupport::TestCase - include ColumnScopeTestHelper test "verify that items name column is selected" do - assert Item.selects(:name).proxy_options[:select] == '"items"."name"' + assert_equal '"items"."name"', Item.selects(:name).proxy_options[:select] end test "verify that items name column is selected with distinct" do - assert Item.selects(:name).uniq!.proxy_options[:select] == 'DISTINCT "items"."name"' + assert_equal 'DISTINCT "items"."name"', Item.selects(:name).uniq!.proxy_options[:select] end test "verify that items name and items value columns are selected" do - assert Item.selects(:name, :value).proxy_options[:select] == '"items"."name","items"."value"' - assert Item.rejects(:id, :content, :timestamps).proxy_options[:select] == '"items"."name","items"."value"' + expectation = '"items"."name","items"."value"' + result1 = Item.selects(:name, :value).proxy_options[:select] + result2 = Item.rejects(:id, :content, :timestamps).proxy_options[:select] + + assert_equal expectation, result1 + assert_equal expectation, result2 end test "verify select only name results in an array with foo bar and baz" do @@ -48,27 +43,23 @@ class ColumnScopeTest < ActiveSupport::TestCase assert_equal expectation, result2 end test "verify first distinct content is the lorem ipsum" do - expectation = ColumnScopeTestHelper.content + expectation = CONTENT result = Item.select_first :distinct_content assert_equal expectation, result end test "verify find returns 3 and baz" do expectation = ['baz', 3] - result1 = Item.with_name('baz').selects(:name, :value).values.first - result2 = Item.with_name('baz').rejects(:content, :id, :timestamps).values.first - result3 = Item.with_name('baz').select_first(:name__value) + result1 = Item.named('baz').selects(:name, :value).values.first + result2 = Item.named('baz').rejects(:content, :id, :timestamps).values.first + result3 = Item.named('baz').select_first(:name__value) assert_equal expectation, result1 assert_equal expectation, result2 assert_equal expectation, result3 end test "verify values returns values ordered" do - expectation = [ - ['foo', 1, ColumnScopeTestHelper.content], - ['bar', 2, ColumnScopeTestHelper.content], - ['baz', 3, ColumnScopeTestHelper.content] - ] + expectation = [['foo',1,CONTENT],['bar',2,CONTENT],['baz',3,CONTENT]] # select values and drop id and timestamps result = Item.values.all.each { |tpl| tpl.shift; tpl.pop; tpl.pop } test/column_scope_test.rb @@ -14,3 +14,5 @@ ActiveRecord::Base.connection.instance_eval do t.timestamps end end + +# ... maybe I should Stub a database Adapter? test/database_setup.rb lib/column_scope.rb fc0e372a5f4d76b56a5df019646a4e6d4b010f0b Florian Aßmann florian.assmann@email.de http://github.com/boof/column_scope/commit/2728648e199520be755207ff5f6c47b35b57b0a3 2728648e199520be755207ff5f6c47b35b57b0a3 2009-01-02T02:07:38-08:00 2009-01-02T02:07:38-08:00 Documentation and speed improvements. * fixed deprecated documentation * added install note to README.rdoc * moved ColumnScope into ActiveRecord::NamedScope * ValueExtractor uses send instead of calling procs * some minor tweaks 6167b2c2c9feaa95321cfbf1660b7914130810c4 Florian Aßmann florian.assmann@email.de