listings 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a22fc4c13d5cb505a29f55c60ce5e6e25f47da2b6bed2a3af544a98ceb1585a
-  data.tar.gz: fae15cccdcd790883b853edc1e53c001fc752c6e7d356dea2c7dc8da05e81428
+  metadata.gz: a9b35711b73e6f70de549f6508b4d2626a3dc5c899d809bb08f1b6e6ff0adf49
+  data.tar.gz: 942eadc3eb9a0adfce42a544c61f263aeab9f3bf4a8825656a3a28bac3b36301
 SHA512:
-  metadata.gz: 885752d12e05bf3e3e87fbaaa432d33bfbe72e187da074014fb54441d4e8527804ca803e7f43899ae03e36984aa31a12620e03cad96d07ee91b3daf1ea46d1b8
-  data.tar.gz: 812390604aaa4ed022db339abce0e8ffddd291689cde6f1d03a0995eb5e2dbe997918b6fdb6fa9957946e60fb9b88897e9186826093491eb3705ad7f223fb021
+  metadata.gz: 9668f06ac36fcf570e47c0c325719c51f2c34118943acd673a82f910ccef7f7dbf9850c8d443a519c39ebf36fe4ad0ce9d087a2161fc8e400bd082953c8b5ff2
+  data.tar.gz: 53b6c6433a53d146d9ac62eaae1e68d7e7299c4f4a2945f10c1d276d7c98a43ca68e49197abfc0b5f4660c22dd7d3b2ef5b55a6b3217dc6b40a17f6829078046

data/README.md

