acts_as_finder 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tomasz Gieniusz
+
+MIT License
+
+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,54 @@
+# ActsAsFinder
+
+This `acts_as` extension provides the capabilities for beautiful record finding by specified column(s).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_finder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_finder
+
+## Example Usage
+
+Assume you have following model:
+
+    class Language < ActiveRecord::Base
+      acts_as_finder :short_name, :name
+    end
+	
+And records in database:
+
+    +----+------------+---------+
+    | id | short_name | name    |
+    +----+------------+---------+
+    | 1  | EN         | English |
+    | 2  | PL         | Polish  |
+    +----+------------+---------+
+
+Now you can use this extension like this:
+
+    >> Language.EN
+    => #<Language id: 1, short_name: "EN", name: "English"> 
+
+    >> Language.Polish
+    => #<Language id: 2, short_name: "PL", name: "Polish">
+    
+## Build Status
+[![Build Status](https://secure.travis-ci.org/tomgi/acts_as_finder.png)](https://secure.travis-ci.org/tomgi/acts_as_finder)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/acts_as_finder.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/acts_as_finder/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tomasz Gieniusz"]
+  gem.email         = ["tomasz.gieniusz@gmail.com"]
+  gem.description   = %q{This `acts_as` extension provides the capabilities for beautiful finding record in database by specified column.}
+  gem.summary       = %q{A gem allowing beautiful finding records by specified column.}
+  gem.homepage      = "http://github.com/tomgi/acts_as_finder"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "acts_as_finder"
+  gem.require_paths = ["lib"]
+  gem.version       = ActiveRecord::Acts::Finder::VERSION
+  
+  gem.add_dependency "activerecord"
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "rspec"
+end

data/lib/acts_as_finder.rb

@@ -0,0 +1,3 @@
+require "acts_as_finder/active_record/acts/finder"
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::Finder)

data/lib/acts_as_finder/active_record/acts/finder.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  module Acts
+    module Finder
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def acts_as_finder(*fields)
+          instance_eval <<-EOV
+            @acts_as_finder_fields ||= []
+            @acts_as_finder_fields += #{fields}
+            def method_missing(sym, *args, &block)
+              begin 
+                super
+              rescue => e
+                @acts_as_finder_fields.each do |field|
+                  el = where(field.to_sym => sym).first
+                  return el if el
+                end
+                raise e
+              end
+            end
+            
+            def methods
+              @acts_as_finder_fields.inject(super) do |acc, field|
+                acc += all.map { |r| r.send(field).to_sym }
+              end
+            end
+          EOV
+        end
+      end
+
+    end
+  end
+end

data/lib/acts_as_finder/version.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  module Acts
+    module Finder
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/acts_as_finder_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe "acts_as_finder" do
+  it "finds record by given field" do
+    Currency.EUR.should == Currency.find_by_short_name('EUR')
+  end
+
+  context "tries to invoke method from upper class before finding" do
+    it "returns base result if base method exists" do
+      ActiveRecord::Base.should_receive(:EUR).and_return(:ok)
+      Currency.EUR.should == :ok
+    end
+    it "raises error if base method and record don't exist" do
+      expect{Currency.TEST}.to raise_error(NameError)
+    end
+  end
+
+  context "can find by many fields" do
+    context "#invoking acts_as_finder once passing two fields" do
+      it "returns record found by first field if exists" do
+        Language.EN.should == Language.find_by_short_name('EN')
+      end
+
+      it "searches by second field if nothing was found by first field " do
+        Language.English.should == Language.find_by_name('English')
+      end
+    end
+
+    context "#invoking acts_as_finder twice with different fields" do
+      it "returns record found by first field if exists" do
+        Country.EN.should == Country.find_by_short_name('EN')
+      end
+
+      it "searches by second field if nothing was found by first field " do
+        Country.England.should == Country.find_by_name('England')
+      end
+    end
+  end
+
+  context 'has records fields values included in #methods' do
+    it 'one field' do
+      Currency.methods.should include(:EUR, :PLN)
+    end
+
+    it 'two fields' do
+      Language.methods.should include(:EN, :PL, :English, :Polish)
+    end
+
+    it 'includes also base methods' do
+      ActiveRecord::Base.should_receive(:methods).and_return([:ok])
+      Language.methods.should include(:ok)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'active_record'
+require 'acts_as_finder'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+require 'support/schema.rb'
+require 'support/models.rb'
+require 'support/data.rb'

data/spec/support/data.rb

@@ -0,0 +1,7 @@
+Currency.create(:short_name => "EUR")
+Currency.create(:short_name => "PLN")
+
+Language.create(:short_name => "EN", :name => "English")
+Language.create(:short_name => "PL", :name => "Polish")
+
+Country.create(:short_name => "EN", :name => "England")

data/spec/support/models.rb

@@ -0,0 +1,12 @@
+class Currency < ActiveRecord::Base
+  acts_as_finder :short_name
+end
+
+class Language < ActiveRecord::Base
+  acts_as_finder :short_name, :name
+end
+
+class Country < ActiveRecord::Base
+  acts_as_finder :short_name
+  acts_as_finder :name
+end

data/spec/support/schema.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :currencies, :force => true do |t|
+    t.string :short_name
+    t.timestamps
+  end
+
+  create_table :languages, :force => true do |t|
+    t.string :short_name
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :countries, :force => true do |t|
+    t.string :short_name
+    t.string :name
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tomasz Gieniusz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This `acts_as` extension provides the capabilities for beautiful finding
+  record in database by specified column.
+email:
+- tomasz.gieniusz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_finder.gemspec
+- lib/acts_as_finder.rb
+- lib/acts_as_finder/active_record/acts/finder.rb
+- lib/acts_as_finder/version.rb
+- spec/acts_as_finder_spec.rb
+- spec/spec_helper.rb
+- spec/support/data.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: http://github.com/tomgi/acts_as_finder
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A gem allowing beautiful finding records by specified column.
+test_files:
+- spec/acts_as_finder_spec.rb
+- spec/spec_helper.rb
+- spec/support/data.rb
+- spec/support/models.rb
+- spec/support/schema.rb