rodf 0.3.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6df39b5334145e202ec1e0994066867281ff199
-  data.tar.gz: b3aa43af22b6ff114d617ac829ca8b6f666e2d1d
+SHA256:
+  metadata.gz: 97ad9b10231e7a1a3b553c83880873a7543cfad68b622c8a5884c177f997d208
+  data.tar.gz: 968d57b5f72cfe03350cd7a2f929224b34e857c41758d7b30cd7a4ae47367661
 SHA512:
-  metadata.gz: c2e0fea2bb28a9b6255f2944b250a1e2e013edffdcdba0fd9626146ec9f4ad53b8b7e000657cb2eea967f4ee0bf77875535236215cf12c00671e5bba03191504
-  data.tar.gz: d089d0a704c5339380b17827140a152ceff5c63dcdc9d00a4043e808f8b3c017cafd9fdba65f89325b43aaee2c13c95ae6d4d73c3249678b048622ca1ec3782c
+  metadata.gz: d44ab7bb0070d832969272e6b0f9350792a346e192a703d4c23708aecbdbf4347ad01eb0fc2a546407712394795d40f983c6162c078c084215cf1707a617f887
+  data.tar.gz: 13bdfa011468af90e8c475a1f02aa30a7f8c29b6e0a1c12f4849d15da0eb2d42a65eb9b853f9891ac4501901c25f7df8b9c2be6867bcba5c50d7abd40c688b6a

data/CHANGELOG.md

