odf_core 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56984a4144095fe244d3b9c7ed29bdb9bf47e955
-  data.tar.gz: eed16b3cf151f7178514325f3ccf8ca3688dabd3
+  metadata.gz: 143b1fffbbb8b0d07d473d1d68acbea7d2469e89
+  data.tar.gz: 5ec1cddcb8ed5fca69c2e71a0542c5c4b9cf3a06
 SHA512:
-  metadata.gz: 3b36cd8da96970f4ad9697bd71997f5c46f2bb630f6ae8cd4b424997e3af901aab2cdeec3dbd69d2269a4abd7949f239bb6590b91c1309ebedbb5e240c699787
-  data.tar.gz: 9dad6a551c46dc2c96bc33d5267728719390a0260ed688984bf064cdb1aa51171b2b3eb5e33807c616a30b0058c1355c5412247cc24e7a640f9e569c8ad90685
+  metadata.gz: ebd87e17317ae9f82216ebc371a3d4ded317d4466146127436ca1932b22cb29dab61f9f564a085bc14cef6e058b7294f60696a30dba434c2f83f740595a24e70
+  data.tar.gz: ae9655e28aa94cb54334967212c96fd165dcbf760da989b42eed14ffc345d5f3c32fa4d99c533d0905e3bed59a726c24e440f6ae4e9a72b692bccdadda922499

data/README.md

@@ -1,7 +1,7 @@
 # OdfCore
 
 Full set of "Open Document Format" elements translated into Ruby classes.
-Ok but what does it mean? It means if you are developing an ODF gem you can take this implementation as core of your gem. If you are looking for an easy to use ODF implementation without knowing all the implementation details of ODF, you are not supposed to be here, instead you can have a look at the [ODF gem](https://github.com/meinac/odf).
+Ok, seems like cool but what does it mean? It means if you are developing an ODF gem you can take this implementation as a foundation of your gem. If you are looking for an easy to use ODF implementation without knowing all the implementation details of ODF, you are not supposed to be here, instead you can have a look at the [ODF gem](https://github.com/meinac/odf).
 
 ## Installation
 
@@ -21,16 +21,25 @@ Or install it yourself as:
 
 ## Usage
 
-Example usage of classes;
+This gem provides Ruby classes for all ODF elements. If the element you want to use is `draw::text-box` then the class you are looking for is `OdfCore::Element::Draw::TextBox`. The pattern is applicable for all the elements(`OdfCore::Element::$NAMESPACE::$ELEMENT_NAME_IN_RUBY_CONVENTION`).
 
-    text_box = OdfCore::Draw::TextBox.new
-    headline = OdfCore::Draw::H.new('Text comes here...')
+The element instance has a simple interface with 3 methods;
+
+- `<<` method allows you to insert child element
+- `[]=` method allows you to set attribute for element
+- `[]` method allows you to get the value of the attribute for the element
+
+Example of adding child into an element;
+
+    text_box = OdfCore::Element::Draw::TextBox.new
+    headline = OdfCore::Element::Draw::H.new
     text_box << headline
 
-It's also possible to set attributes for elements like so;
+Example of setting and getting the attribute of an element;
 
-    text_box = OdfCore::Draw::TextBox.new
-    text_box.fo_max_height = '10px'
+    text_box = OdfCore::Element::Draw::TextBox.new
+    text_box['fo:max-height'] = '10px'
+    text_box['fo:max-height']
 
 ## Development
 

data/lib/odf_core.rb

@@ -1,4 +1,4 @@
-require "odf_core/version"
+Dir[File.join(__dir__, "odf_core", "**", "*.rb")].each { |file| require file }
 
 module OdfCore
 

data/lib/odf_core/element/abstract_element.rb

@@ -0,0 +1,57 @@
+module OdfCore
+  module Element
+    class AbstractElement
+
+      class << self
+        def children
+          self::CHILDREN
+        end
+
+        def attributes
+          self::ATTRIBUTES
+        end
+
+        def xml_element_name
+          self::XML_ELEMENT_NAME
+        end
+      end
+
+      attr_reader :children, :attributes
+
+      def initialize
+        @children = []
+        @attributes = {}
+      end
+
+      def <<(element)
+        check_child_element!(element)
+
+        @children << element
+      end
+
+      def []=(attribute_name, attribute_value)
+        check_attribute!(attribute_name)
+
+        @attributes[attribute_name] = attribute_value
+      end
+
+      def [](attribute_name)
+        @attributes[attribute_name]
+      end
+
+      private
+        def check_child_element!(element)
+          if !self.class.children.include?(element.class.xml_element_name)
+            raise Error::NotAllowedElement.new(self.class.name, element.class)
+          end
+        end
+
+        def check_attribute!(attribute_name)
+          if !self.class.attributes.include?(attribute_name)
+            raise Error::NotAllowedAttribute.new(self.class.name, attribute_name)
+          end
+        end
+
+    end
+  end
+end

data/lib/odf_core/element/anim/animate.rb

@@ -0,0 +1,40 @@
+module OdfCore
+  module Element
+    module Anim
+      class Animate < AbstractElement
+        XML_ELEMENT_NAME = 'anim:animate'
+
+        CHILDREN = [].freeze
+
+        ATTRIBUTES = [
+          "anim:formula",
+          "anim:sub-item",
+          "smil:accelerate",
+          "smil:accumulate",
+          "smil:additive",
+          "smil:attributeName",
+          "smil:autoReverse",
+          "smil:begin",
+          "smil:by",
+          "smil:calcMode",
+          "smil:decelerate",
+          "smil:dur",
+          "smil:end",
+          "smil:fill",
+          "smil:fillDefault",
+          "smil:from",
+          "smil:keySplines",
+          "smil:keyTimes",
+          "smil:repeatCount",
+          "smil:repeatDur",
+          "smil:restart",
+          "smil:restartDefault",
+          "smil:targetElement",
+          "smil:to",
+          "smil:values",
+        ].freeze
+
+      end
+    end
+  end
+end

data/lib/odf_core/element/anim/animate_color.rb

@@ -0,0 +1,42 @@
+module OdfCore
+  module Element
+    module Anim
+      class AnimateColor < AbstractElement
+        XML_ELEMENT_NAME = 'anim:animateColor'
+
+        CHILDREN = [].freeze
+
+        ATTRIBUTES = [
+          "anim:color-interpolation",
+          "anim:color-interpolation-direction",
+          "anim:formula",
+          "anim:sub-item",
+          "smil:accelerate",
+          "smil:accumulate",
+          "smil:additive",
+          "smil:attributeName",
+          "smil:autoReverse",
+          "smil:begin",
+          "smil:by",
+          "smil:calcMode",
+          "smil:decelerate",
+          "smil:dur",
+          "smil:end",
+          "smil:fill",
+          "smil:fillDefault",
+          "smil:from",
+          "smil:keySplines",
+          "smil:keyTimes",
+          "smil:repeatCount",
+          "smil:repeatDur",
+          "smil:restart",
+          "smil:restartDefault",
+          "smil:targetElement",
+          "smil:to",
+          "smil:values",
+        ].freeze
+
+      end
+    end
+  end
+end

data/lib/odf_core/element/anim/animate_motion.rb

@@ -0,0 +1,42 @@
+module OdfCore
+  module Element
+    module Anim
+      class AnimateMotion < AbstractElement
+        XML_ELEMENT_NAME = 'anim:animateMotion'
+
+        CHILDREN = [].freeze
+
+        ATTRIBUTES = [
+          "anim:formula",
+          "anim:sub-item",
+          "smil:accelerate",
+          "smil:accumulate",
+          "smil:additive",
+          "smil:attributeName",
+          "smil:autoReverse",
+          "smil:begin",
+          "smil:by",
+          "smil:calcMode",
+          "smil:decelerate",
+          "smil:dur",
+          "smil:end",
+          "smil:fill",
+          "smil:fillDefault",
+          "smil:from",
+          "smil:keySplines",
+          "smil:keyTimes",
+          "smil:repeatCount",
+          "smil:repeatDur",
+          "smil:restart",
+          "smil:restartDefault",
+          "smil:targetElement",
+          "smil:to",
+          "smil:values",
+          "svg:origin",
+          "svg:path",
+        ].freeze
+
+      end
+    end
+  end
+end

data/lib/odf_core/element/anim/animate_transform.rb

@@ -0,0 +1,38 @@
+module OdfCore
+  module Element
+    module Anim
+      class AnimateTransform < AbstractElement
+        XML_ELEMENT_NAME = 'anim:animateTransform'
+
+        CHILDREN = [].freeze
+
+        ATTRIBUTES = [
+          "anim:formula",
+          "anim:sub-item",
+          "smil:accelerate",
+          "smil:accumulate",
+          "smil:additive",
+          "smil:attributeName",
+          "smil:autoReverse",
+          "smil:begin",
+          "smil:by",
+          "smil:decelerate",
+          "smil:dur",
+          "smil:end",
+          "smil:fill",
+          "smil:fillDefault",
+          "smil:from",
+          "smil:repeatCount",
+          "smil:repeatDur",
+          "smil:restart",
+          "smil:restartDefault",
+          "smil:targetElement",
+          "smil:to",
+          "smil:values",
+          "svg:type",
+        ].freeze
+
+      end
+    end
+  end
+end

data/lib/odf_core/element/anim/audio.rb

@@ -0,0 +1,34 @@
+module OdfCore
+  module Element
+    module Anim
+      class Audio < AbstractElement
+        XML_ELEMENT_NAME = 'anim:audio'
+
+        CHILDREN = [].freeze
+
+        ATTRIBUTES = [
+          "anim:audio-level",
+          "anim:id",
+          "presentation:group-id",
+          "presentation:master-element",
+          "presentation:node-type",
+          "presentation:preset-class",
+          "presentation:preset-id",
+          "presentation:preset-sub-type",
+          "smil:begin",
+          "smil:dur",
+          "smil:end",
+          "smil:fill",
+          "smil:fillDefault",
+          "smil:repeatCount",
+          "smil:repeatDur",
+          "smil:restart",
+          "smil:restartDefault",
+          "xlink:href",
+          "xml:id",
+        ].freeze
+
+      end
+    end
+  end
+end

data/lib/odf_core/element/anim/command.rb

@@ -0,0 +1,28 @@
+module OdfCore
+  module Element
+    module Anim
+      class Command < AbstractElement
+        XML_ELEMENT_NAME = 'anim:command'
+
+        CHILDREN = ["anim:param"].freeze
+
+        ATTRIBUTES = [
+          "anim:command",
+          "anim:id",
+          "anim:sub-item",
+          "presentation:group-id",
+          "presentation:master-element",
+          "presentation:node-type",
+          "presentation:preset-class",
+          "presentation:preset-id",
+          "presentation:preset-sub-type",
+          "smil:begin",
+          "smil:end",
+          "smil:targetElement",
+          "xml:id",
+        ].freeze
+
+      end
+    end
+  end
+end

data/lib/odf_core/element/anim/iterate.rb

@@ -0,0 +1,52 @@
+module OdfCore
+  module Element
+    module Anim
+      class Iterate < AbstractElement
+        XML_ELEMENT_NAME = 'anim:iterate'
+
+        CHILDREN = [
+          "anim:animate",
+          "anim:animateColor",
+          "anim:animateMotion",
+          "anim:animateTransform",
+          "anim:audio",
+          "anim:command",
+          "anim:iterate",
+          "anim:par",
+          "anim:seq",
+          "anim:set",
+          "anim:transitionFilter",
+        ].freeze
+
+        ATTRIBUTES = [
+          "anim:id",
+          "anim:iterate-interval",
+          "anim:iterate-type",
+          "anim:sub-item",
+          "presentation:group-id",
+          "presentation:master-element",
+          "presentation:node-type",
+          "presentation:preset-class",
+          "presentation:preset-id",
+          "presentation:preset-sub-type",
+          "smil:accelerate",
+          "smil:autoReverse",
+          "smil:begin",
+          "smil:decelerate",
+          "smil:dur",
+          "smil:end",
+          "smil:endsync",
+          "smil:fill",
+          "smil:fillDefault",
+          "smil:repeatCount",
+          "smil:repeatDur",
+          "smil:restart",
+          "smil:restartDefault",
+          "smil:targetElement",
+          "xml:id",
+        ].freeze
+
+      end
+    end
+  end
+end

data/lib/odf_core/element/anim/par.rb

@@ -0,0 +1,48 @@
+module OdfCore
+  module Element
+    module Anim
+      class Par < AbstractElement
+        XML_ELEMENT_NAME = 'anim:par'
+
+        CHILDREN = [
+          "anim:animate",
+          "anim:animateColor",
+          "anim:animateMotion",
+          "anim:animateTransform",
+          "anim:audio",
+          "anim:command",
+          "anim:iterate",
+          "anim:par",
+          "anim:seq",
+          "anim:set",
+          "anim:transitionFilter",
+        ].freeze
+
+        ATTRIBUTES = [
+          "anim:id",
+          "presentation:group-id",
+          "presentation:master-element",
+          "presentation:node-type",
+          "presentation:preset-class",
+          "presentation:preset-id",
+          "presentation:preset-sub-type",
+          "smil:accelerate",
+          "smil:autoReverse",
+          "smil:begin",
+          "smil:decelerate",
+          "smil:dur",
+          "smil:end",
+          "smil:endsync",
+          "smil:fill",
+          "smil:fillDefault",
+          "smil:repeatCount",
+          "smil:repeatDur",
+          "smil:restart",
+          "smil:restartDefault",
+          "xml:id",
+        ].freeze
+
+      end
+    end
+  end
+end