xlsxtream_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f95f772a88e172129234f4283c232efc799fe20b752675e6b44d8f96d6fbf582
+  data.tar.gz: 0e910d29f10e28c3ea51c7ec10e32708199118cfc803bafc0b17f28a5e00ee28
+SHA512:
+  metadata.gz: f2d2e2d691e850a3b6d50637ee3b97f186b66172af768273ff73ab091db36619f2399063e9724fc38668f2c179ca518eab6ada601189465830189c60b969920b
+  data.tar.gz: dc0a03fe157d825c586f6af81a59083ac33fe0599115ba9baa43b2e8c3678b691b9c26dbd625d6d1cdeeab8739662947abfba48cebf428bc5397b5ea06a86bb9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 doabit
+
+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,83 @@
+# XlsxtreamRails
+Xlsx stream download for rails with template.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "xlsxtream_rails"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install xlsxtream_rails
+```
+
+## Controller
+
+Set your instance variables in your controller and configure the response if needed:
+
+```ruby
+class PostsController < ApplicationController
+  def index
+    @posts = Post.all
+    respond_to do |format|
+      format.xlsx
+    end
+  end
+end
+```
+
+## Model
+
+Add `xlsx_columns` method for model:
+
+```ruby
+class Post < ApplicationRecord
+   def xlsx_columns
+     [:id, :title, :body]
+   end
+end
+```
+
+or
+
+```ruby
+class Post < ApplicationRecord
+   belongs_to :category
+
+   def xlsx_columns
+     [
+       [:category, category.name],
+       :title,
+       :body
+    ]
+   end
+end
+```
+
+## View
+
+If you want to render with template, you can create the template with the .xlsx.xrb extension (index.xlsx.xrb for example)
+
+```ruby
+xlsx.write_worksheet do |sheet|
+  @posts.find_each do |post|
+    sheet.add_row [post.id, post.title]
+  end
+end
+```
+
+## This gem is inspired by the following
+
+[spreadsheet_architect](https://github.com/westonganger/spreadsheet_architect)
+
+[caxlsx_rails](https://github.com/caxlsx/caxlsx_rails)
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/tasks/xlsxtream_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :xlsxtream_rails do
+#   # Task goes here
+# end

data/lib/xlsxtream_rails/action_controller.rb

@@ -0,0 +1,56 @@
+require "action_controller"
+require "stringio"
+
+Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+
+ActionController::Renderers.add :xlsx do |data, options|
+  # force layout false
+  options[:layout] = false
+  # disposition / filename
+  options[:disposition] = options.delete(:disposition) || "attachment"
+
+  if defined?(ActiveRecord) && data.is_a?(ActiveRecord::Relation)
+    options[:filename] ||= data.klass.name.pluralize
+  end
+
+  options[:filename] = options[:filename] ? options[:filename].strip.sub(/\.xlsx$/i, "") : "data"
+  options[:filename] += ".xlsx"
+
+  headers["Content-Type"] = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+  headers["Content-disposition"] = "attachment; filename=\"#{options[:filename]}.xlsx\""
+  headers["X-Accel-Buffering"] = "no"
+  headers["Cache-Control"] = "no-cache"
+  headers["Last-Modified"] = Time.zone.now.ctime.to_s
+  headers.delete("Content-Length")
+  self.response_body = Enumerator.new do |enumerator|
+    xlsx = Xlsxtream::Workbook.new(enumerator)
+    if lookup_context.template_exists?(options[:template], options[:prefixes])
+      source = lookup_context.find_template(options[:template], options[:prefixes], false).source
+      builder = StringIO.new
+      builder << "# encoding: utf-8\n"
+      builder << source
+      view_context.instance_eval(builder.string)
+    else
+      XlsxtreamRails::Utils.write_xls(xlsx, data)
+    end
+
+    xlsx.close
+  end
+end
+
+# For respond_to default
+begin
+  ActionController::Responder
+rescue
+else
+  class ActionController::Responder
+    def to_xlsx
+      @_action_has_layout = false
+      if @default_response
+        @default_response.call(options)
+      else
+        controller.render({xlsx: controller.action_name}.merge(options))
+      end
+    end
+  end
+end

data/lib/xlsxtream_rails/railtie.rb

@@ -0,0 +1,14 @@
+module XlsxtreamRails
+  class Railtie < ::Rails::Railtie
+    initializer "xlsxtream_rails.initialization" do
+      ActiveSupport.on_load(:action_view) do
+        require "xlsxtream_rails/template_handler"
+        ActionView::Template.register_template_handler :xrb, ActionView::Template::Handlers::XrbBuilder.new
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        require "xlsxtream_rails/action_controller"
+      end
+    end
+  end
+end

data/lib/xlsxtream_rails/template_handler.rb

@@ -0,0 +1,19 @@
+require "action_view"
+require "stringio"
+
+module ActionView
+  module Template::Handlers
+    class XrbBuilder
+      def default_format
+        Mime[:xlsx].symbol
+      end
+
+      def call(template, source = nil)
+        builder = StringIO.new
+        builder << "# encoding: utf-8\n"
+        builder << (source || template.source)
+        builder.string
+      end
+    end
+  end
+end

data/lib/xlsxtream_rails/utils.rb

@@ -0,0 +1,37 @@
+module XlsxtreamRails
+  module Utils
+    def self.write_xls(xlsx, data)
+      headers = []
+      needs_headers = true
+      needs_column_types = false
+      xlsx.write_worksheet(auto_format: false) do |sheet|
+        data.find_each do |instance, index|
+          row_data = []
+          instance_cols = instance.xlsx_columns
+          instance_cols.each_with_index do |x, i|
+            if x.is_a?(Array)
+              headers.push(x[0].to_s) if needs_headers
+              row_data.push(x[1].is_a?(Symbol) ? instance.send(x[1]) : x[1])
+              if needs_column_types
+                column_types[i] = x[2]
+              end
+            else
+              headers.push(str_titleize(x.to_s)) if needs_headers
+              row_data.push(x.is_a?(Symbol) ? instance.send(x) : x)
+            end
+          end
+          sheet.add_row headers if needs_headers
+          needs_headers = false
+          sheet.add_row row_data
+        end
+      end
+    end
+
+    def self.str_titleize(str)
+      str.sub(/\A_+/, "")
+        .gsub(/[_.]/, " ")
+        .sub(" rescue nil", "")
+        .gsub(/(\A|\ )\w/) { |x| x.upcase }
+    end
+  end
+end

data/lib/xlsxtream_rails/version.rb

@@ -0,0 +1,3 @@
+module XlsxtreamRails
+  VERSION = "0.1.0"
+end

data/lib/xlsxtream_rails.rb

@@ -0,0 +1,11 @@
+require "xlsxtream"
+require "xlsxtream_rails/utils"
+require "xlsxtream_rails/version"
+require "xlsxtream_rails/railtie"
+
+module XlsxtreamRails
+  def xlsx_columns(opts = {})
+    column_names = self.class.column_names
+    column_names.map { |x| x.to_sym }
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: xlsxtream_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- doabit
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: xlsxtream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: Xlsx stream download for rails with template.
+email:
+- doinsist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/xlsxtream_rails_tasks.rake
+- lib/xlsxtream_rails.rb
+- lib/xlsxtream_rails/action_controller.rb
+- lib/xlsxtream_rails/railtie.rb
+- lib/xlsxtream_rails/template_handler.rb
+- lib/xlsxtream_rails/utils.rb
+- lib/xlsxtream_rails/version.rb
+homepage: https://github.com/ruby-gems/xlsxtream_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ruby-gems/xlsxtream_rails
+  source_code_uri: https://github.com/ruby-gems/xlsxtream_rails
+  changelog_uri: https://github.com/ruby-gems/xlsxtream_rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Xlsx stream download for rails with template.
+test_files: []