lp_csv_exportable_with_stream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b0e1113b747629d9b0b0cca628298e191d9d186fcfa2d5402c9af8874882a36
+  data.tar.gz: cc7e4df25168bfbeca22de97eb84034e90caa84177380abe434f82812991808e
+SHA512:
+  metadata.gz: 4f92ce7f354a2b3bce3867fae10342d84e4e05051ebeef6e82a240dd97cbc474599b8f8c907b35381f76b2c1c18bfd33c3f2df55075d4069fb18dc2238607dd2
+  data.tar.gz: 0a764b3271b700ce5953a2fbd985bf8074b87c4b07193fc7fa41c6de3a646e44f787db5a74f02e66e254e0421b414b3bc7ca050799dcc53b6a0958dcdc21376d

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-31
+
+- Initial release
+  - Add filename setting
+  - Default encode to UTF-8
+  - Download with Stream

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lp_csv_exportable_with_stream.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "lp_csv_exportable"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    lp_csv_exportable_with_stream (0.1.0)
+      lp_csv_exportable
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.10)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    lp_csv_exportable (0.2.9)
+      activesupport
+    minitest (5.15.0)
+    rake (13.0.6)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  lp_csv_exportable
+  lp_csv_exportable_with_stream!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 z01241
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# LpCSVExportableWithStream
+
+This is an extension of [LaunchPadLab/lp_csv_exportable](https://github.com/LaunchPadLab/lp_csv_exportable), let you can export data with Live stream. 
+
+When Export lager data, rails will fetch all data what you need and make generate scv data. Your download will start after scv file generated, that's This will make your project seems to broken.
+
+But Live Stream will generate file while downloading. It's good for your user experience
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lp_csv_exportable_with_stream'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lp_csv_exportable_with_stream
+
+## Usage
+
+1. Follow the [LaunchPadLab/lp_csv_exportable](https://github.com/LaunchPadLab/lp_csv_exportable) basic usage. Like this
+
+```ruby
+class ExportUsers
+  include LpCSVExportable::CanExportAsCSV
+
+  column :first_name
+  column :last_name
+  column :email
+  column 'User Role', model_methods: %i[membership name]
+end
+
+```
+
+2. And add `include LpCSVExportable::WithStream` below `include LpCSVExportable::CanExportAsCSV`
+```ruby
+  include LpCSVExportable::CanExportAsCSV
+  include LpCSVExportable::WithStream
+
+  column :first_name
+```
+
+3. finally, replace `.to_csv`  with `.to_csv_lazy(self)`
+
+```ruby
+def index
+    users = User.all
+
+    respond_to do |format|
+      format.csv do
+        export = ExportUsers.new
+        export.collection = users
+        export.to_csv_lazy(self)
+      end
+    end
+  end
+```
+
+## Filename Setting
+
+You can setting your filename in Export Class, just add self.filename = "Your File Name"
+
+```ruby
+class ExportUsers
+  include LpCSVExportable::CanExportAsCSV
+  include LpCSVExportable::WithStream
+
+  self.filename = "Your File Name" # This is base file name
+
+```
+
+Also, you can add prefix ro suffix for your file name when export. maybe exported date and so on.
+
+```ruby
+respond_to do |format|
+  format.csv do
+    export = ExportUsers.new
+    export.collection = users
+    export.filename_prefix = "#{Date.today.strftime("%Y-%m-%d %H:%M")}" # add prefix to your base filename
+    export.filename_suffix = "version 2" # add suffix to your base filename
+    export.to_csv_lazy(self)
+  end
+end
+
+```
+
+
+## Prevent N + 1 query
+
+If your need to prevent n + 1 query, you can add `self.collection_includes = [:your, :relations]`, it will automatically includes relations of your collection
+
+```ruby
+class ExportUsers
+  include LpCSVExportable::CanExportAsCSV
+  include LpCSVExportable::WithStream
+
+  self.filename = "Your File Name"
+  self.collection_includes = [:address, :friends] # Equivalence with "collection.includes(:address, :friends)"
+```
+#### Note
+What's N + 1 Query?
+[Faster Rails: Eliminating N+1 queries](https://semaphoreci.com/blog/2017/08/09/faster-rails-eliminating-n-plus-one-queries.html)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lp_csv_exportable_with_stream.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/lp_csv_exportable_with_stream/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LpCSVExportableWithStream
+  VERSION = "0.1.0"
+end

data/lib/lp_csv_exportable_with_stream/with_stream.rb

@@ -0,0 +1,45 @@
+module LpCSVExportable
+  module WithStream
+    attr_accessor :filename_prefix, :filename_suffix
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def to_csv_lazy(formatter)
+      formatter.headers['Content-Type'] = 'text/csv; charset=utf-8'
+      formatter.headers['Content-Disposition'] =
+        "attachment; filename=\"#{filename_prefix}#{self.class.filename}#{filename_suffix}.csv\""
+      formatter.headers['X-Accel-Buffering'] = 'no'
+      formatter.headers['Cache-Control'] = 'no-cache'
+      formatter.headers['Last-Modified'] = Time.zone.now.ctime.to_s
+      formatter.headers.delete('Content-Length')
+      formatter.response_body = Enumerator.new do |yielder|
+        yielder << "\uFEFF" + CSV.generate_line(headers).to_s.force_encoding('UTF-8')
+        collection.includes(self.class.collection_includes || []).each do |obj|
+          yielder << CSV.generate_line(columns.map do |column|
+            column.format(retrieve_value(obj, column))
+          end).to_s.force_encoding('UTF-8')
+        end
+      end
+    end
+
+    module ClassMethods
+      def filename=(name)
+        @filename = name
+      end
+
+      def filename
+        @filename
+      end
+
+      def collection_includes=(collection_includes)
+        @collection_includes = collection_includes
+      end
+
+      def collection_includes
+        @collection_includes
+      end
+    end
+  end
+end

data/lib/lp_csv_exportable_with_stream.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "lp_csv_exportable_with_stream/version"
+
+module LpCSVExportableWithStream
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+require 'lp_csv_exportable_with_stream/with_stream'

data/sig/lp_csv_exportable_with_stream.rbs

@@ -0,0 +1,4 @@
+module LpCSVExportableWithStream
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: lp_csv_exportable_with_stream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- z22919456
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lp_csv_exportable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Export file with stream, free your thread
+email:
+- z22919456@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lp_csv_exportable_with_stream.rb
+- lib/lp_csv_exportable_with_stream/version.rb
+- lib/lp_csv_exportable_with_stream/with_stream.rb
+- sig/lp_csv_exportable_with_stream.rbs
+homepage: https://github.com/z22919456/lp_csv_exportable_with_stream
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/z22919456/lp_csv_exportable_with_stream
+  source_code_uri: https://github.com/z22919456/lp_csv_exportable_with_stream
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Extension of lp_csv_exportable, let export file can be download by stream
+test_files: []