activerecord-search 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8ef7cc040cb55d4441f14102a4b54f59c442381
+  data.tar.gz: d7b779810f9712b735e3b6521955f7f743e20c64
+SHA512:
+  metadata.gz: d4eca6e16ac94069b4baf73d9c026455c1d875b36fcce734b8d2542edc31e7b6bd50f7bb41df4faa30ee57ada7c6c5a5dbc21ece153152be763e20cbb8b175d0
+  data.tar.gz: eaa616a114c777fc99954fefdc0e8bdcbc7abe82d150cf9cbd43a257ed591c8050d7b3869e208656b994cc29495188e68c2168b4231dc78faea5fcb144e7f63d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mehdi FARSI
+
+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,113 @@
+# ActiveRecord::Search
+
+a lightweight search-engine using ActiveRecord
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-search
+
+## Usage
+
+This plugin permits, with few lines of code, to have a lightweight and steady ActiveRecord search engine.
+
+Below is an example of the features offered by this plugin:
+
+Use case:
+
+A model named Post that contains 2 fields: `title:string` and `content:text`.
+We want to search any posts that include `Ruby` in their content:
+
+##### In `app/models/posts.rb`:
+
+```ruby
+class Post < ActiveRecord::Base
+    search_field :content
+    search_option :anywhere
+end
+```
+##### In `app/controllers/posts_controller.rb`:
+
+```ruby
+class PostsController < ApplicationController
+
+    def index
+        Post.search_post("Ruby")
+    end
+    
+    ...
+end
+```
+
+## More about the API
+
+##### search_option method
+
+`search_option` method specifies where to search in the sentence. Available options:
+
+- `:start_with` : the sentence starts with the pattern.
+- `:end_with`   : the sentence ends with the pattern.
+- `:anywhere`   : search anywhere in the sentence. [DEFAULT OPTION]
+
+##### search_MODEL method
+
+A method :search_MODEL is auto-generated. It's the method used in controller in our above example. some examples:
+ 
+- for a model Post a method `search_post` is generated.
+- for a model Book a method `search_book` is generated.
+
+The method can accept a second argument which is a `search_option`. Example:
+
+```ruby
+class PostsController < ApplicationController
+
+    def index
+        Post.search_post("Ruby", :start_with) # See search_option method section for more information
+    end
+    
+    ...
+end
+```
+
+Append the model name to this method results from the following question: What is the probability that a `search` method already exists in the model?
+
+In this example, the search-engine will search any posts that the content starts with `"Ruby"`.
+
+##### search_field method
+
+`search_field` method specifies which field is used for the search. It's possible to search in multiple fields by using the method `search_fields([])`: 
+
+```ruby
+class Post < ActiveRecord::Base
+    search_fields [:title, :content]
+end
+```
+
+In this example, the search-engine will search any posts that include `"Ruby"` in their content OR in their title.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mehdi-farsi/activerecord-search.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/activerecord-search.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/search/version'
+require 'activerecord/base'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-search"
+  spec.version       = Activerecord::Search::VERSION
+  spec.date          = '2015-10-05'
+  spec.authors       = ["Mehdi FARSI"]
+  spec.email         = ["mehdifarsi.pro@gmail.com"]
+
+  spec.summary       = %q{ActiveRecord::Search}
+  spec.description   = %q{a lightweight search-engine using ActiveRecord}
+  spec.homepage      = "https://github.com/mehdi-farsi/activerecord-search"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.post_install_message = <<-EOF
+  Thanks for installing!
+  You can follow me on:
+    - Twitter: @farsi_mehdi
+    - Github: mehdi-farsi
+
+  This project permits to help to solve a common problem. My reward is to see you using it.
+
+  So please, feel free to 'star' the project on GitHub:
+
+  https://github.com/mehdi-farsi/activerecord-search
+  
+   Many Thanks !
+  EOF
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activerecord", '~> 0'
+  spec.add_development_dependency "sqlite3", '~> 0'
+  spec.add_development_dependency "minitest", '~> 0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/search"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord/base.rb

@@ -0,0 +1,70 @@
+require "activerecord/search/version"
+require "active_record"
+
+module ActiveRecord
+  class SearchError < ::StandardError
+    def message
+      "Please set only one the following options: :start_with, :end_with, :anywhere"
+    end
+  end
+
+  class Base
+    class << self
+      def inherited(subclass)
+        super
+        return if subclass.to_s.underscore == "active_record/schema_migration"
+        class_eval <<-EOF
+          class << #{subclass} 
+            attr_reader :search_option, :search_fields
+
+            def search_#{subclass.to_s.underscore}(words, option = nil)
+              formatted_words = format_search(words, option)
+
+              search_scope  = []
+              search_params = {}
+              @search_fields.each do |field|
+                search_params[field] = formatted_words
+                search_scope << field.to_s + " LIKE :" + field.to_s
+              end
+
+              where([search_scope.join(" OR "), search_params])
+            end
+
+            def search_fields(fields)
+              @search_fields = [fields].flatten
+            end
+            alias_method :search_field, :search_fields 
+
+
+            # If options are given, they override the default options behavior
+            def format_search(words, option)
+              if !option.nil?
+                format_with_option(words, option)
+              else
+                o = @search_option.nil? ? :anywhere : @search_option
+                format_with_option(words, o)
+              end
+            end
+
+            def format_with_option(words, option)
+              case option
+                when :start_with then words + '%'
+                when :end_with   then '%' + words 
+                when :anywhere   then '%' + words + '%'
+                else
+                  raise SearchError
+              end
+            end
+
+            def search_option(option = :anywhere)
+              @search_option = option
+            end
+          end
+        EOF
+      end # self.inherited
+    end
+
+  end # Base
+end # ActiveRecord
+
+

data/lib/activerecord/search/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module Search
+    VERSION = "0.1.1"
+  end
+end

data/lib/activerecord/search.rb

@@ -0,0 +1,7 @@
+require "activerecord/search/version"
+
+module Activerecord
+  module Search
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-search
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mehdi FARSI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: a lightweight search-engine using ActiveRecord
+email:
+- mehdifarsi.pro@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-search.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/base.rb
+- lib/activerecord/search.rb
+- lib/activerecord/search/version.rb
+homepage: https://github.com/mehdi-farsi/activerecord-search
+licenses:
+- MIT
+metadata: {}
+post_install_message: "  Thanks for installing!\n  You can follow me on:\n    - Twitter:
+  @farsi_mehdi\n    - Github: mehdi-farsi\n\n  This project permits to help to solve
+  a common problem. My reward is to see you using it.\n\n  So please, feel free to
+  'star' the project on GitHub:\n\n  https://github.com/mehdi-farsi/activerecord-search\n
+  \ \n   Many Thanks !\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: ActiveRecord::Search
+test_files: []