twb 4.9.4 → 4.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bf5871fe93aaf4afc19f4c4b789d18db29545c43f77c6ae1d2c901dc23cd142
-  data.tar.gz: e529613db65063341cde12d6393201765f3a53b680e4fbc7fe21707b9ff83681
+  metadata.gz: b285e90d1a99aa8de5a3613e00f03e634611643cac0ede6360a67a6f13f66f50
+  data.tar.gz: 32ef66741caea4210c0ca8959c001046a6884799a2bd544974fd155bc86fe625
 SHA512:
-  metadata.gz: 7fb310fd663173d925df07488ec1f8d147651ca6588b725f03acaa99e88cfbcc07bb5aed2b797a8e70afd57143466a06ca0857bab0e4bdad99fda42423093652
-  data.tar.gz: 460b6aee7fe9bf62baa9611a350dc3b7fe671ae18c03b8943431506a43bf0598247e92e784604cf35450bdc1f3dc09c04380ae43ff35c33344877885f16ca191
+  metadata.gz: 2ba95c4825210b53050e39cd172672456c46ff38e22dfabd0b1dcfe5d63a4e1ba0761295a92eedae92e744e34197c2a70625fdd36cddc284b874b66fe07bb18f
+  data.tar.gz: d78f2d12dd031a66ce686ad9bc2ca2cd5546d509ef049a7e129f58f7a0da00deddaa1860bba8946cf8ff7cbe5ef5d255d9b2dbda48a25acd77fd75f387803882

data/lib/tfl/Flow.rb

@@ -0,0 +1,311 @@
+
+#  Copyright (C) 2014, 2020  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 'nokogiri'
+require 'zip'
+
+module Flow
+
+
+  ##
+  # A Tableau Prep Flow file.
+  #
+  class Flow < TabClass
+
+    attr_reader :name,         :dir,    :type,      :modtime
+    attr_reader :version,      :build,  :platform,  :base
+    attr_reader :root
+    #--
+    attr_reader :datasources,     :datasource 
+    attr_reader :datasourceNames, :datasourceUINames, :dataSourceNamesMap
+    # attr_reader :orphanDataSources  # i.e. not referenced in any Worksheet
+    #--
+    # attr_reader :dashboards,      :storyboards,       :worksheets
+    # attr_reader :parameters,      :actions
+    # attr_reader :valid
+
+    ##
+    # Creates a Flow from its file name.
+    #
+    # == Parameters:
+    # flowWithDir
+    #   The Flow's file name, the Flow can be a TWB or TWBX file.
+    #
+    def initialize tflWithDir
+      raise ArgumentError.new("ERROR in Flow creation: '#{tflWithDir}' must be a String, is a #{tflWithDir.class} \n ")    unless tflWithDir.is_a? String
+      raise ArgumentError.new("ERROR in Flow creation: '#{tflWithDir}' must have an extension of .tfl or .tflx \n ")       unless tflWithDir.upcase.end_with?(".TFL", ".TFLX")
+      raise ArgumentError.new("ERROR in Flow creation: '#{tflWithDir}' must must be a file, is a Directory\\Folder \n ")   if File.directory?(tflWithDir)
+      raise ArgumentError.new("ERROR in Flow creation: '#{tflWithDir}' cannot be found, must be a Tableau Flow file. \n ") unless File.file?(tflWithDir)
+      @valid = false
+      if File.file?(tflWithDir) then
+        @name    = File.basename(tflWithDir)
+        @dir     = File.dirname(File.expand_path(tflWithDir))
+        @modtime = File.new(tflWithDir).mtime.strftime("%Y-%m-%d %H:%M:%S")
+        case File.extname(tflWithDir).downcase
+          when '.tlf'  then processTFL(tflWithDir)
+          when '.tflx' then processTFLX(flowWithDir)
+        end
+      end
+    end
+
+    def id
+        @id ||= @id = @name.hash
+    end
+
+    def build
+      @build ||= loadBuild
+    end
+
+    def release
+      @build ||= loadBuild
+    end
+
+    def worksheets
+      @worksheets.values
+    end
+
+    def worksheet name
+      @worksheets[name]
+    end
+
+    def worksheetNames
+      @worksheets.keys
+    end
+
+    def dashboards
+      @dashboards.values
+    end
+
+    def dashboardNames
+      @dashboards.keys
+    end
+
+    def dashboard name
+      @dashboards[name]
+    end
+
+    def actions
+      @actions.values
+    end
+
+    def actionNames
+      @actions.keys
+    end
+
+    def datasource name
+      @dataSourceNamesMap[name]
+    end
+
+    def parameters
+      @parameters ||= loadParameters
+    end
+
+    def orphanDataSources
+      @orphanDataSources ||= identifyOrphandatasoUrceS
+    end
+
+    def storyboards
+      @storyboards.values
+    end
+
+    def storyboardNames
+      @storyboards.keys
+    end
+
+    def storyboard name
+      @storyboards[name]
+    end
+
+    private
+
+    def processTFLX(twbxWithDir)
+      Zip::File.open(twbxWithDir) do |zip_file|
+        twb   = zip_file.glob('*.twb').first
+        @ndoc = Nokogiri::XML(twb.get_input_stream)
+        @type = :twbx
+        processDoc
+      end
+    end
+
+    def processTFL(twbFile)
+      @ndoc = Nokogiri::XML(open(twbFile))
+      @type = :twb
+      processDoc
+    end
+
+    def processDoc
+      @valid = true
+    end
+
+    def loadBuild
+      # - earlier Version, need to confirm when source-build began 
+      #   @build   = @ndoc.xpath('/flow/comment()').text.gsub(/^[^0-9]+/,'').strip
+      @build = if !@ndoc.at_xpath('/flow/@source-build').nil?
+                   @ndoc.at_xpath('/flow/@source-build').text
+               else 
+                   if @ndoc.at_xpath('/flow/comment()').nil?
+                      'not found'
+                   else
+                      @ndoc.at_xpath('/flow/comment()').text.gsub(/^[^0-9]+/,'').strip
+                  end
+               end
+    end
+
+    def loaddatasources
+      # puts "LOAD DATA SOURCES"
+      # @dataSourcesNode = @ndoc.at_xpath('//flow/datasources')
+      @datasources        = Set.new
+      @datasourceNames    = SortedSet.new
+      @datasourceUINames  = SortedSet.new
+      @dataSourceNamesMap = {}
+      datasourceNodes     = @ndoc.xpath('//flow/datasources/datasource')
+      # puts "DATASOURCENODES : #{@datasourceNodes.length}"
+      datasourceNodes.each do |node|
+        datasource = Twb::DataSource.new(node,self)
+        @datasources << datasource
+        @datasourceNames    << datasource.name
+        @datasourceNames    << datasource.uiname
+        @datasourceUINames  << datasource.uiname
+        @dataSourceNamesMap[datasource.name]   = datasource 
+        @dataSourceNamesMap[datasource.uiname] = datasource 
+      end
+      # puts "DATASOURCES    : #{@datasources.length}"
+    end
+
+    def loadWorksheets
+      @worksheets  = {}
+      hiddenSheets = []
+      @ndoc.xpath('//flow/windows/window[@hidden="true"]').each do |hs|
+        hiddenSheets << hs['name']
+      end
+      sheets = @ndoc.xpath('//flow/worksheets/worksheet' ).to_a
+      sheets.each do |node|
+        sheet = Twb::Worksheet.new(node, self)
+        sheet.hidden = hiddenSheets.include? sheet.name 
+        @worksheets[sheet.name] = sheet
+      end
+    end
+
+    def loadDashboards
+      @dashesNode = @ndoc.at_xpath('//flow/dashboards')
+      @dashboards = {}
+      dashes = @ndoc.xpath('//flow/dashboards/dashboard').to_a
+      dashes.each do |node|
+        unless node.attr('type') == 'storyboard' then
+          dashboard = Twb::Dashboard.new(node, @worksheets)
+          @dashboards[dashboard.name] = dashboard
+        end
+      end
+    end
+
+    def loadStoryboards
+      @storyboards = {}
+      boards = @ndoc.xpath("//flow/dashboards/dashboard[@type='storyboard']" ).to_a
+      boards.each do |node|
+        sheet = Twb::Storyboard.new(node)
+        @storyboards[sheet.name] = sheet
+      end
+    end
+
+    def loadWindows
+      @windowsnode = @ndoc.at_xpath("//flow/windows")
+      @windows = {}
+      windows  = @ndoc.xpath("//flow/windows/window[@name]")
+      windows.each do |node|
+        window = Twb::Window.new(node)
+        @windows[window.name] = window
+      end
+    end
+
+    def loadActions
+      @actions = {}
+      actionNodes = @ndoc.xpath("//flow/actions/action")
+      actionNodes.each do |anode|
+        action = Twb::Action.new(anode, @flownode)
+        @actions[action.uiname] = action
+      end
+    end
+
+    def identifyOrphandatasoUrceS
+      sheetDataSources = Set.new
+      @worksheets.values.each do |sheet|
+        sheet.datasources.each do |ds|
+            sheetDataSources << ds.uiname
+        end
+      end
+      @orphanDataSources = @datasourceUINames - sheetDataSources
+    end
+
+    def writeTwb(name=@name)
+      $f = File.open(name,'w')
+      if $f
+          $f.puts @ndoc
+          $f.close
+      end
+      return name
+    end
+
+    def writeTwbx(name=@name)
+        emit  "Writing the Workbook, need implementation"
+    end
+
+    # Make sure that the TWB has a <dashboards> node.
+    # It's possible for a TWB to have no dashboards, and therefore no <dashboards> node.
+    def ensureDashboardsNodeExists
+      if @dashesNode.nil?
+        @dashesNode = Nokogiri::XML::Node.new "dashboards", @ndoc
+        # TODO fix this @dataSourcesNode.add_next_sibling(@dashesNode)
+      end
+    end
+
+    def ensureWindowsNodeExists
+      if @windowsnode.nil?
+        @windowsnode = Nokogiri::XML::Node.new "windows", @ndoc
+        # TODO fix this @dataSourcesNode.add_next_sibling(@windowsnode)
+      end
+    end
+
+    def getNewDashboardTitle(t)
+      title = t
+      if @datasources.include?(title)
+        inc = 0
+        loop do
+          inc+=1
+          title = t + ' ' + inc.to_s
+          if !@datasources.include?(title)
+            break
+          end
+        end
+      end
+      return title
+    end
+
+    def loadParameters
+      @parameters = {}
+      paramsDS = ndoc.at_xpath('./flow/datasources/datasource[@name="Parameters"]')
+      unless paramsDS.nil?
+        paramNodes = paramsDS.xpath('.//column')
+        paramNodes.each do |pn|
+          parameter = Twb::Parameter.new pn
+          @parameters[parameter.name] = parameter
+        end
+      end
+      return @parameters
+    end
+
+  end  # class Flow
+
+end  # module Twb

data/lib/twb.rb

@@ -73,12 +73,12 @@ require_relative 'twb/analysis/sheets/worksheetsummarizer'
 require_relative 'twb/analysis/sheets/worksheetdatastructurecsvemitter'
 require_relative 'twb/analysis/sheets/sheetfiltersanalyzer'
 require_relative 'twb/analysis/sheets/sheetfieldsanalyzer'
+require_relative 'twb/analysis/sheets/dashboardsummarizer'
 require_relative 'twb/analysis/sheets/dashsheetsanalyzer'
 require_relative 'twb/analysis/sheets/sheetsintooltipanalyzer'
 
-
 # Represents Tableau Workbooks, their contents, and classes that analyze and manipulate them.
 #
 module Twb
-  VERSION = '4.9.4'
+  VERSION = '4.9.9'
 end

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

@@ -298,8 +298,8 @@ DOTHEADER
             @referencedFields.merge referencedFields
             @twbRootFields.merge dsRootFields
             if @doGraph
-              cypher     @twb.name
-              cypherPy   @twb.name
+              # cypher     @twb.name
+              # cypherPy   @twb.name
             end
             emit "#######################"
             #--

data/lib/twb/analysis/datasources/datasourcefilesanalyzer.rb

@@ -71,7 +71,7 @@ module DataSources
             fileDir  = File.dirname  fqFileName
             modtime  = File.mtime    fqFileName
             size     = File.size     fqFileName
-            data = [$recNum+=1, twbName, twb.dir, ds.uiname, fileName, fileDir, modtime, size]
+            data = [@recNum+=1, twbName, twb.dir, ds.uiname, fileName, fileDir, modtime, size]
             @csvFile  << data
         end
       end

data/lib/twb/analysis/sheets/dashboardsummarizer.rb

@@ -0,0 +1,94 @@
+#  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 DashboardsSummarizer
+
+    include TabTool
+
+    attr_accessor :localEmit
+
+    def initialize(**args)
+      @args      = args
+      @recordDir = !@args.nil? && @args[:recordDir] == true
+      @ttdocdir  = @args[:ttdocdir]
+      @csvAdd    = !@args.nil? && args[:csvMode] == :add
+      @csvMode   = @csvAdd ? 'a' : 'w'
+      init
+      @funcdoc   = {:class=>self.class, :blurb=>'Analyze Dashboard Worksheets', :description=>'Identifies the Worksheets present in Dashboards.',}
+      #--
+      docFileName     = docFile('DashboardSummaries.csv')
+      @dashboardsCSV  = CSV.open(docFileName,@csvMode)
+      unless @csvAdd
+        if @recordDir
+          @dashboardsCSV  << ['Rec #','Workbook','Dashboard','# Worksheets','Workbook Dir']
+        else
+          @dashboardsCSV  << ['Rec #','Workbook','Dashboard','# Worksheets'               ]
+        end
+      end
+      addDocFile @dashboardsCSV, docFileName, "Workbooks and their Dashboards' summaries"
+      #--
+      @twbCount    = 0
+      @dashCount   = 0
+      @recNum      = 0
+    end
+
+    def metrics
+      {
+        # '# of Workbooks'  => @twbCount,
+        '# of Dashboards' => @dashCount,
+      }
+    end
+
+    def processTWB twb
+       @twb     = twb
+       @twbName = @twb.name
+       @twbDir  = @twb.dir
+       @modTime = @twb.modtime
+       emit "   -- #{@twbName}"
+       @twbCount += 1
+       parseDashes
+       finis
+    end
+
+    def parseDashes
+      @dashboards = @twb.dashboards
+      @dashboards.each do |dash|
+        emit "DASH:: #{dash.name}"
+        @dashCount += 1
+        recordCSV [@twbName, dash.name, dash.worksheets.length]
+      end
+    end
+
+    private
+
+      def recordCSV record
+        numberedRec = [@recNum+=1] + record
+        if @recordDir
+          @dashboardsCSV  << numberedRec.push(@twbDir)
+        else
+          @dashboardsCSV  << numberedRec
+        end
+      end
+
+  end #class SheetFieldsAnalyzer
+
+end # module Analysis
+end # module Twb

data/lib/twb/analysis/workbooksummaryanalyzer.rb

@@ -37,7 +37,7 @@ module Analysis
       docFileName  = docFile('WorkbookSummary.csv')
       @csvFile     = CSV.open(docFileName,@csvMode)
       unless @csvAdd
-        csvHeader       = ['Rec #', 'Workbook','Type','Version','Build','Platform','Modified','# Data Sources','# Dashboards','# Worksheets']
+        csvHeader       = ['Rec #', 'Workbook','Directory','Type','Version','Build','Platform','Modified','# Data Sources','# Dashboards','# Worksheets']
         if @recordDir
           csvHeader.push('Workbook Directory')
         end
@@ -65,6 +65,7 @@ module Analysis
        @twb     = twb
        emit "   -- #{@twbName}"
        recordCSV [ @twb.name,
+                   @twb.dir, 
                    @twb.type, 
                    @twb.version, 
                    @twb.build,

data/lib/twb/util/cypher.rb

@@ -48,7 +48,7 @@ module Util
     end
 
     def renderNodes
-      puts "Cypher def renderNodes @nodes:#{@nodes}"
+      puts "Cypher def renderNodes @nodes:#{@nodes.to_s}"
       csv = CSV.open(docFile("#{@fileName}.nodes.csv"),'w')
       csv << ['Type','Name','UUID']
       nodesCSV = Set.new

data/lib/twb/util/gml.rb

@@ -77,7 +77,7 @@ GMLHEADER
 
     def renderNodes file
       nodes = Set.new
-      puts 'def renderNodes'
+      # puts 'def renderNodes'
       @nodes.each do |node|
         gmlID   = Digest::MD5.hexdigest(node.id)
         gmlName = node.name.gsub('&','&').gsub('"','"')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 4.9.4
+  version: 4.9.9
 platform: ruby
 authors:
 - Chris Gerrard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2020-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: creek
@@ -58,6 +58,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/t.rb
+- lib/tfl/Flow.rb
 - lib/twb.rb
 - lib/twb/action.rb
 - lib/twb/analysis/annotatedfieldscsvemitter.rb
@@ -82,6 +83,7 @@ files:
 - lib/twb/analysis/documentedfieldscsvemitter.rb
 - lib/twb/analysis/documentedfieldsmarkdownemitter.rb
 - lib/twb/analysis/sheets/analyzedashboardsheets.rb
+- lib/twb/analysis/sheets/dashboardsummarizer.rb
 - lib/twb/analysis/sheets/dashsheetsanalyzer.rb
 - lib/twb/analysis/sheets/sheetfieldsanalyzer.rb
 - lib/twb/analysis/sheets/sheetfiltersanalyzer.rb