listings 0.1.10 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32776ce178fcb720c00b4934b817b1caf3074944
-  data.tar.gz: 580d72bd4ab37f34a8e1547f25d0754bb296d429
+  metadata.gz: 22306e285b8f18877c6d47cc742bfa3cb284c4ac
+  data.tar.gz: f402374e22a72800dfef55e6a8d65fabc2c17a69
 SHA512:
-  metadata.gz: 7206e2c4df8f2213ceab30455446de291e9cce3700b612e7e864fee6308cfb806456b0d4486d8735b51740991f7a987a449fea761338b073b3fe032df4a43665
-  data.tar.gz: 568d4deb9319ff9dc18877b471f0e09a768445e529f804e5349ebf48a3b4cd255c5892573605b177a095fac1d69064bbabe01f56bc27ac39ff087bc5be6d9c10
+  metadata.gz: e0dac07fedd6ef74330151646a991720ded9b0ff2cdb8f7059cfcf0d0d3e62a8a44176a95a9abee7a37e2665662a071670aedf1e7358066fdcdc90858d9248a6
+  data.tar.gz: bf3482c5505d5bce1c903e65cb29dace7917f8fbf60f4629ded558e24cab4d2a2b14a352b8d29f9d9f2d624324254e9be50caf8c34424acf03f3107bdf2fbc80

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
@@ -243,6 +251,18 @@ It supports `title:` and a block
   end
 ```
 
+A `values: :method` can be specified to avoid the select distinct over the values.
+
+```ruby
+  filter album: :name, values: :all_album_names, title: 'Album' do |album_name|
+    album_name.titleize
+  end
+
+  def all_album_names
+    Album.order("name").pluck("distinct name").reject(&:nil?)
+  end
+```
+
 Also `render:` option can be used to suppress the rendering of the filter, but allowing the user to filter by it. For example to filter by the id:
 
 ```ruby

data/app/controllers/listings/listings_controller.rb

@@ -20,11 +20,8 @@ module Listings
       @listing = prepare_listing params, view_context, false
 
       respond_to do |format|
-        format.csv { send_data @listing.to_csv, filename: @listing.export_filename(:csv) }
-        format.xls do
-          headers["Content-Disposition"] = "attachment; filename=\"#{@listing.export_filename(:xls)}\""
-          render 'listings/export'
-        end
+        format.csv { @listing.send_csv(self) }
+        format.xls { @listing.send_xls(self) }
       end
     ensure
       Kaminari::Helpers::Tag.paginate_with_listings(nil)

data/app/views/listings/export.xls.erb

@@ -11,7 +11,7 @@
           <Cell><Data ss:Type="String"><%= col.human_name %></Data></Cell>
         <% end %>
       </Row>
-    <% @listing.items.each do |item| %>
+    <% @listing.export_each do |item| %>
       <Row>
         <% @listing.columns.each do |col| %>
           <% col.value_for(item).tap do |value| %>

data/lib/listings/base.rb

@@ -177,30 +177,40 @@ module Listings
       (params[:format] || :html).to_sym
     end
 
-    def to_array
-      data = []
-
-      data << self.columns.map { |c| c.human_name }
-
+    def export_each
       self.items.each do |item|
-        row = []
-        self.columns.each do |col|
-          row << col.value_for(item)
-        end
-        data << row
+        yield item
       end
-
-      data
     end
 
-    def to_csv
-      CSV.generate do |csv|
-        self.to_array.each do |row|
-          csv << row
+    def send_csv(controller)
+      csv_filename = self.export_filename(:csv)
+
+      controller.headers["X-Accel-Buffering"] = "no"
+      controller.headers["Cache-Control"] = "no-cache"
+      controller.headers["Content-Type"] = "text/csv; charset=utf-8"
+      controller.headers["Content-Disposition"] = %(attachment; filename="#{csv_filename}")
+      controller.headers["Transfer-Encoding"] = "chunked"
+      controller.headers.delete("Content-Length")
+
+      controller.response_body = Enumerator.new do |lines|
+        lines << self.columns.map { |c| c.human_name }.to_csv
+
+        self.export_each do |item|
+          row = []
+          self.columns.each do |col|
+            row << col.value_for(item)
+          end
+          lines << row.to_csv
         end
       end
     end
 
+    def send_xls(controller)
+      controller.headers["Content-Disposition"] = %(attachment; filename="#{self.export_filename(:xls)}")
+      controller.render 'listings/export'
+    end
+
     def method_missing(m, *args, &block)
       view_context.send(m, *args, &block)
     end

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/filter_view.rb

@@ -9,7 +9,13 @@ module Listings
     end
 
     def values
-      @values ||= listing.data_source.values_for_filter(field)
+      @values ||= begin
+        if method = @field_description.props[:values]
+          listing.send(method)
+        else
+          listing.data_source.values_for_filter(field)
+        end
+      end
     end
 
     def value_for(value)

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.10"
+  VERSION = "0.1.15"
 end

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1 @@
+{ }

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/listings/tracks_listing.rb

