ruby2xlsx 0.0.1

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.rdoc

@@ -0,0 +1,99 @@
+= Ruby2xlsx
+
+Export your data to Excel. Provide two ways for export data: template or renderer.
+
+== Install
+
+This is very simple (Rails 3 only):
+
+  gem "ruby2xlsx"
+
+== Usage
+
+You can use two types: template and renderer.
+
+=== Renderer
+
+  def index
+    @articles = Article.order('id DESC')
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xlsx { render xlsx: @articles }
+    end
+  end
+
+With options:
+
+  format.xlsx { render xlsx: @articles, 
+    :columns => [:id, :title, :updated_at], 
+    :filename => ["articles_", Time.now.to_s, ".xlsx"].join,
+    :worksheet_name => "My articles" }
+
+=== Template
+
+In controller (app/controllers/articles_controller.rb):
+
+  class ArticlesController < ApplicationController
+    respond_to :xlsx, :only => [:index]
+    
+    def index
+      @articles = Article.order('id DESC')
+      respond_with(@articles)
+    end
+  end
+
+In view (app/views/articles/index.xlsx.xrb):
+  
+  add_worksheet "Data"
+
+  bold = add_format(:bold => 1)
+  headings = [ 'Title', 'Views', 'Comments' ]
+  
+  write('A1', headings, bold)
+
+  @articles.each_with_index do |article, index|
+    row = index + 1
+    write(row, 0, article.title)
+    write(row, 1, article.views_count)
+    write(row, 2, article.comments_count)
+  end
+  
+  chart4 = add_chart(:name => 'Results Chart', :type => 'Chart::Area')
+
+  # Configure the series.
+  chart4.add_series(
+      :categories => '=Sheet1!$A$2:$A$7',
+      :values => '=Sheet1!$B$2:$B$7',
+      :name => 'Test data series 1'
+  )
+
+  # Add another series.
+  chart4.add_series(
+      :categories => '=Sheet1!$A$2:$A$7',
+      :values => '=Sheet1!$C$2:$C$7',
+      :name => 'Test data series 2'
+  )
+
+  # Add some labels.
+  chart4.set_title( :name => 'Results of sample analysis' )
+  chart4.set_x_axis( :name => 'Sample number' )
+  chart4.set_y_axis( :name => 'Sample length' )
+
+== Dependencies
+
+1. https://github.com/cxn03651/writeexcel
+2. https://rubygems.org/gems/activemodel
+
+== Other similar gems
+
+1. https://github.com/arydjmal/to_xls
+2. https://github.com/xinuc/ekuseru
+3. https://github.com/harvesthq/simple_xlsx_writer
+4. https://github.com/stevo/excellent
+5. https://github.com/asanghi/excel_rails
+6. https://github.com/rdavila/active_record_to_excel
+7. https://github.com/liangwenke/to_xls-rails
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/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    = 'Ruby2xlsx'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/ruby2xlsx/base.rb

@@ -0,0 +1,46 @@
+require 'writeexcel'
+require 'stringio'
+
+module Ruby2xlsx
+  class Base
+    # Constructs a new ejs engine based on given xlsx", :root => true, :view_path => "/path/to/views" })
+    #
+    def initialize(source, options = {})
+      @source = source
+      @options = options
+      @compiled = false
+      @io = ::StringIO.new
+    end
+    
+    def workbook
+      @workbook ||= ::WriteExcel.new(@io)
+    end
+    
+    def worksheet
+      @worksheet ||= add_worksheet(worksheet_name)
+    end
+    
+    def add_worksheet(*args)
+      @worksheet = workbook.add_worksheet(*args)
+    end
+    
+    def render(*args)
+      workbook.close
+      @io.string
+    end
+    
+    def worksheet_name
+      "somename"
+    end
+    
+    def method_missing(m, *args, &block)
+      if worksheet.respond_to?(m)
+        worksheet.send(m, *args, &block)
+      elsif workbook.respond_to?(m)
+        workbook.send(m, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/ruby2xlsx/default.rb

@@ -0,0 +1,13 @@
+require 'active_model/naming'
+require 'active_model/translation'
+
+module Ruby2xlsx
+  class Default
+    extend ActiveModel::Naming
+    extend ActiveModel::Translation
+    
+    def self.column_names
+      [:id]
+    end
+  end
+end

data/lib/ruby2xlsx/document.rb

@@ -0,0 +1,66 @@
+module Ruby2xlsx
+  class Document < Base
+    def render
+      date_format = workbook.add_format(:num_format => 'dd.mm.yyyy')
+      time_format = workbook.add_format(:num_format => 'dd.mm.yyyy HH:MM')
+      
+      each_with_index do |record, index|
+        row = index + 1
+        
+        columns_names.each_with_index do |column, num|
+          value = record.send(column)
+          
+          if value.is_a?(Date)
+            worksheet.write_string(row, num, value.strftime("%Y-%m-%dT"), date_format)
+          elsif value.is_a?(DateTime) || value.is_a?(Time)
+            worksheet.write_date_time(row, num, value.strftime("%Y-%m-%dT%H:%M:%S.%L"), time_format)
+          else
+            worksheet.write(row, num, value)
+          end
+        end
+      end
+      
+      bold = workbook.add_format(:bold => 1)
+      worksheet.write('A1', human_columns_names, bold)
+      
+      super
+    end
+    
+    def columns_names
+      @columns_names ||= (@options[:columns] || @klass.column_names)
+    end
+    
+    def human_columns_names
+      @human_columns_names ||= columns_names.map { |column| @klass.human_attribute_name(column.to_s) }
+    end
+    
+    def worksheet_name
+      @worksheet_name ||= (@options[:worksheet_name] || @klass.model_name.human)
+    end
+    
+    def filename
+      @filename ||= [(@options[:filename] || @klass.model_name.plural || "document"), ".xlsx"].join
+    end
+    
+    def each_with_index
+      count = 0
+      if @source.is_a?(::ActiveRecord::Relation)
+        @klass ||= @source.klass
+        
+        @source.find_each do |item|
+          yield item, count
+          count += 1
+        end
+      else
+        items = Array.wrap(@source)
+        @klass ||= items.first.class unless items.empty?
+        @klass ||= Default
+        
+        items.each do |item|
+          yield item, count
+          count += 1
+        end
+      end
+    end
+  end
+end

data/lib/ruby2xlsx/engine.rb

@@ -0,0 +1,17 @@
+require 'rails'
+require 'ruby2xlsx'
+
+module Ruby2xlsx
+  class Engine < ::Rails::Engine
+    initializer "ruby2xlsx.setup" do
+      ::Mime::Type.register "application/vnd.ms-excel", :xlsx
+
+      ::ActionView::Template.register_template_handler :xrb, Ruby2xlsx::Xrb.new
+
+      ::ActionController::Renderers.add :xlsx do |collection, options|
+        doc = Ruby2xlsx::Document.new(collection, options)
+        send_data(doc.render, :filename => doc.filename, :type => "application/vnd.ms-excel", :disposition => "attachment")
+      end
+    end
+  end
+end

data/lib/ruby2xlsx/template.rb

@@ -0,0 +1,25 @@
+module Ruby2xlsx
+  class Template < Base
+    
+    # Renders the representation based on source, object, scope and locals
+    # Template.new("...source...", { :format => "xlsx" }).render(scope, { :foo => "bar", :object => @user })
+    #
+    def render(scope, locals, &block)
+      @locals, @scope = locals, scope
+      set_locals_variables
+      
+      instance_eval(@source) if @source.present?
+      instance_eval(&block) if block_given?
+      
+      super
+    end
+    
+    protected
+    
+      def set_locals_variables
+        @locals.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+  end
+end

data/lib/ruby2xlsx/version.rb

@@ -0,0 +1,3 @@
+module Ruby2xlsx
+  VERSION = "0.0.1".freeze
+end

data/lib/ruby2xlsx/xrb.rb

@@ -0,0 +1,14 @@
+module Ruby2xlsx
+  class Xrb
+    # Default format used by Excel builder.
+    class_attribute :default_format
+    self.default_format = ::Mime::XLSX
+
+    def call(template)
+      %{ controller.send_data ::Ruby2xlsx::Template.new(#{template.source.inspect}).render(self, assigns.merge(local_assigns)),
+          :filename => [controller.action_name, ".xlsx"].join, 
+          :type => "application/vnd.ms-excel", 
+          :disposition => "attachment" }
+    end
+  end
+end

data/lib/ruby2xlsx.rb

@@ -0,0 +1,9 @@
+module Ruby2xlsx
+  autoload :Xrb, "ruby2xlsx/xrb"
+  autoload :Base, "ruby2xlsx/base"
+  autoload :Template, "ruby2xlsx/template"
+  autoload :Document, "ruby2xlsx/document"
+  autoload :Default, "ruby2xlsx/default"
+end
+
+require "ruby2xlsx/engine"

data/lib/tasks/ruby2xlsx_tasks.rake

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

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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__)
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/javascripts/articles.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/assets/stylesheets/articles.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

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

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  respond_to :html
+end

data/test/dummy/app/controllers/articles_controller.rb

@@ -0,0 +1,100 @@
+class ArticlesController < ApplicationController
+  respond_to :xlsx, :only => [:index, :another, :empty]
+  
+  # GET /articles
+  # GET /articles.json
+  def index
+    @articles = Article.order('id DESC')
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @articles }
+      format.xlsx { render xlsx: @articles }
+    end
+  end
+  
+  def another
+    @articles = Article.order('id DESC')
+    respond_with(@articles)
+  end
+
+  def empty
+    @articles = []
+    
+    respond_to do |format|
+      format.json { render json: @articles }
+      format.xlsx { render xlsx: @articles }
+    end
+  end
+
+  # GET /articles/1
+  # GET /articles/1.json
+  def show
+    @article = Article.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @article }
+    end
+  end
+
+  # GET /articles/new
+  # GET /articles/new.json
+  def new
+    @article = Article.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @article }
+    end
+  end
+
+  # GET /articles/1/edit
+  def edit
+    @article = Article.find(params[:id])
+  end
+
+  # POST /articles
+  # POST /articles.json
+  def create
+    @article = Article.new(params[:article])
+
+    respond_to do |format|
+      if @article.save
+        format.html { redirect_to @article, notice: 'Article was successfully created.' }
+        format.json { render json: @article, status: :created, location: @article }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @article.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /articles/1
+  # PUT /articles/1.json
+  def update
+    @article = Article.find(params[:id])
+
+    respond_to do |format|
+      if @article.update_attributes(params[:article])
+        format.html { redirect_to @article, notice: 'Article was successfully updated.' }
+        format.json { head :ok }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @article.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /articles/1
+  # DELETE /articles/1.json
+  def destroy
+    @article = Article.find(params[:id])
+    @article.destroy
+
+    respond_to do |format|
+      format.html { redirect_to articles_url }
+      format.json { head :ok }
+    end
+  end
+end

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

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

