twb 3.9.7 → 4.3.1

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

@@ -28,14 +28,15 @@ module Analysis
     attr_reader   :twbname, :twbcount
 
     def initialize
+      init
       #-- set up metrics
       @twbcount   = 0
       @dscount    = 0
       @filecount  = 0
       @sheetcount = 0
       #--
-      @funcdoc    = {:class=>self.class, :blurb=>'Analyzing Google Sheet Data Sources from Tableau Workbooks.', :description=>nil,}
-      docFileName = docFile('TWBGoogleSheetDataSources.csv')
+      @funcdoc    = {:class=>self.class, :blurb=>'Analyze Google Sheet Data Sources', :description=>nil,}
+      docFileName = docFile('GoogleSheetDataSources.csv')
       @csv        = CSV.open(docFileName, 'w')
       @csv       << ["Workbook",'Data Source','Connection','File Name','Type','Table Name','Field']
       @docfiles = [{:name=>docFileName,:description=>"CSV File containing the data relating Google Sheet-based Data Sources."}]
@@ -57,9 +58,9 @@ module Analysis
           conns = ds.node.xpath(".//connection[@class='google-sheets']")
           if conns.length > 0
               @relation   = ds.node.at_xpath('./connection/relation')
-              @relName    = @relation.attribute('name').text
-              @relType    = @relation.attribute('type').text
-              @fileName   = ds.node.at_xpath('.//named-connection/connection').attribute('filename')
+              @relName    = @relation.nil? ? 'n/a - no relation in connection' : @relation['name']
+              @relType    = @relation.nil? ? 'n/a - no relation in connection' : @relation['type']
+              @fileName   = ds.node.at_xpath('.//named-connection/connection')['filename']
               @filecount += 1
               emit "FILENAME: #{@fileName}"
               tables = ds.node.xpath(".//relation[@type='table']")

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

@@ -27,12 +27,12 @@ module Analysis
 
     def initialize
       init
-      @funcdoc     = {:class=>self.class, :blurb=>'Analyze Dashboard Sheets from Tableau Workbooks.', :description=>'Identifies the Worksheets present in Dashboards.',}
+      @funcdoc     = {:class=>self.class, :blurb=>'Analyze Dashboard Worksheets', :description=>'Identifies the Worksheets present in Dashboards.',}
       #--
-      docFileName  = docFile('TwbDashboardSheets.csv')
+      docFileName  = docFile('DashboardSheets.csv')
       @dashSheetsCSV  = CSV.open(docFileName,'w')
-      @dashSheetsCSV  << ['Workbook','Dashboard','Worksheet','Hidden','Visible']
-      addDocFile docFileName, "Workbooks, Dashboards, and Worksheets in the Dashboards"
+      @dashSheetsCSV  << ['Workbook','Workbook Dir','Modified','Dashboard','Worksheet','Hidden','Visible']
+      addDocFile docFileName, "Workbooks, Dashboards, and their Worksheets"
       #--
       @twbCount    = 0
       @dashCount   = 0
@@ -50,6 +50,8 @@ module Analysis
     def processTWB twb
        @twb     = twb
        @twbName = @twb.name
+       @twbDir  = @twb.dir
+       @modTime = @twb.modtime
        emit "   -- #{@twbName}"
        @twbCount += 1
        parseDashes
@@ -64,7 +66,7 @@ module Analysis
         dash.worksheets.each do |sheet|
           @sheetCount += 1
           emit "SHEET: #{sheet.name}"
-          @dashSheetsCSV  << [@twbName, dash.name, sheet.name, sheet.hidden, sheet.visible ]
+          @dashSheetsCSV  << [@twbName, @twbDir, @modTime, dash.name, sheet.name, sheet.hidden, sheet.visible ]
         end
       end
     end

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

@@ -23,20 +23,36 @@ module Analysis
 
     include TabTool
 
+    @@fieldTypeCodes = { 'DB ref'  => 'Db',
+                         'color'   => 'Clr',
+                         'filter'  => 'F',
+                         'lod'     => 'L',
+                         'page'    => 'Pg',
+                         'path'    => 'Pt',
+                         'shape'   => 'Sh',
+                         'size'    => 'Sz',
+                         'text'    => 'Tx',
+                         'tooltip' => 'Tt',
+                         :column   => 'Cm',
+                         :row      => 'R',
+                       }
+
+
     attr_accessor :localEmit
 
     def initialize
       init
-      @funcdoc    = {:class=>self.class, :blurb=>'Analyze Sheet Fields from Tableau Workbooks.', :description=>nil,}
+      @funcdoc    = {:class=>self.class, :blurb=>'Analyze Worksheet Fields', :description=>nil,}
       #--
-      docFileName = docFile('TwbWorksheetFields.csv')
+      docFileName = docFile('WorksheetFields.csv')
       @sheetFieldsCSV  = CSV.open(docFileName,'w')
-      @sheetFieldsCSV  << ['Workbook','Worksheet','Data Source','Data Source (tech)','Field','Field (tech)']
+      @sheetFieldsCSV  << ['Rec #', 'Workbook','Worksheet','Data Source','Data Source (tech)','Field','Field (tech)','Usage','Usage - code']
       addDocFile docFileName, "Workbooks, Worksheets, and the Sheets' Data Sources and Fields"
       #--
       @twbCnt     = 0
       @sheetCnt   = 0
       @fieldsCnt  = 0
+      @recNum     = 0
     end
 
     def metrics
@@ -49,27 +65,57 @@ module Analysis
 
     def processTWB twb
        @twb = twb
-       emit "   -- #{@twb.name}"
+       emit "   -- twb:: #{@twb.name}"
        @twbCnt += 1
        @twbDomainsLoaded = false
        parseSheets
        finis
     end
 
+    private
+
     def parseSheets
       @worksheets  = @twb.worksheets
       @worksheets.each do |sheet|
+        @sheet     = sheet.name
         @sheetCnt += 1
-        emit "SHEET: #{sheet.name}"
+        emit "SHEET: #{@sheet}"
         showFields sheet unless sheet.datasourceFields.nil?
       end
     end
 
     def showFields sheet
+      showDBFields  sheet
+      showRCFields  sheet.rowFields, :row
+      showRCFields  sheet.colFields, :column
+      showEncodedFields sheet
+      showFilterFields  sheet
+      showPageFields    sheet
+    end
+
+    def showPageFields sheet
+      sheet.pageFields.each do |pfield|
+        ds = @twb.datasource pfield.dataSource
+        fuiname = ds.fieldUIName pfield.name 
+        @sheetFieldsCSV  << [@recNum+=1, @twb.name, @sheet, ds.uiname, ds.name, fuiname, pfield.name, 'page', ftc('filter')]
+      end
+    end
+
+    def showFilterFields sheet
+      filters = sheet.filters
+      filters.each do |filter|
+        dsName   = filter.dataSource.name
+        dsUIName = filter.dataSource.uiname
+        # puts "Filter field: #{filter.dataSource.name}  ui:'#{}'"
+        @sheetFieldsCSV  << [@recNum+=1, @twb.name, @sheet, dsUIName, dsName, filter.uiname, filter.name, 'filter', ftc('filter')]
+      end
+    end
+
+    def showDBFields sheet
       fields = sheet.datasourceFields
-      emit " #FIELDS: #{fields.length}"
+      emit "def showDBFields sheet: #{sheet.name} #FIELDS: #{fields.length}"
       if fields.nil?
-        @sheetFieldsCSV  << [@twb.name, sheet.name, nil, nil, nil, nil]
+        @sheetFieldsCSV  << [@recNum+=1, @twb.name, @sheet, nil, nil, nil, nil, nil]
       end
       fields.each do |dsName, dsfields|
         ds = @twb.datasource dsName
@@ -81,12 +127,48 @@ module Analysis
            emit "       f: #{sheetField}"
            emit "       c: #{sheetField.class}"
            fuiName = ds.fieldUIName sheetField #Fields[sheetField]
-           @sheetFieldsCSV  << [@twb.name, sheet.name, ds.uiname, dsName, sheetField.uiname, sheetField.name]
+           @sheetFieldsCSV  << [@recNum+=1, @twb.name, @sheet, ds.uiname, dsName, sheetField.uiname, sheetField.name, 'DB ref', ftc('DB ref')]
            # emit true, "        : #{dsFields[field].class}"
         end
       end
     end
 
+    def showRCFields fields, usage
+      emit "def showRCFields #fields: #{fields.length}  \t #{fields}"
+      if fields.nil?
+        @sheetFieldsCSV  << [@recNum+=1, @twb.name, @sheet, nil, nil, nil, nil, nil]
+      else
+        fields.each do |cf|
+          emit "coded field: #{cf}"
+          fldName = cf.name
+          dsName  = cf.dataSource
+          ds      = @twb.datasource dsName
+          emit "DATASOURCE : #{ds.class} "  #{ }" #{ds}"
+          fuiName = ds.fieldUIName cf.name
+          emit "      ds: #{dsName}"
+          emit "        - #{ds.uiname}"
+          emit "        : #{ds.class}"
+          @sheetFieldsCSV  << [@recNum+=1, @twb.name, @sheet, ds.uiname, dsName, fuiName, fldName, usage, ftc(usage)]
+        end
+      end
+    end
+
+    def showEncodedFields sheet
+      unless sheet.encodedFields.nil?
+        sheet.encodedFields.each do |type,fields|
+          fields.each do |field|
+            dsName  = field.dataSource
+            ds      = @twb.datasource dsName
+            fuiName = ds.fieldUIName field.name
+            @sheetFieldsCSV  << [@recNum+=1, @twb.name, @sheet, ds.uiname, dsName, fuiName, field.name, type, ftc(type)]
+          end
+        end
+      end
+    end #def showEncodedFields
+
+    def ftc type   # ftc : abbr for fieldTypeCode, for brevity
+      @@fieldTypeCodes[type].nil? ? type : @@fieldTypeCodes[type]
+    end
 
   end #class SheetFieldsAnalyzer
 

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

@@ -27,11 +27,11 @@ module Analysis
 
     def initialize
       init
-      @funcdoc     = {:class=>self.class, :blurb=>'Analyze Worksheet filters.', :description=>'Documents Quick Filters and the values they employ, if any. Work in progess.',}
+      @funcdoc     = {:class=>self.class, :blurb=>'Analyze Worksheet Filters', :description=>'Documents Quick Filters and the values they employ, if any. Work in progess.',}
       #--
       docFileName  = docFile('WorksheetFilters.csv')
       $sheetFieldsCSV  = CSV.open( docFileName  ,'w')
-      $sheetFieldsCSV  << ['Workbook','Worksheet','Filter Type','Operation','Data Source','Field','Value','Alias', 'Alias?','Operation Mode','Include Null?']
+      $sheetFieldsCSV  << ['Workbook','Workbook Dir','Worksheet','Filter Type','Operation','Data Source','Field','Value','Alias', 'Alias?','Operation Mode','Include Null?','Kind']
       addDocFile docFileName, "Workbooks, Worksheets and the sheets' Quick Filters"
       #--
       @sheetCount  = 0
@@ -48,6 +48,7 @@ module Analysis
     def processTWB twb
        @twb     = twb
        @twbName = @twb.name
+       @twbDir  = @twb.dir
        emit "   -- #{@twbName}"
        @twbDomainsLoaded = false
        parseFilters
@@ -62,14 +63,14 @@ module Analysis
           filter.emit "-----------------------------\nWORKSHEET:: #{sheet.name}\n-----------------------------"
           if filter.values.empty?
           # $sheetFieldsCSV  << ['Workbook','Worksheet','Filter Type','Operation'     ,'Data Source','Field','Value','Alias', 'Alias?']
-            $sheetFieldsCSV  << [@twbName  ,sheet.name, filter.type  ,filter.inexclude, filter.dataSource.uiname, filter.uiname,nil,nil,nil,filter.inexMode,filter.includeNull]
+            $sheetFieldsCSV  << [@twbName, @twbDir, sheet.name, filter.type  ,filter.inexclude, filter.dataSource.uiname, filter.uiname,nil,nil,nil,filter.inexMode,filter.includeNull,filter.kind]
           end
           filter.values.each do |valueMap|
             value  = valueMap[:value]
             valias = valueMap[:alias]
             same   = value.eql? valias
-            # puts "RECORDING FILTER VALUES:  %-25s  --  %-25s  same? %s " % [value,valias,same]
-            $sheetFieldsCSV  << [@twbName  ,sheet.name, filter.type  ,filter.inexclude, filter.dataSource.uiname, filter.uiname, value, valias, same,filter.inexMode,filter.includeNull]
+            emit "RECORDING FILTER VALUES:  %-35s  --  %-25s  same? %s " % [value,valias,same]
+            $sheetFieldsCSV  << [@twbName, @twbDir, sheet.name, filter.type  ,filter.inexclude, filter.dataSource.uiname, filter.uiname, value, valias, same,filter.inexMode,filter.includeNull,filter.kind]
           end
         end
       end

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

@@ -0,0 +1,122 @@
+#  sheetfieldsanalyzer.rb Copyright (C) 2018  Chris 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/>.
+
+require 'twb'
+require 'csv'
+
+module Twb
+module Analysis
+
+  class SheetSourcesAnalyzer
+
+    include TabTool
+
+    attr_accessor :localEmit
+
+    def initialize
+      init
+      @funcdoc    = {:class=>self.class, :blurb=>'Analyze Worksheet Fields', :description=>nil,}
+      #--
+      docFileName = docFile('WorksheetFields.csv')
+      @sheetFieldsCSV  = CSV.open(docFileName,'w')
+      @sheetFieldsCSV  << ['Workbook','Worksheet','Data Source','Data Source (tech)','Field','Field (tech)','Usage']
+      addDocFile docFileName, "Workbooks, Worksheets, and the Sheets' Data Sources and Fields"
+      #--
+      @twbCnt     = 0
+      @sheetCnt   = 0
+      @fieldsCnt  = 0
+    end
+
+    def metrics
+      {
+        '# of Workbooks'         => @twbcount,
+        '# of Worksheets'        => @sheetCnt,
+        '# of Worksheet Fields'  => @fieldsCnt
+      }
+    end
+
+    def processTWB twb
+       @twb = twb
+       emit "   -- twb:: #{@twb.name}"
+       @twbCnt += 1
+       @twbDomainsLoaded = false
+       parseSheets
+       finis
+    end
+
+    private
+
+    def parseSheets
+      @worksheets  = @twb.worksheets
+      @worksheets.each do |sheet|
+        @sheet     = sheet.name
+        @sheetCnt += 1
+        emit "SHEET: #{@sheet}"
+        showFields sheet unless sheet.datasourceFields.nil?
+      end
+    end
+
+    def showFields sheet
+      showDBFields  sheet
+      showRCFields  sheet.rowFields, :row
+      showRCFields  sheet.colFields, :column
+    end
+
+    def showDBFields sheet
+      fields = sheet.datasourceFields
+      emit "def showDBFields sheet: #{sheet.name} #FIELDS: #{fields.length}"
+      if fields.nil?
+        @sheetFieldsCSV  << [@twb.name, @sheet, nil, nil, nil, nil, nil]
+      end
+      fields.each do |dsName, dsfields|
+        ds = @twb.datasource dsName
+        emit "      ds: #{dsName}"
+        emit "        - #{ds.uiname}"
+        emit "        : #{ds.class}"
+        dsfields.each do |sheetField|
+           @fieldsCnt += 1
+           emit "       f: #{sheetField}"
+           emit "       c: #{sheetField.class}"
+           fuiName = ds.fieldUIName sheetField #Fields[sheetField]
+           @sheetFieldsCSV  << [@twb.name, @sheet, ds.uiname, dsName, sheetField.uiname, sheetField.name, 'DB ref']
+           # emit true, "        : #{dsFields[field].class}"
+        end
+      end
+    end
+
+    def showRCFields fields, usage
+      emit "def showRCFields #fields: #{fields.length}  \t #{fields}"
+      if fields.nil?
+        @sheetFieldsCSV  << [@twb.name, @sheet, nil, nil, nil, nil, nil]
+      else
+        fields.each do |cf|
+          emit "coded field: #{cf}"
+          fldName = cf.name
+          dsName  = cf.dataSource
+          ds      = @twb.datasource cf.dataSource
+          emit "DATASOURCE : #{ds.class} "  #{ }" #{ds}"
+          fuiName = ds.fieldUIName cf.name
+          emit "      ds: #{dsName}"
+          emit "        - #{ds.uiname}"
+          emit "        : #{ds.class}"
+          @sheetFieldsCSV  << [@twb.name, @sheet, ds.uiname, dsName, fuiName, fldName, usage]
+        end
+      end
+    end
+
+  end #class SheetFieldsAnalyzer
+
+end # module Analysis
+end # module Twb

