ekuseru 0.3.1

data/.gitignore

@@ -0,0 +1 @@
+**.swp

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nugroho Herucahyono
+
+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.rdoc

@@ -0,0 +1,99 @@
+= Ekuseru
+
+Ekuseru is a gem to generate Microsoft Excel documents with Rails. This gem 
+provides templating abilities to create excel documents using Spreadsheet gem.
+
+Having a template is very convenient, because we can define how our file looks
+like in the views, and we can access all helper methods defined in rails.
+
+== Installation
+
+=== Spreadsheet gem
+
+* Edit your Gemfile, add:
+
+  gem "ekuseru"
+
+* then run
+
+  bundle install
+
+== Usage
+
+=== Controller
+
+To generate xls document, add <code>format.xls</code> in your controller.
+
+Example:
+
+  class ProductsController < ApplicationController
+    respond_to :html, :xls
+
+    def index
+      @products = Product.all
+      respond_with @products
+    end
+
+    ...
+
+  end
+
+=== Template
+
+Ekuseru will use .eku files as the template. So, with the example above,
+we will need to create 'index.xls.eku' in app/views/products/.
+Basically it's just an ordinary ruby file.
+In the template, we will get a <code>xls</code> variable which is a
+Spreadsheet::Workbook object ready to be modified like whatever we want.
+
+Consult the Spreadsheet documentation to create the template.
+
+http://spreadsheet.rubyforge.org/GUIDE_txt.html
+
+You can set the filename sent to the user with <code>__filename</code> variable.
+
+In the template :
+
+  # set the filename sent to the user with __filename variable
+  # this is optional, if you don't set it, the name will be like products.xls
+
+  __filename = "Products Catalog.xls"
+
+  # we get 'xls' variable which is a Workbook object
+  # then we can create some worksheet to work with, with create_worksheet method
+
+  sheet1 = xls.create_worksheet
+
+  # fill the [0, 0] cell
+
+  sheet1[0, 0] = "Products Catalog"
+
+  # Worksheet#row will return a Row object. We can modify it just like an Array.
+  # this code will return the second row and fill the cells.
+
+  sheet1.row(1).concat ["Name", "Price", "Stock", "Description"]
+
+  # we can access the instance variable we set in the controller, just like
+  # in erb template
+
+  @products.each_with_index do |p, i|
+    sheet1.update_row i+2, p.name, p.price, p.stock, p.description
+  end
+
+  # we can add some formatting using Spreadsheet::Format object
+
+  title_format = Spreadsheet::Format.new(:color => :blue, :weight => :bold, :size => 18)
+  sheet1.row(0).set_format(0, title_format)
+
+  bold = Spreadsheet::Format.new(:weight => :bold)
+  sheet1.row(1).default_format = bold
+
+That's it. Then you can create a link to the xls file if you want, like:
+
+  <%= link_to 'Excel', products_path(:format => :xls) %>
+
+== Credits
+
+* Jacob Rothstein (http://github.com/jbr)
+
+Copyright (c) 2009 Nugroho Herucahyono, released under the MIT license

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ekuseru plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the ekuseru plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ekuseru'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ekuseru"
+    gemspec.summary = "Export excel documents from Rails"
+    gemspec.description = "Ekuseru is a gem to generate Microsoft Excel documents with Rails." +
+      " This plugin provides templating abilities to create excel documents using Spreadsheet gem."
+    gemspec.email = "xinuc@xinuc.org"
+    gemspec.homepage = "http://github.com/xinuc/ekuseru"
+    gemspec.authors = ["Nugroho Herucahyono", "Jacob Rothstein"]
+    gemspec.add_dependency('spreadsheet', ">=0.6")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/ekuseru.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ekuseru}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nugroho Herucahyono", "Jacob Rothstein"]
+  s.date = %q{2010-03-22}
+  s.description = %q{Ekuseru is a gem to generate Microsoft Excel documents with Rails. This plugin provides templating abilities to create excel documents using Spreadsheet gem.}
+  s.email = %q{xinuc@xinuc.org}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ekuseru.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/ekuseru.rb",
+     "lib/template_handler/eku.rb",
+     "lib/template_handler/options.rb",
+     "test/ekuseru_controller_test.rb",
+     "test/fixtures/ekuseru/index.xls.eku",
+     "test/test.log",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/xinuc/ekuseru}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Export excel documents from Rails}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/ekuseru_controller_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<spreadsheet>, [">= 0.6"])
+    else
+      s.add_dependency(%q<spreadsheet>, [">= 0.6"])
+    end
+  else
+    s.add_dependency(%q<spreadsheet>, [">= 0.6"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,4 @@
+require 'ekuseru'
+
+Mime::Type.register "application/vnd.ms-excel", :xls
+ActionView::Template.register_template_handler 'eku', Ekuseru::TemplateHandler::Eku

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'README.rdoc'))

data/lib/ekuseru.rb

@@ -0,0 +1,10 @@
+require 'spreadsheet'
+require 'template_handler/eku'
+require 'template_handler/options'
+
+class ActionView::Base
+  private
+  def _ekuseru_setup
+    @_ekuseru_options = Ekuseru::TemplateHandler::Options.new controller
+  end
+end

data/lib/template_handler/eku.rb

