rubyXL 3.3.29 → 3.3.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 07e72e7675b581c19399a3f4f5ce60790b3e1cb2
-  data.tar.gz: f2a67aee8be9391fd9d58c44886cff21a3df5af7
+SHA256:
+  metadata.gz: b03457172d474572306d0c12f04040aa71fd850651c24883f4cb9d547767f94f
+  data.tar.gz: eb2262738f31511cf674abfc0486849fd607434c007a0b6c810094f8da308ce5
 SHA512:
-  metadata.gz: 7aa59896e1ca74f38545b426e0d8fad613fd341ec06781724df2c82e94857149129b328ff5186b09cc0df377d78140c1162aa69bec3013b288f35c030f823c27
-  data.tar.gz: 2cf93d0b03520e8cc7ec955dee92fdd14dacca0647369e7a071ce02598b2db63597326d928143d2ec674c560b8aa26a57fc4c2c0996fc8d634d584128c1b099e
+  metadata.gz: f8076ff24b3353c04316da91192f457b5ed9c3cd373cf8721b71ffdb57487482793c5fa05fe9a1a485d2dc5081dfae1eba62cf3cf7d276be14bb87ab85975fde
+  data.tar.gz: d36b10b4be0a669363bec0cb405a4c83a2be2a8346155ad6fd67cd014b38331c4bce2eca048c1a591e186ebfa7460a364fbc9df3ef0a41fec9daa1bac5849f0d

data/README.rdoc

@@ -53,6 +53,7 @@ Please note that row is a _sparse_ array of cells. Your code *must* expect that
   cell.vertical_alignment
   cell.get_border(:top)
   cell.get_border_color(:top)
+  cell.text_rotation
 
 ==== Wrappers for accessing Row properties 
 Please note: these methods are being phased out in favor of the OOXML object model.
@@ -140,6 +141,15 @@ bottom, center, distributed, top
   worksheet.sheet_data[0][0].change_vertical_alignment('bottom')  # Sets A1 to be bottom aligned
   worksheet.change_row_vertical_alignment(0, 'distributed')       # Sets first row to be distributed vertically
   worksheet.change_column_vertical_alignment(0, 'top')            # Sets first column to be top aligned
+  
+===== Rotation
+  worksheet.sheet_data[0][0].change_text_rotation(90)  # Sets A1 to be rotated by 90 degrees
+
+Values:
+* 0-90 - degrees counterclockwise, around the bottom LEFT corner of the cell;
+* 91-179 - degrees clockwise, around the bottom RIGHT corner of the cell;
+* 180-254 - degrees clockwise, around the bottom LEFT corner of the cell, text becomes progressively invisible
+* 255 - text is in normal rotation but displayed vertically (one letter under another), line feed starts new line to the right of the previous.
 
 ==== Changing Row Height
   worksheet.change_row_height(0, 30)  # Sets first row height to 30
@@ -193,6 +203,8 @@ WARNING: Use of this method WILL break formulas referencing cells which have bee
 ==== Modifying Cell Format
   cell = worksheet[0][0]
   cell.set_number_format '0.0000%'    # For formats, see https://support.office.com/en-us/article/5026bbd6-04bc-48cd-bf33-80f18b4eae68
+  cell.change_text_wrap(true)         # Makes the text in the cell to wrap.
+  cell.change_text_indent(1)          # Indents the text in the cell by 1 level
 
 == I/O
 

data/VERSION

@@ -1 +1 @@
-3.3.29
+3.3.30

data/lib/rubyXL/convenience_methods.rb

@@ -120,7 +120,8 @@ module RubyXL
       fill = fills[xf.fill_id]
       pattern = fill && fill.pattern_fill
       color = pattern && pattern.fg_color
-      color && color.rgb || 'ffffff'
+      color = color && color.get_rgb(self)
+      color && color.to_s || 'ffffff'
     end
 
     def register_new_fill(new_fill, old_xf)
@@ -869,6 +870,16 @@ module RubyXL
       self.style_index = workbook.modify_alignment(self.style_index) { |a| a.wrap_text = wrap }
     end
 
+    def change_text_rotation(rot)
+      validate_worksheet
+      self.style_index = workbook.modify_alignment(self.style_index) { |a| a.text_rotation = rot }
+    end
+
+    def change_text_indent(indent)
+      validate_worksheet
+      self.style_index = workbook.modify_alignment(self.style_index) { |a| a.indent = indent }
+    end
+
     def change_border(direction, weight)
       validate_worksheet
       self.style_index = workbook.modify_border(self.style_index, direction, weight)
@@ -940,6 +951,20 @@ module RubyXL
       return nil if xf_obj.alignment.nil?
       xf_obj.alignment.wrap_text
     end
+    
+    def text_rotation
+      validate_worksheet
+      xf_obj = get_cell_xf
+      return nil if xf_obj.alignment.nil?
+      xf_obj.alignment.text_rotation    
+    end
+
+    def text_indent()
+      validate_worksheet
+      xf_obj = get_cell_xf
+      return nil if xf_obj.alignment.nil?
+      xf_obj.alignment.indent
+    end
 
     def set_number_format(format_code)
       new_xf = get_cell_xf.dup
@@ -1119,4 +1144,157 @@ module RubyXL
     end
   end
 
+  module ColorConvenienceMethods
+
+    def get_rgb(workbook)
+      if rgb then
+        return rgb
+      elsif theme then
+        theme_color = workbook.theme.get_theme_color(theme)
+        rgb_color = theme_color && theme_color.a_srgb_clr
+        color_value = rgb_color && rgb_color.val
+        return nil if color_value.nil?
+
+        RubyXL::RgbColor.parse(color_value).to_hls.apply_tint(tint).to_rgb.to_s
+      end
+    end
+
+  end
+
+  module ColorConvenienceClasses
+    # https://ciintelligence.blogspot.com/2012/02/converting-excel-theme-color-and-tint.html
+    class RgbColor
+      attr_accessor :r, :g, :b, :a
+
+      def to_hls
+        hls_color = HlsColor.new
+
+        # Note that we are overriding accessors with local vars here:
+        r = self.r / 255.0
+        g = self.g / 255.0
+        b = self.b / 255.0
+
+        hls_color.a = (self.a || 0) / 255.0
+
+        min = [r, g, b].min
+        max = [r, g, b].max
+        delta = max - min
+
+        if (max == min) then
+          hls_color.h = hls_color.s = 0
+          hls_color.l = max
+          return hls_color
+        end
+
+        hls_color.l = (min + max) / 2
+
+        if (hls_color.l < 0.5) then
+          hls_color.s = delta / (max + min);
+        else
+          hls_color.s = delta / (2.0 - max - min);
+        end
+
+        hls_color.h = (g - b) / delta       if (r == max)
+        hls_color.h = 2.0 + (b - r) / delta if (g == max)
+        hls_color.h = 4.0 + (r - g) / delta if (b == max)
+
+        hls_color.h *= 60;
+        hls_color.h += 360 if hls_color.h < 0
+
+        hls_color
+      end
+
+      def self.parse(str)
+        r, g, b, a = str.unpack("A2A2A2A2")
+
+        rgb_color = RgbColor.new
+        rgb_color.r = r && r.to_i(16)
+        rgb_color.g = g && g.to_i(16)
+        rgb_color.b = b && b.to_i(16)
+        rgb_color.a = a && a.to_i(16)
+
+        rgb_color
+      end
+
+      def to_s
+        str = r.to_s(16) + g.to_s(16) + b.to_s(16)
+        str += a.to_s(16) if a && a != 0
+        str
+      end
+
+    end
+
+    class HlsColor
+      attr_accessor :h, :l, :s, :a
+
+      def to_rgb
+        rgb_color = RgbColor.new
+
+        r = g = b = l
+
+        if s != 0 then
+          t1 = nil
+
+          if l < 0.5 then
+            t1 = l * (1.0 + s)
+          else
+            t1 = l + s - (l * s)
+          end
+
+          t2 = 2.0 * l - t1;
+          h = self.h / 360.0
+
+          t_r = h + (1.0 / 3.0)
+          r = set_color(t1, t2, t_r)
+
+          t_g = h;
+          g = set_color(t1, t2, t_g)
+
+          t_b = h - (1.0 / 3.0);
+          b = set_color(t1, t2, t_b)
+        end
+
+        rgb_color.r = (r * 255).round(0).to_i
+        rgb_color.g = (g * 255).round(0).to_i
+        rgb_color.b = (b * 255).round(0).to_i
+
+        rgb_color.a = (a * 255).round(0).to_i
+
+        rgb_color
+      end
+
+      private def set_color(t1, t2, t3)
+        color = 0
+
+        t3 += 1.0 if (t3 < 0)
+        t3 -= 1.0 if (t3 > 1)
+
+        if (6.0 * t3 < 1) then
+          color = t2 + (t1 - t2) * 6.0 * t3;
+        elsif (2.0 * t3 < 1) then
+          color = t1;
+        elsif (3.0 * t3 < 2) then
+          color = t2 + (t1 - t2) * ((2.0 / 3.0) - t3) * 6.0;
+        else
+          color = t2;
+        end
+
+        color
+      end
+
+      def apply_tint(tint)
+        return self if tint.nil? || tint == 0
+
+        if tint < 0 then
+          self.l = l * (1.0 + tint);
+        else
+          self.l = l * (1.0 - tint) + tint;
+        end
+
+        self
+      end
+
+    end
+  end
+
 end

