activerecord-blockwhere 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6188f0b42749735cf271522b4553caa3824e8ce8
+  data.tar.gz: 5dac29b2a8de101982f52039e628810e5a57bb01
+SHA512:
+  metadata.gz: f664af9db26928765b748e3044df7c80cfc0c2fef681e77d5479cd8b3f9697e43151241148a3ad71dfc4aa573675959dfc4cb7f1694c4ab4780abe161411448b
+  data.tar.gz: 1719c1e6a3565f88b3eb0596382d24041c542deac61d9f15798e6652305f0e01f2d0c664a50d1b5ca0416eb0eda9952f844ce5be922f59305d06e0ca2bec42a6

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.bundle
+vendor/bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-blockwhere.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,31 @@
+Copyright (c) 2013, Synergy Marketing, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+Neither the name of the Synergy Marketing, Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.
+

data/README.md

@@ -0,0 +1,53 @@
+# Activerecord::Blockwhere
+
+Simply conditions DSL for ActiveRecord.
+It helps using Arel Predications in the block.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-blockwhere'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-blockwhere
+
+## Usage
+
+   # * person has many entries.
+   # Person(id: integer, name: string)
+   # Entry(id: integer, person_id: integer, name: string)
+   
+   Person.where { id.eq(1) }.to_sql
+   # => SELECT "people".* FROM "people"  WHERE "people"."id" = 1
+   
+   Person.where { !id.eq(1) }.to_sql
+   # => SELECT "people".* FROM "people"  WHERE (NOT ("people"."id" = 1))
+   
+   Person.where { id.eq(1) & name.matches('%alice%') }.to_sql
+   # => SELECT "people".* FROM "people"  WHERE ("people"."id" = 1 AND "people"."name" LIKE '%alice%')
+   
+   Person.where { id.in([1,2,3]) & name.not_eq('bob') }.to_sql
+   # => SELECT "people".* FROM "people"  WHERE ("people"."id" IN (1, 2, 3) AND "people"."name" != 'bob')
+   
+   Person.where { name.eq('alice') | name.eq('bob') }.to_sql
+   # => SELECT "people".* FROM "people"  WHERE (("people"."name" = 'alice' OR "people"."name" = 'bob'))
+   
+   # join association
+   Person.where { name.eq('alice') & entries.name.matches('%hello%') }.to_sql
+   # => SELECT "people".* FROM "people"
+   #    INNER JOIN "entries" ON "entries"."person_id" = "people"."id"
+   #    WHERE ("people"."name" = 'alice' AND "entries"."name" LIKE '%hello%')
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+namespace :spec do
+  desc "Create rspec coverage"
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task["spec"].execute
+  end
+  
+  desc "boot console with spec helpers"
+  task :console do
+    require File.expand_path('../spec/spec_helper.rb', __FILE__)
+    require 'irb'
+    ARGV.clear
+    IRB.start
+  end
+end

data/activerecord-blockwhere.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/blockwhere/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-blockwhere"
+  spec.version       = ActiveRecord::Blockwhere::VERSION
+  spec.authors       = ["yuki teraoka"]
+  spec.email         = ["info@techscore.com"]
+  spec.description   = %q{Simply conditions DSL for ActiveRecord }
+  spec.summary       = %q{Simply conditions DSL for ActiveRecord. It helps using Arel Predications in the block.}
+  spec.homepage      = "https://github.com/techscore/activerecord-blockwhere"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "activerecord", ">= 3.0.0"
+  spec.add_development_dependency "sqlite3-ruby"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_runtime_dependency "activerecord", ">= 3.0.0"
+  spec.add_runtime_dependency "arel", ">= 3.0.0"
+end

data/lib/active_record/blockwhere.rb

@@ -0,0 +1,17 @@
+require "active_record/blockwhere/where_proxy"
+require "active_record/blockwhere/arel_node_operations"
+
+module ActiveRecord
+  module Blockwhere
+    def where(*args, &block)
+      relation = args.empty? ? self : super(*args)
+      relation = WhereProxy.where(relation, block.binding.eval('self'), &block) if block
+      relation
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Relation.send :include, ActiveRecord::Blockwhere
+  Arel::Nodes::Node.send      :include, ActiveRecord::Blockwhere::ArelNodeOperations
+end

data/lib/active_record/blockwhere/arel_node_operations.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module Blockwhere
+    module ArelNodeOperations
+      def &(other)
+        self.and(other)
+      end
+
+      def |(other)
+        self.or(other)
+      end
+
+      def !
+        self.not
+      end
+
+      def empty?
+        false
+      end
+    end
+  end
+end

