context_aware_scope 0.0.2

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.textile

@@ -0,0 +1,41 @@
+h1. Context Aware Scope
+
+An extension to ActiveRecord's named scope
+
+h2. Usage
+
+1. Add a context to a named_scope:
+
+<pre>
+  named_scope :luxurious, :conditions => ['price > ?', 100], :context => {:price => 'luxurious'}
+  named_scope :recent, :conditions => ['created_at > ?', 1.week.ago], :context => {:created_at => 'brand new'}
+</pre>
+
+
+2. Execute the scopes:
+
+<pre>
+  @products = Product.new.luxurious
+</pre>
+
+3. And get the context:
+
+<pre>
+  @products.context
+  # => {:price => 'luxurious', :created_at => 'brand new'}
+  "You are looking at #{@products.context.values.to_sentence} products"
+  # => "You are looking at brand new and luxurious products"
+</pre>
+
+h2. Installation
+
+Install the ContextAwareScope gem:
+
+<pre>
+  gem install context_aware_scope
+</pre>
+
+
+h2. Compatibility
+Only tested with ActiveRecord 2.3.8.
+Rails 3 support planned.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "context_aware_scope"
+    gem.summary = %Q{Add context to named_scopes in ActiveRecord}
+    gem.description = %Q{Allows to add a context to a named_scope that will be passed through the whole scope chain}
+    gem.email = "info@simplificator.com"
+    gem.homepage = "http://github.com/simplificator/context_aware_scope"
+    gem.authors = ["Simplificator", "Fabio Kuhn"]
+    gem.add_development_dependency "shoulda", ">= 2.11"
+    gem.add_development_dependency "leftright"
+    gem.add_dependency "activerecord", ">= 2.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "context aware scope #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/context_aware_scope.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{context_aware_scope}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Simplificator", "Fabio Kuhn"]
+  s.date = %q{2010-08-10}
+  s.description = %q{Allows to add a context to a named_scope that will be passed through the whole scope chain}
+  s.email = %q{info@simplificator.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "context_aware_scope.gemspec",
+     "lib/context_aware_scope.rb",
+     "test/database.yml",
+     "test/models.rb",
+     "test/test_helper.rb",
+     "test/units/lambda_scope_test.rb",
+     "test/units/normal_scope_test.rb",
+     "test/units/readme_sample_test.rb"
+  ]
+  s.homepage = %q{http://github.com/simplificator/context_aware_scope}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Add context to named_scopes in ActiveRecord}
+  s.test_files = [
+    "test/models.rb",
+     "test/test_helper.rb",
+     "test/units/lambda_scope_test.rb",
+     "test/units/normal_scope_test.rb",
+     "test/units/readme_sample_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 2.11"])
+      s.add_development_dependency(%q<leftright>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 2.11"])
+      s.add_dependency(%q<leftright>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 2.11"])
+    s.add_dependency(%q<leftright>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+  end
+end
+

data/lib/context_aware_scope.rb

@@ -0,0 +1,58 @@
+module ContextAwareScope
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+      class_eval do
+        def initialize_with_context(proxy_scope, options, &block)
+          @context = options ? options[:context] || {} : {}
+          initialize_without_context(proxy_scope, options, &block)
+        end
+
+        alias_method_chain :initialize, :context
+
+        # get current context from scope chain
+        def context
+          p @proxy_scope.class
+          if @proxy_scope.class == ActiveRecord::NamedScope::Scope
+            p @context
+            recursive_context = @proxy_scope.context
+            recursive_context = recursive_context.keep_merge(@context)
+            recursive_context
+          else
+            p @context
+            @context
+          end
+        end
+
+        # exclude context from proxy options
+        # that way it is not sent to the with_scope on the ActiveRecord model
+        def proxy_options
+          @proxy_options.except(:context)
+        end
+      end
+    end
+  end
+
+  module ClassMethods
+
+  end
+end
+
+class ActiveRecord::NamedScope::Scope
+  include ContextAwareScope
+end
+
+class Hash
+  def keep_merge(hash)
+    target = dup
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].keep_merge(hash[key])
+        next
+      end
+      #target[key] = hash[key]
+      target.update(hash) { |key, *values| values.flatten.uniq }
+    end
+    target
+  end
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite:
+  adapter: sqlite3
+  database: ":memory:"

data/test/models.rb

@@ -0,0 +1,73 @@
+class Order < ActiveRecord::Base
+  belongs_to :customer
+  named_scope :by_price, lambda{|price| {:conditions => ['price > ?', price], :context => {:price => "> #{price}"}}}
+  named_scope :by_product, lambda{|name| {:conditions => {:product_name => name}, :context => {:product => name}}}
+  named_scope :expensive, :conditions => ['price > ?', 10], :context => {:price => '> 10'}
+  named_scope :with_camel, :conditions => {:product_name => 'camel'}, :context => {:product => 'camel'}
+
+end
+
+class Customer < ActiveRecord::Base
+  has_many    :orders
+  belongs_to  :city
+  named_scope :by_name, lambda{|name| {:conditions => ['name like ?', "%#{name}%"], :context => {:filter => {:customer => {:name => name}}}}}
+end
+
+class City < ActiveRecord::Base
+  has_many    :customers
+end
+
+class Product < ActiveRecord::Base
+  named_scope :luxurious, :conditions => ['price > ?', 100], :context => {:price => 'luxurious'}
+  named_scope :recent, :conditions => ['created_at > ?', 1.week.ago], :context => {:created_at => 'brand new'}
+end
+
+def setup_database(name)
+  database_yml = YAML.load_file(File.join(File.dirname(__FILE__), 'database.yml'))
+  ActiveRecord::Base.establish_connection(database_yml[name])
+  ActiveRecord::Base.configurations = true
+
+  ActiveRecord::Schema.verbose = false
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :orders do |t|
+      t.string  :product_name
+      t.integer :price
+      t.date    :purchased_at
+      t.integer :customer_id
+    end
+
+    create_table :customers do |t|
+      t.string  :name
+      t.integer :credit
+      t.integer :city_id
+    end
+
+    create_table :cities do |t|
+      t.string  :name
+    end
+
+    create_table :products do |t|
+      t.string    :name
+      t.datetime  :created_at
+      t.integer   :price
+    end
+  end
+end
+
+def seed_models
+  city1 = City.create(:name => 'Zurich')
+  city2 = City.create(:name => 'Basel')
+  customer1 = Customer.create(:name => 'Aladin', :city => city1)
+  customer2 = Customer.create(:name => 'Ali Baba', :city => city1)
+  customer3 = Customer.create(:name => 'Sidi Abdel', :city => city2)
+  order1 = Order.create(:customer => customer1, :product_name => 'magic carpet', :price => 500, :purchased_at => '2010-07-22')
+  order2 = Order.create(:customer => customer1, :product_name => 'old lamp', :price => 5, :purchased_at => '2010-07-22')
+  order3 = Order.create(:customer => customer2, :product_name => 'camel', :price => 1200, :purchased_at => '2010-07-24')
+  product = Product.create(:name => 'Bracelet', :price => 324, :created_at => 1.day.ago)
+end
+
+def cleanup_database
+  [City, Customer, Order, Product].each do |model_class|
+    model_class.delete_all
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'leftright'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib', 'context_aware_scope'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'context_aware_scope'
+
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+#ActiveRecord::Base.logger.level = Logger::DEBUG
+
+require File.join(File.dirname(__FILE__), 'models')
+
+setup_database('sqlite')
+
+class Test::Unit::TestCase
+  def teardown
+    cleanup_database
+  end
+end

data/test/units/lambda_scope_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+class LambdaScopeTest < Test::Unit::TestCase
+  context 'orders' do
+    setup do
+      seed_models
+    end
+
+    context 'with a simple scope with text context' do
+      setup do
+        @orders = Order.by_price(10)
+      end
+
+      should 'should have results' do
+        assert_equal 2, @orders.count
+      end
+
+      should 'have context on list' do
+        assert_equal ActiveRecord::NamedScope::Scope, @orders.class
+        assert_equal Hash, @orders.context.class
+        assert_equal ({:price => '> 10'}), @orders.context
+      end
+    end
+
+    context 'with a chained scope with text context' do
+      setup do
+        @orders = Order.by_product('camel').by_price(10)
+      end
+
+      should 'should have results' do
+        assert_equal 1, @orders.count
+      end
+
+      should 'set a string context' do
+        assert_equal Hash, @orders.context.class
+        assert_equal 2, @orders.context.size
+        assert_equal '> 10', @orders.context[:price]
+        assert_equal 'camel', @orders.context[:product]
+      end
+    end
+  end
+
+  context 'customers' do
+    setup do
+      seed_models
+    end
+
+    context 'with a chained scope and a deep merging context' do
+      setup do
+        @customers = Customer.by_name('Al').by_name('Ba')
+      end
+
+      should 'should have results' do
+        assert_equal 1, @customers.count
+      end
+
+      should 'set a string context' do
+        assert_equal Hash, @customers.context.class
+        assert_equal ({:name => ['Al', 'Ba']}), @customers.context[:filter][:customer]
+      end
+    end
+  end
+end

data/test/units/normal_scope_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class NormalScopeTest < Test::Unit::TestCase
+  context 'orders' do
+    setup do
+      seed_models
+    end
+
+    context 'with a simple scope with text context' do
+      setup do
+        @orders = Order.expensive
+      end
+
+      should 'should have results' do
+        assert_equal 2, @orders.count
+      end
+
+      should 'have context on list' do
+        assert_equal ActiveRecord::NamedScope::Scope, @orders.class
+        assert_equal Hash, @orders.context.class
+        assert_equal ({:price => '> 10'}), @orders.context
+      end
+    end
+
+    context 'with a chained scope with text context' do
+      setup do
+        @orders = Order.with_camel.expensive
+      end
+
+      should 'should have results' do
+        assert_equal 1, @orders.count
+      end
+
+      should 'set a string context' do
+        assert_equal Hash, @orders.context.class
+        assert_equal 2, @orders.context.size
+        assert_equal '> 10', @orders.context[:price]
+        assert_equal 'camel', @orders.context[:product]
+
+      end
+    end
+  end
+end

data/test/units/readme_sample_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class ReadmeSampleTest < Test::Unit::TestCase
+  context 'new and luxurious products' do
+    setup do
+      seed_models
+      @products = Product.recent.luxurious
+    end
+
+    should 'should have results' do
+      assert_equal 1, @products.count
+      assert_equal ({:price => 'luxurious', :created_at => 'brand new'}), @products.context
+      assert_equal "You are looking at brand new and luxurious products", "You are looking at #{@products.context.values.to_sentence} products"
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: context_aware_scope
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Simplificator
+- Fabio Kuhn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: leftright
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id003
+description: Allows to add a context to a named_scope that will be passed through the whole scope chain
+email: info@simplificator.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- README.textile
+- Rakefile
+- VERSION
+- context_aware_scope.gemspec
+- lib/context_aware_scope.rb
+- test/database.yml
+- test/models.rb
+- test/test_helper.rb
+- test/units/lambda_scope_test.rb
+- test/units/normal_scope_test.rb
+- test/units/readme_sample_test.rb
+has_rdoc: true
+homepage: http://github.com/simplificator/context_aware_scope
+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 
+      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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Add context to named_scopes in ActiveRecord
+test_files: 
+- test/models.rb
+- test/test_helper.rb
+- test/units/lambda_scope_test.rb
+- test/units/normal_scope_test.rb
+- test/units/readme_sample_test.rb