ar_to_html_table 0.1.2 → 0.1.3

data/README.textile

@@ -82,9 +82,9 @@ bc. :exclude      => EXCLUDE_COLUMNS,
 :total_many   => 'tables.total_many',
 :unknown_key  => 'tables.unknown',
 :not_set_key  => 'tables.not_set',
-:heading	  => nil,
-:caption	  => nil,
-:sort		  => nil
+:heading      => nil,
+:caption      => nil,
+:sort         => nil
 
 |_. Option|_. Description|
 |:include|Array of columns that should be rendered|
@@ -101,6 +101,25 @@ bc. :exclude      => EXCLUDE_COLUMNS,
 |:unknown_key|I18n key for rendering **(Unknown)**|
 |:not_set_key|I18n key for rendering **(Not Set)**|
 
+h2. Using formatters outside ar_to_html_table
+
+Once defined the formatters can be used in other places. Both class and instance methods are provided.  Best explained by the following example:
+
+bc.   class Product < ActiveRecord::Base
+     column_format :name,      :order => 1
+     column_format :orders,    :total => :sum
+     column_format :revenue,   :total => :sum, :order => 5, :class => 'right'
+     column_format :age, 	   :total => :avg, :order => 20, :class => 'right', :formatter => :number_with_delimiter
+   end
+ 
+   # p = Product.first
+   => #<Product id: 55986, age: 4346, .........
+   # p.age
+   => 4346
+
+   # p.format_column(:age)
+   => "4,346"
+
 h1. License
 
 (The MIT License)

data/lib/ar_to_html_table/column_formats.rb

@@ -10,7 +10,31 @@ module ArToHtmlTable
     end
   
     module InstanceMethods
-
+      # Invoke the formatter on a column.
+      #
+      # ====Examples
+      #
+      #   class Product < ActiveRecord::Base
+      #     column_format :name,      :order => 1
+      #     column_format :orders,    :total => :sum
+      #     column_format :revenue,   :total => :sum, :order => 5, :class => 'right'
+      #     column_format :age, 	    :total => :avg, :order => 20, :class => 'right', :formatter => :number_with_delimiter
+      #   end
+      # 
+      #   # p = Product.first
+      #   # p.age
+      #   => 4346
+      #
+      #   # p.format_column(:age)
+      #   => "4,346"
+      #
+      # ====Parameters
+      #
+      #   column_name:  A column (attribute) on the the model instance 
+      def format_column(column_name)
+        self.class.format_column(column_name, self[column_name])
+      end
+      alias :format_attribute :format_column
     end
   
     module ClassMethods
@@ -61,6 +85,31 @@ module ArToHtmlTable
         @attr_formats ||= default_formats
         @attr_formats[name.to_s] || {}
       end
+      
+      # Invoke the formatter on a column.
+      #
+      # ====Examples
+      #
+      #   class Product < ActiveRecord::Base
+      #     column_format :name,      :order => 1
+      #     column_format :orders,    :total => :sum
+      #     column_format :revenue,   :total => :sum, :order => 5, :class => 'right'
+      #     column_format :age, 	    :total => :avg, :order => 20, :class => 'right', :formatter => :number_with_delimiter
+      #   end
+      #
+      #   # Product.format_column(:age, 4346)
+      #   => "4,346"
+      #
+      # ====Parameters
+      #
+      #   column_name:  A column (attribute) on the the model instance
+      #   value: The value to be formatted
+      def format_column(column_name, value)
+        formatter = format_of(column_name)[:formatter]
+        raise "Column #{column_name} has no configured formatter" unless formatter && formatter.is_a?(Proc)
+        formatter.call(value, {})
+      end
+      alias :format_attribute :format_column
     
     private
       # Default column formats used in to_table for active_record

data/lib/ar_to_html_table/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ar_to_html_table
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Kip Cole