everywhere 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=d

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in everywhere.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Akira Matsuda
+
+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/README.rdoc

@@ -0,0 +1,79 @@
+= Everywhere
+
+Hash condition syntax for AR query everywhere!
+
+
+== Features
+
+=== where + not
+
+"+Everywhere+" enables you to construct where + not query such as below using AR Hash query syntax.
+
+  SELECT "users".* FROM "users" WHERE ("users"."name" != 'foo')
+  SELECT "users".* FROM "users" WHERE ("users"."created_at" IS NOT NULL)
+  SELECT "users".* FROM "users" WHERE ("users"."status" NOT IN ('inactive', 'deleted')
+
+
+== Syntaxes
+
+"+Everywhere+" supports 4 syntaxes.
+
+* hash_value
+Push the value into a Hash indexed by +:not+.
+Similar to MongoDB. http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24ne
+
+    User.where(:name => {:not => 'foo'})
+     => SELECT "users".* FROM "users" WHERE ("users"."name" != 'foo')
+
+* hash_key
+Put the whole key + value Hash into another Hash indexed by +:not+.
+
+    User.where(:not => {:name => 'foo'})
+     => SELECT "users".* FROM "users" WHERE ("users"."name" != 'foo')
+
+* symbol
+Put +:not+ as the first parameter of +where+ method.
+
+    User.where(:not, :name => 'foo')
+     => SELECT "users".* FROM "users" WHERE ("users"."name" != 'foo')
+
+* method
+Use the special method named +where_not+.
+
+    User.where_not(:not, :name => 'foo')
+     => SELECT "users".* FROM "users" WHERE ("users"."name" != 'foo')
+
+
+== Supported versions
+
+ActiveRecord 3.0.x, 3.1.x, and 3.2 (edge)
+
+
+== Usage
+
+Bundle 'everywhere' gem.
+
+
+== Configuring the syntax
+
+You can choose one from four syntaxes listed above.
+For example, if you prefer the symbol syntax, put the following line in your config file.
+
+  config.active_record.where_syntax = :symbol
+
+The default value is +:hash_value+.
+
+
+== Todo
+
++like+ and +not like+ (if needed)
+
+
+== Contributing to Everywhere
+
+* Fork, fix, then send me a pull request.
+
+
+== Copyright
+
+Copyright (c) 2011 Akira Matsuda. See MIT-LICENSE for further details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/everywhere.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "everywhere/version"
+
+Gem::Specification.new do |s|
+  s.name        = "everywhere"
+  s.version     = Everywhere::VERSION
+  s.authors     = ["Akira Matsuda"]
+  s.email       = ["ronnie@dio.jp"]
+  s.homepage    = ""
+  s.summary     = %q{Hash condition syntax for AR query everywhere!}
+  s.description = %q{Hash condition syntax for AR query everywhere!}
+
+  s.rubyforge_project = "everywhere"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'sqlite3'
+  s.add_runtime_dependency 'activerecord'
+end

data/lib/everywhere.rb

@@ -0,0 +1,2 @@
+require 'everywhere/version'
+require 'everywhere/railtie'

data/lib/everywhere/hash_key.rb

@@ -0,0 +1,59 @@
+require 'everywhere/util'
+
+module ActiveRecord
+  class PredicateBuilder
+    if ActiveRecord::VERSION::STRING > '3.1'
+      class << self
+        include Everywhere::Util
+
+        def build_from_hash_with_not(engine, attributes, default_table)
+          attributes_with_not = {}
+          attributes.each do |column, value|
+            # {not: {key: value}}
+            if column == :not
+              value.each do |k, v|
+                attributes_with_not["#{k}__not__"] = v
+              end
+            else
+              attributes_with_not[column] = value
+            end
+          end
+          build_from_hash_without_not(engine, attributes_with_not, default_table).map do |rel|
+            if rel.left.name.to_s.ends_with? '__not__'
+              rel.left.name = rel.left.name.to_s.sub(/__not__$/, '').to_sym
+              negate rel
+            else
+              rel
+            end
+          end
+        end
+        alias_method_chain :build_from_hash, :not
+      end
+    else
+      include Everywhere::Util
+
+      def build_from_hash_with_not(attributes, default_table)
+        attributes_with_not = {}
+        attributes.each do |column, value|
+          # {not: {key: value}}
+          if column == :not
+            value.each do |k, v|
+              attributes_with_not["#{k}__not__"] = v
+            end
+          else
+            attributes_with_not[column] = value
+          end
+        end
+        build_from_hash_without_not(attributes_with_not, default_table).map do |rel|
+          if rel.left.name.to_s.ends_with? '__not__'
+            rel.left.name = rel.left.name.to_s.sub(/__not__$/, '').to_sym
+            negate rel
+          else
+            rel
+          end
+        end
+      end
+      alias_method_chain :build_from_hash, :not
+    end
+  end
+end

data/lib/everywhere/hash_value.rb

@@ -0,0 +1,53 @@
+require 'everywhere/util'
+
+module ActiveRecord
+  class PredicateBuilder
+    if ActiveRecord::VERSION::STRING > '3.1'
+      class << self
+        include Everywhere::Util
+
+        def build_from_hash_with_not(engine, attributes, default_table)
+          attributes_with_not = attributes.map do |column, value|
+            # {key: {not: value}}
+            if value.is_a?(Hash) && (value.keys.size == 1) && (value.keys.first == :not)
+              ["#{column}__not__", value.values.first]
+            else
+              [column, value]
+            end
+          end
+          build_from_hash_without_not(engine, attributes_with_not, default_table).map do |rel|
+            if rel.left.name.to_s.ends_with? '__not__'
+              rel.left.name = rel.left.name.to_s.sub(/__not__$/, '').to_sym
+              negate rel
+            else
+              rel
+            end
+          end
+        end
+        alias_method_chain :build_from_hash, :not
+      end
+    else
+      include Everywhere::Util
+
+      def build_from_hash_with_not(attributes, default_table)
+        attributes_with_not = attributes.map do |column, value|
+          # {key: {not: value}}
+          if value.is_a?(Hash) && (value.keys.size == 1) && (value.keys.first == :not)
+            ["#{column}__not__", value.values.first]
+          else
+            [column, value]
+          end
+        end
+        build_from_hash_without_not(attributes_with_not, default_table).map do |rel|
+          if rel.left.name.to_s.ends_with? '__not__'
+            rel.left.name = rel.left.name.to_s.sub(/__not__$/, '').to_sym
+            negate rel
+          else
+            rel
+          end
+        end
+      end
+      alias_method_chain :build_from_hash, :not
+    end
+  end
+end

data/lib/everywhere/method.rb

@@ -0,0 +1,21 @@
+require 'everywhere/util'
+
+module ActiveRecord
+  class Base
+    class << self
+      delegate :where_not, :to => :scoped
+    end
+  end
+
+  module QueryMethods
+    include Everywhere::Util
+
+    def where_not(opts, *rest)
+      return self if opts.blank?
+
+      relation = clone
+      relation.where_values += build_where(opts, rest).map {|r| negate r}
+      relation
+    end
+  end
+end

data/lib/everywhere/railtie.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+
+module ActiveRecord
+  class Base
+    cattr_accessor :where_syntax, :instance_writer => false
+  end
+end
+
+module Everywhere
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'everywhere' do |app|
+      ActiveSupport.on_load(:active_record) do
+        require "everywhere/#{app.config.active_record.where_syntax || 'hash_value'}"
+      end
+    end
+  end
+end

data/lib/everywhere/symbol.rb

@@ -0,0 +1,16 @@
+require 'everywhere/util'
+
+module ActiveRecord
+  module QueryMethods
+    include Everywhere::Util
+
+    def build_where_with_not(opts, other = [])
+      if opts == :not
+        build_where_without_not(*other).map {|r| negate r}
+      else
+        build_where_without_not(opts, other)
+      end
+    end
+    alias_method_chain :build_where, :not
+  end
+end

data/lib/everywhere/util.rb

@@ -0,0 +1,15 @@
+module Everywhere
+  module Util
+    private
+    def negate(rel)
+      case rel.class.name
+      when 'Arel::Nodes::Equality'
+        Arel::Nodes::NotEqual.new rel.left, rel.right
+      when 'Arel::Nodes::In'
+        Arel::Nodes::NotIn.new rel.left, rel.right
+      else
+        rel.not
+      end
+    end
+  end
+end

data/lib/everywhere/version.rb

@@ -0,0 +1,3 @@
+module Everywhere
+  VERSION = "0.0.1"
+end

data/spec/hash_key_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'everywhere/hash_key'
+
+describe 'normal query' do
+  before do
+    @where = Post.where(:title => 'hello').where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."title" = 'hello'] }
+end
+
+describe 'not eq' do
+  before do
+    @where = Post.where(:not => {:title => 'hello'}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."title" != 'hello'] }
+end
+
+describe 'not null' do
+  before do
+    @where = Post.where(:not => {:created_at => nil}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."created_at" IS NOT NULL] }
+end
+
+describe 'not in' do
+  before do
+    @where = Post.where(:not => {:title => %w[hello goodbye]}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."title" NOT IN ('hello', 'goodbye')] }
+end
+
+describe 'association' do
+  before do
+    @where = Post.joins(:comments).where(:comments => {:not => {:body => 'foo'}}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["comments"."body" != 'foo'] }
+end

