ruby_pptx 0.1.0 → 0.2.0

data/lib/ruby_pptx/shapes/base.rb

@@ -24,64 +24,90 @@ module Pptx
       @parent = parent
     end
 
-    def ==(other) = other.is_a?(BaseShape) && other.element == @element
+    def ==(other)
+      other.is_a?(BaseShape) && other.element == @element
+    end
     alias eql? ==
 
-    def hash = @element.hash
+    def hash
+      @element.hash
+    end
 
     # The package part containing this shape.
-    def part = @parent.part
+    def part
+      @parent.part
+    end
 
     # The drawing-object id, unique within the slide.
-    def shape_id = @element.shape_id
+    def shape_id
+      @element.shape_id
+    end
 
-    def name = @element.shape_name
+    def name
+      @element.shape_name
+    end
 
     def name=(value)
       @element.nvXxPr.cNvPr.name = value.to_s
     end
 
     # @return [Length, nil] nil when the shape inherits its position
-    def left = @element.x
+    def left
+      @element.x
+    end
 
     def left=(value)
       @element.x = value
     end
 
-    def top = @element.y
+    def top
+      @element.y
+    end
 
     def top=(value)
       @element.y = value
     end
 
-    def width = @element.cx
+    def width
+      @element.cx
+    end
 
     def width=(value)
       @element.cx = value
     end
 
-    def height = @element.cy
+    def height
+      @element.cy
+    end
 
     def height=(value)
       @element.cy = value
     end
 
     # Clockwise rotation in degrees.
-    def rotation = @element.rot
+    def rotation
+      @element.rot
+    end
 
     def rotation=(value)
       @element.rot = value
     end
 
-    def placeholder? = @element.placeholder?
+    def placeholder?
+      @element.placeholder?
+    end
 
     # This shape's shadow. Always returned, even when the shadow is inherited.
     #
     # @return [ShadowFormat]
-    def shadow = @shadow ||= ShadowFormat.new(@element.spPr)
+    def shadow
+      @shadow ||= ShadowFormat.new(@element.spPr)
+    end
 
     # What happens when this shape is clicked during a slide show.
-    def click_action = @click_action ||= ActionSetting.new(@element.nvXxPr.cNvPr, self)
+    def click_action
+      @click_action ||= ActionSetting.new(@element.nvXxPr.cNvPr, self)
+    end
 
     # What happens when the pointer rests on this shape.
     def hover_action
@@ -93,7 +119,9 @@ module Pptx
     # A shortcut for `click_action.url`, which is the common case; reach for
     # {#click_action} when the click does something else. Nil when the click
     # is not a hyperlink -- a slide jump reports nil here, not a partname.
-    def hyperlink = click_action.url
+    def hyperlink
+      click_action.url
+    end
 
     def hyperlink=(url)
       click_action.address = url
@@ -105,14 +133,26 @@ module Pptx
     end
 
     # Overridden by the subclasses that can actually hold these.
-    def text_frame? = false
-    def chart? = false
-    def table? = false
+    def text_frame?
+      false
+    end
+
+    def chart?
+      false
+    end
+
+    def table?
+      false
+    end
 
     # @return [Pptx::Enum::MSO_SHAPE_TYPE]
-    def shape_type = raise(NotImplementedError, "#{self.class} must implement #shape_type")
+    def shape_type
+      raise(NotImplementedError, "#{self.class} must implement #shape_type")
+    end
 
-    def inspect = "#<#{self.class.name} id=#{shape_id} #{name.inspect}>"
+    def inspect
+      "#<#{self.class.name} id=#{shape_id} #{name.inspect}>"
+    end
   end
 
   # The placeholder-specific properties of a shape: which placeholder it is
@@ -124,15 +164,25 @@ module Pptx
 
     # The `idx` that ties a slide placeholder to the layout one it inherits
     # from. The title placeholder is always 0.
-    def idx = @element.idx
+    def idx
+      @element.idx
+    end
 
     # @return [Pptx::Enum::PP_PLACEHOLDER]
-    def type = @element.type
+    def type
+      @element.type
+    end
 
-    def orientation = @element.orient
+    def orientation
+      @element.orient
+    end
 
-    def size = @element.sz
+    def size
+      @element.sz
+    end
 
-    def inspect = "#<Pptx::PlaceholderFormat idx=#{idx} type=#{type}>"
+    def inspect
+      "#<Pptx::PlaceholderFormat idx=#{idx} type=#{type}>"
+    end
   end
 end

data/lib/ruby_pptx/shapes/freeform.rb

@@ -36,9 +36,13 @@ module Pptx
       new(shapes, start_x, start_y, x_scale, y_scale)
     end
 
-    def each(&) = @operations.each(&)
+    def each(&)
+      @operations.each(&)
+    end
 
-    def size = @operations.size
+    def size
+      @operations.size
+    end
 
     # Draw a straight line to (x, y).
     #
@@ -89,11 +93,17 @@ module Pptx
     #
     # The bounding box need not start at the local origin, so this is what the
     # points are measured from.
-    def offset_x = drawn.map(&:x).push(@start_x).min
+    def offset_x
+      drawn.map(&:x).push(@start_x).min
+    end
 
-    def offset_y = drawn.map(&:y).push(@start_y).min
+    def offset_y
+      drawn.map(&:y).push(@start_y).min
+    end
 
-    def inspect = "#<Pptx::FreeformBuilder #{size} operations>"
+    def inspect
+      "#<Pptx::FreeformBuilder #{size} operations>"
+    end
 
     private
 
@@ -103,10 +113,14 @@ module Pptx
     # Rounded half-to-even, because Python rounds that way and Ruby rounds
     # half-up: a coordinate of 100.5 would otherwise land a unit away from
     # where the reference implementation puts it.
-    def round(value) = value.round(half: :even)
+    def round(value)
+      value.round(half: :even)
+    end
 
     # Operations that have a position; a close does not.
-    def drawn = @operations.reject { |operation| operation.kind == :close }
+    def drawn
+      @operations.reject { |operation| operation.kind == :close }
+    end
 
     def local_width
       xs = drawn.map(&:x).push(@start_x)
@@ -118,17 +132,27 @@ module Pptx
       ys.max - ys.min
     end
 
-    def width = (local_width * @x_scale).round
+    def width
+      (local_width * @x_scale).round
+    end
 
-    def height = (local_height * @y_scale).round
+    def height
+      (local_height * @y_scale).round
+    end
 
-    def left = (offset_x * @x_scale).round
+    def left
+      (offset_x * @x_scale).round
+    end
 
-    def top = (offset_y * @y_scale).round
+    def top
+      (offset_y * @y_scale).round
+    end
 
     # Points inside a path are relative to the shape's top-left corner, not to
     # the local origin.
-    def to_shape_space(x, y) = [x - offset_x, y - offset_y]
+    def to_shape_space(x, y)
+      [x - offset_x, y - offset_y]
+    end
 
     def apply(operation, path)
       case operation.kind

data/lib/ruby_pptx/shapes/placeholder.rb

@@ -13,13 +13,26 @@ module Pptx
   # Writing is not inherited -- setting a value applies it to this shape, which
   # is what stops it tracking the layout from then on.
   module InheritsDimensions
-    def left = effective(:left)
-    def top = effective(:top)
-    def width = effective(:width)
-    def height = effective(:height)
+    def left
+      effective(:left)
+    end
+
+    def top
+      effective(:top)
+    end
+
+    def width
+      effective(:width)
+    end
+
+    def height
+      effective(:height)
+    end
 
     # The placeholder one level up that this one inherits from, or nil.
-    def base_placeholder = raise(NotImplementedError, "#{self.class} must define base_placeholder")
+    def base_placeholder
+      raise(NotImplementedError, "#{self.class} must define base_placeholder")
+    end
 
     private
 
@@ -42,7 +55,9 @@ module Pptx
   class SlidePlaceholder < Shape
     include InheritsDimensions
 
-    def shape_type = Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    end
 
     # Matched to the layout by `idx`, which is what ties the two together.
     def base_placeholder
@@ -63,9 +78,9 @@ module Pptx
     # Put +new_element+ where this placeholder is and move the `p:ph` onto
     # it. The original element leaves the tree; this object is spent.
     def replace_placeholder_with(new_element)
-      adopted = @element.build_from_xml(new_element.node.to_xml)
+      adopted = @element.import(new_element)
       adopted.nvXxPr.nvPr.insert_ph(@element.ph)
-      @element.node.add_previous_sibling(adopted.node)
+      @element.add_previous_sibling(adopted)
       @element.parent.remove(@element)
       ShapeFactory.build_for_slide(adopted, @parent)
     end
@@ -129,14 +144,20 @@ module Pptx
   class PlaceholderPicture < Picture
     include InheritsDimensions
 
-    def shape_type = Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    end
 
-    def base_placeholder = part.slide_layout.placeholders.by_idx(element.ph_idx)
+    def base_placeholder
+      part.slide_layout.placeholders.by_idx(element.ph_idx)
+    end
   end
 
   # A table or chart that fills a placeholder.
   class PlaceholderGraphicFrame < GraphicFrame
-    def placeholder? = true
+    def placeholder?
+      true
+    end
   end
 
   # A placeholder on a slide layout.
@@ -153,7 +174,9 @@ module Pptx
       DATE: :DATE, FOOTER: :FOOTER, SLIDE_NUMBER: :SLIDE_NUMBER
     }.freeze
 
-    def shape_type = Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    end
 
     def base_placeholder
       base_type = BASE_TYPES[element.ph_type&.name]
@@ -169,9 +192,13 @@ module Pptx
   class NotesSlidePlaceholder < Shape
     include InheritsDimensions
 
-    def shape_type = Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    end
 
-    def base_placeholder = part.notes_master.placeholders.by_type(element.ph_type)
+    def base_placeholder
+      part.notes_master.placeholders.by_type(element.ph_type)
+    end
   end
 
   # A placeholder on a slide master.
@@ -179,6 +206,8 @@ module Pptx
   # There is nothing above a master to inherit from, so its geometry is
   # whatever it carries itself.
   class MasterPlaceholder < Shape
-    def shape_type = Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::PLACEHOLDER
+    end
   end
 end

data/lib/ruby_pptx/shapes/shape.rb

@@ -8,7 +8,9 @@ require "ruby_pptx/table"
 module Pptx
   # A `p:sp`: an auto shape, a text box, or a placeholder.
   class Shape < BaseShape
-    def text_frame? = true
+    def text_frame?
+      true
+    end
 
     # The text inside this shape, creating an empty text body if it has none.
     def text_frame
@@ -16,27 +18,37 @@ module Pptx
     end
 
     # Shortcut for `text_frame.text`.
-    def text = text_frame.text
+    def text
+      text_frame.text
+    end
 
     def text=(value)
       text_frame.text = value
     end
 
     # The shape's fill.
-    def fill = @fill ||= FillFormat.from_fill_parent(@element.spPr)
+    def fill
+      @fill ||= FillFormat.from_fill_parent(@element.spPr)
+    end
 
     # The shape's outline.
-    def line = @line ||= LineFormat.new(@element.spPr)
+    def line
+      @line ||= LineFormat.new(@element.spPr)
+    end
 
     # The adjustment handles of this shape's geometry; empty for a freeform.
     #
     # @return [Adjustments]
-    def adjustments = @adjustments ||= Adjustments.new(@element.spPr.prstGeom)
+    def adjustments
+      @adjustments ||= Adjustments.new(@element.spPr.prstGeom)
+    end
 
     # The preset geometry of an auto shape.
     #
     # @return [Pptx::Enum::MSO_SHAPE, nil] nil unless this is an auto shape
-    def auto_shape_type = @element.autoshape? ? @element.prst : nil
+    def auto_shape_type
+      @element.autoshape? ? @element.prst : nil
+    end
 
     def shape_type
       return Enum::MSO_SHAPE_TYPE::PLACEHOLDER if placeholder?
@@ -60,12 +72,16 @@ module Pptx
     end
 
     # The outline drawn around the picture.
-    def line = @line ||= LineFormat.new(@element.spPr)
+    def line
+      @line ||= LineFormat.new(@element.spPr)
+    end
   end
 
   # A `p:pic` showing a still image.
   class Picture < BasePicture
-    def shape_type = Enum::MSO_SHAPE_TYPE::PICTURE
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::PICTURE
+    end
 
     # The image this picture shows: its bytes, format, size and resolution.
     #
@@ -82,7 +98,9 @@ module Pptx
     # which crops nothing; an ellipse shows it through an oval.
     #
     # @return [Pptx::Enum::Member, nil] nil for a freeform mask, or no geometry
-    def auto_shape_type = @element.spPr.prstGeom&.prst
+    def auto_shape_type
+      @element.spPr.prstGeom&.prst
+    end
 
     def auto_shape_type=(value)
       member = Enum::MSO_AUTO_SHAPE_TYPE.fetch(value)
@@ -101,9 +119,13 @@ module Pptx
   # Not a {Picture}: the image a movie holds is its poster frame, which is
   # what {#poster_frame} returns, and a movie cannot be masked by a shape.
   class Movie < BasePicture
-    def shape_type = Enum::MSO_SHAPE_TYPE::MEDIA
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::MEDIA
+    end
 
-    def media_type = Enum::PP_MEDIA_TYPE::MOVIE
+    def media_type
+      Enum::PP_MEDIA_TYPE::MOVIE
+    end
 
     # The still shown before the movie plays, or nil if there is none.
     #
@@ -116,7 +138,9 @@ module Pptx
     # Playback settings. PowerPoint keeps these in the timing tree and
     # python-pptx exposes none of them yet; the object exists so code written
     # against either library finds it.
-    def media_format = @media_format ||= MediaFormat.new(@element)
+    def media_format
+      @media_format ||= MediaFormat.new(@element)
+    end
   end
 
   # Playback formatting for a movie. Deliberately empty; see {Movie#media_format}.
@@ -128,29 +152,41 @@ module Pptx
   # points, so moving an end point may flip the box rather than move it. The
   # accessors here hide that.
   class Connector < BaseShape
-    def shape_type = Enum::MSO_SHAPE_TYPE::LINE
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::LINE
+    end
 
-    def line = @line ||= LineFormat.new(@element.spPr)
+    def line
+      @line ||= LineFormat.new(@element.spPr)
+    end
 
-    def begin_x = Length.emu(@element.flipH ? left.to_i + width.to_i : left.to_i)
+    def begin_x
+      Length.emu(@element.flipH ? left.to_i + width.to_i : left.to_i)
+    end
 
     def begin_x=(value)
       move_x(Length.coerce(value).emu, begin_point: true)
     end
 
-    def begin_y = Length.emu(@element.flipV ? top.to_i + height.to_i : top.to_i)
+    def begin_y
+      Length.emu(@element.flipV ? top.to_i + height.to_i : top.to_i)
+    end
 
     def begin_y=(value)
       move_y(Length.coerce(value).emu, begin_point: true)
     end
 
-    def end_x = Length.emu(@element.flipH ? left.to_i : left.to_i + width.to_i)
+    def end_x
+      Length.emu(@element.flipH ? left.to_i : left.to_i + width.to_i)
+    end
 
     def end_x=(value)
       move_x(Length.coerce(value).emu, begin_point: false)
     end
 
-    def end_y = Length.emu(@element.flipV ? top.to_i : top.to_i + height.to_i)
+    def end_y
+      Length.emu(@element.flipV ? top.to_i : top.to_i + height.to_i)
+    end
 
     def end_y=(value)
       move_y(Length.coerce(value).emu, begin_point: false)
@@ -183,9 +219,13 @@ module Pptx
       self
     end
 
-    def begin_connected? = !@element.nvCxnSpPr.cNvCxnSpPr.stCxn.nil?
+    def begin_connected?
+      !@element.nvCxnSpPr.cNvCxnSpPr.stCxn.nil?
+    end
 
-    def end_connected? = !@element.nvCxnSpPr.cNvCxnSpPr.endCxn.nil?
+    def end_connected?
+      !@element.nvCxnSpPr.cNvCxnSpPr.endCxn.nil?
+    end
 
     def inspect
       "#<Pptx::Connector (#{begin_x.inches.round(2)}, #{begin_y.inches.round(2)}) -> " \
@@ -238,8 +278,13 @@ module Pptx
       raise Error, "a graphic frame has no shadow of its own; format the chart or table instead"
     end
 
-    def table? = @element.table?
-    def chart? = @element.chart?
+    def table?
+      @element.table?
+    end
+
+    def chart?
+      @element.chart?
+    end
 
     # The table inside this frame.
     #
@@ -274,7 +319,9 @@ module Pptx
       end
     end
 
-    def ole_object? = @element.ole_object?
+    def ole_object?
+      @element.ole_object?
+    end
 
     # The OLE object this frame holds.
     #
@@ -300,12 +347,18 @@ module Pptx
     end
 
     # The ProgID naming the program that opens the object, e.g. "Excel.Sheet.12".
-    def prog_id = @element.progId
+    def prog_id
+      @element.progId
+    end
 
     # Whether it appears as an icon rather than as a picture of its content.
-    def show_as_icon? = @element.showAsIcon
+    def show_as_icon?
+      @element.showAsIcon
+    end
 
-    def inspect = "#<Pptx::OleFormat #{prog_id.inspect}>"
+    def inspect
+      "#<Pptx::OleFormat #{prog_id.inspect}>"
+    end
   end
 
   # A `p:grpSp` containing other shapes.
@@ -314,15 +367,23 @@ module Pptx
   # contains, and are recomputed whenever its contents change.
   class GroupShape < BaseShape
     # A group keeps its effects in `p:grpSpPr` rather than `p:spPr`.
-    def shadow = @shadow ||= ShadowFormat.new(@element.grpSpPr)
+    def shadow
+      @shadow ||= ShadowFormat.new(@element.grpSpPr)
+    end
 
-    def shape_type = Enum::MSO_SHAPE_TYPE::GROUP
+    def shape_type
+      Enum::MSO_SHAPE_TYPE::GROUP
+    end
 
     # The shapes inside this group.
-    def shapes = @shapes ||= GroupShapes.new(@element, self)
+    def shapes
+      @shapes ||= GroupShapes.new(@element, self)
+    end
 
     # A group holds no text of its own, though the shapes in it may.
-    def text_frame? = false
+    def text_frame?
+      false
+    end
 
     # PowerPoint offers no click behaviour on a group; the shapes inside carry
     # their own.