rodf 0.3.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6df39b5334145e202ec1e0994066867281ff199
-  data.tar.gz: b3aa43af22b6ff114d617ac829ca8b6f666e2d1d
+  metadata.gz: 4baedf0ea44080eb12e4184c97e388dda1ad3174
+  data.tar.gz: 41f4048ce761bfc790c4e81f2b7e2f794b07e0fe
 SHA512:
-  metadata.gz: c2e0fea2bb28a9b6255f2944b250a1e2e013edffdcdba0fd9626146ec9f4ad53b8b7e000657cb2eea967f4ee0bf77875535236215cf12c00671e5bba03191504
-  data.tar.gz: d089d0a704c5339380b17827140a152ceff5c63dcdc9d00a4043e808f8b3c017cafd9fdba65f89325b43aaee2c13c95ae6d4d73c3249678b048622ca1ec3782c
+  metadata.gz: f00589a65f0a1a77993c320ed7c7d39927c0bc1a609010f82c0f44119faa29e2de139e2c02fb303d8a1a9b7be0dc70b174fac58bc45a9d596eb4c704e21fb976
+  data.tar.gz: 9c9ea98eb21673b50eebb823c7c8b886bede10e3c86b14463c473f0b9eafca4bb24c0a4a5417d01e4cf242e5f379e252f5723a2314f10cfd7508c000429cdfed

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+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/README.md

@@ -1,100 +1,170 @@
-# rODF
+<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
 
-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.
+This 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.
 
 This is NOT an ODF reading library.
 
-### Installation
+### v1.0.0 Breaking Changes
+The main module `ODF` has changed to `RODF`
 
-You should be able to install the latest stable version by saying something like
+`require 'odf/spreadsheet'` must be changed to `require 'rodf'`
 
-    gem install rodf
+### Install
+
+```
+gem install rodf
+```
 
 ### How do I use it?
 
 rODF works pretty much like Builder, but with ODF-aware constructs. Try this:
 
-    require 'odf/spreadsheet'
+```ruby
+require 'rodf'
 
-    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
+  table 'My first table from Ruby' do
+    row do
+      cell 'Hello, rODF world!'
     end
+  end
+end
+```
 
-Some basic formatting is also possible:
+Styling and formatting is also possible:
 
-    require 'odf/spreadsheet'
+```ruby
+require 'rodf'
 
-    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
-    end
+RODF::Spreadsheet.file("my-spreadsheet.ods") do
+  style 'red-cell', family: :cell do
+    property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
+  end
 
-Some basic conditional formatting is also possible:
+  table 'Red text table' do
+    row do
+      cell 'Red', style: 'red-cell'
+    end
+  end
+end
+```
 
-    require 'odf/spreadsheet'
+Conditional formatting is also possible:
 
-    ODF::Spreadsheet.file("my-spreadsheet.ods") do
+```ruby
+require 'rodf'
 
-      office_style 'red-cell', :family => :cell do
-        property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
-      end
+RODF::Spreadsheet.file("my-spreadsheet.ods") do
 
-      office_style 'green-cell', :family => :cell do
-        property :text, 'font-weight' => 'bold', 'color' => '#00ff00'
-      end
+  office_style 'red-cell', family: :cell do
+    property :text, 'font-weight' => 'bold', 'color' => '#ff0000'
+  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
+  office_style 'green-cell', family: :cell do
+    property :text, 'font-weight' => 'bold', 'color' => '#00ff00'
+  end
 
-        property :conditional,
-                  'condition' => 'cell-content()<0',
-                  'apply-style-name' => 'red-cell'
+  # 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'
 
-        property :conditional,
-                  'condition' => 'cell-content()>0',
-                  'apply-style-name' => 'green-cell'
-      end
+    property :conditional, 'condition' => 'cell-content()>0', 'apply-style-name' => 'green-cell'
+  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' }
-      end
+  table 'Red text table' do
+    row do
+      cell 'Red force', style: 'red-cell'
+    end
+    row do
+      cell '-4', type: :float, style: 'cond1'
+    end
+    row do
+      cell '0', type: :float, style: 'cond1'
     end
+    row do
+      cell '5', type: :float, style: 'cond1'
+    end
+  end
+end
+```
 
 ### Procedural style
 
 The declarative style shown above is just syntatic sugar. A more procedural
 style can also be used. Like so:
 
