twb 1.9.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44eeddf556df0d517a68f5b4a1af89ae52138f37
-  data.tar.gz: 46d6c474f5d6d5b020d7849463733c66bfb724fe
+  metadata.gz: 0ac4493d38cdcff16c2d5cb96873ba8356e80271
+  data.tar.gz: 8f77ffab827d962ec69aae1061d72978a65111ed
 SHA512:
-  metadata.gz: 6ba98c71c6cd2ccfa8bb6800e20541e90d1e8c9d8da2a420b93a8b8ba5b91912228185fd4a9d6ae20e66ea0da98b62c24b1f24cb9d631fbae9de028742c9fbef
-  data.tar.gz: 5d06d43f7367afc011bb3dce3c33c95cbbc7205238e08bdf2f494426e2c6fc90088c6854a55f8a49712bec79a54ed01aacb7358d42e1e0bb50ec5fc68d9b8126
+  metadata.gz: 0f146956037bfdbd37161ee9a631dc86827afa4af34470199beb2553b152cdeb95201994b088a2028ac89cb5d54e728ff70af4c794e1f9d7a1a903d3af9ab5a2
+  data.tar.gz: ef4a7e6e3435b0e3bfa4d9ba096f8f055ec40ffc865196f0923b04cbd9818a9047c62799fb0f505ae1d940269719c71446e0227c44d79f15285fef058770bed8

data/lib/twb.rb

@@ -16,6 +16,7 @@
 require_relative 'twb/dashboard'
 require_relative 'twb/datasource'
 require_relative 'twb/docdashboard'
+require_relative 'twb/dbfield'
 require_relative 'twb/localfield'
 require_relative 'twb/metadatafield'
 require_relative 'twb/storyboard'
@@ -35,14 +36,17 @@ require_relative 'twb/util/xraydashboards'
 require_relative 'twb/util/graphnode'
 require_relative 'twb/util/graphedge'
 require_relative 'twb/util/graphedges'
+require_relative 'twb/analysis/documentedfieldsmarkdownemitter'
+require_relative 'twb/analysis/annotatedfieldsCSVEmitter'
 require_relative 'twb/analysis/calculatedfields/calculatedfieldsanalyzer'
 require_relative 'twb/analysis/calculatedfields/markdownemitter'
 require_relative 'twb/analysis/calculatedfields/csvemitter'
+require_relative 'twb/analysis/datasources/DataSourceFieldsCSVEmitter'
 require_relative 'twb/analysis/datasources/DataSourceTableFieldsCSVEmitter'
-require_relative 'twb/analysis/Sheets/WorksheetDataStructureCSVEmitter.rb'
+require_relative 'twb/analysis/Sheets/WorksheetDataStructureCSVEmitter'
 
 # Represents Tableau Workbooks and their contents.
 #
 module Twb
-  VERSION = '1.9.1'
+  VERSION = '2.2.1'
 end

data/lib/twb/analysis/AnnotatedFieldsCSVEmitter.rb

@@ -0,0 +1,182 @@
+#  DocumentedFieldsCSVEmitter.rb - this Ruby script Copyright 2017 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/>.
+
+require 'twb'
+require 'csv'
+
+module Twb
+module Analysis
+
+  class AnnotatedFieldsCSVEmitter
+
+    attr_reader :csvFileName, :csvRecords
+    attr_reader :dsCount,     :fieldsCount  
+
+    @@csvHeader = ['Record #',
+                   'Workbook',           
+                   'Workbook Dir',
+                   'Data Source',
+                   'Field',
+                   'Doc Type',
+                   'Doc Line #',
+                   'Doc Line'
+                  ]
+    @@csvFileType = 'TwbAnnotatedFields'
+    @@csvFileName = @@csvFileType + '.csv'
+
+    def initialize
+      @csvFile     = CSV.open(@@csvFileName,'w')
+      @csvFile     << @@csvHeader
+      @csvRecords  = Set.new
+      # --
+      @recNum    = 0
+      @dsCount   = 0
+      @fieldNum  = 0
+    end
+
+    def self.csvHeader
+      @@csvHeader
+    end
+
+    def self.csvFileType
+      @@csvFileType
+    end
+
+    def self.csvFileNaame
+      @@csvFileName
+    end
+
+    def processTwb twb
+      @twb = nil
+      @twb         = twb                    if twb.instance_of? Twb::Workbook
+      @twb         = Twb::Workbook.new(twb) if twb.instance_of? String
+      raise ArgumentError.new("ERROR in Workbok processing: '#{twb}' must be a Workbook (class) or the name of a Workbook (String), is a #{twb.class} \n ") unless @twb.is_a? Twb::Workbook
+      # --
+      dss = @twb.datasources
+      dss.each do |ds|
+        @dsname = ds.uiname
+        # puts "\n    -- #{ds.uiname} "
+        # tables = Set.new
+        fields = {}
+        @dsCount += 1
+        ds.columnFields.each do |field|
+          recordField field
+        end
+      end
+    end # def processTwb twb
+
+    def recordField field
+      @fieldNum += 1
+      @lineNum   = 0
+      field.comment.each do |line|
+        # dispLine = if ''.eql?(line) the ? '' : line
+        @csvFile << [ @recNum+=1,
+                      @twb.name,
+                      @twb.dir,
+                      @dsname,
+                      field.uiname,
+                      'Comment',
+                      @lineNum+=1,
+                      # ''.eql?(line) ? " " : line
+                      line
+                    ]
+      end
+      unless field.calcField.nil?
+        @lineNum   = 0
+        field.calcField.formulaResolvedLines.each do |line|
+          @csvFile << [ @recNum+=1,
+                        @twb.name,
+                        @twb.dir,
+                        @dsname,
+                        field.uiname,
+                        'Formula',
+                        @lineNum+=1,
+                        line
+                      ]
+        end
+      end
+    end
+
+    # def recordField fields, field, props
+    #   # puts "%-65s  :: %s " % [fieldName,props]
+    #   return if field.uiname.nil?
+    #   if fields.has_key? field.uiname
+    #     fields[field.uiname].merge! field.properties
+    #   else
+    #     fields[field.uiname] = field.properties
+    #   end
+    # end
+
+    def emitFields fields
+      fields.each do |fieldName,props|
+        # puts "FIELD::  %-40s  :: %s" % [fieldName,props.inspect]
+        # class = props[]
+        csvRec = [ @recNum+=1,
+                   @twb.name,
+                   @twb.dir,
+                   @dsname,
+                   fieldName,
+                   props[:type],
+                   props['hidden'],
+                   props[:columnField],
+                   props[:calculatedField],
+                   props[:dbField],
+                   props[:mappedField],
+                   props[:metadataField]
+                 ]
+        @csvFile << csvRec
+        @csvRecords.add csvRec
+      end
+    end
+
+    def recordTech field, type
+      @recNum+=1
+      field.properties.each do |name,value|
+        @csvFileTech << [ @recNum,
+                          @twb.name,
+                          @twb.dir,
+                          @dsname,
+                          field.uiname,
+                          type,
+                          name,
+                          value
+                        ]
+      end
+    end
+
+    def emitTech dataSource, fieldName, type, properties
+      # puts "XX #{dataSource.uiname} :: #{fieldName} #{}  :: #{type} :: #{properties}"
+      @recNum+=1
+      properties.each do |name,value|
+        @csvFileTech << [ @recNum,
+                          @twb.name,
+                          @twb.dir,
+                          dataSource.uiname,
+                          fieldName,
+                          type,
+                          name,
+                          value
+                        ]
+      end
+    end
+
+    def cleanup
+      @csvFile.close unless @csvFile.nil?
+    end
+
+  end # class DocumentedFieldsCSVEmitter
+
+end   # module Analysis
+end   # module Twb

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

@@ -28,7 +28,7 @@ module CalculatedFields
     end
 
     def processTwb twb
-       twb = File.basename(twb)
+      twb = File.basename(twb)
       @twb = Twb::Workbook.new twb
       @docFileName = twb + '.CalculatedFields.md'
       @docFile     = File.open(@docFileName,'w')
@@ -46,6 +46,7 @@ module CalculatedFields
         calcFields.each do |fldname, field|
           calculation = field.calculation
           @docFile.puts "\n##### #{fldname} "
+          @docFile.puts "###### ...description..."
           @docFile.puts "```"
           if calculation.has_formula 
             @docFile.puts calculation.formulaResolved

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

@@ -0,0 +1,250 @@
+#  calculatedfieldsanalyzer.rb - this Ruby script Copyright 2017 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/>.
+
+require 'twb'
+require 'csv'
+
+module Twb
+module Analysis
+module DataSources
+
+  class DataSourceFieldsCSVEmitter
+
+    attr_reader :csvFileName, :csvRecords
+    attr_reader :dsCount,     :fieldsCount  
+
+    @@csvHeader = ['Record #',
+                   'Workbook',           
+                   'Workbook Dir',
+                   'Data Source',
+                   'Field',
+                   'Twb Type',
+                   'Hidden',            # props[:hidden],
+                   'Type - Column',     # props[:columnField],
+                   'Type - Calculated', # props[:calculatedField],
+                   'Type - Db',         # props[:dbField],
+                   'Type - Mapped',     # props[:mappedField] 
+                   'Type - MetaData',     # props[:mappedField]  
+                  ]
+    @@csvFileType = 'TwbDataSourceFields'
+    @@csvFileName = @@csvFileType + '.csv'
+
+    @@tallHeader = ['Field #',
+                    'Workbook',           
+                    'Workbook Dir',
+                    'Data Source',
+                    'Field',
+                    'Field Type',
+                    'Property - Name',
+                    'Property - Value'
+                   ]
+    @@fullFileType = 'TwbDataSourceFieldsDetails'
+    @@fullFileName = @@fullFileType + '.csv'
+
+
+    @@fullHeader = ['Field #',
+                    'Workbook',           
+                    'Workbook Dir',
+                    'Data Source',
+                    'Field',
+                    'Field - source',
+                    'Field - class',
+                    'Field - path',
+                    'Property - Name',
+                    'Property - Value'
+                   ]
+    @@tallFileType = 'TwbDataSourceFieldsTech'
+    @@tallFileName = @@tallFileType + '.csv'
+
+    def initialize
+      @csvFile     = CSV.open(@@csvFileName,'w')
+      @csvFile     << @@csvHeader
+      @csvRecords  = Set.new
+      puts "Opened: #{!@csvFile.nil?} - #{@@csvFileName}"
+      # --
+      @csvFileFull = CSV.open(@@fullFileName,'w')
+      @csvFileFull << @@fullHeader
+      puts "Opened: #{!@csvFileFull.nil?} - #{@@fullFileName} "
+      # --
+      @csvFileTech = CSV.open(@@tallFileName,'w')
+      @csvFileTech << @@tallHeader
+      puts "Opened: #{!@csvFileTech.nil?} - #{@@tallFileName}"
+      # --
+      @recNum      = 0
+      @dsCount     = 0
+      @fieldsCount = 0
+    end
+
+    def self.csvHeader
+      @@csvHeader
+    end
+
+    def self.csvFileType
+      @@csvFileType
+    end
+
+    def self.csvFileNaame
+      @@csvFileName
+    end
+
+    def processTwb twb
+      @twb = nil
+      @twb         = twb                    if twb.instance_of? Twb::Workbook
+      @twb         = Twb::Workbook.new(twb) if twb.instance_of? String
+      raise ArgumentError.new("ERROR in Workbok processing: '#{twb}' must be a Workbook (class) or the name of a Workbook (String), is a #{twb.class} \n ") unless @twb.is_a? Twb::Workbook
+      # --
+      dss = @twb.datasources
+      dss.each do |ds|
+        @dsname = ds.uiname
+        # puts "\n    -- #{ds.uiname} "
+        # tables = Set.new
+        fields = {}
+        @dsCount += 1
+        fclasses = Set.new
+        ds.localFields.each do |field|
+          recordFieldFull field, :local
+          # recordField( fields, field, {:type=>:local,:columnField=>true,:hidden=>field.hidden} )
+          # emitTech( ds,     field.uiname, 'Local', field.properties)
+          # recordTech( field, 'LocalA')
+        end
+        ds.columnFields.each do |field|
+          recordFieldFull field, :column
+          # recordField( fields, field, {:type=>'column',:columnField=>true,:hidden=>field.hidden} )
+          # emitTech( ds,     field.uiname, 'Column', field.properties)
+          # recordTech( field, 'ColumnA')
+        end
+        ds.calculatedFields.each do |field|
+          recordFieldFull field, :calc
+          # puts "WWW #{field.class}  :: #{field} ::prop:: #{field.properties.class} :: #{field.properties}"
+          # recordField( fields, field, {:type=>'calc',:calculatedField=>true,:hidden=>field.hidden} )
+          # emitTech( ds,     field.uiname, 'Calculated', field.properties)
+          # recordTech( field, 'CalcA')
+        end
+        ds.metadataFields.each do |field|
+          recordFieldFull field, :metadata
+          # recordField( fields, field,   {:type=>'metadata',:metadataField=>true} )
+          # emitTech( ds,     field.uiname, 'MetaData', field.properties)
+          # recordTech( field, 'MetadataA')
+        end
+        ds.dbFields.each do |field|
+          recordFieldFull field, :db
+          # recordField( fields, field,    {:type=>'database',:dbField=>true} )
+          # emitTech( ds,     field.uiname, 'Db', field.properties)
+          # recordTech( field, 'DbA')
+        end
+        ds.mappedFields.each do |field|
+          recordFieldFull field, :mapped
+          # recordField( fields, field,    {:type=>'mapped',:mappedField=>true} )
+          # emitTech( ds,     field.uiname, 'Mapped', field.properties)
+          # recordTech( field, 'MappedA')
+        end
+        emitFields(fields)
+      end
+    end # def processTwb twb
+
+    def recordFieldFull field, source
+      # print field.properties.nil? ? '-' : ":#{field.properties.length}"
+      # puts field.properties
+      @recNum+=1
+      field.properties.each do |name,value|
+        # print name 
+        @csvFileFull << [  @recNum,
+                           @twb.name,
+                           @twb.dir,
+                           @dsname,
+                           field.uiname,
+                           source,
+                           field.class,
+                           field.node.path.to_s.gsub(/[0-9]/,'').gsub('[]',''),
+                           name,
+                           value
+                         ]
+        # @csvFileFull << csvRec
+      end
+    end
+
+    def recordField fields, field, props
+      # puts "%-65s  :: %s " % [fieldName,props]
+      return if field.uiname.nil?
+      if fields.has_key? field.uiname
+        fields[field.uiname].merge! field.properties
+      else
+        fields[field.uiname] = field.properties
+      end
+    end
+
+    def emitFields fields
+      fields.each do |fieldName,props|
+        # puts "FIELD::  %-40s  :: %s" % [fieldName,props.inspect]
+        # class = props[]
+        csvRec = [ @recNum+=1,
+                   @twb.name,
+                   @twb.dir,
+                   @dsname,
+                   fieldName,
+                   props[:type],
+                   props['hidden'],
+                   props[:columnField],
+                   props[:calculatedField],
+                   props[:dbField],
+                   props[:mappedField],
+                   props[:metadataField]
+                 ]
+        @csvFile << csvRec
+        @csvRecords.add csvRec
+      end
+    end
+
+    def recordTech field, type
+      @recNum+=1
+      field.properties.each do |name,value|
+        @csvFileTech << [ @recNum,
+                          @twb.name,
+                          @twb.dir,
+                          @dsname,
+                          field.uiname,
+                          type,
+                          name,
+                          value
+                        ]
+      end
+    end
+
+    def emitTech dataSource, fieldName, type, properties
+      # puts "XX #{dataSource.uiname} :: #{fieldName} #{}  :: #{type} :: #{properties}"
+      @recNum+=1
+      properties.each do |name,value|
+        @csvFileTech << [ @recNum,
+                          @twb.name,
+                          @twb.dir,
+                          dataSource.uiname,
+                          fieldName,
+                          type,
+                          name,
+                          value
+                        ]
+      end
+    end
+
+    def cleanup
+      @csvFile.close unless @csvFile.nil?
+    end
+
+  end # class DataSourceFieldsCSVEmitter
+
+
+end   # module DataSources
+end   # module Analysis
+end   # module Twb