mundane-search 0.0.1 → 0.0.2

data/Guardfile

@@ -0,0 +1,11 @@
+# More info at https://github.com/guard/guard#readme
+# guard 'minitest', :seed => "23242" do
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| "spec/#{m[1]}#{m[2]}_spec.rb".sub("spec/mundane-search/", "spec/") }
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$}) do |m|
+    "spec/#{m[1]}#{m[2]}_integration_spec.rb".sub("spec/mundane-search/", "spec/")
+  end
+  watch(%r|^spec/spec_helper\.rb|)   { "spec" }
+  watch("spec/minitest_helper.rb")   { "spec" }
+end

data/README.md

@@ -12,18 +12,53 @@ You know the deal:
 
 ## Usage
 
-Build a search using middleware, then run that search on a specific collection and params.
+Still in the process of figuring this out! But much of it works like I want, so hopefully no brutal changes.
 
-Collections are typically array-like structures (arrays, ActiveRecord or Sunsport scoped collections, etc.)
+### Typical use
+
+Build a search, then run that search on a specific collection and params.
+
+Collections are typically array-like structures (arrays, ActiveRecord or Sunspot scoped collections, etc.)
 
 Params are hash-like structures, such as those interpreted from forms and query strings. They are optional.
 
+Create a search:
+
+    class BookSearch < MundaneSearch::Result
+    end
+
+Add filters to it:
+
+    class BookSearch < MundaneSearch::Result
+      use MundaneSearch::Filters::AttributeMatch, param_key: "title"
+    end
+
+Then use that search in your controllers:
+
+    # params = { "title" => "A Tale of Two Cities" }
+    @result = BookSearch.results_for(Book.scoped, params)
+
+The returned result is enumerable:
+
+    @result.each {|book| ... }
+    @result.first
+
+And has some Rails form compatibility:
+
+    <%= search_form_for(@result) do |f| %>
+      <%= f.input :title %>
+    <% end %>
+
+## Sans sugar
+
+MundaneSearch can be used outside of Rails on whatever sort of object you want:
+
     built = MundaneSearch::Builder.new do
       use MundaneSearch::Filters::ExactMatch, param_key: "fruit"
     end
     built.call %w(apple orange blueberry), { 'fruit' => 'orange' } # ["orange"]
 
-If you check out project, ./script/console will get you a session with everything loaded up.
+If you git checkout the project, ./script/console will get you a session with everything loaded up.
 
 ## Middleware
 
@@ -113,19 +148,36 @@ So yeah, it's fun. Here's a more practical example ... if you have clients that
     end
     built.call %w(Pizza Pasta Antipasto Gumbo), { "food" => "", "noms" => "Gumbo" } # ["Gumbo"]
 
-## ActiveRecord
+### A shortcut for referencing filters
+
+If a filter is defined directly under MundaneSearch::Filters or Object (such as when you just define a class without a namespace), you can reference it with a underscored version of that filter.
+
+The following two "use" designations would use the same filter.
+
+    MundaneSearch::Builder.new do
+      use MundaneSearch::Filters::ExactMatch, param_key: "foo"
+      use :exact_match, param_key: "foo"
+    end
+
+Object is searched first, so a user defined ExactMatch would take precedence over the MundaneSearch::Filters one.
+
+## Supporting multiple collection types
 
 MundaneSearch can work with any collection object that can be passed around and modified. Filters can be designed to work with several types of collection.
 
+When a filter is about to be built, MundaneSearch looks at the base class of the collection being searched and checks to see if there is a subclass with the same name.
+
+In the following example, the ActiveRecord subclass will be used instead of the OnlyManagers class when the collection is an instance of ActiveRecord::Relation.
+
     class OnlyManagers < MundaneSearch::Filters::Base
-      def filtered_collection
-        case collection
-        when ActiveRecord::Relation
+      class ActiveRecord < self
+        def filtered_collection
           collection.where(postion: "manager")
-        else
-          collection.select {|e| e.position == "manager" }
         end
       end
+      def filtered_collection
+        collection.select {|e| e.position == "manager" }
+      end
     end
 
 

data/Rakefile

@@ -38,5 +38,5 @@ end
 
 #Rake::Task['test'].clear
 desc "Run all tests"
-task 'test' => %w[test:unit test:integration]
+task 'test' => %w[test:integration test:unit]
 task 'default' => 'test'

data/bin/coderay

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('mundane-search', 'coderay')

data/bin/erubis

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('erubis', 'erubis')

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/pry

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('mundane-search', 'pry')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/bin/rake

@@ -13,4 +13,4 @@ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
 require 'rubygems'
 require 'bundler/setup'
 
-load Gem.bin_path('rake', 'rake')
+load Gem.bin_path('mundane-search', 'rake')

data/bin/sprockets

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sprockets' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sprockets', 'sprockets')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')

data/bin/tilt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tilt', 'tilt')

data/lib/columns_hash.rb