-    require 'odf/spreadsheet'
+```ruby
+require 'rodf'
 
-    ss = ODF::Spreadsheet.new
-    t = ss.table 'My first table from Ruby'
-    r = t.row
-    c = r.cell 'Hello, rODF world!'
+ss = RODF::Spreadsheet.new
+t = ss.table 'My first table from Ruby'
+r = t.row
+c = r.cell 'Hello, rODF world!'
 
-    ss.write_to 'my-spreadsheet.ods'
+# 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:
 
-    require 'odf/spreadsheet'
-
-    ss = ODF::Spreadsheet.new
-    ss.table 'My first table from Ruby' do
-      row { cell 'Hello, rODF world!' }
-    end
-
-    ss.write_to 'my-spreadsheet.ods'
+```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'
+```
+
+### 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',
+```
+
+
+### Credits
+Created by [@thiagoarrais](https://github.com/thiagoarrais)
+
+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
+
+<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> 

data/Rakefile

@@ -1,23 +1,8 @@
-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
-
-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"
 
-  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"]]
-end
+task :test => :spec
+task :default => :test

data/lib/{odf → rodf}/cell.rb

@@ -15,34 +15,55 @@
 # 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 'rubygems'
 require 'builder'
 
-require 'odf/container'
-require 'odf/paragraph'
+require 'rodf/container'
+require 'rodf/paragraph'
 
-module ODF
+module RODF
   class Cell < Container
     contains :paragraphs
 
     alias :p :paragraph
 
-    def initialize(*args)
-      value = args.first || ''
-      opts = args.last.instance_of?(Hash) ? args.last : {}
-
-      @url = opts[:url]
-      @type = opts[:type] || :string
-      unless value.instance_of?(Hash)
-        if value.respond_to? :strftime
-          @value = value.strftime("%Y-%m-%d")
-        else
-          @value = value.to_s.strip
+    def initialize(value=nil, opts={})
+      if value.is_a?(Hash)
+        opts = value
+        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)
+            @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
+          end
         end
       end
 
       @elem_attrs = make_element_attributes(@type, @value, opts)
-      @mutiply = (opts[:span] || 1).to_i
+      @multiplier = (opts[:span] || 1).to_i
 
       make_value_paragraph
     end
@@ -56,31 +77,31 @@ module ODF
       text = markup.tag! 'table:table-cell', @elem_attrs do |xml|
         xml << paragraphs_xml
       end
-      (@mutiply - 1).times {text = markup.tag! 'table:table-cell'}
+      (@multiplier - 1).times {text = markup.tag! 'table:table-cell'}
       text
     end
 
     def contains_url?
-      !@url.nil? && !@url.empty?
+      !empty?(@url)
     end
 
   private
 
     def contains_string?
-      :string == @type && !@value.nil? && !@value.empty?
+      :string == @type && !empty?(@value)
     end
 
     def make_element_attributes(type, value, opts)
       attrs = {}
-      attrs['office:value-type'] = type if :string == type || !empty(value) || !opts[:formula].nil?
-      attrs['office:date-value'] = value if :date == type && !empty(value)
-      attrs['office:value'] = value if :float == type && !empty(value)
+      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]
-      attrs
+      return attrs
     end
 
     def make_value_paragraph
@@ -88,7 +109,7 @@ module ODF
         cell, value, url = self, @value, @url
         paragraph do
           if cell.contains_url?
-            link value, :href => url
+            link value, href: url
           else
             self << value
           end
@@ -96,9 +117,9 @@ module ODF
       end
     end
 
-    def empty(value)
-      value.nil? || value.empty?
+    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/{odf → rodf}/column.rb

@@ -15,10 +15,9 @@
 # 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 'rubygems'
 require 'builder'
 
-module ODF
+module RODF
   class Column
     def initialize(opts={})
       @elem_attrs = {}

data/lib/{odf → rodf}/container.rb

@@ -15,12 +15,9 @@
 # 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 'rubygems'
-gem 'activesupport', '>= 3.0', '< 6.0'
-
 require 'active_support/inflector'
 
-module ODF
+module RODF
   class Container
     def self.contains(*stuffs_array)
       stuffs_array.map {|sym| sym.to_s}.each do |stuffs|

data/lib/{odf → rodf}/data_style.rb

@@ -15,14 +15,12 @@
 # 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 'rubygems'
-
 require 'builder'
 
-require 'odf/container'
-require 'odf/style_section'
+require 'rodf/container'
+require 'rodf/style_section'
 
-module ODF
+module RODF
   class DataStyle < Container
     contains :style_sections
 

data/lib/{odf → rodf}/document.rb

