active_search 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9c7dd30c9833519ed79bd213892cb61a9377ca5
+  data.tar.gz: c29c291a9e4585979e41f7fbad3e849e9d41a9a3
+SHA512:
+  metadata.gz: 8c1208749ac67681714764c99bc6924584ebcb8e43dca0d1ede4342b343519d8017b490e9cc2f7d7f94dd5704771f30b03a7e600f289aabc020ca40d577a6d71
+  data.tar.gz: 29db12d2b2d1f2b0d5c903ab1f446d2869a3d45af6be58178e3ef0b81f804079454a8f8b6c0a9fc5fdfbd7b2ef95194c10ac0935b75d6ead11096799886f165a

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 zachmokahn
+
+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,69 @@
+## Searchable
+#### By zachmokahn
+
+This gem is in very early, very beta release. Please report any and all bugs, as well as any or all desired features. I'd love to make this better, or for you to make it better. Fork it, make pull requests, give me feedback. THANKS!
+
+#### What does it do?
+
+Searchable adds some methods to ActiveRecord::Base Objects
+
+
+```
+#is_searchable?
+#searchable?
+```
+```is_searchable?``` and it's alias: ```searchable?``` detect whether or not any class that inherits from ActiveRecord::Base is searchable. By default this returns false.
+
+
+```
+#searchable_by(:parameters)
+#findable_by(:parameters)
+```
+By adding ```searchable_by``` or it's alias ```findable_by``` to a class inheriting for ActiveRecord::Base it will become searchable by the provided parameters that correspond to columns in the database.
+When this is included ```#searchable?``` will return true.
+
+
+```
+#find_by_value("value")
+#search_for("value")
+```
+By calling ```find_by_value``` or it's alias ```search_for``` on a class it checks all the searchable parameters of the Class the method is being called on for a match. This method will preform partial matches and is case insensitive.
+
+
+```
+#find_by_value("value", "association")
+#search_for("value", "association")
+```
+This can also be called on an instance of a Class to search against a collection of ActiveRecord::Associations where the searchable parameters match.
+
+
+#### How the Heck do you use this?
+1. Install the Gem
+
+    ```ruby
+    gem install searchable
+    ```
+or Require it in your Gemfile
+    ```ruby
+    gem 'searchable'
+    ```
+2. Make a class searchable
+
+    ```ruby
+    class Model < ActiveRecord::Base
+      searchable_by :first_name, :last_name, :nickname
+    end
+    ```
+3. Find instances of that class
+
+    ```ruby
+    Model.search_for("zachmo")
+      => [#<Model id: 1, first_name: "Zack", last_name: "Mo", nickname: "zachmo", created_at: "2013-12-01 04:00:48", updated_at: "2013-12-01 04:00:48">]
+    ```
+
+===
+
+##### Are you sure it works?
+I test drove this whole development, so everything included works.
+<img align="center" src="img/tests.png" />
+Is it perfect? No. But it beta. Give me a break.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/active_search.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_search"
+  spec.version       = ActiveSearch::VERSION
+  spec.authors       = ["Zachary J. Davy"]
+  spec.email         = ["zachmokahn@gmail.com"]
+  spec.description   = "Searchable will allow any model to be 'searched for' in a text field given the 'search' class"
+  spec.summary       = "Easily make items searchable inside of your app"
+  spec.homepage      = "http://github.com/zachmokahn/searchable"
+  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_runtime_dependency "activerecord"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/active_search.rb

@@ -0,0 +1,6 @@
+require "active_search/version"
+require "active_record"
+
+['search_helper.rb', 'is_searchable.rb'].each { |path| Dir["#{File.dirname(__FILE__)}/active_search/#{path}"].each { |f| require(f) } }
+
+ActiveRecord::Base.send :include, ActiveSearch::SearchHelper

data/lib/active_search/version.rb

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

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: active_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zachary J. Davy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: coveralls
+  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: guard
+  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: guard-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: Searchable will allow any model to be 'searched for' in a text field
+  given the 'search' class
+email:
+- zachmokahn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_search.gemspec
+- lib/active_search.rb
+- lib/active_search/version.rb
+homepage: http://github.com/zachmokahn/searchable
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Easily make items searchable inside of your app
+test_files: []