caxlsx_rails 0.6.3 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f849af21c49f497751ff2161fe91f879ea63f30b43edff25e7eef7c04730eb5
-  data.tar.gz: 6643d7e2085b006a3370f641a676fa5b362478b1cd07ecf088dbcd935266d7d7
+  metadata.gz: 22c74d3929476fad668147236c3023cb4f52ef9471e0479a0bdbe7ef89dcb980
+  data.tar.gz: 32c5a47c42f98e2b26f20b618eb86ecce0b50b9296eb4d227b7bd414cdd487f7
 SHA512:
-  metadata.gz: fbbb6a95c0718a512ca0a30e5512e1fbad49b137af9fce1e5eb177810773e9f76cb796c1f0abcc423f6365dc418b47b9854c233b67503fda1e2622d2bb7ca226
-  data.tar.gz: 641cfdc744ed57f58c8735c37efa936494e72a968df31ac53bb7a637cfc5277bc2747373abdcd50deaa4b54bb497203af97b7da34eac1257b8476a2b9311fb62
+  metadata.gz: 702ccb285b30c7f2498663858e0e1b3d2368156e1f23c836683f39ecf154247db44fb9e975fb5846d81a26da9a7cc2786d0e7842c06a17d67b4c6eddb757298d
+  data.tar.gz: 6b37602c7d82d45dc41d3907904078204d6a797948b5a54556f1a7a5f6d899de76b151b1f5509c61ef06f66a6b01fd820c3048a8ffa8a639602bd3d8c61750a3

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change log
 
+**Unreleased**
+
+
+**April 1, 2026**: 0.7.1 release
+
+Note: v0.7.0 failed on the GitHub CI, skipping that version number.
+
+- Drop support for Ruby < 2.6 and Rails < 6.1
+- Require at least caxlsx 4.0
+- Add Rails 8.0 and Ruby 3.4 to the CI matrix
+
+**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]
@@ -98,4 +115,3 @@
 
 - Initial posting.
 - It works, but there are no tests! Bad programmer!
-

data/README.md

@@ -1,25 +1,22 @@
 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)
