caxlsx_rails 0.6.2 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f263d86f6909925b4fbc02450180f0faa6f4f6dac0500224a2861dcea886e03
-  data.tar.gz: 170415d18b4ecaea6bc524dd5d3b4dde2a310dd8b1bab80ffe39d482af2bd7c5
+  metadata.gz: ed6804c086bd3783c84283db93df9a972a5dd22f14393a70eca1b66ad22212f4
+  data.tar.gz: 3c8b9f058f4df8dc3d79ebce09e64988ba0300e6cb1f1b86197ea6c65345b0fe
 SHA512:
-  metadata.gz: 29b9b7180d97e4fecdb9bfe4f8ae3e6d1d6bd47c420e79d46c03d2fc51c75705d531bb5d202c14f6dc0356a918e786196533e96b6696e200dd81d8011f1de90d
-  data.tar.gz: 0633e8f87e84799219bcd6f874455ba41c59dfd3471f0ce122e301b0891be22ddd2c2d691560dc8931d3f708b5502991c17d9bafae65425f89c3f779ccac39ce
+  metadata.gz: 329d8ef7d3fe9ef8c3b70ac1a342a9ecce75ea1ca06f803449dff898fc697472e8d6c48455790c029011ac451b0d86b00e88f99b28be242221d2a1bf716acf7c
+  data.tar.gz: 8ab327efb87a5e095aee190b7d77ae46841874a899d0b6cc9da6d9aa8a870b52123c64fda6cf512f950eb5f4ca36fcf4ccddf9768efc1cda4bb945fcd99efdea

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+**June 18, 2024**: 0.6.4 release
+
+- Convert to Github actions
+- Improve tests
+- Fix broken templates with comments as their last line
+
+**March 8, 2022**: 0.6.3 release
+
+- Exclude rspec directory (#149)[https://github.com/caxlsx/caxlsx_rails/pull/149]
+
 **December 18, 2019**: 0.6.2 release
 
 - Release under caxlsx_rails

data/README.md

@@ -1,25 +1,31 @@
 Notice: axlsx_rails renamed to caxlsx_rails
 ===================================================
-This gem has been renamed to match other gems in the Axlsx community organization: http://github.com/caxlsx
+This gem has been renamed to match other gems in the Axlsx community organization: https://github.com/caxlsx
 
 Axlsx-Rails — Spreadsheet templates for Rails
 ===================================================
 
-[![Build Status](https://secure.travis-ci.org/caxlsx/caxlsx_rails.svg?branch=master)](http://travis-ci.org/caxlsx/caxlsx_rails)
 [![Gem
-Version](https://badge.fury.io/rb/caxlsx_rails.svg)](http://badge.fury.io/rb/caxlsx_rails)
+Version](https://badge.fury.io/rb/caxlsx_rails.svg)](https://badge.fury.io/rb/caxlsx_rails)
 [![Coverage
 Status](https://coveralls.io/repos/caxlsx/caxlsx_rails/badge.svg)](https://coveralls.io/r/caxlsx/caxlsx_rails)
+[![tests](https://github.com/caxlsx/caxlsx_rails/actions/workflows/test.yml/badge.svg)](https://github.com/caxlsx/caxlsx_rails/actions)
+![downloads](https://img.shields.io/gem/dt/caxlsx_rails?label=downloads)
 
-![Total downloads](http://ruby-gem-downloads-badge.herokuapp.com/caxlsx_rails?type=total)
-![Total downloads axlsx_rails](http://ruby-gem-downloads-badge.herokuapp.com/axlsx_rails?type=total)
-![Downloads for 0.6.1 (latest)](http://ruby-gem-downloads-badge.herokuapp.com/caxlsx_rails/0.6.0?label=0.6.1)
+## Notice: Community Axlsx Organization
+
+To better maintain the Axlsx ecosystem, all related gems have been forked or moved to the following community organization:
+
+https://github.com/caxlsx
+
+[Join the Caxlsx Slack channel](https://join.slack.com/t/caxlsx/shared_invite/enQtOTI5OTM0MzI1Njk5LTBlMDQzNDk2YzkwODMxMmVkODMyYzJiZGU5NTQ3YTg5NTBlN2IwZTlmNTRjNzhiY2E0MDY2OTEyYmFlODI5NjA)
 
 ## Installation
 
 In your Gemfile:
 
 ```ruby
+gem 'caxlsx'
 gem 'caxlsx_rails'
 ```
 
@@ -27,19 +33,19 @@ See [previous installations](#previous-installations) if needed.
 
 ## Requirements
 
-* Tested on Rails 4.2, 5.x and 6.0
+* Tested on Rails 4.2, 5.x, 6.x, and 7.x.
 * For Rails 3.1 or 3.2 use version 3.0
 * **As of 0.5.0 requires Axlsx 2.0.1, but strongly suggests 2.1.0.pre, which requires rubyzip 1.1.0**
 * As of Rails 4.1 you must use `render_to_string` to render a mail attachment.
 
 ## FYI
 
-* This gem depends on [Axlsx](https://github.com/caxlsx/axlsx). See [the blog](http://axlsx.blog.randym.net/) or the [examples page](https://github.com/randym/axlsx/blob/master/examples/example.rb) for usage.
+* This gem depends on [caxlsx](https://github.com/caxlsx/caxlsx). See [the blog](http://axlsx.blog.randym.net/) or the [examples page](https://github.com/caxlsx/caxlsx/tree/master/examples) for usage.
 * Check out [axlsx_styler](https://github.com/sakovias/axlsx_styler) by [sakovias](https://github.com/sakovias) for easier styles and borders!
 
 ## Usage
 
-Axlsx-Rails provides a renderer and a template handler. It adds the `:xlsx` format and parses `.xlsx.axlsx` templates. This lets you take all the [Axlsx](https://github.com/caxlsx/axlsx) code out of your controller or model and place it inside the template, where view code belongs! **See [this blog post](http://axlsx.blog.randym.net/2012/08/excel-on-rails-like-pro-with-axlsxrails.html) for a more complete walkthrough.**
+Axlsx-Rails provides a renderer and a template handler. It adds the `:xlsx` format and parses `.xlsx.axlsx` templates. This lets you take all the [caxlsx](https://github.com/caxlsx/caxlsx) code out of your controller or model and place it inside the template, where view code belongs! **See [this blog post](http://axlsx.blog.randym.net/2012/08/excel-on-rails-like-pro-with-axlsxrails.html) for a more complete walkthrough.**
 
 ### Controller
 
@@ -69,7 +75,7 @@ wb.add_worksheet(name: "Buttons") do |sheet|
 end
 ```
 
-This is where you place all your [Axlsx](https://github.com/caxlsx/axlsx) specific markup. Add worksheets, fill content, merge cells, add styles. See the [Axlsx examples](https://github.com/caxlsx/axlsx/tree/master/examples/example.rb) page to see what you can do.
+This is where you place all your [caxlsx](https://github.com/caxlsx/caxlsx) specific markup. Add worksheets, fill content, merge cells, add styles. See the [caxlsx examples](https://github.com/caxlsx/caxlsx/tree/master/examples) page to see what you can do.
 
 Remember, like in `erb` templates, view helpers are available to use the `.xlsx.axlsx` template.
 
@@ -286,7 +292,7 @@ end
 
 require 'rspec/expectations'
 
-module XslsMatchers
+module XlsxMatchers
 
   RSpec::Matchers.define :have_header_cells do |cell_values|
     match do |worksheet|
@@ -325,6 +331,30 @@ end
 * If it says your template is missing, check that its extension is `.xlsx.axlsx`.
 * If you get the error `uninitialized constant Mime::XSLX` you have used `format.xslx` instead of `format.xlsx`, or something similar.
 
+### Using axlsx_rails in API mode
+
+In API mode Rails does not include ActionView, so axlsx_rails will not work. To render axlsx_rails templates you must include ActionView::Rendering in your controller and override render_to_body:
+
+```ruby
+class MyController < ActionController::API
+  include ActionView::Rendering
+
+  def show
+    respond_to do |format|
+      format.xlsx
+    end
+  end
+
+  private
+
+  def render_to_body(options)
+    _render_to_body_with_renderer(options) || super
+  end
+end
+```
+
+See [issue 107](https://github.com/caxlsx/caxlsx_rails/issues/107)
+
 ### Mailer Attachments: No content, cannot read, Invalid Byte Sequence in UTF-8
 
 If you are having problems with rendering a template and attaching it to a template, try a few options:
@@ -348,6 +378,10 @@ end
 
 If you get these errors, please open an issue and share code so the bug can be isolated. Or comment on issue [#29](https://github.com/caxlsx/caxlsx_rails/issues/29) or [#25](https://github.com/caxlsx/caxlsx_rails/issues/25).
 
+### The unparsed template is returned, or something similar
+
+Have you followed other tutorials for serving Excel from Rails? Have you declared the MIME type already? These may be incompatible with caxlsx_rails (which declares the MIME type for you.) Remove any vestiges of other tutorials from your code and try again.
+
 ### Generated Files Can't Be Opened or Invalid Byte Sequence in UTF-8
 
 Both these errors *appear* to be caused by Rails applying a layout to the template. Passing `layout: false` to `render :xlsx` should fix this issue. Version 0.5.0 attempts to fix this issue.
@@ -385,9 +419,29 @@ If you are using turbolinks, you may need to disable turbolinks when you link to
 link_to 'Download spreadsheet', path_to_sheet, data: {turbolinks: false}
 ```
 
+### Rails 7 Unknown Format
+
+In Rails 7, if you get an error of "Unknown Format" you may need to add `(format: "xlsx")` to the named route.
+
+A clue to the "format" that Rails is responding with is to look at your log file or console after you click the HTML link or submit your form. You should see `Processing by Controller#action as XLSX`.
+
+#### Code Examples
+
+Scenario 1 - HTML Link within index.html.erb
+
+```ruby
+link_to "Download as Excel", my_named_route_path(format: "xlsx")
+```
+
+Scenario 2 - Using form_with()
+
+```ruby
+form_with method: :post, url: my_named_route_path(format: :xlsx) do |f|
+```
+
 ### What to do
 
-If you are having problems, try to isolate the issue. Use the console or a script to make sure your data is good. Then create the spreadsheet line by line without Axlsx-Rails to see if you are having Axlsx problems. If you can manually create the spreadsheet, create an issue and we will work it out.
+If you are having problems, try to isolate the issue. Use the console or a script to make sure your data is good. Then create the spreadsheet line by line without Axlsx-Rails to see if you are having caxlsx problems. If you can manually create the spreadsheet, create an issue and we will work it out.
 
 ## Previous Installations
 
@@ -418,7 +472,7 @@ gem 'axlsx_rails'
 ## Dependencies
 
 - [Rails](https://github.com/rails/rails)
-- [Axlsx](https://github.com/caxlsx/axlsx)
+- [caxlsx](https://github.com/caxlsx/caxlsx)
 
 ## Authors
 
@@ -440,14 +494,17 @@ Many thanks to [contributors](https://github.com/caxlsx/caxlsx_rails/graphs/cont
 * [JohnSmall](https://github.com/JohnSmall)
 * [BenoitHiller](https://github.com/BenoitHiller)
 
-## Donations
+## Change log
+
+**June 18, 2024**: 0.6.4 release
 
-Say thanks for Axlsx-Rails by donating! It makes it easier for me to provide to open
-source:
+- Convert to Github actions
+- Improve tests
+- Fix broken templates with comments as their last line
 
-[![Click here to lend your support to: Axlsx-Rails!](http://www.pledgie.com/campaigns/27737.png?skin_name=chrome)](http://www.pledgie.com/campaigns/27737)
+**March 8, 2022**: 0.6.3 release
 
-## Change log
+- Exclude rspec directory (#149)[https://github.com/caxlsx/caxlsx_rails/pull/149]
 
 **December 18, 2019**: 0.6.2 release
 

data/caxlsx_rails.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/axlsx_rails/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'caxlsx_rails'
+  s.version     = AxlsxRails::VERSION
+  s.licenses    = ['MIT']
+  s.authors     = ['Noel Peden']
+  s.email       = ['noel@peden.biz']
+  s.homepage    = 'https://github.com/caxlsx/caxlsx_rails'
+  s.summary     = 'A simple rails plugin to provide an xlsx renderer using the caxlsx gem.'
+  s.description = "Caxlsx_Rails provides an Caxlsx renderer so you can move all your spreadsheet code from your controller into view files. Partials are supported so you can organize any code into reusable chunks (e.g. cover sheets, common styling, etc.) You can use it with acts_as_caxlsx, placing the to_xlsx call in a view and adding ':package => xlsx_package' to the parameter list. Now you can keep your controllers thin!"
+
+  s.files = Dir['lib/**/*', 'CHANGELOG.md', 'README.md', 'MIT-LICENSE', 'caxlsx_rails.gemspec']
+
+  s.add_dependency 'actionpack', '>= 3.1'
+  s.add_dependency 'caxlsx', '>= 3.0'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'roo'
+  s.add_development_dependency 'rubyzip'
+  s.add_development_dependency 'growl'
+  s.add_development_dependency 'rb-fsevent'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-nav'
+end

data/lib/axlsx_rails/railtie.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require 'axlsx_rails/template_handler'
+
 module AxlsxRails
   class Railtie < Rails::Railtie
     initializer 'axlsx_rails.initialization' do
       ActiveSupport.on_load(:action_view) do
-        require 'axlsx_rails/template_handler'
-        ActionView::Template.register_template_handler :axlsx, ActionView::Template::Handlers::AxlsxBuilder.new
+        ActionView::Template.register_template_handler :axlsx, AxlsxRails::TemplateHandler.new
       end
 
       ActiveSupport.on_load(:action_controller) do

data/lib/axlsx_rails/template_handler.rb

@@ -1,37 +1,33 @@
 # frozen_string_literal: true
 
-require 'action_view'
 require 'stringio'
 
-module ActionView
-  module Template::Handlers
-    class AxlsxBuilder
-
-      def default_format
-        case
-        when Rails.version.to_f >= 6
-          Mime[:xlsx].symbol
-        when Rails.version.to_f >= 5
-          Mime[:xlsx]
-        else
-          Mime::XLSX
-        end
+module AxlsxRails
+  class TemplateHandler
+    def default_format
+      case
+      when Rails.version.to_f >= 6
+        Mime[:xlsx].symbol
+      when Rails.version.to_f >= 5
+        Mime[:xlsx]
+      else
+        Mime::XLSX
       end
+    end
 
-      def call(template, source = nil)
-        builder = StringIO.new
-        builder << "require 'axlsx';"
-        builder << "xlsx_author = defined?(xlsx_author).nil? ? nil : xlsx_author;"
-        builder << "xlsx_created_at = defined?(xlsx_created_at).nil? ? nil : xlsx_created_at;"
-        builder << "xlsx_use_shared_strings = defined?(xlsx_use_shared_strings).nil? ? nil : xlsx_use_shared_strings;"
-        builder << "xlsx_package = Axlsx::Package.new("
-        builder << ":author => xlsx_author,"
-        builder << ":created_at => xlsx_created_at,"
-        builder << ":use_shared_strings => xlsx_use_shared_strings);"
-        builder << (source || template.source)
-        builder << ";xlsx_package.to_stream.string;"
-        builder.string
-      end
+    def call(template, source = nil)
+      builder = StringIO.new
+      builder << "require 'axlsx';"
+      builder << "xlsx_author = defined?(xlsx_author).nil? ? nil : xlsx_author;"
+      builder << "xlsx_created_at = defined?(xlsx_created_at).nil? ? nil : xlsx_created_at;"
+      builder << "xlsx_use_shared_strings = defined?(xlsx_use_shared_strings).nil? ? nil : xlsx_use_shared_strings;"
+      builder << "xlsx_package = Axlsx::Package.new("
+      builder << ":author => xlsx_author,"
+      builder << ":created_at => xlsx_created_at,"
+      builder << ":use_shared_strings => xlsx_use_shared_strings);"
+      builder << (source || template.source)
+      builder << "\n;xlsx_package.to_stream.string;"
+      builder.string
     end
   end
 end

data/lib/axlsx_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AxlsxRails
-  VERSION = '0.6.2'
+  VERSION = '0.6.4'
 end