csv_shaper 1.1.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ebfdda4a218f9cf86f42c9158f3ea0baa77de655
-  data.tar.gz: 7cc018cfafa1d59ae8589f087f71e9556c960e8f
+SHA256:
+  metadata.gz: c06a84401d676f513ab8f089bfcea8cb244d806aabf77f4656e44ecc8d9a4f6e
+  data.tar.gz: 9e227b8653d95f8ab32b5d330fa7b14045c4e67db35e53f20406bb17a4e195fa
 SHA512:
-  metadata.gz: 644876cb037fa67e9f7bb79bd84880e74aac4b1b75143427f687db9ce794a5c75ae2f7b7d4323631792fb07618c579294ff42e2538af96fb5cd88994fa62040b
-  data.tar.gz: e71f61f64dedb5785e01ac9037d75f9e093ffed3b36238006da5f9d2a0c5466a8d9fc35918615284b53701b38537d5c1ab5b67489aafc7880c0475687f91f2a6
+  metadata.gz: c9b10a4737247def56c00ddd6897b96d3547dafca91c041a93c50a2270efb5b2b215adaf8cda876b111fa59a637441e92f542a2c63f7f8d1cbe0140871b250d6
+  data.tar.gz: 2ad0ae7d740549839707e44273a6577ef5db6227e69198234d6cad784909c65055302d57dcad8413a096ca87febef1d9c5cb739cb9949e0346db0149eba52a21

data/.ruby-version

@@ -1 +1 @@
-2.1.4
+2.3.1

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.0

data/.travis.yml

@@ -1,4 +1,4 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.7.1
+  - 2.6.6
+  - 2.5.8

data/README.md

@@ -27,7 +27,7 @@ end
 
 ### Install
 
-**Requires Ruby 1.9+**
+**Requires Ruby 2.2+**
 
 Install using Rubygems
 
