twb 5.1.4 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f839625abecd6c9b4ad520856fd216678790a2dace5307e62458db4e07b970cd
-  data.tar.gz: f95701f60e3f4f99525113e723392b1d039b361db9ac63eb2689c58ef4a3a490
+  metadata.gz: 7e028806f0ddf3f1a48cda4ae9476f63f9302107cab1116673f1934f96143919
+  data.tar.gz: ec93e736c7833c5801cdc5fa7bd9344addd0de495d26d7e7d9af81633abbef52
 SHA512:
-  metadata.gz: d59954bb21cc6b232402d0792219df4e0e48ddcf8a664088b58409c7e28b30175f3f3304910459304f2d87639bf1ce5a6f7d9b533b43ed0088bfbb1c4f131c8f
-  data.tar.gz: c8fa036df0e3e8808f507404f5930a8db20ca19fb7a04251eda1deee7dc1ea09f1e06a811f79539275d2eed9cb473f009239dca5ae1c56c7179f4826ed0201c0
+  metadata.gz: 620200b5922bff2813fc62503fcce0faa43a9f3daade99e87e003fe05a856aae102a7a8fef67fe7ddb4e847cdb8a0594fc66eea6377cf46955fd0708995cf8eb
+  data.tar.gz: a7db358530ed931716db2221206eae088ce2b82a61a638dca303863c738d88f7283e2b791dba8feefe321cf7478f1f0d44b233b3fdc21958778defdc365ad21d

data/lib/twb.rb

@@ -54,6 +54,7 @@ require_relative 'twb/analysis/documentedfieldsmarkdownemitter'
 require_relative 'twb/analysis/annotatedfieldscsvemitter'
 require_relative 'twb/analysis/workbooksummaryanalyzer'
 require_relative 'twb/analysis/calculatedfields/calculatedfieldsanalyzer'
+require_relative 'twb/analysis/calculatedfields/dotanalyzer'
 require_relative 'twb/analysis/calculatedfields/groupfieldsanalyzer'
 require_relative 'twb/analysis/calculatedfields/markdownemitter'
 require_relative 'twb/analysis/calculatedfields/csvemitter'
@@ -80,5 +81,5 @@ require_relative 'twb/analysis/sheets/sheetsintooltipanalyzer'
 # Represents Tableau Workbooks, their contents, and classes that analyze and manipulate them.
 #
 module Twb
-  VERSION = '5.1.4'
+  VERSION = '5.2.0'
 end

data/lib/twb/analysis/calculatedfields/calculatedfieldsanalyzer.rb

@@ -78,12 +78,12 @@ module Analysis
       @fieldTables = {}
 
 
-      @@dotHeader = <<DOTHEADER
-  digraph g {
-      graph [rankdir="LR" splines=line];
-      node  [shape="box"  width="2"];
+#       @@dotHeader = <<DOTHEADER
+#   digraph g {
+#       graph [rankdir="LR" splines=line];
+#       node  [shape="box"  width="2"];
 
-DOTHEADER
+# DOTHEADER
 
       def initialize(**args)
           emit "initialize CalculatedFieldsAnalyzer args #{args}"
@@ -141,7 +141,7 @@ DOTHEADER
           # end
           processDataSource ds
         end
-        mapTwb
+        # mapTwb
         emitGml
         @twbCount += 1
         finis
@@ -195,10 +195,10 @@ DOTHEADER
               calculatedFields.add calcField.id
               dsFields[calcField.uiname] = calcField
               # if @doGraph
-                calcFieldNode    = Twb::Util::Graphnode.new(name: calcField.uiname, id: calcField.id, type: calcField, properties: {:DataSource => ds.uiname})
-                @nodes.add calcFieldNode
-                dsFieldEdge     = Twb::Util::Graphedge.new(from: dataSourceNode, to: calcFieldNode, relationship: 'contains')
-                @edges.add dsFieldEdge
+              calcFieldNode    = Twb::Util::Graphnode.new(name: calcField.uiname, id: calcField.id, type: calcField, properties: {:DataSource => ds.uiname})
+              @nodes.add calcFieldNode
+              dsFieldEdge     = Twb::Util::Graphedge.new(from: dataSourceNode, to: calcFieldNode, relationship: 'contains')
+              @edges.add dsFieldEdge
               # end
               calculation     = calcField.calculation
               if calculation.has_formula
@@ -265,46 +265,10 @@ DOTHEADER
                                             '',  # rf.id,
                                             '',  #refFieldTable
                                           ]
-
-
-                    # emit "  referenced field.name  ::'#{rf.name.nil?}'  :: '#{rf.name}'"
-                    # emit "  referenced field.uiname::'#{rf.uiname}'"
-                    # if @doGraph
-                            # unless rf.uiname.nil?
-                            #   properties = {'DataSource' => ds.uiname, 'DataSourceReference' => 'local', :source => rf}
-                            #   refFieldNode  = Twb::Util::Graphnode.new(name: rf.uiname, id: rf.id,   type: rf.type, properties: properties)
-                            #   @nodes.add refFieldNode
-                            #   fieldFieldEdge = Twb::Util::Graphedge.new(from: calcFieldNode,  to: refFieldNode, relationship: 'references')
-                            #   @edges.add fieldFieldEdge
-                            # end
-                            # # end
-                            # referencedFields.add rf.id
-                            # refFieldTable = ds.fieldTable(rf.name)
-                            # emit "refFieldTable.nil? : #{refFieldTable.nil?}"
-                            # unless refFieldTable.nil?
-                            #   tableID        = refFieldTable + ':::' + ds.uiname
-                            #   tableName      = "||#{refFieldTable}||"
-                            #   # if @doGraph
-                            #     tableNode      = Twb::Util::Graphnode.new(name: tableName,      id: tableID,   type: :DBTable, properties: properties)
-                            #     @nodes.add tableNode
-                            #     fieldFieldEdge = Twb::Util::Graphedge.new(from: refFieldNode,  to: tableNode, relationship: 'is a field in')
-                            #     @edges.add fieldFieldEdge
-                            #   # end
-                            #   # fldToDsNode    = tableNode
-                            # end
-                            # @csvFormulaFields <<  [ 
-                            #                         @referencedFieldsCount += 1,
-                            #                         @twb.name,
-                            #                         # @modTime,
-                            #                         ds.uiname,
-                            #                         calcField.uiname,
-                            #                         calculation.formulaFlat,
-                            #                         calculation.formulaFlatResolved,
-                            #                         rf.name,
-                            #                         rf.uiname,
-                            #                         rf.id,
-                            #                         refFieldTable
-                            #                       ]
+                    refFieldNode    = Twb::Util::Graphnode.new(name: rf.uiname, id: rf.id, type: rf, properties: {:DataSource => ds.uiname})
+                    @nodes.add refFieldNode
+                    refFieldEdge     = Twb::Util::Graphedge.new(from: calcFieldNode, to: refFieldNode , relationship: 'references')
+                    @edges.add refFieldEdge
                   end # resolvedFields.each do
               end # if calculation.has_formula
             end # ds.calculatedFields.each 
@@ -345,49 +309,49 @@ DOTHEADER
             emit "\t       formula:: #{calculation.formulaFlat}"
           end
 
-          def mapTwb 
-            twb        = @twb.name
-            rootFields = @twbRootFields
-            dotStuff    = initDot twb
-            dotFile     = dotStuff[:file]
-            dotFileName = dotStuff[:name]
-            dotFile.puts "\n //  subgraph cluster_1 {"
-            dotFile.puts "   //    color= grey;"
-            dotFile.puts ""
-            edgesAsStrings = SortedSet.new
-            # this two step process coalesces the edges into a unique set, avoiding duplicating the dot
-            # file entries, and can be shrunk when graph edges expose the bits necessary for management by Set
-            emit "\n========================\nLoading Edges\n========================\n  From DC?  Referenced?  Edge \n  %s  %s  %s" % ['--------', '-----------', '-'*45]
-            @edges.each do |e|
-              # don't want to emit edge which is from a Data Connection to a
-              # Calculated Field which is also referenced by another calculated field
-              isFromDC   = e.from.type == :TwbDataConnection
-              isRefField = @referencedFields.include?(e.to.id)
-              edgesAsStrings.add(e.dot) unless isFromDC && isRefField
-              # emit "   ES        #{e.dot}"
-              # emit "   ES  from  #{e.from}"
-              # emit "   ES    to  #{e.to}"
-            end
-            emit "------------------------\n "
-            edgesAsStrings.each do |es|
-              dotFile.puts "        #{es}"
-            end
-            emit "========================\n "
-            dotFile.puts ""
-            dotFile.puts "   // }"
-            dotFile.puts "\n\n  //  4 NODES --------------------------------------------------------------------"
-            @nodes.each do |n|
-              dotFile.puts n.dotLabel
-            end
-            dotFile.puts "\n\n  //  5--------------------------------------------------------------------"
-            emitTypes(      dotFile )
-            closeDot(       dotFile, twb )
-            emit "Rendering DOT file - #{twb}"
-            renderDot(twb,dotFileName,'pdf')
-            renderDot(twb,dotFileName,'png')
-            renderDot(twb,dotFileName,'svg')
-            # emitEdges
-          end
+          # def mapTwb 
+          #   twb        = @twb.name
+          #   rootFields = @twbRootFields
+          #   dotStuff    = initDot twb
+          #   dotFile     = dotStuff[:file]
+          #   dotFileName = dotStuff[:name]
+          #   dotFile.puts "\n //  subgraph cluster_1 {"
+          #   dotFile.puts "   //    color= grey;"
+          #   dotFile.puts ""
+          #   edgesAsStrings = SortedSet.new
+          #   # this two step process coalesces the edges into a unique set, avoiding duplicating the dot
+          #   # file entries, and can be shrunk when graph edges expose the bits necessary for management by Set
+          #   emit "\n========================\nLoading Edges\n========================\n  From DC?  Referenced?  Edge \n  %s  %s  %s" % ['--------', '-----------', '-'*45]
+          #   @edges.each do |e|
+          #     # don't want to emit edge which is from a Data Connection to a
+          #     # Calculated Field which is also referenced by another calculated field
+          #     isFromDC   = e.from.type == :TwbDataConnection
+          #     isRefField = @referencedFields.include?(e.to.id)
+          #     edgesAsStrings.add(e.dot) unless isFromDC && isRefField
+          #     # emit "   ES        #{e.dot}"
+          #     # emit "   ES  from  #{e.from}"
+          #     # emit "   ES    to  #{e.to}"
+          #   end
+          #   emit "------------------------\n "
+          #   edgesAsStrings.each do |es|
+          #     dotFile.puts "        #{es}"
+          #   end
+          #   emit "========================\n "
+          #   dotFile.puts ""
+          #   dotFile.puts "   // }"
+          #   dotFile.puts "\n\n  //  4 NODES --------------------------------------------------------------------"
+          #   @nodes.each do |n|
+          #     dotFile.puts n.dotLabel
+          #   end
+          #   dotFile.puts "\n\n  //  5--------------------------------------------------------------------"
+          #   emitTypes(      dotFile )
+          #   closeDot(       dotFile, twb )
+          #   emit "Rendering DOT file - #{twb}"
+          #   renderDot(twb,dotFileName,'pdf')
+          #   renderDot(twb,dotFileName,'png')
+          #   renderDot(twb,dotFileName,'svg')
+          #   # emitEdges
+          # end
 
           def cypher twbName
             if @doGraph
@@ -503,44 +467,44 @@ DOTHEADER
             dotFile.puts '   }'
           end
 
-          def initDot twb
-            dotFileName = docFile("#{twb}#{@@processName}.dot")
-            dotFile = File.open(dotFileName,'w')
-            dotFile.puts @@dotHeader
-            return {:file => dotFile, :name => dotFileName}
-          end
+          # def initDot twb
+          #   dotFileName = docFile("#{twb}#{@@processName}.dot")
+          #   dotFile = File.open(dotFileName,'w')
+          #   dotFile.puts @@dotHeader
+          #   return {:file => dotFile, :name => dotFileName}
+          # end
 
-          def closeDot dotFile, twb
-            dotFile.puts ' '
-            dotFile.puts '// -------------------------------------------------------------'
-            dotFile.puts ' '
-            dotFile.puts '   subgraph cluster_1 {'
-            # dotFile.puts '     color=white;'
-            dotFile.puts '     style=invis;'
-            # dotFile.puts '     border=0;'
-            dotFile.puts '     node [border=blue];'
-            dotFile.puts ' '
-            dotFile.puts '     "" [style=invis]'
-            dotFile.puts "     \"Tableau Tools\\nCalculated Fields Map\\nWorkbook '#{twb}'\\n#{Time.new.ctime}\"  [penwidth=0]"
-            # dotFile.puts "     \"Tableau Tools Workbook  Calculated Fields Map\\n#{Time.new.ctime}\"  -> \"\"  [style=invis]"
-            dotFile.puts ' '
-            dotFile.puts '   }'
-            dotFile.puts ' '
-            dotFile.puts '}'
-            dotFile.close
-          end
+          # def closeDot dotFile, twb
+          #   dotFile.puts ' '
+          #   dotFile.puts '// -------------------------------------------------------------'
+          #   dotFile.puts ' '
+          #   dotFile.puts '   subgraph cluster_1 {'
+          #   # dotFile.puts '     color=white;'
+          #   dotFile.puts '     style=invis;'
+          #   # dotFile.puts '     border=0;'
+          #   dotFile.puts '     node [border=blue];'
+          #   dotFile.puts ' '
+          #   dotFile.puts '     "" [style=invis]'
+          #   dotFile.puts "     \"Tableau Tools\\nCalculated Fields Map\\nWorkbook '#{twb}'\\n#{Time.new.ctime}\"  [penwidth=0]"
+          #   # dotFile.puts "     \"Tableau Tools Workbook  Calculated Fields Map\\n#{Time.new.ctime}\"  -> \"\"  [style=invis]"
+          #   dotFile.puts ' '
+          #   dotFile.puts '   }'
+          #   dotFile.puts ' '
+          #   dotFile.puts '}'
+          #   dotFile.close
+          # end
 
 
-          def renderDot twb, dot, format
-            imageType = '-T' + format
-            imageFile  = './ttdoc/' + twb + @@processName + 'Graph.' + format
-            imageParam = '-o"' + imageFile + '"'
-            emit  "system  #{@@gvDotLocation} #{imageType} #{imageParam} \"#{dot}\""
-                   system "#{@@gvDotLocation} #{imageType} #{imageParam} \"#{dot}\""
-            emit  "           - #{imageFile}"
-            @imageFiles << imageFile
-            return imageFile
-          end
+          # def renderDot twb, dot, format
+          #   imageType = '-T' + format
+          #   imageFile  = './ttdoc/' + twb + @@processName + 'Graph.' + format
+          #   imageParam = '-o"' + imageFile + '"'
+          #   emit  "system  #{@@gvDotLocation} #{imageType} #{imageParam} \"#{dot}\""
+          #          system "#{@@gvDotLocation} #{imageType} #{imageParam} \"#{dot}\""
+          #   emit  "           - #{imageFile}"
+          #   @imageFiles << imageFile
+          #   return imageFile
+          # end
 
   end #  class
 

data/lib/twb/analysis/calculatedfields/dotanalyzer.rb

@@ -0,0 +1,139 @@
+#  dotanalyzer.rb - this Ruby script Copyright 2017, 2018 Christopher Gerrard
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+module Twb
+module Analysis
+module CalculatedFields
+
+  class DotAnalyzer
+    include TabTool
+
+    attr_reader :docFileName
+
+    @@gvDotLocation = 'C:\\tech\\graphviz\\Graphviz2.38\\bin\\dot.exe'
+    @@imageTypes = ['pdf', 'png', 'svg']
+
+    def initialize(**args)
+      @args = args
+      init
+      @funcdoc = {:class=>self.class, :blurb=>'Create Dot files documenting Calculated Fields', :description=>'Analyze Calculated Fields - create Dot files' }
+      @metrics = {}
+      @imageFiles = Array.new
+    end
+
+    def processTWB twb
+      # twb = File.basename(twb)
+      @twb         = twb #Twb::Workbook.new twb
+      addDocFile @dotFile, @dotFileName, "Dot file of Calculated fields for Workbook '#{@twb.name}'"
+      @twb.datasources.each do |ds|
+        unless ds.calculatedFields.empty?
+          initDotFile ds.uiname
+          # @dotFile.puts "\n ## #{ds.uiname} \n "
+          # @dotFile.puts "__has #{ds.calculatedFields.length} calculated fields__\n "
+          @cfCnt = 0
+          calcFields = Set.new
+          refFields  = Set.new
+          edges      = Set.new
+          ds.calculatedFields.each do |cf|
+            @cfCnt += 1
+            calcFields << cf.uiname
+            edges            << " \"#{ds.uiname}\" -> \"#{cf.uiname}\"  [tailport=e, headport=w] "
+            cf.referencedFields.each do |rf|
+              refFields << rf.uiname
+              edges            << " \"#{cf.uiname}\" -> \"#{rf.uiname}\" [tailport=e, headport=w] "
+            end
+          end # ds.calculatedFields.each
+          # "federated.17h7owt0rsacke17cql8o0w2ittk"  ->  "New AO Actuals Query in PP+ (AO Variance Data)::vs Prior Year [YTD]"
+          # "federated.01s5lca037ted31gxs9sg0t9mnnt" [label="Controls"    ]
+          edges.each do |edge|
+            @dotFile.puts "\t #{edge.strip}"
+          end
+          @dotFile.puts " "
+          allFields = calcFields + refFields
+          allFields.each do |f|
+            @dotFile.puts "\t \"#{f}\" [label=\"#{f}\"]"
+          end
+          endPointFields = allFields - calcFields
+          rankSame(endPointFields) unless endPointFields.nil? || endPointFields.empty?
+          closeDotFile
+          @@imageTypes.each do |type|
+            renderDot type
+          end
+        end
+      end  # twb.datasources.each
+      finis
+    end    # def processTwb twb
+
+    private
+
+    def initDotFile dsName
+      @dotFileName = './ttdoc/' + @twb.name + '.' + dsName + '.CalculatedFields.dot'
+      @dotFile     = File.open(@dotFileName,'w')
+      # @dotFile.puts @@dotHeader
+      @dotFile.puts ' digraph g {'
+      @dotFile.puts '   graph [rankdir="LR" splines=line];'
+      @dotFile.puts '   node  [shape="box"  width="2"];'
+      @dotFile.puts ' '
+      @dotFile.puts '   subgraph cluster_0 {'
+    end
+
+    def closeDotFile
+      # @dotFile.puts "\n # counted #{@cfCnt} calculated fields\n "
+      # @dotFile.puts "\n }"
+     @dotFile.puts '   }'
+      @dotFile.puts ' '
+      @dotFile.puts '// -------------------------------------------------------------'
+     @dotFile.puts ' '
+     @dotFile.puts '   subgraph cluster_1 {'
+      #@dotFile.puts '     color=white;'
+     @dotFile.puts '     style=invis;'
+      #@dotFile.puts '     border=0;'
+     @dotFile.puts '     node [border=blue];'
+     @dotFile.puts ' '
+     @dotFile.puts '     "" [style=invis]'
+     @dotFile.puts "     \"Tableau Tools\\nCalculated Fields Map\\nWorkbook '#{@twb.name}'\\n#{Time.new.ctime}\"  [penwidth=0]"
+      #@dotFile.puts "     \"Tableau Tools Workbook  Calculated Fields Map\\n#{Time.new.ctime}\"  -> \"\"  [style=invis]"
+     @dotFile.puts ' '
+     @dotFile.puts '   }'
+     @dotFile.puts ' '
+     @dotFile.puts '}'
+      @dotFile.close
+    end
+
+      def rankSame fields
+        @dotFile.puts "\n {rank=same "
+        fields.each do |f|
+          @dotFile.puts "\t \"#{f}\" "
+        end
+        @dotFile.puts " } "
+      end
+
+      def renderDot format
+        imageType = '-T' + format
+        imageFile  = @dotFileName + '.Graph.' + format
+        imageParam = '-o"' + imageFile + '"'
+        emit "system  #{@@gvDotLocation} #{imageType} #{imageParam} \"#{@dotFileName}\""
+        system "#{@@gvDotLocation} #{imageType} #{imageParam} \"#{@dotFileName}\""
+        # emit  "           - #{imageFile}"
+        @imageFiles << imageFile
+        return imageFile
+      end
+
+  end # class DotAnalyzer
+
+end   # nodule CalculatedFields
+end   # module Analysis
+end   # module Twb

data/lib/twb/analysis/calculatedfields/markdownemitter.rb

@@ -52,10 +52,10 @@ module CalculatedFields
             @docFile.puts "#{l.gsub('<<','[').gsub('>>',']')}" 
           end
           @docFile.puts "```"
-          if cf.calcFields.length > 0
+          if cf.referencedFields.length > 0
             fieldsRefOrder  = []
             fieldsSortSet   = SortedSet.new
-            cf.calcFields.each do |field|
+            cf.referencedFields.each do |field|
               fieldsRefOrder.push field.uiname
               fieldsSortSet << field.uiname
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 5.1.4
+  version: 5.2.0
 platform: ruby
 authors:
 - Chris Gerrard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: creek
@@ -64,6 +64,7 @@ files:
 - lib/twb/analysis/annotatedfieldscsvemitter.rb
 - lib/twb/analysis/calculatedfields/calculatedfieldsanalyzer.rb
 - lib/twb/analysis/calculatedfields/csvemitter.rb
+- lib/twb/analysis/calculatedfields/dotanalyzer.rb
 - lib/twb/analysis/calculatedfields/fieldsaliasesanalyzer.rb
 - lib/twb/analysis/calculatedfields/groupfieldsanalyzer.rb
 - lib/twb/analysis/calculatedfields/markdownemitter.rb