active_search 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9c7dd30c9833519ed79bd213892cb61a9377ca5
-  data.tar.gz: c29c291a9e4585979e41f7fbad3e849e9d41a9a3
+  metadata.gz: d62e32ef5213c4e135d0d4bb69d3b4ac0bdc504c
+  data.tar.gz: b9abf6b9ff1bc7bff9bf05faa1f85c513e49879c
 SHA512:
-  metadata.gz: 8c1208749ac67681714764c99bc6924584ebcb8e43dca0d1ede4342b343519d8017b490e9cc2f7d7f94dd5704771f30b03a7e600f289aabc020ca40d577a6d71
-  data.tar.gz: 29db12d2b2d1f2b0d5c903ab1f446d2869a3d45af6be58178e3ef0b81f804079454a8f8b6c0a9fc5fdfbd7b2ef95194c10ac0935b75d6ead11096799886f165a
+  metadata.gz: 2eec8c4ab05cddbc04f7c197e12551e14f2f67acab4bfd3f75b2f3b5737fc5baec62892f8284418615de24839d5ac81c605ed5ac4c35e524153d4adde26e6b19
+  data.tar.gz: da6c5d1b53f994ebdb67a97f05f9e9c5da411b8ecc740351dc1a1a81d0c73e7b4ff3ea6a44925a7cf9bad3f927ebb534bc22c38331076770d3ac09d7a4df486f

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p374@searchable"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.3 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.9.3"

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,11 +1,11 @@
-## Searchable
+## ActiveSearch
 #### 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