@@ -264,6 +264,12 @@ CsvShaper.encode(col_sep: "\t") do |csv|
 end
 ```
 
+To configure Rails template-specific CSV output, use the `config` method on the `csv` object:
+
+```ruby
+csv.config.col_sep = "\t"
+```
+
 ### Contributing
 
 1. Fork it

data/lib/csv_shaper.rb

@@ -21,4 +21,4 @@ module CsvShaper
   end
 end
 
-require "csv_shaper_template" if defined?(ActionView::Template)
+require "csv_shaper_handler" if defined?(ActionView::Template)

data/lib/csv_shaper/encoder.rb

@@ -27,9 +27,13 @@ module CsvShaper
         CSV::Row.new(@header.mapped_columns, data, false)
       end
 
+      if csv_options[:write_headers] && rows.empty?
+        rows << CSV::Row.new(@header.mapped_columns, [], true)
+      end
+
       table = CSV::Table.new(rows)
       csv_options.except!(*custom_options.keys)
-      table.to_csv(csv_options)
+      table.to_csv(**csv_options)
     end
 
     private

data/lib/csv_shaper/shaper.rb

@@ -4,8 +4,12 @@ module CsvShaper
   class Shaper
     attr_reader :header, :rows
 
-    class << self
-      attr_accessor :config
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.config=(new_config)
+      @config = new_config
     end
 
     def initialize(options = {})

data/lib/csv_shaper/version.rb

@@ -1,3 +1,3 @@
 module CsvShaper
-  VERSION = "1.1.0"
+  VERSION = "1.3.2"
 end

data/lib/csv_shaper_handler.rb

@@ -0,0 +1,27 @@
+require 'csv_shaper_template'
+
+# CsvShaperHandler
+# Template handler for Rails
+class CsvShaperHandler
+  cattr_accessor :default_format
+  self.default_format = Mime[:csv]
+
+  # Expected `call` class method
+  # Set response headers with filename
+  # Primarily calls CsvShaperTemplate.encode, passing through the context (self)
+  def self.call(template, source = nil)
+    %{
+      if ( controller.present? ) && !( defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base) )
+        @filename ||= "\#{controller.action_name}.csv"
+        controller.response.headers["Content-Type"] ||= 'text/csv'
+        controller.response.headers['Content-Disposition'] = "attachment; filename=\\\"\#{@filename}\\\""
+      end
+
+      CsvShaperTemplate.encode(self) do |csv|
+        #{source || template.source}
+      end
+    }
+  end
+end
+
+ActionView::Template.register_template_handler :shaper, CsvShaperHandler

data/lib/csv_shaper_template.rb

@@ -11,30 +11,8 @@ class CsvShaperTemplate < CsvShaper::Shaper
     @context = context
     super()
   end
-end
-
-# CsvShaperHandler
-# Template handler for Rails
-class CsvShaperHandler
-  cattr_accessor :default_format
-  self.default_format = Mime::CSV
 
-  # Expected `call` class method
-  # Set response headers with filename
-  # Primarily calls CsvShaperTemplate.encode, passing through the context (self)
-  def self.call(template)
-    %{
-      if ( controller.present? ) && !( defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base) )
-        @filename ||= "\#{controller.action_name}.csv"
-        controller.response.headers["Content-Type"] ||= 'text/csv'
-        controller.response.headers['Content-Disposition'] = "attachment; filename=\\\"\#{@filename}\\\""
-      end
-
-      CsvShaperTemplate.encode(self) do |csv|
-        #{template.source}
-      end
-    }
+  def config
+    @local_config
   end
 end
-
-ActionView::Template.register_template_handler :shaper, CsvShaperHandler

data/spec/config_spec.rb

@@ -13,6 +13,20 @@ describe CsvShaper::Config do
     expect(config.options).to eq({ write_headers: false, col_sep: "\t", header_inflector: :titleize })
   end
 
+  it "does not require setting up the config before generating a CSV file" do
+    shaper = CsvShaper::Shaper.new do |csv|
+      csv.headers :name, :age, :gender
+
+      csv.row do |csv|
+        csv.cell :name, 'Paul'
+        csv.cell :age, '27'
+        csv.cell :gender, 'Male'
+      end
+    end
+
+    expect(shaper.to_csv).to eq "Name,Age,Gender\nPaul,27,Male\n"
+  end
+
   it "should exclude the headers if specified" do
     CsvShaper::Shaper.config = config
 

data/spec/csv_shaper_template_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require "csv_shaper_template"
+
+describe CsvShaperTemplate do
+  it "should allow configuration via #config method" do
+    csv_string = CsvShaperTemplate.encode(double('context')) do |csv|
+      csv.config.write_headers = false
+      csv.config.col_sep = ';'
+
+      csv.headers :name, :age, :gender
+
+      csv.row do |csv|
+        csv.cell :name, 'Paul'
+        csv.cell :age, '27'
+        csv.cell :gender, 'Male'
+      end
+    end
+
+    expect(csv_string).to eq "Paul;27;Male\n"
+  end
+
+  it "should override global configuration with local configuration" do
+    CsvShaper::Shaper.config = CsvShaper::Config.new do |c|
+      c.write_headers = false
+      c.col_sep = "\t"
+    end
+
+    csv_string = CsvShaperTemplate.encode(double('context')) do |csv|
+      csv.config.col_sep = ','
+
+      csv.headers :name, :age, :gender
+
+      csv.row do |csv|
+        csv.cell :name, 'Paul'
+        csv.cell :age, '27'
+        csv.cell :gender, 'Male'
+      end
+    end
+
+    expect(csv_string).to eq "Paul,27,Male\n"
+  end
+end

data/spec/encoder_spec.rb

@@ -40,4 +40,10 @@ describe CsvShaper::Encoder do
     encoder = CsvShaper::Encoder.new(csv.header, csv.rows)
     expect(encoder.to_csv).to eq("Full name,Sex,Age\nPaul,Male,27\nBob,Male,31\nJane,Female,23\n,,81\n")
   end
+
+  it "should encode a Shaper instance with no rows to a CSV string" do
+    CsvShaper::Shaper.config = config
+    encoder = CsvShaper::Encoder.new(csv.header, [])
+    expect(encoder.to_csv).to eq("Full name,Sex,Age\n")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_shaper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Paul Springett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-02 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,7 @@ files:
 - ".groc.json"
 - ".rspec"
 - ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -79,9 +80,11 @@ files:
 - lib/csv_shaper/row.rb
 - lib/csv_shaper/shaper.rb
 - lib/csv_shaper/version.rb
+- lib/csv_shaper_handler.rb
 - lib/csv_shaper_template.rb
 - spec/config_spec.rb
 - spec/csv_shaper_spec.rb
+- spec/csv_shaper_template_spec.rb
 - spec/encoder_spec.rb
 - spec/fixtures/user.rb
 - spec/header_spec.rb
@@ -106,14 +109,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Beautiful DSL for creating CSV output in Ruby & Rails
 test_files:
 - spec/config_spec.rb
 - spec/csv_shaper_spec.rb
+- spec/csv_shaper_template_spec.rb
 - spec/encoder_spec.rb
 - spec/fixtures/user.rb
 - spec/header_spec.rb