wildsearcher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e4cc4203569b654f25a929843566c92f77f4f0d
+  data.tar.gz: 171f199fddb87ce52adb931de3c69e622fc7b771
+SHA512:
+  metadata.gz: f44bc5e1bbeccc8d922ce1e38f94b9f27d2796cd38d2e528adb54982b19c74506b589d1020d44011db5388e1250405a7149882be19b4db8fb4c17d8e4ab727c7
+  data.tar.gz: aa0310db8067cf79f6100fec5940f7ccfd3cbd689bf7a313b4e0491d999a9e976f924988df602089feb0461e105ad17e6ea866c112481c0e572fc6fb9095b2be

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vivek Bisen
+
+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,48 @@
+# Wildsearcher
+
+Search for records in rails controller or model by specifying fields and a search term.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wildsearcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wildsearcher
+
+## Usage
+
+##### `wildsearcher(params)`
+
+For your rails application, make your url look like `http://some.car_website.com?search_fields=year,make,vin&search_term=fancy ford`.
+
+This will populate `search_term` and `search_fields` in your controller params. Now, filter your records in `index` action or wherever by calling `Car.wildsearcher(params)`. That's it!
+
+
+##### `filter_records`
+
+If you are looking for filtering records for a model `Car(id: integer, year: integer, make: string, vin: string)`, you can call `Car.filter_records(search_fields: [year, vin], search_term: "20")` and it will return expected records.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/vivekbisen/wildsearcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/wildsearcher.rb

@@ -0,0 +1,44 @@
+require "wildsearcher/version"
+require "active_record"
+
+module Wildsearcher
+  def wildsearcher(params = {})
+    field_array = params[:search_fields].to_s.split(",")
+    term = params[:search_term].to_s.strip
+    filter_records(search_fields: field_array, search_term: term)
+  end
+
+  def filter_records(search_fields: [], search_term: "")
+    return default_scope if search_fields.empty? || search_term.blank?
+    where(conditions(filter_fields(search_fields), search_term))
+  end
+
+  private def filter_fields(fields)
+    fields.keep_if do |f|
+      f.to_s.downcase.in? column_names
+    end
+  end
+
+  private def conditions(fields, term)
+    term = "%" + term.strip + "%" if db_like == "ILIKE"
+    [fields.map { |f| "#{f} #{db_like} ?" }.join(" OR ")] + ([term] * fields.count)
+  end
+
+  private def default_scope
+    ::ActiveRecord::VERSION::MAJOR >= 4 ? all : scoped
+  end
+
+  private def db_like
+    case ::ActiveRecord::Base.connection.class.name.demodulize
+    when "PostgreSQLAdapter"
+      "ILIKE"
+    when "MysqlAdapter"
+      "LIKE"
+    else
+      raise NotImplementedError.new("Wildsearcher currently supports only Mysql and Postgresql.")
+    end
+  end
+
+end
+
+::ActiveRecord::Base.extend(Wildsearcher)

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: wildsearcher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vivek Bisen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Filter your records for your rails app with one line change.
+email:
+- vivek@luther.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/wildsearcher.rb
+homepage: https://github.com/vivekbisen/wildsearcher
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Provide a way to search a term for specified fields
+test_files: []