data/spec/hash_value_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'everywhere/hash_value'
+
+describe 'normal query' do
+  before do
+    @where = Post.where(:title => 'hello').where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."title" = 'hello'] }
+end
+
+describe 'not eq' do
+  before do
+    @where = Post.where(:title => {:not => 'hello'}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."title" != 'hello'] }
+end
+
+describe 'not null' do
+  before do
+    @where = Post.where(:created_at => {:not => nil}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."created_at" IS NOT NULL] }
+end
+
+describe 'not in' do
+  before do
+    @where = Post.where(:title => {:not => %w[hello goodbye]}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."title" NOT IN ('hello', 'goodbye')] }
+end
+
+describe 'association' do
+  before do
+    @where = Post.joins(:comments).where(:comments => {:body => {:not => 'foo'}}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["comments"."body" != 'foo'] }
+end

data/spec/method_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'everywhere/method'
+
+describe 'normal query' do
+  before do
+    @where = Post.where(:name => 'hello').where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."name" = 'hello'] }
+end
+
+describe 'not eq' do
+  before do
+    @where = Post.where_not(:name => 'hello').where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."name" != 'hello'] }
+end
+
+describe 'not null' do
+  before do
+    @where = Post.where_not(:created_at => nil).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."created_at" IS NOT NULL] }
+end
+
+describe 'not in' do
+  before do
+    @where = Post.where_not(:name => %w[hello goodbye]).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."name" NOT IN ('hello', 'goodbye')] }
+end
+
+describe 'association' do
+  before do
+    @where = Post.joins(:comments).where_not(:comments => {:body => 'foo'}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["comments"."body" != 'foo'] }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'active_record'
+
+# database
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('test')
+
+# models
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+#migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:posts) {|t| t.string :title}
+    create_table(:comments) {|t| t.text :body; t.references :post}
+  end
+end
+
+RSpec.configure do |config|
+  config.before :all do
+    CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'posts'
+  end
+end

