to-csv 1.0.2 → 1.0.3

data/Rakefile

@@ -1,52 +1,52 @@
-#encoding: utf-8
-
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/gempackagetask'
-load 'test/tasks.rake'
-
-TO_CSV_VERSION = '1.0.2'
-CLEAN.include('pkg')
-
-spec = Gem::Specification.new do |s|
-  s.author = "Ícaro Leopoldino da Motta"
-  s.email = "icaro.ldm@gmail.com"
-  s.platform = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 1.8.6'
-  s.name = "to-csv"
-  s.summary = s.description = "Convert arrays to CSV (array of hashes, matrixes, ActiveRecord objects etc)."
-  s.homepage = "http://github.com/ilmotta/to-csv"
-  s.version = TO_CSV_VERSION
-
-  s.add_dependency 'activesupport', '>= 2.3.5'
-  s.add_development_dependency 'activerecord', '>= 2.3.5'
-  s.add_development_dependency 'sqlite3-ruby', '>= 1.2.5'
-
-  s.has_rdoc = true
-  s.require_path = "lib"
-  s.extra_rdoc_files = FileList['*.rdoc']
-  s.files = FileList['init.rb', 'MIT-LICENSE', 'Rakefile', 'lib/**/*', 'test/**/*']
-
-  s.post_install_message = %q{
-========================================================================
-
-  Thanks for installing ToCSV.
-
-  If your Ruby version is lower than 1.9 you need to install fastercsv.
-
-    $ sudo gem install fastercsv
-
-========================================================================
-
-}
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.define
-end
-
-task :build => [:clean, :repackage]
-
-task :default => :test
-
+#encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+load 'test/tasks.rake'
+
+TO_CSV_VERSION = '1.0.3'
+CLEAN.include('pkg')
+
+spec = Gem::Specification.new do |s|
+  s.author = "Ícaro Leopoldino da Motta"
+  s.email = "icaro.ldm@gmail.com"
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.8.7'
+  s.name = "to-csv"
+  s.summary = s.description = "Convert arrays to CSV (array of hashes, matrixes, ActiveRecord objects etc)."
+  s.homepage = "http://github.com/ilmotta/to-csv"
+  s.version = TO_CSV_VERSION
+
+  s.add_dependency 'activesupport', '>= 2.3.5'
+  s.add_development_dependency 'activerecord', '>= 2.3.5'
+  s.add_development_dependency 'sqlite3-ruby', '>= 1.2.5'
+
+  s.has_rdoc = true
+  s.require_path = "lib"
+  s.extra_rdoc_files = FileList['*.rdoc']
+  s.files = FileList['init.rb', 'MIT-LICENSE', 'Rakefile', 'lib/**/*', 'test/**/*']
+
+  s.post_install_message = %q{
+========================================================================
+
+  Thanks for installing ToCSV.
+
+  If your Ruby version is lower than 1.9 you need to install fastercsv.
+
+    $ sudo gem install fastercsv
+
+========================================================================
+
+}
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.define
+end
+
+task :build => [:clean, :repackage]
+
+task :default => :test
+

data/lib/to_csv.rb