@@ -15,15 +15,13 @@
 # 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 'rubygems'
-
 require 'zip'
 
-require 'odf/container'
-require 'odf/skeleton'
-require 'odf/style'
+require 'rodf/container'
+require 'rodf/skeleton'
+require 'rodf/style'
 
-module ODF
+module RODF
   class Document < Container
     contains :styles, :default_styles, :office_styles
 

data/lib/{odf → rodf}/hyperlink.rb

@@ -15,12 +15,11 @@
 # 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 'rubygems'
 require 'builder'
 
-require 'odf/paragraph_container'
+require 'rodf/paragraph_container'
 
-module ODF
+module RODF
   class Hyperlink < ParagraphContainer
     def initialize(first, second = {})
       if second.instance_of?(Hash) && second.empty?

data/lib/{odf → rodf}/master_page.rb

@@ -15,10 +15,9 @@
 # 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 'rubygems'
 require 'builder'
 
-module ODF
+module RODF
   class MasterPage
     def initialize(name, opts = {})
       @name, @layout = name, opts[:layout]

data/lib/{odf → rodf}/page_layout.rb

@@ -15,13 +15,12 @@
 # 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 'rubygems'
 require 'builder'
 
-require 'odf/container'
-require 'odf/property'
+require 'rodf/container'
+require 'rodf/property'
 
-module ODF
+module RODF
   class PageLayout < Container
     contains :properties
 

data/lib/{odf → rodf}/paragraph.rb

@@ -15,12 +15,11 @@
 # 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 'rubygems'
 require 'builder'
 
-require 'odf/paragraph_container'
+require 'rodf/paragraph_container'
 
-module ODF
+module RODF
   class Paragraph < ParagraphContainer
     def initialize(fst = nil, snd = {})
       first_is_hash = fst.instance_of? Hash

data/lib/{odf → rodf}/paragraph_container.rb

@@ -15,12 +15,11 @@
 # 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 'rubygems'
 require 'builder'
 
-require 'odf/container'
+require 'rodf/container'
 
-module ODF
+module RODF
   # Container for all kinds of paragraph content
   class ParagraphContainer < Container
     def content_parts

data/lib/{odf → rodf}/property.rb

@@ -15,19 +15,18 @@
 # 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 'rubygems'
 require 'builder'
 
-module ODF
+module RODF
   class Property
-    PROPERTY_NAMES = {:cell => 'table-cell-properties',
-                      :text => 'text-properties',
-                      :column => 'table-column-properties',
-                      :row => 'table-row-properties',
-                      :page_layout => 'page-layout-properties',
-                      :header_footer => 'header-footer-properties',
-                      :list_level => 'list-level-properties',
-                      :conditional => 'map'}
+    PROPERTY_NAMES = {cell: 'table-cell-properties',
+                      text: 'text-properties',
+                      column: 'table-column-properties',
+                      row: 'table-row-properties',
+                      page_layout: 'page-layout-properties',
+                      header_footer: 'header-footer-properties',
+                      list_level: 'list-level-properties',
+                      conditional: 'map'}
     TRANSLATED_SPECS = [:border_color, :border_style, :border_width]
 
     ATTRIBUTES_TO_NAMESPACES = [[

data/lib/{odf → rodf}/row.rb

@@ -15,13 +15,12 @@
 # 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 'rubygems'
 require 'builder'
 
-require 'odf/container'
-require 'odf/cell'
+require 'rodf/container'
+require 'rodf/cell'
 
-module ODF
+module RODF
   class Row < Container
     contains :cells
     attr_reader :number

data/lib/{odf → rodf}/skeleton.rb

@@ -17,7 +17,7 @@
 
 require 'erb'
 
-module ODF
+module RODF
   class Skeleton
     def manifest(document_type)
       ERB.new(template('manifest.xml.erb')).result(binding)

data/lib/{odf → rodf}/span.rb

@@ -15,13 +15,12 @@
 # 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 'rubygems'
 require 'builder'
 
-require 'odf/compatibility'
-require 'odf/paragraph_container'
+require 'rodf/compatibility'
+require 'rodf/paragraph_container'
 
-module ODF
+module RODF
   class TextNode
     def initialize(content)
       @content = content
@@ -34,6 +33,8 @@ module ODF
 
   class Span < ParagraphContainer
     def initialize(first, second = nil)
+      @style = nil
+
       if first.instance_of?(Symbol)
         @style = first
         content_parts << TextNode.new(second) unless second.nil?