openxml-package 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b8b8727009d5a81ee13ed1fb5543abf6a85811f
-  data.tar.gz: c4d7e5c4845e6dd2c1906020fdfda4215692ec09
+  metadata.gz: c894c5ccef5327f4463ca9ddd3401bc6f3aa7e27
+  data.tar.gz: c34eb930e46eff3af421c9ac49bf0bedc78113d6
 SHA512:
-  metadata.gz: bb19edd1f90e92b0784dd8ff54e752c204a1e83d22074dc0d44b1cfb6b0b2423ddd2d7c69f6216c8fc015984c3fad0cb99019d17f49f7e143208b54ac7bad3be
-  data.tar.gz: b714390cb65eda06f274d50fbd0c8f2c79ffc4bb4ac0ce90f3b083ece9d7043286f1430e4e533175b181df94efa7f4d7691dc2103d321753cb7650df141a39e0
+  metadata.gz: 2e6418b2b1dadf17009690fbfc6ada8d12f3e5b31493d4df9299bff672b8756098bb11d32c5fb9d3fe59180c7ee2838cf77ac167ca49b9ba6fe3120988cf3749
+  data.tar.gz: f2a422bb660b761956f6a76ec856697115cc0d9ecd08b8f138c6e4093a6a74a8e83d5e2fad8325f62fda30eb6ab88f7f767b5acaa31e976e2bc231774f353cc5

data/lib/openxml-package/version.rb

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

data/lib/openxml/element.rb

@@ -0,0 +1,69 @@
+require "openxml/has_attributes"
+
+module OpenXml
+  class Element
+    include HasAttributes
+
+    class << self
+      attr_reader :property_name
+      attr_reader :namespace
+
+      def tag(*args)
+        @tag = args.first if args.any?
+        @tag
+      end
+
+      def name(*args)
+        @property_name = args.first if args.any?
+        @name
+      end
+
+      def namespace(*args)
+        @namespace = args.first if args.any?
+        @namespace
+      end
+
+    end
+
+    def tag
+      self.class.tag || default_tag
+    end
+
+    def name
+      self.class.property_name || default_name
+    end
+
+    def namespace
+      ([self.class] + self.class.ancestors).select { |klass| klass.respond_to?(:namespace) }.map(&:namespace).find(&:itself)
+    end
+
+    def to_xml(xml)
+      raise UndefinedNamespaceError, self.class unless namespace
+
+      xml[namespace].public_send(tag, xml_attributes) do
+        yield xml if block_given?
+      end
+    end
+
+  private
+
+    def default_tag
+      (class_name[0, 1].downcase + class_name[1..-1]).to_sym
+    end
+
+    def default_name
+      class_name.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    end
+
+    def class_name
+      self.class.to_s.split(/::/).last
+    end
+
+  end
+
+  class UndefinedNamespaceError < RuntimeError
+    def initialize(klass)
+      super "#{klass} does not define its namespace"
+    end
+  end
+end

data/lib/openxml/has_attributes.rb

@@ -0,0 +1,127 @@
+module OpenXml
+  module HasAttributes
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    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
+
+        attr_reader name
+
+        define_method "#{name}=" do |value|
+          valid_in?(value, one_of) unless one_of.nil?
+          send(expects, value) unless expects.nil?
+          matches?(value, matches) unless matches.nil?
+          in_range?(value, in_range) unless in_range.nil?
+          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]
+      end
+
+      def attributes
+        @attributes ||= {}
+      end
+
+      def with_namespace(namespace, &block)
+        @attribute_namespace = namespace
+        instance_eval(&block)
+      end
+    end
+
+    def render?
+      attributes.keys.map(&method(:send)).any?
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+  private
+
+    def xml_attributes
+      attributes.each_with_object({}) do |(name, options), attrs|
+        display, namespace = options
+        value = send(name)
+        attr_name = "#{namespace}:#{display}"
+        attr_name = "#{display}" if namespace.nil?
+        attrs[attr_name] = value unless value.nil?
+      end
+    end
+
+    def boolean(value)
+      message = "Invalid #{name}: frame must be true or false"
+      raise ArgumentError, message unless [true, false].member? value
+    end
+
+    def hex_color(value)
+      message = "Invalid #{name}: must be :auto or a hex color, e.g. 4F1B8C"
+      raise ArgumentError, message unless value == :auto || value =~ /^[0-9A-F]{6}$/
+    end
+
+    def hex_digit(value)
+      message = "Invalid #{name}: must be a two-digit hex number, e.g. BF"
+      raise ArgumentError, message unless value =~ /^[0-9A-F]{2}$/
+    end
+
+    def hex_digit_4(value)
+      message = "Invalid #{name}: must be a four-digit hex number, e.g. BF12"
+      raise ArgumentError, message unless value =~ /^[0-9A-F]{4}$/
+    end
+
+    def long_hex_number(value)
+      message = "Invalid #{name}: must be an eight-digit hex number, e.g., FFAC0013"
+      raise ArgumentError, message unless value =~ /^[0-9A-F]{8}$/
+    end
+
+    def hex_string(value)
+      message = "Invalid #{name}: must be a string of hexadecimal numbers, e.g. FFA23C6E"
+      raise ArgumentError, message unless value =~ /^[0-9A-F]+$/
+    end
+
+    def integer(value)
+      message = "Invalid #{name}: must be an integer"
+      raise ArgumentError, message unless value.is_a?(Integer)
+    end
+
+    def positive_integer(value)
+      message = "Invalid #{name}: must be a positive integer"
+      raise ArgumentError, message unless value.is_a?(Integer) && value >= 0
+    end
+
+    def string(value)
+      message = "Invalid #{name}: must be a string"
+      raise ArgumentError, message if !value.is_a?(String) || value.length.zero?
+    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)
+    end
+
+    def percentage(value)
+      message = "Invalid #{name}: must be a percentage"
+      raise ArgumentError, message unless value.is_a?(String) && value =~ /-?[0-9]+(\.[0-9]+)?%/ # Regex supplied in sec. 22.9.2.9 of Office Open XML docs
+    end
+
+    def on_or_off(value)
+      valid_in? value, [:on, :off]
+    end
+
+    def valid_in?(value, list)
+      message = "Invalid #{name}: must be one of #{list} (was #{value.inspect})"
+      raise ArgumentError, message unless list.member?(value)
+    end
+
+    def matches?(value, regexp)
+      message = "Value does not match #{regexp}"
+      raise ArgumentError, message unless value =~ regexp
+    end
+
+  end
+end

data/lib/openxml/has_children.rb

@@ -0,0 +1,30 @@
+module OpenXml
+  module HasChildren
+    attr_reader :children
+
+    def initialize
+      @children = []
+    end
+
+    def <<(child)
+      children << child
+    end
+
+    def push(child)
+      children.push(child)
+    end
+
+    def to_xml(xml)
+      super(xml) do
+        yield xml if block_given?
+        children.each do |child|
+          child.to_xml(xml)
+        end
+      end
+    end
+
+    def render?
+      super || children.any?
+    end
+  end
+end

data/lib/openxml/parts/rels.rb

@@ -1,4 +1,5 @@
 require "securerandom"
+require "openxml/relationship"
 require "nokogiri"
 
 module OpenXml
@@ -23,11 +24,15 @@ module OpenXml
       end
 
       def add_relationship(type, target, id=nil, target_mode=nil)
-        Relationship.new(type, target, id, target_mode).tap do |relationship|
+        OpenXml::Elements::Relationship.new(type, target, id, target_mode).tap do |relationship|
           relationships.push relationship
         end
       end
 
+      def push(relationship)
+        relationships.push relationship
+      end
+
       def each(&block)
         relationships.each(&block)
       end
@@ -48,12 +53,6 @@ module OpenXml
         end
       end
 
-      class Relationship < Struct.new(:type, :target, :id, :target_mode)
-        def initialize(type, target, id=nil, target_mode=nil)
-          super type, target, id || "R#{SecureRandom.hex}", target_mode
-        end
-      end
-
     private
       attr_reader :relationships
 

data/lib/openxml/relationship.rb

@@ -0,0 +1,9 @@
+module OpenXml
+  module Elements
+      class Relationship < Struct.new(:type, :target, :id, :target_mode)
+        def initialize(type, target, id=nil, target_mode=nil)
+          super type, target, id || "R#{SecureRandom.hex}", target_mode
+        end
+      end
+  end
+end

data/openxml-package.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rails", ">= 3.2", "< 5.0"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "minitest-reporters-turn_reporter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openxml-package
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -80,26 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -216,13 +196,17 @@ files:
 - lib/openxml/builder.rb
 - lib/openxml/builder/element.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/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/relationship.rb
 - lib/openxml/rubyzip_fix.rb
 - lib/openxml/types.rb
 - openxml-package.gemspec
@@ -247,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Ruby implementation of OpenXmlPackage from Microsoft's Open XML SDK