fast_excel_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '04786851f3112db346d86f46931f7546425264f7e2834086915f3cac8454f5b9'
+  data.tar.gz: cbd27cc8c28343e8f445f597f442f1fdd365c634637171bec02f473dadaad023
+SHA512:
+  metadata.gz: 71d6c3694b6e70dacd0cdf075866f3f1c0cc536d2dec7b8d7ff14313b1506f94df74ae7bb5330328ba23151bbe467314c610afd5190877e9a7806a3eea79e86c
+  data.tar.gz: fa3a631a5ea3a7035231bbacfe8622b4960335a3e76ff76fed2c1f25fd6b81e59ccf33b77dc33dcd5a10fd572dd9dedd086afc70c01914315523c3fd087c780e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fast_excel_rails.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    fast_excel_rails (0.1.0)
+      fast_excel (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    fast_excel (0.4.0)
+      ffi (> 1.9, < 2)
+    ffi (1.15.3)
+    minitest (5.14.4)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fast_excel_rails!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nick Muerdter
+
+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,79 @@
+# FastExcelRails
+
+A Rails template handler for the [fast_excel](https://github.com/Paxa/fast_excel) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "fast_excel_rails"
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+## Usage
+
+### Controllers
+
+The default template file for your controller action can be rendered using `format.xlsx`:
+
+```ruby
+class ThingsController < ApplicationController
+  def index
+    @things = (1..1000).to_a
+    respond_to do |format|
+      format.xlsx
+    end
+  end
+end
+```
+
+Other options, like filenames or custom template paths, can be set using an explicit render call:
+
+```ruby
+class ThingsController < ApplicationController
+  def index
+    respond_to do |format|
+      format.xlsx { render :xlsx => "my filname.xlsx", :template => "custom_template"
+    end
+  end
+end
+```
+
+### Templates
+
+Templates use the `.xlsx.fast_excel` extension and are normal Ruby files that have access to a `workbook` variable that is a [`FastExcel::Workbook`](https://github.com/Paxa/fast_excel) instance.
+
+For example, `app/views/things/index.xlsx.fast_excel`:
+
+```ruby
+worksheet = workbook.add_worksheet
+
+worksheet.append_row(["Message", "Price", "Date"], workbook.bold_format)
+
+@things.each do |i|
+  worksheet << ["Hello", (rand * i).round(2), Time.now])
+end
+```
+
+See [fast_excel](https://github.com/Paxa/fast_excel) for further information on usage syntax.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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 tags, 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]/fast_excel_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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fast_excel_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fast_excel_rails.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/fast_excel_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fast_excel_rails"
+  spec.version       = FastExcelRails::VERSION
+  spec.authors       = ["Nick Muerdter"]
+  spec.email         = ["12112+GUI@users.noreply.github.com"]
+
+  spec.summary       = %q{A Rails template handler for the fast_excel gem.}
+  spec.homepage      = "https://github.com/GUI/fast_excel_rails"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/GUI/fast_excel_rails/tree/v#{FastExcelRails::VERSION}"
+  spec.metadata["changelog_uri"] = "https://github.com/GUI/fast_excel_rails/blob/v#{FastExcelRails::VERSION}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fast_excel", "~> 0.1"
+end

data/lib/fast_excel_rails.rb

@@ -0,0 +1,5 @@
+require "fast_excel_rails/version"
+
+if defined?(::Rails)
+  require "fast_excel_rails/railtie"
+end

data/lib/fast_excel_rails/railtie.rb

@@ -0,0 +1,31 @@
+require "action_controller"
+require "fast_excel_rails/template_handler"
+
+module FastExcelRails
+  class Railtie < Rails::Railtie
+    initializer "fast_excel_rails.register" do |app|
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Template.register_template_handler :fast_excel, FastExcelRails::TemplateHandler.new
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        unless Mime::Type.lookup_by_extension(:xlsx)
+          Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+        end
+
+        ActionController::Renderers.add :xlsx do |filename, options|
+          unless filename.end_with?(".xlsx")
+            filename = "#{filename}.xlsx"
+          end
+
+          disposition = options.delete(:disposition) || "attachment"
+
+          options[:layout] = false
+
+          content = render_to_string(options)
+          send_data(content, :type => :xlsx, :filename => filename, :disposition => disposition)
+        end
+      end
+    end
+  end
+end

data/lib/fast_excel_rails/template_handler.rb

@@ -0,0 +1,30 @@
+require "action_view"
+
+module FastExcelRails
+  class TemplateHandler
+    def default_format
+      :xlsx
+    end
+
+    def call(template, source = nil)
+      <<-eos
+        # Only build one shared workbook object so partials can take advantage
+        # of the same workbook by default.
+        root_view = false
+        unless @fast_excel_rails_template_workbook
+          @fast_excel_rails_template_workbook = FastExcel.open
+          root_view = true
+        end
+
+        # Define a local "workbook" variable for accessing things inside the
+        # template.
+        workbook = @fast_excel_rails_template_workbook
+        #{source || template.source}
+
+        if root_view
+          @fast_excel_rails_template_workbook.read_string
+        end
+      eos
+    end
+  end
+end

data/lib/fast_excel_rails/version.rb

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

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: fast_excel_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Muerdter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fast_excel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: 
+email:
+- 12112+GUI@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fast_excel_rails.gemspec
+- lib/fast_excel_rails.rb
+- lib/fast_excel_rails/railtie.rb
+- lib/fast_excel_rails/template_handler.rb
+- lib/fast_excel_rails/version.rb
+homepage: https://github.com/GUI/fast_excel_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/GUI/fast_excel_rails
+  source_code_uri: https://github.com/GUI/fast_excel_rails/tree/v0.1.0
+  changelog_uri: https://github.com/GUI/fast_excel_rails/blob/v0.1.0/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Rails template handler for the fast_excel gem.
+test_files: []