ruby_search_object 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDkyYWQ4ODYwNTRhYWU5YzMwMDZlYTJkYjM5ODk5MmJjNDhmZGI4Yw==
+  data.tar.gz: !binary |-
+    YzI1ZDU5ZjJhMGRkMTcxMTIwMmE2NzdiOTkxNjY5YjE2NzFiZTU0Yw==
+SHA512:
+  metadata.gz: !binary |-
+    ZmFjY2FhYjc5ZmM5ZTE0OGMxZDZjMmE3MzI5NTJmYzU0NTJhZmU4YjA0MmEz
+    ZjFlZDMzZjkwOTBkMDczYzYwNTZmMGVjZWU4YzUyODdiZmNiOTM3ODE0MjY3
+    ZjFlODA2Nzk2ZGE4NDE3MTE3Y2JlZDM2MjQ1YmY1OWRjMWM1NWY=
+  data.tar.gz: !binary |-
+    NjFhMWI4NTFjMTMxODc0MzdiMTAyYjcxOWMxY2VjOGMxZDBkYTdmYjk0OWYw
+    ODRiNjYzNDUwMjI1Zjk1M2FjZWMxMmFmNGJiYzBkNzE0NTgwZGNlMDQyNDM4
+    ZTIwY2QzNzc0NTVmOWQ5N2Q0Mzc3ZjQyYjRmOGM1MzUxZWY3NGU=

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 ruby_search_object.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vijayanand Nandam
+
+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,82 @@
+# RubySearchObject
+
+This gem provides a layout for implementation of search on activerecord / sequel or any other ORM based models. What this gem does is it creates and instace of the search handler class for the model and invokes the search method on that class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby_search_object'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_search_object
+
+Then include in you class like:
+    
+    class Article < ActiveRecord::Base
+      include RubySearchObject
+    end
+
+If not using in rails you might have to load the gem using
+
+    require 'ruby_search_object'
+
+
+## Usage
+Lets take the classic example of a **Article** search in an rails application.
+When you include the `RubySearchObject` module adds a method called `search` to the class. Then you can pass the parameters to the search method which will then be passed to you search handler object and return the results. Every time you call the method search on the Article class a new search object is created. The search method creates a new instance of class `ArticleSearch` when included in class `Article`. So it appends `Search` to the class name so your search logic should go into the class named `ArticleSearch` or what ever the class name you are using + Search.
+
+
+Example Implementaion of search.
+Lets say each `Article` has a title, description and published date.
+
+The Article Class will be like above
+
+    class Article < ActiveRecord::Base
+      include RubySearchObject
+    end
+
+An example article search class would be like (prefarably placed in app/services or app/search_handlers folder) 
+
+    class ArticleSearch
+      def initialize params = {}
+        @title = params[:title]
+        @start_date = params[:start_date]
+        @end_date = params[:end_date]
+        @articles = Article.order('id asc')
+      end
+
+      def search
+        build_title_query
+        build_date_range_query
+        @articles
+      end
+
+      def build_title_query
+        @articles = @articles.where(title: @title) if @title.present?
+      end
+
+      def build_date_range_query
+        @articles = @articles.where('published_date >= ?', @start_date) if @start_date.present?
+        @articles = @articles.where('published_date <= ?', @end_date) if @end_date.present?
+      end
+    end
+
+Then you can call the search like
+
+    Article.search(title: 'A Title', start_date: '2014-10-1', end_date: '2014-10-31')
+
+which will instantiate the ArticleSearch class with above params and returns the search results after forumulating the sql query with conditions.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks

data/lib/ruby_search_object.rb

@@ -0,0 +1,21 @@
+require "ruby_search_object/version"
+
+module RubySearchObject
+  module ClassMethods
+    def search(params = {})
+      search_handler(params).search
+    end
+
+    def search_handler params = {}
+      search_handler = search_handler_class.new(params)
+    end
+
+    def search_handler_class
+      Object.const_get("#{name}Search")
+    end
+  end
+
+  def self.included(host_class)
+    host_class.extend ClassMethods
+  end
+end

data/lib/ruby_search_object/version.rb

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

data/ruby_search_object.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_search_object/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_search_object"
+  spec.version       = RubySearchObject::VERSION
+  spec.authors       = ["Vijayanand Nandam"]
+  spec.email         = ["vijayanand.nandam@gmail.com"]
+  spec.description   = %q{A ruby service object pattern}
+  spec.summary       = %q{Implements the ruby search service object pattern to encapsulate search functionality on records of an object}
+  spec.homepage      = "http://cybrilla.com"
+  spec.license       = "MIT"
+
+  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', '~> 10.3', '>= 10.3.2'
+end

data/tests/ruby_search_object_test.rb

@@ -0,0 +1,44 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'ruby_search_object'
+
+class Article
+  include RubySearchObject
+end
+
+class ArticleSearch
+  attr_accessor :params
+  def initialize params = {}
+    @params = params
+  end
+
+  def search
+    params
+  end
+end
+
+describe RubySearchObject do
+
+  describe 'when asked for search handler' do
+    it 'returns the correct class' do
+      Article.search_handler_class.must_equal ArticleSearch
+    end
+  end
+
+  describe 'when asked for search handler' do
+    it 'returns search handler instance of search handler' do
+      Article.search_handler.class.must_equal ArticleSearch
+    end
+  end
+
+  describe 'when asked to search' do
+    it 'triggers the search on the search handler instance' do
+      params = { param: 1 }
+      Article.search(params).must_equal params
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ruby_search_object
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vijayanand Nandam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-22 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: '10.3'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+description: A ruby service object pattern
+email:
+- vijayanand.nandam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_search_object.rb
+- lib/ruby_search_object/version.rb
+- ruby_search_object.gemspec
+- tests/ruby_search_object_test.rb
+homepage: http://cybrilla.com
+licenses:
+- MIT
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Implements the ruby search service object pattern to encapsulate search functionality
+  on records of an object
+test_files: []