data/lib/active_record/blockwhere/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Blockwhere
+    VERSION = "1.0.0"
+  end
+end

data/lib/active_record/blockwhere/where_proxy.rb

@@ -0,0 +1,35 @@
+require 'active_support'
+
+module ActiveRecord
+  module Blockwhere
+    class WhereProxy < ActiveSupport::BasicObject
+      attr_reader :relation, :context
+
+      def self.where(relation, context = nil, &block)
+        proxy = new(relation, context)
+        condition = proxy.instance_eval(&block)
+        condition ? proxy.relation.where(condition) : proxy.relation
+      end
+
+      def initialize(relation, context = nil)
+        @relation = relation
+        @context  = context
+      end
+
+      def method_missing(name, *args, &block)
+        if @relation.columns_hash.key?(name.to_s)
+          return @relation.arel_table[name]
+        end
+        reflection = @relation.reflections[name]
+        if ::ActiveRecord::Reflection::AssociationReflection === reflection
+          @relation = @relation.joins(name) unless @relation.joins_values.include?(name)
+          return WhereProxy.new(reflection.klass.scoped, @context)
+        end
+        if @context && @context.respond_to?(name)
+          return @context.__send__(name, *args, &block)
+        end
+        @relation.__send__(name, *args, &block)
+      end
+    end
+  end
+end

data/spec/activerecord-blockwhere_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ActiveRecord::Blockwhere do
+  before(:each) do
+    @alice        = Person.create!({:id => 1, :name => "Alice"  }, :without_protection => true)
+    @bob          = Person.create!({:id => 2, :name => "Bob"    }, :without_protection => true)
+    @carol        = Person.create!({:id => 3, :name => "Carol"  }, :without_protection => true)
+    @entry1       = @alice.entries.create!({:id => 1}, :without_protection => true)
+    @entry2       = @alice.entries.create!({:id => 2}, :without_protection => true)
+    @entry3       = @bob.entries.create!({:id => 3}, :without_protection => true)
+  end
+    
+  context 'simple where' do
+    it { expect(Person.where{ id.eq(1)}.count ).to eq 1        }
+    it { expect(Person.where{ id.eq(1)}.first ).to eq @alice   }
+    it { expect(Person.where{ id.eq(1) | id.eq(2)}.map(&:name).sort ).to eq %w(Alice Bob      ) }
+    it { expect(Person.where{ id.in([1, 3])      }.map(&:name).sort ).to eq %w(Alice     Carol) }
+    it { expect(Person.where{ ! id.eq(1)         }.map(&:name).sort ).to eq %w(      Bob Carol) }
+  end
+  
+  context 'where with association' do
+    it { expect(Person.where{ entries.id.not_eq(0) }.map(&:name).sort.uniq ).to eq %w(Alice Bob      ) }
+    it { expect(Person.where{ entries.id.eq(1)     }.map(&:name).sort      ).to eq %w(Alice          ) }
+  end
+  
+  context 'where with context' do
+    before(:each) do
+      @context = Struct.new(:params).new({})
+    end
+    
+    it do
+      @context.params[:id] = 2
+      expect(@context.instance_eval { Person.where{ id.eq(params[:id]) }.first } ).to eq @bob
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/vendor/'
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record/blockwhere'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each {|f| require f}

data/spec/support/database_cleaner.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+require 'database_cleaner'
+
+DatabaseCleaner[:active_record].strategy = :transaction if defined? ActiveRecord
+
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+  config.before :each do
+    DatabaseCleaner.start
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+ActiveRecord::Base.establish_connection( :adapter => 'sqlite3', :database => ':memory:')
+
+#migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:people      ) {|t| t.string :name}
+    create_table(:entries     ) {|t| t.integer :person_id; t.string :name }
+  end
+end
+
+ActiveRecord::Migration.verbose = false
+CreateAllTables.up
+
+
+class Person < ActiveRecord::Base
+  has_many :entries
+end
+
+class Entry < ActiveRecord::Base
+  belongs_to :person
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-blockwhere
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- yuki teraoka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: arel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 'Simply conditions DSL for ActiveRecord '
+email:
+- info@techscore.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-blockwhere.gemspec
+- lib/active_record/blockwhere.rb
+- lib/active_record/blockwhere/arel_node_operations.rb
+- lib/active_record/blockwhere/version.rb
+- lib/active_record/blockwhere/where_proxy.rb
+- spec/activerecord-blockwhere_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+- spec/support/models.rb
+homepage: https://github.com/techscore/activerecord-blockwhere
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simply conditions DSL for ActiveRecord. It helps using Arel Predications
+  in the block.
+test_files:
+- spec/activerecord-blockwhere_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+- spec/support/models.rb