minidusen 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21b9abdca5644bbe2c9d7266988f8a0a22927435
+  data.tar.gz: 8fde451ba5ee361aa2c7ee3377ac195edd641d0e
+SHA512:
+  metadata.gz: fbd3c16faed08b0ec651898c609f78da008688701513dbfa372f495327540d14d283f031d9723d75a8425069499aab945129ee794b0bd1aa85699bc9bcd36e6c
+  data.tar.gz: fc869ed7bd8b21f1babd9c433bf6c5c31383188a6d9672e3a43680591bde2989dbd61ce4678d9ff525a1ef2d266935fd3da245a288eb3b110ba0c00846d01812

data/.gitignore

@@ -0,0 +1,7 @@
+pkg
+tags
+*.gem
+.idea
+tmp
+spec/support/database.yml
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1,2 @@
+2.2.4
+

data/.travis.yml

@@ -0,0 +1,30 @@
+language: ruby
+rvm:
+  - "2.1.8"
+  - "2.3.1"
+gemfile:
+  - gemfiles/Gemfile.3.2.mysql2
+  - gemfiles/Gemfile.4.2.mysql2
+  - gemfiles/Gemfile.4.2.pg
+  - gemfiles/Gemfile.5.0.mysql2
+  - gemfiles/Gemfile.5.0.pg
+before_script:
+  - psql -c 'create database minidusen_test;' -U postgres
+  - mysql -e 'create database IF NOT EXISTS minidusen_test;'
+script: bundle exec rspec spec
+sudo: false
+cache: bundler
+notifications:
+  email:
+    - fail@makandra.de
+branches:
+  only:
+    - master
+matrix:
+  exclude:
+    - rvm: "2.3.1"
+      gemfile: gemfiles/Gemfile.3.2.mysql2
+    - rvm: "2.1.8"
+      gemfile: gemfiles/Gemfile.5.0.mysql2
+    - rvm: "2.1.8"
+      gemfile: gemfiles/Gemfile.5.0.pg

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Henning Koch
+
+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,209 @@
+Minidusen [![Build Status](https://secure.travis-ci.org/makandra/minidusen.png?branch=master)](https://travis-ci.org/makandra/minidusen)
+=========
+
+Low-tech search solution for ActiveRecord with MySQL or PostgreSQL
+------------------------------------------------------------------
+
+Minidusen lets you filter ActiveRecord models with a single query string.
+It works with your existing MySQL or PostgreSQL schema by mostly relying on simple `LIKE` queries. No additional indexes, tables or indexing databases are required.
+
+Minidusen accepts a single, Google-like query string and converts it into `WHERE` conditions for [an ActiveRecord scope](http://guides.rubyonrails.org/active_record_querying.html#conditions).
+
+The following type of queries are supported:
+
+- `foo` (case-insensitive search for `foo` in developer-defined columns)
+- `foo bar` (rows must include both `foo` and `bar`)
+- `"foo bar"` (rows must include the phrase `"foo bar"`)
+- `-bar` (rows must not include the word `bar`)
+- `filetype:pdf` (developer-defined filter for file type)
+- `some words 'a phrase' filetype:pdf -excluded -'excluded  phrase' -filetype:pdf` (combination of the above)
+
+Minidusen is a quick way to implement find-as-you-type filters for index views:
+
+![A list of records filtered by a query](https://raw.githubusercontent.com/makandra/minidusen/master/doc/filtered_index_view.cropped.png)
+
+We have found it to scale well for many thousand records. It's probably not a good idea to use Minidusen for hundreds of thousands of records or very long text columns. For this we recommend to use PostgreSQL with [pg_search](https://github.com/Casecommons/pg_search) or full-text databases like [Solr](https://github.com/sunspot/sunspot).
+
+
+Installation
+------------
+
+In your `Gemfile` say:
+
+```ruby
+gem 'minidusen'
+```
+
+Now run `bundle install` and restart your server.
+
+
+Basic Usage
+-----------
+
+Our example will be a simple address book:
+
+```ruby
+class Contact < ActiveRecord::Base
+  validates_presence_of :name, :street, :city, :email
+end
+```
+
+We create a new class `ContactFilter` that will describe the searchable columns:
+
+```ruby
+class ContactFilter
+  include Minidusen::Filter
+
+  filter :text do |scope, phrases|
+    columns = [:name, :email]
+    scope.where_like(columns => phrases)
+  end
+
+end
+```
+
+We can now use `ContactFilter` to filter a scope of `Contact` records:
+
+```ruby
+# We start by building a scope of all contacts.
+# No SQL query is made.
+all_contacts = Contact.all
+# => ActiveRecord::Relation
+
+# Now we filter the scope to only contain contacts with "gmail" in either :name or :email column.
+# Again, no SQL query is made.
+gmail_contacts = ContactFilter.new.filter(all_contacts, 'gmail')
+# => ActiveRecord::Relation
+
+# Inspect the filtered scope.
+gmail_contacts.to_sql
+# => "SELECT * FROM contacts WHERE name LIKE '%gmail%' OR email LIKE '%gmail%'"
+
+# Finally we load the scope to produce an array of Contact records.
+gmail_contacts.to_a
+# => Array
+```
+
+### Filtering scopes with existing conditions
+
+Note that you can also pass a scope with existing conditions to `ContactFilter#filter`. The returned scope will contain both the existing conditions and the conditions from the filter:
+
+```ruby
+published_contacts = Contact.where(published: true)
+# => ActiveRecord::Relation
+
+published_contacts.to_sql
+# => "SELECT * FROM contacts WHERE (published = 1)"
+
+gmail_contacts = ContactFilter.new.filter(published_contacts, 'gmail')
+# => ActiveRecord::Relation
+
+gmail_contacts.to_sql
+# => "SELECT * FROM contacts WHERE (published = 1) AND (name LIKE '%gmail%' OR email LIKE '%gmail%')"
+```
+
+### How `where_like` works
+
+The example above uses `where_like`. You can call `where_like` on any scope to produce a new scope where the given array of column names must contain all of the given phrases.
+
+Let's say we call `ContactFilter.new.filter(Contact.published, 'foo "bar baz" bam')`. This will call the block `filter :text do |scope, phrases|` with the following arguments:
+
+```ruby
+scope == Contact.published
+phrases == ['foo', 'bar baz', 'bam']
+```
+
+The scope `scope.where_like(columns => phrases)` will now represent the following SQL query:
+
+```ruby
+SELECT * FROM contacts
+WHERE (name LIKE "%foo%" OR email LIKE "%foo") AND (email LIKE "%foo%" OR email LIKE "%foo")
+```
+
+You can also use `where_like` to find all the records *not* matching some phrases, using the `:negate` option:
+
+```ruby
+Contact.where_like(name: 'foo', negate: true)
+```
+
+Processing queries for qualified fields
+---------------------------------------
+
+Google supports queries like `filetype:pdf` that filters records by some criteria without performing a full text search. Minidusen gives you a simple way to support such search syntax.
+
+Let's support a query like `email:foo@bar.com` to explictly search for a contact's email address, without filtering against other columns.
+
+We can learn this syntax by adding a `filter:email` instruction
+to our `ContactFilter` class`:
+
+```ruby
+class ContactFilter
+  include Minidusen::Filter
+
+  search_by :email do |scope, email|
+    scope.where(emai: email)
+  end
+
+  search_by :text do |scope, phrases|
+    columns = [:name, :email]
+    scope.where_like(columns => phrases)
+  end
+
+end
+```
+
+We can now explicitly search for a user's e-mail address:
+
+```ruby
+ContactFilter.new.filter(Contact, 'email:foo@bar.com').to_sql
+# => "SELECT * FROM contacts WHERE email='foo@bar.com'"
+```
+
+### Caveat
+
+If you search for a phrase containing a colon (e.g. `deploy:rollback`), Minidusen will mistake the first part as a – nonexistent – qualifier and return an empty set.
+
+To prevent that, search for a phrase:
+
+    "deploy:rollback"
+
+
+Supported Rails versions
+------------------------
+
+Minidusen is tested on:
+
+- Rails 3.2
+- Rails 4.2
+- Rails 5.0
+- MySQL 5.6
+- PostgreSQL
+
+If you need support for platforms not listed above, please submit a PR!
+
+
+Development
+-----------
+
+- There are tests in `spec`. We only accept PRs with tests.
+- We currently develop using Ruby 2.2.4 (see `.ruby-version`) since that version works for all versions of ActiveRecord that we support.
+- TravisCI will test additional Ruby versions (2.1.8 and 2.3.1)
+- Put your database credentials into `spec/support/database.yml`. There's a `database.sample.yml` you can use as a template.
+- Create a database `minidusen_test` in both MySQL and PostgreSQL.
+- There are gem bundles in `gemfiles` for each combination of ActiveRecord version and database type that we support.
+- You can bundle all test applications by saying `bundle exec rake all:install`
+- You can run specs from the project root by saying `bundle exec rake all:spec`.
+
+If you would like to contribute:
+
+- Fork the repository.
+- Push your changes **with passing specs**.
+- Send me a pull request.
+
+Note that we're very eager to keep this gem lightweight. If you're unsure whether a change would make it into the gem, [open an issue](https://github.com/makandra/minidusen/issues/new).
+
+
+Credits
+-------
+
+Henning Koch from [makandra](http://makandra.com/)

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'bundler/gem_tasks'
+
+desc 'Default: Run all specs.'
+task :default => 'all:spec'
+
+namespace :all do
+
+  desc "Run specs on all versions"
+  task :spec do
+    success = true
+    for_each_gemfile do
+      success &= system("bundle exec rspec spec")
+    end
+    fail "Tests failed" unless success
+  end
+
+  desc "Bundle all versions"
+  task :install do
+    for_each_gemfile do
+      system('bundle install')
+    end
+  end
+
+  desc "Update all versions"
+  task :update do
+    for_each_gemfile do
+      system('bundle update')
+    end
+  end
+
+end
+
+def for_each_gemfile
+  version = ENV['VERSION'] || '*'
+  Dir["gemfiles/Gemfile.#{version}"].sort.each do |gemfile|
+    next if gemfile =~ /.lock/
+    puts '', "\033[44m#{gemfile}\033[0m", ''
+    ENV['BUNDLE_GEMFILE'] = gemfile
+    yield
+  end
+end

data/gemfiles/Gemfile.3.2.mysql2

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '=3.2.22'
+gem 'rspec', '~> 3.4'
+gem 'mysql2', '= 0.3.17'
+
+gem 'byebug'
+
+gem 'minidusen', :path => '..'
+gem 'i18n', '=0.6.11' # 0.7 no longer builds for Ruby 1.8.7

data/gemfiles/Gemfile.3.2.mysql2.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: ..
+  specs:
+    minidusen (0.7.0)
+      activerecord (>= 3.2)
+      activesupport (>= 3.2)
+      edge_rider (>= 0.2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.22)
+      activesupport (= 3.2.22)
+      builder (~> 3.0.0)
+    activerecord (3.2.22)
+      activemodel (= 3.2.22)
+      activesupport (= 3.2.22)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.22)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    byebug (8.2.0)
+    diff-lcs (1.2.5)
+    edge_rider (0.3.1)
+      activerecord
+    i18n (0.6.11)
+    multi_json (1.11.2)
+    mysql2 (0.3.17)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    tzinfo (0.3.46)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.2.22)
+  byebug
+  i18n (= 0.6.11)
+  minidusen!
+  mysql2 (= 0.3.17)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.12.5

data/gemfiles/Gemfile.4.2.mysql2

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~>4.2.1'
+gem 'rspec', '~>3.4'
+gem 'mysql2', '~> 0.3.17'
+
+gem 'byebug'
+
+gem 'minidusen', :path => '..'

data/gemfiles/Gemfile.4.2.mysql2.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: ..
+  specs:
+    minidusen (0.7.0)
+      activerecord (>= 3.2)
+      activesupport (>= 3.2)
+      edge_rider (>= 0.2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activerecord (4.2.5)
+      activemodel (= 4.2.5)
+      activesupport (= 4.2.5)
+      arel (~> 6.0)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    byebug (8.2.0)
+    diff-lcs (1.2.5)
+    edge_rider (0.3.1)
+      activerecord
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    mysql2 (0.3.20)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.2.1)
+  byebug
+  minidusen!
+  mysql2 (~> 0.3.17)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.12.5