axlsx_rails 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change log
+---------
+- **July 17, 2012**: 0.1.0 release
+* Tests completed
+* Acts_as_xlsx tested, example in docs
+
+- **July 12, 2012**: 0.0.1 release
+* Initial posting.
+* It works, but there are no tests! Bad programmer!

data/Gemfile

@@ -0,0 +1,17 @@
+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
+
+# 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.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,196 @@
+PATH
+  remote: .
+  specs:
+    axlsx_rails (0.1.0)
+      axlsx
+      rails (~> 3.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    acts_as_xlsx (1.0.5)
+      activerecord (>= 2.3.9)
+      axlsx (>= 1.0.13)
+      i18n (>= 0.4.1)
+    addressable (2.2.8)
+    arel (3.0.2)
+    axlsx (1.1.7)
+      nokogiri (>= 1.4.1)
+      rake (>= 0.8.7)
+      rubyzip (>= 0.9.5)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.3)
+      ffi (~> 1.0.6)
+    choice (0.1.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    faraday (0.8.1)
+      multipart-post (~> 1.1)
+    ffi (1.0.11)
+    google-spreadsheet-ruby (0.3.0)
+      google_drive (>= 0.3.0)
+    google_drive (0.3.1)
+      nokogiri (>= 1.4.4, != 1.5.2, != 1.5.1)
+      oauth (>= 0.3.6)
+      oauth2 (>= 0.5.0)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.2.0)
+      guard (>= 1.1)
+    hike (1.2.1)
+    httpauth (0.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    jquery-rails (2.0.2)
+      railties (>= 3.2.0, < 5.0)
+      thor (~> 0.14)
+    json (1.7.3)
+    jwt (0.1.4)
+      json (>= 1.2.4)
+    libwebsocket (0.1.3)
+      addressable
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    log4r (1.1.10)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    nokogiri (1.5.5)
+    oauth (0.4.6)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    roo (1.10.1)
+      choice (>= 0.1.4)
+      google-spreadsheet-ruby (>= 0.1.5)
+      nokogiri (>= 1.5.0)
+      rubyzip (>= 0.9.4)
+      spreadsheet (> 0.6.4)
+      todonotes (>= 0.1.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    rspec-rails (2.11.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    ruby-ole (1.2.11.4)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.24.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    spreadsheet (0.7.3)
+      ruby-ole (>= 1.0)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.15.4)
+    tilt (1.3.3)
+    todonotes (0.1.0)
+      log4r
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acts_as_xlsx
+  axlsx_rails!
+  bundler
+  capybara
+  guard-rspec
+  jquery-rails
+  rake
+  roo
+  rspec-rails
+  sqlite3

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')                  { "spec" }
+  watch(%r{spec/support/.+\.rb$})               { "spec" }
+
+  watch(%r{spec/dummy/app/(.+)\.rb$})           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{spec/dummy/app/(.*)(\.erb|\.haml)$}) { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{spec/dummy/app/controllers/.+\.rb$}) { ["spec/axlsx_renderer_spec.rb", "spec/axlsx_builder_spec.rb", "axlsx_request_spec.rb"] }
+  watch('lib/axlsx_rails/action_controller.rb') { ["spec/axlsx_renderer_spec.rb", "spec/axlsx_request_spec.rb"] }
+  watch('lib/axlsx_rails/template_handler.rb')  { "spec/axlsx_builder_spec.rb" }
+  watch(%r{spec/dummy/app/views/.+\.erb})       { "spec/axlsx_request_spec.rb" }
+end

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,68 @@
+Axlsx-Rails — Axlsx templates for Rails views
+===================================================
+
+##Installation
+--------------
+Until published:
+	gem 'axlsx_rails', :git => "https://github.com/straydogstudio/axlsx_rails.git"
+
+##Requirements
+--------------
+* Rails 3.1, but it has only been tested on 3.2.6
+
+##Usage
+-------
+
+Axlsx-Rails provides a renderer and a template handler. It adds the :xlsx format and parses .xlsx.axslx templates.
+
+###Controller
+
+You can either use the typical format:
+
+	respond_to do |format|
+		format.xlsx
+	end
+
+or call render directly:
+
+	render "foobar", filename: "the_latest_foobar", disposition: 'inline'
+
+###Template
+
+Use the .xlsx.axlsx extension (sorry if your lysdexic!) In the template, use xlsx_package variable, which is set with Axlsx::Package.new:
+
+	wb = xlsx_package.workbook
+	style_shout = wb.styles.add_style sz: 16, b: true, alignment: { horizontal: :center }
+	wb.add_worksheet(name: "Foobar") do |sheet|
+	  sheet.add_row ['Bad', 'spellers', 'of', 'the', 'world', '...']
+	  sheet.add_row ['Untie!']
+	  sheet.merge_cells("B1:B6")
+	  sheet["B1"].style = style_shout
+	end
+
+If you use [acts_as_xlsx](https://github.com/randym/acts_as_xlsx), configure the active record normally, but specify the package in the template:
+
+	User.to_xlsx package: xlsx_package, (other options)
+
+To set the author attribute upon Axlsx::Package.new, insert the following in application.rb:
+
+	config.axlsx_author = "Elmer Fudd"
+
+> NOTE: We really ought to allow the author to be set in each call
+
+####Partials
+Partials are currently untested.
+
+##Dependencies
+--------------
+- [Axlsx](https://github.com/randym/axlsx)
+
+##Authors
+---------
+* [Noel Peden](https://github.com/straydogstudio)
+
+##Change log
+------------
+- **July 12, 2012**: 0.0.1 release
+* Initial posting.
+* It works, but there are no tests! Bad programmer!

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    = 'AxlsxRails'
+  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,4 @@
+require 'axlsx'
+require 'axlsx_rails/action_controller'
+require 'axlsx_rails/template_handler'
+

data/lib/axlsx_rails/action_controller.rb

@@ -0,0 +1,16 @@
+require 'action_controller'
+Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+
+ActionController::Renderers.add :xlsx do |filename, options|
+	disposition   = options.delete(:disposition) || 'attachment'
+	download_name = options.delete(:filename) || "#{filename}.xlsx"
+	download_name += ".xlsx" unless download_name =~ /\.xlsx$/
+	send_data render_to_string(filename, options), :filename => download_name, :type => "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :disposition => disposition
+end
+
+# For respond_to default
+class ActionController::Responder
+	def to_xlsx
+		controller.render :xlsx => controller.action_name
+	end
+end

data/lib/axlsx_rails/template_handler.rb

@@ -0,0 +1,24 @@
+require 'action_view'
+module ActionView
+  module Template::Handlers
+    class AxlsxBuilder
+      def default_format
+        Mime::XLSX
+      end
+      
+      def self.call(template)
+        "xlsx_package = Axlsx::Package.new(:author => #{axlsx_author.inspect});\n" + 
+          template.source +
+          ";\nxlsx_package.to_stream.string;"
+      end
+
+      private
+
+      def self.axlsx_author
+        Rails.application.config.respond_to?(:axlsx_author) ? Rails.application.config.axlsx_author : nil
+      end
+    end
+  end
+end
+
+ActionView::Template.register_template_handler :axlsx, ActionView::Template::Handlers::AxlsxBuilder

data/lib/axlsx_rails/version.rb

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

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,34 @@
+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
+      handler.default_format.should == Mime::XLSX
+    end
+
+    it "compiles to an excel spreadsheet" do
+      xlsx_package, wb = nil
+      eval( AB.call template )
+      xlsx_package.serialize('/tmp/axlsx_temp.xlsx')
+      expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+      wb.cell(2,3).should == 'c'
+    end
+
+    #TODO:
+    # Test if author field is set - does roo parse that?
+  end
+end