openxml-package 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c894c5ccef5327f4463ca9ddd3401bc6f3aa7e27
-  data.tar.gz: c34eb930e46eff3af421c9ac49bf0bedc78113d6
+  metadata.gz: d9d9d2bb9ed93cad6c56d2642cf32f5dec4a3196
+  data.tar.gz: 523d6f4d5e2c72c78f3a0210231d4e95cd98b38f
 SHA512:
-  metadata.gz: 2e6418b2b1dadf17009690fbfc6ada8d12f3e5b31493d4df9299bff672b8756098bb11d32c5fb9d3fe59180c7ee2838cf77ac167ca49b9ba6fe3120988cf3749
-  data.tar.gz: f2a422bb660b761956f6a76ec856697115cc0d9ecd08b8f138c6e4093a6a74a8e83d5e2fad8325f62fda30eb6ab88f7f767b5acaa31e976e2bc231774f353cc5
+  metadata.gz: d12159354e30a736f3b20694cde93ad3855ba4a5ac17146ef252c325262fe92aa4ddd292b9dcf6d851e329884a3feaf5587393802134e90411f80da2fd33b5f3
+  data.tar.gz: 9c8c076c937bfe168182dfe7ddae3f6b0efa6a6687607661949cfceb1dfe92fb7bacf3717a27532921fc8b05c6384e4f1cfbbc98afc5c71dc9b552170901a1cb

data/lib/openxml-package/version.rb

@@ -1,3 +1,3 @@
 module OpenXmlPackage
-  VERSION = "0.2.9"
+  VERSION = "0.3.0"
 end

data/lib/openxml/builder.rb

@@ -13,6 +13,7 @@ module OpenXml
     def initialize(options={})
       @to_s_options = { with_xml: true }
 
+      @ns = nil
       @document = Ox::Document.new(
         encoding: "UTF-8",
         version: "1.0",

data/lib/openxml/builder/element.rb

@@ -8,7 +8,7 @@ module OpenXml
       end
 
       def []=(attribute, value)
-        namespace_def = attribute.downcase.to_s.match /^xmlns(?:\:(?<prefix>.*))?$/
+        namespace_def = attribute.downcase.to_s.match(/^xmlns(?:\:(?<prefix>.*))?$/)
         namespaces << namespace_def[:prefix].to_sym if namespace_def && namespace_def[:prefix]
         super
       end

data/lib/openxml/contains_properties.rb

@@ -0,0 +1,24 @@
+require "openxml/has_properties"
+
+module OpenXml
+  module ContainsProperties
+
+    def self.included(base)
+      base.class_eval do
+        include HasProperties
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      def property_xml(xml)
+        props = active_properties
+        return unless render_properties? props
+        props.each { |prop| prop.to_xml(xml) }
+      end
+
+    end
+
+  end
+end

data/lib/openxml/element.rb

@@ -6,21 +6,20 @@ module OpenXml
 
     class << self
       attr_reader :property_name
-      attr_reader :namespace
 
       def tag(*args)
         @tag = args.first if args.any?
-        @tag
+        @tag ||= nil
       end
 
       def name(*args)
         @property_name = args.first if args.any?
-        @name
+        @property_name ||= nil
       end
 
       def namespace(*args)
         @namespace = args.first if args.any?
-        @namespace
+        @namespace ||= nil
       end
 
     end

data/lib/openxml/has_attributes.rb

@@ -6,9 +6,10 @@ module OpenXml
     end
 
     module ClassMethods
-      def attribute(name, expects: nil, one_of: nil, in_range: nil, displays_as: nil, namespace: nil, matches: nil, deprecated: false)
-        bad_names = %w(tag name namespace properties_tag)
-        raise ArgumentError if bad_names.member? name
+
+      def attribute(name, expects: nil, one_of: nil, in_range: nil, displays_as: nil, namespace: nil, matches: nil, validation: nil, deprecated: false)
+        bad_names = %w{ tag name namespace properties_tag }
+        raise ArgumentError if bad_names.member? name.to_s
 
         attr_reader name
 
@@ -17,21 +18,35 @@ module OpenXml
           send(expects, value) unless expects.nil?
           matches?(value, matches) unless matches.nil?
           in_range?(value, in_range) unless in_range.nil?
+          validation.call(value) if validation.respond_to? :call
           instance_variable_set "@#{name}", value
         end
 
         camelized_name = name.to_s.gsub(/_([a-z])/i) { $1.upcase }.to_sym
-        attributes[name] = [displays_as || camelized_name, namespace || @attribute_namespace]
+        attributes[name] = [displays_as || camelized_name, namespace || attribute_namespace]
       end
 
       def attributes
-        @attributes ||= {}
+        @attributes ||= begin
+          if superclass.respond_to?(:attributes)
+            Hash[superclass.attributes.map { |name, attribute|
+              [ name, attribute.dup ]
+            }]
+          else
+            {}
+          end
+        end
       end
 
       def with_namespace(namespace, &block)
         @attribute_namespace = namespace
         instance_eval(&block)
       end
+
+      def attribute_namespace
+        @attribute_namespace ||= nil
+      end
+
     end
 
     def render?
@@ -49,7 +64,7 @@ module OpenXml
         display, namespace = options
         value = send(name)
         attr_name = "#{namespace}:#{display}"
-        attr_name = "#{display}" if namespace.nil?
+        attr_name = display.to_s if namespace.nil?
         attrs[attr_name] = value unless value.nil?
       end
     end
@@ -110,7 +125,7 @@ module OpenXml
     end
 
     def on_or_off(value)
-      valid_in? value, [:on, :off]
+      valid_in? value, %i{ on off }
     end
 
     def valid_in?(value, list)

data/lib/openxml/has_children.rb

@@ -2,7 +2,8 @@ module OpenXml
   module HasChildren
     attr_reader :children
 
-    def initialize
+    def initialize(*)
+      super
       @children = []
     end
 
@@ -26,5 +27,6 @@ module OpenXml
     def render?
       super || children.any?
     end
+
   end
 end

data/lib/openxml/has_properties.rb

@@ -0,0 +1,176 @@
+module OpenXml
+  module HasProperties
+
+    class ChoiceGroupUniqueError < RuntimeError; end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def properties_tag(*args)
+        @properties_tag = args.first if args.any?
+        @properties_tag ||= nil
+      end
+
+      def value_property(name, as: nil, klass: nil)
+        attr_reader name
+
+        properties[name] = (as || name).to_s
+        classified_name = properties[name].split("_").map(&:capitalize).join
+        class_name = klass.name unless klass.nil?
+        class_name ||= (to_s.split("::")[0...-2] + ["Properties", classified_name]).join("::")
+
+        (choice_groups[current_group] ||= []).push(name) unless current_group.nil?
+
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{name}=(value)
+          group_index = #{@current_group.inspect}
+          ensure_unique_in_group(:#{name}, group_index) unless group_index.nil?
+          instance_variable_set "@#{name}", #{class_name}.new(value)
+        end
+        CODE
+      end
+
+      def property(name, as: nil, klass: nil)
+        properties[name] = (as || name).to_s
+        classified_name = properties[name].split("_").map(&:capitalize).join
+        class_name = klass.name unless klass.nil?
+        class_name ||= (to_s.split("::")[0...-2] + ["Properties", classified_name]).join("::")
+
+        (choice_groups[current_group] ||= []).push(name) unless current_group.nil?
+
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{name}(*args)
+          if instance_variable_get("@#{name}").nil?
+            group_index = #{@current_group.inspect}
+            ensure_unique_in_group(:#{name}, group_index) unless group_index.nil?
+            instance_variable_set "@#{name}", #{class_name}.new(*args)
+          end
+
+          instance_variable_get "@#{name}"
+        end
+        CODE
+      end
+
+      def property_choice
+        @current_group = choice_groups.length
+        yield
+        @current_group = nil
+      end
+
+      def current_group
+        @current_group ||= nil
+      end
+
+      def properties
+        @properties ||= begin
+          if superclass.respond_to?(:properties)
+            Hash[superclass.properties.map { |key, klass_name| [ key, klass_name.dup ] }]
+          else
+            {}
+          end
+        end
+      end
+
+      def choice_groups
+        @choice_groups ||= begin
+          if superclass.respond_to?(:choice_groups)
+            superclass.choice_groups.map(&:dup)
+          else
+            []
+          end
+        end
+      end
+
+      def properties_attribute(name, **args)
+        properties_element.attribute name, **args
+        define_method "#{name}=" do |value|
+          properties_element.public_send :"#{name}=", value
+        end
+
+        define_method name.to_s do
+          properties_element.public_send name.to_sym
+        end
+      end
+
+      def properties_element
+        this = self
+        parent_klass = superclass.respond_to?(:properties_element) ? superclass.properties_element : OpenXml::Element
+        @properties_element ||= Class.new(parent_klass) do
+          tag :"#{this.properties_tag || this.default_properties_tag}"
+          namespace :"#{this.namespace}"
+        end
+      end
+
+      def default_properties_tag
+        :"#{tag}Pr"
+      end
+
+    end
+
+    def properties_element
+      @properties_element ||= self.class.properties_element.new
+    end
+
+    def properties_attributes
+      properties_element.attributes
+    end
+
+    def render?
+      return true unless defined?(super)
+      render_properties? || super
+    end
+
+    def to_xml(xml)
+      super(xml) do
+        property_xml(xml)
+        yield xml if block_given?
+      end
+    end
+
+    def property_xml(xml)
+      props = active_properties
+      return unless render_properties? props
+
+      properties_element.to_xml(xml) do
+        props.each { |prop| prop.to_xml(xml) }
+      end
+    end
+
+  private
+
+    def properties
+      self.class.properties
+    end
+
+    def active_properties
+      properties.keys.map { |property| instance_variable_get("@#{property}") }.compact
+    end
+
+    def render_properties?(properties=active_properties)
+      properties.any?(&:render?) || properties_attributes.any?
+    end
+
+    def properties_tag
+      self.class.properties_tag || default_properties_tag
+    end
+
+    def default_properties_tag
+      :"#{tag}Pr"
+    end
+
+    def choice_groups
+      self.class.choice_groups
+    end
+
+    def ensure_unique_in_group(name, group_index)
+      other_names = (choice_groups[group_index] - [name])
+      unique = other_names.all? { |other_name| instance_variable_defined?("@#{other_name}") }
+      message = "Property #{name} cannot also be set with #{other_names.join(", ")}."
+      raise ChoiceGroupUniqueError, message unless unique
+    end
+
+  end
+end

data/lib/openxml/package.rb

@@ -18,7 +18,7 @@ module OpenXml
       end
 
       def content_types(&block)
-        content_types_presets.instance_eval &block
+        content_types_presets.instance_eval(&block)
       end
 
       def open(path)

data/lib/openxml/properties.rb

@@ -0,0 +1,22 @@
+module OpenXml
+  module Properties
+  end
+end
+
+require "openxml/properties/base_property"
+require "openxml/properties/complex_property"
+require "openxml/properties/value_property"
+
+require "openxml/properties/boolean_property"
+require "openxml/properties/integer_property"
+require "openxml/properties/positive_integer_property"
+require "openxml/properties/string_property"
+require "openxml/properties/on_off_property"
+require "openxml/properties/toggle_property"
+
+require "openxml/properties/container_property"
+require "openxml/properties/transparent_container_property"
+
+Dir.glob(File.join(File.dirname(__FILE__), "properties", "*.rb").to_s).each do |file|
+  require file
+end

data/lib/openxml/properties/base_property.rb

@@ -0,0 +1,81 @@
+module OpenXml
+  module Properties
+    class BaseProperty
+      attr_reader :value
+
+      class << self
+        attr_reader :property_name
+        attr_reader :allowed_tags
+
+        def tag_is_one_of(tags)
+          attr_accessor :tag
+          @allowed_tags = tags
+        end
+
+        def tag(*args)
+          @tag = args.first if args.any?
+          @tag ||= nil
+        end
+
+        def name(*args)
+          @property_name = args.first if args.any?
+          @property_name ||= nil
+        end
+
+        def namespace(*args)
+          @namespace = args.first if args.any?
+          @namespace ||= nil
+        end
+
+      end
+
+      def initialize(tag=nil, *_args)
+        return unless self.class.allowed_tags
+        validate_tag tag
+        @tag = tag
+      end
+
+      def validate_tag(tag)
+        return if self.class.allowed_tags.include?(tag)
+        allowed = self.class.allowed_tags.join(", ")
+        message = "Invalid tag name for #{name}: #{tag.inspect}. It should be one of #{allowed}."
+        raise ArgumentError, message
+      end
+
+      def render?
+        !value.nil?
+      end
+
+      def name
+        self.class.property_name || default_name
+      end
+
+      def default_name
+        class_name.gsub(/(.)([A-Z])/, '\1_\2').downcase
+      end
+
+      def tag
+        self.class.tag || default_tag
+      end
+
+      def default_tag
+        (class_name[0, 1].downcase + class_name[1..-1]).to_sym
+      end
+
+      def namespace
+        self.class.namespace
+      end
+
+    private
+
+      def apply_namespace(xml)
+        namespace.nil? ? xml : xml[namespace]
+      end
+
+      def class_name
+        self.class.to_s.split(/::/).last
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/boolean_property.rb

@@ -0,0 +1,15 @@
+module OpenXml
+  module Properties
+    class BooleanProperty < ValueProperty
+
+      def ok_values
+        [nil, true, false]
+      end
+
+      def to_xml(xml)
+        super if value
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/complex_property.rb

@@ -0,0 +1,21 @@
+require "openxml/has_attributes"
+
+module OpenXml
+  module Properties
+    class ComplexProperty < BaseProperty
+      include HasAttributes
+
+      def to_xml(xml)
+        return unless render?
+        apply_namespace(xml).public_send(tag, xml_attributes) do
+          yield xml if block_given?
+        end
+      end
+
+      def render?
+        !xml_attributes.empty?
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/container_property.rb

@@ -0,0 +1,70 @@
+require "openxml/has_attributes"
+
+module OpenXml
+  module Properties
+    class ContainerProperty < BaseProperty
+      include Enumerable
+      include HasAttributes
+
+      class << self
+
+        def child_class(*args)
+          unless args.empty?
+            @child_classes = args.map { |arg|
+              prop_name = arg.to_s.split(/_/).map(&:capitalize).join # LazyCamelCase
+              const_name = (self.to_s.split(/::/)[0...-1] + [prop_name]).join("::")
+              Object.const_get const_name
+            }
+          end
+
+          @child_classes
+        end
+        alias child_classes child_class
+
+      end
+
+      def initialize
+        @children = []
+      end
+
+      def <<(child)
+        raise ArgumentError, invalid_child_message unless valid_child?(child)
+        children << child
+      end
+
+      def each(*args, &block)
+        children.each(*args, &block)
+      end
+
+      def render?
+        !children.length.zero?
+      end
+
+      def to_xml(xml)
+        return unless render?
+
+        apply_namespace(xml).public_send(tag, xml_attributes) {
+          each { |child| child.to_xml(xml) }
+        }
+      end
+
+    private
+
+      attr_reader :children
+
+      def invalid_child_message
+        class_name = self.class.to_s.split(/::/).last
+        "#{class_name} must be instances of one of the following: #{child_classes}"
+      end
+
+      def valid_child?(child)
+        child_classes.any? { |child_class| child.is_a?(child_class) }
+      end
+
+      def child_classes
+        self.class.child_classes
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/integer_property.rb

@@ -0,0 +1,15 @@
+module OpenXml
+  module Properties
+    class IntegerProperty < ValueProperty
+
+      def valid?
+        value.is_a? Integer
+      end
+
+      def invalid_message
+        "Invalid #{name}: must be an integer"
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/on_off_property.rb

@@ -0,0 +1,21 @@
+module OpenXml
+  module Properties
+    class OnOffProperty < ValueProperty
+
+      def ok_values
+        [true, false, :on, :off] # :on and :off are from the Transitional Spec
+      end
+
+      def to_xml(xml)
+        if value == true
+          apply_namespace(xml).public_send(tag) do
+            yield xml if block_given?
+          end
+        else
+          super
+        end
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/positive_integer_property.rb

@@ -0,0 +1,15 @@
+module OpenXml
+  module Properties
+    class PositiveIntegerProperty < IntegerProperty
+
+      def valid?
+        super && value >= 0
+      end
+
+      def invalid_message
+        "Invalid #{name}: must be a positive integer"
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/string_property.rb

@@ -0,0 +1,15 @@
+module OpenXml
+  module Properties
+    class StringProperty < ValueProperty
+
+      def valid?
+        value.is_a?(String) && !value.length.zero?
+      end
+
+      def invalid_message
+        "Invalid value for #{name}; string expected (provided: #{value.inspect})"
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/toggle_property.rb

@@ -0,0 +1,11 @@
+module OpenXml
+  module Properties
+    class ToggleProperty < OnOffProperty
+      # Toggle properties are no different in representation than on/off properties;
+      # rather, the difference is in how they compose with one another (cf.
+      # Section 17.7.3). It's helpful, then, to retain the concept, but entirely
+      # unnecessary to duplicate implementation.
+      # cf. Section A.6.9 of the spec, and Section A.7.9 of the transitional spec.
+    end
+  end
+end

data/lib/openxml/properties/transparent_container_property.rb

@@ -0,0 +1,12 @@
+module OpenXml
+  module Properties
+    class TransparentContainerProperty < ContainerProperty
+
+      def to_xml(xml)
+        return unless render?
+        each { |child| child.to_xml(xml) }
+      end
+
+    end
+  end
+end

data/lib/openxml/properties/value_property.rb

@@ -0,0 +1,37 @@
+module OpenXml
+  module Properties
+    class ValueProperty < BaseProperty
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+        raise ArgumentError, invalid_message unless valid?
+      end
+
+      def valid?
+        ok_values.member? value
+      end
+
+      def invalid_message
+        "#{value.inspect} is an invalid value for #{name}; acceptable: #{ok_values.join(", ")}"
+      end
+
+      def render?
+        !value.nil?
+      end
+
+      def to_xml(xml)
+        apply_namespace(xml).public_send(tag, :"#{value_attribute}" => value) do
+          yield xml if block_given?
+        end
+      end
+
+    private
+
+      def value_attribute
+        namespace.nil? ? "val" : "#{namespace}:val"
+      end
+
+    end
+  end
+end

data/lib/openxml/rubyzip_fix.rb

@@ -4,10 +4,12 @@ module Zip
   class InputStream
   protected
 
+    alias _old_get_io get_io
+
     # The problem in RubyZip 1.1.0 is that we only call `seek`
     # when `io` is a File. We need to move the cursor to the
     # right position when `io` is a StringIO as well.
-    def get_io(io, offset = 0)
+    def get_io(io, offset=0)
       io = ::File.open(io, "rb") unless io.is_a?(IO) || io.is_a?(StringIO)
       io.seek(offset, ::IO::SEEK_SET)
       io

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openxml-package
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -195,17 +195,31 @@ files:
 - lib/openxml-package/version.rb
 - lib/openxml/builder.rb
 - lib/openxml/builder/element.rb
+- lib/openxml/contains_properties.rb
 - lib/openxml/content_types_presets.rb
 - lib/openxml/element.rb
 - lib/openxml/errors.rb
 - lib/openxml/has_attributes.rb
 - lib/openxml/has_children.rb
+- lib/openxml/has_properties.rb
 - lib/openxml/package.rb
 - lib/openxml/part.rb
 - lib/openxml/parts.rb
 - lib/openxml/parts/content_types.rb
 - lib/openxml/parts/rels.rb
 - lib/openxml/parts/unparsed_part.rb
+- lib/openxml/properties.rb
+- lib/openxml/properties/base_property.rb
+- lib/openxml/properties/boolean_property.rb
+- lib/openxml/properties/complex_property.rb
+- lib/openxml/properties/container_property.rb
+- lib/openxml/properties/integer_property.rb
+- lib/openxml/properties/on_off_property.rb
+- lib/openxml/properties/positive_integer_property.rb
+- lib/openxml/properties/string_property.rb
+- lib/openxml/properties/toggle_property.rb
+- lib/openxml/properties/transparent_container_property.rb
+- lib/openxml/properties/value_property.rb
 - lib/openxml/relationship.rb
 - lib/openxml/rubyzip_fix.rb
 - lib/openxml/types.rb