tablematic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c7e31de7aad761a0668517eb443ffd019b4251e
+  data.tar.gz: e0fc8ad8f5c9a0bf563f291bfca9b0a0c9866c11
+SHA512:
+  metadata.gz: bd67f2907fc0d539fdfd52a666a921497f6b6b20b64cc01ff9f504c622c016a393ff6b9d134a2f1f6f3de5fe4093c75bd8b35aad5e9abc1efc1fe9388a3e4a47
+  data.tar.gz: c9e993d9ade0999ea19be71cbd790f6a64411f1134723a2e2ecc09f6ac2c35d7a1f5f239235066bec4b89f3eb7291a59596a40fca7078fe02d2c207ae6e3a5d1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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.rdoc

@@ -0,0 +1,193 @@
+# Tablematic
+
+## Introduction
+There are a bunch of other Rails table generators out there. This is mine.
+
+Tabletastic is a gem to help quickly emit tabular data in a Rails web
+view. I created it because 1) I found myself doing this all the time, and
+it seemed like I could make it generic and package it as a gem, and 2)
+companies always want to see open source code samples when you apply
+for jobs, so it made sense to create some!
+
+## Installation
+(Eventually, when I put this on rubygems) in your Rails project, Gemfile:
+  gem "tablematic"
+
+## Usage
+The simplest use of tablematic is to invoke the helper method with a
+variable that contains a collection of ActiveRecord objects, thusly:
+
+```erb
+<%= table_for(@posts) %>
+```
+
+Let's say you have a table named posts, and it contains the following
+data:
+
+
+|id|created_at|updated_at|added_by     |title          |content|
+|--|----------|----------|-------------|---------------|-------|
+| 1|2015-08-06|2015-08-06|Lisa Marie   |Elvis had a Twin|On January 8, 1935, Elvis Aron (later spelled Aaron) Presley was born at his parents' two-room house in East Tupelo, Mississippi, about 35 minutes after his identical twin brother, Jesse Garon, who was stillborn.|
+| 2|2015-08-06|2015-08-06|Priscilla    |Graceland       |In 1957, when he was just 22, Elvis shelled out $102,500 for Graceland, the Memphis mansion that served as his home base for two decades.|
+| 3|2015-08-06|2015-08-06|Elvis Himself|Col. Tom Barker |Elvis's future manager immigrated illegally to America as a young man, where he reinvented himself as Tom Parker and claimed to be from West Virginia. He worked as a pitchman for traveling carnivals, followed by stints as dog catcher and pet cemetery founder, among other occupations, then managed the careers of several country music singers.|
+
+_Note: Check the unit tests for more Elvis Facts(tm)_
+
+Calling table_for on the table above would generate a table that looks like this:
+
+```html
+<table class=' tablematic'>
+  <thead>
+    <tr>
+      <th class='id integer'>Id</th>
+      <th class='created_at datetime'>Created at</th>
+      <th class='updated_at datetime'>Updated at</th>
+      <th class='added_by string'>Added by</th>
+      <th class='title string'>Title</th>
+      <th class='content text'>Content</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class='even'>
+      <td class='id integer'>1</td>
+      <td class='created_at datetime'>2015-08-06 12:04:05 UTC</td>
+      <td class='updated_at datetime'>2015-08-06 12:04:05 UTC</td>
+      <td class='added_by string'>Lisa Marie</td>
+      <td class='title string'>Elvis had a Twin</td>
+      <td class='content text'>On January 8, 1935, Elvis Aron (later spelled Aaron) Presley was born at his parents’ two-room house in East Tupelo, Mississippi, about 35 minutes after his identical twin brother, Jesse Garon, who was stillborn.</td>
+    </tr>
+    <tr class='odd'>
+      <td class='id integer'>2</td>
+      <td class='created_at datetime'>2015-08-06 12:04:05 UTC</td>
+      <td class='updated_at datetime'>2015-08-06 12:04:05 UTC</td>
+      <td class='added_by string'>Priscilla</td>
+      <td class='title string'>Graceland</td>
+      <td class='content text'>In 1957, when he was just 22, Elvis shelled out $102,500 for Graceland, the Memphis mansion that served as his home base for two decades.</td>
+    </tr>
+    <tr class='even'>
+      <td class='id integer'>3</td>
+      <td class='created_at datetime'>2015-08-06 12:04:05 UTC</td>
+      <td class='updated_at datetime'>2015-08-06 12:04:05 UTC</td>
+      <td class='added_by string'>Elvis Himself</td>
+      <td class='title string'>Col. Tom Barker</td>
+      <td class='content text'>Elvis’s future manager immigrated illegally to America as a young man, where he reinvented himself as Tom Parker and claimed to be from West Virginia. He worked as a pitchman for traveling carnivals, followed by stints as dog catcher and pet cemetery founder, among other occupations, then managed the careers of several country music singers.</td>
+    </tr>
+  </tbody>
+</table> 
+```
+
+Interesting stuff above:
+* It auto-generates odd/even classes on the rows in case you want to use them for styling
+* It also includes the parameter name and datatype on each column in case that's useful for styling (e.g., you might want to make integers align right).
+* Tables have the tablematic class by default.
+
+### Customizing output
+The defaults are probably not exactly what you need, so you can tweak things as needed by
+supplying options in an hash as the second parameter to table_for. Here are some of the
+supported options:
+
+#### table_class:
+A string or array of strings to use as class name(s) on the table. This is handy if you're
+using a CSS framework like bootstrap:
+
+```erb
+<%= table_for(@posts, table_class: 'table table-condensed') %>
+```
+
+yields
+
+```html
+<table class="tablematic table table-condensed">
+...
+```
+
+#### attributes:
+Limits the output to only those attributes included in the array. E.g.,
+
+```erb
+<%= table_for(@posts, attributes: [:title, :content]) %>
+```
+
+You can also specify the column header names this way by making the
+array elements into hashes where the key is the attribute name and
+the value is the title:
+
+```erb
+<%= table_for(@posts, attributes: [{title: 'A cool title'}, {content: 'Awesome content'}]) %>
+```
+
+### Code Blocks for additional per-row output
+Let's say you want to include links to Edit or Delete actions on each row along
+with the table values. Anything that is supplied in a block to the table_for
+method will be appended to the end of each row that is generated. For example, 
+
+```erb
+<% table_for(@posts) do |post| %>
+  <td><%= link_to "Edit", edit_post_path(post) %></td>
+<% end %>
+```
+
+will generate the following:
+
+```html
+<table class=' tablematic'>
+  <thead>
+    <tr>
+      <th class='id integer'>Id</th>
+      <th class='created_at datetime'>Created at</th>
+      <th class='updated_at datetime'>Updated at</th>
+      <th class='added_by string'>Added by</th>
+      <th class='title string'>Title</th>
+      <th class='content text'>Content</th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class='even'>
+      <td class='id integer'>1</td>
+      <td class='created_at datetime'>2015-08-06 12:04:05 UTC</td>
+      <td class='updated_at datetime'>2015-08-06 12:04:05 UTC</td>
+      <td class='added_by string'>Lisa Marie</td>
+      <td class='title string'>Elvis had a Twin</td>
+      <td class='content text'>On January 8, 1935, Elvis Aron (later spelled Aaron) Presley was born at his parents’ two-room house in East Tupelo, Mississippi, about 35 minutes after his identical twin brother, Jesse Garon, who was stillborn.</td>
+      <td><a href="/posts/1/edit">Edit</a></td>
+    </tr>
+...
+```
+
+### Global Configuration
+Right now there's only one option you can configure globally - I'm working
+on that. Here's how you do it - in an initializer, plop the following code:
+
+```ruby
+Tablematic.configure do |config|
+  config.table_class = 'table table-condensed'    
+end
+```
+
+This will make the default CSS classes on every generated table include the
+table and table-condensed classes, so you don't have to specify it explicitly
+everywhere you use the helper.
+
+## TODO
+* Upload to rubygems and become FOSS famous.
+* Setup TravisCI
+* Change string additions to use << instead because string addition is expensive (or better yet use content_tag).
+* An exclude option to easily exclude columns, including at the global level.
+* Integration specs for better testing w/ Rails.
+* Maybe it'd be cool to have optional footers with totals? Might be wonky w/ pagination.
+* A way to specify column headings when you're including additional stuff in a block.
+* A way to specify that generate class names should use hyphens instead of underscores
+* Configurable class namespaces, some of that stuff is already there just haven't finished it.
+* Make it work w/ regular old arrays of hashes as well as AR.
+
+## Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add specs for it.
+* Commit.
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+Copyright 2015 Mike Desjardins. See MIT-LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tablematic'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/tablematic/builder.rb

@@ -0,0 +1,69 @@
+module TableHelper
+  class TableBuilder
+    def initialize(records, attr, opts={})
+      @records = records
+      @attr = attr
+      @model = @records.first.class
+      @namespace = opts.fetch(:namespace,'')
+      @config = Tablematic.configuration
+      @opts = opts
+    end
+
+    def build(view_context, &block)
+      result = "<table class='#{table_classes}'>"
+      result += emit_html_heading
+      result += emit_html_rows(view_context, &block)
+      result += "</table>"
+      result.html_safe
+    end
+
+    def output_buffer=(other)
+    end
+
+    protected
+
+    def column_heading_for(attribute)
+      return attribute.values.first if attribute.is_a?(Hash)
+      return attribute.to_s.humanize
+    end
+
+    def emit_html_heading
+      result = "<thead><tr>"
+      @attr.each do |attribute|
+        result += "<th class='#{attribute_css_class(attribute)} #{attribute_type_css_class(attribute)}'>#{column_heading_for(attribute)}</th>"
+      end
+      result += "</tr></thead>"
+    end
+
+    def emit_html_rows(view_context, &block)
+      result = "<tbody>"
+      @records.each_with_index do |record,i|
+        odd_even = i % 2 == 0 ? "#{@namespace}even" : "#{@namespace}odd"
+        result += "<tr class='#{odd_even}'>"
+        append_to_rows = block_given? ? view_context.capture(record, &block) : ''
+        @attr.each do |attribute|
+          message = attribute.is_a?(Hash) ? attribute.keys.first.to_sym : attribute.to_sym
+          value = record.send(message).to_s
+          result += "<td class='#{attribute_css_class(attribute)} #{attribute_type_css_class(attribute)}'>#{value}</td>"
+        end
+        result += append_to_rows
+        result += "</tr>"
+      end
+      result += "</tbody>"
+    end
+
+    def attribute_css_class(attribute_name)
+      "#{@namespace}#{attribute_name.to_s.parameterize.underscore}"
+    end
+
+    def attribute_type_css_class(attribute_name)
+      column = @model.columns_hash[attribute_name.to_s]
+      "#{@namespace}#{column.type.to_s.parameterize.underscore}" if column
+    end
+
+    def table_classes
+      css_classes = @opts.fetch(:table_class, @config.table_class)
+      ([] << css_classes << 'tablematic').flatten.join(' ')
+    end
+  end
+end