@@ -1,63 +1,64 @@
-require RUBY_VERSION < '1.9' ? 'fastercsv' : 'csv'
-require 'ostruct'
-require 'active_support'
-require 'to_csv/csv_converter'
-
-module ToCSV
-  mattr_accessor :byte_order_marker, :locale, :primary_key, :timestamps
-  mattr_accessor :csv_options
-  self.csv_options = { :col_sep => ';' }
-  
-  #
-  # Returns a CSV string.
-  #
-  # ==== Available Options:
-  #
-  # 1. *options*
-  #    +byte_order_marker+::
-  #      If true, a Byte Order Maker (BOM) will be inserted at
-  #      the beginning of the output. It's useful if you want to force
-  #      MS Excel to read UTF-8 encoded files, otherwise it will just
-  #      decode them as Latin1 (ISO-8859-1). Default: +false+.
-  #    +only+::
-  #      Same behavior as with the +to_json+ method.
-  #    +except+::
-  #      Same as +only+ option.
-  #    +methods+::
-  #      Accepts a symbol or an array with additional methods to be included.
-  #    +timestamps+::
-  #      Include timestamps +created_at+, +created_on+, +updated_at+ and
-  #      +updated_on+. If false Default: +false+.
-  #    +primary_key+::
-  #      If +true+ the object's primary key will be added as an attribute,
-  #      which in turn will be mapped to a CSV column. Default: +false+.
-  #    +headers+::
-  #       If this list is <tt>nil</tt> then headers will be in alphabetical order.
-  #       If it is an empty array or <tt>false</tt>, no headers will be shown.
-  #       If it is non empty, headers will be sorted in the order specified.
-  #       <tt>:all</tt> can be used as a placeholder for all attributes not
-  #       explicitly named.
-  #    +locale+::
-  #      In a Rails environment, it will automatically take the current locale
-  #      and will use it to translate the columns to friendly headers.
-  #      Methods will be translated from
-  #      <tt>[:activerecord, :attributes, <model>]</tt>. If the translation
-  #      is missing, then a simple humanize will be called.
-  #
-  # 2. *csv_options*
-  #    Accepts all options listed in <tt>FasterCSV::DEFAULT_OPTIONS</tt>.
-  #
-  def to_csv(options = {}, csv_options = {}, &block)
-    return '' if empty?
-    csv_converter = ToCSV::Converter.new(self, options, csv_options, &block)
-    csv_converter.to_csv
-  end
-end
-
-ActiveRecord::NamedScope::Scope.send(:include, ToCSV) if defined?(ActiveRecord::NamedScope::Scope)
-
-class Array
-  remove_method :to_csv
-  extend  ToCSV
-  include ToCSV
-end
+require RUBY_VERSION < '1.9' ? 'fastercsv' : 'csv'
+require 'ostruct'
+require 'active_support/core_ext'
+require 'to_csv/csv_converter'
+
+module ToCSV
+  mattr_accessor :byte_order_marker, :locale, :primary_key, :timestamps
+  mattr_accessor :csv_options
+  self.csv_options = { :col_sep => ';', :encoding => 'UTF-8' }
+
+  #
+  # Returns a CSV string.
+  #
+  # ==== Available Options:
+  #
+  # 1. *options*
+  #    +byte_order_marker+::
+  #      If true, a Byte Order Maker (BOM) will be inserted at
+  #      the beginning of the output. It's useful if you want to force
+  #      MS Excel to read UTF-8 encoded files, otherwise it will just
+  #      decode them as Latin1 (ISO-8859-1). Default: +false+.
+  #    +only+::
+  #      Same behavior as with the +to_json+ method.
+  #    +except+::
+  #      Same as +only+ option.
+  #    +methods+::
+  #      Accepts a symbol or an array with additional methods to be included.
+  #    +timestamps+::
+  #      Include timestamps +created_at+, +created_on+, +updated_at+ and
+  #      +updated_on+. If false Default: +false+.
+  #    +primary_key+::
+  #      If +true+ the object's primary key will be added as an attribute,
+  #      which in turn will be mapped to a CSV column. Default: +false+.
+  #    +headers+::
+  #       If this list is <tt>nil</tt> then headers will be in alphabetical order.
+  #       If it is an empty array or <tt>false</tt>, no headers will be shown.
+  #       If it is non empty, headers will be sorted in the order specified.
+  #       <tt>:all</tt> can be used as a placeholder for all attributes not
+  #       explicitly named.
+  #    +locale+::
+  #      In a Rails environment, it will automatically take the current locale
+  #      and will use it to translate the columns to friendly headers.
+  #      Methods will be translated from
+  #      <tt>[:activerecord, :attributes, <model>]</tt>. If the translation
+  #      is missing, then a simple humanize will be called.
+  #
+  # 2. *csv_options*
+  #    Accepts all options listed in <tt>FasterCSV::DEFAULT_OPTIONS</tt>.
+  #
+  def to_csv(options = {}, csv_options = {}, &block)
+    return '' if empty?
+    csv_converter = ToCSV::Converter.new(self, options, csv_options, &block)
+    csv_converter.to_csv
+  end
+end
+
+ActiveRecord::NamedScope::Scope.send(:include, ToCSV) if defined?(ActiveRecord::NamedScope::Scope)
+
+class Array
+  remove_method :to_csv
+  extend  ToCSV
+  include ToCSV
+end
+

data/lib/to_csv/csv_converter.rb

