to_xls 1.0.0 → 1.5.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+# bundler generated
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -1,16 +1,2 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-gem "spreadsheet", ">= 0"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-  gem "factory_girl", ">= 0"
-end
+gemspec

data/{LICENSE.txt → MIT-LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Enrique García Cota
+Copyright (c) 2012 Splendeo Innovación
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -11,8 +11,17 @@ This gem transform an Array or Hash into a excel file using the spreadsheet gem.
   @users.to_xls(:headers => false)     # don't include headers
   @users.to_xls(:columns => [:name, :role]) # include only these columns, on this order
   @users.to_xls(:columns => [:name, {:company => [:name, :address]}]) # able to pick associations/called methods
-  @users.to_xls(:columns => [:name, {:company => [:name, :address]}], :headers => [:name, :company, :address]) # provide better names for the associated columns
+  @users.to_xls(:columns => [:name, {:company => [:name, :address]}], :headers => ['Name', 'Company', 'Address']) # provide better names for the associated columns
 
+== Format
+
+This gem includes a simplified way to change the format of the cells. Also this gem provides a simplified way for changing the format of the headers.
+
+To change the format of the cells and headers the code should be like this:
+
+      User.all.to_xls :cell_format => {:color => :blue}, :header_format => {:weight => :bold, :color => :red}
+
+To have a full list of the format admited for the cells and headers you may have a look {on the source code of spreadsheet gem}[http://scm.ywesee.com/?p=spreadsheet/.git;a=blob;f=lib/spreadsheet/format.rb;h=ceef6bb6618238d1ff5cc0462826e2c127c272f1;hb=HEAD]. This gem runs under to_xls, so the format supported by this gem are the ones of spreadsheet.
 
 == Example of use in Rails
 
@@ -62,14 +71,14 @@ Then execute
 
     bundle install
 
-== ToXml::ArrayWriter
+== ToXml::Writer
 
-You can export to a file or spreadsheet book using the internal ToXml::ArrayWriter class:
+You can export to a file or spreadsheet book using the internal ToXml::Writer class:
 
-    ToXls::ArrayWriter.new(users, :name => 'Users').write_io(file) # writes to a given file
-    ToXls::ArrayWriter.new(users, :name => 'Users').write_book(book) # writes to a spreadsheet book (adds a new sheet)
+    ToXls::Writer.new(users, :name => 'Users').write_io(file) # writes to a given file
+    ToXls::Writer.new(users, :name => 'Users').write_book(book) # writes to a spreadsheet book (adds a new sheet)
 
-The options of ArrayWriter.new(array, options) are the same as in to_xls.
+The options of Writer.new(array, options) are the same as in to_xls.
 
 == Contributing to to_xls
  
@@ -83,6 +92,17 @@ The options of ArrayWriter.new(array, options) are the same as in to_xls.
 
 == Copyright
 
-Copyright (c) 2011 Enrique García Cota. See LICENSE.txt for
+Copyright (c) 2011 Splendeo Innovación. See MIT-LICENSE.txt for
 further details.
 
+== Credits
+
+* Ian Link & mlecho helped implementing the formats
+
+== Changelog
+
+1.5.0
+
+* to_xls now extends Enumerable instead of Array
+* Included :cell_format and :header_format options
+* Used bundler instead of jeweller

data/Rakefile

@@ -1,30 +1,12 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
+
+#Bundler::GemHelper.install_tasks
+
 require 'rake'
+require "rubygems"
+require "bundler"
+require "bundler/gem_tasks"
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "to_xls"
-  gem.homepage = "http://github.com/splendeo/to_xls"
-  gem.license = "MIT"
-  gem.summary = %Q{to_xls for Arrays and Hashes}
-  gem.description = %Q{Adds a to_xls method to arrays, which can be used to generate excel files conveniently. Can rely on ActiveRecord sugar for obtaining attribute names.}
-  gem.email = "egarcia@splendeo.es"
-  gem.authors = ["Enrique Garcia Cota", "Francisco de Juan"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  gem.add_runtime_dependency 'spreadsheet', '> 0'
-  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
+Bundler.setup(:default, :test)
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
@@ -32,19 +14,4 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "to_xls #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/lib/to_xls.rb

@@ -1 +1,2 @@
-require 'to_xls/array_patch.rb'
+require "to_xls/version"
+require "to_xls/enumerable_patch.rb"

data/lib/to_xls/enumerable_patch.rb

@@ -0,0 +1,9 @@
+
+require 'to_xls/writer.rb'
+
+module Enumerable
+  # Options for to_xls: columns, name, header, sheet
+  def to_xls(options = {})
+    ToXls::Writer.new(self, options).write_string
+  end
+end

data/lib/to_xls/version.rb

@@ -0,0 +1,3 @@
+module ToXls
+  VERSION = "1.5.0"
+end

data/lib/to_xls/{array_writer.rb → writer.rb}

@@ -4,10 +4,12 @@ require 'spreadsheet'
 
 module ToXls
 
-  class ArrayWriter
+  class Writer
     def initialize(array, options = {})
       @array = array
       @options = options
+      @cell_format = create_format :cell_format
+      @header_format = create_format :header_format
     end
 
     def write_string(string = '')
@@ -34,12 +36,14 @@ module ToXls
         row_index = 0
 
         if headers_should_be_included?
+          apply_format_to_row(sheet.row(0), @header_format)
           fill_row(sheet.row(0), headers)
           row_index = 1
         end
 
         @array.each do |model|
           row = sheet.row(row_index)
+          apply_format_to_row(row, @cell_format)
           fill_row(row, columns, model)
           row_index += 1
         end
@@ -54,7 +58,7 @@ module ToXls
     end
 
     def can_get_columns_from_first_element?
-      @array.first && 
+      @array.first &&
       @array.first.respond_to?(:attributes) &&
       @array.first.attributes.respond_to?(:keys) &&
       @array.first.attributes.keys.is_a?(Array)
@@ -77,6 +81,14 @@ module ToXls
 
 private
 
+    def apply_format_to_row(row, format)
+      row.default_format = format if format
+    end
+
+    def create_format(name)
+      Spreadsheet::Format.new @options[name] if @options.has_key? name
+    end
+
     def fill_row(row, column, model=nil)
       case column
       when String, Symbol

data/spec/{array_spec.rb → enumerable_spec.rb}

@@ -1,14 +1,15 @@
 # encoding: utf-8
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe Array do
+describe Enumerable do
 
   describe :to_xls do
-    it "should throw no error without data" do
+
+    it "throws no error without data" do
       lambda { [].to_xls }.should_not raise_error
     end
 
-    it "should return the correct string representing a spreadsheet" do
+    it "returns the correct string representing a spreadsheet" do
       s = StringIO.new
       xls = make_book(mock_users)
       xls.write(s)

data/spec/spec_helper.rb

@@ -1,17 +1,8 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
-require 'factory_girl'
 require 'to_xls'
 
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**.rb", ].each {|f| require f}
-
-RSpec.configure do |config|
-  
-end
-
 def mock_model(name, attributes)
   attributes[:attributes] = attributes.clone
   mock(name, attributes)
@@ -45,6 +36,19 @@ end
 
 def make_book(array, options={})
   book = Spreadsheet::Workbook.new
-  ToXls::ArrayWriter.new(array, options).write_book(book)
+  ToXls::Writer.new(array, options).write_book(book)
   book
 end
+
+def check_format(sheet, header_format, cell_format)
+  sheet.rows.each_with_index do |row, i|
+    hash = i == 0 ? header_format : cell_format
+    compare_hash_format(hash, row.default_format)
+  end
+end
+
+def compare_hash_format(hash, format)
+  hash.each do |key, value| 
+    format.font.send(key).should == value
+  end
+end

data/spec/{array_writer_spec.rb → writer_spec.rb}

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe ToXls::ArrayWriter do
+describe ToXls::Writer do
 
   it "throws no error without data" do
     lambda { [].to_xls }.should_not raise_error
@@ -109,7 +109,7 @@ describe ToXls::ArrayWriter do
   describe "#write_book" do
     it "writes a new sheet in a book" do
       book = Spreadsheet::Workbook.new
-      ToXls::ArrayWriter.new(mock_users).write_book(book)
+      ToXls::Writer.new(mock_users).write_book(book)
       check_sheet( book.worksheets.first,
         [ [:age,  :email,           :name],
           [   20, 'peter@gmail.com', 'Peter'],
@@ -124,7 +124,7 @@ describe ToXls::ArrayWriter do
     it "writes a new sheet in a book" do
       book = Spreadsheet::Workbook.new
       sheet = book.create_worksheet
-      ToXls::ArrayWriter.new(mock_users).write_sheet(sheet)
+      ToXls::Writer.new(mock_users).write_sheet(sheet)
       check_sheet( sheet,
         [ [:age,  :email,           :name],
           [   20, 'peter@gmail.com', 'Peter'],
@@ -138,7 +138,7 @@ describe ToXls::ArrayWriter do
   describe "#write_io" do
     it "writes a new book in a stream" do
       io1 = StringIO.new
-      ToXls::ArrayWriter.new(mock_users).write_io(io1)
+      ToXls::Writer.new(mock_users).write_io(io1)
       io2 = StringIO.new
       xls = make_book(mock_users, {})
       xls.write(io2)
@@ -149,7 +149,7 @@ describe ToXls::ArrayWriter do
 
   describe "#write_string" do
     it "writes a new sheet in a string" do
-      str = ToXls::ArrayWriter.new(mock_users).write_string()
+      str = ToXls::Writer.new(mock_users).write_string()
       io = StringIO.new
       xls = make_book(mock_users, {})
       xls.write(io)
@@ -158,7 +158,15 @@ describe ToXls::ArrayWriter do
     end
   end
 
-  
-
-
+  describe "formats" do
+    it "accepts the format options" do
+      cell_format = {:color => :blue} 
+      header_format = {:weight => :bold, :color => :red}
+      xls = make_book( mock_users,
+        :cell_format => cell_format,
+        :header_format => header_format
+      )
+      check_format( xls.worksheets.first, header_format, cell_format)
+    end
+  end
 end

data/to_xls.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "to_xls/version"
+
+Gem::Specification.new do |s|
+  s.name        = "to_xls"
+  s.version     = ToXls::VERSION
+  s.authors     = ["Enrique Garcia Cota", "Francisco de Juan", "Sergio Díaz Álvarez"]
+  s.email       = %q{egarcia@splendeo.es}
+  s.homepage    = "https://github.com/splendeo/to_xls"
+  s.summary     = %q{to_xls for Enumerations}
+  s.description = %q{Adds a to_xls method to all enumerations, which can be used to generate excel files conveniently. Can rely on ActiveRecord sugar for obtaining attribute names.}
+
+  s.rubyforge_project = "to_xls"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<spreadsheet>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9.2"])
+    else
+      s.add_dependency(%q<spreadsheet>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9.2"])
+   end
+  else
+    s.add_dependency(%q<spreadsheet>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_development_dependency(%q<rake>, ["~> 0.9.2"])
+  end
+end

metadata

@@ -1,160 +1,114 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: to_xls
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.5.0
   prerelease: 
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Enrique Garcia Cota
 - Francisco de Juan
+- Sergio Díaz Álvarez
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-26 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: spreadsheet
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &19965000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *19965000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19934800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *19934800
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &19932020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *19932020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &19892300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.5.2
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: factory_girl
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: spreadsheet
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 1.2.3
-  type: :development
-  version_requirements: *id008
-description: Adds a to_xls method to arrays, which can be used to generate excel files conveniently. Can rely on ActiveRecord sugar for obtaining attribute names.
+  version_requirements: *19892300
+description: Adds a to_xls method to all enumerations, which can be used to generate
+  excel files conveniently. Can rely on ActiveRecord sugar for obtaining attribute
+  names.
 email: egarcia@splendeo.es
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .document
+- .gitignore
 - .rspec
 - Gemfile
-- LICENSE.txt
+- MIT-LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION
 - init.rb
 - lib/to_xls.rb
-- lib/to_xls/array_patch.rb
-- lib/to_xls/array_writer.rb
-- spec/array_spec.rb
-- spec/array_writer_spec.rb
+- lib/to_xls/enumerable_patch.rb
+- lib/to_xls/version.rb
+- lib/to_xls/writer.rb
+- spec/enumerable_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/splendeo/to_xls
-licenses: 
-- MIT
+- spec/writer_spec.rb
+- to_xls.gemspec
+homepage: https://github.com/splendeo/to_xls
+licenses: []
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4596769968473579780
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4596769968473579780
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.6.2
+rubyforge_project: to_xls
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: to_xls for Arrays and Hashes
-test_files: 
-- spec/array_spec.rb
-- spec/array_writer_spec.rb
-- spec/spec_helper.rb
+summary: to_xls for Enumerations
+test_files: []

data/VERSION

@@ -1 +0,0 @@
-1.0.0

data/lib/to_xls/array_patch.rb

@@ -1,9 +0,0 @@
-
-require 'to_xls/array_writer.rb'
-
-class Array
-  # Options for to_xls: columns, name, header, sheet
-  def to_xls(options = {})
-    ToXls::ArrayWriter.new(self, options).write_string
-  end
-end