spreadsheet_rails 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spreadsheet_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jon Riddle
+
+MIT License
+
+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,49 @@
+# SpreadsheetRails
+
+SpreadsheetRails provides a template handler for ActionView to render
+Microsoft Excel workbooks like any view.  This was heavily inspired by
+Prawn::Rails (https://github.com/Whoops/prawn-rails).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spreadsheet_rails', git: 'git://github.com/jdrnetworking/spreadsheet_rails.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create a view template named `[action_name].xls.spreadsheet`
+
+### Block Syntax
+
+    spreadsheet_document(options) do |workbook|
+      workbook.create_worksheet name: 'My Great Worksheet'
+    end
+
+### Override Workbook Class
+
+You can also override the default workbook class (Spreadsheet::Workbook):
+
+    spreadsheet_document(renderer: MyWorkbook)
+
+and then create your workbook class:
+
+    class MyWorkbook < Spreadsheet::Workbook
+      def initialize(io = nil, options = { default_format: Spreadsheet::Format.new })
+        super
+        create_worksheet name: 'Another Great Worksheet'
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/spreadsheet_rails.rb

@@ -0,0 +1,52 @@
+require 'spreadsheet_rails/version'
+require 'spreadsheet_rails/railtie' if defined?(Rails)
+
+module SpreadsheetRails
+  module SpreadsheetRailsHelper
+    ##
+    # Render a new or existing spreadsheet workbook
+    #
+    # Pass an instance of Spreadsheet::Workbook to render it directly
+    #
+    # Valid options:
+    #  :filename: sent to client in the Content-Disposition header
+    #  :renderer: subclass of Spreadsheet::Workbook to use, defaults to Spreadsheet::Workbook
+    #  :io:       optional IO object pass to Spreadsheet::Workbook#initialize
+    #
+    # Yields the workbook object unless a spreadsheet instance is given
+    def spreadsheet_document(workbook = nil, options = {})
+      filename = options.delete(:filename)
+
+      unless workbook
+        klass = options.delete(:renderer) || Spreadsheet::Workbook
+        klass_args = [options.delete(:io)]
+        klass_args << options unless options.empty?
+        workbook = klass.new(*klass_args)
+        yield workbook if block_given?
+      end
+
+      disposition = "attachment;"
+      disposition += %Q( filename="#{filename}") if filename
+      headers['Content-Disposition'] = disposition
+
+      render_io workbook
+    end
+
+    ##
+    # Renders to a string any object that will #write to an IO object
+    def render_io(writer)
+      StringIO.new.tap do |io|
+        writer.write(io)
+      end.string
+    end
+  end
+
+  class TemplateHandler
+    class_attribute :default_format
+    self.default_format = :pdf
+
+    def self.call(template)
+      "#{template.source.strip}"
+    end
+  end
+end

data/lib/spreadsheet_rails/railtie.rb

@@ -0,0 +1,21 @@
+require 'spreadsheet'
+
+module SpreadsheetRails
+  class Railtie < Rails::Railtie
+    initializer "spreadsheet_rails.register_mime_type" do
+      Mime::Type.register_alias('application/vnd.ms-excel', :xls) unless Mime::Type.lookup_by_extension(:xls)
+    end
+
+    initializer "spreadsheet_rails.register_template_handler" do
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Template.register_template_handler(:spreadsheet, SpreadsheetRails::TemplateHandler)
+      end
+    end
+
+    initializer "spreadsheet_rails.include_action_view_helper" do
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Base.send(:include, SpreadsheetRails::SpreadsheetRailsHelper)
+      end
+    end
+  end
+end

data/lib/spreadsheet_rails/version.rb

@@ -0,0 +1,3 @@
+module SpreadsheetRails
+  VERSION = "0.1.0"
+end

data/spreadsheet_rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spreadsheet_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spreadsheet_rails"
+  spec.version       = SpreadsheetRails::VERSION
+  spec.authors       = ["Jon Riddle"]
+  spec.email         = ["coder@jdrnetworking.com"]
+  spec.description   = %q{Use spreadsheet views in Rails 3}
+  spec.summary       = %q{Use spreadsheet views in Rails 3}
+  spec.homepage      = "https://github.com/jdrnetworking/spreadsheet_rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/) - %w(.gitignore)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "spreadsheet"
+  spec.add_runtime_dependency "rails", ">= 3.1"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: spreadsheet_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jon Riddle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use spreadsheet views in Rails 3
+email:
+- coder@jdrnetworking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spreadsheet_rails.rb
+- lib/spreadsheet_rails/railtie.rb
+- lib/spreadsheet_rails/version.rb
+- spreadsheet_rails.gemspec
+homepage: https://github.com/jdrnetworking/spreadsheet_rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3697989438872928748
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3697989438872928748
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Use spreadsheet views in Rails 3
+test_files: []