greedo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3640b00c249ab0f3ec46c9effc6ea1a760c65c6
+  data.tar.gz: 7a527cd406993f475c47b08473f2cec9c18dcbae
+SHA512:
+  metadata.gz: 642c57b5c69b8383670ad28aeea10255701c63f68d709b5b57b8f9ffe6f7dbfcd541b4b7e2c2ed842e8d1cc25a22477982a2d1ed6b6b719171814001617e72ea
+  data.tar.gz: bee6f1092985ca86be8e7bb09648324dd18bff12df13e2ad3bbc0bf413580e6f7aa0b2f0b302176e5cbb25d5a29a02f10cada07c864768a1355cbfc4b1f2d32f

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,54 @@
+# 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.
+
+## 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,17 @@
+- if grid.empty?
+  = grid.empty_message
+- else
+  %table.table.table-striped
+    %thead
+      %tr
+        - grid.headers.each do |header|
+          %th= header.label
+
+    %tbody
+      - grid.rows.each do |row|
+        %tr{id: row.id}
+          - row.columns.each do |column|
+            %td= column.value
+
+- if grid.show_pagination?
+  = will_paginate grid.paginator.records, param_name: param_name, 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"
+  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,96 @@
+module Greedo
+  module GridHelper
+    class Grid
+      attr_reader :paginator, :view_context, :fields
+
+      def initialize(paginator, view_context)
+        @paginator = paginator
+        @view_context = view_context
+        @row_id = ->(record) { default_row_id(record) }
+        @fields = []
+      end
+
+      def configure
+        yield self if block_given?
+      end
+
+      def row_id(&block)
+        @row_id = block
+        nil
+      end
+
+      def column(name, label: name.to_s.humanize, &block)
+        if block
+          renderer = ->(record) { view_context.capture(record, &block) }
+        else
+          renderer = ->(record) { record.public_send(name) }
+        end
+
+        fields << Field.new(name, label, renderer)
+        nil
+      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) { "No data to show." }
+      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)
+
+      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)) }
+        end
+      end
+
+      Field = Struct.new(:name, :label, :renderer) do
+        def value(record)
+          renderer.call(record)
+        end
+      end
+    end
+
+    def greedo(scope,
+               param_name: :page,
+               page: params.fetch(param_name) { 1 }.to_i,
+               per_page: 20,
+               &block)
+      paginator = Paginator.build(scope, page: page, per_page: per_page)
+      grid = Grid.new(paginator, self)
+      grid.configure(&block)
+      render partial: "greedo/grid", locals: {grid: grid, param_name: param_name}
+    end
+  end
+end

data/lib/greedo/paginator.rb

@@ -0,0 +1,42 @@
+require "will_paginate"
+require "will_paginate-bootstrap"
+
+module Greedo
+  class Paginator
+    attr_reader :scope, :page, :per_page
+
+    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)
+    end
+
+    def initialize(scope, page:, per_page:)
+      @scope = scope
+      @page = page
+      @per_page = per_page
+    end
+
+    def records
+      scope.paginate(page: page, per_page: per_page)
+    end
+
+    def show?
+      scope.count > per_page
+    end
+  end
+
+  class ArrayPaginator
+    attr_reader :records
+
+    def initialize(records)
+      @records = records
+    end
+
+    def show?
+      false
+    end
+  end
+end

data/lib/greedo/railtie.rb

@@ -0,0 +1,7 @@
+module Greedo
+  class Railtie < ::Rails::Railtie
+    initializer 'greedo' do |_app|
+      Greedo.init
+    end
+  end
+end

data/lib/greedo/version.rb

@@ -0,0 +1,3 @@
+module Greedo
+  VERSION = "0.0.1"
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

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

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end