data/lib/twb/codedfield.rb

@@ -83,6 +83,6 @@ module Twb
       @fqName <=> other.techCode
     end
 
-  end # class CalculationField
+  end # class CodedField
 
 end  # module Twb

data/lib/twb/connection.rb

@@ -17,15 +17,117 @@ require 'nokogiri'
 
 module Twb
 
-  class Connection < TabClass
+  class Connection
 
-    attr_reader :xmlType
+    include TabTool
+
+    def self.attributeNames
+        @@attributeNames ||= [
+                                'authentication',
+                                'authentication-type',
+                                'auto-extract',
+                                'channel',
+                                'character-set',
+                                'class',
+                                'cleaning',
+                                'compat',
+                                'compressed-responses',
+                                'compressed-responses-bulk',
+                                'compressed-responses-rest',
+                                'compressed-responses-soap',
+                                'connection-type',
+                                'dataRefreshTime',
+                                'dbname',
+                                'directory',
+                                'disable-unicode',
+                                'driver',
+                                'enum-with-permissions',
+                                'expected-driver-version',
+                                'filename',
+                                'force-character-set',
+                                'force-header',
+                                'force-separator',
+                                'header',
+                                'imex',
+                                'interpretationMode',
+                                'maxfieldlength',
+                                'mdwpath',
+                                'odbc-connect-string-extras',
+                                'odbc-native-protocol',
+                                'one-time-sql',
+                                'pagesize',
+                                'password',
+                                'port',
+                                'prefer-ind-semantics',
+                                'query-band-spec',
+                                'REDIRECT_URI',
+                                'salesforce-api-version',
+                                'schema',
+                                'SCOPE',
+                                'separator',
+                                'server',
+                                'server-oauth',
+                                'service',
+                                'sf-total-requestor-buffer-size-in-mb',
+                                'show',
+                                'tableau-ri',
+                                'tablename',
+                                'temporary',
+                                'update-time',
+                                'updated-database',
+                                'use-nonemptycrossjoin',
+                                'userLanguage',
+                                'username',
+                                'validate',
+                                'workgroup-auth-mode'
+                             ]
+    end
+
+    attr_reader :node, :xmlType, :attributes
 
     # node: XML element
     def initialize node
+        @node    = node
         @xmlType = node.type
+        @path    = node.path.gsub(/\[[0-9]+\]/,'')  
+        @pathNum = /(\d+)/.match(@path)
+        @name    = nil
+    end
+
+    def processConnection path
+        conns = @node.xpath(path)
+        conns.each do |connNode|
+            connClass = @dsclass
+            cpath     = conn.path
+            connPath  = cpath.
+            connPNum  = 
+            # puts cpath, connPath
+            # puts "CPATH: #{cpath}"
+            conn.attributes.each do |name,value|
+                # puts  "\n\t\t - %-15s -> %-s" % [name, value]
+                $csvFile << [ $recCount += 1,
+                              $twbName,  $dir,     $build,    $version,
+                              $dsName,   $dstype,  $dsuiname, connClass, 
+                              connPath,  connPNum,
+                              name,      value.value
+                            ]
+            end
+        end
+    end
+
+    def attributes
+        @attributes ||= loadAttributes
+    end
 
+    private
 
+    def loadAttributes
+        @attributes = {}
+        nodeAttrs = @node.attributes
+        @@attributeNames.each do |a|
+            @attributes[a] = nodeAttrs[a]
+        end
+        return @attributes
     end
 
   end # class