redmine_api_helper 0.3.35

data/lib/odf_writer/image.rb

@@ -0,0 +1,176 @@
+# encoding: utf-8
+#
+# Ruby Gem to create a self populating Open Document Format (.odf) text file.
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+require 'rack/mime' # needed for Rack::Mime
+
+module ODFWriter
+
+  ########################################################################################
+  #
+  # Image: replace images
+  #
+  ########################################################################################
+  class Image < Field
+  
+    ######################################################################################
+    #
+    # constants
+    #
+    ######################################################################################
+    IMAGE_DIR_NAME = "Pictures"
+    
+    ######################################################################################
+    #
+    # replace!
+    #
+    ######################################################################################
+    def replace!(doc, manifest, template, item=nil )
+    
+      image_data = value(item)
+      
+      if image_data = is_image?(image_data) 
+        
+        # find placeholder image
+        nodes = find_image_nodes( doc )
+        return if nodes.blank?
+        
+        # find manifest
+        man = manifest.xpath("//manifest:manifest") rescue nil
+        return if man.blank?
+        
+        # each placeholder image
+        nodes.each do |node|
+        
+          # create unique filename for image in .odt file
+          path = ::File.join(IMAGE_DIR_NAME, "#{SecureRandom.hex(20).upcase}#{::File.extname(image_data[:filename])}")
+          mime = Rack::Mime.mime_type(File.extname(image_data[:filename]))
+          
+          # set path and mime type of placeholder image
+          node.attribute('href').value = path
+          if node.attribute('mime-type').present?
+            node.attribute('mime-type').value = mime
+          else
+            node.set_attribute('mime-type', mime)
+          end
+          
+          # set width and height of placeholder image
+          parent = node.parent
+          if parent.name == "frame"
+            width  = parent.attribute('width').value
+            height = parent.attribute('height').value
+            parent.attribute('height').value = recalc_height(:x => image_data[:width], :y => image_data[:height], :newx => width, :newy => height)
+          end
+          
+          # add image to .odt file
+          add_image_file( image_data[:bytes], path, mime, doc, man, template )
+          
+        end
+      end
+      
+    end #def
+    
+    def self.unique_image_names(doc)
+      nodes   = doc.xpath("//draw:frame[@draw:name='#{@name}']")
+      padding = Math.log10(nodes.length).to_i + 1 if nodes.present?
+      nodes.each_with_index do |node, i|
+        num = "%.#{padding}i" % i
+        node.attribute('name').value = "IMAGE_#{num}_" + node.attribute('name').value
+      end
+    end #def
+    
+    ######################################################################################
+    #
+    # private
+    #
+    ######################################################################################
+    private
+    
+    ######################################################################################
+    # is_image?
+    ######################################################################################
+    def is_image?(obj)
+      case obj
+      when Hash
+        if (obj.keys.map(&:to_sym) & 
+            [:filename, :width, :height, :bytes]).length == 4 
+          obj.symbolize_keys
+        end
+      else
+        if obj.respond_to?(:filename) &&
+           obj.respond_to?(:width) &&
+           obj.respond_to?(:height) &&
+           obj.respond_to?(:bytes)
+          {:filename => obj.filename,
+           :width    => obj.width,
+           :height   => obj.height,
+           :bytes    => obj.bytes }
+        end
+      end
+    end #def
+    
+    ######################################################################################
+    # find_image_nodes
+    ######################################################################################
+    def find_image_nodes(doc)
+      doc.xpath(".//draw:frame[@draw:name='#{@name}']/draw:image")
+    end #def
+    
+    ######################################################################################
+    # recalc_height
+    ######################################################################################
+    def recalc_height(nums)
+    
+      numericals = {}
+      dimensions = {}
+      
+      #remove dimensions like 'px' or 'cm' or 'in' or 'pt'
+      [:x, :y, :newx, :newy].each do |v|
+        num = nums[v].to_s.match(/[0-9.]+/)
+        numericals[v] = num[0].to_f if num
+        dimensions[v] = nums[v].to_s.gsub(/\A[0-9.]+/, "")
+      end
+      
+      if [:x, :y, :newx, :newy].all?{|i| numericals[i].present? }
+        y = numericals[:newx] / numericals[:x] * numericals[:y]
+      end 
+      
+      y ? "#{'%.3f'%y}#{dimensions[:newy]}" : nums[:newy]
+      
+    end #def
+    
+    ######################################################################################
+    # add_image_file
+    ######################################################################################
+    def add_image_file(bytes, path, mime, doc, manifest, template )
+    
+      file_entry = Nokogiri::XML::Node.new('manifest:file-entry', doc)
+      file_entry.set_attribute('manifest:full-path', path)
+      file_entry.set_attribute('manifest:media-type', mime)
+      manifest.children.after file_entry
+          
+      template.output_stream.put_next_entry(path)
+      template.output_stream.write bytes
+      
+    end #def
+    
+    
+  end #class
+end #module

data/lib/odf_writer/image_reader.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+#
+# Ruby Gem to create a self populating Open Document Format (.odf) text file.
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+module ODFWriter
+  
+  ########################################################################################
+  #
+  # ImageReader: find all images and set name
+  #
+  ########################################################################################
+  class ImageReader
+    
+    attr_accessor :name
+    
+    ######################################################################################
+    #
+    # initialize
+    #
+    ######################################################################################
+    def initialize(opts)
+      @name = opts[:name]
+    end #def
+    
+    ######################################################################################
+    #
+    # get_paths: limit to paths with ancestors 'text '(content.xml) and master-styles (styles.xml)
+    #
+    ######################################################################################
+    def paths( root, doc)
+      
+      # find nodes with matching field elements matching [BOOKMARK] pattern
+      nodes = doc.xpath("//draw:frame[draw:image]").select{|node| scan(node).present? }
+      
+      # find path for each field
+      paths = nil
+      nodes.each do |node|
+        leaf  = {:images => scan(node)}
+        paths = PathFinder.trail(node, leaf, :root => root, :paths => paths)
+      end #each
+      paths.to_h
+      
+    end #def
+    
+    ######################################################################################
+    # private
+    ######################################################################################
+    
+    private
+    
+    def scan(node)
+      if name 
+        node.attr("draw:name") == name.upcase ? [node.attr("draw:name")] : []
+      else
+        [node.attr("draw:name")]
+      end
+    end #def
+  end #class
+end #module

data/lib/odf_writer/images.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+#
+# Ruby Gem to create a self populating Open Document Format (.odf) text file.
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+module ODFWriter
+
+  ########################################################################################
+  #
+  # Images: replace images 
+  #
+  ########################################################################################
+  module Images
+  
+    ######################################################################################
+    #
+    # constants
+    #
+    ######################################################################################
+    IMAGE_DIR_NAME = "Pictures"
+    
+    ######################################################################################
+    #
+    # find_image_name_matches
+    #
+    ######################################################################################
+    def find_image_name_matches(content)
+    
+      @images.each_pair do |image_name, img_data|
+        if node = content.xpath("//draw:frame[@draw:name='#{image_name}']/draw:image").first
+          placeholder_path = node.attribute('href').value
+          @image_names_replacements[path] = ::File.join(IMAGE_DIR_NAME, ::File.basename(placeholder_path))
+        end
+      end
+      
+    end #def
+    
+    ######################################################################################
+    #
+    # include_image_files
+    #
+    ######################################################################################
+    def include_image_files(file)
+    
+      return if @images.empty?
+      
+      @image_names_replacements.each_pair do |path, template_image|
+      
+        file.output_stream.put_next_entry(template_image)
+        file.output_stream.write ::File.read(path)
+        
+      end
+      
+    end #def
+    
+    ######################################################################################
+    #
+    # avoid_duplicate_image_names
+    #
+    ######################################################################################
+    # newer versions of LibreOffice can't open files with duplicates image names
+    def avoid_duplicate_image_names(content)
+    
+      nodes = content.xpath("//draw:frame[@draw:name]")
+      
+      nodes.each_with_index do |node, i|
+        node.attribute('name').value = "pic_#{i}"
+      end
+      
+    end #def
+    
+  end #class
+end #module

data/lib/odf_writer/list_style.rb

@@ -0,0 +1,336 @@
+# encoding: utf-8
+#
+# Ruby Gem to create a self populating Open Document Format (.odf) text file.
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+module ODFWriter
+
+  ########################################################################################
+  #
+  # ListStyle: add style for ul, ol up to  6 levels deep
+  #
+  ########################################################################################
+  class ListStyle
+  
+    ######################################################################################
+    #
+    # initialize
+    #
+    ######################################################################################
+    def initialize( *list_styles )
+      @list_styles = *list_styles
+      @font  = {}
+    end #def
+    
+    ######################################################################################
+    #
+    # add_list_style
+    #
+    ######################################################################################
+    def add_list_style( doc )
+    
+      ns                                   = doc.collect_namespaces
+      automatic_styles                     = doc.at("//office:automatic-styles", ns)
+      font_declarations                    = doc.at("//office:font-face-decls", ns)
+      
+      
+      
+      @list_styles.each do |list_style|
+      
+        automatic_styles                   << create_list( doc, list_style ) if automatic_styles.present?
+        
+        if @font.present?
+          font_declarations                << create_font( doc, @font )      if font_declarations.present?
+        end
+      end
+    end #def
+    
+    ######################################################################################
+    #
+    # private
+    #
+    ######################################################################################
+    private
+    
+    def create_font( doc, font )
+      node                               = Nokogiri::XML::Node.new('style:font-face', doc)
+      node["style:name"]                 = font[:font_name]
+      node["svg:font-family"]            = font[:font_family]
+      node["style:font-family-generic"]  = font[:font_family_generic]
+      node["style:font-pitch"]           = font[:font_pitch]
+      node
+    end #def
+    
+    def create_list( doc, list_style )
+        
+      node                               = Nokogiri::XML::Node.new('text:list-style', doc)
+      
+      #
+      # common properties
+      #
+      case list_style
+      
+        when :ul
+          node['style:name']                                    = "ul"
+          
+          #
+          # Level 1
+          #
+          list_bullet                                           = Nokogiri::XML::Node.new('text:list-level-style-bullet', doc) 
+          list_bullet['text:level']                             = "1"
+          list_bullet['text:bullet-char']                       = "•"
+          node << list_bullet
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_bullet << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "1cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "1cm"
+          list_level << list_label
+          
+          #
+          # Level 2
+          #
+          list_bullet                                           = Nokogiri::XML::Node.new('text:list-level-style-bullet', doc) 
+          list_bullet['text:level']                             = "2"
+          list_bullet['text:bullet-char']                       = "◦"
+          node << list_bullet
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_bullet << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "1.5cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "1.5cm"
+          list_level << list_label
+          
+          #
+          # Level 3
+          #
+          list_bullet                                           = Nokogiri::XML::Node.new('text:list-level-style-bullet', doc) 
+          list_bullet['text:level']                             = "3"
+          list_bullet['text:bullet-char']                       = "▪"
+          node << list_bullet
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_bullet << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "2cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "2cm"
+          list_level << list_label
+          
+          #
+          # Level 4
+          #
+          list_bullet                                           = Nokogiri::XML::Node.new('text:list-level-style-bullet', doc) 
+          list_bullet['text:level']                             = "4"
+          list_bullet['text:bullet-char']                       = "•"
+          node << list_bullet
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_bullet << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "2.5cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "2.5cm"
+          list_level << list_label
+          
+          #
+          # Level 5
+          #
+          list_bullet                                           = Nokogiri::XML::Node.new('text:list-level-style-bullet', doc) 
+          list_bullet['text:level']                             = "5"
+          list_bullet['text:bullet-char']                       = "◦"
+          node << list_bullet
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_bullet << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "3cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "3cm"
+          list_level << list_label
+          
+          #
+          # Level 6
+          #
+          list_bullet                                           = Nokogiri::XML::Node.new('text:list-level-style-bullet', doc) 
+          list_bullet['text:level']                             = "6"
+          list_bullet['text:bullet-char']                       = "▪"
+          node << list_bullet
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_bullet << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "3.5cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "3.5cm"
+          list_level << list_label
+          
+        when :ol
+          node['style:name']                                    = "ol"
+          
+          #
+          # Level 1
+          #
+          list_number                                           = Nokogiri::XML::Node.new('text:list-level-style-number', doc) 
+          list_number['text:level']                             = "1"
+          list_number['style:num-suffix']                       = "."
+          list_number['style:num-format']                       = "1"
+          node << list_number
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_number << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "1cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "1cm"
+          list_level << list_label
+          
+          #
+          # Level 2
+          #
+          list_number                                           = Nokogiri::XML::Node.new('text:list-level-style-number', doc) 
+          list_number['text:level']                             = "2"
+          list_number['style:num-suffix']                       = "."
+          list_number['style:num-format']                       = "1"
+          node << list_number
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_number << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "1.5cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "1.5cm"
+          list_level << list_label
+          
+          #
+          # Level 3
+          #
+          list_number                                           = Nokogiri::XML::Node.new('text:list-level-style-number', doc) 
+          list_number['text:level']                             = "3"
+          list_number['style:num-suffix']                       = "."
+          list_number['style:num-format']                       = "1"
+          node << list_number
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_number << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "2cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "2cm"
+          list_level << list_label
+          
+          #
+          # Level 4
+          #
+          list_number                                           = Nokogiri::XML::Node.new('text:list-level-style-number', doc) 
+          list_number['text:level']                             = "4"
+          list_number['style:num-suffix']                       = "."
+          list_number['style:num-format']                       = "1"
+          node << list_number
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_number << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "2.5cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "2.5cm"
+          list_level << list_label
+          
+          #
+          # Level 5
+          #
+          list_number                                           = Nokogiri::XML::Node.new('text:list-level-style-number', doc) 
+          list_number['text:level']                             = "5"
+          list_number['style:num-suffix']                       = "."
+          list_number['style:num-format']                       = "1"
+          node << list_number
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_number << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "3cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "3cm"
+          list_level << list_label
+          
+          #
+          # Level 6
+          #
+          list_number                                           = Nokogiri::XML::Node.new('text:list-level-style-number', doc) 
+          list_number['text:level']                             = "6"
+          list_number['style:num-suffix']                       = "."
+          list_number['style:num-format']                       = "1"
+          node << list_number
+          
+          list_level                                            = Nokogiri::XML::Node.new('style:list-level-properties', doc)
+          list_level['text:list-level-position-and-space-mode'] = "label-alignment"
+          list_number << list_level
+          
+          list_label                                            = Nokogiri::XML::Node.new('style:list-level-label-alignment', doc) 
+          list_label['text:label-followed-by']                  = "listtab"
+          list_label['text:list-tab-stop-position']             = "3.5cm"
+          list_label['fo:text-indent']                          = "-0.5cm"
+          list_label['fo:margin-left']                          = "3.5cm"
+          list_level << list_label
+          
+      end
+      
+      node
+      
+    end #def
+    
+  end #class
+end #module