facet_for 0.0.8 → 0.1.0

data/README.md

@@ -0,0 +1,58 @@
+# facet_for
+
+facet_for is a collection of FormBuilder helpers that speed up the process of creating complex search forms with [Ransack](http://github.com/ernie/ransack).
+
+For many searches, it can be as simple as:
+
+```ruby
+<%= f.facet_for(:field_name) -%>
+```
+
+facet_for will use the database column type to choose an appropriate Ransack predicate, then create both the label and field. It will also work for ```has_many``` and ```belongs_to``` associations.
+
+## Installation
+
+Add ```gem 'facet_for'``` in your Gemfile
+
+## Options
+
+Many options in facet_for can be overridden by passing hash options.
+
+### Predicates
+
+To choose an alternate predicate, pass ```:type => :predicate```.
+
+Most of the Ransack predicates are supported:
+
+* Contains - ```:type => :cont```
+* Doesn't Contain - ```:type => :not_cont```
+* Starts With - ```:type => :start```
+* Doesn't Start With - ```:type => :not_start```
+* Ends With - ```:type => :end```
+* Doesn't End With - ```:type => :not_end```
+* Is Null - ```:type => :null```
+* Is Not Null - ```:type => :not_null```
+* True - ```:type => :true```
+* False - ```:type => :false```
+* Greater Than or Equal - ```:type => :gte```
+* Less Than or Equal - ```:type => :lte```
+
+As well as several special cases and meta-predicates specific to facet_for:
+
+#### Collections
+
+* Collection - ```:type => :collection```
+
+By default, when passing a ```has_many``` or ```belongs_to``` association into facet_for, it will choose the ```:collection``` predicate. This produces a ```collection_select``` with the unique options for that association.
+
+When using ```:type => :collection``` on a column in the database, rather than an association, it defaults to all unique options.
+
+To pass specific options, use ```:collection => []``` to pass an array of options. This may either be a flat array of strings (eg ```['Blue', 'Red', 'Green']), a flat array of objects (```SomeModel.all```), or a nested array of name and value pairs.
+
+* Contains Any - ```:type => :cont_any```
+
+```:type => :cont_any``` behaves in a nearly identical manner to ```:type => :collection```, except that the collection is rendered as a series of check boxes rather than a ```collection_select```.
+
+### Custom Labels
+
+By default, facet_for will determine label text based on a combination of the field name and the predicate. This can be overwritten by specifying ```:label => 'Your Label Here'```.

data/lib/facet_for/version.rb

@@ -1,3 +1,3 @@
 module FacetFor
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/lib/facet_for.rb

@@ -37,7 +37,8 @@ module FacetFor
 
     q.context.searchable_associations.each do |association|
       association_model = association.camelcase.singularize.constantize
-      column_options.push([association_model.to_s, options_for_model(association_model, association)])
+      column_options.push([association_model.to_s,
+                           options_for_model(association_model, association)])
     end
 
     column_options
@@ -96,13 +97,13 @@ module FacetFor
           x.primary_key_name == @facet[:column_name].to_s }.uniq and association.count > 0
 
           if association.first.macro == :has_many
-
             # For a has_many relationship, we want the plural name with _id.
             # Ransack will then look at the _id column for the associated model.
             # This won't work properly on models with nonstandard id column
             # names. That's a problem, but whatevs for the time being.
             @facet[:association_name] = "#{association.first.plural_name}"
             @facet[:column_name] = "#{association.first.plural_name}_id"
+            @facet[:clean_column_name] = "#{association.first.name.to_s.singularize}_id"
 
           elsif association.first.macro == :belongs_to
 
@@ -121,11 +122,11 @@ module FacetFor
           @facet[:type] = @facet[:type] || :collection
 
           # If the user hasn't specified a collection, we'll provide one now
-          # based on this association
+          # based on this association. We only want to use distinct values.
+          # This could probably be cleaner, but it works.
 
-          @facet[:collection] = @facet[:model].joins(@facet[:association_name].to_sym).select("DISTINCT #{@facet[:column_name]}").where("#{@facet[:column_name]} IS NOT NULL").map { |m| m.send(@facet[:association_name].to_sym) }
+          @facet[:collection] = @facet[:model].unscoped.joins(@facet[:association_name].to_sym).select("DISTINCT #{clean_column}").where("#{clean_column} IS NOT NULL").map { |m| @facet[:association_name].to_s.singularize.camelcase.constantize.find(m.send(clean_column))  }
 
-#          @facet[:collection] = @facet[:collection] || association.first.klass.all
         end
       else
 
@@ -349,8 +350,12 @@ module FacetFor
 
     end
 
+    def clean_column
+      @facet[:clean_column_name] || @facet[:column_name]
+    end
+
     def unique_value_collection
-      @facet[:collection] = @facet[:model].select("DISTINCT #{@facet[:column_name]}").where("#{@facet[:column_name]} IS NOT NULL").map { |m| m.send(@facet[:column_name]) }
+      @facet[:collection] = @facet[:model].unscoped.select("DISTINCT #{clean_column}").where("#{clean_column} IS NOT NULL").map { |m| m.send(@facet[:column_name]) }
     end
 
     def label(string_name, string_label = nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: facet_for
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-06 00:00:00.000000000Z
+date: 2012-01-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ransack
-  requirement: &78616160 !ruby/object:Gem::Requirement
+  requirement: &84788010 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *78616160
+  version_requirements: *84788010
 description: Provides helpers for creating search forms with Ransack
 email:
 - jbarket@sleepunit.com
@@ -31,7 +31,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README.textile
+- README.md
 - Rakefile
 - facet_for.gemspec
 - lib/facet_for.rb
@@ -52,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -507125603
+      hash: 432141005
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -507125603
+      hash: 432141005
 requirements: []
 rubyforge_project: facet_for
 rubygems_version: 1.8.10

data/README.textile

@@ -1,8 +0,0 @@
-h1. facet_for
-
-facet_for is a collection of FormBuilder helpers that speed up the process of
-creating complex search forms with "Ransack":http://github.com/ernie/ransack
-
-h2. Installation
-
-Simply include 'facet_for' in your Gemfile