openxml-package 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4897a42b3b6601e4c9592fd0a0dfb280d00924bc
-  data.tar.gz: e897af932351b707af9c4b954eb64437dcb85db3
+  metadata.gz: 1a0436dc9e0622316c63a9a049ebe243ebe50bd0
+  data.tar.gz: f598315aff5dea761320ef51fe2f64709bba9073
 SHA512:
-  metadata.gz: 8ef6f7fd79923969da139af148dcb8ee285216d7794a24ee5d6e74602a9ac6ba7fe05f95bdef3b6ac877fd59900210f3742f9658296c2e40f53909c40839238c
-  data.tar.gz: 94c22130fd32fca51a16ed4714534aa141a84c4a89e1399723ce4867b736cb3d440e9e134e045c21f663d3071df368483f233879540e267c335e150974d4573b
+  metadata.gz: c19ae66a76c4abcd5a4c431e567a0cf55060e35827afba22c2ba27bc35d9f7d1773c009e55b9e3a48d61221aca7c3811ec2a9907f6517432d7df7eebdcbd21ed
+  data.tar.gz: 2c17f6398cd89b909e36e8d3dd6d42a5f761ae7df2da319cf5ca99b609eb17a6c9e82dab5496cc13a5521dfc0e745a0ea2365589494ece87820fa919a7eed6d3

data/lib/openxml-package/version.rb

@@ -1,3 +1,3 @@
 module OpenXmlPackage
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/openxml/contains_properties.rb

@@ -13,11 +13,16 @@ module OpenXml
     module InstanceMethods
 
       def property_xml(xml)
+        ensure_required_choices
         props = active_properties
         return unless render_properties? props
         props.each { |prop| prop.to_xml(xml) }
       end
 
+      def properties_attributes
+        {}
+      end
+
     end
 
   end

data/lib/openxml/has_attributes.rb

@@ -1,3 +1,5 @@
+require "openxml/unmet_requirement"
+
 module OpenXml
   module HasAttributes
 
@@ -7,10 +9,12 @@ module OpenXml
 
     module ClassMethods
 
-      def attribute(name, expects: nil, one_of: nil, in_range: nil, displays_as: nil, namespace: nil, matches: nil, validation: nil, deprecated: false)
+      def attribute(name, expects: nil, one_of: nil, in_range: nil, displays_as: nil, namespace: nil, matches: nil, validation: nil, required: false, deprecated: false)
         bad_names = %w{ tag name namespace properties_tag }
         raise ArgumentError if bad_names.member? name.to_s
 
+        required_attributes.push(name) if required
+
         attr_reader name
 
         define_method "#{name}=" do |value|
@@ -27,17 +31,21 @@ module OpenXml
       end
 
       def attributes
-        @attributes ||= begin
+        @attributes ||= {}.tap do |attrs|
           if superclass.respond_to?(:attributes)
-            Hash[superclass.attributes.map { |name, attribute|
-              [ name, attribute.dup ]
-            }]
-          else
-            {}
+            superclass.attributes.each do |key, value|
+              attrs[key] = value.dup
+            end
           end
         end
       end
 
+      def required_attributes
+        @required_attributes ||= [].tap do |attrs|
+          attrs.push(*superclass.required_attributes) if superclass.respond_to?(:required_attributes)
+        end
+      end
+
       def with_namespace(namespace, &block)
         @attribute_namespace = namespace
         instance_eval(&block)
@@ -57,9 +65,14 @@ module OpenXml
       self.class.attributes
     end
 
+    def required_attributes
+      self.class.required_attributes
+    end
+
   private
 
     def xml_attributes
+      ensure_required_attributes_set
       attributes.each_with_object({}) do |(name, options), attrs|
         display, namespace = options
         value = send(name)
@@ -69,6 +82,14 @@ module OpenXml
       end
     end
 
+    def ensure_required_attributes_set
+      unset_attributes = required_attributes.reject do |attr|
+        instance_variable_defined?("@#{attr}")
+      end
+      message = "Required attribute(s) #{unset_attributes.join(", ")} have not been set"
+      raise OpenXml::UnmetRequirementError, message if unset_attributes.any?
+    end
+
     def boolean(value)
       message = "Invalid #{name}: frame must be true or false"
       raise ArgumentError, message unless [true, false].member? value
@@ -114,6 +135,11 @@ module OpenXml
       raise ArgumentError, message if !value.is_a?(String) || value.length.zero?
     end
 
+    def string_or_blank(value)
+      message = "Invalid #{name}: must be a string, even if the string is empty"
+      raise ArgumentError, message unless value.is_a?(String)
+    end
+
     def in_range?(value, range)
       message = "Invalid #{name}: must be a number between #{range.begin} and #{range.end}"
       raise ArgumentError, message unless range.include?(value.to_i)

data/lib/openxml/has_properties.rb

@@ -1,3 +1,5 @@
+require "openxml/unmet_requirement"
+
 module OpenXml
   module HasProperties
 
@@ -14,12 +16,13 @@ module OpenXml
         @properties_tag ||= nil
       end
 
-      def value_property(name, as: nil, klass: nil)
+      def value_property(name, as: nil, klass: nil, required: false, default_value: nil)
         attr_reader name
 
         properties[name] = (as || name).to_s
+        required_properties[name] = default_value if required
         classified_name = properties[name].split("_").map(&:capitalize).join
-        class_name = klass.name unless klass.nil?
+        class_name = klass.to_s unless klass.nil?
         class_name ||= (to_s.split("::")[0...-2] + ["Properties", classified_name]).join("::")
 
         (choice_groups[current_group] ||= []).push(name) unless current_group.nil?
@@ -33,17 +36,18 @@ module OpenXml
         CODE
       end
 
-      def property(name, as: nil, klass: nil)
+      def property(name, as: nil, klass: nil, required: false)
         properties[name] = (as || name).to_s
+        required_properties[name] = true if required
         classified_name = properties[name].split("_").map(&:capitalize).join
-        class_name = klass.name unless klass.nil?
+        class_name = klass.to_s 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?
+          unless instance_variable_defined?("@#{name}")
             group_index = #{@current_group.inspect}
             ensure_unique_in_group(:#{name}, group_index) unless group_index.nil?
             instance_variable_set "@#{name}", #{class_name}.new(*args)
@@ -54,8 +58,9 @@ module OpenXml
         CODE
       end
 
-      def property_choice
+      def property_choice(required: false)
         @current_group = choice_groups.length
+        required_choices << @current_group if required
         yield
         @current_group = nil
       end
@@ -65,22 +70,26 @@ module OpenXml
       end
 
       def properties
-        @properties ||= begin
-          if superclass.respond_to?(:properties)
-            Hash[superclass.properties.map { |key, klass_name| [ key, klass_name.dup ] }]
-          else
-            {}
-          end
+        @properties ||= {}.tap do |props|
+          props.merge!(superclass.properties) if superclass.respond_to?(:properties)
         end
       end
 
       def choice_groups
-        @choice_groups ||= begin
-          if superclass.respond_to?(:choice_groups)
-            superclass.choice_groups.map(&:dup)
-          else
-            []
-          end
+        @choice_groups ||= [].tap do |choices|
+          choices.push(*superclass.choice_groups.map(&:dup)) if superclass.respond_to?(:choice_groups)
+        end
+      end
+
+      def required_properties
+        @required_properties ||= {}.tap do |props|
+          props.merge!(superclass.required_properties) if superclass.respond_to?(:required_properties)
+        end
+      end
+
+      def required_choices
+        @required_choices ||= [].tap do |choices|
+          choices.push(*superclass.required_choices) if superclass.respond_to?(:required_choices)
         end
       end
 
@@ -110,6 +119,11 @@ module OpenXml
 
     end
 
+    def initialize(*_args)
+      super
+      build_required_properties
+    end
+
     def properties_element
       @properties_element ||= self.class.properties_element.new
     end
@@ -131,6 +145,7 @@ module OpenXml
     end
 
     def property_xml(xml)
+      ensure_required_choices
       props = active_properties
       return unless render_properties? props
 
@@ -139,6 +154,13 @@ module OpenXml
       end
     end
 
+    def build_required_properties
+      required_properties.each do |prop, default_value|
+        public_send(:"#{prop}=", default_value) if respond_to? :"#{prop}="
+        public_send(:"#{prop}")
+      end
+    end
+
   private
 
     def properties
@@ -150,7 +172,9 @@ module OpenXml
     end
 
     def render_properties?(properties=active_properties)
-      properties.any?(&:render?) || properties_attributes.any?
+      properties.any?(&:render?) || properties_attributes.keys.any? do |key|
+        properties_element.instance_variable_defined?("@#{key}")
+      end
     end
 
     def properties_tag
@@ -165,12 +189,34 @@ module OpenXml
       self.class.choice_groups
     end
 
+    def required_properties
+      self.class.required_properties
+    end
+
+    def required_choices
+      self.class.required_choices
+    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}") }
+      unique = other_names.none? { |other_name| instance_variable_defined?("@#{other_name}") }
       message = "Property #{name} cannot also be set with #{other_names.join(", ")}."
       raise ChoiceGroupUniqueError, message unless unique
     end
 
+    def unmet_choices
+      required_choices.reject do |choice_index|
+        choice_groups[choice_index].one? do |prop_name|
+          instance_variable_defined?("@#{prop_name}")
+        end
+      end
+    end
+
+    def ensure_required_choices
+      unmet_choice_groups = unmet_choices.map { |index| choice_groups[index].join(", ") }
+      message = "Required choice from among group(s) (#{unmet_choice_groups.join("), (")}) not made"
+      raise OpenXml::UnmetRequirementError, message if unmet_choice_groups.any?
+    end
+
   end
 end

data/lib/openxml/parts/content_types.rb

@@ -40,7 +40,7 @@ module OpenXml
       end
 
       def to_xml
-        build_xml do |xml|
+        build_standalone_xml do |xml|
           xml.Types(xmlns: "http://schemas.openxmlformats.org/package/2006/content-types") {
             defaults.each { |extension, content_type| xml.Default("Extension" => extension, "ContentType" => content_type) }
             overrides.each { |part_name, content_type| xml.Override("PartName" => part_name, "ContentType" => content_type) }

data/lib/openxml/parts/rels.rb

@@ -23,7 +23,7 @@ module OpenXml
         end
       end
 
-      def add_relationship(type, target, id=nil, target_mode=nil)
+      def add_relationship(type, target, id=next_id, target_mode=nil)
         OpenXml::Elements::Relationship.new(type, target, id, target_mode).tap do |relationship|
           relationships.push relationship
         end
@@ -56,6 +56,11 @@ module OpenXml
     private
       attr_reader :relationships
 
+      def next_id
+        @current_id = (@current_id || 0) + 1
+        "rId#{@current_id}"
+      end
+
     end
   end
 end

data/lib/openxml/render_when_empty.rb

@@ -0,0 +1,9 @@
+module OpenXml
+  module RenderWhenEmpty
+
+    def render?
+      true
+    end
+
+  end
+end

data/lib/openxml/unmet_requirement.rb

@@ -0,0 +1,3 @@
+module OpenXml
+  class UnmetRequirementError < RuntimeError; end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openxml-package
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -221,8 +221,10 @@ files:
 - lib/openxml/properties/transparent_container_property.rb
 - lib/openxml/properties/value_property.rb
 - lib/openxml/relationship.rb
+- lib/openxml/render_when_empty.rb
 - lib/openxml/rubyzip_fix.rb
 - lib/openxml/types.rb
+- lib/openxml/unmet_requirement.rb
 - openxml-package.gemspec
 - tmp/.keep
 homepage: https://github.com/openxml/openxml-package