twb 3.7.2 → 3.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd921c477a3ab3ef1de872935a8057bd4fd5ea27
-  data.tar.gz: de2bc297a944a544bb0f251ac5cc9f972e1f763c
+  metadata.gz: 183bcd3f582a9939faf1544d4b4ecfda0cd36f0a
+  data.tar.gz: 3daae7542ce46541dd310e6f27d717530db9ac95
 SHA512:
-  metadata.gz: 46becdab0ca9837b76ddd7ffc46e26433ab130bda120c5150ddce3575da04e80309874dfef9ca69531556b6185b46131889b62fe3f0a05e58b341be83ef04d56
-  data.tar.gz: 41f15a08b3b9971c4ca237ea5a166c212488c6e13a5ee3ca59613b8894d7b23d619e9d54fbc3c41280b4fc543c9109af1985befb92a7b42dc2bea00dc14f865a
+  metadata.gz: aa968978835cf31847e3446bc02107662b00e3213e4d1345104ace41b6cddd3d2c6d7756bd6ec4ae9a6bcae22acb4904e53771658b210d1847852558f29d43f8
+  data.tar.gz: c19335e986bbbf10166e96b97bb2e0064091fe2e71af00bbc0bc17c4e87b01fa51eefc019ea19e3e23149efaf341d2d95484ffdd06aa19b7e9122713439e639a

data/lib/twb.rb

@@ -60,5 +60,5 @@ require_relative 'twb/analysis/Sheets/sheetfieldsanalyzer'
 # Represents Tableau Workbooks and their contents.
 #
 module Twb
-  VERSION = '3.7.2'
+  VERSION = '3.7.5'
 end

data/lib/twb/analysis/CalculatedFields/CalculatedFieldsAnalyzer.rb

@@ -21,9 +21,10 @@ require 'csv'
 module Twb
 module Analysis
 
-  class CalculatedFieldsAnalyzer < Twb::Util::Graph
+  class CalculatedFieldsAnalyzer # < Twb::Util::Graph
 
       include TabTool
+      include Graph
 
       attr_reader   :calculatedFieldsCount, :formulaFieldsCount, :dataFiles
       attr_accessor :ttdocdir
@@ -81,12 +82,7 @@ module Analysis
 DOTHEADER
 
       def initialize
-          #-- Logging setup --
-          @ttdocdir = 'ttdoc'
-          # logfile   = docFile(@@ttlogfile)
-          # @logger   = Logger.new(logfile)
-          # @logger.level = Logger::DEBUG
-          emit '  Initializing CalculatedFieldsAnalyzer'
+          @funcdoc = {:class=>self.class, :blurb=>'Analyzing Calculated Fields from Tableau Workbooks.', :description=>'Calculated fields can be complex, this tool provides robust coverage.',}
           #-- CSV records collectors
           @csvCalculatedFields = []
           @csvFormulaFields    = []
@@ -98,43 +94,12 @@ DOTHEADER
           #--
           @referencedFields     = SortedSet.new
           #--
-          emit "init CSV #{@@calcFieldsCSVFileName}"
-          @csvCF = File.open(docFile(@@calcFieldsCSVFileName), 'w')
-          @csvCF.puts @@calcFieldsCSVFileHeader.to_csv
-          # @csvCF.close
-          #--
-          emit "init CSV #{@@calcLinesCSVFileName}"
-          @csvCFLs = File.open(docFile(@@calcLinesCSVFileName), 'w')
-          @csvCFLs.puts @@calcLinesCSVFileHeader.to_csv
-          # @csvCFLs.close
-          #--
-          emit "init CSV #{@@formFieldsCSVFileName}"
-          @csvFF = File.open(docFile(@@formFieldsCSVFileName), 'w')
-          @csvFF.puts @@formFieldsCSVFileHeader.to_csv
-          # @csvFF.close
-          #--
-          @dataFiles   = { @@calcFieldsCSVFileName => 'Calculated Fields & their Formulas', 
-                           @@calcLinesCSVFileName  => 'Calculated Fields & individual Formula Lines',
-                           @@formFieldsCSVFileName => 'Fields referenced in Formulas'
-                         }
+          @csvCF   = initCSV(@@calcFieldsCSVFileName, 'Calculated fields and their formulas.',                      @@calcFieldsCSVFileHeader)
+          @csvCFLs = initCSV(@@calcLinesCSVFileName,  "Calculated fields and their formulas' individual lines.",    @@calcLinesCSVFileHeader)
+          @csvFF   = initCSV(@@formFieldsCSVFileName, 'Calculated fields and the fields their formulas reference.', @@formFieldsCSVFileHeader)
           #--
           @localEmit  = false