+ActiveSearch adds some methods to ActiveRecord::Base Objects
 
 
 ```
@@ -39,7 +39,7 @@ This can also be called on an instance of a Class to search against a collection
 
 #### How the Heck do you use this?
 1. Install the Gem
-
+    
     ```ruby
     gem install searchable
     ```

data/active_search.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   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.description   = "ActiveSearch will allow any model to be 'searched for' in a text field given the 'searchable_by' attribute"
   spec.summary       = "Easily make items searchable inside of your app"
-  spec.homepage      = "http://github.com/zachmokahn/searchable"
+  spec.homepage      = "http://github.com/zachmokahn/active_search"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/active_search/is_searchable.rb

@@ -0,0 +1,21 @@
+module ActiveSearch
+  module IsSearchable
+    extend ActiveSupport::Concern
+    module ClassMethods
+      attr_reader :searchable_values
+      def is_searchable?
+        true
+      end
+      alias searchable? is_searchable?
+
+      def find_by_value(value, association=self)
+        values = []
+        @searchable_values.each do |search|
+         values << association.where("#{search} LIKE ?", "%#{value}%")
+        end
+        values.flatten
+      end
+      alias search_for find_by_value
+    end
+  end
+end

data/lib/active_search/search_helper.rb

@@ -0,0 +1,27 @@
+require 'active_support/concern'
+
+module ActiveRecord
+  class Base
+    def find_by_value(value, association)
+      self.send(association.to_sym).find_by_value(value)
+    end
+    alias search_for find_by_value
+  end
+end
+
+module ActiveSearch
+  module SearchHelper
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def is_searchable?
+        false
+      end
+      alias searchable? is_searchable?
+      def searchable_by(*values)
+	@searchable_values = values
+        include ActiveSearch::IsSearchable
+      end
+      alias findable_by searchable_by
+    end
+  end
+end

data/lib/active_search/version.rb

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

data/spec/lib/active_search_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'active_search'
+
+class Model < ActiveRecord::Base
+end
+
+class SearchableModel < ActiveRecord::Base
+  belongs_to :is_not_searchable_model
+  belongs_to :is_searchable_model
+  searchable_by :test, :banana
+end
+
+class IsNotSearchableModel < ActiveRecord::Base
+  has_many :searchable_models
+end
+
+class IsSearchableModel < ActiveRecord::Base
+  has_many :searchable_models
+  searchable_by :test
+end
+
+class FindableModel < ActiveRecord::Base
+  findable_by :test
+end
+
+describe ActiveSearch do
+      before(:each) do
+        @model = Model.create(test: "test")
+        @is_not_searchable_model = IsNotSearchableModel.create(test: "test")
+        @is_searchable_model = IsSearchableModel.create(test: "test")
+        @bob = SearchableModel.create(test: "Bob",
+                                      banana: "yellow",
+                                      is_not_searchable_model_id: @is_not_searchable_model.id,
+                                      is_searchable_model_id: @is_searchable_model.id)
+        @bob2 = SearchableModel.create(test: "Bob",
+                                       banana: "brown",
+                                       is_not_searchable_model_id: @is_not_searchable_model.id,
+                                       is_searchable_model_id: @is_searchable_model.id)
+      end
+  describe "Active Record Model" do
+    context "#is_searchable?" do
+      it "returns false by default" do
+        expect(Model.is_searchable?).to be_false
+      end
+
+      it "returns true if '#search_by' is included" do
+        expect(SearchableModel.is_searchable?).to be_true
+      end
+    end
+    context "#searchable_values" do
+      it "returns values passed to '#searchable_by'" do
+        expect(SearchableModel.searchable_values).to include(:test)
+      end
+    end
+    context "#find_by_values" do
+        it "returns an array of matching objects" do
+        expect(SearchableModel.find_by_value("Bob")).to include(@bob)
+        expect(SearchableModel.find_by_value("Bob")).to include(@bob2)
+        expect(SearchableModel.find_by_value("yellow")).to include(@bob)
+        expect(SearchableModel.find_by_value("yellow")).to_not include(@bob2)
+      end
+    end
+  end
+  describe "Active Record Associations" do
+    context "#find_by_values" do
+      it "returns an instance of a model's associations found by value when the model is searchable" do
+        expect(@is_searchable_model.class.is_searchable?).to be_true
+        expect(@is_searchable_model.find_by_value("yellow", "searchable_models")).to include(@bob)
+        expect(@is_searchable_model.find_by_value("yellow", "searchable_models")).to_not include(@bob2)
+      end
+      it "returns an instance of a model's associations found by value when the model is not searchable" do
+        expect(@is_not_searchable_model.class.is_searchable?).to be_false
+        expect(@is_not_searchable_model.find_by_value("yellow", "searchable_models")).to include(@bob)
+        expect(@is_not_searchable_model.find_by_value("yellow", "searchable_models")).to_not include(@bob2)
+      end
+    end
+  end
+  describe "Partial Matches" do
+    context "#find_by_value" do
+      it "returns the models as long as the value partially matches the '#seachable_values' strings" do
+        expect(SearchableModel.find_by_value("ow")).to include(@bob)
+        expect(SearchableModel.find_by_value("ow")).to include(@bob2)
+      end
+      it "does not return the value if the partial strings do not match" do
+        expect(SearchableModel.find_by_value("low")).to include(@bob)
+        expect(SearchableModel.find_by_value("low")).to_not include(@bob2)
+        expect(SearchableModel.find_by_value("row")).to include(@bob2)
+        expect(SearchableModel.find_by_value("row")).to_not include(@bob)
+      end
+      it "returns the models regardless of case" do
+        expect(SearchableModel.find_by_value("bob")).to include(@bob)
+        expect(SearchableModel.find_by_value("bob")).to include(@bob2)
+        expect(SearchableModel.find_by_value("Yellow")).to include(@bob)
+        expect(SearchableModel.find_by_value("Brown")).to include(@bob2)
+      end
+    end
+  end
+  describe "Method Aliases" do
+    context "#searchable?" do
+      it "is an alias for #is_searchable?" do
+	expect(SearchableModel.searchable?).to eq(SearchableModel.is_searchable?)
+	expect(Model.searchable?).to eq(Model.is_searchable?)
+      end
+    end
+    context "#search_for" do
+      it "is an alias for #find_by_value" do
+        expect(SearchableModel.search_for("Bob")).to eq(SearchableModel.find_by_value("Bob"))
+        expect(@is_searchable_model.search_for("yellow", "searchable_models")).to eq(@is_searchable_model.find_by_value("yellow", "searchable_models"))
+        expect(@is_not_searchable_model.search_for("yellow", "searchable_models")).to eq(@is_not_searchable_model.find_by_value("yellow", "searchable_models"))
+      end
+    end
+    context "#findable_by" do
+      it "is an alias for #searchable_by" do
+      	expect(FindableModel.searchable?).to eq(true)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'coveralls'
+Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+require 'active_search'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3",
+  :database => ":memory:")
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+  create_table :models, :force => true do |t|
+    t.string :test
+  end
+  create_table :searchable_models, :force => true do |t|
+    t.string :test
+    t.string :banana
+    t.integer :is_not_searchable_model_id
+    t.integer :is_searchable_model_id
+  end
+  create_table :is_not_searchable_models, :force => true do |t|
+    t.string :test
+  end
+  create_table :is_searchable_models, :force => true do |t|
+    t.string :test
+  end
+  create_table :findable_models, :force => true do |t|
+    t.string :test
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_search
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Zachary J. Davy
@@ -122,8 +122,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Searchable will allow any model to be 'searched for' in a text field
-  given the 'search' class
+description: ActiveSearch will allow any model to be 'searched for' in a text field
+  given the 'searchable_by' attribute
 email:
 - zachmokahn@gmail.com
 executables: []
@@ -131,14 +131,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_search.gemspec
+- img/tests.png
 - lib/active_search.rb
+- lib/active_search/is_searchable.rb
+- lib/active_search/search_helper.rb
 - lib/active_search/version.rb
-homepage: http://github.com/zachmokahn/searchable
+- spec/lib/active_search_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/zachmokahn/active_search
 licenses:
 - MIT
 metadata: {}
@@ -162,4 +170,6 @@ rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Easily make items searchable inside of your app
-test_files: []
+test_files:
+- spec/lib/active_search_spec.rb
+- spec/spec_helper.rb