listings 0.1.6 → 0.1.7

data/README.md

@@ -249,13 +249,20 @@ Also `render:` option can be used to suppress the rendering of the filter, but a
   filter :id, render: false
 ```
 
+Or `render:` can be user to indicate the partial to be used for rendering that filter. Hence allowing custom UI for certain filter among the default UI. See [Templates](#templates) for information regarding where the partial will be looked.
+
+```ruby
+  filter :update_at, render: 'date'
+```
+
+
 Filters are rendered by default by the side of the listing. With `layout` method you can change this and render them on the top.
 
 ```ruby
   layout filters: :top
 ```
 
-Custom filters allows definition of custom meaning to a key. This filters are not rendered.
+Custom filters allows definition of custom meaning to a key. This filters are not rendered by default. Use `render:` option to indicate the partial to be used for rendering.
 
 ```ruby
   custom_filter :order_lte do |items, value|
@@ -408,10 +415,10 @@ There are a number of templates involved in rendering the listing. These templat
 
 For example if a listing named `tracks` is rendered with `twitter-bootstrap-3` theme the templates are looked up in the following locations/order:
 
- * `<app>/views/listings/twitter-bootstrap-3/<partial>`
- * `<gem>/views/listings/twitter-bootstrap-3/<partial>`
  * `<app>/views/listings/tracks/<partial>`
  * `<gem>/views/listings/tracks/<partial>`
+ * `<app>/views/listings/twitter-bootstrap-3/<partial>`
+ * `<gem>/views/listings/twitter-bootstrap-3/<partial>`
  * `<app>/views/listings/<partial>`
  * `<gem>/views/listings/<partial>`
 

data/app/controllers/listings/listings_controller.rb

@@ -5,11 +5,15 @@ module Listings
     def full
       @listing = prepare_listing params, view_context
       render 'listings/full'
+    ensure
+      Kaminari::Helpers::Tag.paginate_with_listings(nil)
     end
 
     def content
       @listing = prepare_listing params, view_context
       render 'listings/content'
+    ensure
+      Kaminari::Helpers::Tag.paginate_with_listings(nil)
     end
 
     def export
@@ -22,6 +26,8 @@ module Listings
           render 'listings/export'
         end
       end
+    ensure
+      Kaminari::Helpers::Tag.paginate_with_listings(nil)
     end
 
   end

data/app/views/listings/_filters.html.haml

@@ -0,0 +1,2 @@
+- listing.filters_to_render.reverse.each do |filter_view|
+  = listings_partial_render filter_view.partial_name, listing, filter: filter_view

data/app/views/listings/_side_filters.html.haml

@@ -0,0 +1,2 @@
+.filters
+  = listings_partial_render 'filters', listing

data/app/views/listings/_top_filters.html.haml

@@ -0,0 +1 @@
+= listings_partial_render 'filters', listing

data/app/views/listings/twitter-bootstrap-2/_side_filter.html.haml

@@ -0,0 +1,8 @@
+%ul.nav.nav-list.well
+  %li.nav-header
+    = "Filter by #{filter.human_name}"
+  - filter.values.each do |value|
+    %li.filter
+      %a{:href => '#', :'data-key' => filter.key, :'data-value' => value}
+        = filter.value_for(value)
+        %i.icon-remove

data/app/views/listings/twitter-bootstrap-2/_top_filter.html.haml

@@ -0,0 +1,10 @@
+%li.dropdown.pull-right
+  %a.dropdown-toggle(data-toggle="dropdown" href="#")
+    = filter.human_name
+    %b.caret
+  %ul.dropdown-menu
+    - filter.values.each do |value|
+      %li.filter
+        %a{:href => '#', :'data-key' => filter.key, :'data-value' => value}
+          = filter.value_for(value)
+          %i.icon-remove

data/app/views/listings/twitter-bootstrap-3/_side_filter.html.haml

@@ -0,0 +1,7 @@
+%a.list-group-item.disabled(href="#")
+  = "Filter by #{filter.human_name}"
+- filter.values.each do |value|
+  %a.list-group-item.filter{:href => '#', :'data-key' => filter.key, :'data-value' => value}
+    = filter.value_for(value)
+    %span.icon-remove
+      ×

data/app/views/listings/twitter-bootstrap-3/_side_filters.html.haml

@@ -1,9 +1,2 @@
 .filters.list-group
-  - listing.filters_to_render.reverse.each do |filter_view|
-    %a.list-group-item.disabled(href="#")
-      = "Filter by #{filter_view.human_name}"
-    - filter_view.values.each do |value|
-      %a.list-group-item.filter{:href => '#', :'data-key' => filter_view.key, :'data-value' => value}
-        = filter_view.value_for(value)
-        %span.icon-remove
-          ×
+  = listings_partial_render 'filters', listing

data/app/views/listings/twitter-bootstrap-3/_top_filter.html.haml

@@ -0,0 +1,10 @@
+%li.dropdown
+  %a.dropdown-toggle(data-toggle="dropdown" href="#")
+    = filter.human_name
+    %span.caret
+  %ul.dropdown-menu
+    - filter.values.each do |value|
+      %li.filter
+        %a{:href => '#', :'data-key' => filter.key, :'data-value' => value}
+          = filter.value_for(value)
+          %i.icon-remove

data/lib/listings/base.rb

@@ -89,7 +89,7 @@ module Listings
 
       if filterable?
         filters_to_render.each do |filter_view|
-          filter_view.values # prepare values
+          filter_view.prepare_values
         end
 
         self.search_filters.each do |key, filter_value|

data/lib/listings/configuration_methods.rb

@@ -164,8 +164,8 @@ module Listings
         filters << FilterDescriptor.new(path, props, proc)
       end
 
-      def custom_filter(key, &proc)
-        filters << CustomFilterDescriptor.new(key, proc)
+      def custom_filter(key, props = {}, &proc)
+        filters << CustomFilterDescriptor.new(key, props, proc)
       end
 
       def layout(props = {})

data/lib/listings/custom_filter_descriptor.rb

@@ -1,10 +1,12 @@
 module Listings
   class CustomFilterDescriptor
     attr_reader :key
+    attr_reader :props
     attr_reader :proc
 
-    def initialize(key, proc)
+    def initialize(key, props, proc)
       @key = key
+      @props = props
       @proc = proc
     end
 

data/lib/listings/custom_filter_view.rb

@@ -8,12 +8,12 @@ module Listings
       @descriptor = descriptor
     end
 
-    def key
-      @descriptor.key
+    def prepare_values
+      # custom filters do not perform lookup
     end
 
-    def render?
-      false
+    def key
+      @descriptor.key
     end
 
     def apply_filter(value)
@@ -21,5 +21,25 @@ module Listings
         listing.instance_exec items, value, &@descriptor.proc
       end
     end
+
+    def render?
+      if render_option.is_a?(String)
+        true
+      else
+        render_option
+      end
+    end
+
+    def partial_name
+      if render_option.is_a?(String)
+        render_option
+      else
+        raise "custom filters can only be rendered when a partial is specified"
+      end
+    end
+
+    def render_option
+      @descriptor.props.fetch(:render, false)
+    end
   end
 end

data/lib/listings/filter_view.rb

@@ -4,6 +4,10 @@ module Listings
       super
     end
 
+    def prepare_values
+      values
+    end
+
     def values
       @values ||= listing.data_source.values_for_filter(field)
     end
@@ -16,12 +20,28 @@ module Listings
       end
     end
 
+    def apply_filter(value)
+      listing.data_source.filter(field, value)
+    end
+
     def render?
-      @field_description.props.fetch(:render, true)
+      if render_option.is_a?(String)
+        true
+      else
+        render_option
+      end
     end
 
-    def apply_filter(value)
-      listing.data_source.filter(field, value)
+    def partial_name
+      if render_option.is_a?(String)
+        render_option
+      else
+        "#{listing.layout_options[:filters]}_filter"
+      end
+    end
+
+    def render_option
+      @field_description.props.fetch(:render, true)
     end
   end
 end

data/lib/listings/version.rb

@@ -1,3 +1,3 @@
 module Listings
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/spec/dummy/app/assets/javascripts/application.js

@@ -22,3 +22,18 @@
 //     console.log(el);
 //   });
 // });
+
+$(function(){
+
+  $('.listing').on('change', '#date-filter', function(){
+    var listings = $(this).closest('.listing')
+    var filter = $(this);
+
+    if (filter.val() == '') {
+      listings.trigger("listings:filter:key:clear", filter.data('filter-key'))
+    } else {
+      listings.trigger("listings:filter:key:set", [filter.data('filter-key'), filter.val()])
+    }
+  });
+});
+

data/spec/dummy/app/listings/filtered_posts_listing.rb

@@ -13,11 +13,22 @@ class FilteredPostsListing < Listings::Base
   filter :author
   filter :category
 
+  custom_filter :updated, render: 'date' do |items, value|
+    begin
+      d = Date.parse(value)
+      items.where(updated_at: d.beginning_of_day..d.end_of_day)
+    rescue
+      items
+    end
+  end
+
 
   column :id
   column :title, searchable: true
   column :author
   column :category
+  column :updated_at
+
   column do |post|
     link_to 'Editar', edit_post_path(post)
   end

data/spec/dummy/app/views/listings/_date.html.haml

@@ -0,0 +1,4 @@
+%ul.nav.nav-list.well
+  %li.nav-header
+    = "Filter by #{filter.key}"
+    %input#date-filter{:'data-filter-key' => filter.key, style: 'width: 100%'}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listings
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -187,19 +187,23 @@ files:
 - app/controllers/listings/listings_controller.rb
 - app/helpers/listings/application_helper.rb
 - app/views/layouts/listings/application.html.erb
+- app/views/listings/_filters.html.haml
 - app/views/listings/_listing.html.haml
+- app/views/listings/_side_filters.html.haml
 - app/views/listings/_table_content.html.haml
+- app/views/listings/_top_filters.html.haml
 - app/views/listings/content.js.erb
 - app/views/listings/export.xls.erb
 - app/views/listings/full.js.erb
 - app/views/listings/twitter-bootstrap-2/_header.html.haml
-- app/views/listings/twitter-bootstrap-2/_side_filters.html.haml
+- app/views/listings/twitter-bootstrap-2/_side_filter.html.haml
 - app/views/listings/twitter-bootstrap-2/_table_full.html.haml
-- app/views/listings/twitter-bootstrap-2/_top_filters.html.haml
+- app/views/listings/twitter-bootstrap-2/_top_filter.html.haml
 - app/views/listings/twitter-bootstrap-3/_header.html.haml
+- app/views/listings/twitter-bootstrap-3/_side_filter.html.haml
 - app/views/listings/twitter-bootstrap-3/_side_filters.html.haml
 - app/views/listings/twitter-bootstrap-3/_table_full.html.haml
-- app/views/listings/twitter-bootstrap-3/_top_filters.html.haml
+- app/views/listings/twitter-bootstrap-3/_top_filter.html.haml
 - config/locales/listings.yml
 - config/routes.rb
 - lib/listings/action_view_extensions.rb
@@ -251,6 +255,7 @@ files:
 - spec/dummy/app/models/post.rb
 - spec/dummy/app/models/track.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/listings/_date.html.haml
 - spec/dummy/app/views/posts/filtered.html.haml
 - spec/dummy/app/views/posts/index.html.haml
 - spec/dummy/app/views/shared/_post_partial.html.haml
@@ -348,6 +353,7 @@ test_files:
 - spec/dummy/app/models/post.rb
 - spec/dummy/app/models/track.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/listings/_date.html.haml
 - spec/dummy/app/views/posts/filtered.html.haml
 - spec/dummy/app/views/posts/index.html.haml
 - spec/dummy/app/views/shared/_post_partial.html.haml

data/app/views/listings/twitter-bootstrap-2/_side_filters.html.haml

@@ -1,11 +0,0 @@
-.filters
-  - listing.filters_to_render.reverse.each do |filter_view|
-    %ul.nav.nav-list.well
-      %li.nav-header
-        = "Filter by #{filter_view.human_name}"
-      - filter_view.values.each do |value|
-        %li.filter
-          %a{:href => '#', :'data-key' => filter_view.key, :'data-value' => value}
-            = filter_view.value_for(value)
-            %i.icon-remove
-

data/app/views/listings/twitter-bootstrap-2/_top_filters.html.haml

@@ -1,11 +0,0 @@
-- listing.filters_to_render.each do |filter_view|
-  %li.dropdown.pull-right
-    %a.dropdown-toggle(data-toggle="dropdown" href="#")
-      = filter_view.human_name
-      %b.caret
-    %ul.dropdown-menu
-      - filter_view.values.each do |value|
-        %li.filter
-          %a{:href => '#', :'data-key' => filter_view.key, :'data-value' => value}
-            = filter_view.value_for(value)
-            %i.icon-remove

data/app/views/listings/twitter-bootstrap-3/_top_filters.html.haml

@@ -1,11 +0,0 @@
-- listing.filters_to_render.each do |filter_view|
-  %li.dropdown
-    %a.dropdown-toggle(data-toggle="dropdown" href="#")
-      = filter_view.human_name
-      %span.caret
-    %ul.dropdown-menu
-      - filter_view.values.each do |value|
-        %li.filter
-          %a{:href => '#', :'data-key' => filter_view.key, :'data-value' => value}
-            = filter_view.value_for(value)
-            %i.icon-remove