duxml 0.7.2 → 0.8.0

data/lib/duxml/meta/grammar/spreadsheet.rb

@@ -1,35 +1,35 @@
-# Copyright (c) 2016 Freescale Semiconductor Inc.
-
-require 'rubyXL'
-
-module Duxml
-  # contains helper methods to convert spreadsheet of DTD rules into Duxml::Rules
-  module Spreadsheet
-    private
-  # @param path [String] spreadsheet file
-    def self.sheet_to_xml(path)
-      worksheet = RubyXL::Parser.parse(path)[0]
-      attr_val_rule_hash = {}
-      g = GrammarClass.new
-      worksheet.each_with_index do |row, index|
-        next if index == 0
-        break if row[3].nil? || row[4].nil?
-        element_name = row[3].value
-        statement_str = row[4].value
-        g << ChildrenRuleClass.new(element_name, statement_str)
-        attribute_rules = row[5].value.split(/\n/)
-        attribute_rules.each_with_index do |rule, i|
-          next if i == 0 or rule.empty?
-          attr_name, value_expr, attr_req = *rule.split
-          next if [attr_name, value_expr, attr_req].any? do |s| s.empty? or s.match(/\w/).nil? end
-          g << AttrsRuleClass.new(element_name, attr_name, attr_req)
-          unless attr_val_rule_hash[attr_name]
-            g << ValueRuleClass.new(attr_name, value_expr)
-            attr_val_rule_hash[attr_name] = true
-          end
-        end # attribute_rules.each_with_index
-      end # worksheet.each_with_index
-      g
-    end # def sheet_to_xml(path)
-  end # module Spreadsheet
+# Copyright (c) 2016 Freescale Semiconductor Inc.
+
+require 'rubyXL'
+
+module Duxml
+  # contains helper methods to convert spreadsheet of DTD rules into Duxml::Rules
+  module Spreadsheet
+    private
+  # @param path [String] spreadsheet file
+    def self.sheet_to_xml(path)
+      worksheet = RubyXL::Parser.parse(path)[0]
+      attr_val_rule_hash = {}
+      g = GrammarClass.new
+      worksheet.each_with_index do |row, index|
+        next if index == 0
+        break if row[3].nil? || row[4].nil?
+        element_name = row[3].value
+        statement_str = row[4].value
+        g << ChildrenRuleClass.new(element_name, statement_str)
+        attribute_rules = row[5].value.split(/\n/)
+        attribute_rules.each_with_index do |rule, i|
+          next if i == 0 or rule.empty?
+          attr_name, value_expr, attr_req = *rule.split
+          next if [attr_name, value_expr, attr_req].any? do |s| s.empty? or s.match(/\w/).nil? end
+          g << AttrsRuleClass.new(element_name, attr_name, attr_req)
+          unless attr_val_rule_hash[attr_name]
+            g << ValueRuleClass.new(attr_name, value_expr)
+            attr_val_rule_hash[attr_name] = true
+          end
+        end # attribute_rules.each_with_index
+      end # worksheet.each_with_index
+      g
+    end # def sheet_to_xml(path)
+  end # module Spreadsheet
 end # module Duxml

data/lib/duxml/meta/grammar.rb

@@ -50,9 +50,9 @@ module Duxml
       end
     end
 
-    # @return [Element] returns self as XML element e.g. '<duxml:grammar/>'
-    def self.xml
-      Element.new(name.nmtokenize).extend self
+    # @return [Doc] returns self as XML document
+    def xml
+      Element.new('grammar') << rules.collect do |rule| rule.xml end
     end
 
     # @return [History] history that this grammar is currently reporting to

data/lib/duxml/meta/history.rb

@@ -27,10 +27,10 @@ module Duxml
 
     def_delegators :@nodes, :[], :each
 
-    # @param harsh_or_kind [Boolean] by default harsh i.e. true so that if this History detects an error it will raise an Exception; otherwise not
-    def initialize(harsh_or_kind = true)
+    # @param strict_or_false [Boolean] by default strict i.e. true so that if this History detects an error it will raise an Exception; otherwise not
+    def initialize(strict_or_false = true)
       @nodes = []
-      @strict = harsh_or_kind
+      @strict = strict_or_false
     end
 
     attr_reader :nodes
@@ -40,15 +40,16 @@ module Duxml
   module History
     # used when creating a new metadata file for a static XML file
     #
-    # @return [Element] XML element for a new <duxml:history> node
-    def self.xml
-      Element.new(name.nmtokenize).extend self
+    # @return [Doc] returns self as XML document
+    def xml
+      h = Element.new('history')
+      events.each do |event| h << event.xml end
+      h
     end
 
     # @return [Boolean] toggles (true by default) whether History will raise exception or tolerate qualify errors
-    def strict?(harsh_or_kind=nil)
-      @strict = harsh_or_kind.nil? ? @strict : harsh_or_kind
-      @strict
+    def strict?(strict_or_false=nil)
+      @strict = strict_or_false.nil? ? @strict : strict_or_false
     end
 
     # @return [ChangeClass, ErrorClass] the latest event

data/lib/duxml/meta.rb

@@ -22,17 +22,10 @@ module Duxml
       @grammar_path = grammar_path
     end
 
-    attr_reader :history, :grammar
+    attr_reader :history, :grammar, :grammar_path
   end
 
   module Meta
-    # @return [Doc] metadata document
-    def self.xml
-      d = Doc.new << (Element.new(name.nmtokenize) << Grammar.xml << History.xml)
-      d.root.grammar[:ref] = @grammar_path if @grammar_path
-      d
-    end
-
     # @param path [String] path of XML-content file
     # @return [String] full path of metadata file based on content file's name e.g.
     #   'design.xml' => '.design.xml.duxml'
@@ -41,11 +34,29 @@ module Duxml
       "#{dir}/.#{File.basename(path)}#{FILE_EXT}"
     end
 
+    # @param g [String, GrammarClass] either a grammar object or path to one
+    # @return [GrammarClass] grammar object
     def grammar=(g)
-      @grammar = g.is_a?(GrammarClass) ? g : Grammar.import(g)
+      @grammar = if g.is_a?(GrammarClass)
+                   g
+                 else
+                   @grammar_path = g if File.exists?(g)
+                   Grammar.import(g)
+                 end
       history.delete_observers if history.respond_to?(:delete_observers)
       history.add_observer(grammar, :qualify)
       grammar.add_observer history
+      grammar
+    end
+
+    def xml
+      if grammar_path
+        g = Duxml::Element.new('grammar')
+        g[:ref] = grammar_path
+      else
+        g = grammar.xml
+      end
+      Duxml::Element.new('meta') << g << history.xml
     end
   end # module Meta
 end # module Duxml

data/lib/duxml/reportable.rb

@@ -1,27 +1,29 @@
-# Copyright (c) 2016 Freescale Semiconductor Inc.
-
-require 'observer'
-
-module Reportable
-  include Observable
-
-  # @param obs [Object] observer to add to this Element as well as its NodeSet
-  def add_observer(obs, sym=nil)
-    super(obs, sym || :update)
-    nodes.add_observer(obs) if self.respond_to?(:nodes) and nodes.respond_to?(:add_observer)
-  end
-
-  private
-
-  # all public methods that alter XML must call #report in the full scope of that public method
-  # in order to correctly acquire name of method that called #report
-  #
-  # @param *args [*several_variants]
-  def report(*args)
-    return nil if @observer_peers.nil?
-    changed
-    new_args = [args.first, self]
-    args[1..-1].each do |a| new_args << a end if args.size > 1
-    notify_observers(*new_args)
-  end
+# Copyright (c) 2016 Freescale Semiconductor Inc.
+
+require 'observer'
+
+module Reportable
+  include Observable
+
+  # @param obs [Object] observer to add to this Element as well as its NodeSet
+  def add_observer(obs, sym=nil)
+    super(obs, sym || :update)
+    nodes.add_observer(obs) if self.respond_to?(:nodes) and nodes.respond_to?(:add_observer)
+  end
+
+  attr_reader :observer_peers
+
+  private
+
+  # all public methods that alter XML must call #report in the full scope of that public method
+  # in order to correctly acquire name of method that called #report
+  #
+  # @param *args [*several_variants]
+  def report(*args)
+    return nil if @observer_peers.nil?
+    changed
+    new_args = [args.first, self]
+    args[1..-1].each do |a| new_args << a end if args.size > 1
+    notify_observers(*new_args)
+  end
 end

data/lib/duxml/saxer.rb

@@ -14,7 +14,8 @@ module Duxml
       saxer = DocuLiner.new(Duxml::Doc.new, obs)
       Ox.sax_parse(saxer, io, {convert_special: true, symbolize: false})
       doc = saxer.cursor
-      doc.add_observer obs if obs
+      doc.add_observer obs if obs and doc.count_observers < 1
+      doc.path = path
       doc
     end
 
@@ -37,7 +38,7 @@ module Duxml
       attr_accessor :cursor_stack
 
       def start_element(name)
-        cursor << Duxml::Element.new(name, line, column)
+        cursor.nodes.insert(-1, Duxml::Element.new(name, line, column))
         cursor_stack << cursor.nodes.last
       end
 
@@ -46,7 +47,7 @@ module Duxml
       end
 
       def text(str)
-        cursor << str
+        cursor.nodes.insert(-1, str)
       end
 
       def end_element(name)

data/lib/duxml.rb

@@ -1,51 +1,46 @@
 # Copyright (c) 2016 Freescale Semiconductor Inc.
 
 require File.expand_path(File.dirname(__FILE__) + '/duxml/saxer')
-require File.expand_path(File.dirname(__FILE__) + '/duxml/meta')
 
 module Duxml
-  DITA_GRAMMAR = File.expand_path(File.dirname(__FILE__) + '/../xml/dita_grammar.xml')
   include Saxer
-  include Meta
 
-  # path to XML file
-  @file
-  # current document
+  # most recently processed document - default location for validated documents that are not loaded explicitly
   @doc
-  # meta data document
-  @meta
 
-  attr_reader :meta, :file, :doc
+  attr_reader :doc
 
-  # @param file [String, Doc] loads or creates given file or document and finds or creates corresponding metadata file e.g. '.xml_file.duxml'
+  # @param _file [String] loads XML file from given path and finds or creates corresponding metadata file e.g. '.xml_file.duxml'
   # @param grammar_path [nil, String, Duxml::Grammar] optional - provide an external grammar file or object
-  # @return [Duxml::Meta] combined Object tree from metadata root (metadata and content's XML documents are kept separate)
+  # @return [Doc] XML document as Ruby object
   def load(_file, grammar_path=nil)
-    if _file.is_a?(String) and File.exists?(_file)
-      @file = _file
+    meta_path = Meta.meta_path(_file)
+
+    if File.exists?(meta_path)
+      meta = Ox.parse_obj(File.read meta_path)
+      meta.grammar = grammar_path unless grammar_path.nil? or meta.grammar.defined?
     else
-      @file = "#{(_file.respond_to?(:name) ? _file.name : _file.class.to_s) + _file.object_id.to_s}"
-      File.write file, ''
+      meta = MetaClass.new(grammar_path)
     end
 
-    set_metadata!(grammar_path)
-    set_doc!
-  end # def load
-
-  # @param file [String] creates new XML file at given path
-  # @param content [Doc, Element] XML content with which to initialize new file
-  def create(file, content=nil)
-    File.write(file, content.to_s)
-    @doc = content.is_a?(Doc) ? content : Doc.new
-  end
+    if File.exists?(_file)
+      @doc = sax(_file, meta.history)
+    else
+      @doc = Doc.new
+      @doc.path = _file
 
-  # @param file [String] saves current content XML to given file path (Duxml@file by default)
-  def save(file)
-    meta_path = Meta.meta_path(file)
-    unless File.exists?(meta_path)
-      File.new meta_path, 'w+'
-      File.write(meta_path, Meta.xml)
+      doc.delete_observers if doc.count_observers > 0 and doc.observer_peers.first.object_id != meta.history.object_id
+      doc.add_observer meta.history if doc.count_observers < 1
     end
+    doc.set_meta meta
+  end # def load
+
+  # @param file [String] saves current content XML to given file path
+  # @param xml [Doc, Element] current Doc by default, but can also be unattached XML Element
+  def save(file, xml=doc)
+    @doc = xml.respond_to?(:root) ? xml : Doc.new << xml
+    doc.write_to file
+    File.write(Meta.meta_path(file), Ox.dump(doc.meta, circular: true))
   end
 
   # @param file [String] output file path for logging human-readable validation error messages
@@ -53,45 +48,29 @@ module Duxml
     File.write(file, meta.history.description)
   end
 
-  # @param *Args [*several_variants] @see #load
+  # @param *Args [String, Doc] if string then path to load Doc, else Doc to validate
+  # @param options [Hash, Symbol] currently just supports suppression of console output of results with :quiet
   # @return [Boolean] whether file passed validation
-  def validate(*args)
-    load(*args) unless args.empty?
-    raise Exception, "grammar not defined!" unless meta.grammar.defined?
-    raise Exception, "document not loaded!" unless doc.root
+  def validate(path_or_doc, options={})
+    doc = path_or_doc.is_a?(Doc) ? path_or_doc : load(path_or_doc)
+    unless doc.grammar.defined?
+      raise Exception, "grammar not defined!" unless options[:grammar]
+      doc.grammar = options[:grammar]
+    end
+    raise Exception, "XML document has no root element!" unless doc.root
     results = []
-    doc.root.traverse do |n| results << meta.grammar.validate(n) unless n.is_a?(String) end
+    doc.root.traverse do |n| results << doc.grammar.validate(n) unless n.is_a?(String) end
+    puts(doc.history.description) unless options[:quiet]
     !results.any? do |r| !r end
   end # def validate
 
-  # @return [Nokogiri::XML::RelaxNG] current metadata's grammar as a relaxng file
-  def relaxng
-    #meta.grammar.relaxng
-  end
-
   private
-
-  # @return [Doc] @doc is set to either file given by user or new Doc
-  def set_doc!
-    @doc ||= if file.nil?
-               f = Doc.new
-               f.add_observer meta.history
-               f
-             else
-               f = File.open file
-               sax(f, meta.history)
-             end
+  # @param g_path [String, GrammarClass] grammar to associate with @doc, which must be set to a Doc and not nil
+  def associate_grammar(g_path)
+    doc.grammar = g_path if g_path
   end
 
-  # @return [MetaClass] @meta is set to either file extrapolated from path of XML-content file or new MetaClass
-  def set_metadata!(grammar_path=nil)
-    meta_path = Meta.meta_path(file)
-    if file and File.exists?(meta_path)
-      @meta = sax(File.open(meta_path)).root
-      meta.grammar=grammar_path unless grammar_path.nil? or meta.grammar.defined?
-    else
-      @meta = MetaClass.new(grammar_path)
-    end
-    meta
+  def find_meta
+
   end
 end # module Duxml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duxml
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Peter Kong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
-description: execute 'validate_xml --help' for more info
+description: see README.md
 email:
 - peter.kong@nxp.com
 executables:
@@ -88,7 +88,6 @@ files:
 - lib/duxml/ruby_ext/string.rb
 - lib/duxml/saxer.rb
 - lib/duxml.rb
-- xml/dita_grammar.xml
 - bin/validate_xml
 homepage: http://www.github.com/ruby-dita/duxml
 licenses: