caxlsx_rails 0.6.2 → 0.6.3

data/README.md

@@ -13,13 +13,22 @@ Status](https://coveralls.io/repos/caxlsx/caxlsx_rails/badge.svg)](https://cover
 
 ![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)
+![Downloads for 0.6.3 (latest)](http://ruby-gem-downloads-badge.herokuapp.com/caxlsx_rails/0.6.3?label=0.6.3)
+
+## Notice: Community Axlsx Organization
+
+To better maintain the Axlsx ecosystem, all related gems have been forked or moved to the following community organization: 
+
+http://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'
 ```
 
@@ -34,12 +43,12 @@ See [previous installations](#previous-installations) if needed.
 
 ## 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 +78,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.
 
@@ -325,6 +334,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 +381,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.
@@ -387,7 +424,7 @@ link_to 'Download spreadsheet', path_to_sheet, data: {turbolinks: false}
 
 ### 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 +455,7 @@ gem 'axlsx_rails'
 ## Dependencies
 
 - [Rails](https://github.com/rails/rails)
-- [Axlsx](https://github.com/caxlsx/axlsx)
+- [caxlsx](https://github.com/caxlsx/caxlsx)
 
 ## Authors
 
@@ -449,6 +486,10 @@ source:
 
 ## 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

data/lib/axlsx_rails/version.rb

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