acts_as_explorable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf09cef7bef8fb847eceda7eb6ab0ffe5a3d9d72
+  data.tar.gz: a7b61b25db90271f6787c8e3140ca097500f5445
+SHA512:
+  metadata.gz: 3856e51cda905223c8d4c3d35456d7db75d69573bf810c0d61f911f0432e3069f24ea53c1bb749690d8ad58e4750755d63a46f0c7592fabf258b5f650698d16b
+  data.tar.gz: 8f2fec4eb042b5a9f48aa665cc37c51b3a5e7251c9e9f485de2b415db2bc9c8df0a450dd97c74efaacd03011118bbfdea5e19c6f3d9814cef64d50077e6d0f6f

data/.gitignore

@@ -0,0 +1,16 @@
+*.log
+*.sqlite3
+.bundle
+.ruby-version
+.yarddoc
+pkg/*
+doc/*
+*.gem
+*.lock
+.bundle
+.yardoc
+nbproject/*
+Gemfile.lock
+bin
+spec/*.log
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.0.0
+  - rbx-2
+
+gemfile:
+  - gemfiles/activerecord_4.0.gemfile
+  - gemfiles/activerecord_4.1.gemfile
+  - gemfiles/activerecord_4.2.gemfile
+
+sudo: false
+
+bundler_args: '--without local_development yard --jobs 3 --retry 3'
+
+script: bundle exec rake
+
+matrix:
+  fast_finish: true
+  allow_failures:
+      - gemfile: gemfiles/activerecord_edge.gemfile
+      - rvm: rbx-2

data/Appraisals

@@ -0,0 +1,12 @@
+appraise "activerecord-4.0" do
+  gem "activerecord", github: "rails/rails" , branch: '4-0-stable'
+end
+
+appraise "activerecord-4.1" do
+  gem "activerecord", github: "rails/rails" , branch: '4-1-stable'
+end
+
+appraise "activerecord-4.2" do
+  gem "railties", github: "rails/rails" , branch: '4-2-stable'
+  gem "activerecord", github: "rails/rails"  , branch: '4-2-stable'
+end

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :doc do
+  gem 'yard'
+end
+
+group :local_development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'appraisal'
+  gem 'rake'
+  gem 'byebug', platform: :mri_21
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', cmd: 'bundle exec 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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Mathias Schneider
+
+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,52 @@
+# Acts As Explorable
+
+[![Build Status](https://travis-ci.org/hiasinho/acts_as_explorable.svg?branch=develop)](https://travis-ci.org/hiasinho/acts_as_explorable) [![Code Climate](https://codeclimate.com/github/hiasinho/acts_as_explorable/badges/gpa.svg)](https://codeclimate.com/github/hiasinho/acts_as_explorable) [![Inline docs](http://inch-ci.org/github/hiasinho/acts_as_explorable.svg?branch=develop)](http://inch-ci.org/github/hiasinho/acts_as_explorable)
+
+Acts As Explorable is a Ruby Gem specifically written for ActiveRecord models.
+
+## Installation
+
+### Supported Ruby and Rails versions
+
+* Ruby 2.0.0, 2.1.0
+* Rails 4.0, 4.1, 4.2+
+
+### Install
+
+THIS GEM IS NOT RELEASED YET. SO, THIS WON'T WORK!
+
+Just add the following to your Gemfile.
+
+```ruby
+gem 'acts_as_explorable', '~> 0.0.1'
+```
+
+And follow that up with a ``bundle install``.
+
+## Usage
+
+TODO
+
+## Testing
+
+All tests follow the RSpec format and are located in the spec directory.
+They can be run with:
+
+```
+rake spec
+```
+
+## License
+
+Acts as explorable is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+## TODO
+
+### v0.1
+- Fill this README file
+- Release v0.0.1 to rubygems
+
+###v0.x
+- Add tests for postgres and mysql
+- Query string validation helper for use in forms
+- Use methods in addition to fields

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+
+desc 'Default: run specs.'
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.options << '--output-dir' << './doc'
+  t.options << '--no-private'
+  t.options << '--protected'
+  t.options << '--readme' << 'README.md'
+  t.options << '--hide-tag' << 'return'
+  t.options << '--hide-tag' << 'param'
+end
+
+Bundler::GemHelper.install_tasks

data/acts_as_explorable.gemspec

@@ -0,0 +1,28 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'acts_as_explorable/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'acts_as_explorable'
+  s.version     = ActsAsExplorable::VERSION
+  s.authors     = ['Mathias Schneider']
+  s.email       = ['mathias@hiasinho.com']
+  s.homepage    = 'https://github.com/hiasinho/acts_as_explorable'
+  s.summary     = 'Adds GitHub-like search function to your models'
+  s.description = 'Adds GitHub-like search function to your models'
+  s.license     = 'MIT'
+
+  s.files                 = `git ls-files`.split("\n")
+  s.test_files            = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths         = ['lib']
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_runtime_dependency 'activerecord',  ['>= 4.0', '< 5']
+
+  s.add_development_dependency 'sqlite3'
+
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'factory_girl_rails', '~> 4.0'
+  s.add_development_dependency 'database_cleaner'
+end

data/gemfiles/activerecord_4.0.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", :github => "rails/rails", :branch => "4-0-stable"
+
+group :doc do
+  gem "yard"
+end
+
+group :local_development do
+  gem "guard"
+  gem "guard-rspec"
+  gem "appraisal"
+  gem "rake"
+  gem "byebug", :platform => :mri_21
+end
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.1.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", :github => "rails/rails", :branch => "4-1-stable"
+
+group :doc do
+  gem "yard"
+end
+
+group :local_development do
+  gem "guard"
+  gem "guard-rspec"
+  gem "appraisal"
+  gem "rake"
+  gem "byebug", :platform => :mri_21
+end
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.2.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "railties", :github => "rails/rails", :branch => "4-2-stable"
+gem "activerecord", :github => "rails/rails", :branch => "4-2-stable"
+
+group :doc do
+  gem "yard"
+end
+
+group :local_development do
+  gem "guard"
+  gem "guard-rspec"
+  gem "appraisal"
+  gem "rake"
+  gem "byebug", :platform => :mri_21
+end
+
+gemspec :path => "../"

data/lib/acts_as_explorable/configuration.rb

@@ -0,0 +1,9 @@
+module ActsAsExplorable
+  class Configuration
+    attr_accessor :filters
+
+    def initialize
+      @filters = {}
+    end
+  end
+end

data/lib/acts_as_explorable/element/base.rb

@@ -0,0 +1,8 @@
+module ActsAsExplorable::Element
+  #
+  # Base class for {ActsAsExplorable::Element Elements}.
+  #
+  class Base
+    include ActsAsExplorable::Element
+  end
+end

data/lib/acts_as_explorable/element/dynamic_filter.rb

@@ -0,0 +1,15 @@
+module ActsAsExplorable::Element
+  #
+  # Generates a +where+ clause to look up the searched string in the given columns
+  #
+  class DynamicFilter < Base
+    def after_init
+      @query_type = :where
+    end
+
+    def render
+      @query_parts << table[type].lower.in(@parameters)
+      @full_query = @query_parts.first
+    end
+  end
+end

data/lib/acts_as_explorable/element/in.rb

@@ -0,0 +1,18 @@
+module ActsAsExplorable::Element
+  #
+  # Generates a +where+ clause to look up the searched string in the given columns
+  #
+  class In < Base
+    def after_init
+      @query_type = :where
+    end
+
+    def render
+      @parameters.each do |f|
+        @query_parts <<
+          table[f.to_sym].matches_any(@query_string.map { |q| "%#{q}%" })
+      end
+      @full_query = @query_parts.inject(:or)
+    end
+  end
+end

data/lib/acts_as_explorable/element/sort.rb

@@ -0,0 +1,20 @@
+module ActsAsExplorable::Element
+  #
+  # Generates an +order+ query part to sort by the given columns
+  #
+  class Sort < Base
+    def after_init
+      @query_type = :reorder
+    end
+
+    def render
+      @full_query = @parameters.map do |f|
+        if f =~ /(-asc|-desc)/
+          { f.split('-').first.to_sym => f.split('-').last.to_sym }
+        else
+          { f.to_sym => :desc }
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_explorable/element.rb

@@ -0,0 +1,83 @@
+require 'acts_as_explorable/element/base'
+require 'acts_as_explorable/element/in'
+require 'acts_as_explorable/element/sort'
+require 'acts_as_explorable/element/dynamic_filter'
+
+module ActsAsExplorable
+  module Element
+    attr_accessor :query_type, :model, :parameters, :query_string, :query_parts,
+                  :full_query
+
+    #
+    # This method acts as a factory to build a concrete element
+    #
+    # @example
+    #   ActsAsExplorable::Element.build(:in, 'Zlatan in:first_name', Player)
+    #
+    # @param type [Symbol] The element type to be build
+    # @param query [String] The query string
+    # @param model [ActiveRecord::Base] Anactive record model
+    #
+    # @return [ActsAsExplorable::Element] A concrete element type
+    def self.build(type, query, model)
+      klass = Module.nesting.last.const_get('Element').const_get(type.to_s.camelize)
+      instance = klass.new(query, model, type)
+      rescue NameError
+        DynamicFilter.new(query, model, type)
+    end
+
+    def initialize(query, model, element_type = nil)
+      query = query.to_acts_as_explorable(ActsAsExplorable.filters.keys)
+
+      @type = element_type if element_type
+      @model = model
+      @query_string = query[:values]
+      @query_parts = []
+      filter_parameters(query[:params])
+      after_init
+
+      render if @parameters.present?
+    end
+
+    def after_init; end
+
+    def execute(query_object)
+      query_object.send(@query_type, @full_query)
+    end
+
+    protected
+
+    def filter_parameters(params)
+      return unless params[type]
+      @parameters = params[type].select do |f|
+        filters.find do |e|
+          /#{e.to_sym}(?:-\w+)?/ =~ f
+        end
+      end
+    end
+
+    #
+    # Returns the Arel table for the current model
+    #
+    # @return [Arel::Table] Arel table for the current model
+    def table
+      @model.arel_table
+    end
+
+    def render
+      fail "`#render` needs to be implemented for #{self.class.name}"
+    end
+
+    def type
+      @type.to_sym || self.class.name.demodulize.underscore.to_sym
+    end
+
+    #
+    # Returns the customized filters
+    #
+    # @return [Hash] The customized filters
+    def filters
+      ActsAsExplorable.filters[type]
+    end
+  end
+end

data/lib/acts_as_explorable/explorable.rb

@@ -0,0 +1,76 @@
+module ActsAsExplorable
+  module Explorable
+    def self.extended(base)
+      base.class_eval do
+        def self.explorable?
+          false
+        end
+      end
+    end
+
+    # Configure ActsAsExplorable's behavior in a model.
+    #
+    # The plugin can be customized using parameters or through a `block`.
+    #
+    #     class Player < ActiveRecord::Base
+    #       extend ActsAsExplorable
+    #       explorable in: [:first_name, :last_name, :position, :city, :club],
+    #                  sort: [:first_name, :last_name, :position, :city, :club, :created_at],
+    #                  position: ['GK', 'MF', 'FW']
+    #     end
+    #
+    # Using a block (TODO: This will be available in future versions):
+    #
+    #     class Player < ActiveRecord::Base
+    #       extend ActsAsExplorable
+    #       explorable do |config|
+    #         config.filters = {
+    #           in: [:first_name, :last_name, :position, :city, :club],
+    #           sort: [:first_name, :last_name, :position, :city, :club, :created_at],
+    #           position: ['GK', 'MF', 'FW']
+    #         }
+    #       end
+    #     end
+    #
+    # @yield Provides access to the model class's config, which
+    #   allows to customize types and filters
+    #
+    # @yieldparam config The model class's {ActsAsExplorable::Configuration config}.
+    def explorable(filters = {}, &_block)
+      class_eval do
+        def self.explorable?
+          true
+        end
+      end
+
+      if block_given?
+        ActsAsExplorable.setup { |config| yield config }
+      else
+        explorable_set_filters filters
+      end
+    end
+
+    protected
+
+    # Configure ActsAsExplorable's permitted filters per type in a model.
+    #
+    #     class Person < ActiveRecord::Base
+    #       extend ActsAsExplorable
+    #       explorable_filters in: [:first_name, :last_name, :city],
+    #                          sort: [:first_name, :last_name, :city, :created_at]
+    #     end
+    #
+    # @param [Hash] filters Filters for types
+    # @return [Array] Permitted filters
+    #
+    def explorable_set_filters(filters = {})
+      ActsAsExplorable.filters = filters if filters.present?
+
+      ActsAsExplorable.filters.each_pair do |f, _a|
+        ActsAsExplorable.filters[f].map!(&:downcase)
+      end
+
+      ActsAsExplorable.filters
+    end
+  end
+end

data/lib/acts_as_explorable/ext/string.rb

@@ -0,0 +1,24 @@
+#
+# A String extension for ActsAsExplorable
+#
+class String
+  # Converts the String into a Hash for ActsAsExplorable.
+  #
+  # == Returns:
+  # A Hash providing 2 keys:
+  # - <tt>:values</tt> holds the search text values
+  # - <tt>:params</tt> holds parameters (fields) to search in
+  #
+  # @example
+  #   query = "Foo Bar in:name,body sort:created_at-asc"
+  #   query.to_acts_as_explorable
+  #   # => {:values=>["Foo", "Bar"], :params=>{:in=>["name", "body"], :sort=>["created_at-asc"]}}
+  #
+  # @param keys [Array<String, Symbol>, nil] Array of accepted keys
+  #
+  # @return [Hash] Converted query
+  def to_acts_as_explorable(*keys)
+    return nil if self.blank?
+    ActsAsExplorable::Parser.transform(self, *keys)
+  end
+end

data/lib/acts_as_explorable/parser.rb

@@ -0,0 +1,61 @@
+module ActsAsExplorable
+  ##
+  # Transforms query strings to a Hash that can be used by ActsAsExplorable.
+  #
+  # @example
+  #   ActsAsExplorable::Parser.transform('Zlatan in:first_name')
+  #   => { values: ["Zlatan"], params: { in: ["first_name"] } }
+  class Parser
+    attr_reader :values, :params, :props
+
+    #
+    # Returns a transformed query Hash using the given query string
+    # @param query_string [String] A query string
+    # @param keys [Array] An Array of transformation rules
+    #
+    # @return [Hash] Transformed query
+    def self.transform(query_string, *keys)
+      instance = new(query_string)
+      instance.parse(*keys)
+    end
+
+    def initialize(query_string)
+      @query_string = query_string
+      split_query_string
+    end
+
+    #
+    # Parses the query string
+    # @param keys [Hash] An Array of transformation rules
+    #
+    # @return [Hash] Transformed query
+    def parse(*keys)
+      split_query_string
+
+      @props.each do |p|
+        key, params = p.split(':').first.to_sym, p.split(':').last.split(',')
+        next if !keys.flatten.include?(key) && !keys.empty?
+        @params[key] ||= []
+        @params[key] = @params[key] | params.map(&:downcase)
+      end
+
+      { values: @values, params: @params }
+    end
+
+    private
+
+    def split_query_string
+      @values = []
+      @params = {}
+      @props  = []
+
+      @query_string.split(/\s+/).each do |q|
+        if q =~ /\w+:[\w,-]+/
+          @props << q
+        else
+          @values << q
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_explorable/query.rb

@@ -0,0 +1,36 @@
+module ActsAsExplorable
+  #
+  # Adds the search scope to a model
+  #
+  module Query
+    #
+    # Initiates a search with the given query string and returns an
+    # <tt>ActiveRecord::Relation</tt> scope object.
+    #
+    # The query string's *syntax* is described in {file:docs/yard/README.md#syntax the Readme File}
+    #
+    # The search method can be used just like a scope.
+    #
+    #   Foo.search("Foo Bar in:name,body sort:created_at-asc").to_sql
+    #   # => "SELECT foo.* FROM foo WHERE (foo.body ILIKE '%Foo%' OR foo.body ILIKE '%Bar%') ORDER BY foo.created_at ASC"
+    #
+    # It is also possible to put it in a scope chain like this:
+    #
+    #   Foo.published.search("Foo Bar in:name,body sort:created_at-asc")
+    #
+    # @param [String] query_string A query string
+    # @return [ActiveRecord::Relation] Returns an <tt>ActiveRecord::Relation</tt> scope object
+    #
+    def search(query_string)
+      parts = ActsAsExplorable.filters.keys.map { |t| Element.build(t, query_string, self) }
+
+      result = all
+
+      parts.compact.each do |part|
+        result = part.execute(result)
+      end
+
+      result
+    end
+  end
+end

data/lib/acts_as_explorable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsExplorable
+  VERSION = '0.1.0'
+end

data/lib/acts_as_explorable.rb

@@ -0,0 +1,45 @@
+require 'active_record'
+require 'active_support/inflector'
+require 'acts_as_explorable/version'
+require 'acts_as_explorable/configuration'
+require 'acts_as_explorable/parser'
+require 'acts_as_explorable/ext/string'
+require 'acts_as_explorable/element'
+require 'acts_as_explorable/explorable'
+require 'acts_as_explorable/query'
+
+#
+# ActsAsExplorable Plugin
+#
+# @author hiasinho
+#
+module ActsAsExplorable
+  def self.extended(base)
+    base.extend Query
+  end
+
+  def self.method_missing(method_name, *args, &block)
+    if @configuration.respond_to?(method_name)
+      @configuration.send(method_name, *args, &block)
+    else
+      super
+    end
+  end
+
+  def self.respond_to?(method_name, _include_private = false)
+    @configuration.respond_to? method_name
+  end
+
+  protected
+
+  def self.setup
+    @configuration ||= Configuration.new
+    yield @configuration if block_given?
+  end
+
+  setup
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend ActsAsExplorable::Explorable
+end

data/lib/tasks/acts_as_explorable_tasks.rake

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

data/spec/factories/players.rb

@@ -0,0 +1,57 @@
+FactoryGirl.define do
+  factory :player, aliases: [:zlatan, :god_of_football] do
+    first_name 'Zlatan'
+    last_name 'Ibrahimovic'
+    position 'FW'
+    city 'Paris'
+    club 'PSG'
+
+    factory :manuel, aliases: [:goalkeeper] do
+      first_name 'Manuel'
+      last_name 'Neuer'
+      position 'GK'
+      city 'München'
+      club 'FC Bayern München'
+    end
+
+    factory :bastian, aliases: [:schweini] do
+      first_name 'Bastian'
+      last_name 'Schweinsteiger'
+      position 'MF'
+      city 'München'
+      club 'FC Bayern München'
+    end
+
+    factory :sascha do
+      first_name 'Sascha'
+      last_name 'Mölders'
+      position 'FW'
+      city 'Augsburg'
+      club 'FC Augsburg'
+    end
+
+    factory :christiano, aliases: [:forward] do
+      first_name 'Christiano'
+      last_name 'Ronaldo'
+      position 'FW'
+      city 'Madrid'
+      club 'Real Madrid'
+    end
+
+    factory :toni do
+      first_name 'Toni'
+      last_name 'Kroos'
+      position 'MF'
+      city 'Madrid'
+      club 'Real Madrid'
+    end
+
+    factory :fernando do
+      first_name 'Fernando'
+      last_name 'Torres'
+      position 'FW'
+      city 'Madrid'
+      club 'Athletico Madrid'
+    end
+  end
+end

data/spec/lib/acts_as_explorable/element/dynamic_filter_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ActsAsExplorable::Element::DynamicFilter do
+
+  subject { ActsAsExplorable::Element::DynamicFilter }
+  let (:element) { ActsAsExplorable::Element }
+
+  it 'should return a dynamic filter element' do
+    expect(element.build(:position, 'position:gk,mf,fw', Player)).to be_instance_of(subject)
+  end
+
+  it 'should filter by position' do
+    create(:goalkeeper)
+    create(:forward)
+
+    expect(Player.search('position:gk').count).to eq(1)
+  end
+
+end

data/spec/lib/acts_as_explorable/element/in.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe ActsAsExplorable::Element::In do
+
+  subject { ActsAsExplorable::Element::In }
+  let (:element) { ActsAsExplorable::Element }
+
+  it 'should return a dynamic filter element' do
+    expect(element.build(:in, 'test in:first_name', Player)).to be_instance_of(subject)
+  end
+
+end

data/spec/lib/acts_as_explorable/element_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe ActsAsExplorable::Element do
+
+  subject { ActsAsExplorable::Element }
+
+  describe '.build' do
+    it 'should be callable' do
+      expect(subject).to respond_to(:build)
+    end
+
+    it 'should create an element' do
+      expect(ActsAsExplorable::Element.build(:position, 'position:gk', Player)).to be_instance_of(ActsAsExplorable::Element::DynamicFilter)
+    end
+  end
+end

data/spec/lib/acts_as_explorable/explorable_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+def create_player(klass = Player, factory: :player)
+  klass.create(attributes_for(factory))
+end
+
+describe ActsAsExplorable::Explorable do
+
+  let(:zlatan) { create(:zlatan) }
+  let(:manuel) { create(:manuel) }
+  let(:bastian) { create(:bastian) }
+  let(:christiano) { create(:christiano) }
+  let(:toni) { create(:toni) }
+  let(:fernando) { create(:fernando) }
+
+  it 'should not be explorable' do
+    expect(NotExplorable).not_to be_explorable
+  end
+
+  it 'should be explorable' do
+    expect(Explorable).to be_explorable
+  end
+
+  it 'should be customizable through a block' do
+    skip 'TODO: This will be available in future versions'
+  end
+
+end

data/spec/lib/acts_as_explorable/parser_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe ActsAsExplorable::Parser do
+
+  subject { ActsAsExplorable::Parser }
+
+  describe '#new' do
+    it 'should be called with a query string' do
+      expect { subject.new }.to raise_error
+    end
+  end
+
+  describe '.transform' do
+    it 'should respond with a hash' do
+      expect(subject.transform('Zlatan in:first_name')).to be_a(Hash)
+    end
+
+    it 'should have a result with :values and :params keys' do
+      expect(subject.transform('Zlatan in:first_name'))
+        .to  have_key(:values)
+        .and have_key(:params)
+    end
+
+    it 'should not have a result with a key :props' do
+      expect(subject.transform('Zlatan in:first_name'))
+        .not_to have_key(:props)
+    end
+
+    it 'should transform the string to a hash' do
+      expect(subject.transform('Zlatan in:first_name'))
+        .to eq(values: ['Zlatan'], params: { in: ['first_name'] })
+    end
+  end
+
+end

data/spec/lib/acts_as_explorable/query_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe ActsAsExplorable::Query do
+
+  let(:zlatan) { create(:zlatan) }
+  let(:manuel) { create(:manuel) }
+  let(:bastian) { create(:bastian) }
+  let(:christiano) { create(:christiano) }
+  let(:toni) { create(:toni) }
+  let(:fernando) { create(:fernando) }
+
+  context 'in:' do
+    it '`first_name` should find by first name' do
+      [zlatan, christiano]
+      expect(Player.search('Zlatan in:first_name').count).to eq(1)
+    end
+
+    it '`club` should find by club' do
+      [zlatan, manuel, bastian]
+      expect(Player.search('Bayern in:club').count).to eq(2)
+    end
+
+    it '`city` should find by city' do
+      [zlatan, bastian, christiano, toni, fernando]
+      expect(Player.search('Madrid in:city').count).to eq(3)
+    end
+  end
+
+  context 'sort:' do
+    before(:each) do
+      [christiano, zlatan, bastian]
+    end
+
+    it '`first_name` should order descending by first name' do
+      expect(Player.search('sort:first_name').first).to eq(zlatan)
+    end
+
+    it '`first_name-desc` should order descending by first name' do
+      expect(Player.search('sort:first_name-desc').first).to eq(zlatan)
+    end
+
+    it '`first_name-asc` should order ascending by first name' do
+      expect(Player.search('sort:first_name-asc').last).to eq(zlatan)
+    end
+
+    it '`position-desc,first_name-asc` should order by position then by first name' do
+      expect(Player.search('sort:position-desc,first_name-asc').first).to eq(bastian)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+begin
+  require 'byebug'
+rescue LoadError
+end
+$LOAD_PATH << '.' unless $LOAD_PATH.include?('.')
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'logger'
+
+require File.expand_path('../../lib/acts_as_explorable', __FILE__)
+I18n.enforce_available_locales = true
+require 'rails'
+require 'rspec/its'
+require 'sqlite3'
+require 'factory_girl'
+require 'database_cleaner'
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+  config.raise_errors_for_deprecations!
+end
+
+FactoryGirl.find_definitions

data/spec/support/database.rb

@@ -0,0 +1,64 @@
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), '../debug.log'))
+ActiveRecord::Base.logger.level = ENV['TRAVIS'] ? ::Logger::ERROR : ::Logger::DEBUG
+
+ActiveRecord::Schema.define(version: 1) do
+  create_table :players do |t|
+    t.string :first_name
+    t.string :last_name
+    t.string :position, limit: 2
+    t.string :city
+    t.string :club
+
+    t.timestamps null: false
+  end
+end
+
+class ActsAsExplorable::TestModelBase < ActiveRecord::Base
+  self.table_name = :players
+end
+
+class Player < ActsAsExplorable::TestModelBase
+  extend ActsAsExplorable
+  explorable in: [:first_name, :last_name, :position, :city, :club],
+             sort: [:first_name, :last_name, :position, :city, :club, :created_at],
+             position: %w(GK MF FW)
+end
+
+class ArgumentsPlayer < ActsAsExplorable::TestModelBase
+  extend ActsAsExplorable
+  explorable in: [:first_name, :last_name, :position, :city, :club],
+             sort: [:first_name, :last_name, :position, :city, :club, :created_at],
+             position: %w(GK MF FW)
+end
+
+class BlockPlayer < ActsAsExplorable::TestModelBase
+  extend ActsAsExplorable
+  explorable do |config|
+    config.filters = {
+      in: [:first_name, :last_name, :position, :city, :club],
+      sort: [:first_name, :last_name, :position, :city, :club, :created_at],
+      position: %w(GK MF FW)
+    }
+  end
+end
+
+class BlockPlayer < ActsAsExplorable::TestModelBase
+  extend ActsAsExplorable
+  explorable in: [:first_name, :last_name, :position, :city, :club],
+             sort: [:first_name, :last_name, :position, :city, :club, :created_at],
+             position: %w(GK MF FW)
+
+  explorable do |_config|
+
+  end
+end
+
+class Explorable < ActsAsExplorable::TestModelBase
+  extend ActsAsExplorable
+  explorable
+end
+
+class NotExplorable < ActsAsExplorable::TestModelBase
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean
+  end
+
+  config.after(:suite) do
+    DatabaseCleaner.clean
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_explorable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mathias Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-17 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !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-rails
+  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-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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 GitHub-like search function to your models
+email:
+- mathias@hiasinho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- acts_as_explorable.gemspec
+- gemfiles/activerecord_4.0.gemfile
+- gemfiles/activerecord_4.1.gemfile
+- gemfiles/activerecord_4.2.gemfile
+- lib/acts_as_explorable.rb
+- lib/acts_as_explorable/configuration.rb
+- lib/acts_as_explorable/element.rb
+- lib/acts_as_explorable/element/base.rb
+- lib/acts_as_explorable/element/dynamic_filter.rb
+- lib/acts_as_explorable/element/in.rb
+- lib/acts_as_explorable/element/sort.rb
+- lib/acts_as_explorable/explorable.rb
+- lib/acts_as_explorable/ext/string.rb
+- lib/acts_as_explorable/parser.rb
+- lib/acts_as_explorable/query.rb
+- lib/acts_as_explorable/version.rb
+- lib/tasks/acts_as_explorable_tasks.rake
+- spec/factories/players.rb
+- spec/lib/acts_as_explorable/element/dynamic_filter_spec.rb
+- spec/lib/acts_as_explorable/element/in.rb
+- spec/lib/acts_as_explorable/element_spec.rb
+- spec/lib/acts_as_explorable/explorable_spec.rb
+- spec/lib/acts_as_explorable/parser_spec.rb
+- spec/lib/acts_as_explorable/query_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+- spec/support/database_cleaner.rb
+homepage: https://github.com/hiasinho/acts_as_explorable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds GitHub-like search function to your models
+test_files: []
+has_rdoc: