dynamic_search 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bd92fbf6e943b1e7103d631f528bc256f1908c2
+  data.tar.gz: e625b99742280f234547e6d4984ece01ed830d97
+SHA512:
+  metadata.gz: 8ade600ac15512d56ab78a93c77aeda6e586d8e8c730f9458b0ba2a1367157419174c44512d19cc9466c6f330a29824762fecb0661e761681717a6e0ee04ee84
+  data.tar.gz: df5c166699f454040155a4cc797705798136c10a2fbb48fc97c6e0c71781790f2c6e8e7ffd53403637c738ade2d03459239a0993f9d582818b8147fe2577ec7a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jeremy Winterberg
+
+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,56 @@
+# DynamicSearch
+DynamicSearch provides support for multi term searches to your rails models.
+
+## Usage
+1. Include the module to any model you want DynamicSearch functionality.  
+```ruby
+include DynamicSearch
+```
+
+2. Customize the search method to your models to specify how your search should work. In
+   this case, you're telling the search method which columns you want included in your
+   search. By default, DynamicSearch looks at every column except foreign keys, id,
+   and timestamps.
+```ruby  
+def search(search)  
+  super(search, ["first_name", "last_name", "username", "email"])  
+end  
+```
+
+3. To use the search you can create a search box form in your view.  
+```ruby  
+<%= form_for :model_name, method: 'get' do |f| %>  
+  <%= f.text_field :search, placeholder: "search" %>  
+<% end %>  
+```  
+Then in your controller, you can call the search method on your model.  
+```ruby  
+if params.has_key? :search  
+  @results = Model.search(params[:search])  
+end  
+```
+From there I normally would paginate the results.
+
+## Installation
+Add this line to your application's Gemfile:  
+
+```ruby
+gem 'dynamic_search'
+```
+
+And then execute:  
+```bash
+$ bundle
+```
+
+Or install it yourself as:  
+```bash
+$ gem install dynamic_search
+```
+
+## Contributing
+If you find a bug, submit an issue or pull request if you've fixed it. Feel free to reach
+out on twitter: [@jeremydwayne](https://www.twitter.com/jeremydwayne)
+
+## 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,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DynamicSearch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/dynamic_search.rb

@@ -0,0 +1,43 @@
+module DynamicSearch
+  extend ActiveSupport::Concern
+  ##
+  # This module provides the parent search method which will be available
+  # to any model which includes DynamicSearch `include DynamicSearch`
+
+  module ClassMethods
+
+    def search(search, columns = nil)
+      ##
+      # The search method will search all columns except foreign keys, id,
+      # and timestamps. The columns searched can be overwritten in an individual model
+      # by using the following syntax:
+      # 
+      # def search(search)
+      #   super(search, ["array", "of", "columns"])
+      # end
+
+      if search.present?
+        columns ||= self.column_names.reject{|e| e.end_with?("_id")} - ["id", "created_at", "updated_at"]
+        params = {}
+        sql = []
+
+        search.split.each_with_index do |s, i|
+          params["first#{i}".to_sym] = "#{sanitize_sql(s)}%"
+          params["nth#{i}".to_sym] = "% #{sanitize_sql(s)}%"
+
+          statements = []
+          for column in columns
+            statements << "#{column} LIKE :first#{i}"
+            statements << "#{column} LIKE :nth#{i}"
+          end
+
+          sql << "(#{statements.join(" OR ")})"
+        end
+        self.where(sql.join(" AND "), params)
+      else
+        self.all
+      end
+    end
+
+  end
+end

data/lib/dynamic_search/version.rb

@@ -0,0 +1,3 @@
+module DynamicSearch
+  VERSION = '0.1.6'
+end

data/lib/tasks/dynamic_search_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dynamic_search do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: dynamic_search
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Jeremy Winterberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: rspec
+  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: Adds a search method which allows you to search for multiple words from
+  multiple columns.
+email:
+- winterjd@uwec.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/dynamic_search.rb
+- lib/dynamic_search/version.rb
+- lib/tasks/dynamic_search_tasks.rake
+homepage: https://www.github.com/jeremydwayne/dynamic_search
+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.6.13
+signing_key: 
+specification_version: 4
+summary: DynamicSearch provides support for multi term searches to your rails models.
+test_files: []