html_tables 0.0.1

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.rbc
+.*
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fábio D. Batista
+
+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,42 @@
+# html_tables
+
+This gem was extracted from some projects on my company. Everyone is welcome to use and improve upon.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'html_tables'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html_tables
+
+## Usage
+
+HAML example:
+
+    = data_table_for(@products, name: :products_table) do |t|
+      - t.column(:code, align: :center, width: '9em')
+      - t.column(:description) { |p| p.descriptions.first }
+      - t.column(:pricing)
+      - t.column(:quantity, width: '9em') do |p|
+        - if p.quantity == 0
+          %span.label.label-important.stack-right(title = 'Out of stock')
+            %i.icon-flag.icon-white
+        - else
+          .c= number_with_delimiter p.quantity
+      - t.column(:situation, align: :center, width: '9em')
+      - t.nodata 'No product found.'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/html_tables.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/html_tables/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Fábio David Batista"]
+  gem.email         = ["fabio@elementarsistemas.com.br"]
+  gem.description   = %q{Simple DSL for HTML data tables}
+  gem.summary       = %q{This gem was extracted from some projects on my company. Everyone is welcome to use and improve upon.}
+  gem.homepage      = "http://elementarsistemas.com.br/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "html_tables"
+  gem.require_paths = ["lib"]
+  gem.version       = HtmlTables::VERSION
+
+  gem.add_dependency 'i18n'
+  gem.add_dependency 'actionpack'
+  gem.add_dependency 'railties'
+  gem.add_dependency 'activerecord'
+end

data/lib/html_tables.rb

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+
+require 'html_tables/version'
+
+require 'html_tables/format_for_output'
+require 'html_tables/yielded_object'
+require 'html_tables/data_table'
+require 'html_tables/data_table_helper'
+require 'html_tables/railtie' if defined?(Rails::Railtie)

data/lib/html_tables/data_table.rb

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+
+module HtmlTables
+  class DataTable
+    attr_reader :collection, :options, :row_classes
+    attr_accessor :nodata_message, :item_url_block
+
+    def initialize(builder, collection, options = { })
+      @builder = builder
+      @collection = collection
+      @options = options
+      @row_classes = []
+    end
+
+    def auto_generate_columns!
+      model.accessible_attributes.each do |attr|
+        col = model_columns[attr]
+        object_to_yield.column col.name unless col.nil?
+      end
+    end
+
+    def model
+      @model ||= collection.model_name.constantize if collection.respond_to?(:model_name)
+      @model ||= collection.first.try(:class)
+      @model ||= options[:name].to_s.singularize.constantize
+    end
+
+    def model_columns
+      @model_columns ||= ActiveSupport::HashWithIndifferentAccess[*model.columns.map { |c| [c.name, c] }.flatten]
+    end
+
+    def object_to_yield
+      @ctl ||= YieldedObject.new(self)
+    end
+
+    def columns
+      @columns ||= ActiveSupport::OrderedHash.new
+    end
+
+    def header_for(column_id)
+      return nil if column_id.nil?
+      return columns[column_id][:header] if columns[column_id][:header]
+      return @builder.content_tag(:i, nil, class: 'icon-check') if columns[column_id][:checkbox]
+      v ||= I18n.t(column_id, scope: [:tables, options[:name] || :default], raise: true) rescue nil
+      v ||= I18n.t(column_id, scope: [:tables, :default], raise: true) rescue nil
+      v ||= I18n.t(column_id, scope: [:activerecord, :attributes, model.model_name.underscore], raise: true) rescue nil
+      v ||= model_columns[column_id].human_name rescue nil
+
+      v || column_id.to_s.humanize
+    end
+
+    def url_for(item)
+      (item_url_block.call(item) unless item_url_block.nil?) || @builder.url_for(item) rescue nil
+    end
+
+    def row_options_for(item)
+      h = { }
+
+      url = self.url_for(item)
+      h[:data] = { url: url } if url
+
+      classes = []
+      self.row_classes.each do |cls, opts|
+        next if opts[:if] && !test(item, &opts[:if])
+        next if opts[:unless] && test(item, &opts[:unless])
+        classes << cls
+      end
+
+      h[:class] = classes.uniq * ' ' unless classes.empty?
+
+      h
+    end
+
+    def test(item)
+      yield item
+    end
+  end
+end

