comma 4.2.0 → 4.5.0

data/init.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'comma'

data/lib/comma.rb

@@ -1,26 +1,13 @@
-# load the right csv library
-if RUBY_VERSION >= '1.9'
-  require 'csv'
-  CSV_HANDLER = CSV
-else
-  begin
-    gem 'fastercsv'
-    require 'fastercsv'
+# frozen_string_literal: true
 
-    CSV_HANDLER = FasterCSV
-  rescue LoadError => e
-    raise "Error : FasterCSV not installed, please `gem install fastercsv` for faster processing on <Ruby 1.9"
-  end
-end
-
-raise "Error - This Comma version only supports Rails 3.x. Please use a 2.x version of Comma for use with earlier rails versions." if
-  defined? Rails and (Rails.version.split('.').map(&:to_i).first < 3)
+require 'csv'
+CSV_HANDLER = CSV
 
 module Comma
   DEFAULT_OPTIONS = {
-      :write_headers => true,
-      :style => :default
-    }
+    write_headers: true,
+    style: :default
+  }.freeze
 end
 
 require 'active_support/lazy_load_hooks'
@@ -38,30 +25,34 @@ require 'comma/generator'
 require 'comma/array'
 require 'comma/object'
 
-#Load into Rails controllers
+# Load into Rails controllers
 ActiveSupport.on_load(:action_controller) do
   if defined?(ActionController::Renderers) && ActionController::Renderers.respond_to?(:add)
     ActionController::Renderers.add :csv do |obj, options|
       filename    = options[:filename]  || 'data'
       extension   = options[:extension] || 'csv'
-
-      if Rails.version >= "5.0.0"
-        mime_type   = options[:mime_type] || Mime[:csv]
-      else
-        mime_type   = options[:mime_type] || Mime::CSV
-      end
-
-      #Capture any CSV optional settings passed to comma or comma specific options
-      csv_options = options.slice(*CSV_HANDLER::DEFAULT_OPTIONS.merge(Comma::DEFAULT_OPTIONS).keys).each_with_object({}) do |(k, v), h|
+      mime_type = if Rails.version >= '5.0.0'
+                    options[:mime_type] || Mime[:csv]
+                  else
+                    options[:mime_type] || Mime::CSV
+                  end
+      with_bom = options.delete(:with_bom) || false
+
+      # Capture any CSV optional settings passed to comma or comma specific options
+      csv_options = options.slice(*CSV_HANDLER::DEFAULT_OPTIONS.merge(Comma::DEFAULT_OPTIONS).keys)
+      csv_options = csv_options.each_with_object({}) do |(k, v), h|
         # XXX: Convert string to boolean
         h[k] = case k
-        when :write_headers
-          v = (v != 'false') if v.is_a?(String)
-        else
-          v
-        end
+               when :write_headers
+                 (v != 'false') if v.is_a?(String)
+               else
+                 v
+               end
       end
-      send_data obj.to_comma(csv_options), :type => mime_type, :disposition => "attachment; filename=\"#{filename}.#{extension}\""
+      data = obj.to_comma(csv_options)
+      data = "\xEF\xBB\xBF#{data}" if with_bom
+      disposition = "attachment; filename=\"#{filename}.#{extension}\""
+      send_data data, type: mime_type, disposition: disposition
     end
   end
 end

data/lib/comma/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Array
   def to_comma(style = :default)
     Comma::Generator.new(self, style).run(:each)

data/lib/comma/data_extractor.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 require 'comma/extractor'
 
 module Comma
-
   class DataExtractor < Extractor
-
     class ExtractValueFromInstance
       def initialize(instance)
         @instance = instance
@@ -42,7 +42,7 @@ module Comma
 
       def null_association
         @null_association ||= Class.new(Class.const_defined?(:BasicObject) ? ::BasicObject : ::Object) do
-          def method_missing(symbol, *args, &block)
+          def method_missing(_symbol, *_args, &_block)
             nil
           end
         end.new
@@ -56,7 +56,7 @@ module Comma
       args.each do |arg|
         case arg
         when Hash
-          arg.each do |k, v|
+          arg.each do |k, _v|
             @results << ExtractValueFromAssociationOfInstance.new(@instance, sym).extract(k, &block)
           end
         when Symbol
@@ -69,7 +69,7 @@ module Comma
       end
     end
 
-    def __static_column__(header = nil, &block)
+    def __static_column__(_header = nil, &block)
       @results << (block ? yield(@instance) : nil)
     end
   end

