tableview 0.2.0 → 0.3.0

data/README.md

@@ -16,42 +16,36 @@ In your Gemfile:
 then
 
     $ bundle install
+    $ rails g tableview:install
      
-Create a file in `/lib/application_responder.rb` with:
+To apply to a resource use the built in generator:
 
-    class ApplicationResponder < ActionController::Responder
-      include Tableview::Responder
-    end
-    
-Then add this to your controller:
-
-    require "#{Rails.root}/lib/application_responder"
-    self.responder = ApplicationResponder
-    respond_to :html, :csv, :xls, :ascii, :only => :index
+    $ rails g tableview resource_name
 
-Then create a partial named `_table.tv` in which you can use a DSL like this to define your table:
+This will create a partial named `_table.tv` in which you can use a DSL like this to define your table:
 
-    table.header_row do |row|
-      row.cell "First header cell", :align => :right
-      row.cell "You can do", "more cells at once"
-    end
+    => @registrations
     
-    @posts.each do |post|
-      table.row do |row|
-        row.cell post.title
-        row.cell post.body if format.xls?
-      end
-    end
+    + :first_name
+    + :surname
+    + :address {|reg| reg.address + "\n" + reg.postcode }
+    + :friends if format.html?
     
-This partial will be used to render your view.
-
-### NEW! ###
-
-We now have a column based DSL.
-
-    table.table_for @events
+    if format.xls?
+      = @registrations.some_scope, "Workbook title"
+      = @registration.other_scope, "Works as title in other formats as well"
+    end
     