-          @imageFiles  = []
-      end
-
-      def initDocDir
-        return if $ttdocdir.nil?
-        return if ''.eql? $ttdocdir
-        return if Dir.exists?($ttdocdir)
-        if File.exists? $ttdocdir
-            $ttdocdir = nil
-            return
-        end
-        Dir.mkdir $ttdocdir
-      end
-
-      def docFile name
-        @ttdocdir.nil? ? name : "#{@ttdocdir}\\#{name}"
+          @imageFiles = []
       end
 
       def processTWB workbook
@@ -221,19 +186,19 @@ DOTHEADER
               emit "@@ FL: #{calcField.uiname}"
               calculation.formulaResolvedLines.each do |fl|
                 emit "@@ FL:   => '#{fl}'"
-                fieldFormulaLines.push [ @calculatedFieldsCount,        # 'Calc Field #',
-                                         @twb.name,                     # 'Workbook',      
-                                         @twbDir,                       # 'Workbook Dir',
-                                         ds.uiname,                     # 'Data Source',   
-                                         ds.caption,                    # 'Data Source Caption', 
-                                         ds.name,                       # 'Data Source Name (tech)',
-                                         calcField.uiname,              # 'Field Name',    
-                                         calcField.caption,             # 'Field Caption',       
-                                         calcField.name,                # 'Field Name (tech)',
-                                         calcField.calculation.formulaFlatResolved, # 'Formula'
-                                         flnum += 1,                    # 'Formula Line #',
-                                         fl.start_with?(" ") ? "'#{fl}" : fl # 'Formula Line' - THIS IS A STUPID HACK NEEDED BECAUSE TABLEAU STRIPS LEADING BLANKS FROM CSV VALUES
-                                       ]
+                fieldFormulaLines << [ @calculatedFieldsCount,        # 'Calc Field #',
+                                       @twb.name,                     # 'Workbook',      
+                                       @twbDir,                       # 'Workbook Dir',
+                                       ds.uiname,                     # 'Data Source',   
+                                       ds.caption,                    # 'Data Source Caption', 
+                                       ds.name,                       # 'Data Source Name (tech)',
+                                       calcField.uiname,              # 'Field Name',    
+                                       calcField.caption,             # 'Field Caption',       
+                                       calcField.name,                # 'Field Name (tech)',
+                                       calcField.calculation.formulaFlatResolved, # 'Formula'
+                                       flnum += 1,                    # 'Formula Line #',
+                                       fl.start_with?(" ") ? "'#{fl}" : fl # 'Formula Line' - THIS IS A STUPID HACK NEEDED BECAUSE TABLEAU STRIPS LEADING BLANKS FROM CSV VALUES
+                                     ]
               end
               #-- collect fields referenced in formula
               calculation.calcFields.each do |rf|
@@ -256,19 +221,19 @@ DOTHEADER
                   @edges.add fieldFieldEdge
                   # fldToDsNode    = tableNode
                 end
-                @csvFormulaFields.push [ 
-                                          @formulaFieldsCount += 1,
-                                          @twb.name,           
-                                          @twbDir,
-                                          ds.uiname,
-                                          calcField.uiname,
-                                          calculation.formulaFlat,
-                                          calculation.formulaResolved,
-                                          rf.name,
-                                          rf.uiname,
-                                          rf.id,
-                                          refFieldTable
-                                       ]
+                @csvFormulaFields <<  [ 
+                                        @formulaFieldsCount += 1,
+                                        @twb.name,           
+                                        @twbDir,
+                                        ds.uiname,
+                                        calcField.uiname,
+                                        calculation.formulaFlat,
+                                        calculation.formulaResolved,
+                                        rf.name,
+                                        rf.uiname,
+                                        rf.id,
+                                        refFieldTable
+                                      ]
               end # resolvedFields.each do
           end # if calculation.has_formula
         end # ds.calculatedFields.each 
@@ -280,35 +245,24 @@ DOTHEADER
         cypherPy   @twb.name
         emit "#######################"
         #-- record calculated fields 
-            # @csvCF = File.open(docFile(@@calcFieldsCSVFileName), 'a')
-            # @csvCF.puts @@calcFieldsCSVFileHeader.to_csv
         emit "@@ record calculated fields  ds: #{ds.uiname}"
-        # @csvCF.open('a')
         @csvCalculatedFields.each do |r| 
-          @csvCF.puts r.to_csv
+          @csvCF << r
         end
         #-- record individual formula lines 
-          # @csvCFLs = File.open(docFile(@@calcLinesCSVFileName), 'a')
-          # @csvCFLs.puts @@calcLinesCSVFileHeader.to_csv
         emit "@@ individual formula lines  ds: #{ds.uiname}"
         fieldFormulaLines.each do |ffl|
-          emit "@@@@ FFLA: #{ffl}" 
-          emit "@@@@ FFLB: #{ffl.to_csv}" 
-          emit "@@@@ FFLc: " 
-          @csvCFLs.puts ffl.to_csv
+          @csvCFLs << ffl
         end
         #-- record formula-referenced fields 
-          # @csvFF = File.open(docFile(@@formFieldsCSVFileName), 'a')
-          # @csvFF.puts @@formFieldsCSVFileHeader.to_csv
         emit "@@ formula-referenced fields ds: #{ds.uiname}"
         @csvFormulaFields.each do |r| 
-          @csvFF.puts r.to_csv
+          @csvFF << r
         end
         #--
         return @imageFiles
       end # def processDataSource
 
-
       def emitCalcfield calcField
         emit "\t FIELD    cap :: #{calcField.caption} "
         emit "\t         tname:: #{calcField.name}"

data/lib/twb/analysis/CalculatedFields/MarkdownEmitter.rb

@@ -32,13 +32,13 @@ module CalculatedFields
       @twb = twb #Twb::Workbook.new twb
       @docFileName = './ttdoc/' + @twb.name + '.CalculatedFields.md'
       @docFile     = File.open(@docFileName,'w')
-      @docFile.puts "## #{twb.name}"
+      @docFile.puts "# #{twb.name}"
       dsNames = @twb.datasourceUINames
       @docFile.puts "#{dsNames.length} Data Sources"
       
 
       @twb.datasources.each do |ds|
-        @docFile.puts "# #{ds.uiname}"
+        @docFile.puts "## #{ds.uiname}"
         @docFile.puts "__has #{ds.calculatedFields.length} calculated fields__\n "
         cnt = 0
         ds.calculatedFields.each do |cf|

data/lib/twb/analysis/DataSources/googlesheetdatasourcesanalyzer.rb

@@ -28,14 +28,21 @@ module Analysis
     attr_reader   :twbname, :twbcount
 
     def initialize
+      #-- set up metrics
       @twbcount   = 0
-      @sheetCnt   = 0
-      @filterCnt  = 0
+      @dscount    = 0
+      @sheetcount = 0
+      @metrics    = {
+                      '# of Workbooks'   => @twbcount  ,
+                      '# of Worksheets'  => @dscount   ,
+                      '# of Worksheets'  => @sheetcount
+                    }
+      #--
       @funcdoc    = {:class=>self.class, :blurb=>'Analyzing Google Sheet Data Sources from Tableau Workbooks.', :description=>nil,}
       docFileName = docFile('TWBGoogleSheetDataSources.csv')
       @csv        = CSV.open(docFileName, 'w')
       @csv       << ["Workbook",'Data Source','Connection','File Name','Type','Table Name','Field']
-      @docfiles = [{:name=>docFileName,:desc=>"CSV File containing the data relating Google Sheet-based Data Sources."}]
+      @docfiles = [{:name=>docFileName,:description=>"CSV File containing the data relating Google Sheet-based Data Sources."}]
     end
 
     def processTWB twb

data/lib/twb/analysis/Sheets/sheetfieldsanalyzer.rb

@@ -15,7 +15,6 @@
 
 require 'twb'
 require 'csv'
-require 'set'
 
 module Twb
 module Analysis
@@ -34,7 +33,7 @@ module Analysis
       docFileName = docFile('TWBWorksheetFields.csv')
       @sheetFieldsCSV  = CSV.open(docFileName,'w')
       @sheetFieldsCSV  << ['Workbook','Worksheet','Data Source','Data Source (tech)','Field','Field (tech)']
-      @docfiles = [{:name=>docFileName,:desc=>"CSV File containing the data relating Workbooks,Worksheets, and the sheets' Data Sources and Fields"}]
+      addDocFile docFileName, "CSV File containing the data relating Workbooks,Worksheets, and the sheets' Data Sources and Fields"
     end
 
     def processTWB twb
@@ -45,7 +44,6 @@ module Analysis
        parseSheets
     end
 
-
     def parseSheets
       @worksheets  = @twb.worksheets
       @worksheets.each do |sheet|

data/lib/twb/tabtool.rb

@@ -17,29 +17,75 @@ require 'logger'
 
 module TabTool
 
-  attr_accessor :ttdocdir, :logger,  :loglevel, :logfilename
-  attr_reader   :funcdoc,  :docfiles
+  attr_accessor :ttdocdir, :logger,   :loglevel, :logfilename
+  attr_reader   :funcdoc,  :docfiles, :metrics 
 
   TTDOCDIR = './ttdoc'
 
   @funcdoc     = {:class=>nil, :blurb=>nil, :description=>nil,}
-  @docfiles    = {}
+  @docfiles    = []  # should be of form [{:name=>'docFileName',:description=>'doc file description'}]
 
   @ttdocdir    = './ttdoc'
   @logfilename = 'TabTools.ttlog'
   @loglevel    = Logger::DEBUG
   @localEmit   = false
+  @docDirSet   = false
 
   def funcdoc
     @funcdoc.nil? ? {:class=>'n/a', :blurb=>'generic TabTool blurb', :description=>'A useful Tableau Tool.'} : @funcdoc
   end
 
   def docFile name
-    # emit "docFile:  TTDOCDIR: #{TTDOCDIR}  name:'#{name}'"
-    TTDOCDIR.nil? ? name : "#{TTDOCDIR}/#{name}"
+    initDocDir unless @docDirSet
+    @docDir.nil? ? name : "#{@docDir}/#{name}"
+  end
+
+  def docfiles
+    @docfiles ||= @docfiles = []
+  end
+
+  def addDocFile name, description
+    @docfiles = [] if @docfiles.nil?
+    @docfiles << {:name=>name,:description=>description}
+  end
+
+  def docFileMaxNameLen
+    maxlen = 0
+    docfiles.each do |f|
+      nameLen = f[:name].class == String ? [maxlen, f[:name].length].max : 0
+      maxlen = nameLen.nil? ? maxlen : [maxlen,nameLen].max
+    end
+    return maxlen
+  end
+
+  def docfilesdoc
+    lines   = SortedSet.new
+    unless @docfiles.nil? || @docfiles.empty?
+      nameLen = docFileMaxNameLen
+      docfiles.each do |dfi|
+        lines << "    - %-#{nameLen}s    %-s " % [ dfi[:name], dfi[:description] ]
+      end
+    end
+    docLines = lines.empty? ? [] : [' ','For documentation and generated data see the following:',' ']
+    lines.each do |l|
+      docLines << l
+    end
+    return docLines
+  end
+
+  def initCSV(fileName, desc=nil, header=nil)
+    # puts 'initCSV'
+    # puts "  @docDirSet: #{@docDirSet}    "
+    csvName =  docFile(fileName)
+    emit "init CSV #{csvName}"
+    csvFile = CSV.open(csvName, 'w')
+    csvFile << header unless header.nil?
+    addDocFile csvName,desc
+    return csvFile
   end
 
   def emit(local=@localEmit, stuff)
+      initDocDir if @docDirSet.nil? || !@docDirSet
       initLogger if @logger.nil?
       if stuff.is_a? String then
         lines = stuff.split(/\n/)
@@ -54,10 +100,35 @@ module TabTool
   end
 
   def initLogger
-    lfn = docFile("#{self.class.to_s.split('::').last}.ttlog")
-    @logger       = Logger.new(lfn)
+    initDocDir unless @docDirSet
+    initDocDir
+    logFileName   = docFile("#{self.class.to_s.split('::').last}.ttlog")
+    @logger       = Logger.new(logFileName)
     @logger.level = Logger::DEBUG
   end
 
+  def initDocDir
+    # puts 'initDocDir - begin'
+    # puts "  @docDirSet: #{@docDirSet}    "
+    # puts "  TTDOCDIR  : #{TTDOCDIR}    "
+    # puts "  $ttdocdir : #{$ttdocdir}    "
+    # puts "  @docDir   : #{@docDir}    "
+    return if @docDirSet
+    return if TTDOCDIR.nil?      && $ttdocdir.nil?
+    return if ''.eql?($ttdocdir) && ''.eql?(TTDOCDIR)
+    @docDir = $ttdocdir.nil? ? TTDOCDIR : $ttdocdir
+    return if Dir.exists?(@docDir)
+    if File.exists? @docDir
+        @docDir = nil
+        return
+    end
+    Dir.mkdir @docDir
+    @docDirSet = true
+    # puts "  @docDirSet: #{@docDirSet}    "
+    # puts "  @docDir   : #{@docDir}    "
+    # puts 'initDocDir - end'
+  end
+
+
 end # module TabTool
 

data/lib/twb/util/graph.rb

@@ -13,18 +13,16 @@
 #  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 Util
+module Graph
 
-  class Graph
     attr_accessor :nodes, :edges
+
     def nodes
         @nodes ||= @nodes = []
     end
+
     def edges
         @edges ||= @edges = []
     end
-  end
 
-end  # module Util
-end  # module Twb
+end  # module Graph

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.7.5
 platform: ruby
 authors:
 - Chris Gerrard