comma 4.3.2 → 4.4.0

data/lib/comma.rb

@@ -31,12 +31,12 @@ ActiveSupport.on_load(:action_controller) do
     ActionController::Renderers.add :csv do |obj, options|
       filename    = options[:filename]  || 'data'
       extension   = options[:extension] || 'csv'
-
       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)
@@ -50,6 +50,7 @@ ActiveSupport.on_load(:action_controller) do
                end
       end
       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

data/lib/comma/generator.rb

@@ -16,9 +16,9 @@ module Comma
 
     def run(iterator_method)
       if @filename
-        CSV_HANDLER.open(@filename, 'w', @options) { |csv| append_csv(csv, iterator_method) } && (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
 

data/lib/comma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Comma
-  VERSION = '4.3.2'
+  VERSION = '4.4.0'
 end

data/spec/comma/comma_spec.rb

@@ -171,9 +171,9 @@ 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
 

data/spec/comma/data_extractor_spec.rb

@@ -19,25 +19,25 @@ describe Comma::DataExtractor do # rubocop:disable Metrics/BlockLength
 
   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')
+      expect(@data).to 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')
+      expect(@data).to 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')
+        expect(@data).to include('123123123')
+        expect(@data).to include('321321321')
       end
 
       it 'should not fail when an associated object is nil' do
-        -> { Book.new('Smalltalk-80', 'Language and Implementation', nil).to_comma }.should_not raise_error
+        expect { Book.new('Smalltalk-80', 'Language and Implementation', nil).to_comma }.not_to raise_error
       end
     end
   end
@@ -53,7 +53,7 @@ describe Comma::DataExtractor, 'id attribute' do
   end
 
   it 'id attribute should yield block' do
-    @data.should include('42')
+    expect(@data).to include('42')
   end
 end
 
@@ -70,7 +70,7 @@ describe Comma::DataExtractor, 'with static column method' do
   end
 
   it 'should extract headers' do
-    @data.should eq([nil, nil, '', 'John Doe'])
+    expect(@data).to eq([nil, nil, '', 'John Doe'])
   end
 end
 
@@ -86,6 +86,6 @@ describe Comma::DataExtractor, 'nil value' do
   end
 
   it 'should extract nil' do
-    @data.should eq([nil, nil, nil])
+    expect(@data).to eq([nil, nil, nil])
   end
 end

data/spec/comma/header_extractor_spec.rb

@@ -19,26 +19,26 @@ describe Comma::HeaderExtractor do # rubocop:disable Metrics/BlockLength
 
   describe 'when no parameters are provided' do
     it 'should use the method name as the header name, humanized' do
-      @headers.should include('Description')
+      expect(@headers).to include('Description')
     end
   end
 
   describe 'when given a string description as a parameter' do
     it 'should use the string value, unmodified' do
-      @headers.should include('Title')
+      expect(@headers).to include('Title')
     end
   end
 
   describe 'when an hash is passed as a parameter' do
     describe 'with a string value' do
       it 'should use the string value, unmodified' do
-        @headers.should include('ISBN-10')
+        expect(@headers).to include('ISBN-10')
       end
     end
 
     describe 'with a non-string value' do
       it 'should use the non string value converted to a string, humanized' do
-        @headers.should include('Issuer')
+        expect(@headers).to include('Issuer')
       end
     end
   end
@@ -56,6 +56,6 @@ describe Comma::HeaderExtractor, 'with static column method' do
   end
 
   it 'should extract headers' do
-    @headers.should eq(['', 'STATIC', 'STATIC'])
+    expect(@headers).to eq(['', 'STATIC', 'STATIC'])
   end
 end

data/spec/comma/rails/active_record_spec.rb

@@ -79,25 +79,25 @@ if defined? ActiveRecord
     end
 
     describe '#to_comma on scopes' do
-      it 'should extend ActiveRecord::NamedScope::Scope to add a #to_comma method which will return CSV content for objects within the scope' do # rubocop:disable Style/LineLength
-        Person.teenagers.to_comma.should == "Name,Age\nJunior,18\n"
+      it 'should extend ActiveRecord::NamedScope::Scope to add a #to_comma method which will return CSV content for objects within the scope' do # rubocop:disable Metrics/LineLength
+        expect(Person.teenagers.to_comma).to eq "Name,Age\nJunior,18\n"
       end
 
       it 'should find in batches' do
         scope = Person.teenagers
-        scope.should_receive(:find_each).and_yield @person
+        expect(scope).to receive(:find_each).and_yield @person
         scope.to_comma
       end
 
       it 'should fall back to iterating with each when scope has limit clause' do
         scope = Person.limit(1)
-        scope.should_receive(:each).and_yield @person
+        expect(scope).to receive(:each).and_yield @person
         scope.to_comma
       end
 
       it 'should fall back to iterating with each when scope has order clause' do
         scope = Person.order(:age)
-        scope.should_receive(:each).and_yield @person
+        expect(scope).to receive(:each).and_yield @person
         scope.to_comma
       end
     end
@@ -126,19 +126,19 @@ if defined? ActiveRecord
       end
 
       it 'should i18n-ize header values' do
-        Person.teenagers.to_comma.should match(/^名前,年齢/)
+        expect(Person.teenagers.to_comma).to match(/^名前,年齢/)
       end
     end
 
     describe 'github issue 75' do
       it 'should find association' do
-        -> { Person.all.to_comma(:issue_75) }.should_not raise_error
+        expect { Person.all.to_comma(:issue_75) }.not_to raise_error
       end
     end
 
     describe 'with accessor' do
       it 'should not raise exception' do
-        Job.all.to_comma.should eq("Name\nJunior\n")
+        expect(Job.all.to_comma).to eq("Name\nJunior\n")
       end
     end
 
@@ -149,7 +149,7 @@ if defined? ActiveRecord
     end
   end
 
-  describe Comma, 'generating CSV from an ActiveRecord object using Single Table Inheritance' do # rubocop:disable Metric/BlockLength
+  describe Comma, 'generating CSV from an ActiveRecord object using Single Table Inheritance' do # rubocop:disable Metrics/BlockLength
     class Animal < ActiveRecord::Base
       comma do
         name 'Name' do |name|
@@ -188,16 +188,16 @@ if defined? ActiveRecord
     end
 
     it 'should return and array of data content, as defined in comma block in child class' do
-      @dog.to_comma.should == %w[Dog-Rex]
+      expect(@dog.to_comma).to eq %w[Dog-Rex]
     end
 
     # FIXME: this one is failing - the comma block from Dog is executed instead of the one from the super class
     it 'should return and array of data content, as defined in comma block in super class, if not present in child' do
-      @cat.to_comma.should == %w[Super-Kitty]
+      expect(@cat.to_comma).to eq %w[Super-Kitty]
     end
 
     it 'should call definion in parent class' do
-      -> { @dog.to_comma(:with_type) }.should_not raise_error
+      expect { @dog.to_comma(:with_type) }.not_to raise_error
     end
   end
 end

data/spec/controllers/users_controller_spec.rb

@@ -10,7 +10,7 @@ if defined?(Rails)
         mock_users = [mock_model(User), mock_model(User)]
         allow(User).to receive(:all).and_return(mock_users)
 
-        mock_users.should_receive(:to_comma).once
+        expect(mock_users).to receive(:to_comma).once
 
         get :index, format: :csv
       end
@@ -25,17 +25,17 @@ if defined?(Rails)
       it 'should not affect html requested' do
         get :index
 
-        response.status.should eq 200
-        response.content_type.should eq 'text/html'
-        response.body.should == 'Users!'
+        expect(response.status).to eq 200
+        expect(response.content_type).to eq 'text/html'
+        expect(response.body).to eq 'Users!'
       end
 
       it 'should return a csv when requested' do
         get :index, format: :csv
 
-        response.status.should eq 200
-        response.content_type.should eq 'text/csv'
-        response.header['Content-Disposition'].should include('filename="data.csv"')
+        expect(response.status).to eq 200
+        expect(response.content_type).to eq 'text/csv'
+        expect(response.header['Content-Disposition']).to include('filename="data.csv"')
 
         expected_content = <<-CSV.gsub(/^\s+/, '')
         First name,Last name,Name
@@ -43,7 +43,7 @@ if defined?(Rails)
         Wilma,Flintstone,Wilma Flintstone
         CSV
 
-        response.body.should == expected_content
+        expect(response.body).to eq expected_content
       end
 
       describe 'with comma options' do
@@ -59,7 +59,7 @@ if defined?(Rails)
           Wilma,Flintstone
           CSV
 
-          response.body.should == expected_content
+          expect(response.body).to eq expected_content
         end
       end
 
@@ -79,9 +79,9 @@ if defined?(Rails)
         it 'should allow a filename to be set' do
           get_ :with_custom_options, format: :csv, params: { custom_options: { filename: 'my_custom_name' } }
 
-          response.status.should eq 200
-          response.content_type.should eq 'text/csv'
-          response.header['Content-Disposition'].should include('filename="my_custom_name.csv"')
+          expect(response.status).to eq 200
+          expect(response.content_type).to eq 'text/csv'
+          expect(response.header['Content-Disposition']).to include('filename="my_custom_name.csv"')
         end
 
         it 'should allow a custom filename with spaces' do
@@ -89,35 +89,47 @@ if defined?(Rails)
           params = { custom_options: { filename: 'filename with a lot of spaces' } }
           get_ :with_custom_options, format: :csv, params: params
 
-          response.status.should eq 200
-          response.content_type.should eq 'text/csv'
-          response.header['Content-Disposition'].should include('filename="filename with a lot of spaces.csv"')
+          expect(response.status).to eq 200
+          expect(response.content_type).to eq 'text/csv'
+          expect(response.header['Content-Disposition']).to include('filename="filename with a lot of spaces.csv"')
 
           filename_string = response.header['Content-Disposition'].split('=').last
           # shellsplit honors quoted strings
-          filename_string.shellsplit.length.should == 1
+          expect(filename_string.shellsplit.length).to eq 1
         end
 
         it 'should allow a file extension to be set' do
           get_ :with_custom_options, format: :csv, params: { custom_options: { extension: :txt } }
 
-          response.status.should eq 200
-          response.content_type.should eq 'text/csv'
-          response.header['Content-Disposition'].should include('filename="data.txt"')
+          expect(response.status).to eq 200
+          expect(response.content_type).to eq 'text/csv'
+          expect(response.header['Content-Disposition']).to include('filename="data.txt"')
         end
 
         it 'should allow mime type to be set' do
           get_ :with_custom_options, format: :csv, params: { custom_options: { mime_type: 'text/plain' } }
-          response.status.should eq 200
-          response.content_type.should == 'text/plain'
+          expect(response.status).to eq 200
+          expect(response.content_type).to eq 'text/plain'
+        end
+
+        it 'should allow bom to be set' do
+          get_ :with_custom_options, format: :csv, params: { custom_options: { with_bom: true } }
+
+          expected_content = <<-CSV.gsub(/^\s+/, '')
+          \xEF\xBB\xBFFirst name,Last name,Name
+          Fred,Flintstone,Fred Flintstone
+          Wilma,Flintstone,Wilma Flintstone
+          CSV
+
+          expect(response.body). to eq expected_content
         end
 
         describe 'headers' do
           it 'should allow toggling on' do
             get_ :with_custom_options, format: :csv, params: { custom_options: { write_headers: 'true' } }
 
-            response.status.should eq 200
-            response.content_type.should eq 'text/csv'
+            expect(response.status).to eq 200
+            expect(response.content_type).to eq 'text/csv'
 
             expected_content = <<-CSV.gsub(/^\s+/, '')
             First name,Last name,Name
@@ -125,29 +137,29 @@ if defined?(Rails)
             Wilma,Flintstone,Wilma Flintstone
             CSV
 
-            response.body.should == expected_content
+            expect(response.body).to eq expected_content
           end
 
           it 'should allow toggling off' do
             get_ :with_custom_options, format: :csv, params: { custom_options: { write_headers: false } }
 
-            response.status.should eq 200
-            response.content_type.should eq 'text/csv'
+            expect(response.status).to eq 200
+            expect(response.content_type).to eq 'text/csv'
 
             expected_content = <<-CSV.gsub(/^\s+/, '')
             Fred,Flintstone,Fred Flintstone
             Wilma,Flintstone,Wilma Flintstone
             CSV
 
-            response.body.should == expected_content
+            expect(response.body).to eq expected_content
           end
         end
 
         it 'should allow forcing of quotes' do
           get_ :with_custom_options, format: :csv, params: { custom_options: { force_quotes: true } }
 
-          response.status.should eq 200
-          response.content_type.should eq 'text/csv'
+          expect(response.status).to eq 200
+          expect(response.content_type).to eq 'text/csv'
 
           expected_content = <<-CSV.gsub(/^\s+/, '')
           "First name","Last name","Name"
@@ -155,7 +167,7 @@ if defined?(Rails)
           "Wilma","Flintstone","Wilma Flintstone"
           CSV
 
-          response.body.should == expected_content
+          expect(response.body).to eq expected_content
         end
 
         it 'should allow combinations of options' do
@@ -169,15 +181,15 @@ if defined?(Rails)
           }
           get_ :with_custom_options, format: :csv, params: params
 
-          response.status.should eq 200
-          response.content_type.should eq 'text/csv'
+          expect(response.status).to eq 200
+          expect(response.content_type).to eq 'text/csv'
 
           expected_content = <<-CSV.gsub(/^\s+/, '')
           "Fred"||"Flintstone"||"Fred Flintstone"ENDOFLINE
           "Wilma"||"Flintstone"||"Wilma Flintstone"ENDOFLINE
           CSV
 
-          response.body.should == expected_content
+          expect(response.body).to eq expected_content
         end
       end
     end

data/spec/spec_helper.rb

@@ -3,8 +3,21 @@
 require 'rubygems'
 $LOAD_PATH.unshift(File.expand_path(File.join('..', '..', 'lib'), __FILE__))
 
+require 'simplecov'
 require 'coveralls'
-Coveralls.wear!
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+if defined? Rails
+  SimpleCov.start('rails') do
+    add_filter %r{^/spec/comma/rails/data_mapper_collection_spec\.rb$}
+    add_filter %r{^/spec/comma/rails/mongoid_spec\.rb$}
+  end
+else
+  SimpleCov.start do
+    add_filter %r{^/spec/comma/rails/data_mapper_collection_spec\.rb}
+    add_filter %r{^/spec/comma/rails/mongoid_spec\.rb}
+    add_filter %r{^/spec/controllers/}
+  end
+end
 
 require 'bundler/setup'
 Bundler.require

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comma
 version: !ruby/object:Gem::Version