data/lib/rubyXL/objects/cell_style.rb

@@ -18,13 +18,13 @@ module RubyXL
   class Alignment < OOXMLObject
     define_attribute(:horizontal,      RubyXL::ST_HorizontalAlignment)
     define_attribute(:vertical,        RubyXL::ST_VerticalAlignment)
-    define_attribute(:textRotation,    :int)
+    define_attribute(:textRotation,    :uint)
     define_attribute(:wrapText,        :bool)
-    define_attribute(:indent,          :int)
+    define_attribute(:indent,          :uint)
     define_attribute(:relativeIndent,  :int)
     define_attribute(:justifyLastLine, :bool)
     define_attribute(:shrinkToFit,     :bool)
-    define_attribute(:readingOrder,    :int)
+    define_attribute(:readingOrder,    :uint)
     define_element_name 'alignment'
   end
 

data/lib/rubyXL/objects/color.rb

@@ -8,7 +8,7 @@ module RubyXL
 
     define_attribute(:auto,    :bool)
     define_attribute(:indexed, :uint)
-    define_attribute(:rgb,     :string)
+    define_attribute(:rgb,     ST_UnsignedIntHex)
     define_attribute(:theme,   :uint)
     define_attribute(:tint,    :double, :default => 0.0)
     define_element_name 'color'
@@ -22,6 +22,8 @@ module RubyXL
       end
     end
 
+    include ColorConvenienceMethods
   end
 
+  include ColorConvenienceClasses
 end

data/lib/rubyXL/objects/simple_types.rb

@@ -226,7 +226,9 @@ module RubyXL
   ST_TextStrikeType       = %w{ noStrike sngStrike dblStrike }
   ST_TextCapsType         = %w{ none small all }
 
+  # TODO: http://www.datypic.com/sc/ooxml/t-ssml_ST_UnsignedIntHex.html
+  ST_UnsignedIntHex       = :string # length = 4
   # TODO: http://www.datypic.com/sc/ooxml/t-ssml_ST_UnsignedShortHex.html
-  ST_UnsignedShortHex     = :string
+  ST_UnsignedShortHex     = :string # length = 2
 
 end

data/lib/rubyXL/objects/theme.rb

@@ -1391,6 +1391,25 @@ module RubyXL
       ROOT.join('xl', 'theme', 'theme1.xml')
     end
 
+    def get_theme_color(idx)
+      color_scheme = a_theme_elements && a_theme_elements.a_clr_scheme
+
+      if color_scheme then
+        case idx
+        when 0 then color_scheme.a_lt1
+        when 1 then color_scheme.a_dk1
+        when 2 then color_scheme.a_lt2
+        when 3 then color_scheme.a_dk2
+        when 4 then color_scheme.a_accent1
+        when 5 then color_scheme.a_accent2
+        when 6 then color_scheme.a_accent3
+        when 7 then color_scheme.a_accent4
+        when 8 then color_scheme.a_accent5
+        when 9 then color_scheme.a_accent6
+        end
+      end
+    end
+
     def self.default
       default_theme = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <a:theme xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main" name="Office Theme">

data/lib/rubyXL/objects/workbook.rb

@@ -1,5 +1,6 @@
 #require 'tmpdir'
 require 'date'
+require 'rubyXL/convenience_methods'
 require 'rubyXL/objects/ooxml_object'
 require 'rubyXL/objects/shared_strings'
 require 'rubyXL/objects/stylesheet'
@@ -11,7 +12,6 @@ require 'rubyXL/objects/relationships'
 require 'rubyXL/objects/simple_types'
 require 'rubyXL/objects/extensions'
 require 'rubyXL/objects/external_links'
-require 'rubyXL/convenience_methods'
 
 module RubyXL
 

data/lib/rubyXL/objects/worksheet.rb

@@ -362,7 +362,7 @@ module RubyXL
   class Pane < OOXMLObject
     define_attribute(:xSplit,      :double)
     define_attribute(:ySplit,      :double)
-    define_attribute(:topLeftCell, :string)
+    define_attribute(:topLeftCell, :ref)
     define_attribute(:activePane,  RubyXL::ST_Pane,      :default => 'topLeft')
     define_attribute(:state,       RubyXL::ST_PaneState, :default => 'split')
     define_element_name 'pane'

data/rdoc/README_rdoc.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>README - rubyXL 3.3.29</title>
+<title>README - rubyXL 3.3.30</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "./";
@@ -80,6 +80,7 @@
     <li><a href="#label-Changing+Alignment">Changing Alignment</a>
     <li><a href="#label-Horizontal">Horizontal</a>
     <li><a href="#label-Vertical">Vertical</a>
+    <li><a href="#label-Rotation">Rotation</a>
     <li><a href="#label-Changing+Row+Height">Changing Row Height</a>
     <li><a href="#label-Changing+Column+Width">Changing Column Width</a>
     <li><a href="#label-Merging+Cells">Merging Cells</a>
@@ -195,6 +196,7 @@ preserving as much of the structure as possible.</p>
 <span class="ruby-identifier">cell</span>.<span class="ruby-identifier">vertical_alignment</span>
 <span class="ruby-identifier">cell</span>.<span class="ruby-identifier">get_border</span>(:<span class="ruby-identifier">top</span>)
 <span class="ruby-identifier">cell</span>.<span class="ruby-identifier">get_border_color</span>(:<span class="ruby-identifier">top</span>)
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">text_rotation</span>
 </pre>
 
 <h4 id="label-Wrappers+for+accessing+Row+properties+">Wrappers for accessing Row properties <span><a href="#label-Wrappers+for+accessing+Row+properties+">&para;</a> <a href="#top">&uarr;</a></span></h4>
@@ -317,6 +319,24 @@ You should access and iterate through rows and cells directly:</p>
 <span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_vertical_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-string">&#39;top&#39;</span>)            <span class="ruby-comment"># Sets first column to be top aligned</span>
 </pre>
 
+<h5 id="label-Rotation">Rotation<span><a href="#label-Rotation">&para;</a> <a href="#top">&uarr;</a></span></h5>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_text_rotation</span>(<span class="ruby-value">90</span>)  <span class="ruby-comment"># Sets A1 to be rotated by 90 degrees</span>
+</pre>
+
+<p>Values:</p>
+<ul><li>
+<p>0-90 - degrees counterclockwise, around the bottom LEFT corner of the cell;</p>
+</li><li>
+<p>91-179 - degrees clockwise, around the bottom RIGHT corner of the cell;</p>
+</li><li>
+<p>180-254 - degrees clockwise, around the bottom LEFT corner of the cell,
+text becomes progressively invisible</p>
+</li><li>
+<p>255 - text is in normal rotation but displayed vertically (one letter under
+another), line feed starts new line to the right of the previous.</p>
+</li></ul>
+
 <h4 id="label-Changing+Row+Height">Changing Row Height<span><a href="#label-Changing+Row+Height">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
 <pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_height</span>(<span class="ruby-value">0</span>, <span class="ruby-value">30</span>)  <span class="ruby-comment"># Sets first row height to 30</span>
@@ -409,6 +429,8 @@ have been moved, as the formulas do not adapt to the shifted cells</p>
 
 <pre class="ruby"><span class="ruby-identifier">cell</span> = <span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>]
 <span class="ruby-identifier">cell</span>.<span class="ruby-identifier">set_number_format</span> <span class="ruby-string">&#39;0.0000%&#39;</span>    <span class="ruby-comment"># For formats, see https://support.office.com/en-us/article/5026bbd6-04bc-48cd-bf33-80f18b4eae68</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">change_text_wrap</span>(<span class="ruby-keyword">true</span>)         <span class="ruby-comment"># Makes the text in the cell to wrap.</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">change_text_indent</span>(<span class="ruby-value">1</span>)          <span class="ruby-comment"># Indents the text in the cell by 1 level</span>
 </pre>
 
 <h2 id="label-I-2FO">I/O<span><a href="#label-I-2FO">&para;</a> <a href="#top">&uarr;</a></span></h2>

data/rdoc/RubyXL.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>module RubyXL - rubyXL 3.3.29</title>
+<title>module RubyXL - rubyXL 3.3.30</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "./";
@@ -56,7 +56,18 @@
   <div id="class-metadata">
     
     
-    
+    <div id="includes-section" class="nav-section">
+  <h3>Included Modules</h3>
+
+  <ul class="link-list">
+  
+  
+    <li><a class="include" href="RubyXL/ColorConvenienceClasses.html">RubyXL::ColorConvenienceClasses</a>
+  
+  
+  </ul>
+</div>
+
     
     <!-- Method Quickref -->
 <div id="method-list-section" class="nav-section">
@@ -506,6 +517,12 @@
         <dd>
         
       
+        <dt id="ST_UnsignedIntHex">ST_UnsignedIntHex
+        
+        <dd><p>TODO: <a
+href="http://www.datypic.com/sc/ooxml/t-ssml_ST_UnsignedIntHex.html">www.datypic.com/sc/ooxml/t-ssml_ST_UnsignedIntHex.html</a></p>
+        
+      
         <dt id="ST_UnsignedShortHex">ST_UnsignedShortHex
         
         <dd><p>TODO: <a