filterrific 1.0.1 → 1.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+
+RSpec.configure do |config|
+  # Nothing to do
+end

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

@@ -0,0 +1,97 @@
+/**
+ * Javascript behaviors for Filterrific.
+ * http://filterrific.clearcove.ca
+ *
+ * Requires jQuery 1.7.0 or later.
+ *
+ * Released under the MIT license
+ *
+ */
+
+
+//
+// Embed jquery.observe_field.js to observe Filterrific filter inputs
+//
+// Copied from https://github.com/splendeo/jquery.observe_field
+//
+(function($) {
+  $.fn.observe_field = function(frequency, callback) {
+    frequency = frequency * 1000; // translate to milliseconds
+    return this.each(function(){
+      var $this = $(this);
+      var prev = $this.val();
+      var check = function() {
+        if(removed()){ // if removed clear the interval and don't fire the callback
+          if(ti) clearInterval(ti);
+          return;
+        }
+        var val = $this.val();
+        if(prev != val){
+          prev = val;
+          $this.map(callback); // invokes the callback on $this
+        }
+      };
+      var removed = function() {
+        return $this.closest('html').length == 0
+      };
+      var reset = function() {
+        if(ti){
+          clearInterval(ti);
+          ti = setInterval(check, frequency);
+        }
+      };
+      check();
+      var ti = setInterval(check, frequency); // invoke check periodically
+      // reset counter after user interaction
+      $this.bind('keyup click mousemove', reset); //mousemove is for selects
+    });
+  };
+})(jQuery);
+
+
+
+
+// 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($) {
+
+  // Add change event handler to all Filterrific filter inputs.
+  $(document).on(
+    "change",
+    "#filterrific_filter :input",
+    Filterrific.submitFilterForm
+  );
+
+  // 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(
+    0.5,
+    Filterrific.submitFilterForm
+  );
+
+})(jQuery);

metadata

@@ -1,119 +1,168 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: filterrific
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-09 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: "\n      The Rails User Interface solution for filtering your ActiveRecord lists:\n\n      * Built from the ground up for Rails3\n      * Build filter forms with ease\n      * Filter ActiveRecord lists using AR scopes\n      * Shuttle filter parameters from view to controller to model in a RESTful way\n      * Auto-generate scopes for AR associations (Planned)\n      * Form builder for filter UI forms (Planned)\n    "
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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  "
 email: jhund@clearcove.ca
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - CHANGELOG.md
-- LICENSE
-- README.rdoc
+- MIT-LICENSE
 - Rakefile
-- VERSION
-- doc/Overview diagram.graffle/QuickLook/Preview.pdf
-- doc/Overview diagram.graffle/QuickLook/Thumbnail.tiff
-- doc/Overview diagram.graffle/data.plist
-- doc/Overview diagram.graffle/image1.tiff
+- README.md
 - doc/development_notes/api_design.txt
 - doc/development_notes/controller_api.txt
 - doc/development_notes/model_api.rb
 - doc/development_notes/view_api.txt
-- doc/documentation.md
-- doc/ideas.txt
-- doc/todo.md
-- doc/workflow.md
-- filterrific.gemspec
-- lib/filterrific.rb
-- lib/filterrific/model_mixin.rb
+- doc/meta.md
+- doc/Overview diagram.graffle/data.plist
+- doc/Overview diagram.graffle/image1.tiff
+- lib/filterrific/action_view_extension.rb
+- lib/filterrific/active_record_extension.rb
+- lib/filterrific/engine.rb
 - lib/filterrific/param_set.rb
-- lib/filterrific/railtie.rb
-- lib/filterrific/view_helpers.rb
-- test/helper.rb
-- test/test_filterrific.rb
-has_rdoc: true
-homepage: http://github.com/jhund/filterrific
-licenses: []
-
+- lib/filterrific/version.rb
+- lib/filterrific.rb
+- spec/action_view_extension_spec.rb
+- spec/active_record_extension_spec.rb
+- spec/filterrific_spec.rb
+- spec/param_set_spec.rb
+- spec/spec_helper.rb
+- vendor/assets/images/filterrific-spinner.gif
+- vendor/assets/javascripts/filterrific-jquery.js
+homepage: http://filterrific.clearcove.ca
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: The Rails User Interface solution for filtering your ActiveRecord lists.
+summary: A Rails engine plugin for filtering ActiveRecord ActiveRecord lists.
 test_files: []
-

data/README.rdoc

@@ -1,19 +0,0 @@
-= Filterrific
-
-Add filter controls to your ActiveRecord lists and persist filter settings via session or DB.
-
-MIT licensed.
-
-== 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 Jo Hund. See (MIT) LICENSE for details.

data/VERSION

@@ -1 +0,0 @@
-1.0.1

data/doc/documentation.md

@@ -1,34 +0,0 @@
-# Filterrific Documentation
-
-## Word list
-
-* Filterrific - the gem
-* Filterrific::Param - individual element of a *FilterrificParamSet*.
-  Defines how the AR list should be filtered. Managed via instance of *FilterrificParamSet* class.
-* Filterrific::ScopeNames - List of *Scope* names that are available to *Filterrific*.
-* Filterrific::ParamSet - Container for *FilterrificParams*
-* Filterrific::Form - a HTML form used to define *FilterrificParams*
-* Scope - An ActiveRecord scope (formerly known as named_scope)
-
-## Brain dump
-
-* Scenarios
-  * Saved search (persist FilterrificParamSet in DB)
-  * Will paginate/kaminari integration
-  * Session persistence
-  * Interface for JS client side app to get collections of data via JSON REST
-  * integrate with PG fulltext search (pg_search)
-* Defining Scopes
-  * Belongs_to
-  * Has_many
-  * Sorting
-  * Full text search (Postgres, Like, regex, Sphinx?)
-* Filterrific form inputs
-  * checkboxes
-  * multi selects
-
-## Requirements
-
-* Rails3 (or 3.1?)
-
-  

data/doc/ideas.txt

@@ -1,107 +0,0 @@
-20110418: Look at this when building API: https://github.com/ryan-allen/lispy
-
-
-20110414 Related project:
-
-* https://github.com/plataformatec/has_scope
-
-20110221 Promotion:
-
-* railscasts (even ask for review/feedback)
-* railsinside
-* ruby toolbox
-
-
-20110205: figuring out best prefix for namespacing filterrific
-
-balance between shortness and expression:
-
-f
-fc
-ft
-frc
-ftf
-fifc
-flfc
-frfc
-ftfc
-ftrfc
-fltrfc
-filtrfc
-filterrific
-
-20110112: see if I can learn something here:
-http://www.idolhands.com/ruby-on-rails/guides-tips-and-tutorials/add-filters-to-views-using-named-scopes-in-rails
-
-
-20101227: get inspiration from this project: https://github.com/neerajdotname/admin_data
-look especially at their query builder in the heroku demo project (add conditions like Finder search)
-
-
-Glean specific code from these projects:
-
-20100224 CVIMS
-201001   cando
-201001   PTS
-201001   Quentin-rails-backend
-         stratadocs (list starts with self as AR proxy)
-
-
-view
-(skip these for now?)
-apply all relevant options from formtastic
-integrate with formtastic?
-
-
-
-
-
-
-
-
-SAVED SEARCHES
-==============
-
-See cando for implementation
-
-
-
-
-CONTENT FOR README
-==================
-
-
-
-
-This Rails engine makes it super simple to add filtering to your rails list views.
-
-Some of the features:
----------------------
-
-* RESTful
-* conditions, sorting, maybe grouping?
-* works with pagination
-* settings can be persisted in session or via database for saved searches
-* works with ActiveRecord
-* gets along well with will_paginate
-
-Possibilities:
--------------
-
-* integrate with thinking_sphinx
-* integrate with formtastic
-* integrate with will_paginate
-* integrate with make_resourceful
-
-Here is how it works:
----------------------
-
-Filterrific relies heavily on scopes. Each filter dimension has its own scope. Filterrific makes it
-easy to shuttle user settings to your controllers and models for queries, and back to the views.
-
-
-Related projects
-================
-
-* http://github.com/plataformatec/has_scope
-