@@ -2,11 +2,23 @@ class TracksListing < Listings::Base
 
   model Track
 
-  filter album: :name
+  # filter album: :name # this also works but will do a distinct over the mode
+  filter album: :name, values: :album_names
   filter album: :id, title: 'The Album Id' do |value|
     "#{value}!"
   end
   filter :order, render: false
+  filter :label, values: :label_values
+
+  def album_names
+    Album.order("name").pluck("distinct name").reject(&:nil?)
+  end
+
+  def label_values
+    res = ["red", "blue"]
+    res << params[:l] if params[:l]
+    res
+  end
 
   custom_filter :order_lte do |items, value|
     items.where('"order" <= ?', value.to_i)

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/models/track.rb

@@ -1,6 +1,6 @@
 class Track < ActiveRecord::Base
   belongs_to :album
-  attr_accessible :order, :title if Rails::VERSION::MAJOR == 3
+  attr_accessible :order, :title, :label if Rails::VERSION::MAJOR == 3
 
   scope :even, -> { where("#{table_name}.id % 2 = 0") }
 

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
 
@@ -31,10 +38,12 @@ ActiveRecord::Schema.define(:version => 20150611185922) do
     t.string   "title"
     t.integer  "order"
     t.integer  "album_id"
+    t.string   "label"
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   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,14 +1,22 @@
 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|
   FactoryGirl.create :album
 end
 
+LABELS = %w(Green Red Blue)
+
 (1..10).each do |sn|
-  FactoryGirl.create :track, album: nil
+  FactoryGirl.create :track, album: nil, label: LABELS[sn % LABELS.size]
 end

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.10
+  version: 0.1.15
 platform: ruby
 authors:
 - Brian J. Cardiff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -189,6 +189,7 @@ files:
 - lib/tasks/listings_tasks.rake
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
@@ -197,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
@@ -247,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
@@ -285,77 +291,83 @@ signing_key:
 specification_version: 4
 summary: Simple creation of listings in rails applications.
 test_files:
-- spec/spec_helper.rb
-- spec/dummy/app/listings/filtered_posts_listing.rb
-- spec/dummy/app/listings/posts_listing.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/posts_controller.rb
+- spec/dummy/app/controllers/welcome_controller.rb
+- 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/tracks_listing.rb
+- spec/dummy/app/listings/posts_listing.rb
 - spec/dummy/app/listings/tracks_fixed_order_listing.rb
-- spec/dummy/app/models/object_track.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/track.rb
+- spec/dummy/app/models/object_track.rb
 - spec/dummy/app/models/post.rb
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/welcome_controller.rb
-- spec/dummy/app/controllers/posts_controller.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/listings/_date.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/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
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/helpers/posts_helper.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/config/routes.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/environment.rb
 - spec/dummy/config/application.rb
-- spec/dummy/config/database.yml
 - spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/listings.rb
 - spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/initializers/listings.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
 - spec/dummy/config.ru
-- spec/dummy/spec
-- spec/dummy/script/rails
-- spec/dummy/Rakefile
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/404.html
-- spec/dummy/db/schema.rb
-- spec/dummy/db/seeds.rb
-- spec/dummy/db/migrate/20150611185922_create_tracks.rb
-- spec/dummy/db/migrate/20140728151246_add_category_to_post.rb
-- spec/dummy/db/migrate/20150611185824_create_albums.rb
 - spec/dummy/db/migrate/20130618143317_create_posts.rb
 - spec/dummy/db/migrate/20130618195559_add_author_to_posts.rb
-- spec/dummy/README.rdoc
-- spec/listings/tracks_listing_spec.rb
-- spec/listings/tracks_fixed_order_listing_spec.rb
-- spec/listings/posts_listing_spec.rb
-- spec/models/track_spec.rb
-- spec/models/post_spec.rb
-- spec/models/album_spec.rb
-- spec/support/query_counter.rb
+- spec/dummy/db/migrate/20140728151246_add_category_to_post.rb
+- spec/dummy/db/migrate/20150611185824_create_albums.rb
+- spec/dummy/db/migrate/20150611185922_create_tracks.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/seeds.rb
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/dummy/spec
 - 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/factories/traits.rb
 - spec/lib/filter_parser_spec.rb
 - spec/lib/sources/active_record_data_source_spec.rb
 - spec/lib/sources/object_data_source_spec.rb
+- spec/listings/posts_listing_spec.rb
+- spec/listings/tracks_fixed_order_listing_spec.rb
+- spec/listings/tracks_listing_spec.rb
+- spec/models/album_spec.rb
+- spec/models/post_spec.rb
+- spec/models/track_spec.rb
+- spec/spec_helper.rb
+- spec/support/query_counter.rb