data/spec/symbol_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'everywhere/symbol'
+
+describe 'normal query' do
+  before do
+    @where = Post.where(:name => 'hello').where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."name" = 'hello'] }
+end
+
+describe 'not eq' do
+  before do
+    @where = Post.where(:not, :name => 'hello').where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."name" != 'hello'] }
+end
+
+describe 'not null' do
+  before do
+    @where = Post.where(:not, :created_at => nil).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."created_at" IS NOT NULL] }
+end
+
+describe 'not in' do
+  before do
+    @where = Post.where(:not, :name => %w[hello goodbye]).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["posts"."name" NOT IN ('hello', 'goodbye')] }
+end
+
+describe 'association' do
+  before do
+    @where = Post.joins(:comments).where(:not, :comments => {:body => 'foo'}).where_values
+  end
+  subject { @where }
+  it { @where.should have(1).item }
+  subject { @where.first }
+  its(:to_sql) { should == %q["comments"."body" != 'foo'] }
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: everywhere
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Akira Matsuda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  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: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Hash condition syntax for AR query everywhere!
+email: 
+- ronnie@dio.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- everywhere.gemspec
+- lib/everywhere.rb
+- lib/everywhere/hash_key.rb
+- lib/everywhere/hash_value.rb
+- lib/everywhere/method.rb
+- lib/everywhere/railtie.rb
+- lib/everywhere/symbol.rb
+- lib/everywhere/util.rb
+- lib/everywhere/version.rb
+- spec/hash_key_spec.rb
+- spec/hash_value_spec.rb
+- spec/method_spec.rb
+- spec/spec_helper.rb
+- spec/symbol_spec.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: everywhere
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Hash condition syntax for AR query everywhere!
+test_files: 
+- spec/hash_key_spec.rb
+- spec/hash_value_spec.rb
+- spec/method_spec.rb
+- spec/spec_helper.rb
+- spec/symbol_spec.rb
+has_rdoc: