filterrific 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8319fe298662aa7cfbf8f535386900c463980dda
-  data.tar.gz: b5cf4554ce05881a0d40bf1e689eb2e5be887e54
+  metadata.gz: 818d80584a2a4db43f268028613b856a6ef52528
+  data.tar.gz: 3744f644a940ddccbb6233027a7a4b919e009547
 SHA512:
-  metadata.gz: 5080e45c99e3d025360f30c4de3d09286d28327d7bc86490f41b5a12a20ac1fd998b3e47ed4d88f180bd61cbeb9e03ae64927d31e221466716cfa951097d643c
-  data.tar.gz: 165bd6393ad6decf0568d7caeda8277fd252f1e2c9262f4b3afff3ca92c3a01618e77b1de1d5759141584e0e942d661af6536bf4601bbf1ac8328e9fd908d35b
+  metadata.gz: f7e1fe41394af2fc4e59e9daa1f0523d3b67a1d93288b047f5b76b8962adb84c7d0f61645639fa28d8cca5e6a2ed133fd01b927c7feea182040a4b9d35e0cc08
+  data.tar.gz: 61bf2d0d764c43a252b637ade5b0f4161541d9aeb8ed9b4623acf07a1a96e9dd67023bb8dcc1820df3a8d97c78ba2e15daf7bc5d41281a1be20dfd395473b238

data/CHANGELOG.md

@@ -8,15 +8,16 @@ API changes
     filterrific(
       default_settings: { sorted_by: 'name_asc' },
       search_query: {
-        match: :any
-        wildcard: :suffix,
-        adaptor: :postgres
+        match_terms: :any, # [:all]
+        auto_wildcard: :suffix, # [:prefix, :both, :none]
+        columns: [:first_name, :email, :last_name],
+        case_sensitive: false, # [true]
       },
       sorted_by: {
         name_asc: 'Name (A-Z)',
-        name_desc: 'Name (Z-A)'
+        name_desc: 'Name (Z-A)',
       },
-      filter_names: [
+      scopes: [
         :with_country,
         ...
       ]
@@ -32,7 +33,7 @@ API changes
       filter_names: [],
       params_key: :filterrific,
       select_options: {},
-      session_persistence: 'asdf',
+      session_persistence_key: 'asdf',
     )
     @students = @filterrific.find
 
@@ -46,6 +47,12 @@ API changes
   bug fixes in 3.1, and use of asset pipeline)
 
 
+### 1.4.2
+
+* Updated initialization of ActiveRecord and ActionView extensions again
+
+
+
 ### 1.4.1
 
 * Updated initialization of ActiveRecord and ActionView extensions

data/lib/filterrific/action_view_extension.rb

@@ -3,108 +3,110 @@
 #
 # Adds view helpers to ActionView
 #
-module Filterrific::ActionViewExtension
+module Filterrific
+  module 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(:controller => controller.controller_name, :action => controller.action_name)
+    # 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(:controller => controller.controller_name, :action => controller.action_name)
+      end
+      super
     end
-    super
-  end
-  # TODO: change this to form_for_filterrific!
+    # TODO: change this to form_for_filterrific!
 
-  # Renders a spinner while the list is being updated
-  def render_filterrific_spinner
-    %(
-      <span class="filterrific_spinner" style="display:none;">
-        #{ image_tag('filterrific/filterrific-spinner.gif') }
-      </span>
-    ).html_safe
-  end
-  #alias: filterrific_spinner
+    # Renders a spinner while the list is being updated
+    def render_filterrific_spinner
+      %(
+        <span class="filterrific_spinner" style="display:none;">
+          #{ image_tag('filterrific/filterrific-spinner.gif') }
+        </span>
+      ).html_safe
+    end
+    #alias: filterrific_spinner
 
