csb 0.2.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ff19feed336a0df9dc6426e5afa90af371db81b44cac91c7d19c1c6ae6d2ea0
-  data.tar.gz: afcd571ef70b7bf55fca807e4013d2a8bf765b1739c7cb21c79e6633e0ae2ca1
+  metadata.gz: 518693b4dfa9ef958beb05143afa99c8bc37a8a61fa8b86ea5619140b4898c66
+  data.tar.gz: a155dc1d962466e7d0ed1421910b4dd964de3e55a79ca1092cbe63e3a82591c0
 SHA512:
-  metadata.gz: 0eee7bfb6c29045cbc98b92e28de678309450213bc0bb089fbffee484c94ebd5c89efacac09c092feb0380a2c1b3a01b6810c1d9b0ff3aea9064d16f19156ab4
-  data.tar.gz: 18c7f6d86ec92c3ff5e39414772b75a4f370f57de0c43e90a7d97396546e1df275d83b4bd04e43409986ea3431d4efbf83126ef83ca001ed9bd99a0808fa0274
+  metadata.gz: 61fff01a75f9ada5135fc20b1cce96949150e4ec88d60862e373f3460f5421e04190315199892163ff9a45e6e15190ba305b315f5b8d014944b0786b27bb9698
+  data.tar.gz: 6cc80f9bbff9d15f844de89ca35429b529fb1054a655246de2f1cfebc55e8769d1560aa6b1f53bedeaac831901f54354fa768cc9d5879526c7fdeba3f060447d

data/.github/workflows/rspec.yml

@@ -0,0 +1,47 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  rspec:
+
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7]
+        gemfile: [
+          "gemfiles/rails52.gemfile",
+          "gemfiles/rails60.gemfile",
+        ]
+    steps:
+    - name: Install packages
+      run: |
+        sudo apt update -y
+        sudo apt install -y libsqlite3-dev
+    - uses: actions/checkout@v2
+    - uses: actions/cache@v1
+      with:
+        path: /home/runner/bundle
+        key: bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}-${{ hashFiles(matrix.gemfile) }}-${{ hashFiles('**/*.gemspec') }}
+        restore-keys: |
+          bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}-
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: |
+        bundle config path /home/runner/bundle
+        bundle config --global gemfile ${{ matrix.gemfile }}
+        bundle install
+        bundle update
+        bundle clean
+    - name: Run rspec
+      run: bundle exec rspec

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 Gemfile.lock
+/vendor/bundle

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 0.5.0
+
+- Add `as_table` testing helper
+
+## 0.4.0
+
+- Csb::Cols#initialize supports block arguments
+- Add Testing Helper
+
+## 0.3.1
+
+- Refactor
+
+## 0.3.0
+
+- Add ignore_class_names config
+
+## 0.2.4
+
+- Clean up rack@2.2.x monkey patch.
+
 ## 0.2.3
 
 - Fix rack@2.2.x bug https://github.com/rack/rack/issues/1619

data/README.md

