workbook_rails 0.1.0

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WorkbookRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks
+

data/lib/tasks/workbook_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :workbook_rails do
+#   # Task goes here
+# end

data/lib/workbook_rails.rb

@@ -0,0 +1,5 @@
+require 'workbook_rails/engine'
+module WorkbookRails
+  FORMATS = [:xlsx, :xls]
+end
+

data/lib/workbook_rails/action_controller.rb

@@ -0,0 +1,51 @@
+#
+# You can always specify a template:
+#
+#  def called_action
+#    render xlsx: 'filename', template: 'controller/diff_action'
+#  end
+#
+# And the normal use case works:
+#
+#  def called_action
+#    render 'diff_action'
+#    # or
+#    render 'controller/diff_action'
+#  end
+#
+WorkbookRails::FORMATS.each do |format|
+  ActionController::Renderers.add format do |filename, options|
+    if options[:template] == action_name
+      options[:template] = filename.gsub(/^.*\//,'')
+    end
+
+    # disposition / filename
+    disposition = options.delete(:disposition) || 'attachment'
+    if file_name = options.delete(:filename)
+      file_name += ".#{format}" unless file_name =~ /\.#{format}$/
+    else
+      file_name = "#{filename.gsub(/^.*\//,'')}.#{format}"
+    end
+
+    options = options.merge(:formats => [format])
+    send_data render_to_string(options), :filename => file_name, :type => Mime::Type.lookup_by_extension(format), :disposition => disposition
+  end
+end
+
+# For respond_to default
+begin
+  ActionController::Responder
+rescue
+else
+  class ActionController::Responder
+    WorkbookRails::FORMATS.each do |format|
+      define_method "to_#{format}" do
+        if @default_response
+          @default_response.call(options)
+        else
+          controller.render options.reverse_merge(format => controller.action_name)
+        end
+      end
+    end
+  end
+end

data/lib/workbook_rails/engine.rb

@@ -0,0 +1,25 @@
+require 'workbook'
+require 'workbook_rails/template_handler'
+
+module WorkbookRails
+  class Engine < Rails::Engine
+    initializer 'workbook_rails.action_view' do
+      ActiveSupport.on_load :action_view do
+        ::ActionView::Template.register_template_handler :wb, WorkbookRails::TemplateHandler
+      end
+    end
+
+    initializer 'workbook_rails.action_controller' do
+      ActiveSupport.on_load :action_controller do
+        require 'workbook_rails/action_controller'
+      end
+    end
+
+    unless Mime::Type.lookup_by_extension(:xlsx)
+      Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+    end
+    unless Mime::Type.lookup_by_extension(:xls)
+      Mime::Type.register "application/vnd.ms-excel", :xls
+    end
+  end
+end

data/lib/workbook_rails/template_handler.rb

@@ -0,0 +1,23 @@
+module WorkbookRails
+  class TemplateHandler
+    class_attribute :default_format
+    self.default_format = :xlsx
+
+    def self.workbook_to_string(workbook, format)
+      case format
+      when :xlsx then workbook.stream_xlsx
+      when :xls then
+        io = StringIO.new
+        workbook.to_xls.write(io)
+        io.string
+      end
+    end
+
+    def self.call(template)
+      "workbook = Workbook::Book.new;\n" +
+      template.source +
+      ";\nWorkbookRails::TemplateHandler.workbook_to_string(workbook, lookup_context.rendered_format);"
+    end
+
+  end
+end

data/lib/workbook_rails/version.rb

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

data/spec/ci.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+exit system('cd spec/dummy && bundle install --without debug && bundle exec rake db:create && bundle exec rake db:migrate && cd ../../ && bundle exec rspec spec')

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,60 @@
+#---
+# Excerpted from "Crafting Rails Applications",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material,
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose.
+# Visit http://www.pragmaticprogrammer.com/titles/jvrails for more book information.
+#---
+class HomeController < ApplicationController
+  def index
+  end
+
+  def generic
+    respond_to do |format|
+      format.html
+      format.xlsx
+      format.xls
+    end
+  end
+
+  def only_html; end
+
+  def another
+    render :xlsx => "index", :filename => "filename_test.xlsx"
+  end
+
+  def render_elsewhere
+    case params[:type]
+    when '1'
+      render :xlsx => "home/index", :template => 'users/respond_with'
+    when '2'
+      render :xlsx => "users/respond_with", :template => 'users/respond_with'
+    when '3'
+      render template: "users/respond_with"
+    when '4'
+      render "users/respond_with"
+    else
+      render :xlsx => "index"
+    end
+  end
+
+  def render_file_path
+    render :xlsx => 'index', :file => Rails.root.join('app','views','users','respond_with')
+  end
+
+  def withpartial
+  end
+
+  def useheader
+    respond_to do |format|
+      format.xlsx {
+        if params[:set_direct]
+          response.headers['Content-Disposition'] = "attachment; filename=\"filename_test.xlsx\""
+        else
+          render xlsx: "useheader", filename: "filename_test.xlsx"
+        end
+      }
+    end
+  end
+end

data/spec/dummy/app/controllers/likes_controller.rb

@@ -0,0 +1,18 @@
+class LikesController < ApplicationController
+  # GET /likes
+  # GET /likes.json
+  def index
+    @user = User.find(params[:user_id])
+    @likes = @user.likes
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xlsx
+    end
+  end
+
+  def render_elsewhere
+    @user = User.find(params[:user_id])
+    render :xlsx => "index", :template => 'users/respond_with'
+  end
+end

data/spec/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,16 @@
+class UsersController < ApplicationController
+  respond_to :xlsx, :html
+
+  def show
+    @user = User.find(params[:id])
+    respond_with(@user) do |format|
+      format.xlsx { render "respond_with" }
+    end
+  end
+
+  def send_instructions
+    @user = User.find(params[:user_id])
+    @user.send_instructions
+    render text: "Email sent"
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/mailers/notifier.rb

@@ -0,0 +1,14 @@
+class Notifier < ActionMailer::Base
+  default :from => 'noreply@company.com'
+
+  def instructions(user)
+    @user = user
+
+    # normal syntax
+    xlsx = render_to_string handlers: [:wb], template: 'users/mailers/instructions', layout: false, formats: [:xlsx]
+    attachments["user_#{user.id}.xlsx"] = {mime_type: Mime::XLSX, content: xlsx}
+
+    mail :to => user.email, :subject => 'Instructions'
+  end
+
+end

data/spec/dummy/app/models/like.rb

@@ -0,0 +1,3 @@
+class Like < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,8 @@
+class User < ActiveRecord::Base
+  has_many :likes
+
+  def send_instructions
+    mail = Notifier.instructions(self)
+    mail.send(mail.respond_to?(:deliver_now) ? :deliver_now : :deliver)
+  end
+end

data/spec/dummy/app/views/home/_cover_sheet.xlsx.wb

@@ -0,0 +1,2 @@
+wb.sheet.name = "Cover Sheet"
+wb.sheet.table << ['Cover', 'Sheet']

data/spec/dummy/app/views/home/generic.wb

@@ -0,0 +1,5 @@
+workbook.sheet.name = "Foobar"
+workbook.sheet.table.push ['Bad', 'spellers', 'of', 'the', 'world', '...']
+workbook.sheet.table.push ['Untie!']
+workbook.sheet.table['A2'].rowspan = 2
+workbook.sheet.table['A2'].format = {width: 16, font_weight: 'bold'}

data/spec/dummy/app/views/home/index.html.erb

@@ -0,0 +1,4 @@
+<p>Hey, you can download the xlsx for this page by clicking the link below:</p>
+<p><%= link_to "XLSX", home_path("xlsx") %></p>
+<p><%= link_to "Another", '/another.xlsx' %></p>
+<p><%= link_to "User header", '/useheader.xlsx' %></p>

data/spec/dummy/app/views/home/index.xls.wb

@@ -0,0 +1,5 @@
+workbook.sheet.name = "Foobar"
+workbook.sheet.table.push ['Bad', 'spellers', 'of', 'the', 'world', '...']
+workbook.sheet.table.push ['Untie!']
+workbook.sheet.table['A2'].rowspan = 2
+workbook.sheet.table['A2'].format = {width: 16, font_weight: 'bold'}

data/spec/dummy/app/views/home/index.xlsx.wb

@@ -0,0 +1,5 @@
+workbook.sheet.name = "Foobar"
+workbook.sheet.table.push ['Bad', 'spellers', 'of', 'the', 'world', '...']
+workbook.sheet.table.push ['Untie!']
+workbook.sheet.table['A2'].rowspan = 2
+workbook.sheet.table['A2'].format = {width: 16, font_weight: 'bold'}

data/spec/dummy/app/views/home/only_html.html.erb

@@ -0,0 +1 @@
+<p>Foo, bar</p>

data/spec/dummy/app/views/home/useheader.xlsx.wb

@@ -0,0 +1,5 @@
+workbook.sheet.name = "Useheader"
+workbook.sheet.table.push ['Bad', 'spellers', 'of', 'the', 'world', '...']
+workbook.sheet.table.push ['Untie!']
+workbook.sheet.table['A2'].rowspan = 2
+workbook.sheet.table['A2'].format = {width: 16, font_weight: 'bold'}

data/spec/dummy/app/views/home/withpartial.xlsx.wb

@@ -0,0 +1,6 @@
+render :partial => 'cover_sheet', :locals => {:wb => workbook}
+workbook << [['Bad', 'spellers', 'of', 'the', 'world', '...'], ['Untie!']]
+sheet = workbook.last
+sheet.name = 'Foobar'
+sheet.table['A2'].rowspan = 2
+sheet.table['A2'].format = {width: 16, font_weight: 'bold'}

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy 4</title>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/likes/index.html.erb

@@ -0,0 +1,17 @@
+<h1>Listing likes for <%= @user.name %></h1>
+
+<table>
+  <tr>
+    <th>Name</th>
+  </tr>
+
+<% @likes.each do |like| %>
+  <tr>
+    <td><%= like.name %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Like', new_like_path %>

data/spec/dummy/app/views/likes/index.xlsx.wb

@@ -0,0 +1,5 @@
+workbook.sheet.name = "Foobar"
+workbook.sheet.table.push [@user.name]
+@likes.each do |like|
+  workbook.sheet.table << [like.name]
+end

data/spec/dummy/app/views/notifier/instructions.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <h1>Instructions</h1>
+    <p>
+      You have successfully signed up to example.com,
+      your username is: <%= @user.email %>.<br/>
+    </p>
+    <p>Thanks for joining and have a great day!</p>
+  </body>
+  </html>

data/spec/dummy/app/views/notifier/instructions.txt.erb

@@ -0,0 +1,6 @@
+Instructions
+
+You have successfully signed up to example.com,
+your username is: <%= @user.email %>.
+
+Thanks for joining and have a great day!