greedo 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41e6db7010b9c6b8f6ae92d169ed8ae92ed39ab6dae893b3b8329e9607c66b4f
+  data.tar.gz: '082944928cb20ae268e60aa2e8a4b7c43d18fb50035d35093935dba9a558f042'
+SHA512:
+  metadata.gz: 792af4f3c7d45b7d371a49c08dfc411dc0d212366fe6851d85139e9d71a28fd02dd9fe9532c27275d84ef7ad5828a4248243fb62506b575b319c3914f09626c6
+  data.tar.gz: df4db7d6e7cd53ab6cee2144284f61e3be1e65f1bf23cf96f886fff5a32220ca867185c2e7919425be4b367850924b687250203648302d05131624b3fdd1145d

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version
+spec/dummy/log

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in greedo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Adam Pohorecki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Greedo
+
+A very simple helper for generating data tables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'greedo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install greedo
+
+## Usage
+
+After installing greedo, you can use the helper like this:
+
+```haml
+%h1 My first table
+
+= greedo(User.registered, per_page: 10) do |g|
+  = g.column :name
+  = g.column "Actions" do |user|
+    = link_to "Edit", edit_user_path(user)
+```
+
+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).
+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:
+
+```haml
+%h1 Table with class presenters
+
+= greedo(User.registered) do |g|
+  = g.presenter UserPresenter
+  = g.column :manager_name
+```
+
+or the same with a block:
+
+```haml
+%h1 Table with class presenters
+
+= greedo(User.registered) do |g|
+  - g.presenter do |record|
+    UserPresenter.new(record)
+  = g.column :manager_name
+```
+
+## Limitations
+
+This is a very simple helper for now - there's no sorting, or even any way to easily customize the generated HTML. This will change in time, but for now I'm open-sourcing this mainly to share this useful bit of code between projects.
+
+## TODO:
+
+Here's a couple of things I'm planning to add to this gem:
+
+* sorting by clicking on a column name
+* a generator to install the templates used by greedo in your project for ease of customization
+* making the paginator library swappable (greedo uses will_paginate now).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/greedo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

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

@@ -0,0 +1,28 @@
+- if grid.empty?
+  = grid.empty_message
+- else
+  %table.table.table-striped
+    %thead
+      %tr
+        - grid.headers.each do |header|
+          %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{class: column.klass}
+              = column.value
+
+- if grid.show_pagination?
+  = will_paginate grid.paginator.records, param_name: param_name,
+                                          params: path_params,
+                                          renderer: BootstrapPagination::Rails

data/greedo.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'greedo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "greedo"
+  spec.version       = Greedo::VERSION
+  spec.authors       = ["Adam Pohorecki"]
+  spec.email         = ["adam@pohorecki.pl"]
+  spec.summary       = %q{A very simple grid library}
+  spec.description   = %q{Shortens the syntax for creating tables}
+  spec.homepage      = "https://github.com/gunpowderlabs/greedo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-core"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "rails", "~> 4.2"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_dependency "haml"
+  spec.add_dependency "will_paginate"
+  spec.add_dependency "will_paginate-bootstrap"
+end

data/lib/greedo.rb

@@ -0,0 +1,15 @@
+require "haml"
+
+require "greedo/version"
+require "greedo/grid_helper"
+require "greedo/paginator"
+require "greedo/railtie"
+require "greedo/engine"
+
+module Greedo
+  def self.init
+    ActiveSupport.on_load(:action_view) do
+      ::ActionView::Base.send :include, Greedo::GridHelper
+    end
+  end
+end

data/lib/greedo/engine.rb

@@ -0,0 +1,4 @@
+module Greedo
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/greedo/grid_helper.rb

@@ -0,0 +1,180 @@
+module Greedo
+  module GridHelper
+    class Grid
+      attr_accessor :paginator
+      attr_reader :view_context, :fields, :presenter, :empty_message_text,
+        :order, :order_by, :path_params
+
+      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, 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, order, order_by, view_context, sort, path_params)
+        nil
+      end
+
+      def presenter(klass = nil, &block)
+        block = proc{|r| klass.new(r)} if klass
+        @presenter = block
+        nil
+      end
+
+      def present(record)
+        @presenter.call(record)
+      end
+
+      def rows
+        records.map do |record|
+          Row.new(record, @row_id, fields)
+        end
+      end
+
+      def headers
+        fields
+      end
+
+      def empty?
+        records.empty?
+      end
+
+      def show_pagination?
+        paginator.show?
+      end
+
+      def empty_message
+        view_context.content_tag(:p) { empty_message_text }
+      end
+
+      private
+
+      def records
+        paginator.records
+      end
+
+      def default_row_id(record)
+        snake_class = record.class.name.underscore.gsub("_", "-")
+        "#{snake_class}-#{record.id}"
+      end
+
+      Column = Struct.new(:value, :klass)
+
+      Row = Struct.new(:record, :row_id, :fields) do
+        def id
+          row_id.call(record)
+        end
+
+        def columns
+          fields.map{ |f| Column.new(f.value(record), f.klass) }
+        end
+      end
+
+      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: nil,
+               path_params: {},
+               order: params[:order],
+               order_by: params[:order_by],
+               &block)
+      grid = Grid.new(view_context: self,
+                      order: order,
+                      order_by: order_by,
+                      path_params: path_params)
+      grid.configure(&block)
+      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

@@ -0,0 +1,61 @@
+require "will_paginate"
+require "will_paginate-bootstrap"
+
+module Greedo
+  class Paginator
+    attr_reader :scope, :page, :per_page, :order, :order_by
+
+    def self.build(scope,
+                   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:, order: nil, order_by: nil)
+      @scope = scope
+      @page = page
+      @per_page = per_page
+      @order = order
+      @order_by = order_by
+    end
+
+    def records
+      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.length > per_page
+    end
+  end
+
+  class ArrayPaginator
+    attr_reader :order, :order_by
+
+    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