data/lib/comma/data_mapper_collection.rb

@@ -1,5 +1,11 @@
-class DataMapper::Collection
-  def to_comma(style = :default)
-    Comma::Generator.new(self, style).run(:each)
+# frozen_string_literal: true
+
+if defined?(DataMapper)
+  module DataMapper
+    class Collection
+      def to_comma(style = :default)
+        Comma::Generator.new(self, style).run(:each)
+      end
+    end
   end
 end

data/lib/comma/extractor.rb

@@ -1,7 +1,7 @@
-module Comma
+# frozen_string_literal: true
 
+module Comma
   class Extractor
-
     def initialize(instance, style, formats)
       @instance = instance
       @style = style
@@ -10,7 +10,7 @@ module Comma
     end
 
     def results
-      instance_eval &@formats[@style]
+      instance_eval(&@formats[@style])
       @results.map { |r| convert_to_data_value(r) }
     end
 
@@ -28,7 +28,5 @@ module Comma
     def convert_to_data_value(result)
       result.nil? ? result : result.to_s
     end
-
   end
-
 end

data/lib/comma/generator.rb

@@ -1,24 +1,24 @@
-module Comma
+# frozen_string_literal: true
 
+module Comma
   class Generator
-
     def initialize(instance, style)
       @instance = instance
       @style    = style
       @options  = {}
 
-      if @style.is_a? Hash
-        @options                  = @style.clone
-        @style                    = @options.delete(:style) || Comma::DEFAULT_OPTIONS[:style]
-        @filename                 = @options.delete(:filename)
-      end
+      return unless @style.is_a?(Hash)
+
+      @options                  = @style.clone
+      @style                    = @options.delete(:style) || Comma::DEFAULT_OPTIONS[:style]
+      @filename                 = @options.delete(:filename)
     end
 
     def run(iterator_method)
       if @filename
-        CSV_HANDLER.open(@filename, 'w', @options){ |csv| append_csv(csv, iterator_method) } and return true
+        CSV_HANDLER.open(@filename, 'w', **@options) { |csv| append_csv(csv, iterator_method) } && (return true)
       else
-        CSV_HANDLER.generate(@options){ |csv| append_csv(csv, iterator_method) }
+        CSV_HANDLER.generate(**@options) { |csv| append_csv(csv, iterator_method) }
       end
     end
 
@@ -26,12 +26,12 @@ module Comma
 
     def append_csv(csv, iterator_method)
       return '' if @instance.empty?
+
       csv << @instance.first.to_comma_headers(@style) unless
-        @options.has_key?(:write_headers) && !@options[:write_headers]
+        @options.key?(:write_headers) && !@options[:write_headers]
       @instance.send(iterator_method) do |object|
         csv << object.to_comma(@style)
       end
     end
-
   end
 end

data/lib/comma/header_extractor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'comma/extractor'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/date_time/conversions'
@@ -6,44 +8,47 @@ require 'active_support/core_ext/string/inflections'
 
 module Comma
   class HeaderExtractor < Extractor
-
     class_attribute :value_humanizer
 
-    DEFAULT_VALUE_HUMANIZER = lambda do |value, model_class|
+    DEFAULT_VALUE_HUMANIZER = lambda do |value, _model_class|
       value.is_a?(String) ? value : value.to_s.humanize
     end
     self.value_humanizer = DEFAULT_VALUE_HUMANIZER
 
-    def method_missing(sym, *args, &block)
+    def method_missing(sym, *args, &_block)
       model_class = @instance.class
-      @results << self.value_humanizer.call(sym, model_class) if args.blank?
+      @results << value_humanizer.call(sym, model_class) if args.blank?
       args.each do |arg|
         case arg
         when Hash
-          arg.each do |k, v|
-            @results << self.value_humanizer.call(v, get_association_class(model_class, sym))
+          arg.each do |_k, v|
+            @results << value_humanizer.call(v, get_association_class(model_class, sym))
           end
         when Symbol
-          @results << self.value_humanizer.call(arg, get_association_class(model_class, sym))
+          @results << value_humanizer.call(arg, get_association_class(model_class, sym))
         when String
-          @results << self.value_humanizer.call(arg, model_class)
+          @results << value_humanizer.call(arg, model_class)
         else
           raise "Unknown header symbol #{arg.inspect}"
         end
       end
     end
 
-    def __static_column__(header = '', &block)
+    def __static_column__(header = '', &_block)
       @results << header
     end
 
     private
 
-    def get_association_class(model_class, association)      
-      if model_class.respond_to?(:reflect_on_association)
-        association = model_class.reflect_on_association(association)
-        association.klass rescue nil
-      end      
+    def get_association_class(model_class, association)
+      return unless model_class.respond_to?(:reflect_on_association)
+
+      begin
+        model_class.reflect_on_association(association)&.klass
+      rescue ArgumentError, NameError
+        # Since Rails 5.2, ArgumentError is raised.
+        nil
+      end
     end
   end
 end

data/lib/comma/mongoid.rb

@@ -1,12 +1,15 @@
-#Conditionally set to_comma on Mongoid records if mongoid gem is installed
+# frozen_string_literal: true
+
+# Conditionally set to_comma on Mongoid records if mongoid gem is installed
 begin
   require 'mongoid'
-  class Mongoid::Criteria
-    def to_comma(style = :default)
-      Comma::Generator.new(self, style).run(:each)
+
+  module Mongoid
+    class Criteria
+      def to_comma(style = :default)
+        Comma::Generator.new(self, style).run(:each)
+      end
     end
   end
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
-
-

data/lib/comma/object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'comma/data_extractor'
 require 'comma/header_extractor'
 
@@ -31,6 +33,8 @@ class Object
   end
 
   def raise_unless_style_exists(style)
-    raise "No comma format for class #{self.class} defined for style #{style}" unless self.comma_formats && self.comma_formats[style]
+    return if self.comma_formats && self.comma_formats[style]
+
+    raise "No comma format for class #{self.class} defined for style #{style}"
   end
 end

data/lib/comma/relation.rb

@@ -1,12 +1,18 @@
-class ActiveRecord::Relation
-  def to_comma(style = :default)
-    iterator_method =
-      if arel.ast.limit || !arel.ast.orders.empty?
-        Rails.logger.warn "#to_comma is being used on a relation with limit or order clauses. Falling back to iterating with :each. This can cause performance issues." if defined?(Rails)
-        :each
-      else
-        :find_each
-      end
-    Comma::Generator.new(self, style).run(iterator_method)
+# frozen_string_literal: true
+
+module ActiveRecord
+  class Relation
+    def to_comma(style = :default)
+      iterator_method =
+        if arel.ast.limit || !arel.ast.orders.empty?
+          Rails.logger.warn { <<~WARN } if defined?(Rails)
+            #to_comma is being used on a relation with limit or order clauses. Falling back to iterating with :each. This can cause performance issues.
+          WARN
+          :each
+        else
+          :find_each
+        end
+      Comma::Generator.new(self, style).run(iterator_method)
+    end
   end
 end

data/lib/comma/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Comma
-  VERSION = '4.2.0'
+  VERSION = '4.5.0'
 end

data/spec/comma/comma_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Comma do
-
   it 'should extend object to add a comma method' do
     expect(Object).to respond_to(:comma)
   end
@@ -30,7 +31,6 @@ describe Comma do
 end
 
 describe Comma, 'generating CSV' do # rubocop:disable Metrics/BlockLength
-
   before do
     @isbn = Isbn.new('123123123', '321321321')
     @book = Book.new('Smalltalk-80', 'Language and Implementation', @isbn)
@@ -40,53 +40,54 @@ describe Comma, 'generating CSV' do # rubocop:disable Metrics/BlockLength
   end
 
   it 'should extend Array to add a #to_comma method which will return CSV content for objects within the array' do
-    expect(@books.to_comma).to eq("Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n")
+    expected = "Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n" # rubocop:disable Metrics/LineLength
+    expect(@books.to_comma).to eq(expected)
   end
 
   it 'should return an empty string when generating CSV from an empty array' do
-    expect(Array.new.to_comma).to eq('')
+    expect([].to_comma).to eq('')
   end
 
-  it "should change the style when specified" do
+  it 'should change the style when specified' do
     expect(@books.to_comma(:brief)).to eq("Name,Description\nSmalltalk-80,Language and Implementation\n")
   end
 
   describe 'with :filename specified' do
-    after{ File.delete('comma.csv') }
+    after { File.delete('comma.csv') }
 
-    it "should write to the file" do
-      @books.to_comma(:filename => 'comma.csv')
-      expect(File.read('comma.csv')).to eq("Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n")
+    it 'should write to the file' do
+      @books.to_comma(filename: 'comma.csv')
+      expected = "Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n" # rubocop:disable Metrics/LineLength
+      expect(File.read('comma.csv')).to eq(expected)
     end
 