-  # Renders a link which indicates the current sorting and which can be used to
-  # toggle the list sorting (set column and direction).
-  # NOTE: Make sure that this is used in the list partial that is re-rendered
-  # when the filterrific params are changed, so that the filterrific params in
-  # the URL are always current.
-  # @param[Filterrific::ParamSet] filterrific the current filterrific instance
-  # @param[String, Symbol] sort_key the key to sort by, without direction.
-  #     Example: 'name', 'created_at'
-  # @param[Hash, optional] options:
-  #     * active_column_class: CSS class applied to current sort column.
-  #       Default: 'filterrific_current_sort_column'
-  #     * ascending_indicator: HTML string to indicate ascending sort direction.
-  #       Default: Triangle pointing up.
-  #     * default_sort_direction: override the default sorting when selecting
-  #       a new sort column. Default: 'asc'.
-  #     * descending_indicator: HTML string to indicate descending sort direction.
-  #       Default: Triangle pointing down.
-  #     * html_attrs: HTML attributes to be added to the sorting link. Default: {}
-  #     * label: override label. Default: `sort_key.humanize`.
-  #     * sorting_scope_name: override the name of the scope used for sorting.
-  #       Default: `:sorted_by`
-  #     * url_for_attrs: override the target URL attributes to be used for `url_for`.
-  #       Default: {} (current URL).
-  # TODO: update documentation
-  # TODO: update demo app
-  # TODO: synchronize with sorting select in filter
-  def filterrific_sorting_link(filterrific, sort_key, options = {})
-    options = {
-      :active_column_class => 'filterrific_current_sort_column',
-      :ascending_indicator => '⬆',
-      :default_sort_direction => 'asc',
-      :descending_indicator => '⬇',
-      :html_attrs => {},
-      :label => sort_key.to_s.humanize,
-      :sorting_scope_name => :sorted_by,
-      :url_for_attrs => {},
-    }.merge(options)
-    options[:html_attrs] = options[:html_attrs].with_indifferent_access
-    current_sorting = filterrific.send(options[:sorting_scope_name])
-    current_sort_key = current_sorting ? current_sorting.gsub(/_asc|_desc/, '') : nil
-    current_sort_direction = current_sorting ? (current_sorting =~ /_desc\z/ ? 'desc' : 'asc') : nil
-    new_sort_key = sort_key.to_s
-    if new_sort_key == current_sort_key
-      # current sort column, toggle search_direction
-      new_sort_direction, current_sort_direction_indicator = if 'asc' == current_sort_direction
-        ['desc', options[:ascending_indicator]]
+    # Renders a link which indicates the current sorting and which can be used to
+    # toggle the list sorting (set column and direction).
+    # NOTE: Make sure that this is used in the list partial that is re-rendered
+    # when the filterrific params are changed, so that the filterrific params in
+    # the URL are always current.
+    # @param[Filterrific::ParamSet] filterrific the current filterrific instance
+    # @param[String, Symbol] sort_key the key to sort by, without direction.
+    #     Example: 'name', 'created_at'
+    # @param[Hash, optional] options:
+    #     * active_column_class: CSS class applied to current sort column.
+    #       Default: 'filterrific_current_sort_column'
+    #     * ascending_indicator: HTML string to indicate ascending sort direction.
+    #       Default: Triangle pointing up.
+    #     * default_sort_direction: override the default sorting when selecting
+    #       a new sort column. Default: 'asc'.
+    #     * descending_indicator: HTML string to indicate descending sort direction.
+    #       Default: Triangle pointing down.
+    #     * html_attrs: HTML attributes to be added to the sorting link. Default: {}
+    #     * label: override label. Default: `sort_key.humanize`.
+    #     * sorting_scope_name: override the name of the scope used for sorting.
+    #       Default: `:sorted_by`
+    #     * url_for_attrs: override the target URL attributes to be used for `url_for`.
+    #       Default: {} (current URL).
+    # TODO: update documentation
+    # TODO: update demo app
+    # TODO: synchronize with sorting select in filter
+    def filterrific_sorting_link(filterrific, sort_key, options = {})
+      options = {
+        :active_column_class => 'filterrific_current_sort_column',
+        :ascending_indicator => '⬆',
+        :default_sort_direction => 'asc',
+        :descending_indicator => '⬇',
+        :html_attrs => {},
+        :label => sort_key.to_s.humanize,
+        :sorting_scope_name => :sorted_by,
+        :url_for_attrs => {},
+      }.merge(options)
+      options[:html_attrs] = options[:html_attrs].with_indifferent_access
+      current_sorting = filterrific.send(options[:sorting_scope_name])
+      current_sort_key = current_sorting ? current_sorting.gsub(/_asc|_desc/, '') : nil
+      current_sort_direction = current_sorting ? (current_sorting =~ /_desc\z/ ? 'desc' : 'asc') : nil
+      new_sort_key = sort_key.to_s
+      if new_sort_key == current_sort_key
+        # current sort column, toggle search_direction
+        new_sort_direction, current_sort_direction_indicator = if 'asc' == current_sort_direction
+          ['desc', options[:ascending_indicator]]
+        else
+          ['asc', options[:descending_indicator]]
+        end
+        new_sorting = [new_sort_key, new_sort_direction].join('_')
+        css_classes = [
+          options[:active_column_class],
+          options[:html_attrs].delete(:class)
+        ].compact.join(' ')
+        new_filterrific_params = filterrific.to_hash
+                                            .with_indifferent_access
+                                            .merge(options[:sorting_scope_name] => new_sorting)
+        url_for_attrs = options[:url_for_attrs].merge(:filterrific => new_filterrific_params)
+        link_to(
+          [options[:label], current_sort_direction_indicator].join(' '),
+          url_for(url_for_attrs),
+          options[:html_attrs].reverse_merge(:class => css_classes, :method => :get, :remote => true)
+        )
       else
