con_duxml 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea6092d7c51dbf6ce598c68947b1ac8ceddb1cdf
-  data.tar.gz: a0ad5b0bd5ed055000b4c5a363cc4e1219e94bce
+  metadata.gz: be72385bfaedf3c2c5d3420bf97e9477b9ffc143
+  data.tar.gz: 87c695867176251b5e9cbbe57345cffaa6d6ec01
 SHA512:
-  metadata.gz: 616d12866cc2a18f5fa742958f0cc75711bc4bea6109b5db2aca8c5632814af0260a180a5ad8a24b45637610184bbbdc02cf73663c83da3ef5ad16fe4c8e49da
-  data.tar.gz: 500f5e62594877ab62199185e85dce2e127bef44ad3dc1906d4b660f20d6fa00f57c403e8a4dcd985e0fa0beba40b65be93a23a97f1adab9b27e92fe9dad9974
+  metadata.gz: 5a91a034b74e087b809b5db6daede88759c97b6366516aaa911095bee2ced263c9d17f14fab33ef8a850cf01ac4dc7b9c558bd46ba9a987eca5d9c382526c7ce
+  data.tar.gz: 6cf35d65bdbb92876f1bf7ffd1ff0bd5a30ee542903e463b8c9f342b594c21cef0bf79ff859ca4d1f607080ce28e0ffca05a8dee6d5906f627869794bc7b65ce

data/lib/con_duxml/duxml_ext/transform_class.rb

@@ -0,0 +1,17 @@
+require 'duxml/meta/history/change'
+
+include Duxml
+class TransformClass < ChangeClass
+  def initialize(xform, src, output)
+    @instructions = xform
+    @input = src
+    @output = output
+  end
+
+  attr_reader :instructions, :input, :output
+
+  # @return [String] verbal description of transform event
+  def description
+    "#{output.description} created from #{input.description} by #{instructions.description}"
+  end
+end

data/lib/con_duxml/transform/transform_private.rb

@@ -0,0 +1,81 @@
+# Copyright (c) 2016 Freescale Semiconductor Inc.
+
+# Private is where methods should go that you DO NOT want invoked by a transform file!
+module Private
+  private
+
+  # @param xform [Element] transform element
+  # @param _source [Element] XML xform containing content to be transformed
+  # @return [Array[Element]] transformed content; always an array of nodes, even if just one
+  def activate(xform, _source)
+    @source = _source
+    get_sources(xform).collect do |src|
+      args = get_args(xform, src)
+      output = get_method(xform).call(*args)
+      changed
+      m = methods
+      notify_observers(:Transform, xform, src, output)
+      changed false
+      output
+    end
+  end
+
+  # @param xform [Element] transform element
+  # @return [Array] array of elements that match @target, which must be a '/'-separated string
+  #   if transform element has any children that may need the same source target, target_stack.last remains
+  #   if transform is a leaf, target_stack is popped
+  def get_sources(xform)
+    if xform[:source]
+      source.locate add_name_space_prefix xform[:source]
+    else
+      [source]
+    end
+  end
+
+  # @param xform [Element] transform element
+  # @return [Method] resolves reference to actual transform method
+  def get_method(xform)
+    words = xform.name.split(':').reverse
+    method_name = words[0].to_sym
+    maudule = self
+    maudule = Module.const_get(words[1].constantize) if words[1] and Module.const_defined?(words[1].constantize)
+    if maudule == self
+      public_method(method_name)
+    else
+      maudule.public_instance_method(method_name).bind self
+    end
+  end
+
+  # @param xform [Element] transform element
+  # @param subj [Element] source XML Element
+  # @return [Array[String, Element]] string returned by self[:args] is separated by ';' into correctly formatted argument values for transform method
+  def get_args(xform, subj)
+    args = xform.attributes.keys.sort.collect do |attr|
+      if attr.to_s.match(/arg[0-9]*/)
+        if xform[attr].include?(',')
+          xform[attr].split(',').collect do |s|
+            s.match(/'[\s\w]+'/) ? $MATCH.strip[1..-2] : subj.locate(add_name_space_prefix s.strip).first
+          end
+        elsif xform[attr].include?('/')
+          subj.locate(add_name_space_prefix xform[attr]).first
+        elsif xform[attr].match(/'[\s\w]+'/)
+          $MATCH.strip[1..-2]
+        else
+          targets = subj.locate(xform[attr])
+          targets.empty? ? xform[attr] : targets
+        end
+      end
+    end.compact
+    children = xform.nodes.collect do |child|
+      activate(child, subj)
+    end
+    args << children.flatten if children.any?
+    args
+  end
+
+  def add_name_space_prefix(str)
+    str.split('/').collect do |w|
+      w.match(/\w+/) ? "#{src_ns ? src_ns+':' : ''}#{w}" : w
+    end.join('/')
+  end
+end

data/lib/con_duxml/transform.rb

@@ -1,74 +1,56 @@
 # Copyright (c) 2016 Freescale Semiconductor Inc.
+require 'duxml'
+require_relative 'duxml_ext/transform_class'
+require_relative 'transform/transform_private'
+include Duxml
 
-# helper methods for converting transform elements into code
+# All public methods can be invoked by a transform element; please hide methods you don't want users to invoke in Private
 module Transform
-  @xform
+  include Observable
+  include Private
+
+  # most recent XML node from which content has been taken; for constructing relative paths
   @source
 
-  attr_reader :xform, :source
+  attr_reader :source
 
-  # @param xform [Element] transform element
-  # @param _source [Element] XML xform containing content to be transformed
-  # @return [Array[Element]] transformed content; always an array of nodes, even if just one
-  def activate(xform, _source)
-    @source = _source
-    get_sources(xform).collect do |src|
-      args = get_args(xform, src)
-      get_method(xform).call(*args)
-    end
+  # @param node [Element] XML node from transform output
+  # @return [TransformClass] transform event object from output Doc's history
+  def find_xform_event(node)
+    @output.history #TODO find transform whose outputs include given node
   end
 
-  # @param xform [Element] transform element
-  # @return [Array] array of elements that match @target, which must be a '/'-separated string
-  #   if transform element has any children that may need the same source target, target_stack.last remains
-  #   if transform is a leaf, target_stack is popped
-  def get_sources(xform)
-    if xform[:source]
-      source.locate add_name_space_prefix xform[:source]
-    else
-      [source]
-    end
+  # @param node [Element] XML node from transform output
+  # @return [Element] XML node that contains instructions for transform used to create given @param node
+  def find_transform(node)
+    find_xform_event(node).instructions
   end
 
-  # @param xform [Element] transform element
-  # @return [Method] resolves reference to actual transform method
-  def get_method(xform)
-    words = xform.name.split(':').reverse
-    method_name = words[0].to_sym
-    maudule = Module
-    maudule = Module.const_get(words[1].constantize) if words[1] and Module.const_defined?(words[1].constantize)
-    maudule.method(method_name)
+  # @param node [Element] XML node from transform output
+  # @return [Element] XML node that provided content for transformation i.e. source
+  def find_source(node)
+    find_xform_event(node).input
   end
 
-  # @param xform [Element] transform element
-  # @param subj [Element] source XML Element
-  # @return [Array[String, Element]] string returned by self[:args] is separated by ';' into correctly formatted argument values for transform method
-  def get_args(xform, subj)
-    args = xform.attributes.keys.sort.collect do |attr|
-      if attr.to_s.match(/arg[0-9]/)
-        if xform[attr].include?(',')
-          xform[attr].split(',').collect do |s|
-            if s.match(/'[\s\w]+'/)
-              $MATCH.strip[1..-2]
-            else
-              subj.locate(add_name_space_prefix s.strip).first
-            end
-          end
-        else
-          subj.locate(add_name_space_prefix xform[attr]).first
-        end
-      end
-    end.compact
-    children = xform.nodes.collect do |child|
-      activate(child, subj)
-    end
-    args << children.flatten if children.any?
-    args
+  # @param path [String] path to node from @source e.g. 'child/grandchild'; target is expected to return ONE child
+  #   containing TEXT only
+  # @return [String] content of target node
+  def content(path)
+    @source.locate(add_name_space_prefix path).first.text
   end
 
-  def add_name_space_prefix(str)
-    str.split('/').collect do |w|
-      w.match(/\w+/) ? "#{src_ns ? src_ns+':' : ''}#{w}" : w
-    end.join('/')
+  # @param *args [*several_variants] see Duxml::Element#new; the only difference here is that this method has access to the content source
+  #   so the arguments can pass in the needed data
+  # @return [Element] new element to replace old one
+  def element(*args)
+    Element.new(*args)
+  end
+
+  # @param path [String] path to node from @source
+  # @return [Element] a deep copy of the target(s)
+  def copy(path)
+    @source.locate(add_name_space_prefix path).collect do |node|
+      node.dclone
+    end
   end
 end

data/lib/con_duxml.rb

@@ -5,10 +5,6 @@ module ConDuxml
   include Duxml
   include Transform
 
-  # hash where each key is concatenation of each instantiation of @doc and values are the Doc instance permutations returned by #instantiate
-  @instances
-  # double-key hash containing every result of #transform; keys concatenation of source doc's #object_id and transform doc's #object_id
-  @transformations
   # namespace prefix for source file
   @src_ns
 
@@ -19,7 +15,7 @@ module ConDuxml
   #   also contain directives or links to them
   # @return [Doc] result of transform; automatically hashed into @transforms
   def transform(transforms, doc_or_path=nil)
-    output = Doc.new
+    @output = Doc.new
     transforms = case transforms
                    when Doc then transforms.root
                    when Element then transforms
@@ -33,11 +29,10 @@ module ConDuxml
            end
     @src_ns = transforms[:src_ns]
     source = doc.locate(add_name_space_prefix(transforms[:source])).first
-    output.grammar = transforms[:grammar] if transforms[:grammar]
+    @output.grammar = transforms[:grammar] if transforms[:grammar]
     a = activate(transforms.first, source).first
-    output << a
-    @transformations ||= {}
-    @transformations[doc.object_id+transforms.object_id] = output
+    add_observer @output.history
+    @output << a
   end
 
   # instantiation takes a static design file and constructs a dynamic model by identifying certain keyword elements,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: con_duxml
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Kong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-21 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: duxml
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.4'
 description: 
 email:
 - peter.kong@nxp.com
@@ -48,8 +48,10 @@ files:
 - lib/con_duxml/array.rb
 - lib/con_duxml/duxml_ext/element.rb
 - lib/con_duxml/duxml_ext/linkable.rb
+- lib/con_duxml/duxml_ext/transform_class.rb
 - lib/con_duxml/instance.rb
 - lib/con_duxml/link.rb
+- lib/con_duxml/transform/transform_private.rb
 - lib/con_duxml/transform.rb
 - lib/con_duxml.rb
 homepage: http://www.github.com/Ludocracy/con_duxml