-    # uses I18n for header and calls the symbol as a method on the object
-    table.columns :first_name, :last_name 
-    # Uses first arg as header, and evaluates block for each row
-    table.column("E-mail address") {|event| format.html? link_to event.email : event.email }
+The DSL is a simple superset of ruby with a few special characters (only work if first printable character on line, won't work with eval and friends).
+
+Character | Meaning
+----------|--------
+ `=>`     | Use the passed collection for rendering and I18n
+ `*`      | Pass a hash to this, is used to configure the formatters.
+ `+`      | Defines a column. If passed a symbol, Tableview will use I18n to lookup the header and call the method on the model to get the value. Strings will be used literally. Optionally use a block to generate values.
+ `=`      | Render a subtable for the passed collection. Not all formatters support subtables, use at own risk (notably the CSV formatter has no support for this). Is meant mainly to have nice full-featured excel files.
+ 
+It will also add a few lines of code to your controller:
+
+- `self.responder = ApplicationResponder` this sets up the correct code path to use for dynamically rendering all the formats.
+- `respond_to :html, :json, :csv, :xls, :ascii` a list of supported formats. You will want to use `respond_with` as well.

data/lib/generators/tableview/install/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails'
+
+module Tableview
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Creates the responder file necessary for proper working of the plugin."
+      def create_application_responder
+        # record do |m|
+        #         m.file "definition.txt", "definition.txt"
+        #       end
+        lib 'application_responder.rb', "class ApplicationResponder < ActionController::Responder\n\tinclude Tableview::Responder\nend"
+      
+      end
+    end
+  end
+end

data/lib/generators/tableview/tableview_generator.rb

@@ -0,0 +1,23 @@
+require 'rails'
+
+module Tableview
+  module Generators
+    class TableviewGenerator < ::Rails::Generators::NamedBase
+      namespace "tableview"
+      desc "Generates a partial and some controller code to use tableview."
+      def create_partial
+        cols = file_name.camelize.constantize.column_names
+        template = "=> @#{file_name.tableize}\n\n"
+        cols.each do |col|
+          template << "+ :#{col}\n"
+        end
+        create_file "app/views/#{file_name.tableize}/_table.tv", template
+      end
+      
+      def install_into_controller
+        inject_into_class "app/controllers/#{file_name.tableize}_controller.rb", file_name.camelize.pluralize + "Controller", "  self.responder = ApplicationResponder\n  respond_to :html, :json, :csv, :xls, :ascii"
+      end
+      
+    end
+  end
+end

data/lib/tableview/helper.rb

@@ -9,8 +9,9 @@ module Tableview::Helper
       @params[:format] == :html || @params[:format].blank?
     end
     
-    def method_missing(name, args, &blk)
-      if m = name.match(/^(.+)\?$/)
+    def method_missing(name, *args, &blk)
+      if m = name.to_s.match(/^(.+)\?$/)
+        puts m.inspect, name.inspect
         @params[:format] == m.captures.first
       else
         super

data/lib/tableview/output/ascii.rb

@@ -1,19 +1,23 @@
-module Tableview::Ouput
+module Tableview::Output
   class ASCII
     require 'terminal-table/import'
     def process(tv)
-      @table = table { |t|
-        tv.parts.each do |part|
-          part.rows.each do |row|
-            t.add_row row.cells.map {|cell| {:value => cell.contents}.merge(cell.options) }
+      @table = ""
+      tv.subtables.each do |sub|
+        @table << "# #{sub.title}" unless sub.title.blank?
+        @table << table { |t|
+          sub.parts.each do |part|
+            part.rows.each do |row|
+              t.add_row row.cells.map {|cell| {:value => cell.contents}.merge(cell.options) }
+            end
+            t.add_separator unless part == sub.parts.last
           end
-          t.add_separator unless part == tv.parts.last
-        end
-      }
+        }.to_s
+      end
     end
     
     def to_s
-      @table.to_s
+      @table
     end
     
   end

data/lib/tableview/output/csv.rb

@@ -1,4 +1,4 @@
-module Tableview::Ouput
+module Tableview::Output
   class CSV
     require 'csv'
     def process(tv)

data/lib/tableview/output/html.rb

@@ -1,34 +1,37 @@
-module Tableview::Ouput
+module Tableview::Output
   class HTML
     def process(tv)
       @table = ""
       @p = 0
-      tag :table, tv.options do
+      tv.subtables.each do |sub|
+        tag :h2, sub.title unless sub.title.blank?
+        tag :table, sub.options do
         
-        tv.parts.each do |part|
-          tag (case part.class.to_s
-          when "Tableview::ViewHandler::Header"
-            header = true
-            :thead
-          when "Tableview::ViewHandler::Footer"
-            :tfoot
-          when "Tableview::ViewHandler::Body"
-            :tbody
-          end), part.options do 
+          sub.parts.each do |part|
+            tag (case part.class.to_s
+            when "Tableview::ViewHandler::Header"
+              header = true
+              :thead
+            when "Tableview::ViewHandler::Footer"
+              :tfoot
+            when "Tableview::ViewHandler::Body"
+              :tbody
+            end), part.options do 
         
-            part.rows.each do |row|
-              tag :tr, row.options do
-                row.cells.each do |cell|
-                  tag( header || cell.options[:header] ? :th : :td, cell.options) do 
-                    @table += ERB::Util::html_escape(cell.contents.to_s)
-                  end #td / #th
-                end
-              end #tr
-            end
+              part.rows.each do |row|
+                tag :tr, row.options do
+                  row.cells.each do |cell|
+                    tag( header || cell.options[:header] ? :th : :td, cell.options) do 
+                      @table += ERB::Util::html_escape(cell.contents.to_s)
+                    end #td / #th
+                  end
+                end #tr
+              end
 
-          end #t{part}
-        end
-      end #table
+            end #t{part}
+          end
+        end #table
+      end
     end
     
     def tag(tag, attributes = {})

data/lib/tableview/output/xls.rb

@@ -1,38 +1,36 @@
-module Tableview::Ouput
+module Tableview::Output
   class XLS
     require 'spreadsheet'
-    HEADER_STYLE = {:align => :center, :weight => :bold, :size => 12}
+    HEADER_STYLE = {:align => :center, :weight => :bold}
     FOOTER_STYLE = {:weight => :bold }
     
     def process(tv)
       
       @table = Spreadsheet::Workbook.new
-
-      sheet1 = @table.create_worksheet
-      
-      offset = 0
-
-      tv.parts.each do |part|
-        p_style = case part.class.to_s
-        when "Tableview::ViewHandler::Header"
-          HEADER_STYLE.dup
-        when "Tableview::ViewHandler::Footer"
-          FOOTER_STYLE.dup
-        else
-          {}
-        end.merge part.options
+      tv.subtables.each do |sub|
+        sheet1 = @table.create_worksheet :name => sub.title
+        offset = 0
+        sub.parts.each do |part|
+          p_style = case part.class.to_s
+          when "Tableview::ViewHandler::Header"
+            HEADER_STYLE.dup
+          when "Tableview::ViewHandler::Footer"
+            FOOTER_STYLE.dup
+          else
+            {}
+          end.merge part.options
         
-        part.rows.each do |row|
-          style = p_style.merge row.options
-          row.cells.each_with_index do |cell, i|
-            format = Spreadsheet::Format.new style.merge(cell.options)
-            sheet1[offset, i] = cell.contents
-            sheet1.row(offset).set_format i, format
+          part.rows.each do |row|
+            style = p_style.merge row.options
+            row.cells.each_with_index do |cell, i|
+              format = Spreadsheet::Format.new style.merge(cell.options)
+              sheet1[offset, i] = cell.contents
+              sheet1.row(offset).set_format i, format
+            end
+            offset += 1
           end
-          offset += 1
         end
       end
-      
     end
     
     def to_s

data/lib/tableview/tv.rb

@@ -1,10 +1,16 @@
 module Tableview
   class TV 
     def call(template)
+      source = template.source
+      start, ending = /^\s*/, /\s+(.+?)(?= unless| if| do|\{|#|$)/
+      source.gsub!(/#{start}\+#{ending}/, 'table.column(\1)')
+      source.gsub!(/#{start}\=>#{ending}/, 'table.table_for(\1)')
+      source.gsub!(/#{start}\=#{ending}/, 'table.generate_subtable_for(\1)')
+      source.gsub!(/#{start}\*#{ending}/, 'table.config(\1)')
       %{
         format = Tableview::Helper::Format.new(params)
-        tv = Tableview::ViewHandler.table do |table|
-          #{template.source}
+        tv = Tableview::ViewHandler.dsl do |table|
+          #{source}
         end
         output = Tableview::output_class(params[:format]).new
         output.process(tv)

data/lib/tableview/version.rb

@@ -1,3 +1,3 @@
 module Tableview
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/tableview/view_handler.rb

@@ -6,7 +6,8 @@ module Tableview
     
     attr_reader :table
     
-    def self.table(opts = {}, &block)
+    def self.dsl(opts = {}, &block)
+      puts "self.dsl called"
       ret = Table.new opts
       #ret.instance_eval &block
       yield(ret)
@@ -22,13 +23,13 @@ module Tableview
     end
   
     class Table < TablePiece
-      attr_accessor :parts
+      attr_accessor :parts, :subtables, :title
       def initialize(*args)
         super *args
         self.parts = []
         @current_part = Body.new
         @added = false
-        @headers, @procs = [], []
+        @headers, @procs, @subtables = [], [], []
       end
       
       def table_for(s)
@@ -104,8 +105,28 @@ module Tableview
         end
       end
       
+      def generate_subtable_for(subcollection, title = nil)
+        t = Table.new
+        t.title = title
+        t.header_row do |row|
+          row.cells = @headers
+        end
+        t.body do |b|
+          subcollection.each do |el|
+            b.row do |r|
+              @procs.each do |proc|
+                r.cell proc.call(el)
+              end
+            end
+          end
+        end # body
+        @subtables << t
+        @table_generated = true
+      end
+      
       def create_table!
         return unless @column_based
+        return if @table_generated
         header_row do |row|
           row.cells = @headers
         end
@@ -116,6 +137,7 @@ module Tableview
             end
           end
         end
+        @subtables << self
       end
       
     end
@@ -135,15 +157,12 @@ module Tableview
     end
   
     class Header < Part
-    
     end
   
     class Body < Part
-    
     end
   
     class Footer < Part
-    
     end
   
     class Row < TablePiece

data/lib/tableview.rb

@@ -18,7 +18,7 @@ module Tableview
     rescue 
       raise NoOuputClassError
     end
-    ("Tableview::Ouput::" + format.to_s.upcase).constantize
+    ("Tableview::Output::" + format.to_s.upcase).constantize
   end
   
   class NoOuputClassError

data/tableview.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
   
   s.add_dependency "terminal-table", "~> 1.4"
   s.add_dependency "spreadsheet", "~> 0.6"
+  s.add_dependency "railties", "~> 3.0"
+  #s.add_dependency "thor",     "~> 0.14"
   #s.add_dependency "rails", "~> 3.0"
   
   s.files        = `git ls-files`.split("\n")

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jakub Hampl
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-30 00:00:00 +01:00
+date: 2011-06-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,20 @@ dependencies:
         version: "0.6"
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: railties
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id004
 description: Supported formats are ASCII, MS Excel, HTML and CSV; it is easy to create your own exporter class.
 email: 
 - honitom@seznam.cz
@@ -75,6 +89,8 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- lib/generators/tableview/install/install_generator.rb
+- lib/generators/tableview/tableview_generator.rb
 - lib/tableview.rb
 - lib/tableview/helper.rb
 - lib/tableview/output/ascii.rb