sequel-reporter 0.0.6 → 0.0.7

data/README.md

@@ -35,11 +35,14 @@ The `query` helper takes a block of SQL and returns a `Sequel::Reporter::Report`
 
 Sequel Reporter uses [Twitter Bootstrap](http://twitter.github.com/bootstrap) for formatting, so you can use whatever you want to format your reports from there. 
 
-The `table` helper takes a query produced by the `query` helper and some options and builds an HTML table. Also, it can take a `:links` option which will linkify values in the table. Here's an example:
+The `table` helper takes a query produced by the `query` helper and some options and builds an HTML table. This helper can take an optional block where you can set more options on the table. For example:
 
-    :links => {"Account" => "/reports/register?account=:1"}
+    <%= table(@query) do |t|
+      t.link /Account/ => '/register?account=:this'
+      t.decorate /Amount/ => Sequel::Reporter::NumberDecorator.new
+    end %>
     
-This says that every value in the `Account` column will be surrounded with an `<a>` tag pointing at `/reports/register?account=:1`, where `:1` will be replaced by the value in column 1 of that particular row. You can also use `:title` in a link template. It will get replaced with the title of the column that is currently getting linked. In this case, `:title` would get replaced with `Account`.
+The link method links columns matching the given regex to the given URL pattern. URL patterns can reference the value in the current cell using `:this`, the current date with `:now`, the title of the column with `:title`, and any other value from the row using `:N`, where `N` is the 0-indexed row index. You can write your own decorators. See `sequel-reporter/decorators.rb` for examples.
 
 ### Reports as Classes
 

data/lib/sequel-reporter/decorators.rb

@@ -0,0 +1,61 @@
+require 'rack/utils'
+require 'cgi'
+
+module Sequel::Reporter
+
+  class NumberDecorator
+    def initialize(precision=2)
+      @precision = precision
+    end
+
+    def decorate(cell, row)
+      if cell.value.is_a?(Numeric)
+        cell.align = 'right'
+        cell.text = sprintf("%0.#{@precision}f", cell.value)
+      end
+      cell
+    end
+  end
+
+  class LinkDecorator
+    def initialize(href_pattern)
+      @href_pattern = href_pattern
+    end
+
+    def decorate(cell, row)
+      url = String.new(@href_pattern)
+      row.each_with_index do |c,i|
+        url.gsub!(":#{i}", CGI.escape(c.value.to_s))
+      end
+      url.gsub!(':title', CGI.escape(cell.title.to_s))
+      url.gsub!(':now', CGI.escape(DateTime.now.strftime('%Y-%m-%d')))
+      url.gsub!(':this', CGI.escape(cell.value.to_s))
+      prev_text = cell.text
+      cell.text = "<a href=\"#{url}\">#{cell.text}</a>"
+      cell
+    end
+  end
+
+  class IconDecorator
+    def initialize(icon)
+      @icon = icon
+    end
+
+    def decorate(cell, row)
+      cell.text = "<i class=\"icon-#{@icon}\"></i>"
+      cell
+    end
+  end
+
+  class HighlightDecorator
+    def initialize(color)
+      @color = color
+    end
+
+    def decorate(cell, row)
+      cell.style['background-color'] = @color
+      cell
+    end
+  end
+
+end

data/lib/sequel-reporter/helpers.rb

@@ -12,8 +12,11 @@ module Sequel::Reporter
     end
 
     def table(report, options = {})
-      links = options[:links] || {}
-      partial(:table, :report => report, :links => links, :render_engine => :erb)
+      Table.new(report) do |t|
+        t.decorate :all => NumberDecorator.new
+        t.attributes[:class] = 'table table-striped table-hover table-bordered table-condensed'
+        yield t if block_given?
+      end.render
     end
 
     def query(options={}, &block)
@@ -25,29 +28,6 @@ module Sequel::Reporter
       report
     end
 
-    def linkify(links, row, value, display_value)
-      links.each do |key, val|
-        if key.is_a? String
-          key = /^#{key}$/
-        end
-  
-        if key.match(value[1].title.to_s)
-          url = String.new(links[key])
-          row.each_with_index do |v,i|
-            url.gsub!(":#{i}", CGI.escape(v[0].to_s))
-          end
-  
-          url.gsub!(':title', CGI.escape(value[1].title.to_s))
-          url.gsub!(':now', CGI.escape(DateTime.now.strftime('%Y-%m-%d')))
-          display_value = "<a href='#{url}'>#{escape_html(display_value)}</a>"
-        else
-          display_value = escape_html(display_value)
-        end
-
-      end
-      display_value
-    end
-
     def protected!
       unless self.send(settings.authorization_func)
         response['WWW-Authenticate'] = %(Basic realm="Restricted Area")

data/lib/sequel-reporter/report.rb

@@ -1,47 +1,17 @@
 module Sequel::Reporter
-  class Field
 
-    attr_reader :title, :value_type, :span_class
+  class Cell
+    attr_reader :title, :value, :style
+    attr_accessor :text, :align
 
-    def initialize(title, value_type, span_class)
+    def initialize(title, value)
       @title = title
-      @value_type = value_type
-      @span_class = span_class
+      @value = value
+      @style = {}
+      @text = value
+      @align = 'left'
     end
 
-    def ==(other)
-      self.title == other.title && \
-      self.value_type == other.value_type && \
-      self.span_class == other.span_class
-    end
-  end
-
-  class NumberField < Field
-    def initialize(title)
-      super(title, 'number', 'pull-right')
-    end
-  end
-
-  class StringField < Field
-    def initialize(title)
-      super(title, 'string', 'pull-left')
-    end
-  end
-
-  class Value
-    def initialize(val)
-      @val = val
-    end
-
-    def to_s
-      @val
-    end
-  end
-
-  class NumericValue < Value
-    def to_s
-      sprintf("%0.2f", @val)
-    end
   end
 
   class Report
@@ -72,18 +42,13 @@ module Sequel::Reporter
           raise "No data"
         end
         ds.columns.each do |col|
-          value = row[col]
-          if value.is_a? Numeric
-            report.add_field NumberField.new(col.to_s)
-          else
-            report.add_field StringField.new(col.to_s)
-          end
+          report.add_field col.to_s
         end
 
         ds.each do |row|
           vals = []
           ds.columns.each do |col|
-            vals << row[col]
+            vals << Cell.new(col.to_s, row[col])
           end
           report.add_row(vals)
         end
@@ -110,9 +75,9 @@ module Sequel::Reporter
       @rows << row
     end
 
-    def each_row
+    def each
       @rows.each do |row|
-        yield row.zip(@fields)
+        yield row
       end
     end
 
@@ -121,7 +86,7 @@ module Sequel::Reporter
 
       bucket_column_index = 0
       self.fields.each_with_index do |f, i|
-        if f.title == column
+        if f == column
           bucket_column_index = i
           break
         else
@@ -132,14 +97,13 @@ module Sequel::Reporter
       buckets = {}
       new_rows = {}
 
-      self.each_row do |row|
-        key = row[0, bucket_column_index].map { |r| r[0] }
-        bucket_name = row[bucket_column_index][0]
-        bucket_value = row[bucket_column_index + 1][0]
+      self.each do |row|
+        key = row[0, bucket_column_index].map { |r| r.value }
+        bucket_name = row[bucket_column_index].value
+        bucket_value = row[bucket_column_index + 1].value
 
         if not buckets.has_key? bucket_name
-          field = bucket_value.is_a?(Numeric) ? NumberField.new(bucket_name) : StringField.new(bucket_name)
-          buckets[bucket_name] = field
+          buckets[bucket_name] = bucket_name
         end
 
         new_rows[key] ||= {}

data/lib/sequel-reporter/table.rb

@@ -0,0 +1,60 @@
+module Sequel::Reporter
+  class Table
+
+    attr_reader :attributes
+
+    def initialize(report)
+      @report = report
+      @decorators = []
+      @attributes = {}
+      yield self if block_given?
+    end
+
+    def decorate decorator
+      @decorators << decorator
+    end
+
+    def clear_decorators
+      @decorators.clear
+    end
+
+    def link href
+      if_clause = href.delete(:if)
+      href[href.keys.first] = LinkDecorator.new(href.values.first)
+      href[:if] = if_clause
+      @decorators << href
+    end
+
+    def render
+      body_rows = []
+      header_aligns = {}
+
+      @report.each do |row|
+        body_rows << row.each_with_index.map do |cell, cell_index|
+          @decorators.each do |decorator|
+            dec = decorator.dup
+            if_clause = dec.delete(:if)
+            matcher = dec.keys.first
+
+            next unless matcher == :all || cell.title =~ matcher
+            if if_clause
+              next unless if_clause.call(cell, row)
+            end
+            cell = dec[matcher].decorate(cell, row)
+            header_aligns[cell_index] = cell.align
+          end
+
+          style = cell.style.map { |key, val| "#{key}:#{val}"}.join(";")
+          %Q{<td style="#{style}"><span class="pull-#{cell.align}">#{cell.text}</span></td>}
+        end.join("")
+      end
+
+      body = "<tbody>" + body_rows.map { |r| "<tr>#{r}</tr>" }.join("") + "</tbody>"
+      header = "<thead><tr>" + @report.fields.each_with_index.map { |f,i| "<th><span class=\"pull-#{header_aligns[i] || 'left'}\">#{f}</span></th>" }.join("") + "</tr></thead>"
+
+      attrs = attributes.map { |key,val| "#{key}=\"#{val}\"" }.join(" ")
+      "<table #{attrs}>#{header}#{body}</table>"
+    end
+  end
+
+end

data/lib/sequel-reporter/version.rb

@@ -1,5 +1,5 @@
 module Sequel
   module Reporter
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/lib/sequel-reporter.rb

@@ -1,7 +1,9 @@
 require "sequel-reporter/version"
 require "sequel-reporter/cli"
 require "sequel-reporter/report"
+require "sequel-reporter/decorators"
 require "sequel-reporter/helpers"
+require "sequel-reporter/table"
 require "sequel-reporter/application"
 
 module Sequel

data/sequel-reporter.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('thor')
   gem.add_dependency('rspec')
-  gem.add_dependency('sinatra')
+  gem.add_dependency('sinatra', '1.4.2')
   gem.add_dependency('sinatra-contrib')
   gem.add_dependency('sequel')
 

data/test/report_spec.rb

@@ -11,23 +11,23 @@ describe Sequel::Reporter::Report do
     it "should run a query" do
       report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
       rows = []
-      report.each_row do |row|
+      report.each do |row|
         rows << row
       end
 
-      rows[0][0][0].should eq(2)
-      rows[0][0][1].should eq(Sequel::Reporter::NumberField.new('foo'))
+      rows[0][0].value.should eq(2)
+      rows[0][0].title.should eq('foo')
     end
 
     it "should use params" do
       Sequel::Reporter::Report.params = {:blah => "hi"}
       report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things where something = :blah")
       rows = []
-      report.each_row do |row|
+      report.each do |row|
         rows << row
       end
 
-      rows[0][0][0].should eq(1)
+      rows[0][0].value.should eq(1)
     end
   end
 
@@ -43,9 +43,9 @@ describe Sequel::Reporter::Report do
       report = report.pivot("something", "asc")
 
       report.fields.should eq([
-        Sequel::Reporter::StringField.new('other'),
-        Sequel::Reporter::NumberField.new('hi'),
-        Sequel::Reporter::NumberField.new('ho'),
+        'other',
+        'hi',
+        'ho',
       ])
     end
 

data/test/spec_helper.rb

@@ -1,9 +1,7 @@
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 require 'rspec'
-require 'sequel-reporter/application'
-require 'sequel-reporter/report'
-require 'sequel-reporter/helpers'
+require 'sequel-reporter'
 require 'sequel'
 require 'sqlite3'
 

data/test/table_spec.rb

@@ -0,0 +1,104 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+class RightAlignDecorator
+  def decorate(cell, row)
+    cell.align = 'right'
+    cell
+  end
+end
+
+describe Sequel::Reporter::Table do
+
+  before :each do
+    @things.insert(:id => 1, :something => "hi", :other => "2013-02-18")
+    @things.insert(:id => 2, :something => "ho", :other => "2013-02-19")
+  end
+
+  describe "#render" do
+    it "should render" do
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
+      table = Sequel::Reporter::Table.new(report)
+
+      table.render.should eq("<table ><thead><tr><th><span class=\"pull-left\">foo</span></th></tr></thead><tbody><tr><td style=\"\"><span class=\"pull-left\">2</span></td></tr></tbody></table>")
+    end
+
+    it "should decorate" do
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
+      table = Sequel::Reporter::Table.new(report) do |t|
+        t.decorate /foo/ => RightAlignDecorator.new
+      end
+
+      table.render.should eq("<table ><thead><tr><th><span class=\"pull-right\">foo</span></th></tr></thead><tbody><tr><td style=\"\"><span class=\"pull-right\">2</span></td></tr></tbody></table>")
+    end
+
+    it "should decorate with if lambda" do
+      report = Sequel::Reporter::Report.from_query(@db, "select something from things order by id")
+      table = Sequel::Reporter::Table.new(report) do |t|
+        t.decorate /something/ => RightAlignDecorator.new, :if => lambda{|c,r| c.value == 'hi'}
+      end
+
+      table.render.should eq("<table ><thead><tr><th><span class=\"pull-right\">something</span></th></tr></thead><tbody><tr><td style=\"\"><span class=\"pull-right\">hi</span></td></tr><tr><td style=\"\"><span class=\"pull-left\">ho</span></td></tr></tbody></table>")
+    end
+
+    it "should decorate all cells if given all symbol" do
+      report = Sequel::Reporter::Report.from_query(@db, "select id, something from things order by id limit 1")
+      table = Sequel::Reporter::Table.new(report) do |t|
+        t.decorate :all => RightAlignDecorator.new
+      end
+
+      table.render.should eq("<table ><thead><tr><th><span class=\"pull-right\">id</span></th><th><span class=\"pull-right\">something</span></th></tr></thead><tbody><tr><td style=\"\"><span class=\"pull-right\">1</span></td><td style=\"\"><span class=\"pull-right\">hi</span></td></tr></tbody></table>")
+    end
+
+    it "should decorate with multiple" do
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
+      table = Sequel::Reporter::Table.new(report) do |t|
+        t.decorate /foo/ => Sequel::Reporter::NumberDecorator.new(3)
+        t.decorate /foo/ => Sequel::Reporter::LinkDecorator.new('/something?q=:0&now=:now&title=:title&this=:this')
+      end
+
+      now = DateTime.now.strftime('%Y-%m-%d')
+      table.render.should eq("<table ><thead><tr><th><span class=\"pull-right\">foo</span></th></tr></thead><tbody><tr><td style=\"\"><span class=\"pull-right\"><a href=\"/something?q=2&now=2013-04-12&title=foo&this=2\">2.000</a></span></td></tr></tbody></table>")
+    end
+
+    it "should decorate with icon decorator" do
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
+      table = Sequel::Reporter::Table.new(report) do |t|
+        t.decorate /foo/ => Sequel::Reporter::IconDecorator.new("glass")
+      end
+
+      now = DateTime.now.strftime('%Y-%m-%d')
+      table.render.should eq("<table ><thead><tr><th><span class=\"pull-left\">foo</span></th></tr></thead><tbody><tr><td style=\"\"><span class=\"pull-left\"><i class=\"icon-glass\"></i></span></td></tr></tbody></table>")
+    end
+
+    it "should add attributes to table tag" do
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
+      table = Sequel::Reporter::Table.new(report) do |t|
+        t.attributes[:class] = "table table-bordered table-striped table-hover"
+      end
+
+      now = DateTime.now.strftime('%Y-%m-%d')
+      table.render.should eq("<table class=\"table table-bordered table-striped table-hover\"><thead><tr><th><span class=\"pull-left\">foo</span></th></tr></thead><tbody><tr><td style=\"\"><span class=\"pull-left\">2</span></td></tr></tbody></table>")
+    end
+
+    it "should decorate with link shortcut" do
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
+      table = Sequel::Reporter::Table.new(report) do |t|
+        t.link /foo/ => '/something?q=:0&now=:now&title=:title&this=:this'
+      end
+
+      now = DateTime.now.strftime('%Y-%m-%d')
+      table.render.should eq("<table ><thead><tr><th><span class=\"pull-left\">foo</span></th></tr></thead><tbody><tr><td style=\"\"><span class=\"pull-left\"><a href=\"/something?q=2&now=2013-04-12&title=foo&this=2\">2</a></span></td></tr></tbody></table>")
+    end
+
+    it "should decorate with highlight decorator" do
+      report = Sequel::Reporter::Report.from_query(@db, "select count(1) as foo from things")
+      table = Sequel::Reporter::Table.new(report) do |t|
+        t.decorate :all => Sequel::Reporter::HighlightDecorator.new('#00FF00')
+      end
+
+      now = DateTime.now.strftime('%Y-%m-%d')
+      table.render.should eq("<table ><thead><tr><th><span class=\"pull-left\">foo</span></th></tr></thead><tbody><tr><td style=\"background-color:#00FF00\"><span class=\"pull-left\">2</span></td></tr></tbody></table>")
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-23 00:00:00.000000000 Z
+date: 2013-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -48,17 +48,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
@@ -138,16 +138,18 @@ files:
 - data/views/error.erb
 - data/views/layout.erb
 - data/views/reports/dashboard.erb
-- data/views/table.erb
 - lib/sequel-reporter.rb
 - lib/sequel-reporter/application.rb
 - lib/sequel-reporter/cli.rb
+- lib/sequel-reporter/decorators.rb
 - lib/sequel-reporter/helpers.rb
 - lib/sequel-reporter/report.rb
+- lib/sequel-reporter/table.rb
 - lib/sequel-reporter/version.rb
 - sequel-reporter.gemspec
 - test/report_spec.rb
 - test/spec_helper.rb
+- test/table_spec.rb
 homepage: https://github.com/peterkeen/sequel-reporter
 licenses: []
 post_install_message: 
@@ -175,3 +177,4 @@ summary: An opinionated framework for writing reporting applications
 test_files:
 - test/report_spec.rb
 - test/spec_helper.rb
+- test/table_spec.rb

data/data/views/table.erb

@@ -1,31 +0,0 @@
-<% if report.error %>
-<div class="alert-message block-message warning">
-  <p><%= report.error %></p>
-  <% if report.error.to_s != "No data" %>
-    <p><%= report.error.backtrace %></p>
-  <% end %>
-</div>
-<% else %>
-<table class="table table-striped table-borderd table-hover table-condensed sorted">
-  <thead>
-    <tr>
-      <% report.fields.each do |f| %>
-      <th><span class="<%= f.span_class %>"><%= f.title %></span></th>
-      <% end %>
-    </tr>
-  </thead>
-  <tbody>
-    <% report.each_row do |row| %>
-    <tr>
-      <% row.each do |val| %>
-      <td>
-        <span class="<%= val[1].span_class %>">
-          <%= linkify(links, row, val, (val[1].value_type == 'number' && ! val[0].nil?) ? sprintf("%0.2f", val[0]) : val[0]) %>
-        </span>
-      </td>
-      <% end %>
-    </tr>
-    <% end %>
-  </tbody>
-</table>
-<% end %>