-
-![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.3 (latest)](http://ruby-gem-downloads-badge.herokuapp.com/caxlsx_rails/0.6.3?label=0.6.3)
+[![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)
 
 ## Notice: Community Axlsx Organization
 
-To better maintain the Axlsx ecosystem, all related gems have been forked or moved to the following community organization: 
+To better maintain the Axlsx ecosystem, all related gems have been forked or moved to the following community organization:
 
-http://github.com/caxlsx
+https://github.com/caxlsx
 
 [Join the Caxlsx Slack channel](https://join.slack.com/t/caxlsx/shared_invite/enQtOTI5OTM0MzI1Njk5LTBlMDQzNDk2YzkwODMxMmVkODMyYzJiZGU5NTQ3YTg5NTBlN2IwZTlmNTRjNzhiY2E0MDY2OTEyYmFlODI5NjA)
 
@@ -36,10 +33,9 @@ See [previous installations](#previous-installations) if needed.
 
 ## Requirements
 
-* Tested on Rails 4.2, 5.x and 6.0
-* 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.
+* Tested on Rails 6.1, and 7.x.
+* Supported Ruby versions: 2.6, 2.7, 3.x
+* Minimum Caxlsx version: 4.0
 
 ## FYI
 
@@ -249,8 +245,8 @@ RSpec.shared_context 'axlsx' do
     # mimics an ActionView::Template class, presenting a 'source' method
     # to retrieve the content of the template
     filename = Rails.root.join(*template_path).to_s
-    source = Struct.new(:source).new(File.read(filename))
-    axlsx_binding.eval(ActionView::Template::Handlers::AxlsxBuilder.new.call(source), filename)
+    template = Struct.new(:source).new(File.read(filename))
+    axlsx_binding.eval(AxlsxRails::TemplateHandler.new.call(template), filename)
     axlsx_binding.local_variable_get(:wb)
   end
 end
@@ -295,7 +291,7 @@ end
 
 require 'rspec/expectations'
 
-module XslsMatchers
+module XlsxMatchers
 
   RSpec::Matchers.define :have_header_cells do |cell_values|
     match do |worksheet|
@@ -383,7 +379,7 @@ If you get these errors, please open an issue and share code so the bug can be i
 
 ### 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. 
+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
 
@@ -422,35 +418,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}
 ```
 
-### What to do
+### Rails 7 Unknown Format
 
-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.
+In Rails 7, if you get an error of "Unknown Format" you may need to add `(format: "xlsx")` to the named route.
 
-## Previous Installations
+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`.
 
-In your Gemfile:
+#### Code Examples
+
+Scenario 1 - HTML Link within index.html.erb
 
 ```ruby
-gem 'rubyzip', '>= 1.2.1'
-gem 'axlsx', git: 'https://github.com/randym/axlsx.git', ref: 'c8ac844'
-gem 'axlsx_rails'
+link_to "Download as Excel", my_named_route_path(format: "xlsx")
 ```
 
-If `rubyzip 1.0.0` is needed:
+Scenario 2 - Using form_with()
 
 ```ruby
-gem 'rubyzip', '= 1.0.0'
-gem 'axlsx', '= 2.0.1'
-gem 'axlsx_rails'
+form_with method: :post, url: my_named_route_path(format: :xlsx) do |f|
 ```
 
-If `rubyzip >= 1.1.0` is needed:
+### What to do
 
-```ruby
-gem 'rubyzip', '~> 1.1.0'
-gem 'axlsx', '2.1.0.pre'
-gem 'axlsx_rails'
-```
+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.
 
 ## Dependencies
 
@@ -476,111 +466,3 @@ Many thanks to [contributors](https://github.com/caxlsx/caxlsx_rails/graphs/cont
 * [kodram](https://github.com/kodram)
 * [JohnSmall](https://github.com/JohnSmall)
 * [BenoitHiller](https://github.com/BenoitHiller)
-
-## Donations
-
-Say thanks for Axlsx-Rails by donating! It makes it easier for me to provide to open
-source:
-
-[![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)
-
-## Change log
-
-**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
-
-**December 18, 2019**: 0.6.1 release
-
-- Deprecate axlsx_rails name, release under caxlsx_rails
-- Switch to using caxlsx 3.0 gem
-
-**September 5, 2019**: 0.6.0 release
-
-- Improved Rails 6.0 compatibility re MIME type
-
-**May 1st, 2018**: 0.5.2 release
-
-- Improved Rails 5 compatibility re MIME type
-
-**March 29th, 2017**: 0.5.1 release
-
-- Fix stack trace line numbers
-- Thanks to [BenoitHiller](https://github.com/BenoitHiller)
-
-**July 26st, 2016**: 0.5.0 release
-
-- Support for Rails 5
-- **Tested on on Rails 4.0, 4.1, 4.2, and 5.0**
-- Bug fixes for unreadable files and UTF-8 errors
-
-**July 13th, 2015**: 0.4.0 release
-
-- Support for Rails 4.2
-- **Removal of forced default_formats** (url format must match)
-- **Tested only on Rails 4.1 and 4.2**
-- **For Rails 3.2 or below, use 0.3.0**
-
-**November 20th, 2014**: 0.3.0 release
-
-- Support for Rails 4.2.beta4.
-- **Removal of shorthand template syntax** (`render xlsx: 'another/directory'`)
-
-**September 4, 2014**: 0.2.1 release
-
-- Rails 4.2.beta1 no longer includes responder. This release checks for the existence of responder before configuring a default responder.
-- Rails 4.2 testing, though not yet on Travis CI
-- Author, created_at, and use_shared_strings parameters for Axlsx::Package.new
-
-**April 9, 2014**: 0.2.0 release
-
-- Require Axlsx 2.0.1, which requires rubyzip 1.0.0
-- Better render handling and testing, which might break former usage
-- Rails 4.1 testing
-- Mailer example update (**use render_to_string not render**)
-
-**October 11, 2013**
-
-- Handle (and test) respond_to override
-
-**October 4, 2013**
-
-- Added coveralls
-- Raised testing to axlsx 2.0.1, roo 1.12.2, and rubyzip 1.0.0
-
-**July 25, 2013**
-
-- Documentation improved
-- Testing for generating partial in mailer
-
-**January 18, 2013**: 0.1.4 release
-
-- Now supports Rails 4 (thanks [Envek](https://github.com/Envek))
-- If you call render :xlsx on a request without :xlsx format, it should force the :xlsx format. Works on Rails 3.2+.
-
-**December 6, 2012**: 0.1.3 release
-
-- Fix for absolute template paths
-
-**July 25, 2012**: 0.1.2 release
-
-- Partials tested
-
-**July 19, 2012**: 0.1.1 release
-
-- Travis-ci added (thanks [randym](https://github.com/randym))
-- render statements and filename tests fixes (thanks [engwan](https://github.com/engwan))
-
-**July 17, 2012**: 0.1.0 release
-
-- Tests completed
-- Acts_as_xlsx tested, example in docs
-
-**July 12, 2012**: 0.0.1 release
-
-- Initial posting.
-- It works, but there are no tests! Bad programmer!

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.metadata = {
+    "changelog_uri" => "https://github.com/caxlsx/caxlsx_rails/blob/master/CHANGELOG.md"
+  }
+
+  s.files = Dir['lib/**/*', 'CHANGELOG.md', 'README.md', 'MIT-LICENSE', 'caxlsx_rails.gemspec']
+
+  s.add_dependency 'actionpack', '>= 6.1'
+  s.add_dependency 'caxlsx', '>= 4.0'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'roo'
+  s.add_development_dependency 'rubyzip'
+
+  s.required_ruby_version = '>= 2.6'
+end

data/lib/axlsx_rails/action_controller.rb

@@ -2,15 +2,7 @@
 
 require 'action_controller'
 
-if Rails.version.to_f >= 5
-  unless Mime[:xlsx]
-  	Mime::Type.register 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx
-  end
-else
-  unless defined? Mime::XLSX
-    Mime::Type.register 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx
-  end
-end
+Mime::Type.register 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx unless Mime[:xlsx]
 
 ActionController::Renderers.add :xlsx do |filename, options|
   #
@@ -19,7 +11,7 @@ ActionController::Renderers.add :xlsx do |filename, options|
   #  def called_action
   #    render xlsx: 'filename', template: 'controller/diff_action'
   #  end
-  # 
+  #
   # And the normal use case works:
   #
   #  def called_action
@@ -28,14 +20,21 @@ ActionController::Renderers.add :xlsx do |filename, options|
   #    render 'controller/diff_action'
   #  end
   #
-  options[:template] = filename.gsub(/^.*\//,'') if options[:template] == action_name
+  if options[:template].nil?
+    options[:template] ||= action_name
+    options[:prefixes] ||= self.class.ancestors
+                               .take_while { |a| a.respond_to?(:controller_path) }
+                               .map(&:controller_path)
+  end
+
+  options[:template] = filename.gsub(%r{^.*/}, '') if options[:template] == action_name
 
   # force layout false
   options[:layout] = false
 
   # disposition / filename
   disposition = options.delete(:disposition) || 'attachment'
-  file_name = options.delete(:filename) || "#{filename.gsub(/^.*\//,'')}.xlsx"
+  file_name = options.delete(:filename) || "#{filename.gsub(%r{^.*/}, '')}.xlsx"
   file_name = "#{file_name}.xlsx" unless file_name =~ /\.xlsx$/
 
   # alternate settings
@@ -46,22 +45,18 @@ ActionController::Renderers.add :xlsx do |filename, options|
     options[:locals][:xlsx_use_shared_strings] = options.delete(:xlsx_use_shared_strings)
   end
 
-  mime = Rails.version.to_f >= 5 ? Mime[:xlsx] : Mime::XLSX
-  send_data render_to_string(options), filename: file_name, type: mime, disposition: disposition
+  send_data render_to_string(options), filename: file_name, type: Mime[:xlsx], disposition: disposition
 end
 
 # For respond_to default
-begin
-  ActionController::Responder
-rescue
-else
+if defined?(ActionController::Responder)
   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))
+        controller.render({ xlsx: controller.action_name }.merge(options))
       end
     end
   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,26 @@
 # 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
-      end
+module AxlsxRails
+  class TemplateHandler
+    def default_format
+      Mime[:xlsx].symbol
+    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 'caxlsx';"
+      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.3'
+  VERSION = '0.7.1'
 end

data/lib/axlsx_rails.rb

@@ -2,4 +2,4 @@
 
 warn "DEPRECATION WARNING: axlsx_rails has been renamed to caxlsx_rails. See http://github.com/caxlsx"
 
-require 'axlsx_rails/railtie' if defined?(Rails)
+require 'caxlsx_rails'