simple_searchable 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19f0ade7eb4a83e53e03a6af593ec719af361c10
-  data.tar.gz: 77105c491ed716463a9e5cc615c2e2004078ad04
+  metadata.gz: d07f09bcd6be2d696361577ec3aba42f9ce290c2
+  data.tar.gz: 702622cc97bd72ce5ef8e2f5b10196374bb71ded
 SHA512:
-  metadata.gz: 473bf886754178aa8d8859c485f19d161b830a76f58794bfcfd664f73559bb4f51e20d38db5edee0c8fc3411b2de9525a96d4d97a14fc6d609c1d3fac9791b2b
-  data.tar.gz: fad07694c31f7999cc6b05afd1190e5cc431292859e2d1be2bdbe425be3bd45c5a3d40a19743b2cd0fe07d941ea843cde7291df0718c2201f60e10fb3ddf54f4
+  metadata.gz: 27bf6590e2b6f9550b06eb15a07339053c962225353434543b9936534d948e7542bb22580b3e03bc00d03cdf9a5ebbf45018a5266fd4cf4fee92fb25fcc4cd5c
+  data.tar.gz: 10e6740913c3c25b339fa8eaf11a99b1d10a59acc8234ffa069f8452151dfa386961f95356bfcc56b780f01c51461430150651bd98e5bcb9ccc7a5cd208721dc

data/README.md

@@ -1,6 +1,6 @@
 # SimpleSearchable
 
-TODO: Write a gem description
+This gem adds the utility methods for a basic ActiveRecord search/filtering pattern explained [here](http://www.wordofmike.net/j/easy-active-record-search-pattern).
 
 ## Installation
 
@@ -14,13 +14,52 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install simple_searchable
+To use, bundle the gem with your project and call `searchable_by` from your model(s):
 
-## Usage
+```ruby
+class Religion < ActiveRecord::Base
+  searchable_by :monotheiestic, :originated_in
+  
+  def self.originated_in(continents)
+    where(originating_continent: continents)
+  end
+  
+  def self.monotheistic(true_false)
+    where(monotheistic: true_false)
+  end
+end
+```
+
+Now write a search form which uses the method names as parameter keys:
+
+```erb
+<%= form_tag religions_path do %>
+  <%= fields_for :religion_filters do |f| %>
+    <%= f.label do %>
+      Monotheistic? <%= f.check_box :monotheistic, {}, true, false %>
+    <% end %>
+  
+    <%= f.label :originated_in, "Originated" %>
+    <%= f.select :originated_in, LOCATIONS %>
+  <% end %>
+
+  <%= submit_tag "Search Religions" %>
+<% end %>
+```
+
+And get your controller to use `search`:
+
+```ruby
+class ReligionsController < ApplicationController
+  def index
+    @religions = Religion.search(params[:religion_filters])
+  end
+end
+```
 
-TODO: Write usage instructions here
+If you want to add a new filter, add the scope to the AR class and list it in `searchable_by`, then add an input to your form.
 
 ## Contributing
 

data/lib/simple_searchable/version.rb

@@ -1,3 +1,3 @@
 module SimpleSearchable
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/simple_searchable.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activerecord", "~> 4.0", ">= 4.0"
+  spec.add_runtime_dependency "activerecord", "< 6", ">= 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,61 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: simple_searchable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - '>='
+        version: '6'
+    - - ">="
       - !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'
-    - - '>='
+        version: '6'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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'
 description: 
@@ -65,7 +65,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,19 +83,18 @@ 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
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A very simple ActiveRecord search pattern
 test_files: []
-has_rdoc: