rodf 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4baedf0ea44080eb12e4184c97e388dda1ad3174
-  data.tar.gz: 41f4048ce761bfc790c4e81f2b7e2f794b07e0fe
+SHA256:
+  metadata.gz: 6d5bdd76cb3b3ddf5b262b30b74190fc932c096ef74ddce506ccece191a1b4c4
+  data.tar.gz: 40949bf8a0bfe4fe39a89a7b34e8a97814e3160e94f762f34abab16dfcfb4322
 SHA512:
-  metadata.gz: f00589a65f0a1a77993c320ed7c7d39927c0bc1a609010f82c0f44119faa29e2de139e2c02fb303d8a1a9b7be0dc70b174fac58bc45a9d596eb4c704e21fb976
-  data.tar.gz: 9c9ea98eb21673b50eebb823c7c8b886bede10e3c86b14463c473f0b9eafca4bb24c0a4a5417d01e4cf242e5f379e252f5723a2314f10cfd7508c000429cdfed
+  metadata.gz: af1a5477be81146254b67ac087bf67c1fc8b28e03f327699e3678a3cacb2017b3c3792d4b422a4585c299cdc2ce0930841db0ecdac67b43cc73028613e5fef9e
+  data.tar.gz: 5358ba34d162d5ef45775813458fcf2a0a0ab10b191d2c42c012f5c0807f7517c1377f09d998cfe69424c2b1b96fe75a054f6fa60e2852038455a9684b755c2a

data/CHANGELOG.md

@@ -1,18 +1,61 @@
-v1.0.0 Rename main module ODF to RODF, Fix cell types
-v0.3.7 Add Rails 5 support to gemspec
-v0.3.6 Resulting ODF files as bitstrings
-v0.3.5 Allows current libraries
-v0.3.4 Procedural cell styling
-v0.3.3 Documents can now write themselves to disk
-v0.3.2 Fixes broken styles.xml
-v0.3.1 Adds support for conditional formatting
-v0.3.0 Allow parameterless blocks
-v0.2.2 Reintroduce compatibility with Ruby 1.8
-v0.2.1 Update to newer libraries and Ruby 1.9
-v0.1.6 Fix date handling
-v0.1.5 Bug fix
-v0.1.4 Allow the setting of an entire cell's content to a hyperlink (by Merul Patel)
-v0.1.3 Dependency fix (by Merul Patel)
-v0.1.2 Cell span
-v0.1.1 Basic spreadsheet styling support
-v0.1.0 First version with very basic support for spreadsheet generation
+# CHANGELOG
+
+## v1.1.0
+  * [#34](https://github.com/westonganger/rodf/pull/34) - Add ability to add many rows or cells at once
+  * [#29](https://github.com/westonganger/rodf/pull/29) - Remove ActiveSupport dependency in favor of `dry-inflector`
+  * [#21](https://github.com/thiagoarrais/rodf/pull/21) - Allow more attributes for the `data_style` method
+  * [#19](https://github.com/westonganger/rodf/issues/19) - Changes to Date/Time handling
+
+## v1.0.0
+- Rename main module ODF to RODF, Fix cell types
+
+## v0.3.7
+- Add Rails 5 support to gemspec
+
+## v0.3.6
+- Resulting ODF files as bitstrings
+
+## v0.3.5
+- Allows current libraries
+
+## v0.3.4
+- Procedural cell styling
+
+## v0.3.3
+- Documents can now write themselves to disk
+
+## v0.3.2
+- Fixes broken styles.xml
+
+## v0.3.1
+- Adds support for conditional formatting
+
+## v0.3.0
+- Allow parameterless blocks
+
+## v0.2.2
+- Reintroduce compatibility with Ruby 1.8
+
+## v0.2.1
+- Update to newer libraries and Ruby 1.9
+
+## v0.1.6
+- Fix date handling
+
+## v0.1.5
+- Bug fix
+
+## v0.1.4
+- Allow the setting of an entire cell's content to a hyperlink (by Merul Patel)
+
+## v0.1.3
+- Dependency fix (by Merul Patel)
+
+## v0.1.2 
+- Cell span
+
+## v0.1.1
+- Basic spreadsheet styling support
+
+## v0.1.0
+- First version with very basic support for spreadsheet generation

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2008 Thiago Arrais
+
+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

@@ -1,5 +1,8 @@
-<a href='https://ko-fi.com/A5071NK' target='_blank'><img height='32' style='border:0px;height:32px;' src='https://az743702.vo.msecnd.net/cdn/kofi1.png?v=a' border='0' alt='Buy Me a Coffee' /></a> 
 # RODF
+<a href="https://badge.fury.io/rb/rodf" target="_blank"><img height="21" style='border:0px;height:21px;' border='0' src="https://badge.fury.io/rb/rodf.svg" alt="Gem Version"></a>
+<a href='https://travis-ci.org/westonganger/rodf' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://api.travis-ci.org/westonganger/rodf.svg?branch=master' border='0' alt='Build Status' /></a>
+<a href='https://rubygems.org/gems/rodf' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://ruby-gem-downloads-badge.herokuapp.com/rodf?label=rubygems&type=total&total_label=downloads&color=brightgreen' border='0' alt='RubyGems Downloads' /></a>
+<a href='https://ko-fi.com/A5071NK' target='_blank'><img height='22' style='border:0px;height:22px;' src='https://az743702.vo.msecnd.net/cdn/kofi1.png?v=a' border='0' alt='Buy Me a Coffee' /></a>
 
 This is a library for writing to ODF output from Ruby. It mainly focuses creating ODS spreadsheets.
 
@@ -7,18 +10,13 @@ As well as writing ODS spreadsheets, this library also can write ODT text docume
 
 This is NOT an ODF reading library.
 
-### v1.0.0 Breaking Changes
-The main module `ODF` has changed to `RODF`
-
-`require 'odf/spreadsheet'` must be changed to `require 'rodf'`
-
-### Install
+## Install
 
 ```
 gem install rodf
 ```
 
-### How do I use it?
+## How do I use it?
 
 rODF works pretty much like Builder, but with ODF-aware constructs. Try this:
 
@@ -34,6 +32,77 @@ RODF::Spreadsheet.file("my-spreadsheet.ods") do
 end
 ```
 
+For access to variables and methods from outer code you can use block parameter:
+
+```ruby
+require 'rodf'
+
+@data = 'Hello, rODF world!'
+
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |spreadsheet|
+  spreadsheet.table 'My first table from Ruby' do |table|
+    table.row do |row|
+      row.cell @data
+    end
+  end
+end
+```
+
+Adding many rows or cells at once is supported as well:
+
+```ruby
+require 'rodf'
+
+RODF::Spreadsheet.file("my-spreadsheet.ods") do
+  table 'My first table from Ruby' do
+    add_rows([
+      [1, 'Alice'],
+      [2, { value: 'Bob', color: '#ff0000'}],
+      [3, 'Carol']
+    ])
+
+    row do
+      add_cells ['ID', 'Name']
+    end
+  end
+end
+```
+
+## Procedural style
+
+The declarative style shown above is just syntatic sugar. A more procedural
+style can also be used. Like so:
+
+```ruby
+require 'rodf'
+
+ss = RODF::Spreadsheet.new
+t = ss.table 'My first table from Ruby'
+r = t.row
+c = r.cell 'Hello, rODF world!'
+
+# two methods to write to file
+ss.write_to 'my-spreadsheet.ods'
+# or
+File.write('my-spreadsheet.ods', ss.bytes) # you can send your data in Rails over HTTP using the bytes method
+end
+```
+
+Both styles can be mixed and matched at will:
+
+```ruby
+require 'rodf'
+
+ss = RODF::Spreadsheet.new
+ss.table 'My first table from Ruby' do
+  row do
+    cell 'Hello, rODF world!'
+  end
+end
+
+ss.write_to 'my-spreadsheet.ods'
+```
+
 Styling and formatting is also possible:
 
 ```ruby
@@ -92,45 +161,20 @@ RODF::Spreadsheet.file("my-spreadsheet.ods") do
 end
 ```
 
-### Procedural style
-
-The declarative style shown above is just syntatic sugar. A more procedural
-style can also be used. Like so:
-
-```ruby
-require 'rodf'
-
-ss = RODF::Spreadsheet.new
-t = ss.table 'My first table from Ruby'
-r = t.row
-c = r.cell 'Hello, rODF world!'
-
-# two methods to write to file
-ss.write_to 'my-spreadsheet.ods'
-# or
-File.write('my-spreadsheet.ods') do |f|
-  f.write ss.bytes # you can send your data in Rails over HTTP using the bytes method
-end
-```
-
-Both styles can be mixed and matched at will:
-
-```ruby
-require 'rodf'
+## Columns Types
 
-ss = RODF::Spreadsheet.new
-ss.table 'My first table from Ruby' do
-  row do
-    cell 'Hello, rODF world!'
-  end
-end
+Available columns types are:
 
-ss.write_to 'my-spreadsheet.ods'
-```
+- :string
+- :float
+- :date
+- :time
+- :currency
+- :percentage
 
-### Style List
+## Style List
 ```ruby
-property :text, 
+property :text,
   'font-weight' => :bold, #options are :bold, :thin
   'font-size' => 12,
   'font-name' => 'Arial',
@@ -141,7 +185,7 @@ property :text,
   align: true,
   color: "#000000"
 
-property :cell, 
+property :cell,
   'background-color' => "#DDDDDD",
   'wrap-option' => 'wrap',
   'vertical_align' => 'automatic',
@@ -150,10 +194,10 @@ property :cell,
   'border-left' => '0.75pt solid #999999',
   'border-right' => '0.75pt solid #999999',
 
-property :column, 
+property :column,
   'column-width' => '4.0cm'
 
-property :row, 
+property :row,
   'row-height' => '18pt',
   'use-optimal-row-height' => 'true'
 
@@ -162,9 +206,9 @@ property :table,
 ```
 
 
-### Credits
-Created by [@thiagoarrais](https://github.com/thiagoarrais)
+## Credits
+Currently Maintained by [@westonganger](https://github.com/westonganger) for simplified ODS spreadsheet creation in the [spreadsheet_architect](https://github.com/westonganger/spreadsheet_architect) gem
 
-Currently maintained by [@westonganger](https://github.com/westonganger) to support simplified ODS spreadsheet making in the [spreadsheet_architect](https://github.com/westonganger/spreadsheet_architect) gem
+Originally Created by [@thiagoarrais](https://github.com/thiagoarrais)
 
-<a href='https://ko-fi.com/A5071NK' target='_blank'><img height='32' style='border:0px;height:32px;' src='https://az743702.vo.msecnd.net/cdn/kofi1.png?v=a' border='0' alt='Buy Me a Coffee' /></a> 
+Created & Maintained by [Weston Ganger](https://westonganger.com) [(@westonganger)](https://github.com/westonganger) to support simplified ODS spreadsheet making in the [spreadsheet_architect](https://github.com/westonganger/spreadsheet_architect) gem

data/Rakefile

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/lib/rodf/version.rb')
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
- 
+
 RSpec::Core::RakeTask.new
 
 task :test => :spec

data/lib/rodf.rb

@@ -1,6 +1,6 @@
 require 'builder'
-require 'rodf/spreadsheet'
+require_relative 'rodf/spreadsheet'
 
 module RODF
-  
+
 end

data/lib/rodf/cell.rb

@@ -1,24 +1,13 @@
 # Copyright (c) 2008 Thiago Arrais
 #
 # This file is part of rODF.
-#
-# rODF is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as
-# published by the Free Software Foundation, either version 3 of
-# the License, or (at your option) any later version.
-
-# rODF is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
 
-# You should have received a copy of the GNU Lesser General Public License
-# along with rODF.  If not, see <http://www.gnu.org/licenses/>.
+require 'date'
 
 require 'builder'
 
-require 'rodf/container'
-require 'rodf/paragraph'
+require_relative 'container'
+require_relative 'paragraph'
 
 module RODF
   class Cell < Container
@@ -27,9 +16,11 @@ module RODF
     alias :p :paragraph
 
     def initialize(value=nil, opts={})
+      super
+
       if value.is_a?(Hash)
         opts = value
-        value = ''
+        value = opts[:value]
       else
         if value.is_a?(String)
           value = value.strip
@@ -44,24 +35,20 @@ module RODF
         @url = opts[:url]
 
         if !@type
-          if value.is_a?(Numeric)
+          if @value.is_a?(Numeric)
             @type = :float
           elsif @value.respond_to?(:strftime)
+            ### for auto type inference force :date type because :time doesnt store any date info
             @type = :date
-            @value = value.to_s
-
-            #if value.is_a?(Date)
-            #  @value = value.strftime("%Y-%m-%d")
-            #else
-            #  @value = value.strftime("%Y%m%dT%H%M%S")
-            #end
           else
             @type = :string
-            @value = value.to_s
+            @value = @value.to_s
           end
         end
       end
 
+      ### TODO: set default DataStyle for the Spreadsheet for Date / Time / DateTime cells formatting
+
       @elem_attrs = make_element_attributes(@type, @value, opts)
       @multiplier = (opts[:span] || 1).to_i
 
@@ -93,25 +80,54 @@ module RODF
 
     def make_element_attributes(type, value, opts)
       attrs = {}
-      attrs['office:value-type'] = type if type == :string || !empty?(value) || !opts[:formula].nil?
-      attrs['office:date-value'] = value if type == :date && !empty?(value)
-      attrs['office:value'] = value if type == :float && !empty?(value)
-      attrs['table:formula'] = opts[:formula] unless opts[:formula].nil?
-      attrs['table:style-name'] = opts[:style] unless opts[:style].nil?
-      attrs['table:number-columns-spanned'] = opts[:span] unless opts[:span].nil?
-      attrs['table:number-matrix-columns-spanned'] =
-        attrs['table:number-matrix-rows-spanned'] = 1 if opts[:matrix_formula]
+
+      if !empty?(value) || !opts[:formula].nil? || type == :string
+        attrs['office:value-type'] = type
+      end
+
+      if type != :string && !empty?(value)
+        case type
+        when :date
+          attrs['office:date-value'] = value
+        when :time
+          attrs['office:time-value'] = value
+        else ### :float, :percentage, :currency
+          attrs['office:value'] = value
+        end
+      end
+
+      unless opts[:formula].nil?
+        attrs['table:formula'] = opts[:formula]
+      end
+
+      unless opts[:style].nil?
+        attrs['table:style-name'] = opts[:style]
+      end
+
+      unless opts[:span].nil?
+        attrs['table:number-columns-spanned'] = opts[:span]
+      end
+
+      if opts[:matrix_formula]
+        attrs['table:number-matrix-columns-spanned'] = 1
+        attrs['table:number-matrix-rows-spanned'] = 1
+      end
+
       return attrs
     end
 
     def make_value_paragraph
       if contains_string?
         cell, value, url = self, @value, @url
-        paragraph do
-          if cell.contains_url?
-            link value, href: url
-          else
-            self << value
+
+        # Split out newlines to be new cells since the text has been escaped at this point
+        value.to_s.split("\n").each do |split_value|
+          paragraph do
+            if cell.contains_url?
+              link split_value, href: url
+            else
+              self << split_value
+            end
           end
         end
       end
@@ -121,5 +137,6 @@ module RODF
       value.respond_to?(:empty?) ? value.empty? : value.nil?
       #respond_to?(:empty?) ? (value.empty? || value =~ /\A[[:space:]]*\z/) : value.nil?
     end
+
   end
 end