arel_search 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marcus Vinícius Loureiro Mansur
+
+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,29 @@
+# ArelSearch
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'arel_search'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arel_search
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/arel_search.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arel_search/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "arel_search"
+  gem.version       = ArelSearch::VERSION
+  gem.authors       = ["Marcus Vinicius Loureiro Mansur"]
+  gem.email         = ["marcus.v.mansur@gmail.com"]
+  gem.description   = %q{Arel based search gem}
+  gem.summary       = %q{Searching becomes easy with ArelSearch}
+  gem.homepage      = ""
+
+  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.require_paths = ["lib"]
+end

data/lib/arel_search/base.rb

@@ -0,0 +1,123 @@
+# Arel based search
+#
+# Basic usage:
+#
+# params = {'orders.status.eq' => 50}
+# ArelSearch::Base.new(Order, params).search_all
+#
+#
+# Query by association
+# params = {'orders.status.eq' => 50, 'customer.name.matches' => 'Marcus'}
+# 
+# Paginate
+# ArelSearch::Base.new(Order, params).search(page: 1, per_page: 10)
+#
+# TODO:
+# 
+# Implement NoMethodError for columns and Arel predications
+module ArelSearch
+  class Base
+    attr_reader :fields, :model, :params
+    attr_accessor :scope
+
+    def initialize(m, params)
+      @model  = m
+      @scope  = self.model
+      @params = params
+    end
+
+    def search_all
+      scope_conditions
+      self.scope
+    end
+
+    def search(page=1, per_page=20)
+      self.search_all.paginate(per_page: per_page, page: page)
+    end
+
+    private
+
+    def scope_conditions
+      build_search_fields.each do |field|
+        self.scope = field.scopify(self.scope, self.model.arel_table)
+      end
+    end
+
+    def build_search_fields
+      self.params.inject([]){|fields, param| fields << search_field(param)}
+    end
+
+    def search_field(param)
+       SearchField.new(param[0], param[1], self.model)
+    end
+
+    class SearchField
+      attr_reader :name, :value, :association, :arel_predication, :split, :base_model
+
+      def initialize(key, v, b_model)
+        @base_model       = b_model
+        split_key(key)
+        @association          = self.split[0]
+        self.name             = self.split[1]
+        self.arel_predication = self.split[2]
+        @value                = v
+      end
+
+      def scopify(scope, default_arel_table)
+        if self.arel_table != default_arel_table
+          scope = scope.joins(self.association.to_sym)
+        end
+        scope.where(self.arel_table[self.name].send(self.arel_predication,self.value))
+      end
+
+      def name=(n)
+        validate_name(n)
+        @name = n
+      end
+
+      def arel_predication=(pred)
+        validate_arel_predication(pred)
+        @arel_predication = pred
+      end
+
+      def arel_table
+        self.model.arel_table
+      end
+
+      def model
+        self.association.camelize.singularize.constantize
+      end
+
+      private
+
+      def split_key(key)
+        @split = key.split('.')
+      end
+
+      def validate_name(name)
+        set_model_columns
+        if !@@columns[self.model.name].include?(name)
+          raise NoMethodError, "Column #{name} not found for Table #{self.model.table_name}"
+        end
+      end
+
+      def set_model_columns
+        @@columns ||= {}
+        @@columns[self.model.name] ||= self.model.columns.inject({}){|h,c| h[c.name] = c.type.to_s; h}
+      end
+
+      def validate_arel_predication(predication)
+        set_arel_predications
+        if !@@arel_predications.include?(predication)
+          raise NoMethodError, "Predication #{predication} not found for Module Arel::Predications"
+        end
+      end
+
+      def set_arel_predications
+        @@arel_predications ||= Arel::Predications.instance_methods.map(&:to_s)
+      end
+
+    end
+
+  end
+end

data/lib/arel_search/version.rb

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

data/lib/arel_search.rb

@@ -0,0 +1,5 @@
+require "arel_search/version"
+require "arel_search/base"
+module ArelSearch
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: arel_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marcus Vinicius Loureiro Mansur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-27 00:00:00.000000000 Z
+dependencies: []
+description: Arel based search gem
+email:
+- marcus.v.mansur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arel_search.gemspec
+- lib/arel_search.rb
+- lib/arel_search/base.rb
+- lib/arel_search/version.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
+      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: Searching becomes easy with ArelSearch
+test_files: []