caxlsx_rails 0.6.2

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    = 'CaxlsxRails'
+  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/axlsx_rails.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+warn "DEPRECATION WARNING: axlsx_rails has been renamed to caxlsx_rails. See http://github.com/caxlsx"
+
+require 'axlsx_rails/railtie' if defined?(Rails)

data/lib/axlsx_rails/action_controller.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'action_controller'
+
+if Rails.version.to_f >= 5
+  unless Mime[:xlsx]
+  	Mime::Type.register 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx
+  end
+else
+  unless defined? Mime::XLSX
+    Mime::Type.register 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx
+  end
+end
+
+ActionController::Renderers.add :xlsx do |filename, options|
+  #
+  # 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
+  #
+  options[:template] = filename.gsub(/^.*\//,'') if options[:template] == action_name
+
+  # force layout false
+  options[:layout] = false
+
+  # disposition / filename
+  disposition = options.delete(:disposition) || 'attachment'
+  file_name = options.delete(:filename) || "#{filename.gsub(/^.*\//,'')}.xlsx"
+  file_name = "#{file_name}.xlsx" unless file_name =~ /\.xlsx$/
+
+  # alternate settings
+  options[:locals] ||= {}
+  options[:locals][:xlsx_author] ||= options.delete(:xlsx_author)
+  options[:locals][:xlsx_created_at] ||= options.delete(:xlsx_created_at)
+  unless options[:locals][:xlsx_use_shared_strings]
+    options[:locals][:xlsx_use_shared_strings] = options.delete(:xlsx_use_shared_strings)
+  end
+
+  mime = Rails.version.to_f >= 5 ? Mime[:xlsx] : Mime::XLSX
+  send_data render_to_string(options), filename: file_name, type: mime, disposition: disposition
+end
+
+# For respond_to default
+begin
+  ActionController::Responder
+rescue
+else
+  class ActionController::Responder
+    def to_xlsx
+      @_action_has_layout = false
+      if @default_response
+        @default_response.call(options)
+      else
+        controller.render({xlsx: controller.action_name}.merge(options))
+      end
+    end
+  end
+end

data/lib/axlsx_rails/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AxlsxRails
+  class Railtie < Rails::Railtie
+    initializer 'axlsx_rails.initialization' do
+      ActiveSupport.on_load(:action_view) do
+        require 'axlsx_rails/template_handler'
+        ActionView::Template.register_template_handler :axlsx, ActionView::Template::Handlers::AxlsxBuilder.new
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        require 'axlsx_rails/action_controller'
+      end
+    end
+  end
+end

data/lib/axlsx_rails/template_handler.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require 'stringio'
+
+module ActionView
+  module Template::Handlers
+    class AxlsxBuilder
+
+      def default_format
+        case
+        when Rails.version.to_f >= 6
+          Mime[:xlsx].symbol
+        when Rails.version.to_f >= 5
+          Mime[:xlsx]
+        else
+          Mime::XLSX
+        end
+      end
+
+      def call(template, source = nil)
+        builder = StringIO.new
+        builder << "require 'axlsx';"
+        builder << "xlsx_author = defined?(xlsx_author).nil? ? nil : xlsx_author;"
+        builder << "xlsx_created_at = defined?(xlsx_created_at).nil? ? nil : xlsx_created_at;"
+        builder << "xlsx_use_shared_strings = defined?(xlsx_use_shared_strings).nil? ? nil : xlsx_use_shared_strings;"
+        builder << "xlsx_package = Axlsx::Package.new("
+        builder << ":author => xlsx_author,"
+        builder << ":created_at => xlsx_created_at,"
+        builder << ":use_shared_strings => xlsx_use_shared_strings);"
+        builder << (source || template.source)
+        builder << ";xlsx_package.to_stream.string;"
+        builder.string
+      end
+    end
+  end
+end

data/lib/axlsx_rails/version.rb

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

data/lib/caxlsx_rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'axlsx_rails/railtie' if defined?(Rails)

data/lib/tasks/axlsx_rails_tasks.rake

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

data/spec/axlsx_builder_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'Axlsx template handler' do
+
+  AB = ActionView::Template::Handlers::AxlsxBuilder
+  VT = Struct.new(:source)
+
+  let( :handler ) { AB.new }
+
+  let( :template ) do
+    VT.new("wb = xlsx_package.workbook;\nwb.add_worksheet(name: 'Test') do |sheet|\n\tsheet.add_row ['one', 'two', 'three']\n\tsheet.add_row ['a', 'b', 'c']\nend\n")
+  end
+
+  context "Rails #{Rails.version}" do
+    # for testing if the author is set
+    # before do
+      # Rails.stub_chain(:application, :config, :axlsx_author).and_return( 'Elmer Fudd' )
+    # end
+
+    it "has xlsx format" do
+      if Rails::VERSION::MAJOR >= 6
+        expect(handler.default_format).to eq(mime_type.symbol)
+      else
+        expect(handler.default_format).to eq(mime_type)
+      end
+    end
+
+    it "compiles to an excel spreadsheet when passing in a source" do
+      xlsx_package, wb = nil
+      source = "wb = xlsx_package.workbook;\nwb.add_worksheet(name: 'Test') do |sheet|\n\tsheet.add_row ['four', 'five', 'six']\n\tsheet.add_row ['d', 'e', 'f']\nend\n"
+      eval( AB.new.call template, source )
+      xlsx_package.serialize('/tmp/axlsx_temp.xlsx')
+      expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+      expect(wb.cell(2,3)).to eq('f')
+    end
+
+    it "compiles to an excel spreadsheet when inferring source from template " do
+      xlsx_package, wb = nil
+      eval( AB.new.call template )
+      xlsx_package.serialize('/tmp/axlsx_temp.xlsx')
+      expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+      expect(wb.cell(2,3)).to eq('c')
+    end
+
+    #TODO:
+    # Test if author field is set - does roo parse that?
+  end
+end

data/spec/axlsx_mailer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "Mailer", type: :request do
+  before :each do
+    @user = User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+  end
+
+  it "attaches an xlsx file" do
+    visit "/users/#{@user.id}/send_instructions"
+    last_email = ActionMailer::Base.deliveries.last
+    expect(last_email.to).to eq([@user.email])
+    expect(last_email.attachments.first).to be
+    expect(last_email.attachments.first.content_type).to match(/#{mime_type}/)
+  end
+end

data/spec/axlsx_renderer_spec.rb

@@ -0,0 +1,16 @@
+require'spec_helper'
+
+describe 'Axlsx renderer' do
+
+  it "is registered" do
+    ActionController::Renderers::RENDERERS.include?(:xlsx)
+  end
+
+  it "has mime type" do
+    mime = mime_type
+  	expect(mime).to be
+  	expect(mime.to_sym).to eq(:xlsx)
+  	expect(mime.to_s).to eq("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
+  end
+
+end

data/spec/axlsx_request_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper'
+describe 'Caxlsx request', :type => :request do
+
+  after(:each) do
+    if File.exists? '/tmp/caxlsx_temp.xlsx'
+      File.unlink '/tmp/caxlsx_temp.xlsx'
+    end
+  end
+
+  it "has a working dummy app" do
+    User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+    visit '/'
+    expect(page).to have_content("Hey, you")
+  end
+
+  it "downloads an excel file from default respond_to" do
+    visit '/home.xlsx'
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(2,1)).to eq('Untie!')
+  end
+
+  it "downloads an excel file from respond_to while specifying filename" do
+    visit '/useheader.xlsx'
+
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s)
+    expect(page.response_headers['Content-Disposition']).to include("filename=\"filename_test.xlsx\"")
+
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(2,1)).to eq('Untie!')
+  end
+
+  it "downloads an excel file from respond_to while specifying filename in direct format" do
+    visit '/useheader.xlsx?set_direct=true'
+
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    expect(page.response_headers['Content-Disposition']).to include("filename=\"filename_test.xlsx\"")
+
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(2,1)).to eq('Untie!')
+  end
+
+  it "downloads an excel file from render statement with filename" do
+    visit '/another.xlsx'
+
+    expect(page.response_headers['Content-Type']).to eq(mime_type)
+    expect(page.response_headers['Content-Disposition']).to include("filename=\"filename_test.xlsx\"")
+
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(2,1)).to eq('Untie!')
+  end
+
+  it "downloads an excel file from acts_as_xlsx model" do
+    User.destroy_all
+    User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+    User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    visit '/users.xlsx'
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(3,2)).to eq('Bugs')
+  end
+
+  it "downloads an excel file with partial" do
+    visit '/withpartial.xlsx'
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(1,1,wb.sheets[0])).to eq('Cover')
+    expect(wb.cell(2,1,wb.sheets[1])).to eq("Untie!")
+  end
+
+  it "handles nested resources" do
+    User.destroy_all
+    @user = User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    @user.likes.create(:name => 'Carrots')
+    @user.likes.create(:name => 'Celery')
+    visit "/users/#{@user.id}/likes.xlsx"
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(1,1)).to eq('Bugs')
+    expect(wb.cell(2,1)).to eq('Carrots')
+    expect(wb.cell(3,1)).to eq('Celery')
+  end
+
+  it "handles reference to absolute paths" do
+    User.destroy_all
+    @user = User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    visit "/users/#{@user.id}/render_elsewhere.xlsx"
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s)
+    [[1,false],[3,true],[4,true],[5,false]].reverse.each do |s|
+      visit "/home/render_elsewhere.xlsx?type=#{s[0]}"
+      expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + (s[1] ? "; charset=utf-8" : ''))
+      File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+      wb = nil
+      expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+      if s[0] == 5
+        expect(wb.cell(1,1)).to eq('Bad')
+      else
+        expect(wb.cell(2,2)).to eq('Bugs')
+      end
+    end
+  end
+
+  it "uses respond_with" do
+    User.destroy_all
+    @user = User.create name: 'Responder', last_name: 'Bunny', address: '1234 Right Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    visit "/users/#{@user.id}.xlsx"
+    expect {
+      visit "/users/#{@user.id}.xlsx"
+    }.to_not raise_error
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(2,1)).to eq('Untie!')
+  end
+
+  it "ignores layout" do
+    User.destroy_all
+    @user = User.create name: 'Responder', last_name: 'Bunny', address: '1234 Right Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    expect {
+      visit "/users/export/#{@user.id}.xlsx"
+    }.to_not raise_error
+    File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+    wb = nil
+    expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+    expect(wb.cell(2,1)).to eq('Untie!')
+  end
+
+  unless Rails.version < '3.2'
+    it "handles missing format with render :xlsx" do
+      visit '/another'
+
+      expect(page.response_headers['Content-Type']).to eq(mime_type)
+      expect(page.response_headers['Content-Disposition']).to include("filename=\"filename_test.xlsx\"")
+
+      File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+      wb = nil
+      # wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx')
+      expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to raise_error(Zip::ZipError)
+      # wb.cell(2,1).should == 'Untie!'
+    end
+  end
+
+  unless Rails.version < '4.0'
+    Capybara.register_driver :mime_all do |app|
+      Capybara::RackTest::Driver.new(app, headers: { 'HTTP_ACCEPT' => '*/*' })
+    end
+
+    def puts_def_formats(title)
+      puts "default formats #{title.ljust(30)}: #{ActionView::Base.default_formats}"
+    end
+
+    it "mime all with render :xlsx and then :html" do
+      # puts_def_formats 'before'
+      ActionView::Base.default_formats.delete :xlsx # see notes
+      # puts_def_formats 'in my project'
+      Capybara.current_driver = :mime_all
+      visit '/another'
+      # puts_def_formats 'after render xlsx with */*'
+      expect{
+        visit '/home/only_html'
+      }.to_not raise_error
+      ActionView::Base.default_formats.push :xlsx # see notes
+
+      # Output:
+      # default formats before                        : [:html, :text, :js, :css, :ics, :csv, :vcf, :png, :jpeg, :gif, :bmp, :tiff, :mpeg, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json, :pdf, :zip, :xlsx]
+      # default formats in my project                 : [:html, :text, :js, :css, :ics, :csv, :vcf, :png, :jpeg, :gif, :bmp, :tiff, :mpeg, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json, :pdf, :zip]
+      # default formats after render xlsx with */*    : [:xlsx, :text, :js, :css, :ics, :csv, :vcf, :png, :jpeg, :gif, :bmp, :tiff, :mpeg, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json, :pdf, :zip]
+
+      # Failure/Error: visit '/home/only_html'
+      # ActionView::MissingTemplate:
+      #   Missing template home/only_html, application/only_html with {:locale=>[:en], :formats=>[:xlsx, :text, :js, :css, :ics, :csv, :vcf, :png, :jpeg, :gif, :bmp, :tiff, :mpeg, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json, :pdf, :zip], :variants=>[], :handlers=>[:erb, :builder, :raw, :ruby, :axlsx]}.
+    end
+  end
+
+  if Rails::VERSION::MAJOR < 6
+    it "downloads an excel file when there is no action" do
+      User.destroy_all
+      User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+      User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+      visit '/users/noaction.xlsx'
+      expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+      File.open('/tmp/caxlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+      wb = nil
+      expect{ wb = Roo::Excelx.new('/tmp/caxlsx_temp.xlsx') }.to_not raise_error
+      expect(wb.cell(3,2)).to eq('Bugs')
+    end
+  end
+end