hyper_active_record 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+*.db
+*.log
+.idea

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    hyper_active_record (0.0.1)
+      activerecord (~> 3.0.0)
+      activesupport (~> 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    factory_girl (1.3.3)
+    i18n (0.5.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sqlite3 (1.3.3)
+    tzinfo (0.3.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.0)
+  activesupport (~> 3.0.0)
+  factory_girl (~> 1.3.3)
+  hyper_active_record!
+  rspec (~> 2.5.0)
+  sqlite3 (~> 1.3.3)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Deepak N
+
+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.md

@@ -0,0 +1,49 @@
+Description
+===========
+
+Hyper Active Record is to showcase the features that would make active record super awesome
+
+Install
+=======
+
+    gem install hyper_active_record
+
+If you are using bundler - add dependency in gem file
+
+    gem 'hyper_active_record'
+
+What do you get
+===============
+Hyper Active Record adds the ability to query active record models by virtual attributes. This is achieved by *enhancing* the active record query methods *where, all, count* to allow scope names in conditions. It works just like passing column names in conditions. The scope on a model acts as a virtual column.
+
+For example : If Project model is defined as
+
+      class Project < ActiveRecord::Base
+        #Columns - :name, :start_date, :end_date, :priority
+        scope :started_after, lambda { |date| where('start_date > ?', date) }
+        scope :completed, lambda { where('end_date IS NOT NULL') }
+      end
+
+You can do
+
+      Project.where(:completed => true, :started_after => 2.years.ago, :priority => 1)
+
+This works on any active record relation
+
+      Company.projects.where(:completed => true, :started_after => 2.years.ago)
+
+Also you can use *scoped_by* method on a active record relation. This method accepts a hash of scope name and parameters and returns a scoped object.
+
+      Project.scoped_by(:completed => true, :started_after => 2.years.ago)
+
+How is this useful?
+===================
+You can use this to search a model by the query parameters(may be from a search form) in the index action of a controller. The query parameters can be a combination of database columns and virtual columns (provided a scope is defined for the virtual column).
+
+If you are already using [inherited\_resources](https://github.com/josevalim/inherited_resources) and [has\_scope](https://github.com/plataformatec/has_scope), unit testing the controller would become simpler if implementation has\_scope is changed to just pass all the query params to *where* or *all*  method on the model. This would eliminate the need of data setup for testing the has\_scope declaration on a controller. With this change you can just mock the model's query method to verify the scope name was passed as a condition in the method parameters.
+
+What next?
+==========
+The intention of this gem is to just get a feel of the benefits from this feature.
+
+ I would like to see these features built into the active_record instead of a monkey patch like this.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--format documentation --color)
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => ["spec"]
+
+desc 'Clear out RDoc and generated packages'
+task :clean do
+  rm_rf "hyper_active_record.log"
+  rm_rf "hyper_active_record_test.db"
+  rm_rf "pkg"
+end

data/hyper_active_record.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hyper_active_record/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hyper_active_record"
+  s.version     = HyperActiveRecord::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Deepak N"]
+  s.email       = ["endeep123@gmail.com"]
+  s.homepage    = "https://github.com/endeepak/hyper_active_record"
+  s.summary     = %q{hyper active record}
+  s.description = %q{Makes active record super awesome}
+
+  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"]
+
+  s.add_runtime_dependency("activerecord", "~> 3.0.0")
+  s.add_runtime_dependency("activesupport", "~> 3.0.0")
+  s.add_development_dependency("rspec", "~> 2.5.0")
+  s.add_development_dependency("sqlite3", "~> 1.3.3")
+  s.add_development_dependency('factory_girl', '~> 1.3.3')
+end

data/lib/hyper_active_record.rb

@@ -0,0 +1 @@
+require 'hyper_active_record/query_methods'

data/lib/hyper_active_record/query_methods.rb

@@ -0,0 +1,37 @@
+require 'active_record'
+require 'active_support/core_ext/module/delegation'
+
+module HyperActiveRecord
+  module QueryMethods
+    APPLIED_SCOPE_MARKER = :':applied_scope:'
+
+    def where(opts, *rest)
+      return super unless opts.is_a?(Hash)
+      return super if opts.delete(APPLIED_SCOPE_MARKER)
+
+      scope_options, other_options = slice_scopes(opts)
+      relation = self.scoped_by(scope_options)
+
+      relation.where(other_options.merge(APPLIED_SCOPE_MARKER => true), *rest)
+    end
+
+    def scoped_by(opts)
+      opts.inject(clone) do |relation, scope|
+        name, value = *scope
+        relation = value.is_a?(Array) ? relation.send(name, *value) : relation.send(name, value)
+      end
+    end
+
+  protected
+    def slice_scopes(opts)
+      scope_options = {}
+      opts.each do |name, value|
+        next unless scopes.has_key?(name.to_sym)
+        scope_options[name] = value
+      end
+      return scope_options, opts.except(*(scope_options.keys))
+    end
+  end
+end
+
+ActiveRecord::Relation.send(:include, HyperActiveRecord::QueryMethods)

data/lib/hyper_active_record/version.rb

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

data/spec/db/database.yml

@@ -0,0 +1,9 @@
+sqlite3:
+  adapter: sqlite3
+  database: hyper_active_record_test.db
+mysql:
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: hyper_active_record_test

data/spec/db/init.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/test_database'
+
+TestDatabase.initialize

data/spec/db/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :projects, :force => true do |t|
+    t.column :name, :string
+    t.column :start_date, :date
+    t.column :end_date, :date
+    t.column :priority, :integer
+    t.column :company_id, :integer
+    t.timestamps
+  end
+  create_table :companies, :force => true do |t|
+    t.column :name, :string
+    t.timestamps
+  end
+end

data/spec/db/test_database.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'logger'
+
+class TestDatabase
+  def self.initialize
+    config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+    ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/../../hyper_active_record.log")
+    database = ENV['DB'] || 'sqlite3'
+    ActiveRecord::Base.establish_connection(config[database])
+    ActiveRecord::Migration.verbose = false
+    load(File.dirname(__FILE__) + "/schema.rb")
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,5 @@
+Factory.define(:project) do |f|
+  f.sequence(:name) {|n| "Project #{n}"}
+  f.sequence(:start_date) { |n| n.years.ago }
+  f.sequence(:priority) {|n| 40 + n }
+end

data/spec/hyper_active_record/query_methods_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe HyperActiveRecord::QueryMethods do
+  before(:each) do
+    class Project < ActiveRecord::Base
+      scope :started_after, lambda { |date| where('start_date > ?', date) }
+      scope :started_during, lambda { |begining, ending| where('start_date BETWEEN ? AND ?', begining, ending) }
+      scope :completed, lambda { where('end_date IS NOT NULL') }
+      scope "running", lambda { where('end_date IS NULL') }
+      belongs_to :company
+    end
+    class Company < ActiveRecord::Base
+      has_many :projects
+    end
+  end
+
+  after(:each) do
+    Project.scopes.clear
+    Project.delete_all
+    Company.delete_all
+  end
+
+  context "for scope with no parameters" do
+    it "applies scope ignoring parameter" do
+      project_1 = Factory(:project, :end_date => Date.today)
+      project_2 = Factory(:project, :end_date => nil)
+      project_3 = Factory(:project, :end_date => Date.today)
+
+      conditions = {:completed => 'anything'}
+      expected_records = [project_1, project_3]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "when conditions key is a string" do
+    it "applies scope" do
+      project_1 = Factory(:project, :end_date => Date.today)
+      project_2 = Factory(:project, :end_date => nil)
+
+      conditions = {"completed" => true}
+      expected_records = [project_1]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "when scope name is a string" do
+    it "applies scope" do
+      project_1 = Factory(:project, :end_date => Date.today)
+      project_2 = Factory(:project, :end_date => nil)
+
+      conditions = {:running => true}
+      expected_records = [project_2]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "for scope with single parameter" do
+    it "applies scope" do
+      old_project = Factory(:project, :start_date => 2.years.ago)
+      new_project = Factory(:project, :start_date => Date.today)
+
+      conditions = {:started_after => 1.year.ago}
+      expected_records = [new_project]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "for scope with multiple parameters" do
+    it "applies scope" do
+      project_1 = Factory(:project, :start_date => 1.months.ago, :end_date => Date.today)
+      project_2 = Factory(:project, :start_date => 2.months.ago, :end_date => nil)
+      project_3 = Factory(:project, :start_date => 5.months.ago, :end_date => Date.today)
+
+      conditions = {:started_during => [3.months.ago, Date.today]}
+      expected_records = [project_1, project_2]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "with combination condition and scope name" do
+    it "applies scope and matches by condition" do
+      old_critical_project = Factory(:project, :start_date => 2.years.ago, :priority => 1)
+      new_simple_project = Factory(:project, :start_date => Date.today, :priority => 2)
+      new_critical_project = Factory(:project, :start_date => Date.today, :priority => 1)
+
+      conditions = {:started_after => 1.year.ago, :priority => 2 }
+      expected_records = [new_simple_project]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "with multiple scope names" do
+    it "applies all scopes" do
+      project_1 = Factory(:project, :start_date => 1.months.ago, :end_date => Date.today)
+      project_2 = Factory(:project, :start_date => 2.months.ago, :end_date => nil)
+      project_3 = Factory(:project, :start_date => 5.months.ago, :end_date => Date.today)
+
+      conditions = {:started_after => 3.month.ago, :completed => true}
+      expected_records = [project_1]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "with only conditions and no scope names" do
+    it "mathes by conditions" do
+      project_1 = Factory(:project, :priority => 1)
+      project_2 = Factory(:project, :priority => 2)
+      project_3 = Factory(:project, :priority => 3)
+
+      conditions = {:priority => 2}
+      expected_records = [project_2]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "when scope or column does not exist" do
+    it "raises error" do
+      conditions = {:non_existing_scope => 1.year.ago}
+      expected_error = /no such column: projects.non_existing_scope/
+
+      lambda { Project.where(conditions).to_a }.should raise_error(expected_error)
+      lambda { Project.all(:conditions => conditions) }.should raise_error(expected_error)
+      lambda { Project.count(:conditions => conditions) }.should raise_error(expected_error)
+    end
+  end
+
+  context "when scope name is same as column name" do
+    it "applies scope" do
+      Project.class_eval { scope :priority, lambda { |value| where('priority <= ?', value) } }
+      project_1 = Factory(:project, :priority => 1)
+      project_2 = Factory(:project, :priority => 2)
+      project_3 = Factory(:project, :priority => 3)
+
+      conditions = {:priority => 2}
+      expected_records = [project_1, project_2]
+
+      Project.where(conditions).should == expected_records
+      Project.all(:conditions => conditions).should == expected_records
+      Project.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+
+  context "on a association relation" do
+    it "applies scope" do
+      company = Company.create!(:name => "aaa")
+      old_project = Factory(:project, :start_date => 2.years.ago, :company => company)
+      new_project = Factory(:project, :start_date => Date.today, :company => company)
+
+      conditions = {:started_after => 1.year.ago}
+      expected_records = [new_project]
+
+      company.projects.where(conditions).should == expected_records
+      company.projects.all(:conditions => conditions).should == expected_records
+      company.projects.count(:conditions => conditions).should == expected_records.size
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'factory_girl'
+require File.dirname(__FILE__)+ '/factories'
+
+require 'hyper_active_record'
+require File.expand_path(File.dirname(__FILE__) + "/db/init.rb")

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: hyper_active_record
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Deepak N
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-24 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id005
+description: Makes active record super awesome
+email: 
+- endeep123@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- hyper_active_record.gemspec
+- lib/hyper_active_record.rb
+- lib/hyper_active_record/query_methods.rb
+- lib/hyper_active_record/version.rb
+- spec/db/database.yml
+- spec/db/init.rb
+- spec/db/schema.rb
+- spec/db/test_database.rb
+- spec/factories.rb
+- spec/hyper_active_record/query_methods_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/endeepak/hyper_active_record
+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: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: hyper active record
+test_files: 
+- spec/db/database.yml
+- spec/db/init.rb
+- spec/db/schema.rb
+- spec/db/test_database.rb
+- spec/factories.rb
+- spec/hyper_active_record/query_methods_spec.rb
+- spec/spec_helper.rb