jferris-sconnect 0.1

data/README.rdoc

@@ -0,0 +1,45 @@
+= Sconnect
+
+Sconnect is an extension to ActiveRecord's named_scopes that allows you to combine scopes in more interesting and useful ways.
+
+== Download
+
+Github: http://github.com/jferris/sconnect/tree/master
+
+== Examples
+
+Given the following model:
+
+  class Post < ActiveRecord::Base
+    named_scope :published, :conditions => { :published => true }
+    named_scope :titled, :conditions => "title IS NOT NULL"
+    named_scope :from_today, lambda {
+      { :conditions => ['created_at >= ?', 1.day.ago] }
+    }
+  end
+
+ActiveRecord provides scope chains:
+
+  # All published posts with titles
+  Post.published.titled
+
+  # All published posts from today
+  Post.published.from_today
+
+Sconnect extends these scopes:
+
+  # All posts that are either published or titled
+  Post.published.or.titled
+
+  # All posts that are published but not created today
+  Post.published.not.from_today
+
+  # All posts that are either published or untitled
+  Post.published.or.not.titled
+
+  # All posts from today that are either published or titled
+  Post.published.or.titled.from_today
+
+== Author
+
+Sconnect was written by Joe Ferris.

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rcov'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+Spec::Rake::SpecTask.new do |t|
+  t.libs      << 'spec'
+  t.spec_opts << '-O spec/spec.opts'
+end
+
+desc 'Generate documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sconnect'
+  rdoc.options <<
+    '--line-numbers' <<
+    '--inline-source' <<
+    "--main" <<
+    "README.rdoc"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :spec
+
+spec = Gem::Specification.new do |s|
+  s.name        = %q{sconnect}
+  s.version     = "0.1"
+  s.summary     = %q{Sconnect extends ActiveRecord's named scoped_chains to be 
+                     more useful an interesting.}
+  s.description = %q{Sconnect extends ActiveRecord's named_scope chains to allow
+                     scopes to be combined inclusively, inverted, and more.}
+
+  s.files        = FileList['[A-Z]*', 'lib/**/*.rb', 'spec/**/*.rb']
+  s.require_path = 'lib'
+  s.test_files   = Dir[*['spec/**/*_spec.rb']]
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.rdoc_options = ['--line-numbers', '--inline-source', "--main", "README.rdoc"]
+
+  s.authors = ["Joe Ferris"]
+  s.email   = %q{jferris@thoughtbot.com}
+
+  s.platform = Gem::Platform::RUBY
+end
+
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/lib/sconnect.rb

@@ -0,0 +1,15 @@
+require 'sconnect/or'
+require 'sconnect/not'
+
+#:enddoc:
+module ActiveRecord
+  class Base
+    extend Sconnect::ActiveRecordClassExtensions
+  end
+
+  module NamedScope
+    class Scope
+      include Sconnect::ScopeExtensions
+    end
+  end
+end

data/lib/sconnect/not.rb

@@ -0,0 +1,55 @@
+module Sconnect #:nodoc:
+  class NotScope < ActiveRecord::NamedScope::Scope #:nodoc:
+
+    delegate :current_scoped_methods, :sanitize_sql, :to => :proxy_scope
+
+    def initialize(proxy_scope)
+      @proxy_scope = proxy_scope
+    end
+
+    def proxy_options
+      @proxy_options ||= invert_scope_conditions(@right_scope)
+    end
+
+    private
+
+    def invert_scope_conditions(scope)
+      scope = scope.merge(:conditions => invert_conditions(scope[:conditions]))
+    end
+
+    def invert_conditions(conditions)
+      "NOT (#{sanitize_sql(conditions)})"
+    end
+
+    def method_missing(method, *args, &block)
+      if scopes.include?(method)
+        right_scope = scopes[method].call(self, *args)
+        if @right_scope
+          right_scope
+        else
+          @right_scope = right_scope.proxy_options
+          self
+        end
+      else
+        super(method, *args, &block)
+      end
+    end
+  end
+
+  module ActiveRecordClassExtensions
+    # Inverts the conditions of the following scope.
+    #
+    # Examples:
+    #   # Returns all unpublished posts
+    #   Post.not.published 
+    #
+    #   # Returns all unpublished posts from today
+    #   Post.not.published.from_today
+    #
+    #   # Same as above
+    #   Post.from_today.not.published
+    def not
+      NotScope.new(self)
+    end
+  end
+end

data/lib/sconnect/or.rb

@@ -0,0 +1,67 @@
+module Sconnect #:nodoc:
+  class OrScope < ActiveRecord::NamedScope::Scope #:nodoc:
+
+    delegate :current_scoped_methods, :sanitize_sql, :to => :proxy_scope
+
+    def initialize(left_scope)
+      @left_scope  = left_scope.proxy_options
+      @proxy_scope = left_scope.proxy_scope
+    end
+
+    def proxy_options
+      @proxy_options ||= inclusively_combine_scopes(@left_scope, @right_scope)
+    end
+
+    private
+
+    def inclusively_combine_scopes(left, right)
+      exclusively_combine_scopes(left, right).
+        merge(:conditions => combine_conditions(left, right))
+    end
+
+    def exclusively_combine_scopes(left, right)
+      with_scope(:find => left) do
+        with_scope(:find => right) do
+          current_scoped_methods[:find]
+        end
+      end
+    end
+
+    def combine_conditions(*scopes)
+      segments = scopes.collect do |scope|
+        sanitize_sql(scope[:conditions])
+      end
+      conditions = "(#{segments.join(') OR (')})"
+    end
+
+    def method_missing(method, *args, &block)
+      if scopes.include?(method)
+        right_scope = scopes[method].call(self, *args)
+        if @right_scope
+          right_scope
+        else
+          @right_scope = right_scope.proxy_options
+          self
+        end
+      else
+        super(method, *args, &block)
+      end
+    end
+  end
+
+  module ScopeExtensions
+    # Joins the left and right-hand scopes into an inclusive conditional clause. 
+    #
+    # Examples:
+    #
+    #   # Posts published or owned by the user
+    #   Post.published.or.owned_by(@user)
+    #
+    #   # Posts from today that are either published or owned by the given user
+    #   # (note that "or" binds tighter than the implicit "and")
+    #   Post.from_today.published.or.owned_by(@user)
+    def or
+      OrScope.new(self)
+    end
+  end
+end

data/spec/not_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe "Post" do
+
+  include ModelBuilder
+
+  before do
+    define_model :user
+    define_model :category
+    define_model :post, :published   => :boolean,
+                        :title       => :string,
+                        :user_id     => :integer,
+                        :category_id => :integer do
+      belongs_to :user
+      belongs_to :category
+      named_scope :published, :conditions => { :published => true },
+                              :include    => :user
+      named_scope :titled, :conditions => "title IS NOT NULL",
+                           :include    => :category
+      named_scope :from_today, lambda {
+        { :conditions => ['created_at >= ?', 1.day.ago] }
+      }
+    end
+  end
+
+  describe "titled but not published", :shared => true do
+    it "should find an unpublished, titled post" do
+      should include(Post.create!(:published => false, :title => 'Title'))
+    end
+
+    it "should not find an unpublished, titled post" do
+      should_not include(Post.create!(:published => true, :title => 'Title'))
+    end
+
+    it "should not find an published, untitled post" do
+      should_not include(Post.create!(:published => true, :title => nil))
+    end
+  end
+
+  describe ".not.published" do
+    subject { Post.not.published }
+
+    it "should find an unpublished post" do
+      should include(Post.create!(:published => false))
+    end
+
+    it "should not find an unpublished post" do
+      should_not include(Post.create!(:published => true))
+    end
+
+    it { should be_chainable }
+  end
+
+  describe ".not.published.titled" do
+    subject { Post.not.published }
+    it_should_behave_like "titled but not published"
+    it { should be_chainable }
+  end
+
+  describe ".titled.not.published" do
+    subject { Post.not.published }
+    it_should_behave_like "titled but not published"
+    it { should be_chainable }
+  end
+end
+

data/spec/or_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe "Post" do
+
+  include ModelBuilder
+
+  before do
+    define_model :user
+    define_model :category
+    define_model :post, :published   => :boolean,
+                        :title       => :string,
+                        :user_id     => :integer,
+                        :category_id => :integer do
+      belongs_to :user
+      belongs_to :category
+      named_scope :published, :conditions => { :published => true },
+                              :include    => :user
+      named_scope :titled, :conditions => "title IS NOT NULL",
+                           :include    => :category
+      named_scope :from_today, lambda {
+        { :conditions => ['created_at >= ?', 1.day.ago] }
+      }
+    end
+  end
+
+  describe "published.or.titled", :shared => true do
+    it "should find a published, untitled post" do
+      should include(Post.create!(:published => true,  :title => nil))
+    end
+
+    it "should find an unpublished, titled post" do
+      should include(Post.create!(:published => false, :title => 'Title'))
+    end
+
+    it "should find a published, titled post" do
+      should include(Post.create!(:published => true,  :title => 'Title'))
+    end
+
+    it "not should find an unpublished, untitled post" do
+      should_not include(Post.create!(:published => false, :title => nil))
+    end
+
+    it "should use non-conditional options from .published.titled" do
+      should include_scope_options_from(Post.published.titled)
+    end
+  end
+
+  describe "from_today", :shared => true do
+    it "not find a post published two days ago" do
+      should_not include(Post.create!(:published  => true,
+                                      :title      => 'Title',
+                                      :created_at => 2.days.ago))
+    end
+  end
+
+  describe ".published.or.titled" do
+    subject { Post.published.or.titled }
+    it_should_behave_like "published.or.titled"
+    it { should be_chainable }
+  end
+
+  describe ".from_today.published.or.titled" do
+    subject { Post.from_today.published.or.titled }
+
+    it_should_behave_like "published.or.titled"
+    it_should_behave_like "from_today"
+    it { should be_chainable }
+  end
+
+  describe ".published.or.titled.from_today" do
+    subject { Post.published.or.titled.from_today }
+
+    it_should_behave_like "published.or.titled"
+    it_should_behave_like "from_today"
+    it { should be_chainable }
+  end
+
+  describe ".published.or.titled.or.from_today" do
+    subject { Post.published.or.titled.or.from_today }
+
+    it "should find a published, untitled post from today" do
+      should include(Post.create!(:published => true,  :title => nil))
+    end
+
+    it "should find an unpublished, titled post from today" do
+      should include(Post.create!(:published => false, :title => 'Title'))
+    end
+
+    it "should find a published, titled post from today" do
+      should include(Post.create!(:published => true,  :title => 'Title'))
+    end
+
+    it "should find an unpublished, untitled post from today" do
+      should include(Post.create!(:published => false, :title => nil))
+    end
+
+    it "not should find an unpublished, untitled post from two days ago" do
+      should_not include(Post.create!(:published  => false,
+                                      :title      => nil,
+                                      :created_at => 2.days.ago))
+    end
+
+    it "should use non-conditional options from .published.titled" do
+      should include_scope_options_from(Post.published.titled)
+    end
+
+    it { should be_chainable }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'spec'
+require 'active_record'
+
+SCONNECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+Dir["#{SCONNECT_ROOT}/spec/support/**/*.rb"].each {|file| require(file) }
+$: << "#{SCONNECT_ROOT}/lib"
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => "#{SCONNECT_ROOT}/spec/database.sqlite3"
+)
+
+ActiveRecord::Base.logger = Logger.new("#{SCONNECT_ROOT}/spec/spec.log")
+
+Spec::Runner.configure do |config|
+  config.include Matchers
+end
+
+require 'sconnect'

data/spec/support/active_record_extensions.rb

@@ -0,0 +1,18 @@
+module ActiveRecord
+  class Base
+    # This allows us to look at the options at the end of a chain of scopes.
+    def self.scope_options
+      current_scoped_methods[:find]
+    end
+  end
+
+  module NamedScope
+    class Scope
+      # This allows Scope objects to be used as matchers. Without this hack, a
+      # Scope will be converted to an array when #should is called, so the
+      # matcher will always receive an array. This prevents #should from being
+      # delegated to the Scope's proxy.
+      remove_method :should
+    end
+  end
+end

data/spec/support/model_builder.rb

@@ -0,0 +1,67 @@
+module ModelBuilder
+  def self.included(example_group)
+    example_group.class_eval do
+      before do
+        @defined_constants = []
+        @created_tables    = []
+      end
+
+      after do
+        @defined_constants.each do |class_name| 
+          Object.send(:remove_const, class_name)
+        end
+
+        @created_tables.each do |table_name|
+          ActiveRecord::Base.
+            connection.
+            execute("DROP TABLE IF EXISTS #{table_name}")
+        end
+      end
+    end
+  end
+
+  def create_table(table_name, &block)
+    connection = ActiveRecord::Base.connection
+    
+    begin
+      connection.execute("DROP TABLE IF EXISTS #{table_name}")
+      connection.create_table(table_name, &block)
+      @created_tables << table_name
+      connection
+    rescue Exception => exception
+      connection.execute("DROP TABLE IF EXISTS #{table_name}")
+      raise exception
+    end
+  end
+
+  def define_constant(class_name, base, &block)
+    class_name = class_name.to_s.camelize
+
+    klass = Class.new(base)
+    Object.const_set(class_name, klass)
+
+    klass.class_eval(&block) if block_given?
+
+    @defined_constants << class_name
+
+    klass
+  end
+
+  def define_model_class(class_name, &block)
+    define_constant(class_name, ActiveRecord::Base, &block)
+  end
+
+  def define_model(name, columns = {}, &block)
+    class_name = name.to_s.pluralize.classify
+    table_name = class_name.tableize
+
+    create_table(table_name) do |table|
+      columns.each do |name, type|
+        table.column name, type
+      end
+      table.timestamps
+    end
+
+    define_model_class(class_name, &block)
+  end
+end

data/spec/support/scope_matcher.rb

@@ -0,0 +1,8 @@
+module Matchers
+  def be_chainable
+    simple_matcher do |given, matcher| 
+      matcher.description = "return a chainable named scope"
+      given.class.instance_methods.include?('proxy_scope')
+    end
+  end
+end

data/spec/support/scope_options_matcher.rb

@@ -0,0 +1,38 @@
+module Matchers
+
+  class ScopeOptionsMatcher
+    def initialize(expected)
+      @expected_scope_options = scope_options(expected)
+    end
+
+    def matches?(target)
+      target_scope_options = scope_options(target)
+      @expected_scope_options.detect do |@key, expected_values|
+        expected_values = [expected_values] unless expected_values.is_a?(Array)
+        @target_values = target_scope_options[@key]
+        @target_values = [@target_values] unless @target_values.is_a?(Array)
+        @missing = 
+          expected_values.detect {|value| !@target_values.include?(value) }
+      end
+
+      @missing.nil?
+    end
+
+    def failure_message
+      "Missing value #{@missing.inspect} for #{@key.inspect}" <<
+        " (found values: #{@target_values.inspect})"
+    end
+
+    private
+
+    def scope_options(scope)
+      scope_options = scope.scope_options
+      scope_options.delete(:conditions)
+      scope_options
+    end
+  end
+
+  def include_scope_options_from(scope)
+    ScopeOptionsMatcher.new(scope)
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: jferris-sconnect
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Joe Ferris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-21 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Sconnect extends ActiveRecord's named_scope chains to allow scopes to be combined inclusively, inverted, and more.
+email: jferris@thoughtbot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/sconnect/not.rb
+- lib/sconnect/or.rb
+- lib/sconnect.rb
+- spec/not_spec.rb
+- spec/or_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record_extensions.rb
+- spec/support/model_builder.rb
+- spec/support/scope_matcher.rb
+- spec/support/scope_options_matcher.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Sconnect extends ActiveRecord's named scoped_chains to be  more useful an interesting.
+test_files: 
+- spec/not_spec.rb
+- spec/or_spec.rb