ruby_pptx 0.1.0 → 0.2.0

data/lib/ruby_pptx/chart/xml_writer.rb

@@ -267,11 +267,15 @@ module Pptx
         XML
       end
 
-      def dates? = chart_data.categories.dates?
+      def dates?
+        chart_data.categories.dates?
+      end
 
       # A chart being written from scratch uses the 1900 date system;
       # rewriting an existing chart's data honours the chart's own setting.
-      def date_1904? = @date_1904 || false
+      def date_1904?
+        @date_1904 || false
+      end
 
       def point_xml(index, value)
         %(<c:pt idx="#{index}">\n  <c:v>#{value}</c:v>\n</c:pt>\n)
@@ -279,7 +283,9 @@ module Pptx
 
       # Floats keep their trailing ".0" here, unlike in the workbook, because
       # that is what the reference implementation writes.
-      def format_value(value) = value.is_a?(String) ? escape(value) : value.to_s
+      def format_value(value)
+        value.is_a?(String) ? escape(value) : value.to_s
+      end
 
       def escape(text)
         text.to_s.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
@@ -343,23 +349,35 @@ module Pptx
 
       private
 
-      def bar? = BAR_TYPES.include?(chart_type.name)
+      def bar?
+        BAR_TYPES.include?(chart_type.name)
+      end
 
-      def bar_dir = bar? ? "bar" : "col"
+      def bar_dir
+        bar? ? "bar" : "col"
+      end
 
-      def grouping = GROUPINGS.fetch(chart_type.name)
+      def grouping
+        GROUPINGS.fetch(chart_type.name)
+      end
 
       # A bar chart's category axis runs down the left; a column chart's runs
       # along the bottom, and the value axis takes the other position.
-      def cat_ax_pos = bar? ? "l" : "b"
+      def cat_ax_pos
+        bar? ? "l" : "b"
+      end
 
-      def val_ax_pos = bar? ? "b" : "l"
+      def val_ax_pos
+        bar? ? "b" : "l"
+      end
 
       def overlap
         STACKED_TYPES.include?(chart_type.name) ? %(        <c:overlap val="100"/>\n) : ""
       end
 
-      def series_blocks = all_series_xml { |series| series_xml(series) }
+      def series_blocks
+        all_series_xml { |series| series_xml(series) }
+      end
 
       def cat_ax_xml
         return date_ax_xml(CAT_AX_ID, VAL_AX_ID, cat_ax_pos) if dates?
@@ -442,9 +460,13 @@ module Pptx
 
       private
 
-      def grouping = GROUPINGS.fetch(chart_type.name)
+      def grouping
+        GROUPINGS.fetch(chart_type.name)
+      end
 
-      def markers? = MARKER_TYPES.include?(chart_type.name)
+      def markers?
+        MARKER_TYPES.include?(chart_type.name)
+      end
 
       # A line chart without markers says so per series, by asking for the
       # "none" marker symbol.
@@ -458,7 +480,9 @@ module Pptx
         XML
       end
 
-      def smooth_xml = %(<c:smooth val="0"/>\n)
+      def smooth_xml
+        %(<c:smooth val="0"/>\n)
+      end
 
       def series_blocks
         all_series_xml do |series|
@@ -516,7 +540,9 @@ module Pptx
 
       # A pie plots one series only; any others live in the workbook but are
       # not drawn.
-      def series_blocks = series_xml(chart_data.series.first)
+      def series_blocks
+        series_xml(chart_data.series.first)
+      end
     end
 
     # Shared by the two families whose points carry their own x value rather
@@ -693,7 +719,9 @@ module Pptx
 
       private
 
-      def three_d? = chart_type.name == :BUBBLE_THREE_D_EFFECT
+      def three_d?
+        chart_type.name == :BUBBLE_THREE_D_EFFECT
+      end
 
       def series_blocks
         all_series_xml do |series|
@@ -770,9 +798,13 @@ module Pptx
 
       private
 
-      def grouping = GROUPINGS.fetch(chart_type.name)
+      def grouping
+        GROUPINGS.fetch(chart_type.name)
+      end
 
-      def series_blocks = all_series_xml { |series| series_xml(series) }
+      def series_blocks
+        all_series_xml { |series| series_xml(series) }
+      end
 
       def cat_ax_xml
         return date_ax_xml(CAT_AX_ID, VAL_AX_ID, "b") if dates?
@@ -884,7 +916,9 @@ module Pptx
 
       private
 
-      def radar_style = chart_type.name == :RADAR_FILLED ? "filled" : "marker"
+      def radar_style
+        chart_type.name == :RADAR_FILLED ? "filled" : "marker"
+      end
 
       # A plain radar draws lines without markers, which is said per series by
       # asking for the "none" symbol. The markers and filled variants do not.
@@ -947,7 +981,9 @@ module Pptx
       private
 
       # Unlike a pie, a doughnut draws every series as a concentric ring.
-      def series_blocks = all_series_xml { |series| series_xml(series) }
+      def series_blocks
+        all_series_xml { |series| series_xml(series) }
+      end
     end
   end
 end

data/lib/ruby_pptx/chart/xy_data.rb

@@ -42,9 +42,13 @@ module Pptx
       series
     end
 
-    def each(&) = @series.each(&)
+    def each(&)
+      @series.each(&)
+    end
 
-    def size = @series.size
+    def size
+      @series.size
+    end
 
     # The row a series' title sits on, counting the blocks before it.
     #
@@ -55,13 +59,19 @@ module Pptx
     end
 
     # @api private
-    def series_name_ref(series) = "#{WORKSHEET_NAME}!$B$#{title_row(series)}"
+    def series_name_ref(series)
+      "#{WORKSHEET_NAME}!$B$#{title_row(series)}"
+    end
 
     # @api private
-    def x_values_ref(series) = column_ref(series, "A")
+    def x_values_ref(series)
+      column_ref(series, "A")
+    end
 
     # @api private
-    def y_values_ref(series) = column_ref(series, "B")
+    def y_values_ref(series)
+      column_ref(series, "B")
+    end
 
     # @api private
     def column_ref(series, column)
@@ -71,30 +81,44 @@ module Pptx
     end
 
     # @api private
-    def xlsx_blob = XyWorkbookWriter.new(self).blob
+    def xlsx_blob
+      XyWorkbookWriter.new(self).blob
+    end
 
     # @api private
     # Whether the worksheet carries a third column of bubble sizes.
-    def bubble? = false
+    def bubble?
+      false
+    end
 
-    def inspect = "#<#{self.class.name} series=#{size}>"
+    def inspect
+      "#<#{self.class.name} series=#{size}>"
+    end
 
     private
 
-    def series_class = XySeries
+    def series_class
+      XySeries
+    end
   end
 
   # Data for a bubble chart: series of (x, y, size) points.
   class BubbleChartData < XyChartData
     # @api private
-    def bubble_sizes_ref(series) = column_ref(series, "C")
+    def bubble_sizes_ref(series)
+      column_ref(series, "C")
+    end
 
     # @api private
-    def bubble? = true
+    def bubble?
+      true
+    end
 
     private
 
-    def series_class = BubbleSeries
+    def series_class
+      BubbleSeries
+    end
   end
 
   # One series of a scatter chart.
@@ -117,19 +141,37 @@ module Pptx
       self
     end
 
-    def each(&) = @points.each(&)
+    def each(&)
+      @points.each(&)
+    end
+
+    def size
+      @points.size
+    end
 
-    def size = @points.size
+    def x_values
+      @points.map(&:first)
+    end
+
+    def y_values
+      @points.map { |point| point[1] }
+    end
 
-    def x_values = @points.map(&:first)
+    def name_ref
+      @chart_data.series_name_ref(self)
+    end
 
-    def y_values = @points.map { |point| point[1] }
+    def x_values_ref
+      @chart_data.x_values_ref(self)
+    end
 
-    def name_ref = @chart_data.series_name_ref(self)
-    def x_values_ref = @chart_data.x_values_ref(self)
-    def y_values_ref = @chart_data.y_values_ref(self)
+    def y_values_ref
+      @chart_data.y_values_ref(self)
+    end
 
-    def inspect = "#<#{self.class.name} #{@name.inspect} #{size} points>"
+    def inspect
+      "#<#{self.class.name} #{@name.inspect} #{size} points>"
+    end
   end
 
   # One series of a bubble chart, whose points carry a size as well.
@@ -139,9 +181,13 @@ module Pptx
       self
     end
 
-    def bubble_sizes = @points.map { |point| point[2] }
+    def bubble_sizes
+      @points.map { |point| point[2] }
+    end
 
-    def bubble_sizes_ref = @chart_data.bubble_sizes_ref(self)
+    def bubble_sizes_ref
+      @chart_data.bubble_sizes_ref(self)
+    end
   end
 
   # Writes the workbook behind a scatter or bubble chart.

data/lib/ruby_pptx/dml/color.rb

@@ -19,7 +19,9 @@ module Pptx
     attr_reader :r, :g, :b
 
     # Array patterns too: `in [r, g, b]`.
-    def deconstruct = to_a
+    def deconstruct
+      to_a
+    end
 
     # Parse a hex string such as "3C2F80".
     def self.from_string(hex)
@@ -46,17 +48,27 @@ module Pptx
       freeze
     end
 
-    def to_a = [@r, @g, @b]
+    def to_a
+      [@r, @g, @b]
+    end
 
     # The uppercase hex form OOXML uses, e.g. "3C2F80".
-    def to_s = format("%02X%02X%02X", @r, @g, @b)
+    def to_s
+      format("%02X%02X%02X", @r, @g, @b)
+    end
 
-    def ==(other) = other.is_a?(RGBColor) && other.to_a == to_a
+    def ==(other)
+      other.is_a?(RGBColor) && other.to_a == to_a
+    end
     alias eql? ==
 
-    def hash = to_a.hash
+    def hash
+      to_a.hash
+    end
 
-    def inspect = "#<Pptx::RGBColor #{self}>"
+    def inspect
+      "#<Pptx::RGBColor #{self}>"
+    end
   end
 
   # The colour of a font, fill or line.
@@ -66,7 +78,9 @@ module Pptx
   class ColorFormat
     # @param color_choice_parent [Pptx::Oxml::Element] the element holding the
     #   colour choice, e.g. `a:solidFill`
-    def self.from_color_choice_parent(color_choice_parent) = new(color_choice_parent)
+    def self.from_color_choice_parent(color_choice_parent)
+      new(color_choice_parent)
+    end
 
     def initialize(color_choice_parent)
       @parent = color_choice_parent
@@ -146,10 +160,14 @@ module Pptx
       end
     end
 
-    def inspect = "#<Pptx::ColorFormat type=#{type&.name.inspect} rgb=#{rgb&.to_s.inspect}>"
+    def inspect
+      "#<Pptx::ColorFormat type=#{type&.name.inspect} rgb=#{rgb&.to_s.inspect}>"
+    end
 
     private
 
-    def color_element = @parent.eg_colorChoice
+    def color_element
+      @parent.eg_colorChoice
+    end
   end
 end

data/lib/ruby_pptx/dml/effect.rb

@@ -16,7 +16,9 @@ module Pptx
     end
 
     # True when the shape takes its shadow from the style hierarchy.
-    def inherit? = @element.effectLst.nil?
+    def inherit?
+      @element.effectLst.nil?
+    end
 
     alias inherit inherit?
 
@@ -28,6 +30,8 @@ module Pptx
       value ? @element.remove_effectLst : @element.get_or_add_effectLst
     end
 
-    def inspect = "#<Pptx::ShadowFormat inherit=#{inherit?}>"
+    def inspect
+      "#<Pptx::ShadowFormat inherit=#{inherit?}>"
+    end
   end
 end

data/lib/ruby_pptx/dml/fill.rb

@@ -18,7 +18,9 @@ module Pptx
   class FillFormat
     # @param fill_parent [Pptx::Oxml::Element] the element carrying the fill
     #   choice group, e.g. `p:spPr` or `a:rPr`
-    def self.from_fill_parent(fill_parent) = new(fill_parent)
+    def self.from_fill_parent(fill_parent)
+      new(fill_parent)
+    end
 
     def initialize(fill_parent)
       @parent = fill_parent
@@ -124,13 +126,19 @@ module Pptx
     # The colour stops the gradient passes through, in order.
     #
     # @return [GradientStops]
-    def gradient_stops = GradientStops.new(require_gradient.get_or_add_gsLst)
+    def gradient_stops
+      GradientStops.new(require_gradient.get_or_add_gsLst)
+    end
 
-    def inspect = "#<Pptx::FillFormat type=#{type&.name.inspect}>"
+    def inspect
+      "#<Pptx::FillFormat type=#{type&.name.inspect}>"
+    end
 
     private
 
-    def fill_element = @parent.eg_fillProperties
+    def fill_element
+      @parent.eg_fillProperties
+    end
 
     def require_gradient
       raise Error, "fill type #{type&.name.inspect} is not a gradient" unless type&.name == :GRADIENT
@@ -160,27 +168,39 @@ module Pptx
       self
     end
 
-    def size = @element.gs_list.size
+    def size
+      @element.gs_list.size
+    end
     alias length size
 
-    def [](index, length = nil) = slice_members(@element.gs_list, index, length) { |gs| GradientStop.new(gs) }
+    def [](index, length = nil)
+      slice_members(@element.gs_list, index, length) { |gs| GradientStop.new(gs) }
+    end
 
-    def inspect = "#<Pptx::GradientStops size=#{size}>"
+    def inspect
+      "#<Pptx::GradientStops size=#{size}>"
+    end
   end
 
   # One colour stop in a gradient.
   class GradientStop < ElementProxy
-    def color = @color ||= ColorFormat.from_color_choice_parent(@element)
+    def color
+      @color ||= ColorFormat.from_color_choice_parent(@element)
+    end
 
     # Where along the gradient this stop sits, from 0.0 at the start to 1.0
     # at the end.
-    def position = @element.pos
+    def position
+      @element.pos
+    end
 
     def position=(value)
       @element.pos = Float(value)
     end
 
-    def inspect = "#<Pptx::GradientStop position=#{position}>"
+    def inspect
+      "#<Pptx::GradientStop position=#{position}>"
+    end
   end
 
   class LineFormat
@@ -189,9 +209,13 @@ module Pptx
     end
 
     # The `a:ln` element, added if not present.
-    def element = @element ||= @parent.get_or_add_ln
+    def element
+      @element ||= @parent.get_or_add_ln
+    end
 
-    def fill = @fill ||= FillFormat.from_fill_parent(element)
+    def fill
+      @fill ||= FillFormat.from_fill_parent(element)
+    end
 
     # Shortcut to the line's solid colour, making the fill solid on first use.
     def color
@@ -210,7 +234,9 @@ module Pptx
     # The dash pattern, or nil when it is inherited.
     #
     # @return [Pptx::Enum::Member, nil] a member of MSO_LINE_DASH_STYLE
-    def dash_style = @parent.ln&.prstDash_val
+    def dash_style
+      @parent.ln&.prstDash_val
+    end
 
     # Set the dash pattern, or restore inheritance with nil -- which also
     # drops a custom dash, since either one would override the inherited
@@ -229,6 +255,8 @@ module Pptx
       element.w = value.nil? ? Pptx::Length.emu(0) : value
     end
 
-    def inspect = "#<Pptx::LineFormat width=#{width&.pt}>"
+    def inspect
+      "#<Pptx::LineFormat width=#{width&.pt}>"
+    end
   end
 end

data/lib/ruby_pptx/element_proxy.rb

@@ -17,12 +17,18 @@ module Pptx
       @element = element
     end
 
-    def ==(other) = other.is_a?(ElementProxy) && other.element == @element
+    def ==(other)
+      other.is_a?(ElementProxy) && other.element == @element
+    end
     alias eql? ==
 
-    def hash = @element.hash
+    def hash
+      @element.hash
+    end
 
-    def inspect = "#<#{self.class.name} <#{@element.nsptag}>>"
+    def inspect
+      "#<#{self.class.name} <#{@element.nsptag}>>"
+    end
   end
 
   # A proxy that knows its parent, and through it the part it belongs to.
@@ -38,7 +44,9 @@ module Pptx
     end
 
     # The package part this object lives in.
-    def part = @parent.part
+    def part
+      @parent.part
+    end
   end
 
   # A proxy wrapping a part's root element, such as `p:sld`.

data/lib/ruby_pptx/enum/base.rb

@@ -27,12 +27,18 @@ module Pptx
       # True when this member has no XML representation. Such members are
       # return values only: they describe a state the file format expresses by
       # some other means, so they can be returned but never written.
-      def xml_value? = !(@xml_value.nil? || @xml_value.empty?)
+      def xml_value?
+        !(@xml_value.nil? || @xml_value.empty?)
+      end
 
-      def to_i = @value
+      def to_i
+        @value
+      end
       alias to_int to_i
 
-      def to_sym = @name
+      def to_sym
+        @name
+      end
 
       def <=>(other)
         case other
@@ -41,15 +47,23 @@ module Pptx
         end
       end
 
-      def ==(other) = (self <=> other)&.zero? || false
+      def ==(other)
+        (self <=> other)&.zero? || false
+      end
       alias eql? ==
 
-      def hash = @value.hash
+      def hash
+        @value.hash
+      end
 
       # e.g. "MIDDLE (3)"
-      def to_s = "#{@name} (#{@value})"
+      def to_s
+        "#{@name} (#{@value})"
+      end
 
-      def inspect = "#{@enum.short_name}.#{@name}"
+      def inspect
+        "#{@enum.short_name}.#{@name}"
+      end
     end
 
     # Base for every enumeration. Members are declared with {.member} and
@@ -70,11 +84,17 @@ module Pptx
           member
         end
 
-        def members = @members ||= []
+        def members
+          @members ||= []
+        end
 
-        def each(&) = members.each(&)
+        def each(&)
+          members.each(&)
+        end
 
-        def short_name = name.to_s.split("::").last
+        def short_name
+          name.to_s.split("::").last
+        end
 
         # Look a member up by symbolic name or MS API value.
         #

data/lib/ruby_pptx/enum/prog_id.rb

@@ -12,7 +12,9 @@ module Pptx
     module PROG_ID
       # One embeddable Office file type.
       Member = Data.define(:name, :prog_id, :icon_filename, :width, :height) do
-        def to_s = "PROG_ID.#{name}"
+        def to_s
+          "PROG_ID.#{name}"
+        end
         alias_method :inspect, :to_s
       end
 

data/lib/ruby_pptx/geometry.rb

@@ -39,7 +39,9 @@ module Pptx
 
     # Destructuring and splatting, which is what lets a Point stand in for the
     # `[x, y]` array everywhere this library already unpacks one.
-    def to_ary = [x, y]
+    def to_ary
+      [x, y]
+    end
 
     def +(other)
       other = Point.from(other)
@@ -51,8 +53,13 @@ module Pptx
       Point.new(x: x - other.x, y: y - other.y)
     end
 
-    def to_s = "(#{x.inches.round(3)}in, #{y.inches.round(3)}in)"
-    def inspect = "#<Pptx::Point #{self}>"
+    def to_s
+      "(#{x.inches.round(3)}in, #{y.inches.round(3)}in)"
+    end
+
+    def inspect
+      "#<Pptx::Point #{self}>"
+    end
   end
 
   # The extent of a shape: a width and a height.
@@ -68,22 +75,37 @@ module Pptx
       super(width: Geometry.length(width, :width), height: Geometry.length(height, :height))
     end
 
-    def to_ary = [width, height]
+    def to_ary
+      [width, height]
+    end
 
     # Scale both extents, for `size * 2` or `size * 0.5`.
-    def *(factor) = Size.new(width: width * factor, height: height * factor)
+    def *(factor)
+      Size.new(width: width * factor, height: height * factor)
+    end
 
-    def aspect_ratio = width.emu.to_f / height.emu
+    def aspect_ratio
+      width.emu.to_f / height.emu
+    end
+
+    def to_s
+      "#{width.inches.round(3)}in x #{height.inches.round(3)}in"
+    end
 
-    def to_s = "#{width.inches.round(3)}in x #{height.inches.round(3)}in"
-    def inspect = "#<Pptx::Size #{self}>"
+    def inspect
+      "#<Pptx::Size #{self}>"
+    end
   end
 
   class << self
     # @return [Pptx::Point]
-    def point(x, y) = Point.new(x: x, y: y)
+    def point(x, y)
+      Point.new(x: x, y: y)
+    end
 
     # @return [Pptx::Size]
-    def size(width, height) = Size.new(width: width, height: height)
+    def size(width, height)
+      Size.new(width: width, height: height)
+    end
   end
 end