comma 4.2.0 → 4.3.0

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,46 @@ 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 NameError
+        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.3.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
@@ -179,7 +175,6 @@ describe Comma, 'to_comma data/headers object extensions' do # rubocop:disable M
       expect { @foo.to_comma_headers(:bad) }.to raise_error
       expect { Array(@foo).to_comma(:bad) }.to raise_error
     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

data/spec/comma/data_extractor_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 # comma do
@@ -8,7 +10,6 @@ require 'spec_helper'
 # end
 
 describe Comma::DataExtractor do # rubocop:disable Metrics/BlockLength
-
   before do
     @isbn = Isbn.new('123123123', '321321321')
     @book = Book.new('Smalltalk-80', 'Language and Implementation', @isbn)
@@ -17,41 +18,36 @@ describe Comma::DataExtractor do # rubocop:disable Metrics/BlockLength
   end
 
   describe 'when no parameters are provided' do
-
     it 'should use the string value returned by sending the method name on the object' do
       @data.should include('Language and Implementation')
     end
   end
 
   describe 'when given a string description as a parameter' do
-
     it 'should use the string value returned by sending the method name on the object' do
       @data.should include('Smalltalk-80')
     end
   end
 
   describe 'when an hash is passed as a parameter' do
-
     describe 'with a string value' do
-
       it 'should use the string value, returned by sending the hash key to the object' do
         @data.should include('123123123')
         @data.should include('321321321')
       end
 
       it 'should not fail when an associated object is nil' do
-        lambda { Book.new('Smalltalk-80', 'Language and Implementation', nil).to_comma }.should_not raise_error
+        -> { Book.new('Smalltalk-80', 'Language and Implementation', nil).to_comma }.should_not raise_error
       end
     end
   end
-
 end
 
 describe Comma::DataExtractor, 'id attribute' do
   before do
     @data = Class.new(Struct.new(:id)) do
       comma do
-        id 'ID' do |id| '42' end
+        id 'ID' do |_id| '42' end
       end
     end.new(1).to_comma
   end
@@ -68,7 +64,7 @@ describe Comma::DataExtractor, 'with static column method' do
         __static_column__
         __static_column__ 'STATIC'
         __static_column__ 'STATIC' do '' end
-        __static_column__ 'STATIC' do |o| o.name end
+        __static_column__ 'STATIC', &:name
       end
     end.new(1, 'John Doe').to_comma
   end
@@ -84,7 +80,7 @@ describe Comma::DataExtractor, 'nil value' do
       comma do
         name
         name 'Name'
-        name 'Name' do |name| nil end
+        name 'Name' do |_name| nil end
       end
     end.new(1, nil).to_comma
   end