data/lib/tablematic/configuration.rb

@@ -0,0 +1,8 @@
+class Configuration
+  attr_accessor :exclude, :table_class
+
+  def initialize
+    @exclude = []
+    @table_class = ''
+  end
+end

data/lib/tablematic/helper.rb

@@ -0,0 +1,12 @@
+require 'action_view'
+
+module TableHelper
+  def table_for(records, options={}, &block)
+    attr = options[:attributes] || records.first.attribute_names
+    concat TableBuilder.new(records, attr, options).build(self, &block)
+  end
+end
+
+ActionView::Base.class_eval do
+  include TableHelper
+end

data/lib/tablematic/version.rb

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

data/lib/tablematic.rb

@@ -0,0 +1,16 @@
+require 'tablematic/helper'
+require 'tablematic/builder'
+require 'tablematic/configuration'
+
+module Tablematic
+  def self.configure
+    # raise Error::AlreadyConfigured unless @configuration.nil?
+
+    @configuration = Configuration.new
+    yield(@configuration)
+  end
+
+  def self.configuration
+    return @configuration || Configuration.new
+  end
+end

data/lib/tasks/tablematic_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tablematic do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: tablematic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Desjardins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates tables from AR collections.
+email:
+- mike.desjardins@cereslogic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/tablematic.rb
+- lib/tablematic/builder.rb
+- lib/tablematic/configuration.rb
+- lib/tablematic/helper.rb
+- lib/tablematic/version.rb
+- lib/tasks/tablematic_tasks.rake
+homepage: http://www.github.com/mdesjardins/tablematic
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generates tables from AR collections.
+test_files: []