data/test/dummy/app/helpers/articles_helper.rb

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

data/test/dummy/app/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  validates_presence_of :title
+end

data/test/dummy/app/views/articles/_form.html.erb

@@ -0,0 +1,20 @@
+<%= form_for(@article) do |f| %>
+  <% if @article.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@article.errors.count, "error") %> prohibited this article from being saved:</h2>
+
+      <ul>
+      <% @article.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <%= f.label :title %><br/>
+  <%= f.text_field :title %>
+
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/test/dummy/app/views/articles/another.xlsx.xrb

@@ -0,0 +1,55 @@
+add_worksheet "Sheet1"
+
+bold = add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = [ 'Category', 'Values 1', 'Values 2' ]
+data = [
+    [ 2, 3, 4, 5, 6, 7 ],
+    [ 1, 4, 5, 2, 1, 5 ],
+    [ 3, 6, 7, 5, 4, 3 ]
+]
+
+write('A1', headings, bold)
+write('A2', data)
+
+@articles.each_with_index do |article, index|
+  row = index + 10
+  write(row, 0, article.id)
+  write(row, 1, article.title)
+  write(row, 2, article.created_at)
+end
+
+chart1 = add_chart(:type => 'Chart::Area')
+# Add values only. Use the default categories.
+chart1.add_series( :values => '=Sheet1!$B$2:$B$7' )
+
+chart2 = add_chart(:type => 'Chart::Area')
+
+# Configure the series.
+chart2.add_series(
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values => '=Sheet1!$B$2:$B$7',
+    :name => 'Test data series 1'
+)
+
+chart4 = add_chart(:name => 'Results Chart', :type => 'Chart::Area')
+
+# Configure the series.
+chart4.add_series(
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values => '=Sheet1!$B$2:$B$7',
+    :name => 'Test data series 1'
+)
+
+# Add another series.
+chart4.add_series(
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values => '=Sheet1!$C$2:$C$7',
+    :name => 'Test data series 2'
+)
+
+# Add some labels.
+chart4.set_title( :name => 'Results of sample analysis' )
+chart4.set_x_axis( :name => 'Sample number' )
+chart4.set_y_axis( :name => 'Sample length (cm)' )

data/test/dummy/app/views/articles/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing article</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @article %> |
+<%= link_to 'Back', articles_path %>