@@ -0,0 +1,77 @@
+# CHANGELOG
+
+## Unreleased - [View Diff](https://github.com/westonganger/rodf/compare/v1.2.0..master)
+- Nothing yet
+
+## v1.2.0 - [View Diff](https://github.com/westonganger/rodf/compare/v1.1.1..v1.2.0)
+- Allow passing `:style` argument to `Span`
+- Added `Table#set_column_widths` method
+- Style `:family` option now supports String and Symbol keys. Previously `:family` the family option would only support the key name as a Symbol.
+- Improve Style List Documentation
+- Allow adding XML attributes directly to `Table`, `Row`, `Column`, `Cell` using the `:attributes` argument
+- Remove usage of `contains` metaprogramming method `Container#contains` that was hiding major implementation details from most RODF classes. The code is now much easier to understand.
+
+## v1.1.1 - [View Diff](https://github.com/westonganger/rodf/compare/v1.1.0..v1.1.1)
+- [Issue #36](https://github.com/westonganger/rodf/issues/36) - Improve compatibility for Float Cells
+- Fix gemspec require for Ruby 1.9
+- Cleanup File Commenting
+
+## v1.1.0 - [View Diff](https://github.com/westonganger/rodf/compare/v1.0.0..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 - [View Diff](https://github.com/westonganger/rodf/compare/v0.3.7..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,100 +1,280 @@
-# rODF
+# 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://github.com/westonganger/rodf/actions' target='_blank'><img src="https://github.com/westonganger/rodf/workflows/Tests/badge.svg" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI 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 currently only
-supports creating spreadsheets (ODS) and text documents (ODT). Slide shows (ODP)
-may be added some time in the future.
+RODF is a library for writing to ODF output from Ruby. It mainly focuses creating ODS spreadsheets.
 
-Some knowledge of the [ODF spec](http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os-part1.html) is required.
+As well as writing ODS spreadsheets, this library also can write ODT text documents but it is undocumented and will require knowledge of the ODF spec. It currently does not support ODP Slide shows. Also this is NOT an ODF reading library.
 
-This is NOT an ODF reading library.
+## Install
 
-### Installation
+```
+gem install rodf
+```
 
-You should be able to install the latest stable version by saying something like
+## Usage
 
-    gem install rodf
+RODF works pretty much like Builder, but with ODF-aware constructs. For example:
 
-### How do I use it?
+```ruby
+RODF::Spreadsheet.file("my-spreadsheet.ods") do
+  table 'My first table from Ruby' do
+    row do
+      cell 'Hello world!'
+    end
+  end
+end
+```
 
-rODF works pretty much like Builder, but with ODF-aware constructs. Try this:
+For access to variables and methods from outer code you can use block parameter:
 
-    require 'odf/spreadsheet'
+```ruby
+@data = 'Hello world!'
 
-    ODF::Spreadsheet.file("my-spreadsheet.ods") do
-      table 'My first table from Ruby' do
-        row {cell 'Hello, rODF world!' }
-      end
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |sheet|
+  sheet.table 'My first table from Ruby' do |table|
+    table.row do |row|
+      row.cell @data
     end
+  end
+end
+```
 
-Some basic formatting is also possible:
+Adding many rows or cells at once is supported as well:
 
-    require 'odf/spreadsheet'
+```ruby
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |sheet|
+  sheet.table 'My first table from Ruby' do |t|
+    t.add_rows([
+      [1, 'Alice'],
+      [2, { value: 'Bob', color: '#ff0000'}],
+      [3, 'Carol']
+    ])
 
-    ODF::Spreadsheet.file("my-spreadsheet.ods") do
-      style 'red-cell', :family => :cell do
-        property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
-      end
-      table 'Red text table' do
-        row {cell 'Red', :style => 'red-cell' }
-      end
+    t.row do |r|
+      r.add_cells ['ID', 'Name']
     end
+  end
+end
+```
 
-Some basic conditional formatting is also possible:
+## Procedural style
 
-    require 'odf/spreadsheet'
+The declarative style shown above is just syntatic sugar. A more procedural style can also be used. Like so:
 
-    ODF::Spreadsheet.file("my-spreadsheet.ods") do
+```ruby
+ss = RODF::Spreadsheet.new
 
-      office_style 'red-cell', :family => :cell do
-        property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
-      end
+t = ss.table 'My first table from Ruby'
+r = t.row
+c = r.cell 'Hello world!'
 
-      office_style 'green-cell', :family => :cell do
-        property :text, 'font-weight' => 'bold', 'color' => '#00ff00'
-      end
+# 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
+```
 
-      # conditional formating must be defined as style and the value of
-      # apply-style-name must be an office_style
-      style 'cond1', :family => :cell do
+Both styles can be mixed and matched at will:
 
-        property :conditional,
-                  'condition' => 'cell-content()<0',
-                  'apply-style-name' => 'red-cell'
+```ruby
+ss = RODF::Spreadsheet.new
 
-        property :conditional,
-                  'condition' => 'cell-content()>0',
-                  'apply-style-name' => 'green-cell'
-      end
+ss.table 'My first table from Ruby' do |t|
+  t.row do |r|
+    r.cell 'Hello world!'
+  end
+end
+
+ss.write_to 'my-spreadsheet.ods'
+```
+
+## Styling and Formatting
+
+```ruby
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |sheet|
+
+  sheet.style 'red-cell', family: :cell do |s|
+    s.property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
+  end
 
-      table 'Red text table' do
-        row {cell 'Red force', :style => 'red-cell' }
-        row {cell '-4', :type => :float, :style => 'cond1' }
-        row {cell '0', :type => :float, :style => 'cond1' }
-        row {cell '5', :type => :float, :style => 'cond1' }
+  sheet.style 'row-height', family: :row do |s|
+    s.property :row, 'row-height' => '18pt', 'use-optimal-row-height' => 'true'
+  end
+
+  sheet.table 'Red text table' do |t|
+    t.row style: 'row-height' do |r|
+      r.cell 'Red', style: 'red-cell'
+    end
+  end
+
+  sheet.table 'Text with Paragraphs' do |t|
+    t.row style: 'row-height' do |r|
+      r.cell do |cell|
+        cell.paragraph do |paragraph|
+          text_array = my_text_content.split("\n").select{|x| !x.empty? }
+
+          text_array.each do |str|
+            if str.start_with?("#")
+              paragraph.span(str, style: 'red-cell')
+            else
+              paragraph.span(str)
+            end
+          end
+        end
       end
     end
+  end
 
-### Procedural style
+end
+```
 
-The declarative style shown above is just syntatic sugar. A more procedural
-style can also be used. Like so:
+Conditional formatting is also possible:
 
-    require 'odf/spreadsheet'
+```ruby
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |sheet|
 
-    ss = ODF::Spreadsheet.new
-    t = ss.table 'My first table from Ruby'
-    r = t.row
-    c = r.cell 'Hello, rODF world!'
+  sheet.office_style 'red-cell', family: :cell do |s|
+    s.property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
+  end
 
-    ss.write_to 'my-spreadsheet.ods'
+  sheet.office_style 'green-cell', family: :cell do |s|
+    s.property :text, 'font-weight' => 'bold', 'color' => '#00ff00'
+  end
 
-Both styles can be mixed and matched at will:
+  # conditional formating must be defined as style and the value of
+  # apply-style-name must be an office_style
+  sheet.style 'cond1', family: :cell do |s|
+    s.property :conditional, 'condition' => 'cell-content()<0', 'apply-style-name' => 'red-cell'
 
-    require 'odf/spreadsheet'
+    s.property :conditional, 'condition' => 'cell-content()>0', 'apply-style-name' => 'green-cell'
+  end
 
-    ss = ODF::Spreadsheet.new
-    ss.table 'My first table from Ruby' do
-      row { cell 'Hello, rODF world!' }
+  sheet.table 'Red text table' do |t|
+    t.row do |r|
+      r.cell 'Red force', style: 'red-cell'
+    end
+    t.row do |r|
+      r.cell '-4', type: :float, style: 'cond1'
     end
+    t.row do |r|
+      r.cell '0', type: :float, style: 'cond1'
+    end
+    t.row do |r|
+      r.cell '5', type: :float, style: 'cond1'
+    end
+  end
+end
+```
+
+## Changing Columns Widths
+
+Adding columns or columns width to your spreadsheet can be done with the following
+
+```ruby
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |sheet|
+  sheet.table "foo" do |t|
+    sheet.style('default-col-width', family: :column) do |s|
+      s.property(:column, 'column-width' => '1.234in')
+    end
+
+    col_count.times do
+      t.column style: 'default-col-width'
+    end
+
+    ### OR
+
+    ### Warning this will overwrite any existing table columns (cells remain unaffected)
+    sheet.set_column_widths(
+      table: t, 
+      column_widths: [
+        {'column-width' => '1in'},
+        {'column-width' => '2cm'},
+        {'column-width' => '2.54cm'},
+      ],
+    )
+  end
+end
+```
+
+## Columns Types
+
+Available columns types are:
+
+- :string
+- :float
+- :date
+- :time
+- :currency
+- :percentage
+
+## Style List
+```ruby
+### family: :cell or "table-cell"
+style "my-cell-style", family: :cell do
+  property :text,
+    'font-weight' => :bold, #options are :bold, :thin
+    'font-size' => 12,
+    'font-name' => 'Arial',
+    'font-style' => 'italic',
+    'text-underline-style' => 'solid', # solid, dashed, dotted, double
+    'text-underline-type' => 'single',
+    'text-line-through-style' => 'solid',
+    align: true,
+    color: "#000000"
+
+  property :cell,
+    'background-color' => "#DDDDDD",
+    'wrap-option' => 'wrap',
+    'vertical_align' => 'automatic',
+    'border-top' => '0.75pt solid #999999',
+    'border-bottom' => '0.75pt solid #999999',
+    'border-left' => '0.75pt solid #999999',
+    'border-right' => '0.75pt solid #999999',
+    'writing-mode' => 'lr-tb',
+
+end
+
+### family: :column or "table-column"
+style('my-col-style', family: :column) do
+  property :column,
+    'column-width' => '4.0cm'
+end
+
+### family: :row or "table-row"
+style('my-row-style', family: :row) do
+  property :row,
+    'row-height' => '18pt',
+    'use-optimal-row-height' => 'true'
+end
+
+### family: :table
+style('my-row-style', family: :table) do
+  property :table,
+    'writing-mode' => 'lr-tb',
+```
+
+## Adding Arbitrary XML Attributes
+
+```ruby
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |sheet|
+  sheet.table 'My first table from Ruby', attributes: {'table-protected' => 'true'} do |table|
+    table.row do |row|
+      row.cell @data
+    end
+  end
+end
+
+```
+
+## Production Usage Examples
+
+- `spreadsheet_architect` gem - [View Relevant Source Code](https://github.com/westonganger/spreadsheet_architect/blob/master/lib/spreadsheet_architect/class_methods/ods.rb)
+
+## Credits
+
+Originally Created by [@thiagoarrais](https://github.com/thiagoarrais)
 
-    ss.write_to 'my-spreadsheet.ods'
+Maintained by [@westonganger](https://github.com/westonganger) since 2016, for simplified ODS spreadsheet creation within the [spreadsheet_architect](https://github.com/westonganger/spreadsheet_architect) gem

data/Rakefile

@@ -1,23 +1,15 @@
-require 'rubygems'
+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 :default => :spec
+
 task :test => :spec
+task :default => :test
 
-require 'echoe'
-Echoe.new('rodf') do |gem|
-  gem.author = ["Weston Ganger", "Thiago Arrais", "Foivos Zakkak"]
-  gem.email = "thiago.arrais@gmail.com"
-  gem.url = "http://github.com/thiagoarrais/rodf/tree"
-  gem.summary = "ODF generation library for Ruby"
+task :console do
+  require 'rodf'
 
-  gem.runtime_dependencies = [
-    ["builder", "~> 3.0"],
-    ["rubyzip", "~> 1.0"],
-    ["activesupport", ">= 3.0", "< 6.0"]]
-  gem.development_dependencies = [
-    ["rspec", "~> 2.9"],
-    ["rspec_hpricot_matchers" , "~> 1.0"],
-    ["echoe" , "~> 4.6"]]
+  require 'irb'
+  binding.irb
 end

data/lib/rodf/cell.rb

@@ -0,0 +1,171 @@
+module RODF
+  class Cell < Container
+
+    def initialize(value=nil, opts={})
+      super
+
+      if value.is_a?(Hash)
+        opts = value
+        value = opts[:value]
+      else
+        if value.is_a?(String)
+          value = value.strip
+        end
+        opts = {} unless opts.is_a?(Hash)
+      end
+
+      @value = value || ''
+
+      @type = opts[:type]
+
+      unless empty?(@value)
+        @url = opts[:url]
+
+        if !@type
+          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
+          else
+            @type = :string
+            @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)
+
+      if opts[:attributes]
+        @elem_attrs.merge!(opts[:attributes])
+      end
+
+      @multiplier = (opts[:span] || 1).to_i
+
+      make_value_paragraph
+    end
+
+    def paragraphs
+      @paragraphs ||= []
+    end
+
+    def paragraph(*args, &block)
+      x = Paragraph.new(*args, &block)
+
+      paragraphs << x
+
+      return x
+    end
+    alias p paragraph
+
+    def paragraphs_xml
+      paragraphs.map(&:xml).join
+    end
+
+    def add_paragraphs(*elements)
+      if elements.first.is_a?(Array)
+        elements = elements.first
+      end
+
+      elements.each do |element|
+        paragraph(element)
+      end
+    end
+
+    def style=(style_name)
+      @elem_attrs['table:style-name'] = style_name
+    end
+
+    def xml
+      markup = Builder::XmlMarkup.new
+
+      text = markup.tag! 'table:table-cell', @elem_attrs do |xml|
+        xml << paragraphs_xml
+      end
+
+      (@multiplier - 1).times do 
+        text = markup.tag! 'table:table-cell'
+      end
+
+      text
+    end
+
+    def contains_url?
+      !empty?(@url)
+    end
+
+    private
+
+    def make_element_attributes(type, value, opts)
+      attrs = {}
+
+      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 !empty?(@value)
+        case @type
+        when :float
+          ### https://github.com/westonganger/rodf/issues/36
+          value = @value
+          paragraph do
+            self << value
+          end
+        when :string
+          cell, value, url = self, @value, @url
+
+          # 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
+      end
+    end
+
+    def empty?(value)
+      value.respond_to?(:empty?) ? value.empty? : value.nil?
+      #respond_to?(:empty?) ? (value.empty? || value =~ /\A[[:space:]]*\z/) : value.nil?
+    end
+
+  end
+end

data/lib/rodf/column.rb

@@ -0,0 +1,21 @@
+module RODF
+  class Column
+    def initialize(opts={})
+      @elem_attrs = {}
+
+      @elem_attrs['table:style-name'] = opts[:style] unless opts[:style].nil?
+
+      if opts[:attributes]
+        @elem_attrs.merge!(opts[:attributes])
+      end
+    end
+
+    def style=(style_name)
+      @elem_attrs['table:style-name'] = style_name
+    end
+
+    def xml
+      Builder::XmlMarkup.new.tag! 'table:table-column', @elem_attrs
+    end
+  end
+end