@@ -1,174 +1,237 @@
-#encoding: utf-8
-
-module ToCSV
-
-  CSVClass = RUBY_VERSION < '1.9' ? ::FasterCSV : ::CSV
-
-  class Converter
-
-    def initialize(data, options = {}, csv_options = {}, &block)
-      @opts = options.to_options.reverse_merge({
-        :byte_order_marker => ToCSV.byte_order_marker,
-        :locale            => ToCSV.locale || ::I18n.locale,
-        :primary_key       => ToCSV.primary_key,
-        :timestamps        => ToCSV.timestamps
-      })
-
-      @opts[:only]    = Array(@opts[:only]).map(&:to_s)
-      @opts[:except]  = Array(@opts[:except]).map(&:to_s)
-      @opts[:methods] = Array(@opts[:methods]).map(&:to_s)
-
-      @data = data
-      @block = block
-      @csv_options = csv_options.to_options.reverse_merge(ToCSV.csv_options)
-    end
-
-    def to_csv
-      build_headers_and_rows
-
-      output = CSVClass.generate(@csv_options) do |csv|
-        csv << @header_row if @header_row.try(:any?)
-        @rows.each { |row| csv << row }
-      end
-
-      @opts[:byte_order_marker] ? "\xEF\xBB\xBF#{output}" : output
-    end
-
-    private
-
-      def build_headers_and_rows
-        send "headers_and_rows_from_#{ discover_data_type }"
-      end
-
-      def discover_data_type
-        test_data = @data.first
-        return 'ar_object' if instance_of_active_record? test_data
-        return 'hash' if test_data.is_a? Hash
-        return 'unidimensional_array' if test_data.is_a?(Array) && !test_data.first.is_a?(Array)
-        return 'bidimensional_array' if test_data.is_a?(Array) && test_data.first.is_a?(Array) && test_data.first.size == 2
-        'simple_data'
-      end
-
-      def instance_of_active_record?(obj)
-        obj.class.base_class.superclass == ActiveRecord::Base
-      rescue Exception
-        false
-      end
-
-      def headers_and_rows_from_simple_data
-        @header_row = nil
-        @rows = [@data.dup]
-      end
-
-      def headers_and_rows_from_hash
-        @header_row = @data.first.keys if display_headers?
-        @rows = @data.map(&:values)
-      end
-
-      def headers_and_rows_from_unidimensional_array
-        @header_row = @data.first if display_headers?
-        @rows = @data[1..-1]
-      end
-
-      def headers_and_rows_from_bidimensional_array
-        @header_row = @data.first.map(&:first) if display_headers?
-        @rows = @data.map { |array| array.map(&:last) }
-      end
-
-      def headers_and_rows_from_ar_object
-        attributes = sort_attributes(filter_attributes(attribute_names))
-        @header_row = human_attribute_names(attributes) if display_headers?
-
-        @rows = if @block
-          attributes_class = Struct.new(*attributes.map(&:to_sym))
-          @data.map do |item|
-            @block.call(obj = attributes_class.new, item)
-            attributes.map { |attribute| obj[attribute] || try_formatting_date(item.send(attribute)) }
-          end
-        else
-          @data.map do |item|
-            attributes.map { |attribute| try_formatting_date item.send(attribute) }
-          end
-        end
-      end
-
-      def display_headers?
-        @opts[:headers].nil? || (Array(@opts[:headers]).any? && Array(@opts[:headers]).all? { |h| h != false })
-      end
-
-      def human_attribute_names(attributes)
-        @opts[:locale] ? translate(attributes) : humanize(attributes)
-      end
-
-      def humanize(attributes)
-        attributes.map(&:humanize)
-      end
-
-      def translate(attributes)
-        ::I18n.with_options :locale => @opts[:locale], :scope => [:activerecord, :attributes, @data.first.class.to_s.underscore] do |locale|
-          attributes.map { |attribute| locale.t(attribute, :default => attribute.humanize) }
-        end
-      end
-
-      def try_formatting_date(value)
-        is_a_date?(value) ? value.to_s(:db) : value
-      end
-
-      def is_a_date?(value)
-        value.is_a?(Time) || value.is_a?(Date) || value.is_a?(DateTime)
-      end
-
-      def primary_key_filter(attributes)
-        return attributes if @opts[:primary_key]
-        attributes - Array(@data.first.class.primary_key.to_s)
-      end
-
-      def timestamps_filter(attributes)
-        return attributes if @opts[:timestamps]
-        return attributes if (@opts[:only] + @opts[:except]).any? { |attribute| timestamps.include? attribute }
-        attributes - timestamps
-      end
-
-      def timestamps
-        @timestamps ||= %w[ created_at updated_at created_on updated_on ]
-      end
-
-      def methods_filter(attributes)
-        attributes | @opts[:methods]
-      end
-
-      def only_filter(attributes)
-        return attributes if @opts[:only].empty?
-        attributes & @opts[:only]
-      end
-
-      def except_filter(attributes)
-        attributes - @opts[:except]
-      end
-
-      def attribute_names
-        @data.first.attribute_names.map(&:to_s)
-      end
-
-      def filter_attributes(attributes)
-        attributes = methods_filter(attributes)
-        attributes = primary_key_filter(attributes)
-        attributes = timestamps_filter(attributes)
-        attributes = @opts[:only].any?? only_filter(attributes) : except_filter(attributes)
-        attributes
-      end
-
-      def sort_attributes(attributes)
-        attributes = attributes.map(&:to_s).sort
-        return attributes if @opts[:headers].nil?
-        headers = Array(@opts[:headers]).map(&:to_s)
-        headers.delete_if { |attribute| attribute == 'false' }
-        if index = headers.index('all')
-          (headers & attributes).insert(index, (attributes - headers)).flatten
-        else
-          headers + (attributes - headers)
-        end
-      end
-  end
-end
-
+# encoding: UTF-8
+
+module ToCSV
+
+  CSVClass = RUBY_VERSION < '1.9' ? ::FasterCSV : ::CSV
+
+  class Converter
+    def initialize(data, options = {}, csv_options = {}, &block)
+      @opts = options.to_options.reverse_merge({
+        :byte_order_marker => ToCSV.byte_order_marker,
+        :locale            => ToCSV.locale || ::I18n.locale,
+        :primary_key       => ToCSV.primary_key,
+        :timestamps        => ToCSV.timestamps
+      })
+
+      @opts[:only]    = Array(@opts[:only]).map(&:to_s)
+      @opts[:except]  = Array(@opts[:except]).map(&:to_s)
+      @opts[:methods] = Array(@opts[:methods]).map(&:to_s)
+
+      @data = data
+      @block = block
+      @csv_options = csv_options.to_options.reverse_merge(ToCSV.csv_options)
+      @associations = @opts[:include].kind_of?(Array) ? @opts[:include] : [@opts[:include]] if @opts[:include]
+    end
+
+    def to_csv
+      build_headers_and_rows
+
+      output = CSVClass.generate(@csv_options) do |csv|
+        csv << @header_row if @header_row.try(:any?)
+        @rows.each { |row| csv << row }
+      end
+
+      @opts[:byte_order_marker] ? "\xEF\xBB\xBF#{output}" : output
+    end
+
+    private
+      def build_headers_and_rows
+        send "headers_and_rows_from_#{ discover_data_type }"
+      end
+
+      def discover_data_type
+        test_data = @data.first
+        return 'ar_object' if instance_of_active_record? test_data
+        return 'hash' if test_data.is_a? Hash
+        return 'unidimensional_array' if test_data.is_a?(Array) && !test_data.first.is_a?(Array)
+        return 'bidimensional_array' if test_data.is_a?(Array) && test_data.first.is_a?(Array) && test_data.first.size == 2
+        'simple_data'
+      end
+
+      def instance_of_active_record?(obj)
+        obj.class.base_class.superclass == ActiveRecord::Base
+      rescue Exception
+        false
+      end
+
+      def headers_and_rows_from_simple_data
+        @header_row = nil
+        @rows = [@data.dup]
+      end
+
+      def headers_and_rows_from_hash
+        @header_row = @data.first.keys if display_headers?
+        @rows = @data.map(&:values)
+      end
+
+      def headers_and_rows_from_unidimensional_array
+        @header_row = @data.first if display_headers?
+        @rows = @data[1..-1]
+      end
+
+      def headers_and_rows_from_bidimensional_array
+        @header_row = @data.first.map(&:first) if display_headers?
+        @rows = @data.map { |array| array.map(&:last) }
+      end
+
+      def headers_and_rows_from_ar_object
+        attributes = sort_attributes(filter_attributes(attribute_names))
+        if display_headers?
+          @header_row =  human_attribute_names(attributes)
+          @header_row |= human_attribute_names(headers_from_association_ar_object) if @opts[:include]
+        end
+        @rows = if @block
+          attributes_class = Struct.new(*attributes.map(&:to_sym))
+          @data.map do |item|
+            @block.call(obj = attributes_class.new, item)
+            result = attributes.map { |attribute| obj[attribute] || try_formatting_date(item.send(attribute)) }
+            (result << rows_from_association_ar_object(item);result.flatten!) if @opts[:include] && @row_header_association
+            result
+          end
+        else
+          @data.map do |item|
+            result = attributes.map { |attribute| try_formatting_date item.send(attribute) }
+            (result << rows_from_association_ar_object(item);result.flatten!) if @opts[:include] && @row_header_association
+            result
+          end
+        end
+      end
+
+      def rows_from_association_ar_object(item)
+        @result = []
+        @associations.each do |association|
+          @row_header_association = instance_variable_get("@row_header_association_for_#{from_sym_to_string(association)}")
+          association = association.to_sym
+          case item.class.reflect_on_association(association).macro
+            when :has_many, :has_and_belongs_to_many
+              records = item.send(association).to_a
+              unless records.empty?
+                records.collect do |record|
+                  @row_header_association.map do |attribute|
+                    @result << try_formatting_date(record.send(attribute))
+                  end
+                end
+              end
+            when :has_one, :belongs_to
+              if record = item.send(association)
+                @row_header_association.map do |attribute|
+                  @result <<  try_formatting_date(record.send(attribute))
+                end
+              end
+          end
+        end
+        @result.flatten
+      end
+
+      def headers_from_association_ar_object
+        @header_association = []
+        @associations.each do |association|
+          association = association.to_sym
+          case @data.first.class.reflect_on_association(association).macro
+            when :has_many, :has_and_belongs_to_many
+              records = @data.first.send(association).to_a
+              unless records.empty?
+                instance_variable_set("@row_header_association_for_#{from_sym_to_string(association)}", records.first.attribute_names.map(&:to_s))
+                @row_header_association = instance_variable_get("@row_header_association_for_#{from_sym_to_string(association)}")
+                (1..records.size).each do |record|
+                  @row_header_association.map do |header|
+                    @header_association << "#{from_sym_to_string(association)}_#{record}_#{header}"
+                  end
+                end
+              end
+            when :has_one, :belongs_to
+              instance_variable_set("@row_header_association_for_#{from_sym_to_string(association)}", @data.first.send(association).attribute_names.map(&:to_s))
+              @row_header_association = instance_variable_get("@row_header_association_for_#{from_sym_to_string(association)}")
+              @data.first.send(association).attribute_names.map do |header|
+                @header_association << "#{from_sym_to_string(association)}_#{header}"
+              end
+          end
+        end
+        @header_association.flatten
+      end
+
+      def display_headers?
+        @opts[:headers].nil? || (Array(@opts[:headers]).any? && Array(@opts[:headers]).all? { |h| h != false })
+      end
+
+      def human_attribute_names(attributes)
+        @opts[:locale] ? translate(attributes) : humanize(attributes)
+      end
+
+      def humanize(attributes)
+        attributes.map(&:humanize)
+      end
+
+      def translate(attributes)
+        ::I18n.with_options :locale => @opts[:locale], :scope => [:activerecord, :attributes, @data.first.class.to_s.underscore] do |locale|
+          attributes.map { |attribute| locale.t(attribute, :default => attribute.humanize) }
+        end
+      end
+
+      def try_formatting_date(value)
+        is_a_date?(value) ? value.to_s(:db) : value
+      end
+
+      def is_a_date?(value)
+        value.is_a?(Time) || value.is_a?(Date) || value.is_a?(DateTime)
+      end
+
+      def primary_key_filter(attributes)
+        return attributes if @opts[:primary_key]
+        attributes - Array(@data.first.class.primary_key.to_s)
+      end
+
+      def timestamps_filter(attributes)
+        return attributes if @opts[:timestamps]
+        return attributes if (@opts[:only] + @opts[:except]).any? { |attribute| timestamps.include? attribute }
+        attributes - timestamps
+      end
+
+      def timestamps
+        @timestamps ||= %w[ created_at updated_at created_on updated_on ]
+      end
+
+      def methods_filter(attributes)
+        attributes | @opts[:methods]
+      end
+
+      def only_filter(attributes)
+        return attributes if @opts[:only].empty?
+        attributes & @opts[:only]
+      end
+
+      def except_filter(attributes)
+        attributes - @opts[:except]
+      end
+
+      def attribute_names
+        @data.first.attribute_names.map(&:to_s)
+      end
+
+      def filter_attributes(attributes)
+        attributes = methods_filter(attributes)
+        attributes = primary_key_filter(attributes)
+        attributes = timestamps_filter(attributes)
+        attributes = @opts[:only].any?? only_filter(attributes) : except_filter(attributes)
+        attributes
+      end
+
+      def sort_attributes(attributes)
+        attributes = attributes.map(&:to_s).sort
+        return attributes if @opts[:headers].nil?
+        headers = Array(@opts[:headers]).map(&:to_s)
+        headers.delete_if { |attribute| attribute == 'false' }
+        if index = headers.index('all')
+          (headers & attributes).insert(index, (attributes - headers)).flatten
+        else
+          headers + (attributes - headers)
+        end
+      end
+
+      def from_sym_to_string(sym)
+        sym.to_s.gsub(':','')
+      end
+
+  end
+end
+