greedo 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a89bac7cd8d24f99e8f427fdfa36cacd8b1f1d5b
-  data.tar.gz: c13b4badf51810de63f666cc1375ea9132b9798f
+SHA256:
+  metadata.gz: 41e6db7010b9c6b8f6ae92d169ed8ae92ed39ab6dae893b3b8329e9607c66b4f
+  data.tar.gz: '082944928cb20ae268e60aa2e8a4b7c43d18fb50035d35093935dba9a558f042'
 SHA512:
-  metadata.gz: 2ca476abd4c6d6b02a5f60db77e6eefeb99efa9695eb34ac81449c39eb5ffb31efbf17b8e402438bc9b87b1110bfa9ef7d5ed4bd52ee9408ff09d055f2efc876
-  data.tar.gz: 8b953f2160f9b37ca5ce3f15bb6f9eea5519fa04f7a8b4cc977876e352e82aecd35736b23b694f4c726e12e5f5121f9cbc9f786a327975cf239fdf484e5125cb
+  metadata.gz: 792af4f3c7d45b7d371a49c08dfc411dc0d212366fe6851d85139e9d71a28fd02dd9fe9532c27275d84ef7ad5828a4248243fb62506b575b319c3914f09626c6
+  data.tar.gz: df4db7d6e7cd53ab6cee2144284f61e3be1e65f1bf23cf96f886fff5a32220ca867185c2e7919425be4b367850924b687250203648302d05131624b3fdd1145d

data/README.md

@@ -30,9 +30,19 @@ After installing greedo, you can use the helper like this:
 ```
 
 This will create a data table with two columns, one labelled "Name" and the other "Actions".
-It will show 10 users from the given scope (which should either be an ActiveRecord::Relation or an Array). 
+It will show 10 users from the given scope (which should either be an ActiveRecord::Relation or an Array).
 Pagination will be added if necessary.
 
+### Custom empty message
+
+```haml
+%h1 My first table
+
+= greedo(User.registered, per_page: 10) do |g|
+  = g.custom_empty_message "There are no users in the database."
+  = g.column :name
+```
+
 ### Presenters
 
 You can wrap records in a class instance:

data/app/views/greedo/_grid.html.haml

@@ -5,13 +5,24 @@
     %thead
       %tr
         - grid.headers.each do |header|
-          %th= header.label
+          %th{class: header.klass}
+            .greedo-header
+              = header.label
+              - if header.sort
+                .greedo-order
+                  = link_to header.order_asc_path do
+                    %i.glyphicon{class: header.order_asc_class}
+                  = link_to header.order_desc_path do
+                    %i.glyphicon{class: header.order_desc_class}
 
     %tbody
       - grid.rows.each do |row|
         %tr{id: row.id}
           - row.columns.each do |column|
-            %td= column.value
+            %td{class: column.klass}
+              = column.value
 
 - if grid.show_pagination?
-  = will_paginate grid.paginator.records, param_name: param_name, renderer: BootstrapPagination::Rails
+  = will_paginate grid.paginator.records, param_name: param_name,
+                                          params: path_params,
+                                          renderer: BootstrapPagination::Rails

data/greedo.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-core"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "capybara"
-  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rails", "~> 4.2"
   spec.add_development_dependency "sqlite3"
 
   spec.add_dependency "haml"

data/lib/greedo/grid_helper.rb

@@ -1,33 +1,50 @@
 module Greedo
   module GridHelper
     class Grid
-      attr_reader :paginator, :view_context, :fields, :presenter
+      attr_accessor :paginator
+      attr_reader :view_context, :fields, :presenter, :empty_message_text,
+        :order, :order_by, :path_params
 
-      def initialize(paginator:, view_context:)
-        @paginator = paginator
+      def initialize(view_context:, order: nil, order_by: nil, path_params: nil)
         @view_context = view_context
         @row_id = ->(record) { default_row_id(record) }
         @fields = []
         @presenter = proc{|r| r}
+        @empty_message_text = "No data to show."
+        @order = order
+        @order_by = order_by
+        @path_params = path_params
       end
 
       def configure
         yield self if block_given?
       end
 
+      def custom_empty_message(empty_message_text)
+        @empty_message_text = empty_message_text
+        nil
+      end
+
+      def ordered_by
+        fields.find(&:ordered_by?) || Field.new
+      end
+
       def row_id(&block)
         @row_id = block
         nil
       end
 
-      def column(name, label: name.to_s.humanize, &block)
+      def column(name, label: name.to_s.humanize, sort: nil, &block)
+        if sort.nil? && name.is_a?(Symbol)
+          sort = name.to_s
+        end
         if block
           renderer = ->(record) { view_context.capture(present(record), &block) }
         else
           renderer = ->(record) { present(record).public_send(name) }
         end
 
-        fields << Field.new(name, label, renderer)
+        fields << Field.new(name, label, renderer, order, order_by, view_context, sort, path_params)
         nil
       end
 
@@ -60,7 +77,7 @@ module Greedo
       end
 
       def empty_message
-        view_context.content_tag(:p) { "No data to show." }
+        view_context.content_tag(:p) { empty_message_text }
       end
 
       private
@@ -74,7 +91,7 @@ module Greedo
         "#{snake_class}-#{record.id}"
       end
 
-      Column = Struct.new(:value)
+      Column = Struct.new(:value, :klass)
 
       Row = Struct.new(:record, :row_id, :fields) do
         def id
@@ -82,26 +99,82 @@ module Greedo
         end
 
         def columns
-          fields.map{ |f| Column.new(f.value(record)) }
+          fields.map{ |f| Column.new(f.value(record), f.klass) }
         end
       end
 
-      Field = Struct.new(:name, :label, :renderer) do
+      Field = Struct.new(:name, :label, :renderer, :order, :order_by,
+                         :view_context, :sort, :path_params) do
         def value(record)
           renderer.call(record)
         end
+
+        def klass
+          label.parameterize.underscore
+        end
+
+        def ordered_by?
+          order_by == name.to_s && %w(asc desc).include?(order)
+        end
+
+        def params
+          view_context.params.merge(path_params)
+        end
+
+        def order_desc_path
+          if ordered_by? && order == "desc"
+            view_context.url_for(params.merge(order: nil, order_by: nil))
+          else
+            view_context.url_for(params.merge(order: :desc, order_by: name))
+          end
+        end
+
+        def order_asc_path
+          if ordered_by? && order == "asc"
+            view_context.url_for(params.merge(order: nil, order_by: nil))
+          else
+            view_context.url_for(params.merge(order: :asc, order_by: name))
+          end
+        end
+
+        def order_desc_class
+          if ordered_by? && order == "desc"
+            "glyphicon-triangle-bottom"
+          else
+            "glyphicon-chevron-down"
+          end
+        end
+
+        def order_asc_class
+          if ordered_by? && order == "asc"
+            "glyphicon-triangle-top"
+          else
+            "glyphicon-chevron-up"
+          end
+        end
       end
     end
 
     def greedo(scope,
                param_name: :page,
                page: params.fetch(param_name) { 1 }.to_i,
-               per_page: 20,
+               per_page: nil,
+               path_params: {},
+               order: params[:order],
+               order_by: params[:order_by],
                &block)
-      paginator = Paginator.build(scope, page: page, per_page: per_page)
-      grid = Grid.new(paginator: paginator, view_context: self)
+      grid = Grid.new(view_context: self,
+                      order: order,
+                      order_by: order_by,
+                      path_params: path_params)
       grid.configure(&block)
-      render partial: "greedo/grid", locals: {grid: grid, param_name: param_name}
+      grid.paginator = Paginator.build(scope,
+                                       page: page,
+                                       per_page: (params[:per_page] || per_page || 20).to_i,
+                                       order_by: grid.ordered_by)
+      render partial: "greedo/grid", locals: {grid: grid,
+                                              param_name: param_name,
+                                              path_params: path_params}
     end
   end
 end

data/lib/greedo/paginator.rb

@@ -3,40 +3,59 @@ require "will_paginate-bootstrap"
 
 module Greedo
   class Paginator
-    attr_reader :scope, :page, :per_page
+    attr_reader :scope, :page, :per_page, :order, :order_by
 
     def self.build(scope,
-                   params: {},
-                   page: params.fetch(:page) { 1 }.to_i,
-                   per_page: params.fetch(:per_page) { 20 }.to_i)
-      return ArrayPaginator.new(scope) if scope.is_a?(Array)
-      Paginator.new(scope, page: page, per_page: per_page)
+                   page: 1,
+                   per_page: 20,
+                   order_by: nil)
+      return ArrayPaginator.new(scope, order_by.order, order_by.sort) if scope.is_a?(Array)
+      Paginator.new(scope, page: page, per_page: per_page,
+                    order: order_by.order, order_by: order_by.sort)
     end
 
-    def initialize(scope, page:, per_page:)
+    def initialize(scope, page:, per_page:, order: nil, order_by: nil)
       @scope = scope
       @page = page
       @per_page = per_page
+      @order = order
+      @order_by = order_by
     end
 
     def records
-      scope.paginate(page: page, per_page: per_page)
+      paginated = scope.paginate(page: page, per_page: per_page)
+      order_by_fields = [order_by].flatten.map { |field| "#{field} #{order}" }.join(", ")
+      order_by ? paginated.reorder(order_by_fields) : paginated
     end
 
     def show?
-      scope.count > per_page
+      scope.length > per_page
     end
   end
 
   class ArrayPaginator
-    attr_reader :records
+    attr_reader :order, :order_by
 
-    def initialize(records)
+    def initialize(records, order, order_by)
       @records = records
+      @order = order
+      @order_by = order_by
+    end
+
+    def records
+      @sorted_records ||= sort_records
     end
 
     def show?
       false
     end
+
+    private
+
+    def sort_records
+      sorted = order_by ? @records.sort_by { |r| r.send(order_by) } : @records
+
+      order == "desc" ? sorted.reverse : sorted
+    end
   end
 end

data/lib/greedo/version.rb

@@ -1,3 +1,3 @@
 module Greedo
-  VERSION = "0.0.2"
+  VERSION = "0.0.7"
 end

data/spec/greedo/grid_helper_spec.rb

@@ -13,12 +13,12 @@ RSpec.describe Greedo::GridHelper, type: :helper do
     create_project(name: "Foo")
 
     html = helper.greedo(Project.all) do |g|
-      g.column :id, label: "ID"
-      g.column :name
+      g.column :id, label: "ID", sort: false
+      g.column :name, sort: false
     end
 
-    expect(html).to include("<th>ID</th>")
-    expect(html).to include("<th>Name</th>")
+    expect(html).to include("ID")
+    expect(html).to include("Name")
   end
 
   it "renders values for each of the columns specified" do
@@ -26,8 +26,8 @@ RSpec.describe Greedo::GridHelper, type: :helper do
     bar = create_project(name: "Bar")
 
     html = helper.greedo(Project.all) do |g|
-      g.column :id, label: "ID"
-      g.column :name
+      g.column :id, label: "ID", sort: false
+      g.column :name, sort: false
     end
 
     expect(html).to include("Foo")
@@ -40,7 +40,7 @@ RSpec.describe Greedo::GridHelper, type: :helper do
     create_project(name: "Foo")
 
     html = helper.greedo(Project.all) do |g|
-      g.column :name do |p|
+      g.column "Name" do |p|
         p.name.upcase
       end
     end
@@ -86,8 +86,8 @@ RSpec.describe Greedo::GridHelper, type: :helper do
     bar = create_project(name: "Bar")
 
     html = helper.greedo(Project.all) do |g|
-      g.column :id
-      g.column :name
+      g.column :id, sort: false
+      g.column :name, sort: false
     end
 
     expect(html).to have_selector("tr#project-#{foo.id}")
@@ -100,8 +100,8 @@ RSpec.describe Greedo::GridHelper, type: :helper do
 
     html = helper.greedo(Project.all) do |g|
       g.row_id { |p| "asdf-#{p.id}" }
-      g.column :id
-      g.column :name
+      g.column :id, sort: false
+      g.column :name, sort: false
     end
 
     expect(html).to have_selector("tr#asdf-#{foo.id}")
@@ -127,7 +127,7 @@ RSpec.describe Greedo::GridHelper, type: :helper do
 
     html = helper.greedo(Project.all) do |g|
       g.presenter ProjectPresenter
-      g.column :author
+      g.column :author, sort: false
     end
 
     expect(html).to include("No Author")
@@ -141,7 +141,7 @@ RSpec.describe Greedo::GridHelper, type: :helper do
         record.name
       end
 
-      g.column :length
+      g.column :length, sort: false
     end
 
     expect(html).to include("3")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: greedo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Adam Pohorecki
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,16 +84,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -223,7 +223,7 @@ homepage: https://github.com/gunpowderlabs/greedo
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -238,9 +238,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: A very simple grid library
 test_files: