ar_to_html_table 0.1.1 → 0.1.2

data/README.textile

@@ -47,7 +47,7 @@ h2. Column options
 |:order|Positions a column order relative to other columns.  The number isn't important, just its relative value compared to other columns.  Columns are sorted by order and rendered in that order.  The default order is the order in which the columns are defined.|
 |:total|Renders a table footer with a calculation of all the values in the column.  The available totaling methods are **:sum**, **:count** and **:average** (or :avg or :mean)|
 |:class|The CSS class for this column.  Note that a **colgroup** is defined for each column and each **colgroup** has as CSS class that is the column name|
-|:formatter|Used to format the value of each table cell.  There are several predefined formatters.  This value can also be a lambda for arbitrary formatting.|
+|:formatter|A :symbol representing a method to format the value of each table cell.  There are several predefined formatters but any method with a signature of **method(value, options = {})** will work, including the methods in ActionView::Helpers::NumberHelper. Lastly a lambda can be provided for arbitrary formatting.|
 
 h2. Predefined formatters
 
@@ -62,11 +62,16 @@ h2. Predefined formatters
 |:unknown_on_blank|Displays **(unknown)** when **column.blank?** is true.  This is a localized value.  The key **I18n.t('tables.unknown')** is used.|
 |:not_set_on_blank|Displays **(not set)** when **column.blank?** is true.  This is a localized value.  The key **I18n.t('tables.not_set')** is used.|
 
-p. If no formatter is specified then **#to_s** is called on the value unless the value is a **Fixnumn** in which case **#number_with_delimiter** is called.
+p. If no formatter is specified then:
+
+* string and text values are used unmodified
+* date and datetime values are called on **to_s(:db)**
+* integers and floats are called on **number_with_delimiter**
+* **to_s** is called on all other column types.
 
 h2. Table rendering
 
-To render the html table, call **#to_table(options)** on any ActiveRecord result set.  The default options are:
+To render the html table, call **to_table(options)** on any ActiveRecord result set.  The default options are:
 
 bc. :exclude      => EXCLUDE_COLUMNS, 
 :exclude_ids  => true, 
@@ -76,7 +81,10 @@ bc. :exclude      => EXCLUDE_COLUMNS,
 :total_one    => 'tables.total_one',
 :total_many   => 'tables.total_many',
 :unknown_key  => 'tables.unknown',
-:not_set_key  => 'tables.not_set'
+:not_set_key  => 'tables.not_set',
+:heading	  => nil,
+:caption	  => nil,
+:sort		  => nil
 
 |_. Option|_. Description|
 |:include|Array of columns that should be rendered|
@@ -84,7 +92,7 @@ bc. :exclude      => EXCLUDE_COLUMNS,
 |:exclude_ids|Don't render columns that end in **_id**|
 |:sort|A **Proc** that is called to sort the rows.  Called as **results.sort(options[:sort])**.|
 |:heading|A table heading that is placed in the first row of a table|
-|:caption|A table caption applied with <caption> markup|
+|:caption|A table caption applied|
 |:odd_row|CSS class name for odd rows|
 |:even_row|CSS class name for even rows|
 |:totals|Add a total row at the bottom of the table|

data/Rakefile

@@ -1,2 +1,9 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end

data/ar_to_html_table.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Kip Cole"]
   s.email       = ["kipcole9@gmail.com"]
   s.homepage    = "http://github.com/kipcole9/ar_to_html_table"
-  s.summary     = %q{Render and ActiveRecord result set as an HTML table}
+  s.summary     = %q{Render an ActiveRecord result set as an HTML table}
   s.description = <<-EOF
     Defines Array#to_table that will render an ActiveRecord result set
     as an HTML table.
@@ -21,5 +21,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_dependency('builder')
+  
+  s.add_dependency  'builder'
+  s.add_dependency  'activerecord', '~> 2.3.5'
+  s.add_dependency  'actionpack', '~> 2.3.5'
 end

data/lib/ar_to_html_table/column_formats.rb

@@ -59,7 +59,7 @@ module ArToHtmlTable
       #   => { :total => :sum, :order => 5, :class => 'right' }
       def format_of(name)
         @attr_formats ||= default_formats
-        @attr_formats[name] || {}
+        @attr_formats[name.to_s] || {}
       end
     
     private
@@ -76,13 +76,14 @@ module ArToHtmlTable
         columns.each do |column|
           attr_formats[column.name] = case column.type
           when :integer, :float
-            {:class => :right, :formatter => :number_with_delimiter}
+            { :class => :right, 
+              :formatter => lambda {|*args| number_with_delimiter(args[0])} }
           when :text, :string
-            {}
+            { :formatter => lambda {|*args| args[0]} }
           when :date, :datetime
-            {}
+            { :formatter => lambda {|*args| args[0].to_s(:db)} }
           else
-            {}
+            { :formatter => lambda {|*args| args[0].to_s} }
           end
         end
         attr_formats

data/lib/ar_to_html_table/table_formatter.rb

@@ -156,6 +156,10 @@ module ArToHtmlTable
         html << result
       end
     end
+    
+    def self.procify(symbol)
+      proc { |*args| send(symbol, *args) }
+    end
 
   private
     # Craft a CSS id
@@ -253,7 +257,7 @@ module ArToHtmlTable
     # we have on calling interface in the output_cell method
     # - partially for clarity and partially for performance
     def procify(sym)
-      proc { |val, options| send(sym, val, options) }
+      self.procify(sym)
     end
 
     # Decide if the given column is to be displayed in the table

data/lib/ar_to_html_table/version.rb

@@ -1,3 +1,3 @@
 module ArToHtmlTable
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/boot.rb

@@ -0,0 +1,21 @@
+plugin_root = File.join(File.dirname(__FILE__), '..')
+version = ENV['RAILS_VERSION']
+version = nil if version and version == ""
+
+# first look for a symlink to a copy of the framework
+if !version and framework_root = ["#{plugin_root}/rails", "#{plugin_root}/../../rails"].find { |p| File.directory? p }
+  puts "found framework root: #{framework_root}"
+  # this allows for a plugin to be tested outside of an app and without Rails gems
+  $:.unshift "#{framework_root}/activesupport/lib", "#{framework_root}/activerecord/lib", "#{framework_root}/actionpack/lib"
+else
+  # simply use installed gems if available
+  puts "using Rails#{version ? ' ' + version : nil} gems"
+  require 'rubygems'
+  
+  if version
+    gem 'rails', version
+  else
+    gem 'actionpack', '< 3.0.0.a'
+    gem 'activerecord', '< 3.0.0.a'
+  end
+end

data/test/database.yml

@@ -0,0 +1,22 @@
+sqlite3:
+  database: ":memory:"
+  adapter: sqlite3
+  timeout: 500
+
+sqlite2:
+  database: ":memory:"
+  adapter: sqlite2
+
+mysql:
+  adapter: mysql
+  username: root
+  password: 
+  encoding: utf8
+  database: will_paginate_unittest
+
+postgres:
+  adapter: postgresql
+  username: mislav
+  password: 
+  database: will_paginate_unittest
+  min_messages: warning

data/test/fixtures/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define do
+
+  create_table "products", :force => true do |t|
+    t.column "name",          :string, :limit => 100
+    t.column "price",         :float
+    t.column "sales_volume",  :integer
+    t.column "launch_date",   :datetime
+  end
+
+
+end

data/test/helper.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require 'rubygems'
+
+# gem install redgreen for colored test output
+begin require 'redgreen'; rescue LoadError; end
+
+require 'boot' unless defined?(ActiveRecord)
+
+class Test::Unit::TestCase
+  protected
+  def assert_respond_to_all object, methods
+    methods.each do |method|
+      [method.to_s, method.to_sym].each { |m| assert_respond_to object, m }
+    end
+  end
+
+end
+
+# Wrap tests that use Mocha and skip if unavailable.
+def uses_mocha(test_name)
+  require 'mocha'
+rescue LoadError
+  $stderr.puts "Skipping #{test_name} tests. `gem install mocha` and try again."
+else
+  yield
+end

data/test/lib/activerecord_test_case.rb

@@ -0,0 +1,44 @@
+require 'lib/activerecord_test_connector'
+
+class ActiveRecordTestCase < Test::Unit::TestCase
+  if defined?(ActiveSupport::Testing::SetupAndTeardown)
+    include ActiveSupport::Testing::SetupAndTeardown
+  end
+
+  if defined?(ActiveRecord::TestFixtures)
+    include ActiveRecord::TestFixtures
+  end
+  
+  # Set our fixture path
+  if ActiveRecordTestConnector.able_to_connect
+    self.fixture_path = File.join(File.dirname(__FILE__), '..', 'fixtures')
+    self.use_transactional_fixtures = true
+  end
+
+  def self.fixtures(*args)
+    super if ActiveRecordTestConnector.connected
+  end
+
+  def run(*args)
+    super if ActiveRecordTestConnector.connected
+  end
+
+  # Default so Test::Unit::TestCase doesn't complain
+  def test_truth
+  end
+
+  protected
+
+    def assert_queries(num = 1)
+      $query_count = 0
+      yield
+    ensure
+      assert_equal num, $query_count, "#{$query_count} instead of #{num} queries were executed."
+    end
+
+    def assert_no_queries(&block)
+      assert_queries(0, &block)
+    end
+end
+
+ActiveRecordTestConnector.setup

data/test/lib/activerecord_test_connector.rb

@@ -0,0 +1,76 @@
+require 'active_record'
+require 'active_record/version'
+require 'active_record/fixtures'
+
+class ActiveRecordTestConnector
+  cattr_accessor :able_to_connect
+  cattr_accessor :connected
+
+  FIXTURES_PATH = File.join(File.dirname(__FILE__), '..', 'fixtures')
+
+  # Set our defaults
+  self.connected = false
+  self.able_to_connect = true
+
+  def self.setup
+    unless self.connected || !self.able_to_connect
+      setup_connection
+      load_schema
+      add_load_path FIXTURES_PATH
+      self.connected = true
+    end
+  rescue Exception => e  # errors from ActiveRecord setup
+    $stderr.puts "\nSkipping ActiveRecord tests: #{e}\n\n"
+    self.able_to_connect = false
+  end
+
+  private
+  
+  def self.add_load_path(path)
+    dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+    autoload_paths = dep.respond_to?(:autoload_paths) ? dep.autoload_paths : dep.load_paths
+    autoload_paths.unshift path
+  end
+
+  def self.setup_connection
+    db = ENV['DB'].blank?? 'sqlite3' : ENV['DB']
+    
+    configurations = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'database.yml'))
+    raise "no configuration for '#{db}'" unless configurations.key? db
+    configuration = configurations[db]
+    
+    ActiveRecord::Base.logger = Logger.new(STDOUT) if $0 == 'irb'
+    puts "using #{configuration['adapter']} adapter" unless ENV['DB'].blank?
+    
+    gem 'sqlite3-ruby' if 'sqlite3' == db
+    
+    ActiveRecord::Base.establish_connection(configuration)
+    ActiveRecord::Base.configurations = { db => configuration }
+    prepare ActiveRecord::Base.connection
+
+    unless Object.const_defined?(:QUOTED_TYPE)
+      Object.send :const_set, :QUOTED_TYPE, ActiveRecord::Base.connection.quote_column_name('type')
+    end
+  end
+
+  def self.load_schema
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+      load File.join(FIXTURES_PATH, 'schema.rb')
+    end
+  end
+
+  def self.prepare(conn)
+    class << conn
+      IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SHOW FIELDS /]
+
+      def execute_with_counting(sql, name = nil, &block)
+        $query_count ||= 0
+        $query_count  += 1 unless IGNORED_SQL.any? { |r| sql =~ r }
+        execute_without_counting(sql, name, &block)
+      end
+
+      alias_method_chain :execute, :counting
+    end
+  end
+end

data/test/test_ar_to_html_table.rb

@@ -0,0 +1,12 @@
+require 'helper'
+require 'lib/activerecord_test_case'
+
+class FinderTest < ActiveRecordTestCase
+  # fixtures :topics, :replies, :users, :projects, :developers_projects
+
+  def test_startup
+    assert true
+    # assert_respond_to_all Topic, %w(per_page paginate paginate_by_sql paginate_by_definition_in_class)
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ar_to_html_table
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Kip Cole
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-17 00:00:00 +08:00
+date: 2010-10-20 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,38 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id003
 description: "    Defines Array#to_table that will render an ActiveRecord result set\n    as an HTML table.\n"
 email: 
 - kipcole9@gmail.com
@@ -55,7 +87,14 @@ files:
 - lib/ar_to_html_table/version.rb
 - lib/locale/cldr_additions.yml
 - lib/locale/en.yml
-- lib/tasks/html_tables_tasks.rake
+- lib/tasks/ar_to_html_tables_tasks.rake
+- test/boot.rb
+- test/database.yml
+- test/fixtures/schema.rb
+- test/helper.rb
+- test/lib/activerecord_test_case.rb
+- test/lib/activerecord_test_connector.rb
+- test/test_ar_to_html_table.rb
 has_rdoc: true
 homepage: http://github.com/kipcole9/ar_to_html_table
 licenses: []
@@ -89,6 +128,12 @@ rubyforge_project: ar_to_html_table
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Render and ActiveRecord result set as an HTML table
-test_files: []
-
+summary: Render an ActiveRecord result set as an HTML table
+test_files: 
+- test/boot.rb
+- test/database.yml
+- test/fixtures/schema.rb
+- test/helper.rb
+- test/lib/activerecord_test_case.rb
+- test/lib/activerecord_test_connector.rb
+- test/test_ar_to_html_table.rb

data/lib/tasks/html_tables_tasks.rake

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