@@ -0,0 +1,20 @@
+module Ekuseru
+  module TemplateHandler
+    class Eku < ActionView::TemplateHandler
+      include ActionView::TemplateHandlers::Compilable
+      
+      def compile template
+        %{
+          _ekuseru_setup
+          xls = Spreadsheet::Workbook.new
+          #{template.source}
+          @_ekuseru_options.set_disposition(__filename ||= nil)
+          io = StringIO.new
+          xls.write(io)
+          io.rewind
+          io.read
+        }
+      end
+    end
+  end
+end

data/lib/template_handler/options.rb

@@ -0,0 +1,16 @@
+module Ekuseru
+  module TemplateHandler
+    class Options
+
+      def initialize controller
+        @controller = controller
+        @controller.response.content_type ||= Mime::XLS
+      end
+
+      def set_disposition(filename = nil)
+        @controller.headers["Content-Disposition"] = ["attachment", filename ? "filename=\"#{filename}\"" : nil].compact.join(';')
+      end
+      
+    end
+  end
+end

data/test/ekuseru_controller_test.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class EkuseruController < ActionController::Base
+  append_view_path File.join(File.dirname(__FILE__), 'fixtures')
+  respond_to :xls
+
+  def index
+    @something = 42
+    respond_with @something
+  end
+end
+
+class EkuseruControllerTest < ActionController::TestCase
+  def setup
+    get :index, :format => "xls"
+  end
+
+  test "response is success" do
+    assert_response :success
+  end
+
+  test "content type is xls" do
+    assert_equal Mime::XLS, @response.content_type
+  end
+
+  test "content disposition should be set" do
+    assert_equal 'attachment;filename="Products Catalog.xls"', @response.headers['Content-Disposition']
+  end
+
+  test "the response is an xls document" do
+    assert_nothing_raised do
+      Spreadsheet.open StringIO.new(@response.body)
+    end
+  end
+
+  test "the response has the correct data" do
+    spreadsheet = Spreadsheet.open StringIO.new(@response.body)
+    assert_equal 42, spreadsheet.worksheet(0)[0,0]
+  end
+end

data/test/fixtures/ekuseru/index.xls.eku

@@ -0,0 +1,4 @@
+__filename = "Products Catalog.xls"
+
+sheet = xls.create_worksheet
+sheet[0, 0] = @something

data/test/test.log

@@ -0,0 +1,40 @@
+# Logfile created on Sat Sep 05 23:38:48 -0700 2009 by /
+
+
+Processing ExcelController#index to xls (for 0.0.0.0 at 2009-09-05 23:45:31) [GET]
+Completed in 130ms (View: 2 | 406 Not Acceptable [http://test.host/excel?format=xls]
+
+
+Processing ExcelController#index (for 0.0.0.0 at 2009-09-05 23:51:56) [GET]
+Rendering excel/index
+Completed in 147ms (View: 16 | 200 OK [http://test.host/excel]
+
+
+Processing ExcelController#index (for 0.0.0.0 at 2009-09-05 23:52:04) [GET]
+Rendering excel/index
+Completed in 147ms (View: 17 | 200 OK [http://test.host/excel]
+
+
+Processing ExcelController#index (for 0.0.0.0 at 2009-09-06 00:03:51) [GET]
+Rendering excel/index
+Completed in 19ms (View: 18 | 200 OK [http://test.host/excel]
+
+
+Processing ExcelController#index (for 0.0.0.0 at 2009-09-06 00:03:51) [GET]
+Rendering excel/index
+Completed in 53ms (View: 53 | 200 OK [http://test.host/excel]
+
+
+Processing ExcelController#index (for 0.0.0.0 at 2009-09-06 00:03:51) [GET]
+Rendering excel/index
+Completed in 14ms (View: 13 | 200 OK [http://test.host/excel]
+
+
+Processing ExcelController#index (for 0.0.0.0 at 2009-09-06 00:03:51) [GET]
+Rendering excel/index
+Completed in 13ms (View: 13 | 200 OK [http://test.host/excel]
+
+
+Processing ExcelController#index (for 0.0.0.0 at 2009-09-06 00:03:51) [GET]
+Rendering excel/index
+Completed in 18ms (View: 18 | 200 OK [http://test.host/excel]

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+
+require 'test/unit'
+require 'action_controller'
+require 'action_controller/test_case'
+
+require File.join(File.dirname(__FILE__), '..', 'init.rb')
+
+ActionController::Routing::Routes.draw do |map|
+  match "/index" => "ekuseru#index"
+end
+
+class ActiveSupport::TestCase
+end
+
+module ActionController
+  class TestRequest < ActionDispatch::TestRequest
+    def flash
+      {}
+    end
+  end
+end
+
+class Hash
+  def sweep
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: ekuseru
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
+platform: ruby
+authors: 
+- Nugroho Herucahyono
+- Jacob Rothstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 +07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spreadsheet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :runtime
+  version_requirements: *id001
+description: Ekuseru is a gem to generate Microsoft Excel documents with Rails. This plugin provides templating abilities to create excel documents using Spreadsheet gem.
+email: xinuc@xinuc.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ekuseru.gemspec
+- init.rb
+- install.rb
+- lib/ekuseru.rb
+- lib/template_handler/eku.rb
+- lib/template_handler/options.rb
+- test/ekuseru_controller_test.rb
+- test/fixtures/ekuseru/index.xls.eku
+- test/test.log
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/xinuc/ekuseru
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Export excel documents from Rails
+test_files: 
+- test/test_helper.rb
+- test/ekuseru_controller_test.rb