table-for 3.1.4 → 3.1.5

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+3.1.5
+* Added automatic internationalization (thanks killthekitten)
+
 3.1.0
 * Since templating was moved from blocks into its own gem with_template, TableFor::Base now extends WithTemplate::Base instead of Blocks::Base.
 

data/README.rdoc

@@ -148,3 +148,20 @@ TODO
 
 == Using "Before" and "After" hooks
 TODO
+
+== Internationalization
++table-for+ can do some dirty job for you, if you are using i18n by common rails conventions. For example, you have following in your en.yml:
+
+  en:
+    activerecord:
+      attributes:
+        user:
+          id: '#'
+          name: "Username"
+          bio: "Short biography"
+
+Then, +table-for+ will automatically catch up correct translations for column headers. If you are not familiar with i18n, you can always pass a custom header to the column:
+
+  <%= table_for @users do |table| %>
+    <% table.column :parent_name, header: "Mr. Smith" %>
+  <% end %>

data/VERSION

@@ -1 +1 @@
-3.1.4
+3.1.5

data/lib/table_for/helper_methods.rb

@@ -36,7 +36,7 @@ module TableFor
             elsif column.anonymous
               nil
             else
-              column.name.to_s.titleize
+              I18n.t("#{translation_lookup_prefix}.#{column.name.to_s.underscore}", :default => column.name.to_s.titleize)
             end
           end
         end
@@ -83,6 +83,19 @@ module TableFor
           view.capture(self, &block)
         end
       end
+
+      private
+      def translation_lookup_prefix
+        if global_options[:records].respond_to?(:model)
+          "activerecord.attributes.#{global_options[:records].model.to_s.underscore}"
+        elsif global_options[:records].all? {|record| record.is_a?(ActiveRecord::Base) && record.class == global_options[:records].first.class }
+          "activerecord.attributes.#{global_options[:records].first.class.to_s.underscore}"
+        elsif global_options[:records].all? {|record| record.class == global_options[:records].first.class }
+          "tables.columns.#{global_options[:records].first.class.to_s.underscore}"
+        else
+          "tables.columns"
+        end
+      end
     end
   end
 end

data/spec/integration/table_for_spec.rb

@@ -9,6 +9,13 @@ describe "table_for" do
     end
   end
 
+  class Offer
+    attr_accessor :first_name
+    def initialize(first_name)
+      @first_name = first_name
+    end
+  end
+
   before :each do
     User.create! :email => "andrew.hunter@livingsocial.com", :first_name => "Andrew", :last_name => "Hunter"
     User.create! :email => "todd.fisher@livingsocial.com", :first_name => "Todd", :last_name => "Fisher"
@@ -75,6 +82,51 @@ describe "table_for" do
       xml = XmlSimple.xml_in(%%<table><thead style="background-color: orange"><tr></tr></thead><tbody><tr></tr></tbody></table>%)
       XmlSimple.xml_in(buffer, 'NormaliseSpace' => 2).should eql xml
     end
+
+    it "should translate column names" do
+      rails_4_active_record_array = @users[0, 1].clone
+      rails_4_active_record_array.expects(:model => User)
+      I18n.expects(:t).with("activerecord.attributes.user.first_name", :default => "First Name").returns("Vorname")
+      buffer = @view.table_for rails_4_active_record_array do |table|
+        table.column :first_name
+      end
+      xml = XmlSimple.xml_in(%%<table><thead><tr><th>Vorname</th></tr></thead><tbody><tr><td>Andrew</td></tr></tbody></table>%)
+      XmlSimple.xml_in(buffer, 'NormaliseSpace' => 2).should eql xml
+
+      I18n.expects(:t).with("activerecord.attributes.user.first_name", :default => "First Name").returns("Vorname2")
+      buffer = @view.table_for @users[0,1] do |table|
+        table.column :first_name
+      end
+      xml = XmlSimple.xml_in(%%<table><thead><tr><th>Vorname2</th></tr></thead><tbody><tr><td>Andrew</td></tr></tbody></table>%)
+      XmlSimple.xml_in(buffer, 'NormaliseSpace' => 2).should eql xml
+
+      non_activerecord_array = [Offer.new("Timmy")]
+
+      I18n.expects(:t).with("tables.columns.offer.first_name", :default => "First Name").returns("Vorname3")
+      buffer = @view.table_for non_activerecord_array do |table|
+        table.column :first_name
+      end
+      xml = XmlSimple.xml_in(%%<table><thead><tr><th>Vorname3</th></tr></thead><tbody><tr><td>Timmy</td></tr></tbody></table>%)
+      XmlSimple.xml_in(buffer, 'NormaliseSpace' => 2).should eql xml
+
+      # the rare case where the array has objects of different types
+      mixed_array = [@users.first, Offer.new("Timmy")]
+      I18n.expects(:t).with("tables.columns.first_name", :default => "First Name").returns("Vorname3")
+      buffer = @view.table_for mixed_array do |table|
+        table.column :first_name
+      end
+      xml = XmlSimple.xml_in(%%<table><thead><tr><th>Vorname3</th></tr></thead><tbody><tr><td>Andrew</td></tr><tr><td>Timmy</td></tr></tbody></table>%)
+      XmlSimple.xml_in(buffer, 'NormaliseSpace' => 2).should eql xml
+    end
+
+    it "should not translate column name if header passed" do
+      I18n.expects(:t).never
+      buffer = @view.table_for @users[0,1] do |table|
+        table.column :first_name, :header => "My First Name"
+      end
+      xml = XmlSimple.xml_in(%%<table><thead><tr><th>My First Name</th></tr></thead><tbody><tr><td>Andrew</td></tr></tbody></table>%)
+      XmlSimple.xml_in(buffer, 'NormaliseSpace' => 2).should eql xml
+    end
   end
 
   describe "header_row block" do

data/table-for.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "table-for"
-  s.version = "3.1.4"
+  s.version = "3.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Hunter"]
-  s.date = "2013-10-15"
+  s.date = "2013-10-31"
   s.description = "table-for is a table builder for an array of objects, easily allowing overriding of how any aspect of the table is generated"
   s.email = "hunterae@gmail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table-for
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -234,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 570005552086543120
+      hash: 2078517187188360372
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: