to_spreadsheet 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 776455eae95d6fc809d03558bc270aead0bb0c57
-  data.tar.gz: f38ea16841baabc6bcccfe42eb3d01d8d1d4d624
+  metadata.gz: b8caf02160bc192777511420e81ac8df803f8f6d
+  data.tar.gz: 393535d43b6e6563ed1e7831532bd607ad485fda
 SHA512:
-  metadata.gz: acf617a13f77b92278751e2ffc70516d00a7e026c892c13d6deb36c8fe63f6754428ad032a696ba2387183fcf245775266364ded8614ce915fef2375180652e6
-  data.tar.gz: 0dd83cfc2f159be301559c61861f3eae5eb1f0e60fb297226d368ba84df6cd003aefdfd6d893a28d8541032de50c5c2955c19f9e86b3bab11c636f74492de6f8
+  metadata.gz: c0c0ef72af612b307b511e3235c8f91656d56a976855672a8883072b9a0932276192ca68ee4a038fd8640c18414cbb0301bf53f16032fb18bfa9fd16c19bdc11
+  data.tar.gz: 430257b549ee502de4860ea92404e8b97e7182af9fa955a9e19a693311422d10003e432463aa8ad501eb55c197a7877342842a247ff4b33cd6d2da49f5a111a5

data/README.md

@@ -0,0 +1,149 @@
+# to_spreadsheet [![Build Status](https://secure.travis-ci.org/glebm/to_spreadsheet.png?branch=master)](http://travis-ci.org/glebm/to_spreadsheet)
+
+to_spreadsheet lets your Rails 3+ app render Excel files using the existing slim/haml/erb/etc views.
+
+Installation
+------------
+
+Add it to your Gemfile:
+```ruby
+gem 'to_spreadsheet'
+```
+
+Usage
+-----
+
+In the controller:
+```ruby
+# my_thingies_controller.rb
+class MyThingiesController < ApplicationController
+  respond_to :xls, :html
+  def index
+    @my_items = MyItem.all
+    respond_to do |format|
+      format.html
+      format.xlsx { render xlsx: :index, filename: "my_items_doc" }
+    end
+  end
+end
+```
+
+In the view partial:
+```haml
+# _my_items.haml
+%table
+  %caption My items
+  %thead
+    %tr
+      %td ID
+      %td Name
+  %tbody
+    - my_items.each do |my_item|
+      %tr
+        %td.number= my_item.id
+        %td= my_item.name
+  %tfoot
+    %tr
+      %td(colspan="2") #{my_items.length}
+```
+
+In the XLSX view:
+```haml
+# index.xls.haml
+= render 'my_items', my_items: @my_items
+```
+
+In the HTML view:
+```haml
+# index.html.haml
+= link_to 'Download spreadsheet', my_items_url(format: :xlsx)
+= render 'my_items', my_items: @my_items
+```
+
+### Worksheets
+
+Every table in the view will be converted to a separate sheet.
+The sheet title will be assigned to the value of the table’s caption element if it exists.
+
+### Formatting
+
+You can define formats in your view file (local to the view) or in the initializer
+
+```ruby
+format_xls 'table.my-table' do
+  workbook use_autowidth: true
+  sheet    orientation: landscape
+  format 'th', b: true # bold
+  format 'tbody tr', bg_color: lambda { |row| 'ddffdd' if row.index.odd? }
+  format 'A3:B10', i: true # italic
+  format column: 0, width: 35
+  format 'td.custom', lambda { |cell| modify cell somehow.}
+  # default value (fallback value when value is blank or 0 for integer / float)
+  default 'td.price', 10
+end
+```
+
+For the full list of supported properties head here: http://rubydoc.info/github/randym/axlsx/Axlsx/Styles#add_style-instance_method
+In addition, for column formats, Axlsx columnInfo properties are also supported
+
+### Advanced formatting
+
+to_spreadsheet [associates](https://github.com/glebm/to_spreadsheet/blob/master/lib/to_spreadsheet/renderer.rb#L33) HTML nodes with Axlsx objects as follows:
+
+| HTML tag | Axlsx object |
+|----------|--------------|
+| table    | worksheet    |
+| tr       | row          |
+| td, th   | cell         |
+
+For example, to directly manipulate a worksheet:
+```ruby
+format_xls do
+  format 'table' do |worksheet|
+    worksheet.add_chart ...
+    # to get the associated Nokogiri node:
+    el = context.to_xml_node(worksheet)
+  end
+end
+```
+
+### Themes
+
+You can define themes, i.e. blocks of formatting code:
+```ruby
+ToSpreadsheet.theme :zebra do
+  format 'tr', bg_color: lambda { |row| 'ddffdd' if row.index.odd? }
+end
+```
+
+And then use them:
+```ruby
+format_xls 'table.zebra', ToSpreadsheet.theme(:zebra)
+```
+
+### Using along side axlsx-rails
+If you are using [axlsx-rails](https://github.com/straydogstudio/axlsx_rails), :xlsx renderer might have already been defined. In that case define a custome renderer using
+```ruby
+# app/config/application.rb
+config.to_spreadsheet.renderer = :html2xlsx
+```
+
+And then in controller
+```ruby
+respond_to do |format|
+  format.html2xlsx
+end
+```
+
+### Types
+
+The default theme uses class names on td/th to cast values.
+Here is the list of class to type mapping:
+
+| CSS class        | Format                   |
+|------------------|--------------------------|
+| decimal or float | Decimal                  |
+| num or int       | Integer                  |
+| datetime         | DateTime (Chronic.parse) |
+| date             | Date (Date.parse)        |
+| time             | Time (Chronic.parse)     |

data/Rakefile

@@ -21,3 +21,12 @@ task :write_test_xlsx => :env do
   ToSpreadsheet::Renderer.to_package(html).serialize(path)
   puts "Written to #{path}"
 end
+
+desc "Test all rails versions"
+task :test_all_rails do
+  Dir.glob("./spec/gemfiles/*{[!.lock]}").each do |gemfile|
+    puts "TESTING WITH #{gemfile}"
+    system "BUNDLE_GEMFILE=#{gemfile} bundle | grep Installing"
+    system "BUNDLE_GEMFILE=#{gemfile} bundle exec rspec"
+  end
+end

data/lib/to_spreadsheet.rb

@@ -1,10 +1,13 @@
 require 'to_spreadsheet/version'
 require 'to_spreadsheet/context'
 require 'to_spreadsheet/renderer'
-require 'to_spreadsheet/railtie' if defined?(Rails)
 
 module ToSpreadsheet
   class << self
+    def renderer
+      @renderer ||= :xlsx
+    end
+
     def theme(name, &formats)
       @themes ||= {}
       if formats
@@ -16,5 +19,6 @@ module ToSpreadsheet
   end
 end
 
+require 'to_spreadsheet/railtie' if defined?(Rails)
 require 'to_spreadsheet/themes/default'
 ToSpreadsheet::Context.global.format_xls ToSpreadsheet.theme(:default)

data/lib/to_spreadsheet/rails/action_pack_renderers.rb

@@ -1,16 +1,26 @@
 require 'active_support'
 require 'action_controller/metal/renderers'
-require 'action_controller/responder'
+
+# in rails 3.2  it's ActiveSupport::VERSION
+# in rails 4.0+ it's ActiveSupport.version (instance of Gem::Version)
+if ActiveSupport.respond_to?(:version) && ActiveSupport.version.to_s >= "4.2.0"
+  # For rails 4.2
+  require 'action_controller/responder'
+else
+  # For rails 3.2 - rails 4.1
+  require 'action_controller/metal/responder'
+end
+
 
 # This will let us do thing like `render :xlsx => 'index'`
 # This is similar to how Rails internally implements its :json and :xml renderers
-ActionController::Renderers.add :xlsx do |template, options|
+ActionController::Renderers.add ToSpreadsheet.renderer do |template, options|
   filename = options[:filename] || options[:template] || 'data'
   data = ToSpreadsheet::Context.with_context ToSpreadsheet::Context.global.merge(ToSpreadsheet::Context.new) do |context|
     html = render_to_string(template, options.merge(template: template.to_s, formats: ['xlsx', 'html']))
     ToSpreadsheet::Renderer.to_data(html, context)
   end
-  send_data data, type: :xlsx, disposition: %(attachment; filename="#{filename}.xlsx")
+  send_data data, type: ToSpreadsheet.renderer, disposition: %(attachment; filename="#{filename}.xlsx")
 end
 
 class ActionController::Responder
@@ -18,7 +28,7 @@ class ActionController::Responder
   # respond_to do |format|
   #   format.xlsx
   # end
-  def to_xlsx
-    controller.render xlsx: controller.action_name
+  define_method "to_#{ToSpreadsheet.renderer}" do
+    controller.render ToSpreadsheet.renderer => controller.action_name
   end
 end

data/lib/to_spreadsheet/rails/mime_types.rb

@@ -1,2 +1,2 @@
 require 'action_dispatch/http/mime_type'
-Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx unless Mime::Type.lookup_by_extension(:xlsx)
+Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", ToSpreadsheet.renderer unless Mime::Type.lookup_by_extension(ToSpreadsheet.renderer)

data/lib/to_spreadsheet/railtie.rb

@@ -1,10 +1,15 @@
 require 'rails/railtie'
-require 'to_spreadsheet/rails/mime_types'
-require 'to_spreadsheet/rails/action_pack_renderers'
-require 'to_spreadsheet/rails/view_helpers'
 module ToSpreadsheet
   class Railtie < ::Rails::Railtie
-    initializer "to_spreadsheet.view_helpers" do
+    config.to_spreadsheet = ActiveSupport::OrderedOptions.new
+    config.to_spreadsheet.renderer = ToSpreadsheet.renderer
+
+    config.after_initialize do |app|
+      ToSpreadsheet.instance_variable_set("@renderer", app.config.to_spreadsheet.renderer)
+
+      require 'to_spreadsheet/rails/action_pack_renderers'
+      require 'to_spreadsheet/rails/view_helpers'
+      require 'to_spreadsheet/rails/mime_types'
       ActionView::Base.send :include, ToSpreadsheet::Rails::ViewHelpers
     end
   end

data/lib/to_spreadsheet/version.rb

@@ -1,3 +1,3 @@
 module ToSpreadsheet
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/spec/rails_integration_spec.rb

@@ -0,0 +1,10 @@
+require 'to_spreadsheet/railtie'
+
+describe ToSpreadsheet::Railtie do
+
+  it "registers a renderer" do
+    expect(ToSpreadsheet.renderer).to eq(:html2xlsx)
+    expect(ActionController::Renderers::RENDERERS).to include(ToSpreadsheet.renderer)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: to_spreadsheet
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-28 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,15 +108,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Render XLSX from Rails using existing views ( .*.html => .xlsx )
 email: glex.spb@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.textile
+- README.md
 files:
 - LICENSE
-- README.textile
+- README.md
 - Rakefile
 - lib/to_spreadsheet.rb
 - lib/to_spreadsheet/context.rb
@@ -139,6 +153,7 @@ files:
 - lib/to_spreadsheet/version.rb
 - spec/defaults_spec.rb
 - spec/format_spec.rb
+- spec/rails_integration_spec.rb
 - spec/types_spec.rb
 - spec/worksheets_spec.rb
 homepage: https://github.com/glebm/to_spreadsheet
@@ -160,13 +175,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Render existing views as Excel documents with style!
 test_files:
-- spec/defaults_spec.rb
 - spec/format_spec.rb
+- spec/rails_integration_spec.rb
 - spec/types_spec.rb
+- spec/defaults_spec.rb
 - spec/worksheets_spec.rb
-has_rdoc: true

data/README.textile

@@ -1,116 +0,0 @@
-to_spreadsheet is a gem that lets you render xls from your existing slim/haml/erb/etc views from Rails (>= 3.0). !https://secure.travis-ci.org/glebm/to_spreadsheet.png?branch=master(Build Status)!:http://travis-ci.org/glebm/to_spreadsheet
-
-h2. Installation
-
-Add it to your Gemfile:
-
-bc. gem 'to_spreadsheet'
-
-h2. Usage
-
-In your controller:
-
-bc. # my_thingies_controller.rb
-class MyThingiesController < ApplicationController
-  respond_to :xls, :html
-  def index
-    @my_items = MyItem.all
-    respond_to do |format|
-      format.html 
-      format.xlsx { render xlsx: :index, filename: "my_items_doc" }
-    end
-  end
-end
-
-In your view partial:
-
-bc. # _my_items.haml
-%table
-  %caption My items
-  %thead
-    %tr
-      %td ID
-      %td Name
-  %tbody
-    - my_items.each do |my_item|
-      %tr
-        %td.number= my_item.id
-        %td= my_item.name
-  %tfoot
-    %tr
-      %td(colspan="2") #{my_items.length}
-
-In your index.xls.haml:
-
-bc. # index.xls.haml
-= render 'my_items', my_items: @my_items
-
-In your index.html.haml:
-
-bc. # index.html.haml
-= link_to 'Download spreadsheet', my_items_url(format: :xlsx)
-= render 'my_items', my_items: @my_items
-
-h3. Worksheets
-
-Every table in the view will be converted to a separate sheet.
-The sheet title will be assigned to the value of the table's caption element if it exists.
-
-h3. Formatting
-
-You can define formats in your view file (local to the view) or in the initializer
-
-bc. format_xls 'table.my-table' do
-  workbook use_autowidth: true
-  sheet    orientation: landscape
-  format 'th', b: true # bold
-  format 'tbody tr', bg_color: lambda { |row| 'ddffdd' if row.index.odd? }
-  format 'A3:B10', i: true # italic
-  format column: 0, width: 35
-  format 'td.custom', lambda { |cell| modify cell somehow.}
-  # default value (fallback value when value is blank or 0 for integer / float)
-  default 'td.price', 10
-
-For the full list of supported properties head here: http://rubydoc.info/github/randym/axlsx/Axlsx/Styles#add_style-instance_method
-In addition, for column formats, Axlsx columnInfo properties are also supported
-
-h3. Advanced formatting
-
-to_spreadsheet "associates":https://github.com/glebm/to_spreadsheet/blob/master/lib/to_spreadsheet/renderer.rb#L33 HTML nodes with Axlsx objects as follows:
-
-|_. HTML tag       |_. Axlsx object |
-| table            | worksheet      |
-| tr               | row            |
-| td, th           | cell           |
-
-For example, to directly manipulate a worksheet:
-
-bc. format_xls do
-  format 'table' do |worksheet|
-    worksheet.add_chart ...
-    # to get the associated Nokogiri node:
-    el = context.to_xml_node(worksheet)
-
-
-h3. Themes
-
-You can define "themes" - blocks of formatting code:
-
-bc. ToSpreadsheet.theme :zebra do
-  format 'tr', bg_color: lambda { |row| 'ddffdd' if row.index.odd? }
-
-And then use them:
-
-bc. format_xls 'table.zebra', ToSpreadsheet.theme(:zebra)
-
-h3. Types
-
-The default theme uses class names on td/th to cast values.
-Here is the list of class to type mapping:
-
-|_. ==CSS== class  |_. Format |
-| decimal or float | Decimal  |
-| num or int       | Integer  |
-| datetime         | DateTime (Chronic.parse) |
-| date             | Date (Date.parse)        |
-| time             | Time (Chronic.parse)     |