easy_filters 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1157caafe4fbbbadc2f21ac3dd9c1e8fc76eed32
-  data.tar.gz: 7f3bcf4651888dfbc41a7c7b536b066223a49653
+  metadata.gz: 19155d4317913a170eeae20a792f6cea6cdc2e61
+  data.tar.gz: 6a557001e6dc7581ae2e32755571e0970cf26940
 SHA512:
-  metadata.gz: bb0b250b1e6d1a0d67f417858eda52d1171126341b93f45107b7653f304a9abefb914fff2368bd41b0e321c9e04ceccd89dcc35f5db9cd518938d8d7e884efa2
-  data.tar.gz: 774e231c3e2cc6e7d568a20bf8510ce8f03ab0d8c729218a8fb66c56b0e915f89ed7d5b8726be7f138ab739a211d58229cf7372997bbdb220f1a72bbf20979ed
+  metadata.gz: 194967011a03333cad0deed886d26a999fc8390fad6beb0505e7359738bba1963c1999a3719ea99ee8473fa2ebe3907f9f8dba312b42c5de20501a34949e5c55
+  data.tar.gz: d0c05ce2cbbe406f2b0d441718006666d075adbd27af2ee48ce2679d7f29f884f7572a93c2317c93c726d1bfdea8261e62e63680fc4f94af9fcafd607538fbf2

data/README.md

@@ -20,20 +20,23 @@ And then execute:
 ```
 
 ## Usage
-
+Create a `articles_filter.rb` file in `app/models/easy_filters` folder
 EasyFilters expects you to define the following methods:
 
 ```ruby
-class ArticlesFilter < EasyFilters::ModelFilter
+module EasyFilters
 
-  # Default values for this filter.
-  def self.defaults
-    { body: nil, date_from: nil, date_to: nil }
-  end
+  class ArticlesFilter < ModelFilter
+
+    # Default values for this filter.
+    def self.defaults
+      { body: nil, date_from: nil, date_to: nil }
+    end
 
-  # Model class to be filtered.
-  def model
-    Article
+    # Model class to be filtered.
+    def model
+      Article
+    end
   end
 end
 
@@ -55,37 +58,55 @@ Each `filter_by_*` method receives 2 params:
 For example:  
 
 ```ruby
-class ArticlesFilter < ModelFilter
+
+module EasyFilters
+
+  class ArticlesFilter < ModelFilter
    
-  #(...) previously defined methods
+    #(...) previously defined methods
 
-  # Custom filter method for :body field.
-  def filter_by_body(scope, value)
-    matcher = "%#{value}%"
-    scope.where('body like ? OR body like ?', matcher, matcher)
-  end
+    # Custom filter method for :body field.
+    def filter_by_body(scope, value)
+      matcher = "%#{value}%"
+      scope.where('body like ? OR body like ?', matcher, matcher)
+    end
 
-  # The following 2 filter_by builds an from/to/between date filter:
+    # The following 2 filter_by builds an from/to/between date filter:
 
-  # Custom filter method for :date_from field.
-  def filter_by_date_from(scope, value)
-    scope.joins(:editions).where('editions.date >= ?', Date.parse(value))
-  end
+    # Custom filter method for :date_from field.
+    def filter_by_date_from(scope, value)
+      scope.joins(:editions).where('editions.date >= ?', Date.parse(value))
+    end
 
-  # Custom filter method for :date_to field.
-  def filter_by_date_to(scope, value)
-    scope.joins(:editions).where('editions.date <= ?', Date.parse(value))
+    # Custom filter method for :date_to field.
+    def filter_by_date_to(scope, value)
+      scope.joins(:editions).where('editions.date <= ?', Date.parse(value))
+    end
   end
 end
 
 ```
+
 ### Usage in controllers
 
 You can instance a filter in your controller, and define some
 usefull methods
 
 For example:
+
 ```ruby
+
+  #(...) previously defined controller
+  
+  before_action :filter,       only: [:filter_page]
+  before_action :clear_filter, only: [:filter_page]
+  
+  def filter_page
+    @objects = @filter.all
+  end
+  
+  private
+  
   def create_filter(filter_class, opts = {})
       options = { store: session, persist: true }.merge opts
       filter_class.new options
@@ -93,13 +114,13 @@ For example:
 
   def filter_params
     if params.has_key?(:filter)
-      params.require(:filter).permit(:firstname, :lastname, :cuit).to_options
+      params.require(:filter).permit(:body, :date_from, :date_to).to_options
     end
   end
 
   # Create the @filter object with the currently-set values for the filters
   def filter
-    @filter = create_filter PaymentsFilter, values: filter_params
+    @filter = create_filter EasyFilters::ArticlesFilter, values: filter_params
   end
 
   # Clear the currently-set filters, restoring them to the defaults
@@ -109,14 +130,19 @@ For example:
       redirect_to request.path
     end
   end
+  
 ```
- ### Usage in views
-
- Define a input with the filter
- ```ruby
-<%= form_tag do %>
-    <%= label :filter, :firstname %>
-    <%= submit_tag t('common.filters.search' %>
-    <%= submit_tag t('common.filters.clear' %>
+
+### Usage in views
+Define a input with the filter
+
+```ruby
+
+<% form_tag '', :method => :get do %>
+    <%= label :filter, :body %>
+    <%= text_field :filter, :body %>
+    <%= submit_tag t('common.filters.search') %>
+    <%= submit_tag t('common.filters.clear') %>
 <% end %>
- ```
+
+ ```

data/lib/easy_filters/version.rb

@@ -1,3 +1,3 @@
 module EasyFilters
-  VERSION = "0.0.2"
-end
+  VERSION = "0.0.3"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_filters
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - German Olle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler