adiwg-mdtranslator 1.4.0 → 2.0.0rc2

data/lib/adiwg/mdtranslator/writers/html/sections/html_distributor.rb

@@ -1,62 +1,66 @@
 # HTML writer
-# resource distributor
+# distributor
 
 # History:
+#  Stan Smith 2017-04-04 refactored for mdTranslator 2.0
 # 	Stan Smith 2015-08-21 original script
 
-require_relative 'html_responsibleParty'
+require_relative 'html_responsibility'
 require_relative 'html_orderProcess'
-require_relative 'html_format'
 require_relative 'html_transferOption'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
-
-                class MdHtmlDistributor
-                    def initialize(html)
-                        @html = html
-                    end
-
-                    def writeHtml(hDistributor)
-
-                        # classes used
-                        htmlResParty = MdHtmlResponsibleParty.new(@html)
-                        htmlOrderProc = MdHtmlOrderProcess.new(@html)
-                        htmlFormat = MdHtmlFormat.new(@html)
-                        htmlTranOpt = MdHtmlTransferOption.new(@html)
-
-                        # resource distribution - distributor - required
-                        @html.em('Distributor contact: ')
-                        hResParty = hDistributor[:distContact]
-                        @html.section(:class=>'block') do
-                            htmlResParty.writeHtml(hResParty)
-                        end
+   module Mdtranslator
+      module Writers
+         module Html
 
-                        # resource distribution - order process
-                        hDistributor[:distOrderProcs].each do |hOrder|
-                            @html.em('Order Process: ')
-                            @html.section(:class=>'block') do
-                                htmlOrderProc.writeHtml(hOrder)
-                            end
-                        end
+            class Html_Distributor
+
+               def initialize(html)
+                  @html = html
+               end
 
-                        # resource distribution - resource format
-                        hDistributor[:distFormats].each do |hFormat|
-                            htmlFormat.writeHtml(hFormat)
+               def writeHtml(hDistributor)
+
+                  # classes used
+                  responsibilityClass = Html_Responsibility.new(@html)
+                  orderClass = Html_OrderProcess.new(@html)
+                  transferClass = Html_TransferOption.new(@html)
+
+                  # distributor - contact {responsibility}
+                  unless hDistributor[:contact].empty?
+                     @html.details do
+                        @html.summary('Contact', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           responsibilityClass.writeHtml(hDistributor[:contact])
                         end
+                     end
+                  end
 
-                        # resource distribution - transfer options
-                        hDistributor[:distTransOptions].each do |hTransOption|
-                            htmlTranOpt.writeHtml(hTransOption)
+                  # distributor - order process [] {orderProcess}
+                  hDistributor[:orderProcess].each do |hOrder|
+                     @html.details do
+                        @html.summary('Order Process', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           orderClass.writeHtml(hOrder)
                         end
+                     end
+                  end
 
-                    end # writeHtml
+                  # distributor - transfer options [] {transferOption}
+                  hDistributor[:transferOptions].each do |hTransfer|
+                     @html.details do
+                        @html.summary('Transfer Option', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           transferClass.writeHtml(hTransfer)
+                        end
+                     end
+                  end
 
-                end # class
+               end # writeHtml
+            end # Html_Distributor
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/writers/html/sections/html_document.rb

@@ -0,0 +1,63 @@
+# HTML writer
+
+# History:
+#   Stan Smith 2017-03-22 refactor for mdTranslator 2.0
+#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
+#   Stan Smith 2015-06-23 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-04-07 replaced instruct! with declare! and html to
+#      ... conform with w3 html encoding declarations
+#   Stan Smith 2015-03-23 original script
+
+require_relative 'html_head'
+require_relative 'html_body'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_Document
+
+               def initialize(html, intObj)
+                  @html = html
+                  @@intObj = intObj
+               end
+
+               def writeHtml(responseObj)
+
+                  # classes used
+                  htmlHead = Html_Head.new(@html)
+                  htmlBody = Html_Body.new(@html)
+
+                  version = responseObj[:translatorVersion]
+                  cssLink = responseObj[:writerCSSlink]
+
+                  # write the html document
+                  metadata = @html.declare! :DOCTYPE, :html
+                  @html.html(:lang => 'en') do
+                     htmlHead.writeHtml(version, cssLink)
+                     htmlBody.writeHtml(version, @@intObj)
+                  end
+
+                  return metadata
+
+               end
+
+               # find contact in contact array and return the contact hash
+               def self.getContact(contactId)
+
+                  @@intObj[:contacts].each do |hCont|
+                     if hCont[:contactId] == contactId
+                        return hCont
+                     end
+                  end
+                  return {}
+
+               end
+
+            end # Html_Document
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/html/sections/html_domain.rb

@@ -1,81 +1,72 @@
 # HTML writer
-# data dictionary domain
+# domain
 
 # History:
+#  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-03-26 original script
-#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 
-require_relative 'html_domainMember'
+require_relative 'html_domainItem'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
+   module Mdtranslator
+      module Writers
+         module Html
 
-                class MdHtmlDictionaryDomain
-                    def initialize(html)
-                        @html = html
-                    end
+            class Html_Domain
 
-                    def writeHtml(hDomain)
+               def initialize(html)
+                  @html = html
+               end
 
-                        # classes used
-                        htmlDomMem = MdHtmlDomainMember.new(@html)
+               def writeHtml(hDomain)
 
-                        # domain - user assigned domain id
-                        s = hDomain[:domainId]
-                        if !s.nil?
-                            @html.em('Domain ID: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+                  # classes used
+                  itemClass = Html_DomainItem.new(@html)
 
-                        # domain - domain name
-                        s = hDomain[:domainName]
-                        if !s.nil?
-                            @html.em('Domain name: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+                  # domain - id
+                  unless hDomain[:domainId].nil?
+                     @html.em('ID: ')
+                     @html.text!(hDomain[:domainId])
+                     @html.br
+                  end
 
-                        # domain - domain code
-                        s = hDomain[:domainCode]
-                        if !s.nil?
-                            @html.em('Domain code: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+                  # domain - name
+                  unless hDomain[:domainName].nil?
+                     @html.em('Name: ')
+                     @html.text!(hDomain[:domainName])
+                     @html.br
+                  end
 
-                        # domain - user assigned domain id
-                        s = hDomain[:domainDescription]
-                        if !s.nil?
-                            @html.em('Description: ')
-                            @html.section(:class=>'block') do
-                                @html.text!(s)
-                            end
-                        end
+                  # domain - code
+                  unless hDomain[:domainCode].nil?
+                     @html.em('Code: ')
+                     @html.text!(hDomain[:domainCode])
+                     @html.br
+                  end
 
-                        # domain - domain members
-                        aMembers = hDomain[:domainItems]
-                        if !aMembers.empty?
-                            @html.em('Domain members: ')
-                            aMembers.each do |hDItem|
-                                @html.section(:class=>'block') do
-                                    @html.details do
-                                        @html.summary(hDItem[:itemValue], {'class'=>'h5'})
-                                        @html.section(:class=>'block') do
-                                            htmlDomMem.writeHtml(hDItem)
-                                        end
-                                    end
-                                end
-                            end
-                        end
+                  # domain - description
+                  unless hDomain[:domainDescription].nil?
+                     @html.em('Description: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hDomain[:domainDescription])
+                     end
+                  end
 
-                    end # writeHtml
+                  # domain - domain items [] {domainItem}
+                  hDomain[:domainItems].each do |hItem|
+                     @html.details do
+                        @html.summary(hItem[:itemValue], {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           itemClass.writeHtml(hItem)
+                        end
+                     end
+                  end
 
-                end # class
+               end # writeHtml
+            end # Html_Domain
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/writers/html/sections/html_domainItem.rb

@@ -0,0 +1,49 @@
+# HTML writer
+# domain item
+
+# History:
+#  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-03-26 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_DomainItem
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hItem)
+
+                  # domain member - common name
+                  unless hItem[:itemName].nil?
+                     @html.em('Name: ')
+                     @html.text!(hItem[:itemName])
+                     @html.br
+                  end
+
+                  # domain member - value
+                  unless hItem[:itemValue].nil?
+                     @html.em('Value: ')
+                     @html.text!(hItem[:itemValue])
+                     @html.br
+                  end
+
+                  # domain member - definition
+                  unless hItem[:itemDefinition].nil?
+                     @html.em('Definition: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hItem[:itemDefinition])
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_DomainItem
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/html/sections/html_duration.rb

@@ -0,0 +1,68 @@
+# HTML writer
+# duration
+
+# History:
+#  Stan Smith 2017-03-27 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_Duration
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hDuration)
+
+                  # duration - years
+                  unless hDuration[:years] == 0
+                     @html.em('Years: ')
+                     @html.text!(hDuration[:years].to_s)
+                     @html.br
+                  end
+
+                  # duration - months
+                  unless hDuration[:months] == 0
+                     @html.em('Months: ')
+                     @html.text!(hDuration[:months].to_s)
+                     @html.br
+                  end
+
+                  # duration - days
+                  unless hDuration[:days] == 0
+                     @html.em('Days: ')
+                     @html.text!(hDuration[:days].to_s)
+                     @html.br
+                  end
+
+                  # duration - hours
+                  unless hDuration[:hours] == 0
+                     @html.em('Hours: ')
+                     @html.text!(hDuration[:hours].to_s)
+                     @html.br
+                  end
+
+                  # duration - minutes
+                  unless hDuration[:minutes] == 0
+                     @html.em('Minutes: ')
+                     @html.text!(hDuration[:minutes].to_s)
+                     @html.br
+                  end
+
+                  # duration - seconds
+                  unless hDuration[:seconds] == 0
+                     @html.em('Seconds: ')
+                     @html.text!(hDuration[:seconds].to_s)
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_Duration
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/html/sections/html_entity.rb

@@ -1,138 +1,115 @@
 # HTML writer
-# data dictionary entity
+# entity
 
 # History:
+#  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-03-26 original script
-#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 
 require_relative 'html_entityIndex'
 require_relative 'html_entityAttribute'
+require_relative 'html_entityForeignKey'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
-
-                class MdHtmlDictionaryEntity
-                    def initialize(html)
-                        @html = html
-                    end
-
-                    def writeHtml(hEntity)
-
-                        # classes used
-                        htmlEntIndex = MdHtmlEntityIndex.new(@html)
-                        htmlEntAttrib = MdHtmlEntityAttribute.new(@html)
-
-                        # entity - user assigned entity id
-                        s = hEntity[:entityId]
-                        if !s.nil?
-                            @html.em('Entity ID: ')
-                            @html.text!(s)
-                            @html.br
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_Entity
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hEntity)
+
+                  # classes used
+                  indexClass = Html_EntityIndex.new(@html)
+                  attributeClass = Html_EntityAttribute.new(@html)
+                  foreignClass = Html_EntityForeignKey.new(@html)
+
+                  # entity - entity id
+                  unless hEntity[:entityId].nil?
+                     @html.em('ID: ')
+                     @html.text!(hEntity[:entityId])
+                     @html.br
+                  end
+
+                  # entity - name
+                  unless hEntity[:entityName].nil?
+                     @html.em('Name: ')
+                     @html.text!(hEntity[:entityName])
+                     @html.br
+                  end
+
+                  # entity - code
+                  unless hEntity[:entityCode].nil?
+                     @html.em('Code: ')
+                     @html.text!(hEntity[:entityCode])
+                     @html.br
+                  end
+
+                  # entity - alias names
+                  hEntity[:entityAlias].each do |otherName|
+                     @html.em('Alias: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(otherName)
+                     end
+                  end
+
+                  # entity - definition
+                  unless hEntity[:entityDefinition].nil?
+                     @html.em('Definition: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hEntity[:entityDefinition])
+                     end
+                  end
+
+                  # entity - primary key
+                  unless hEntity[:primaryKey].empty?
+                     @html.em('Primary Key Attribute(s):')
+                     @html.section(:class => 'block') do
+                        hEntity[:primaryKey].each do |attribute|
+                           @html.text!(attribute)
+                           @html.br
                         end
-
-                        # entity - common name
-                        s = hEntity[:entityName]
-                        if !s.nil?
-                            @html.em('Common name: ')
-                            @html.text!(s)
-                            @html.br
-                        end
-
-                        # entity - code
-                        s = hEntity[:entityCode]
-                        if !s.nil?
-                            @html.em('Code name: ')
-                            @html.text!(s)
-                            @html.br
-                        end
-
-                        # entity - alias names
-                        aAlias = hEntity[:entityAlias]
-                        if !aAlias.empty?
-                            @html.em('Entity aliases: ')
-                            @html.section(:class=>'block') do
-                                @html.text!(aAlias.to_s)
-                            end
+                     end
+                  end
+
+                  # entity - indexes [] {entityIndex}
+                  hEntity[:indexes].each do |hIndex|
+                     @html.details do
+                        @html.summary('Index: '+hIndex[:indexCode], {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           indexClass.writeHtml(hIndex)
                         end
-
-                        # entity - definition
-                        s = hEntity[:entityDefinition]
-                        if !s.nil?
-                            @html.em('Definition: ')
-                            @html.section(:class=>'block') do
-                                @html.text!(s.to_s)
-                            end
+                     end
+                  end
+
+                  # entity - attributes [] {entityAttribute}
+                  hEntity[:attributes].each do |hAttribute|
+                     @html.details do
+                        @html.summary('Attribute: '+hAttribute[:attributeCode], {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           attributeClass.writeHtml(hAttribute)
                         end
-
-                        # entity - primary key
-                        aPK = hEntity[:primaryKey]
-                        if !aPK.empty?
-                            @html.em('Primary key: ')
-                            @html.text!(aPK.to_s)
-                            @html.br
+                     end
+                  end
+
+                  # entity - foreign keys [] {entityForeignKey}
+                  hEntity[:foreignKeys].each do |hForeign|
+                     @html.details do
+                        @html.summary('ForeignKey', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           foreignClass.writeHtml(hForeign)
                         end
+                     end
+                  end
 
-                        # entity - other indexes
-                        aIndex = hEntity[:indexes]
-                        if !aIndex.empty?
-                            aIndex.each do |hIndex|
-                                @html.em('Index: ')
-                                @html.section(:class=>'block') do
-                                    htmlEntIndex.writeHtml(hIndex)
-                                end
-                            end
-                        end
-
-                        # entity - attributes
-                        aAttributes = hEntity[:attributes]
-                        if !aAttributes.empty?
-                            @html.em('Attribute List: ')
-                            aAttributes.each do |hAttribute|
-                                @html.section(:class=>'block') do
-                                    @html.details do
-                                        @html.summary(hAttribute[:attributeCode], {'class'=>'h5'})
-                                        @html.section(:class=>'block') do
-                                            htmlEntAttrib.writeHtml(hAttribute)
-                                        end
-                                    end
-                                end
-                            end
-                        end
-
-                        # entity - foreign keys
-                        aFKs = hEntity[:foreignKeys]
-                        if !aFKs.empty?
-                            aFKs.each do |hFK|
-                                @html.em('Foreign Key: ')
-                                @html.section(:class=>'block') do
-
-                                    # foreign key - local attribute list
-                                    @html.em('Local attribute: ')
-                                    @html.text!(hFK[:fkLocalAttributes].to_s)
-                                    @html.br
-
-                                    # foreign key - referenced entity
-                                    @html.em('Referenced entity: ')
-                                    @html.text!(hFK[:fkReferencedEntity])
-                                    @html.br
-
-                                    # foreign key - referenced attribute list
-                                    @html.em('Referenced attribute: ')
-                                    @html.text!(hFK[:fkReferencedAttributes].to_s)
-                                    @html.br
-
-                                end
-
-                            end
-                        end
-
-                    end # writeHtml
-
-                end # class
+               end # writeHtml
+            end # Html_Entity
 
-            end
-        end
-    end
+         end
+      end
+   end
 end