-  version: 4.3.2
+  version: 4.4.0
 platform: ruby
 authors:
 - Marcus Crafter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -51,14 +51,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.5.0
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.5.0
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,20 +101,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.11
 description: Ruby Comma Seperated Values generation library
 email:
 - crafterm@redartisan.com
@@ -136,26 +122,22 @@ files:
 - README.md
 - Rakefile
 - comma.gemspec
-- gemfiles/active4.2.11.1.gemfile
-- gemfiles/active4.2.11.1.gemfile.lock
 - gemfiles/active5.0.7.2.gemfile
 - gemfiles/active5.0.7.2.gemfile.lock
 - gemfiles/active5.1.7.gemfile
 - gemfiles/active5.1.7.gemfile.lock
-- gemfiles/active5.2.3.gemfile
-- gemfiles/active5.2.3.gemfile.lock
-- gemfiles/active6.0.0.gemfile
-- gemfiles/active6.0.0.gemfile.lock
-- gemfiles/rails4.2.11.1.gemfile
-- gemfiles/rails4.2.11.1.gemfile.lock
+- gemfiles/active5.2.4.3.gemfile
+- gemfiles/active5.2.4.3.gemfile.lock
+- gemfiles/active6.0.3.1.gemfile
+- gemfiles/active6.0.3.1.gemfile.lock
 - gemfiles/rails5.0.7.2.gemfile
 - gemfiles/rails5.0.7.2.gemfile.lock
 - gemfiles/rails5.1.7.gemfile
 - gemfiles/rails5.1.7.gemfile.lock
-- gemfiles/rails5.2.3.gemfile
-- gemfiles/rails5.2.3.gemfile.lock
-- gemfiles/rails6.0.0.gemfile
-- gemfiles/rails6.0.0.gemfile.lock
+- gemfiles/rails5.2.4.3.gemfile
+- gemfiles/rails5.2.4.3.gemfile.lock
+- gemfiles/rails6.0.3.1.gemfile
+- gemfiles/rails6.0.3.1.gemfile.lock
 - init.rb
 - lib/comma.rb
 - lib/comma/array.rb
@@ -202,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby Comma Seperated Values generation library