csb 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cf72524c9c57bb6b6b8552ff67f34542f791bae8f1e395464a8d887157480ee
-  data.tar.gz: 3450353def85946d04c04e238082200401b1bf2ee1010fc4ebb3f6478bbdfac1
+  metadata.gz: 838fb73c6e13f3232f1fac402667ff00e92ac6f7f814d8605d2b850f52e449cc
+  data.tar.gz: 8c0016c9bff8210a55882ba0afa442d5fd9efca701800cc031a13ecfbe6ef21b
 SHA512:
-  metadata.gz: 570eb119ec084220bb78abfcc11dd99dfd7427904593b4c229e1e0d825c6b0b69dfdb4053cdaec18725b0ef4569764ca02b90c3d61e342501f52f3bcb44c91f6
-  data.tar.gz: 1410d02f0dcfd112fc0799e1a2fdfde1edc44aa7a6c4f4bbe64fc7aea171bffc0a55fbea09dc6ff4999712c64d4586a5693c9fa1f1e2451dded04f863326358a
+  metadata.gz: 679a875a5174204aa3cfdc5713083c5a25be1c704049ff63a84e5969e9ecc6a582804d15177a3febd86fbb58e614772556d78730df10f3bef266a14644e968e4
+  data.tar.gz: abfb009c641e057a4d6b35992e409d9de8329d598dc0c61a2689a0cbef1564b247e813d1bf740d4572dedb38557bbd82f73f47b934ccf0fd82c2dbdd10424bcc

data/.github/workflows/rspec.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0", "3.1", "3.2"]
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
         gemfile: ["rails61", "rails70"]
         exclude:
           - ruby: "3.1"

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.9.0
+
+- Fixing Issue with config.streaming Enabled in Rails 7.1 (#17)
+
+## 0.8.0
+
+- Add `csv_options` as an option to pass to `CSV.generate_line` (https://github.com/aki77/csb/pull/18)
+
 ## 0.7.0
 
 - Drop support for ruby 2.7

data/README.md

@@ -37,6 +37,7 @@ csv.items = @reports
 
 # csv.filename = "reports_#{Time.current.to_i}.csv"
 # csv.streaming = false
+# csv.csv_options = { col_sep: "\t" }
 
 csv.cols.add('Update date') { |r| l(r.updated_at.to_date) }
 csv.cols.add('Categories') { |r| r.categories.pluck(:name).join(' ') }
@@ -130,6 +131,7 @@ In `config/initializers/csb.rb`, you can configure the following values.
 Csb.configure do |config|
   config.utf8_bom = true # default: false
   config.streaming = false # default: true
+  config.csv_options = { col_sep: "\t" } # default: {}
   config.after_streaming_error = ->(error) do # default: nil
     Rails.logger.error(error)
     Bugsnag.notify(error)

data/lib/csb/builder.rb

@@ -5,21 +5,22 @@ module Csb
   class Builder
     UTF8_BOM = "\xEF\xBB\xBF".freeze
 
-    attr_reader :output, :utf8_bom, :items, :cols
+    attr_reader :output, :utf8_bom, :items, :cols, :csv_options
     attr_accessor :items
 
-    def initialize(output = '', items: [], utf8_bom: false)
+    def initialize(output = '', items: [], utf8_bom: false, csv_options: {})
       @output = output
       @utf8_bom = utf8_bom
       @cols = Cols.new
       @items = items
+      @csv_options = csv_options
     end
 
     def build
       output << UTF8_BOM if utf8_bom
-      output << CSV.generate_line(cols.headers)
+      output << CSV.generate_line(cols.headers, **csv_options)
       items.each do |item|
-        output << CSV.generate_line(cols.values_by_item(item))
+        output << CSV.generate_line(cols.values_by_item(item), **csv_options)
       rescue => error
         break if Csb.configuration.ignore_class_names.include?(error.class.name)
 

data/lib/csb/configuration.rb

@@ -1,10 +1,11 @@
 module Csb
   class Configuration
-    attr_accessor :utf8_bom, :streaming, :after_streaming_error, :ignore_class_names
+    attr_accessor :utf8_bom, :streaming, :after_streaming_error, :ignore_class_names, :csv_options
 
     def initialize
       @utf8_bom = false
       @streaming = true
+      @csv_options = {}
       @ignore_class_names = %w[Puma::ConnectionError]
     end
   end

data/lib/csb/handler.rb

@@ -14,6 +14,7 @@ module Csb
         csv = ::Csb::Template.new(
           utf8_bom: ::Csb.configuration.utf8_bom,
           streaming: ::Csb.configuration.streaming,
+          csv_options: ::Csb.configuration.csv_options,
         )
         #{source}
         controller.send(:send_file_headers!, type: 'text/csv', filename: csv.filename)

data/lib/csb/railtie.rb

@@ -6,6 +6,34 @@ module Csb
       ActiveSupport.on_load :action_view do
         require 'csb/handler'
         ActionView::Template.register_template_handler :csb, Csb::Handler
+
+        # SEE: https://github.com/rails/rails/pull/51023
+        rails_version = Gem::Version.new(Rails.version)
+        if rails_version >= Gem::Version.new('7.1.0') && rails_version < Gem::Version.new('7.1.4')
+          ActionView::Template.prepend(Module.new do
+            # SEE: https://github.com/Shopify/rails/blob/0601929486398954a17b1985fcf7f9f0611d2d55/actionview/lib/action_view/template.rb#L262C5-L281C8
+            def render(view, locals, buffer = nil, implicit_locals: [], add_to_stack: true, &block)
+              instrument_render_template do
+                compile!(view)
+
+                if strict_locals? && @strict_local_keys && !implicit_locals.empty?
+                  locals_to_ignore = implicit_locals - @strict_local_keys
+                  locals.except!(*locals_to_ignore)
+                end
+
+                if buffer
+                  view._run(method_name, self, locals, buffer, add_to_stack: add_to_stack, has_strict_locals: strict_locals?, &block)
+                  nil
+                else
+                  result = view._run(method_name, self, locals, ActionView::OutputBuffer.new, add_to_stack: add_to_stack, has_strict_locals: strict_locals?, &block)
+                  result.is_a?(ActionView::OutputBuffer) ? result.to_s : result
+                end
+              end
+            rescue => e
+              handle_render_error(view, e)
+            end
+          end)
+        end
       end
     end
   end

data/lib/csb/template.rb

@@ -1,10 +1,11 @@
 module Csb
   class Template
-    attr_accessor :utf8_bom, :filename, :streaming, :items, :cols
+    attr_accessor :utf8_bom, :filename, :streaming, :items, :cols, :csv_options
 
-    def initialize(utf8_bom:, streaming:)
+    def initialize(utf8_bom:, streaming:, csv_options:)
       @utf8_bom = utf8_bom
       @streaming = streaming
+      @csv_options = csv_options
       @cols = Cols.new
       @items = []
     end
@@ -20,7 +21,7 @@ module Csb
     private
 
     def build_string
-      builder = Builder.new(utf8_bom: utf8_bom, items: items)
+      builder = Builder.new(utf8_bom: utf8_bom, items: items, csv_options: csv_options)
       builder.cols.copy!(cols)
       builder.build
     end
@@ -28,7 +29,7 @@ module Csb
     def build_enumerator
       Enumerator.new do |y|
         begin
-          builder = Builder.new(y, utf8_bom: utf8_bom, items: items)
+          builder = Builder.new(y, utf8_bom: utf8_bom, items: items, csv_options: csv_options)
           builder.cols.copy!(cols)
           builder.build
         rescue => error

data/lib/csb/version.rb

@@ -1,3 +1,3 @@
 module Csb
-  VERSION = '0.7.0'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csb
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - aki77
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails