filterrific 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1,10 +1,23 @@
-## 1.1.0
+## 1.2.0
+
+* Added simple wrapper for Filterrific::ParamSet.new so that it can be 
+  instantiated with Filterrific.new instead of Filterrific::ParamSet.new.
+* Overrode ActionView's form_for to add filterrific magic when applied to a 
+  Filterrific object.
+* Fixed bug with javascript periodic observer, changed css selector class to
+  avoid conflicts.
+* Moved observe_form_field jquery plugin into filterrific namespace to avoid
+  conflicts.
+
+
 
-* major refactor
-* added specs
-* tied in Rails asset pipeline
-* added gh-pages branch for documentation
 
+## 1.1.0
+
+* Major refactor
+* Added specs
+* Tied in Rails asset pipeline
+* Added gh-pages branch for documentation
 
 
 ### 1.0.1
@@ -13,10 +26,11 @@
 
 
 
+
 # 1.0.0
 
 * Support for Rails 3.1
-* new model api
+* New model api
 
 
 
@@ -25,7 +39,6 @@
 * Replicate functionality of Rails 2.3 version
 
 
-
 ### 0.0.1, released 2010-07-30
 
 * Initial setup

data/README.md

@@ -1,81 +1,14 @@
 Filterrific
 ===========
 
-User configurable filtering of ActiveRecord lists for your Rails app.
-
-Filterrific is a collection of extensions for ActiveRecord and ActionView
-that allow a developer to add user configurable filtering to ActiveRecord lists.
-
-It comes with the following features:
-
-* Let your app's users search, filter and sort lists of ActiveRecord objects.
-* Add as many AND filter dimensions as you want.
-* Persist filter settings in session or DB (for saved searches).
-* Integrates with pagination.
-* Filters can be reset to default settings.
-* Relies on ActiveRecord scopes for building DB queries.
-* Comes with the plumbing to shuttle filter settings from a filter UI to
-  the controller and ActiveRecord.
-* Can be used for JSON/XML/HTML response formats.
-
-
-<div style="margin: 3em 0;">
-  <blockquote>
-    <p>
-      I couldn't live without Filterrific. It makes it super easy to add
-      user configurable reporting to my client projects.
-    </p>
-    <small>Jeff Ward, Animikii</small>
-  </blockquote>
-</div>
-
-
-### Example app 1
-
----
-
-<img src="http://filterrific.clearcove.ca/images/screenshot_c.png" alt="Filterrific in action"/>
-<em>
-  Example app 1: Filtering a list of members, with saved searches,
-  pagination and filter reset. List at the left, filters to the right.
-</em>
-
----
-
-### Example app 2
-
----
-
-<img src="http://filterrific.clearcove.ca/images/screenshot_q.png" alt="Filterrific in action"/>
-<em>
-  Example app 2: Filtering a list of questions. Filters above, list below.
-</em>
-
----
-
-### Details
-
-* Filterrific takes care of shuttling filter settings from your view
-  to ActiveRecord queries, and of returning matching records back to the view.
-  You are responsible to implement the aspects that are specific
-  to your application:
-    * define the required scopes
-    * style your filter form and record lists
-* You use 3 APIs to integrate Filterrific into your app: Model, View and Controller.
+Filterrific is a Rails Engine plugin that makes it easy to add filtering,
+searching, and sorting to your ActiveRecord lists.
 
 Make sure to go to the fantastic [Filterrific documentation](http://filterrific.clearcove.ca)
 to find out more!
 
 
 
-### Dependencies
-
-* Rails and ActiveRecord 3.x and 4
-* PostgreSQL or MySQL
-* Ruby 1.8.7 or greater
-* jQuery and Asset pipeline for form observers and spinner
-
-
 ### Installation
 
 `gem install filterrific`
@@ -102,17 +35,6 @@ or with bundler in your Gemfile:
 
 
 
-### Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-
-
 ### Copyright
 
 Copyright (c) 2010 - 2013 Jo Hund. See [(MIT) LICENSE](https://github.com/jhund/filterrific/blob/master/MIT-LICENSE) for details.

data/doc/meta.md

@@ -9,7 +9,7 @@ Steps for an update
 -------------------
 
 1. Update code and commit it.
-2. Add entry to CHANGELOG:
+2. Add entry to CHANGELOG and commit it:
    * h1 for major release
    * h2 for minor release
    * h3 for patch release

data/lib/filterrific.rb

@@ -2,4 +2,10 @@ require 'filterrific/version'
 require 'filterrific/engine'
 
 module Filterrific
+
+  # Wrapper around Filterrific::ParamSet initialization
+  def self.new(a_resource_class, filterrific_params = {})
+    Filterrific::ParamSet.new(a_resource_class, filterrific_params)
+  end
+
 end

data/lib/filterrific/action_view_extension.rb

@@ -3,6 +3,18 @@
 #
 module Filterrific::ActionViewExtension
 
+  # Sets all options on form_for to defaults if called with Filterrific object
+  def form_for(record, options = {}, &block)
+    if record.is_a?(Filterrific::ParamSet)
+      options[:as] ||= :filterrific
+      options[:html] ||= {}
+      options[:html][:method] ||= :get
+      options[:html][:id] ||= :filterrific_filter
+      options[:url] ||= url_for
+    end
+    super
+  end
+
   # Renders a spinner while the list is being updated
   def render_filterrific_spinner
     %(

data/lib/filterrific/version.rb

@@ -1,3 +1,3 @@
 module Filterrific
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/vendor/assets/javascripts/filterrific-jquery.js

@@ -9,13 +9,42 @@
  */
 
 
+
+// Create global Filterrific namespace
+if (typeof Filterrific === 'undefined') {
+  var Filterrific = {};
+}
+
+
+
+// Define function to submit Filterrific filter form
+Filterrific.submitFilterForm = function(){
+  var form = $(this).parents("form"),
+      url = form.attr("action");
+  // turn on spinner
+  $('.filterrific_spinner').show();
+  // Submit ajax request
+  $.ajax({
+    url: url,
+    data: form.serialize(),
+    type: 'GET',
+    dataType: 'script'
+  }).done(function( msg ) {
+    $('.filterrific_spinner').hide();
+  });
+};
+
+
+
 //
 // Embed jquery.observe_field.js to observe Filterrific filter inputs
 //
 // Copied from https://github.com/splendeo/jquery.observe_field
+// Wrap in immediately invoked function for compatibility with other js libraries
 //
 (function($) {
-  $.fn.observe_field = function(frequency, callback) {
+
+  $.fn.filterrific_observe_field = function(frequency, callback) {
     frequency = frequency * 1000; // translate to milliseconds
     return this.each(function(){
       var $this = $(this);
@@ -50,36 +79,8 @@
 
 
 
-
-// Create global Filterrific namespace
-if (typeof Filterrific === 'undefined') {
-  var Filterrific = {};
-}
-
-
-
-// Define function to submit Filterrific filter form
-Filterrific.submitFilterForm = function(){
-  var form = $(this).parents("form"),
-      url = form.attr("action");
-  // turn on spinner
-  $('.filterrific_spinner').show();
-  // Submit ajax request
-  $.ajax({
-    url: url,
-    data: form.serialize(),
-    type: 'GET',
-    dataType: 'script'
-  }).done(function( msg ) {
-    $('.filterrific_spinner').hide();
-  });
-};
-
-
-
-// Initialize Filterrific event observers
-(function($) {
-
+// Initialize event observers on document ready
+jQuery(function($){
   // Add change event handler to all Filterrific filter inputs.
   $(document).on(
     "change",
@@ -89,9 +90,8 @@ Filterrific.submitFilterForm = function(){
 
   // Add periodic observer to selected inputs.
   // Use this for text fields you want to observe for change, e.g., a search input.
-  $("#filterrific_filter :input.js-periodically-observed").observe_field(
+  $(".filterrific-periodically-observed").filterrific_observe_field(
     0.5,
     Filterrific.submitFilterForm
   );
-
-})(jQuery);
+});

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filterrific
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -107,10 +107,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "\n    The Rails User Interface solution for filtering your ActiveRecord
-  lists:\n\n    * Built from the ground up for Rails3 or higher\n    * Build filter
-  forms with ease\n    * Filter ActiveRecord lists using AR scopes\n    * Shuttle
-  filter parameters from view to controller to model\n  "
+description: Filterrific is a Rails Engine plugin that makes it easy to add filtering,
+  searching, and sorting to your ActiveRecord lists.
 email: jhund@clearcove.ca
 executables: []
 extensions: []
@@ -164,5 +162,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A Rails engine plugin for filtering ActiveRecord ActiveRecord lists.
+summary: A Rails engine plugin for filtering ActiveRecord lists.
 test_files: []