workbook_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99b581f30cf5d61337cee27f99be081975f2e89c
+  data.tar.gz: 9e27f7b3ed8d1abde8754b0e3d9a715a45339617
+SHA512:
+  metadata.gz: fd27b88883fa8915abff6bc44a3172e9b47b358a6a78657deb594f7ff6f1879a4abda80b2668b0ce220e6de8f12fff32ffe9758100ba2aee946ed0faddb324e8
+  data.tar.gz: 4d78bb123cc96b5c482ff9d820e9086cb2ea0caf798313d7868b8b26059eb160d737b2eda73ab489e5b01e811d5c0af0dcabfdcf1647ab32bbfd2dd5b3e80e15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change log
+
+**March 30, 2016**: 0.1.0 release
+
+- Initial posting.

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in axlsx_rails.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+gem 'rails', "~> 4.2.0"
+gem 'responders', '~> 2.0'
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+gem 'capybara', '~> 2.1'
+
+# To use debugger
+# gem 'pry-debugger'

data/Gemfile.lock

@@ -0,0 +1,207 @@
+PATH
+  remote: .
+  specs:
+    workbook_rails (0.1.0)
+      actionpack (>= 3.2)
+      workbook (>= 0.4.10)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.6)
+      activesupport (= 4.2.6)
+      globalid (>= 0.3.0)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    arel (6.0.3)
+    axlsx (2.1.0.pre)
+      htmlentities (~> 4.3.1)
+      nokogiri (>= 1.4.1)
+      rubyzip (~> 1.1.7)
+    builder (3.2.2)
+    capybara (2.7.0)
+      addressable
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    growl (1.0.3)
+    htmlentities (4.3.4)
+    i18n (0.7.0)
+    jquery-rails (4.1.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.6)
+      actionmailer (= 4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      activemodel (= 4.2.6)
+      activerecord (= 4.2.6)
+      activesupport (= 4.2.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.6)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rchardet (1.6.1)
+    responders (2.1.2)
+      railties (>= 4.2.0, < 5.1)
+    roo (2.3.2)
+      nokogiri (~> 1)
+      rubyzip (~> 1.1, < 2.0.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    ruby-ole (1.2.12)
+    rubyzip (1.1.7)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    spreadsheet (1.1.2)
+      ruby-ole (>= 1.0)
+    sprockets (3.6.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.4)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.6.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    workbook (0.5)
+      axlsx (~> 2.1.0.pre)
+      json (~> 1.8)
+      nokogiri (~> 1.6)
+      rake (~> 10.0)
+      rchardet (~> 1.3)
+      roo (~> 2.3)
+      spreadsheet (~> 1.0)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  capybara (~> 2.1)
+  coveralls
+  growl
+  jquery-rails
+  pry
+  pry-nav
+  rails (~> 4.2.0)
+  rake
+  rb-fsevent
+  responders (~> 2.0)
+  rspec-rails
+  sqlite3
+  workbook_rails!
+
+BUNDLED WITH
+   1.11.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,216 @@
+Workbook-Rails — Workbook templates for Rails views
+===================================================
+
+[![Gem
+Version](https://badge.fury.io/rb/workbook_rails.svg)](http://badge.fury.io/rb/workbook_rails)
+[![Build Status](https://secure.travis-ci.org/Programatica/workbook_rails.png?branch=master)](http://travis-ci.org/Programatica/workbook_rails)
+[![Dependency Status](https://gemnasium.com/Programatica/workbook_rails.png?branch=master)](https://gemnasium.com/Programatica/workbook_rails)
+[![Coverage
+Status](https://coveralls.io/repos/Programatica/workbook_rails/badge.png)](https://coveralls.io/r/Programatica/workbook_rails)
+
+
+##Installation
+
+In your Gemfile:
+
+```ruby
+gem 'workbook_rails'
+```
+
+##Requirements
+
+* Rails 3.2, 4.0, 4.1 or 4.2 (tested)
+* **Workbook 0.4.16 requires Axlsx 2.0.1, which requires rubyzip 1.0.0**
+* You must use `render_to_string` to render a mail attachment.
+
+##FYI
+
+* This gem depends on [Workbook](https://github.com/murb/workbook). See [README](https://github.com/murb/workbook) or [rdoc](http://www.rubydoc.info/github/murb/workbook) for usage.
+
+##Usage
+
+Workbook-Rails provides a renderer and a template handler. It adds the `:xlsx` and `:xls` formats and parses `.wb` templates. This lets you take all the [Workbook](https://github.com/murb/workbook) code out of your controller or model and place it inside the template, where view code belongs!
+
+###Controller
+
+To use Workbook-Rails set your instance variables in your controller and configure the response if needed:
+
+```ruby
+class ButtonController < ApplicationController
+  def action_name
+    @buttons = Button.all
+    respond_to do |format|
+      format.xlsx
+    end
+  end
+end
+```
+
+###Template
+
+Create the template with the `.xlsx.wb` extension (`action_name.xlsx.wb` for example.) [**Watch out for typos!**](#troubleshooting) In the template, use workbook variable to create your spreadsheet:
+
+```ruby
+table = workbook.sheet.table
+@buttons.each do |button|
+  table << [button.name, button.category, button.price]
+end
+```
+
+This is where you place all your [Workbook](https://github.com/murb/workbook) specific markup. Add worksheets, fill content, merge cells, add styles.
+
+Remember, like in `erb` templates, view helpers are available to use the `.wb` template.
+
+That's it. Call your action and your spreadsheet will be delivered.
+
+###Rendering Options
+
+You can call render in any of the following ways:
+
+```ruby
+# rendered, no disposition/filename header
+render 'buttons'
+# rendered from another controller, no disposition/filename header
+render 'featured/latest'
+# template and filename of 'buttons'
+render xlsx: 'buttons'
+# template from another controller, filename of 'latest_buttons'
+render xlsx: 'latest_buttons', template: 'featured/latest'
+```
+
+###Multi-format Templates
+
+You can create a template with `.wb` extension, without format, and use for generating different spreadsheets formats, such as xls and xlsx, using respond_to and format param.
+
+Set :format param in the route (/route_path.xlsx, or /route_path.xls) and use respond_to in the controller
+
+```ruby
+respond_to do |format|
+  format.xlsx
+  format.xls
+end
+```
+
+###Disposition
+
+To specify a disposition (such as `inline` so the spreadsheet is opened inside the browser), use the `disposition` option:
+
+```ruby
+render xlsx: "buttons", disposition: 'inline'
+```
+
+If `render xlsx:` is called, the disposition defaults to `attachment`.
+
+###File name
+
+If Rails calls Workbook through default channels (because you use `format.xlsx {}` for example) you must set the filename using the response header:
+
+```ruby
+format.xlsx {
+  response.headers['Content-Disposition'] = 'attachment; filename="my_new_filename.xlsx"'
+}
+```
+
+If you use `render xlsx:` the gem will try to guess the file name:
+
+```ruby
+# filename of 'buttons'
+render xlsx: 'buttons'
+# filename of 'latest_buttons'
+render xlsx: 'latest_buttons', template: 'featured/latest'
+```
+
+If that fails, pass the `:filename` parameter:
+
+```ruby
+render xlsx: "action_or_template", filename: "my_new_filename.xlsx"
+```
+
+###Partials
+
+Partials work as expected:
+
+```ruby
+render :partial => 'cover_sheet', :locals => {:sheet => workbook.sheet}
+workbook << [['Content']]
+workbook.last.name = 'Content'
+```
+
+With the partial simply using the passed variables:
+
+```ruby
+sheet.name = "Cover Sheet"
+sheet.table.push ['Cover', 'Sheet']
+```
+
+###Mailers
+
+To use an xlsx template to render a mail attachment, use the following syntax:
+
+```ruby
+class UserMailer < ActionMailer::Base
+  def export(users)
+    xlsx = render_to_string handlers: [:wb], formats: [:xlsx], template: "users/export", locals: {users: users}
+    attachments["Users.xlsx"] = {mime_type: Mime::XLSX, content: xlsx}
+    ...
+  end
+end
+```
+
+* If the route specifies or suggests the `:xlsx` format you do not need to specify `formats` or `handlers`.
+* If the template (`users/export`) can refer to only one file (the xlsx.axlsx template), you do not need to specify `handlers`, provided the `formats` includes `:xlsx`.
+
+###Scripts
+
+To generate a template within a script, you need to instantiate an ActionView context. Here are two gists showing how to perform this:
+
+* [Using rails runner](https://gist.github.com/straydogstudio/323139591f2cc5d48fbc)
+* [Without rails runner](https://gist.github.com/straydogstudio/dceb775ead81470cea70)
+
+##Troubleshooting
+
+###Mispellings
+
+**It is easy to get the spelling wrong in the extension name, the format.xlsx statement, or in a render call.** Here are some possibilities:
+
+* If it says your template is missing, check that its extension is `.xlsx.wb`.
+* If you get the error `uninitialized constant Mime::XSLX` you have used `format.xslx` instead of `format.xlsx`, or something similar.
+
+### Rails 4.2 changes
+
+Before Rails 4.2 you could call:
+
+```ruby
+  render xlsx: "users/index"
+```
+
+And workbook_rails could adjust the paths and make sure the template was loaded from the right directory. This is no longer possible because the paths are cached between requests for a given controller. As a result, to display a template in another directory you must use the `:template` parameter (which is normal Rails behavior anyway):
+
+```ruby
+  render xlsx: "index", template: "users/index"
+```
+
+If the request format matches you should be able to call:
+
+```ruby
+  render "users/index"
+```
+
+This is a breaking change if you have the old syntax!
+
+###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 Workbook-Rails to see if you are having Workbook problems. If you can manually create the spreadsheet, create an issue and we will work it out.
+
+##Dependencies
+
+- [Rails](https://github.com/rails/rails)
+- [Workbook](https://github.com/murb/workbook)
+
+##Authors
+
+* [Sergio Cambra](https://github.com/scambra)
+
+##Thanks
+
+Many thanks to [straydogstudio](https://github.com/straydogstudio) for [axlsx_rails](https://github.com/straydogstudio/axlsx_rails), which this gem is based in.