berkeley_library-tind 0.4.0

data/lib/berkeley_library/util/ods/xml/office/body.rb

@@ -0,0 +1,17 @@
+require 'berkeley_library/util/ods/xml/element_node'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Office
+          class Body < XML::ElementNode
+            def initialize(doc:)
+              super(:office, 'body', doc: doc)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/office/document_content.rb

@@ -0,0 +1,98 @@
+require 'berkeley_library/util/ods/xml/namespace'
+require 'berkeley_library/util/ods/xml/element_node'
+require 'berkeley_library/util/ods/xml/table/table'
+require 'berkeley_library/util/ods/xml/office/scripts'
+require 'berkeley_library/util/ods/xml/office/font_face_decls'
+require 'berkeley_library/util/ods/xml/office/automatic_styles'
+require 'berkeley_library/util/ods/xml/office/body'
+require 'berkeley_library/util/ods/xml/office/spreadsheet'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Office
+          class DocumentContent < XML::ElementNode
+
+            # ------------------------------------------------------------
+            # Constants
+
+            OFFICE_VERSION = '1.2'.freeze
+            REQUIRED_NAMESPACES = Namespace.reject { |ns| ns == Namespace::MANIFEST }
+
+            # ------------------------------------------------------------
+            # Initializer
+
+            def initialize(doc:)
+              super(:office, 'document-content', doc: doc)
+
+              set_default_attributes!
+              add_default_children!
+            end
+
+            # ------------------------------------------------------------
+            # Accessors and utility methods
+
+            def scripts
+              @scripts ||= Scripts.new(doc: doc)
+            end
+
+            def font_face_decls
+              @font_face_decls ||= Office::FontFaceDecls.new(doc: doc)
+            end
+
+            def automatic_styles
+              @automatic_styles ||= Office::AutomaticStyles.new(doc: doc)
+            end
+
+            def add_table(name, table_style = nil, protected: true)
+              new_table = XML::Table::Table.new(name, table_style, styles: automatic_styles, protected: protected)
+              new_table.tap { |table| spreadsheet.add_child(table) }
+            end
+
+            def spreadsheet
+              @spreadsheet ||= Office::Spreadsheet.new(doc: doc)
+            end
+
+            def body
+              @body ||= Body.new(doc: doc).tap { |body| body.add_child(spreadsheet) }
+            end
+
+            # ------------------------------------------------------------
+            # Protected methods
+
+            # ----------------------------------------
+            # Protected ElementNode overrides
+
+            protected
+
+            def create_element
+              # Make sure any styles, font faces, etc. needed for the body get created
+              # *before* we try to write them to XML
+              children.reverse_each(&:ensure_element!)
+
+              super
+            end
+
+            # ------------------------------------------------------------
+            # Private methods
+
+            private
+
+            def set_default_attributes!
+              REQUIRED_NAMESPACES.each { |ns| set_attribute(:xmlns, ns.prefix, ns.uri) }
+              set_attribute('version', OFFICE_VERSION)
+            end
+
+            def add_default_children!
+              children << scripts
+              children << font_face_decls
+              children << automatic_styles
+              children << body
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/office/document_styles.rb

@@ -0,0 +1,39 @@
+require 'berkeley_library/util/ods/xml/element_node'
+require 'berkeley_library/util/ods/xml/office/font_face_decls'
+require 'berkeley_library/util/ods/xml/office/styles'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Office
+          class DocumentStyles < XML::ElementNode
+            REQUIRED_NAMESPACES = %i[office style fo].freeze
+
+            def initialize(doc:)
+              super(:office, 'document-styles', doc: doc)
+
+              set_default_attributes!
+              add_default_children!
+            end
+
+            private
+
+            def required_namespaces
+              @required_namespaces ||= REQUIRED_NAMESPACES.map { |p| Namespace.for_prefix(p) }
+            end
+
+            def set_default_attributes!
+              required_namespaces.each { |ns| set_attribute(:xmlns, ns.prefix, ns.uri) }
+            end
+
+            def add_default_children!
+              add_child(FontFaceDecls.new(doc: doc))
+              add_child(Styles.new(doc: doc))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/office/font_face_decls.rb

@@ -0,0 +1,30 @@
+require 'berkeley_library/util/ods/xml/element_node'
+require 'berkeley_library/util/ods/xml/style/font_face'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Office
+          class FontFaceDecls < XML::ElementNode
+            def initialize(doc:)
+              super(:office, 'font-face-decls', doc: doc)
+
+              add_font_face(default_face)
+            end
+
+            def add_font_face(font_face)
+              children << font_face
+            end
+
+            private
+
+            def default_face
+              Style::FontFace.default_face(doc: doc)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/office/scripts.rb

@@ -0,0 +1,17 @@
+require 'berkeley_library/util/ods/xml/element_node'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Office
+          class Scripts < XML::ElementNode
+            def initialize(doc:)
+              super(:office, 'scripts', doc: doc)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/office/spreadsheet.rb

@@ -0,0 +1,37 @@
+require 'berkeley_library/util/ods/xml/element_node'
+require 'berkeley_library/util/ods/xml/table/named_expressions'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Office
+          class Spreadsheet < XML::ElementNode
+            def initialize(doc:)
+              super(:office, 'spreadsheet', doc: doc)
+            end
+
+            def named_expressions
+              @named_expressions ||= Table::NamedExpressions.new(doc: doc)
+            end
+
+            def add_child(child)
+              other_children << child
+            end
+
+            def children
+              other_children.dup.tap { |cc| cc << named_expressions }
+            end
+
+            private
+
+            def other_children
+              @other_children ||= []
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/office/styles.rb

@@ -0,0 +1,39 @@
+require 'berkeley_library/util/ods/xml/element_node'
+require 'berkeley_library/util/ods/xml/style/style'
+require 'berkeley_library/util/ods/xml/style/default_style'
+require 'berkeley_library/util/ods/xml/style/paragraph_properties'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Office
+          class Styles < XML::ElementNode
+            def initialize(doc:)
+              super(:office, 'styles', doc: doc)
+
+              add_default_children!
+            end
+
+            private
+
+            def add_default_children!
+              add_child(table_cell_default_style)
+              add_child(Style::Style.new('Default', 'table-cell', doc: doc))
+            end
+
+            def table_cell_default_style
+              style_children = [
+                Style::ParagraphProperties.new(doc: doc),
+                Style::TextProperties.new(font_name: Style::FontFace::DEFAULT_FONT_FACE, doc: doc)
+              ]
+              Style::DefaultStyle.new('table-cell', doc: doc).tap do |ds|
+                style_children.each { |c| ds.add_child(c) }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/style/cell_style.rb

@@ -0,0 +1,58 @@
+require 'berkeley_library/util/ods/xml/style/style'
+require 'berkeley_library/util/ods/xml/style/table_cell_properties'
+require 'berkeley_library/util/ods/xml/style/text_properties'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Style
+          class CellStyle < Style
+
+            attr_reader :color, :font_weight
+
+            # Initializes a new cell style. Note that this should not be called
+            # directly, but only from {XML::Office::AutomaticStyles#add_cell_style}.
+            #
+            # @param name [String] the style name
+            # @param color [String, nil] a hex color (e.g. `#fdb515`)
+            # @param font_weight [String, nil] the font weight, if other than normal
+            # @param wrap [Boolean] whether to allow text wrapping
+            # @param styles [XML::Office::AutomaticStyles] the document styles
+            # rubocop:disable Metrics/ParameterLists, Style/OptionalBooleanParameter
+            def initialize(name, protected = false, color = nil, styles:, font_weight: nil, wrap: false)
+              super(name, :table_cell, doc: styles.doc)
+              @protected = protected
+              @color = color
+              @font_weight = font_weight
+              @wrap = wrap
+
+              set_attribute('parent-style-name', 'Default')
+              add_default_children!
+            end
+            # rubocop:enable Metrics/ParameterLists, Style/OptionalBooleanParameter
+
+            def protected?
+              @protected
+            end
+
+            def wrap?
+              @wrap
+            end
+
+            def custom_text_properties?
+              [color, font_weight].any? { |p| !p.nil? }
+            end
+
+            private
+
+            def add_default_children!
+              children << TableCellProperties.new(protected?, wrap: wrap?, doc: doc)
+              children << TextProperties.new(color: color, font_weight: font_weight, doc: doc) if custom_text_properties?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/style/column_style.rb

@@ -0,0 +1,36 @@
+require 'berkeley_library/util/ods/xml/style/style'
+require 'berkeley_library/util/ods/xml/style/table_column_properties'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Style
+          class ColumnStyle < Style
+            DEFAULT_WIDTH = '1in'.freeze
+
+            attr_reader :width
+
+            # Initializes a new column style. Note that this should not be called
+            # directly, but only from {XML::Office::AutomaticStyles#add_column_style}.
+            #
+            # @param style_name [String] the name of the style
+            # @param width [String] the column width
+            # @param styles [XML::Office::AutomaticStyles] the document styles
+            def initialize(style_name, width = nil, styles:)
+              super(style_name, :table_column, doc: styles.doc)
+              @width = width || DEFAULT_WIDTH
+              add_default_children!
+            end
+
+            private
+
+            def add_default_children!
+              children << TableColumnProperties.new(width, doc: doc)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/style/default_style.rb

@@ -0,0 +1,31 @@
+require 'berkeley_library/util/ods/xml/element_node'
+require 'berkeley_library/util/ods/xml/style/family'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Style
+          class DefaultStyle < XML::ElementNode
+
+            attr_reader :family
+
+            def initialize(family, doc:)
+              super(:style, 'default-style', doc: doc)
+
+              @family = Family.ensure_family(family)
+
+              set_default_attributes!
+            end
+
+            private
+
+            def set_default_attributes!
+              set_attribute('family', family)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/ods/xml/style/family.rb

@@ -0,0 +1,85 @@
+require 'typesafe_enum'
+
+module BerkeleyLibrary
+  module Util
+    module ODS
+      module XML
+        module Style
+          class Family < TypesafeEnum::Base
+            # ------------------------------------------------------------
+            # Enum instances
+
+            # NOTE: declaration order is as they appear in spreadsheets saved from LibreOffice
+
+            new(:TABLE_COLUMN, 'table-column') do
+              def prefix
+                'co'
+              end
+            end
+
+            new(:TABLE_ROW, 'table-row') do
+              def prefix
+                'ro'
+              end
+            end
+
+            new(:TABLE, 'table') do
+              def prefix
+                'ta'
+              end
+            end
+
+            new(:TABLE_CELL, 'table-cell') do
+              def prefix
+                'ce'
+              end
+            end
+
+            # ------------------------------------------------------------
+            # Class methods
+
+            class << self
+              def from_string(str)
+                find_by_key(str.to_s.upcase.to_sym) ||
+                  find_by_value_str(str.to_s.downcase)
+              end
+
+              def ensure_family(f)
+                family = f.is_a?(Family) ? f : Family.from_string(f)
+                return family if family
+
+                raise ArgumentError, "Not a style family: #{f.inspect}"
+              end
+            end
+
+            # ------------------------------------------------------------
+            # Public instance methods
+
+            def split_name(style_name)
+              return [nil, style_name] unless style_name.start_with?(prefix)
+
+              [prefix, style_name[prefix.size..]]
+            end
+
+            def index_part(style_name)
+              prefix, suffix = split_name(style_name)
+              return unless prefix == self.prefix
+              return unless (suffix_i = suffix.to_i).to_s == suffix
+
+              suffix_i
+            end
+
+            # ------------------------------------------------------------
+            # TypesafeEnum overrides
+
+            def to_s
+              # noinspection RubyYardReturnMatch
+              value
+            end
+
+          end
+        end
+      end
+    end
+  end
+end