-        ['asc', options[:descending_indicator]]
+        # new sort column, change sort column
+        new_sort_direction = options[:default_sort_direction]
+        new_sorting = [new_sort_key, new_sort_direction].join('_')
+        new_filterrific_params = filterrific.to_hash
+                                            .with_indifferent_access
+                                            .merge(options[:sorting_scope_name] => new_sorting)
+        url_for_attrs = options[:url_for_attrs].merge(:filterrific => new_filterrific_params)
+        link_to(
+          options[:label],
+          url_for(url_for_attrs),
+          options[:html_attrs].reverse_merge(:method => :get, :remote => true)
+        )
       end
-      new_sorting = [new_sort_key, new_sort_direction].join('_')
-      css_classes = [
-        options[:active_column_class],
-        options[:html_attrs].delete(:class)
-      ].compact.join(' ')
-      new_filterrific_params = filterrific.to_hash
-                                          .with_indifferent_access
-                                          .merge(options[:sorting_scope_name] => new_sorting)
-      url_for_attrs = options[:url_for_attrs].merge(:filterrific => new_filterrific_params)
-      link_to(
-        [options[:label], current_sort_direction_indicator].join(' '),
-        url_for(url_for_attrs),
-        options[:html_attrs].reverse_merge(:class => css_classes, :method => :get, :remote => true)
-      )
-    else
-      # new sort column, change sort column
-      new_sort_direction = options[:default_sort_direction]
-      new_sorting = [new_sort_key, new_sort_direction].join('_')
-      new_filterrific_params = filterrific.to_hash
-                                          .with_indifferent_access
-                                          .merge(options[:sorting_scope_name] => new_sorting)
-      url_for_attrs = options[:url_for_attrs].merge(:filterrific => new_filterrific_params)
-      link_to(
-        options[:label],
-        url_for(url_for_attrs),
-        options[:html_attrs].reverse_merge(:method => :get, :remote => true)
-      )
     end
-  end
 
+  end
 end

data/lib/filterrific/active_record_extension.rb

@@ -3,9 +3,8 @@
 #
 require 'filterrific/param_set'
 
-module Filterrific::ActiveRecordExtension
-
-  module ClassMethods
+module Filterrific
+  module ActiveRecordExtension
 
     # Adds filterrific behavior to class when called like so:
     #
@@ -84,5 +83,4 @@ module Filterrific::ActiveRecordExtension
     end
 
   end
-
 end

data/lib/filterrific/engine.rb

@@ -1,3 +1,7 @@
+require 'filterrific/param_set'
+require 'filterrific/action_view_extension'
+require 'filterrific/active_record_extension'
+
 module Filterrific
   class Engine < ::Rails::Engine
 
@@ -6,26 +10,16 @@ module Filterrific
 
     isolate_namespace Filterrific
 
-    require 'filterrific/param_set'
-
-    initializer "filterrific" do |app|
-
-      ActiveSupport.on_load :active_record do
-        require 'filterrific/active_record_extension'
-        class ::ActiveRecord::Base
-          extend Filterrific::ActiveRecordExtension::ClassMethods
-        end
-      end
+    ActiveSupport.on_load :active_record do
+      extend Filterrific::ActiveRecordExtension
+    end
 
-      ActiveSupport.on_load :action_view do
-        require 'filterrific/action_view_extension'
-        class ::ActionView::Base
-          include Filterrific::ActionViewExtension
-        end
-      end
+    ActiveSupport.on_load :action_view do
+      include Filterrific::ActionViewExtension
+    end
 
+    initializer "filterrific" do |app|
       app.config.assets.precompile += %w(filterrific-spinner.gif)
-
     end
 
   end

data/lib/filterrific/version.rb

@@ -1,3 +1,3 @@
 module Filterrific
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterrific
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails