ransack_abbreviator 0.0.4 → 0.0.6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
 ## v0.0.1
 
-* initial release
+* initial release
+
+## v0.0.2-0.0.5
+
+* Don't use
+
+## v0.0.6
+
+* First stable release

data/README.md

@@ -1,7 +1,62 @@
 ## Ransack Abbreviator [![Build Status](https://travis-ci.org/jhdavids8/ransack-abbreviator.png?branch=master)](http://travis-ci.org/jhdavids8/ransack-abbreviator)
 ===================
 
+[Ransack](https://github.com/ernie/ransack) is a gem that gives you the ability to create powerful search forms. Unfortunately though, the more fields you add to your form, the longer the URL gets, which usually forces you to use the HTTP POST method instead of GET, which can get annoying pretty quickly. 
 
-## To Do
+Ransack Abbreviator uses defined abbreviations for columns and associations to shorten your query params and thus the URL generated by your search form. Hopefully, it allows you to avoid that POST.
+
+### Getting Started
+In your Gemfile:
+
+```ruby
+gem 'ransack_abbreviator'
+```
+
+### How to Use
+The abbreviator should cause absolutely no problems if you decide to not use abbreviations. It only kicks in when an abbreviation is detected in the params. That said, here's how to use it:
+
+#### Define Abbreviations
+First, define some abbreviations for columns and associations that can be queried in your search form. You can create a ransack_abbreviator.yml file in your config directory in a structure like this:
+
+    ransack_abbreviations:
+      columns:
+        name: "nm"
+        title: "tl"
+      associations:
+        articles: "ars"
+        people: "ppl"
+
+If you don't want to use a YAML file, define an initializer and add your abbreviations there.
+```ruby
+RansackAbbreviator.configure do |config|
+  config.add_column_abbreviation(:name, :nm)
+  config.add_column_abbreviation(:title, :tl)
+  config.add_assoc_abbreviation(:articles, :ars)
+  config.add_assoc_abbreviation(:people, :ppl)
+end
+```
+#### Use the Abbreviated Attribute in your Form
+In your form, pass the Ransack language you would normally use (along with the search object) to a helper called ransack_abbreviation_for:
+
+    <%= search_form_for @q do |f| %>
+      <%= f.text_field ransack_abbreviation_for(@q, :name_cont) %>
+      <%= f.text_field ransack_abbreviation_for(@q, :articles_title_start) %>
+      <%= f.submit %>
+    <% end %>
+
+When the above form is submitted, what would have normally been a URL param of 'name_cont' is now 'nm_cont'. 'articles_title_start' is now 'ars.tl_start'.
+
+See the [Ransack](https://github.com/ernie/ransack) documentation on how to reference associations, columns, and predicates.
+
+#### Remove those POST hacks!
+Hopefully, the URL is now at least half the size it could have been before and you can remove all the POST hacks you did to get pagination and whatnot to work correctly!
+
+### Some Notes
+* ransack_abbreviation_for abbreviates what it can, and returns the full name for what it cannot. For example, if you forgot to abbreviate 'articles', then ransack_abbreviation_for(@q, :articles_title_start) would return 'articles.tl_start'
+
+### To Do
 * Support abbreviation of 'ransacker' attributes
-* Extend the 'attribute_select' form helper to support returning attributes as their abbreviations
+* Extend the 'attribute_select' form helper to support returning attributes as their abbreviations
+
+### License and Copyright
+MIT License. Copyright &copy; 2013 [Jamie Davidson](http://jamie-davidson.com)

data/lib/ransack_abbreviator/configuration.rb

@@ -15,7 +15,7 @@ module RansackAbbreviator
           fail "You used a reserved keyword as a column abbreviation. Reserverd keywords: #{RansackAbbreviator::Constants::RESERVED_KEYWORDS.join(", ")}"
         end
         
-        self.column_abbreviations = abbreviations
+        @@column_abbreviations = abbreviations
       end
     end
     
@@ -25,7 +25,7 @@ module RansackAbbreviator
           fail "You used a reserved keyword as an association abbreviation. Reserverd keywords: #{RansackAbbreviator::Constants::RESERVED_KEYWORDS.join(", ")}"
         end
         
-        self.assoc_abbreviations = abbreviations
+        @@assoc_abbreviations = abbreviations
       end
     end
     
@@ -58,7 +58,7 @@ module RansackAbbreviator
     end
     
     def config_dir
-      defined?(Rails) ? Rails.root.join("config") : Pathname.new("config")
+      Pathname.new("config")
     end
   end
 end

data/lib/ransack_abbreviator/engine.rb

@@ -0,0 +1,4 @@
+module RansackAbbreviator
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/ransack_abbreviator/version.rb

@@ -1,3 +1,3 @@
 module RansackAbbreviator
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/ransack_abbreviator.rb

@@ -1,7 +1,10 @@
 require "ostruct"
 require "yaml"
+require 'ransack'
 require 'ransack_abbreviator/configuration'
 require 'ransack_abbreviator/constants'
+require 'ransack_abbreviator/engine' if defined? Rails
+
 
 module RansackAbbreviator
   extend Configuration

metadata

@@ -2,7 +2,7 @@
 name: ransack_abbreviator
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors: 
 - Jamie Davidson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-04 00:00:00 Z
+date: 2013-02-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ransack
@@ -102,6 +102,7 @@ files:
 - lib/ransack_abbreviator/adapters/active_record/base.rb
 - lib/ransack_abbreviator/configuration.rb
 - lib/ransack_abbreviator/constants.rb
+- lib/ransack_abbreviator/engine.rb
 - lib/ransack_abbreviator/ransack_extensions/context.rb
 - lib/ransack_abbreviator/ransack_extensions/nodes/condition.rb
 - lib/ransack_abbreviator/ransack_extensions/search.rb