data/lib/html_tables/data_table_helper.rb

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+
+module HtmlTables
+  module DataTableHelper
+    def data_table_for(collection, options = {})
+      t = DataTable.new(self, collection, options)
+      if block_given?
+        yield t.object_to_yield
+      else
+        t.auto_generate_columns!
+      end
+
+      cls = %w(table table-striped table-bordered)
+      cls << 'table-condensed' if options[:condensed]
+      content_tag(:table, class: cls) do
+        content_tag(:caption, options[:caption] || controller_name, class: ('hidden' unless options[:caption])) +
+        content_tag(:colgroup) do
+          b = ''.html_safe
+          t.columns.each do |_, opts|
+            col_opts = { }
+            col_opts[:style] = "width: #{opts[:width]}" if opts[:width]
+            b << content_tag(:col, col_opts) { }
+          end
+          b
+        end +
+        content_tag(:thead) do
+          content_tag(:tr) do
+            t.columns.map do |name, opts|
+              header_opts = {}
+              header_opts[:class] = 'check' if opts[:checkbox]
+              header_opts[:header_title] = opts[:header_title] if opts[:header_title]
+              content_tag(:th, t.header_for(name), header_opts)
+            end.join.html_safe
+          end
+        end +
+        content_tag(:tbody) do
+          b = ''.html_safe
+          if collection.each do |item|
+            b << content_tag(:tr, t.row_options_for(item)) do
+              t.columns.map do |name, opts|
+                render_td(item, name, opts)
+              end.join.html_safe
+            end
+          end.size == 0 then
+            b << content_tag(:tr, class: 'nodata') do
+              content_tag(:td, colspan: t.columns.size) { t.nodata_message }
+            end unless t.nodata_message.nil?
+          end
+          b
+        end
+      end
+    end
+
+    def render_td(item, column, opts)
+      td_options = {}
+
+      if opts[:align] == :center
+        td_options[:class] = 'c'
+      end
+
+      if opts[:title]
+        td_options[:title] = if opts[:title].respond_to?(:call)
+          opts[:title].call(item)
+        else
+          opts[:title].to_s
+        end
+      end
+
+      v = if opts[:checkbox]
+        checked = nil
+        checked = opts[:block].call(item) if opts[:block]
+        ck_opts = opts.select { |k, _| [:disabled].include?(k) }
+        check_box_tag "#{column}[]", item.id, checked, ck_opts
+      elsif opts[:radio]
+        radio_button_tag "#{column}[]", item.id
+      elsif opts[:block]
+        capture(item, &opts[:block])
+      else
+        tmp = item.send(column)
+        tmp = item.send("#{column}_text") rescue tmp if tmp.is_a?(Symbol)
+        tmp
+      end
+
+      if ::Rails.env.development? && v.is_a?(ActiveRecord::Base)
+        btn = content_tag(:div, class: 'entity-shortcut') do
+          link_to(url_for(v), class: 'btn btn-small') do
+            content_tag(:i, nil, class: 'icon-share')
+          end
+        end rescue nil
+      end
+
+      v = if v.is_a?(Enumerable)
+        v.inject(''.html_safe) { |b, i| b << ', ' unless b.blank?; b << i.format_for_output }
+      else
+        v.format_for_output
+      end
+      v = v.to_s unless v.nil? || v.is_a?(String)
+
+      v = ''.html_safe << btn << v if btn
+
+      content_tag(:td, v, td_options)
+    end
+  end
+end

data/lib/html_tables/format_for_output.rb

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+
+module HtmlTables
+  module FormatForOutput
+    def format_for_output
+      case self
+        when Date, Time, DateTime
+          I18n.l(self, format: :short)
+        when ActiveRecord::Base
+          self.to_label(:short)
+        when TrueClass, FalseClass
+          I18n.t(self.to_s)
+        else
+          self
+      end
+    end
+  end
+end
+
+Object.send(:include, HtmlTables::FormatForOutput)

data/lib/html_tables/railtie.rb

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+
+module HtmlTables
+  class Railtie < Rails::Railtie
+    initializer "html_tables.view_helpers" do
+      ActionView::Base.send :include, DataTableHelper
+    end
+  end
+end

data/lib/html_tables/version.rb

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+module HtmlTables
+  VERSION = "0.0.1"
+end

data/lib/html_tables/yielded_object.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+module HtmlTables
+  class YieldedObject
+    attr_reader :t
+
+    def initialize(data_table)
+      @t = data_table
+    end
+
+    # Adds a checkbox column to the DataTable.
+    # If a block is supplied, it is used to determine the initial state of the checkbox.
+    def checkbox(id = nil, options = { }, &block)
+      options[:block] = block if block_given?
+      t.columns[id] = options.reverse_merge! checkbox: true, align: :center
+    end
+
+    # Adds a radio button column to the DataTable.
+    def radio(id = nil, options = { })
+      t.columns[id] = options.reverse_merge! radio: true, align: :center
+    end
+
+    # Adds a regular column to the DataTable.
+    def column(id, options = { }, &block)
+      options[:block] = block if block_given?
+      t.columns[id] = options
+      nil
+    end
+
+    # Sets the 'no-data' message. If not set, no message will be displayed when there's no records to show.
+    def nodata(msg)
+      t.nodata_message = msg
+      nil
+    end
+
+    def item_url(&block)
+      t.item_url_block = block
+      nil
+    end
+
+    def row_class(cls, options = { })
+      t.row_classes << [cls, options]
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: html_tables
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fábio David Batista
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple DSL for HTML data tables
+email:
+- fabio@elementarsistemas.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- html_tables.gemspec
+- lib/html_tables.rb
+- lib/html_tables/data_table.rb
+- lib/html_tables/data_table_helper.rb
+- lib/html_tables/format_for_output.rb
+- lib/html_tables/railtie.rb
+- lib/html_tables/version.rb
+- lib/html_tables/yielded_object.rb
+homepage: http://elementarsistemas.com.br/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem was extracted from some projects on my company. Everyone is welcome
+  to use and improve upon.
+test_files: []