@@ -1,7 +1,17 @@
+[![Gem Version](https://badge.fury.io/rb/csb.svg)](https://rubygems.org/gems/csb)
+[![Build](https://github.com/aki77/csb/workflows/Build/badge.svg)](https://github.com/aki77/csb/actions)
+
 # Csb
 
 A simple and streaming support CSV template engine for Ruby on Rails.
 
+## Features
+
+- Support for streaming downloads
+- Output in UTF-8 with BOM
+- Readable code
+- High testability
+
 ## Usage
 
 ### Template handler
@@ -18,9 +28,13 @@ In app/views/reports/index.csv.csb:
 
 ```ruby
 csv.items = @reports
+
 # When there are many records
 # csv.items = @reports.find_each
 
+# When there are many records with decorator
+# csv.items = @reports.find_each.lazy.map(&:decorate)
+
 # csv.filename = "reports_#{Time.current.to_i}.csv"
 # csv.streaming = false
 
@@ -56,6 +70,38 @@ csv.build
 # 2019/06/02,category3,content2,,dummy
 ```
 
+### Testing
+
+```ruby
+# Your view
+csv.items = @articles
+csv.cols = Article.csb_cols
+
+# Your Model
+def self.csb_cols
+  Csb::Cols.new do |cols|
+    cols.add('Update date') { |r| I18n.l(r.updated_at.to_date) }
+    cols.add('Categories') { |r| r.categories.pluck(:name).join(' ') }
+    cols.add('Title', :title)
+  end
+end
+
+# Your test
+require 'csb/testing'
+
+expect(Article.csb_cols.col_pairs(article)).to eq [
+  ['Update date', '2020-01-01'],
+  ['Categories', 'test rspec'],
+  ['Title', 'Testing'],
+]
+
+expect(Article.csb_cols.as_table(articles)).to eq [
+  ['Update date', 'Categories', 'Title'],
+  ['2020-01-01', 'test rspec', 'Testing'],
+  ['2020-02-01', 'rails gem', 'Rails 6.2'],
+]
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/csb.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "csv"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/gemfiles/rails52.gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'rails', '5.2.4.3'
+
+gemspec path: '../'

data/gemfiles/rails60.gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'rails', '6.0.3.1'
+
+gemspec path: '../'

data/lib/csb/builder.rb

@@ -20,6 +20,10 @@ module Csb
       output << CSV.generate_line(cols.headers)
       items.each do |item|
         output << CSV.generate_line(cols.values_by_item(item))
+      rescue => error
+        break if Csb.configuration.ignore_class_names.include?(error.class.name)
+
+        raise error
       end
       output
     end

data/lib/csb/cols.rb

@@ -9,6 +9,7 @@ module Csb
 
     def initialize
       @cols = []
+      yield(self) if block_given?
     end
 
     def copy!(other)
@@ -32,5 +33,6 @@ module Csb
         col.value_by_item(item)
       end
     end
+    alias_method :values, :values_by_item
   end
 end

data/lib/csb/configuration.rb

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

data/lib/csb/handler.rb

@@ -21,7 +21,9 @@ module Csb
           response.headers['Cache-Control'] = 'no-cache'
           response.headers['X-Accel-Buffering'] = 'no'
           # SEE: https://github.com/rack/rack/issues/1619
-          response.headers['Last-Modified'] = '0'
+          if Gem::Version.new('2.2.0') <= Gem::Version.new(Rack::RELEASE)
+            response.headers['Last-Modified'] = '0'
+          end
         end
         csv.build
       RUBY

data/lib/csb/template.rb

@@ -1,7 +1,6 @@
 module Csb
-  class Template < Builder
-    attr_accessor :utf8_bom, :filename, :streaming, :items
-    attr_reader :cols
+  class Template
+    attr_accessor :utf8_bom, :filename, :streaming, :items, :cols
 
     def initialize(utf8_bom:, streaming:)
       @utf8_bom = utf8_bom

data/lib/csb/testing.rb

@@ -0,0 +1,11 @@
+module Csb
+  class Cols
+    def col_pairs(item)
+      headers.zip(values(item))
+    end
+
+    def as_table(items)
+      [headers] + items.map { |item| values(item) }
+    end
+  end
+end

data/lib/csb/version.rb

@@ -1,3 +1,3 @@
 module Csb
-  VERSION = "0.2.3"
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.5.0
 platform: ruby
 authors:
 - aki77
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: A simple and streaming support CSV template engine for Ruby on Rails.
 email:
 - aki77@users.noreply.github.com
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -99,6 +100,8 @@ files:
 - bin/console
 - bin/setup
 - csb.gemspec
+- gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
 - lib/csb.rb
 - lib/csb/builder.rb
 - lib/csb/col.rb
@@ -107,6 +110,7 @@ files:
 - lib/csb/handler.rb
 - lib/csb/railtie.rb
 - lib/csb/template.rb
+- lib/csb/testing.rb
 - lib/csb/version.rb
 homepage: https://github.com/aki77/csb
 licenses:
@@ -127,7 +131,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: A simple and streaming support CSV template engine for Ruby on Rails.