@@ -207,6 +207,14 @@ The block is evaluated in a view_context so any helper you will usually use in a
   column album: :name, title: 'Album'
 ```
 
+> **computed columns**
+>
+> Listings will try to sort and filter by default using the `<table_name>.<column_name>` field of the query, on computed queries this will not work, you will need to use `column :my_computed_field, query_column: :my_computed_field` to allow sorting and filtering.
+>
+> Using computed columns might cause some issues depending on the Kaminari version used. If this is the case and you need to filter based on a computed filed, you will need to define a `custom_filter` to apply the filtering of the computed field.
+>
+> See example at [spec/dummy/app/listings/authors_listing.rb](spec/dummy/app/listings/authors_listing.rb)
+
 ### scope
 
 Declaring a `scope` with a symbol with allow user to show only records matching the scope in the ActiveRecord class

data/lib/listings/base_field_descriptor.rb

@@ -11,7 +11,7 @@ module Listings
     end
 
     def build_field(listing)
-      listing.data_source.build_field(path)
+      listing.data_source.build_field(path, props)
     end
 
     def is_field?

data/lib/listings/sources/active_record_data_source.rb

@@ -68,12 +68,12 @@ module Listings::Sources
       @items = @items.eager_load(relation)
     end
 
-    def build_field(path)
+    def build_field(path, props)
       path = self.class.sanitaize_path(path)
       if path.is_a?(Array)
         ActiveRecordAssociationField.new(path, self)
       else
-        ActiveRecordField.new(path, self)
+        ActiveRecordField.new(path, self, props[:query_column])
       end
     end
   end
@@ -113,9 +113,10 @@ module Listings::Sources
   end
 
   class ActiveRecordField < BaseActiveRecordField
-    def initialize(attribute_name, data_source)
+    def initialize(attribute_name, data_source, query_column)
       super(data_source)
       @attribute_name = attribute_name
+      @query_column = query_column
     end
 
     def value_for(item)
@@ -123,7 +124,7 @@ module Listings::Sources
     end
 
     def query_column
-      "#{quote_table_name(data_source.items.table_name)}.#{quote_column_name(@attribute_name)}"
+      @query_column || "#{quote_table_name(data_source.items.table_name)}.#{quote_column_name(@attribute_name)}"
     end
 
     def key

data/lib/listings/sources/data_source.rb

@@ -45,7 +45,7 @@ module Listings::Sources
     end
 
     # returns a +Field+ for the specified options
-    def build_field(path)
+    def build_field(path, props)
     end
 
     def self.for(model)

data/lib/listings/sources/object_data_source.rb

@@ -47,7 +47,7 @@ module Listings::Sources
       end
     end
 
-    def build_field(path)
+    def build_field(path, props)
       path = self.class.sanitaize_path(path)
       unless path.is_a?(Array)
         path = [path]

data/lib/listings/version.rb

@@ -1,3 +1,3 @@
 module Listings
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

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

@@ -23,9 +23,9 @@
 //   });
 // });
 
-$(function(){
+$(function () {
 
-  $('.listing').on('change', '#date-filter', function(){
+  $('.listing').on('change', '#date-filter', function () {
     var listings = $(this).closest('.listing')
     var filter = $(this);
 
@@ -35,5 +35,17 @@ $(function(){
       listings.trigger("listings:filter:key:set", [filter.data('filter-key'), filter.val()])
     }
   });
+
+  $('.listing').on('click', '#posts-count-filter', function () {
+    var listings = $(this).closest('.listing')
+    var filter = $(this);
+    var value = filter.data('filter-value');
+
+    if (value == '') {
+      listings.trigger("listings:filter:key:clear", filter.data('filter-key'))
+    } else {
+      listings.trigger("listings:filter:key:set", [filter.data('filter-key'), value])
+    }
+  });
 });
 

data/spec/dummy/app/controllers/welcome_controller.rb

@@ -10,4 +10,7 @@ class WelcomeController < ApplicationController
 
   def tracks
   end
+
+  def authors
+  end
 end

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

@@ -0,0 +1,26 @@
+class AuthorsListing < Listings::Base
+  model do
+    Author
+      .select('authors.*, (select count(*) from posts where posts.author_id = authors.id) as posts_count')
+  end
+
+  paginates_per 7
+
+  filter :category, values: :categories
+
+  custom_filter :posts_count_eq, render: 'posts_count' do |items, value|
+    items.where("(select count(*) from posts where posts.author_id = authors.id) = ?", value.to_i)
+  end
+
+  def categories
+    Author.select('distinct category').pluck(:category).reject(&:nil?)
+  end
+
+  def query_counts
+    (1..30).to_a
+  end
+
+  column :name, seachable: true
+  column :posts_count, query_column: :posts_count
+  column :category
+end

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

@@ -22,7 +22,7 @@ class PostsListing < Listings::Base
 
   column :id
   column :title, searchable: true
-  column :author, searchable: true
+  column author: :name, searchable: true
   column :category
   column do |post|
     link_to 'Editar', edit_post_path(post)

data/spec/dummy/app/models/author.rb

@@ -0,0 +1,5 @@
+class Author < ActiveRecord::Base
+  attr_accessible :name, :category if Rails::VERSION::MAJOR == 3
+
+  has_many :posts
+end

data/spec/dummy/app/models/post.rb

@@ -1,6 +1,8 @@
 class Post < ActiveRecord::Base
   attr_accessible :title, :author, :category if Rails::VERSION::MAJOR == 3
 
+  belongs_to :author
+
   scope :even, -> { where('id % 2 = 0') }
   scope :odd, -> { where('id % 2 = 1') }
   scope :greater_than, lambda { |gt_id| where('id > ?', gt_id) }

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

@@ -0,0 +1,5 @@
+%ul.nav.nav-list.well
+  %li.nav-header
+    = "Filter by #{filter.key}"
+    - (1..20).each do |value|
+      %a#posts-count-filter{:'data-filter-key' => filter.key, :'data-filter-value' => value, :href => '#'}= value

data/spec/dummy/app/views/welcome/authors.html.haml

@@ -0,0 +1,3 @@
+%h1 Welcome#authors
+
+= render_listing :authors

data/spec/dummy/app/views/welcome/index.html.haml

@@ -12,6 +12,12 @@
   %dd
     ActiveRecord based listing with scopes, deferred_scopes, styles and selectable
 
+%dl
+  %dt
+    = link_to 'Authors', authors_path
+  %dd
+    ActiveRecord based listing with computed columns
+
 %dl
   %dt
     = link_to 'Filtered posts', filtered_posts_path

data/spec/dummy/config/routes.rb

@@ -5,6 +5,7 @@ Rails.application.routes.draw do
       get 'filtered'
     end
   end
+  get 'authors', to: 'welcome#authors'
 
   get 'array', to: 'welcome#array'
   get 'hash', to: 'welcome#hash'

data/spec/dummy/db/schema.rb

@@ -19,11 +19,18 @@ ActiveRecord::Schema.define(:version => 20150611185922) do
     t.datetime "updated_at", :null => false
   end
 
+  create_table "authors", :force => true do |t|
+    t.string   "name"
+    t.string   "category"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
   create_table "posts", :force => true do |t|
     t.string   "title"
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
-    t.text     "author"
+    t.integer  "author_id"
     t.string   "category"
   end
 
@@ -37,5 +44,6 @@ ActiveRecord::Schema.define(:version => 20150611185922) do
   end
 
   add_index "tracks", ["album_id"], :name => "index_tracks_on_album_id"
+  add_index "posts", ["author_id"], :name => "index_posts_on_author_id"
 
 end

data/spec/dummy/db/seeds.rb

@@ -1,8 +1,14 @@
 require 'factory_girl'
 # Dir[Rails.root.join("spec/factories/*.rb")].each {|f| require f}
 
+AUTHORS = []
+
+(1..20).each do |sn|
+  AUTHORS << Author.create!(name: "john-#{(sn % 20) + 1}", category: "category-#{(sn % 3) + 1}")
+end
+
 (1..100).each do |sn|
-  Post.create! title: "post n-#{sn}", author: "john-#{(sn % 4) + 1}", category: "category-#{(sn % 3) + 1}"
+  Post.create! title: "post n-#{sn}", author: AUTHORS[sn % (sn / 10 + 1)], category: "category-#{(sn % 3) + 1}"
 end
 
 (1..10).each do |sn|

data/spec/factories/authors.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :author do
+    name
+  end
+end

data/spec/factories/{post.rb → posts.rb}

@@ -1,5 +1,6 @@
 FactoryGirl.define do
   factory :post do
     title
+    author
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listings
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Brian J. Cardiff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -198,22 +198,26 @@ files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/helpers/posts_helper.rb
 - spec/dummy/app/listings/array_listing.rb
+- spec/dummy/app/listings/authors_listing.rb
 - spec/dummy/app/listings/filtered_posts_listing.rb
 - spec/dummy/app/listings/hash_listing.rb
 - spec/dummy/app/listings/posts_listing.rb
 - spec/dummy/app/listings/tracks_fixed_order_listing.rb
 - spec/dummy/app/listings/tracks_listing.rb
 - spec/dummy/app/models/album.rb
+- spec/dummy/app/models/author.rb
 - spec/dummy/app/models/object_album.rb
 - spec/dummy/app/models/object_track.rb
 - 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/listings/_posts_count.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
 - spec/dummy/app/views/welcome/array.html.haml
+- spec/dummy/app/views/welcome/authors.html.haml
 - spec/dummy/app/views/welcome/hash.html.haml
 - spec/dummy/app/views/welcome/index.html.haml
 - spec/dummy/app/views/welcome/tracks.html.haml
@@ -248,7 +252,8 @@ files:
 - spec/dummy/script/rails
 - spec/dummy/spec
 - spec/factories/albums.rb
-- spec/factories/post.rb
+- spec/factories/authors.rb
+- spec/factories/posts.rb
 - spec/factories/tracks.rb
 - spec/factories/traits.rb
 - spec/lib/filter_parser_spec.rb
@@ -289,11 +294,13 @@ test_files:
 - spec/dummy/app/listings/filtered_posts_listing.rb
 - spec/dummy/app/listings/posts_listing.rb
 - spec/dummy/app/listings/array_listing.rb
+- spec/dummy/app/listings/authors_listing.rb
 - spec/dummy/app/listings/hash_listing.rb
 - spec/dummy/app/listings/tracks_listing.rb
 - spec/dummy/app/listings/tracks_fixed_order_listing.rb
 - spec/dummy/app/models/object_track.rb
 - spec/dummy/app/models/album.rb
+- spec/dummy/app/models/author.rb
 - spec/dummy/app/models/object_album.rb
 - spec/dummy/app/models/track.rb
 - spec/dummy/app/models/post.rb
@@ -303,11 +310,13 @@ test_files:
 - spec/dummy/app/views/posts/filtered.html.haml
 - spec/dummy/app/views/posts/index.html.haml
 - spec/dummy/app/views/listings/_date.html.haml
+- spec/dummy/app/views/listings/_posts_count.html.haml
 - spec/dummy/app/views/shared/_post_partial.html.haml
 - spec/dummy/app/views/welcome/array.html.haml
 - spec/dummy/app/views/welcome/index.html.haml
 - spec/dummy/app/views/welcome/hash.html.haml
 - spec/dummy/app/views/welcome/tracks.html.haml
+- spec/dummy/app/views/welcome/authors.html.haml
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/application.js
@@ -355,8 +364,9 @@ test_files:
 - spec/support/query_counter.rb
 - spec/factories/albums.rb
 - spec/factories/traits.rb
+- spec/factories/authors.rb
+- spec/factories/posts.rb
 - spec/factories/tracks.rb
-- spec/factories/post.rb
 - spec/lib/filter_parser_spec.rb
 - spec/lib/sources/active_record_data_source_spec.rb
 - spec/lib/sources/object_data_source_spec.rb