@@ -0,0 +1,38 @@
+require 'ostruct'
+require 'active_support/concern'
+
+module ColumnsHash
+  extend ActiveSupport::Concern
+  class Attribute < OpenStruct
+    def number?
+      number
+    end
+  end
+
+  def self.generate(options)
+    type = options[:type]
+    attribute = Attribute.new(options)
+    case type
+    when :string
+      attribute.limit = 255
+    when :integer, :float
+      attribute.number =  true
+    end
+    attribute
+  end
+
+  module ClassMethods
+    def columns_hash
+      @columns_hash ||= {}
+    end
+
+    def attribute_column(name, attribute_type)
+      columns_hash[name] = ColumnsHash.generate({name: name, type: attribute_type})
+    end
+  end
+
+  def column_for_attribute(attribute)
+    self.class.columns_hash[attribute]
+  end
+
+end

data/lib/mundane-search.rb

@@ -1,9 +1,17 @@
-require "mundane-search/version"
-require "mundane-search/builder"
-require "mundane-search/filter_canister"
-require "mundane-search/result"
-require "mundane-search/initial_result"
-require "mundane-search/filters"
+require "columns_hash"
+
+require 'mundane-search/railtie' if defined?(Rails)
 
 module MundaneSearch
+  autoload :Version, "mundane-search/version"
+  autoload :Builder, "mundane-search/builder"
+  autoload :FilterCanister, "mundane-search/filter_canister"
+  autoload :Stack, "mundane-search/stack"
+  autoload :Result, "mundane-search/result"
+  autoload :ResultModel, "mundane-search/result_model"
+  autoload :InitialStack, "mundane-search/initial_stack"
+  autoload :Filters, "mundane-search/filters"
+  autoload :Buildable, "mundane-search/buildable"
+  autoload :Railtie, "mundane-search/railtie"
+  autoload :ViewHelpers, "mundane-search/view_helpers"
 end

data/lib/mundane-search/buildable.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+
+module MundaneSearch
+  module Buildable
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        def builder
+          @builder ||= Builder.new
+        end
+      end
+    end
+
+
+    module ClassMethods
+      # Simple delegations to the builder
+      [:use, :result_for, :call, :employ].each do |method|
+        define_method method do |*args, &block|
+          builder.send(method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/mundane-search/builder.rb

@@ -1,25 +1,17 @@
-require_relative './filters'
+require 'active_support/inflector'
 
 module MundaneSearch
   class Builder
-    include MundaneSearch::Filters
+    include MundaneSearch::Filters::Shortcuts
 
     def initialize(&block)
-      @use = []
-
+      @filter_canisters = []
       instance_eval(&block) if block_given?
     end
 
     def use(filter, *args, &block)
-      @use << filter_canister.new(filter, *args, &block)
-    end
-
-    def filter_canister
-      FilterCanister
-    end
-
-    def filters
-      @use
+      filter = convert_filter(filter)
+      @filter_canisters << build_filter_canister.call(filter, *args, &block)
     end
 
     def call(collection, params = {})
@@ -28,14 +20,36 @@ module MundaneSearch
     end
 
     def result_for(collection, params = {})
-      initial_result = InitialResult.new(collection, params)
-      filters.inject(initial_result) do |result, filter|
-        result.add_filter(filter)
+      params ||= {} # tollerate nil
+      initial_stack = InitialStack.new(collection, params)
+      filter_canisters.inject(initial_stack) do |stack, canister|
+        stack.add(canister)
       end
     end
-  end
-end
 
+    attr_reader :filter_canisters
 
+    private
 
+    def build_filter_canister
+      FilterCanister.public_method(:new)
+    end
 
+    def convert_filter(filter)
+      case filter
+      when Class
+        filter
+      when String, Symbol
+        camelized = "#{filter}".camelize
+        [Object, MundaneSearch::Filters].each do |filter_base|
+          if filter_base.const_defined?(camelized)
+            break(filter_base.const_get(camelized))
+          end
+        end
+      else
+        # Warning: May not be a valid filter
+        filter
+      end
+    end
+  end
+end

data/lib/mundane-search/filter_canister.rb

@@ -5,8 +5,32 @@ module MundaneSearch
       @filter, @options = filter, args
     end
 
-    def call(collection, params)
-      filter.new(collection, params, *options).call
+    def build(collection, params)
+      filter_variant(collection).new(collection, params, *options)
     end
+
+    def filter_variant(collection)
+      base = collection.class.to_s.split('::').first.to_sym
+      varient = filter.constants.detect {|c| c == base }
+      varient ? filter.const_get(varient) : filter
+    end
+
+    def param_key
+      single_options[:param_key]
+    end
+
+    def param_key_type
+      single_options[:param_key_type] || param_key_type_from_filter
+    end
+
+    private
+    def single_options
+      options.first || {}
+    end
+
+    def param_key_type_from_filter
+      filter.param_key_type if filter.respond_to?(:param_key_type)
+    end
+
   end
-end
+end