-    it "should accept FasterCSV options" do
-      @books.to_comma(:filename => 'comma.csv', :col_sep => ';', :force_quotes => true)
-      expect(File.read('comma.csv')).to eq("\"Title\";\"Description\";\"Issuer\";\"ISBN-10\";\"ISBN-13\"\n\"Smalltalk-80\";\"Language and Implementation\";\"ISBN\";\"123123123\";\"321321321\"\n")
+    it 'should accept FasterCSV options' do
+      @books.to_comma(filename: 'comma.csv', col_sep: ';', force_quotes: true)
+      expected = "\"Title\";\"Description\";\"Issuer\";\"ISBN-10\";\"ISBN-13\"\n\"Smalltalk-80\";\"Language and Implementation\";\"ISBN\";\"123123123\";\"321321321\"\n" # rubocop:disable Metrics/LineLength
+      expect(File.read('comma.csv')).to eq(expected)
     end
-
   end
 
-  describe "with FasterCSV options" do
-    it "should not change when options are empty" do
-      expect(@books.to_comma({})).to eq("Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n")
+  describe 'with FasterCSV options' do
+    it 'should not change when options are empty' do
+      expected = "Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n" # rubocop:disable Metrics/LineLength
+      expect(@books.to_comma({})).to eq(expected)
     end
 
     it 'should accept the options in #to_comma and generate the appropriate CSV' do
-      expect(@books.to_comma(:col_sep => ';', :force_quotes => true))
-        .to eq("\"Title\";\"Description\";\"Issuer\";\"ISBN-10\";\"ISBN-13\"\n\"Smalltalk-80\";\"Language and Implementation\";\"ISBN\";\"123123123\";\"321321321\"\n")
+      expected = "\"Title\";\"Description\";\"Issuer\";\"ISBN-10\";\"ISBN-13\"\n\"Smalltalk-80\";\"Language and Implementation\";\"ISBN\";\"123123123\";\"321321321\"\n" # rubocop:disable Metrics/LineLength
+      expect(@books.to_comma(col_sep: ';', force_quotes: true)).to eq(expected)
     end
 
-    it "should change the style when specified" do
-      expect(@books.to_comma(:style => :brief, :col_sep => ';', :force_quotes => true))
+    it 'should change the style when specified' do
+      expect(@books.to_comma(style: :brief, col_sep: ';', force_quotes: true))
         .to eq("\"Name\";\"Description\"\n\"Smalltalk-80\";\"Language and Implementation\"\n")
     end
   end
 end
 
 describe Comma, 'defining CSV descriptions' do
-
   describe 'with an unnamed description' do
-
     before do
       class Foo
         comma do; end
@@ -100,7 +101,6 @@ describe Comma, 'defining CSV descriptions' do
   end
 
   describe 'with a named description' do
-
     before do
       class Bar
         comma do; end
@@ -117,9 +117,7 @@ describe Comma, 'defining CSV descriptions' do
 end
 
 describe Comma, 'to_comma data/headers object extensions' do # rubocop:disable Metrics/BlockLength
-
   describe 'with unnamed descriptions' do
-
     before do
       class Foo
         attr_accessor :content
@@ -144,11 +142,9 @@ describe Comma, 'to_comma data/headers object extensions' do # rubocop:disable M
     it 'should return the CSV representation including header and content when called on an array' do
       expect(Array(@foo).to_comma).to eq("Content\ncontent\n")
     end
-
   end
 
   describe 'with named descriptions' do
-
     before do
       class Foo
         attr_accessor :content
@@ -175,11 +171,10 @@ describe Comma, 'to_comma data/headers object extensions' do # rubocop:disable M
     end
 
     it 'should raise an error if the requested description is not avaliable' do
-      expect { @foo.to_comma(:bad) }.to raise_error
-      expect { @foo.to_comma_headers(:bad) }.to raise_error
-      expect { Array(@foo).to_comma(:bad) }.to raise_error
+      expect { @foo.to_comma(:bad) }.to raise_error(RuntimeError)
+      expect { @foo.to_comma_headers(:bad) }.to raise_error(RuntimeError)
+      expect { Array(@foo).to_comma(:bad) }.to raise_error(RuntimeError)
     end
-
   end
 
   describe 'with block' do # rubocop:disable BlockLength
@@ -188,11 +183,11 @@ describe Comma, 'to_comma data/headers object extensions' do # rubocop:disable M
         attr_accessor :content, :created_at, :updated_at
         comma do
           content
-          content('Truncated Content') {|i| i && i.length > 10 ? i[0..10] : '---' }
-          created_at { |i| i && i.to_s(:db) }
-          updated_at { |i| i && i.to_s(:db) }
-          created_at 'Created Custom Label' do |i| i && i.to_s(:short) end
-          updated_at 'Updated at Custom Label' do |i| i && i.to_s(:short) end
+          content('Truncated Content') { |i| i && i.length > 10 ? i[0..10] : '---' }
+          created_at { |i| i&.to_s(:db) }
+          updated_at { |i| i&.to_s(:db) }
+          created_at 'Created Custom Label' do |i| i&.to_s(:short) end
+          updated_at 'Updated at Custom Label' do |i| i&.to_s(:short) end
         end
 
         def initialize(content, created_at = Time.now, updated_at = Time.now)
@@ -209,38 +204,66 @@ describe Comma, 'to_comma data/headers object extensions' do # rubocop:disable M
 
     it 'should return yielded values by block' do
       _header, foo = Array(@foo).to_comma.split("\n")
-      expect(foo).to eq([@content, @content[0..10], @time.to_s(:db), @time.to_s(:db), @time.to_s(:short), @time.to_s(:short)].join(','))
+      expected = [
+        @content,
+        @content[0..10],
+        @time.to_s(:db),
+        @time.to_s(:db),
+        @time.to_s(:short),
+        @time.to_s(:short)
+      ].join(',')
+      expect(foo).to eq(expected)
     end
 
     it 'should return headers with custom labels from block' do
       header, _foo = Array(@foo).to_comma.split("\n")
-      expect(header).to eq(['Content', 'Truncated Content', 'Created at', 'Updated at', 'Created Custom Label', 'Updated at Custom Label'].join(','))
+      expected = [
+        'Content',
+        'Truncated Content',
+        'Created at',
+        'Updated at',
+        'Created Custom Label',
+        'Updated at Custom Label'
+      ].join(',')
+      expect(header).to eq(expected)
     end
 
     it 'should put headers in place when forced' do
-      header, _foo = Array(@foo).to_comma(:write_headers => true).split("\n")
-      expect(header).to eq(['Content', 'Truncated Content', 'Created at', 'Updated at', 'Created Custom Label', 'Updated at Custom Label'].join(','))
+      header, _foo = Array(@foo).to_comma(write_headers: true).split("\n")
+      expected = [
+        'Content',
+        'Truncated Content',
+        'Created at',
+        'Updated at',
+        'Created Custom Label',
+        'Updated at Custom Label'
+      ].join(',')
+      expect(header).to eq(expected)
     end
 
     it 'should not write headers if specified' do
-      header, _foo = Array(@foo).to_comma(:write_headers => false).split("\n")
-      expect(header).to eq([@content, @content[0..10], @time.to_s(:db), @time.to_s(:db), @time.to_s(:short), @time.to_s(:short)].join(','))
+      header, _foo = Array(@foo).to_comma(write_headers: false).split("\n")
+      expected = [
+        @content,
+        @content[0..10],
+        @time.to_s(:db),
+        @time.to_s(:db),
+        @time.to_s(:short),
+        @time.to_s(:short)
+      ].join(',')
+      expect(header).to eq(expected)
     end
-
   end
 
-
   describe 'on an object with no comma declaration' do
-
     it 'should raise an error mentioning there is no comma description defined for that class' do
       expect { 'a string'.to_comma }.to raise_error('No comma format for class String defined for style default')
-      expect { 'a string'.to_comma_headers }.to raise_error('No comma format for class String defined for style default')
+      expect { 'a string'.to_comma_headers }
+        .to raise_error('No comma format for class String defined for style default')
     end
-
   end
 
   describe 'on objects using Single Table Inheritance' do
-
     before do
       class MySuperClass
         attr_accessor :content
@@ -273,9 +296,7 @@ describe Comma, 'to_comma data/headers object extensions' do # rubocop:disable M
     it 'should return and array of data content, as defined in comma block in super class, if not present in child' do
       expect(@childNoComma.to_comma).to eq(%w[super-content])
     end
-
   end
-
 end
 
 describe Comma, '__use__ keyword' do