rodf 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 448589026c98db61c56b1f4078725adf5cb08282a9257cc0be55ba6f6d90d885
-  data.tar.gz: 2c387630e0250037207433aad4fc886a7e5cbddf624fb1b1943d0aae6585fd7d
+  metadata.gz: 97ad9b10231e7a1a3b553c83880873a7543cfad68b622c8a5884c177f997d208
+  data.tar.gz: 968d57b5f72cfe03350cd7a2f929224b34e857c41758d7b30cd7a4ae47367661
 SHA512:
-  metadata.gz: 974dc5d9c321154811ed47ce27f1c04d065542c08242bbc0f65f9c3c3e685cd80b3165b9ddc0f10eebfc13643cbb38aef48dd92da83dc367990afac78f46d783
-  data.tar.gz: ad463dcab3b3589b4e29fc50b224323a05a23cc662923bf73bcc02b49105daee0de0ee72cbe29c0843a12df6ecef7d25742c295aaee3f8dc8f54544961ad8e08
+  metadata.gz: d44ab7bb0070d832969272e6b0f9350792a346e192a703d4c23708aecbdbf4347ad01eb0fc2a546407712394795d40f983c6162c078c084215cf1707a617f887
+  data.tar.gz: 13bdfa011468af90e8c475a1f02aa30a7f8c29b6e0a1c12f4849d15da0eb2d42a65eb9b853f9891ac4501901c25f7df8b9c2be6867bcba5c50d7abd40c688b6a

data/CHANGELOG.md

@@ -1,20 +1,28 @@
 # CHANGELOG
 
-## Unreleased
+## Unreleased - [View Diff](https://github.com/westonganger/rodf/compare/v1.2.0..master)
 - Nothing yet
 
-## v1.1.1
+## 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
+## 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
+## 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

data/README.md

@@ -1,6 +1,6 @@
 # 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.com/westonganger/rodf' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://travis-ci.com/westonganger/rodf.svg?branch=master' border='0' alt='Build Status' /></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>
 
@@ -14,13 +14,11 @@ As well as writing ODS spreadsheets, this library also can write ODT text docume
 gem install rodf
 ```
 
-## How do I use it?
+## Usage
 
 RODF works pretty much like Builder, but with ODF-aware constructs. For example:
 
 ```ruby
-require 'rodf'
-
 RODF::Spreadsheet.file("my-spreadsheet.ods") do
   table 'My first table from Ruby' do
     row do
@@ -33,12 +31,10 @@ end
 For access to variables and methods from outer code you can use block parameter:
 
 ```ruby
-require 'rodf'
-
 @data = 'Hello world!'
 
-RODF::Spreadsheet.file("my-spreadsheet.ods") do |spreadsheet|
-  spreadsheet.table 'My first table from Ruby' do |table|
+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
@@ -49,18 +45,16 @@ 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([
+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']
     ])
 
-    row do
-      add_cells ['ID', 'Name']
+    t.row do |r|
+      r.add_cells ['ID', 'Name']
     end
   end
 end
@@ -71,9 +65,8 @@ end
 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 world!'
@@ -82,82 +75,130 @@ c = r.cell 'Hello world!'
 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 world!'
+
+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 is also possible:
+## Styling and Formatting
 
 ```ruby
-require 'rodf'
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |sheet|
 
-RODF::Spreadsheet.file("my-spreadsheet.ods") do
-  style 'red-cell', family: :cell do
-    property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
+  sheet.style 'red-cell', family: :cell do |s|
+    s.property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
   end
 
-  table 'Red text table' do
-    row do
-      cell 'Red', style: 'red-cell'
+  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
+
 end
 ```
 
 Conditional formatting is also possible:
 
 ```ruby
-require 'rodf'
-
-RODF::Spreadsheet.file("my-spreadsheet.ods") do
+RODF::Spreadsheet.file("my-spreadsheet.ods") do |sheet|
 
-  office_style 'red-cell', family: :cell do
-    property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
+  sheet.office_style 'red-cell', family: :cell do |s|
+    s.property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
   end
 
-  office_style 'green-cell', family: :cell do
-    property :text, 'font-weight' => 'bold', 'color' => '#00ff00'
+  sheet.office_style 'green-cell', family: :cell do |s|
+    s.property :text, 'font-weight' => 'bold', 'color' => '#00ff00'
   end
 
   # conditional formating must be defined as style and the value of
   # apply-style-name must be an office_style
-  style 'cond1', family: :cell do
-    property :conditional, 'condition' => 'cell-content()<0', 'apply-style-name' => 'red-cell'
+  sheet.style 'cond1', family: :cell do |s|
+    s.property :conditional, 'condition' => 'cell-content()<0', 'apply-style-name' => 'red-cell'
 
-    property :conditional, 'condition' => 'cell-content()>0', 'apply-style-name' => 'green-cell'
+    s.property :conditional, 'condition' => 'cell-content()>0', 'apply-style-name' => 'green-cell'
   end
 
-  table 'Red text table' do
-    row do
-      cell 'Red force', style: 'red-cell'
+  sheet.table 'Red text table' do |t|
+    t.row do |r|
+      r.cell 'Red force', style: 'red-cell'
     end
-    row do
-      cell '-4', type: :float, style: 'cond1'
+    t.row do |r|
+      r.cell '-4', type: :float, style: 'cond1'
     end
-    row do
-      cell '0', type: :float, style: 'cond1'
+    t.row do |r|
+      r.cell '0', type: :float, style: 'cond1'
     end
-    row do
-      cell '5', type: :float, style: 'cond1'
+    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:
@@ -171,37 +212,67 @@ Available columns types are:
 
 ## Style List
 ```ruby
-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',
-
-property :column,
-  'column-width' => '4.0cm'
-
-property :row,
-  'row-height' => '18pt',
-  'use-optimal-row-height' => 'true'
-
-property :table,
-  'writing-mode' => 'lr-tb',
+### 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)

data/Rakefile

@@ -6,3 +6,10 @@ RSpec::Core::RakeTask.new
 
 task :test => :spec
 task :default => :test
+
+task :console do
+  require 'rodf'
+
+  require 'irb'
+  binding.irb
+end

data/lib/rodf/cell.rb

@@ -1,15 +1,5 @@
-require 'date'
-
-require 'builder'
-
-require_relative 'container'
-require_relative 'paragraph'
-
 module RODF
   class Cell < Container
-    contains :paragraphs
-
-    alias :p :paragraph
 
     def initialize(value=nil, opts={})
       super
@@ -25,6 +15,7 @@ module RODF
       end
 
       @value = value || ''
+
       @type = opts[:type]
 
       unless empty?(@value)
@@ -46,21 +37,58 @@ module RODF
       ### 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 {text = markup.tag! 'table:table-cell'}
+
+      (@multiplier - 1).times do 
+        text = markup.tag! 'table:table-cell'
+      end
+
       text
     end
 
@@ -68,7 +96,7 @@ module RODF
       !empty?(@url)
     end
 
-  private
+    private
 
     def make_element_attributes(type, value, opts)
       attrs = {}

data/lib/rodf/column.rb

@@ -1,10 +1,17 @@
-require 'builder'
-
 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

data/lib/rodf/container.rb

@@ -1,60 +1,5 @@
-require 'dry/inflector'
-
 module RODF
   class Container
-    INFLECTOR = Dry::Inflector.new.freeze
-
-    def self.contains(*stuffs_array)
-      stuffs_array.map {|sym| sym.to_s}.each do |stuffs|
-        stuff = INFLECTOR.singularize(stuffs.to_s)
-        stuff_class = RODF.const_get(INFLECTOR.camelize(stuff))
-
-        module_for_stuff.instance_exec do
-          define_method stuffs do
-            instance_variable_name = :"@#{stuffs}"
-
-            if instance_variable_defined?(instance_variable_name)
-              return instance_variable_get(instance_variable_name)
-            end
-
-            instance_variable_set(instance_variable_name, [])
-          end
-
-          define_method stuff do |*args, &contents|
-            c = stuff_class.new(*args, &contents)
-            public_send(stuffs) << c
-            c
-          end
-
-          define_method "add_#{stuffs}" do |*elements|
-            elements = elements.first if elements.first.is_a?(Array)
-            elements.each do |element|
-              public_send(stuff, element)
-            end
-          end
-
-          define_method "#{stuffs}_xml" do
-            public_send(stuffs).map(&:xml).join
-          end
-        end
-      end
-    end
-
-    def self.module_for_stuff
-      if const_defined?(:StuffMethods, false)
-        mod = const_get(:StuffMethods)
-      else
-        mod = const_set(:StuffMethods, Module.new)
-        include mod
-      end
-      mod
-    end
-
-    def self.create(*args, &contents)
-      container = new(*args, &contents)
-      container.xml
-    end
-
     def initialize(*_args, &contents)
       return unless contents
 
@@ -64,5 +9,10 @@ module RODF
         yield(self)
       end
     end
+
+    def self.create(*args, &contents)
+      container = self.new(*args, &contents)
+      container.xml
+    end
   end
 end

data/lib/rodf/data_style.rb

@@ -1,20 +1,38 @@
-require 'builder'
-
-require_relative 'container'
-require_relative 'style_section'
-
 module RODF
   class DataStyle < Container
-    contains :style_sections
-
-    alias section style_section
-
     def initialize(name, type)
       super
 
       @type, @name = type, name
     end
 
+    def style_sections
+      @style_sections ||= []
+    end
+
+    def style_section(*args, &block)
+      x = StyleSection.new(*args, &block)
+
+      style_sections << x
+
+      return x
+    end
+    alias section style_section
+
+    def style_sections_xml
+      style_sections.map(&:xml).join
+    end
+
+    def add_style_sections(*elements)
+      if elements.first.is_a?(Array)
+        elements = elements.first
+      end
+
+      elements.each do |element|
+        style_section(element)
+      end
+    end
+
     def xml
       Builder::XmlMarkup.new.tag! "number:#{@type}-style", 'style:name' => @name do |xml|
         xml << style_sections_xml