greentable 0.0.4 → 0.0.5

data/README.md

@@ -1,39 +1,169 @@
-#todo
-assets/greentable.css
-
-greentable
+Greentable
 ==========
 
-Rails declarative html tables with export (xls,csv) features.
+Rails declarative html tables with export (csv,xls,pdf,xml) features.
+
+Please note that the export module is still under development.
 
-This is still under development. check back on Sept 15th 2013
+Tested on rails 3.2, using ruby 1.9.3
 
-### Installation
+## Installation
+```ruby
 gem 'greentable'
+```
+
+## Usage
+The Greentable gem provides two methods only. To produce a table from an array of elements, do the following in a view:
+
+```haml
+=greentable(users) do |gt,user|
+  - gt.col('NAME') do
+    =user.name
+  - gt.col('EMAIL') do
+    =user.email
+```
+
+which will produce the following html:
+
+```html
+<table>
+    <thead>
+        <tr>
+          <th>NAME</th>
+          <th>EMAIL</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>Joe Ruby</td>
+            <td>jruby@example.com</td>
+        </tr>
+        <tr>
+            <td>Donald Rails</td>
+            <td>drails@example.com</td>
+        </tr>
+    </tbody>
+</table>
+```
+
+## Optional Options
+
+Both greentable and greentable.col may be called with an optional hash
+
+```haml
+=greentable(array, class: 'a', style: 'b:c', tr: {class: 'd'}, th: {onclick: 'e();'}, td: {'data-target' => 'f'} ) do |gt, el|
+  -gt.col('Col 1', class: 'g', th: {class: 'h'}) do
+    = el.col1
+  -gt.col('Col 2') do
+    = el.col2
+```
+
+will produce
+
+```html
+<table class='a' style='b:c'>
+    <thead>
+        <tr class='d'>
+          <th class='h' onclick='e();'>Col 1</th>
+          <th onclick='e();'>Col 2</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr class='d'>
+            <td class='g' data-target='f'>...</td>
+            <td data-target='f'>...</td>
+        </tr>
+    </tbody>
+</table>
+```
+
+If you need column names or options to be a little more dynamic, you can use procs:
+
+```haml
+=greentable(years) do |gt,year|
+  -gt.col('Year') do
+    =year.to_s
+  -4.times do |week|
+    -gt.col(Proc.new{ week % 2 == 0 ? 'An even week' : 'An odd week' }, td: {style: Proc.new{ year % 2 == 1 ? 'background-color:red' : nil }} ) do
+      =week
+```
+
+will produce
+
+```html
+<table>
+    <thead>
+        <tr>
+          <th>Year</th>
+          <th>An even week</th>
+          <th>An odd week</th>
+          <th>An even week</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>2013</td>
+            <td>0</td>
+            <td style='background-color:red'>1</td>
+            <td>2</td>
+            <td style='background-color:red'>3</td>
+        </tr>
+        <tr>
+            <td>2014</td>
+            <td>0</td>
+            <td style='background-color:red'>1</td>
+            <td>2</td>
+            <td style='background-color:red'>3</td>
+        </tr>
+        ...
+    </tbody>
+</table>
+```
+
+
+## Global Defaults
+You can configure global defaults for all your greentables.
+
+In config/initializers/greentable.rb
 
-### Usage
-blbabl
 ```ruby
-bla.bla()
+Greentable.configure do |config|
+  config.defaults = {class: 'myTableClass', tr: {class: 'myTrClass'}, th: {style: 'cursor:pointer'}, td: {class: 'pi', onclick: 'alert(3.14159265359)'}}
+end
+```
+
+and in some view:
+
+```erb
+<%= greentable([3.14]) do |gt,element| %>
+    <%  gt.col('First Column') do %>
+        <%= element %>
+    <% end %>
+<% end %>
+```
+
+will produce
+
+```html
+<table class='myTableClass'>
+    <thead>
+        <tr class='myTrClass'>
+          <th style='cursor:pointer'>First Column</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr class='myTrClass'>
+            <td class='pi' onclick='alert(3.14159265359)'>3.14</td>
+        </tr>
+    </tbody>
+</table>
 ```
-bla2
 
-### Subrows
-display_on = first | last | all
+## Green Export
 
-### Export Features
-extend with a plugin
-### Options
+Greentable enables you to export your greentable data for download in various formats seamlessly by a rack middleware.
 
-greentable records, class: 'listtable', tr: {...}, th: {...}, td: {...} do |gt, r|
 
-####greentable
-show_empty
-export
-media skip (?)
+[export still under development. more soon]
 
-### Special Query Parameters
-greentable_export
-greentable_id
-greentable_export_filename
 

data/greentable.gemspec

@@ -1,10 +1,11 @@
 Gem::Specification.new do |s|
   s.name        = "greentable"
-  s.version     = "0.0.4"
+  s.version     = "0.0.5"
   s.author      = "Wael Chatila"
   s.homepage    = "https://github.com/waelchatila/greentable"
   s.summary     = "Rails declarative html tables with export features"
   s.description = "Rails declarative html tables with export features"
+  s.license = 'LGPLv3+'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/greentable/configuration.rb

@@ -0,0 +1,18 @@
+module Greentable
+  class Configuration
+    attr_accessor :defaults
+
+    def initialize
+      @defaults = {}
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+end

data/lib/greentable/greentable_table.rb

@@ -1,3 +1,4 @@
+require 'greentable/configuration'
 require 'greentable/greentable_counter'
 
 module Greentable
@@ -6,16 +7,15 @@ module Greentable
     def initialize(parent, records, opts)
       @parent = parent
       @records = records
-      @opts_tr = opts.delete(:tr) || {}
-      @opts_td = opts.delete(:td) || {}
-      @opts_th = opts.delete(:th) || {}
-      @opts = opts
+      defaults = Greentable.configuration.defaults.clone rescue {}
+      @defaults_tr = (defaults.delete(:tr) || {}).deep_merge(opts.delete(:tr) || {})
+      @defaults_th = (defaults.delete(:th) || {}).deep_merge(opts.delete(:th) || {})
+      @defaults_td = (defaults.delete(:td) || {}).deep_merge(opts.delete(:td) || {})
+      @opts = defaults.deep_merge(opts)
 
       @tr_attributes = []
-
       @th_attributes = []
       @th_html = []
-
       @td_attributes = []
       @td_html = []
 
@@ -29,10 +29,11 @@ module Greentable
 
     def col(th = nil, opts = {}, &block)
       @th_html[@current_col] = th
+      @th_attributes[@current_col] = opts.delete(:th) || {}
+      @td_attributes[@current_col] = opts
 
       @td_html[@row_counter.i] ||= []
       @td_html[@row_counter.i][@current_col] = @parent.capture(&block)
-      @td_attributes[@row_counter.i] = opts
 
       @current_col += 1
       return nil
@@ -54,8 +55,8 @@ module Greentable
       unless @th_html.compact.empty?
         ret << "<thead>"
         ret << "<tr>"
-        @th_html.each do |th|
-          ret << "<th#{do_attributes(@opts_th)}>#{th.is_a?(Proc) ? th.call.to_s : th}</th>"
+        @th_html.each_with_index do |th,i|
+          ret << "<th#{do_attributes(@th_attributes[i])}>#{th.is_a?(Proc) ? th.call.to_s : th}</th>"
         end
         ret << "</tr>"
         ret << "</thead>"
@@ -63,9 +64,9 @@ module Greentable
       ret << "<tbody>"
 
       @row_counter.i.times do |i|
-        ret << "<tr#{do_attributes(@opts_tr.merge(@tr_attributes[i]||{}))}>"
+        ret << "<tr#{do_attributes(@defaults_tr.deep_merge(@tr_attributes[i]||{}))}>"
         @td_html[i].each do |td|
-          ret << "<td#{do_attributes(@opts_td.merge(@td_attributes[i]||{}))}>#{td}</td>"
+          ret << "<td#{do_attributes(@defaults_td.deep_merge(@td_attributes[i]||{}))}>#{td}</td>"
         end
         ret << "</tr>"
       end
@@ -80,5 +81,6 @@ module Greentable
       ret = " " + ret unless ret.empty?
       return ret
     end
+
   end
 end

data/lib/greentable.rb

@@ -1,8 +1,5 @@
+
 module Greentable
   require 'greentable/railtie' if defined?(Rails)
-
-  class << self
-
-  end
-
+  require 'greentable/configuration'
 end

data/todo.txt

@@ -0,0 +1,8 @@
+* subrows. display_on = first | last | all
+* export plugins
+* greentable options: export, media skip (?)
+* Special Query Parameters
+    greentable_export
+    greentable_id
+    greentable_export_filename
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: greentable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-14 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -54,13 +54,16 @@ files:
 - Rakefile
 - greentable.gemspec
 - lib/greentable.rb
+- lib/greentable/configuration.rb
 - lib/greentable/export.rb
 - lib/greentable/greentable_counter.rb
 - lib/greentable/greentable_table.rb
 - lib/greentable/railtie.rb
 - lib/greentable/view_helpers.rb
+- todo.txt
 homepage: https://github.com/waelchatila/greentable
-licenses: []
+licenses:
+- LGPLv3+
 post_install_message: 
 rdoc_options: []
 require_paths: