twb 4.3.3 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 150eff5c8dea70f1bb4a81416ba1097fe200e76ae173976f2cb6991f3b62fd02
-  data.tar.gz: 9238b3a04c9fc93d173743fdd15f9274b8b0f4a01dea00dcaa5cee27cf981c68
+  metadata.gz: 812d81d15bb4830be9ebb74ff7542bec21ba2fd3e2a4ecf6326ed1cc8be8c523
+  data.tar.gz: 6802c24ee1c8477c718b248c3e81a5d46edcabcaa23f5051eec303efd7bbe24c
 SHA512:
-  metadata.gz: 025cc5a832adcf6b550808affe56077a2b8a605080424a57ce0f4f1138887c4ce8d5646f6505e9dcf114364bd8f9e58a40743b450cc1f51188aa10ad35c906b8
-  data.tar.gz: 69b0a5f7ba2cb26a88925c86ada6b7aad6ab6df9bb3ee4ffd04845842657df4037273d9df994c8439043ee29528f375549894f7ec68f5dafec33488809841269
+  metadata.gz: 6277f3d28b0b4810e0ac370fbd282048a6278bb71415bd40a6426ce4f47187a0feead4d85280f752e080fe4355127bfa651233d087ac9eeb04a8190382f854d1
+  data.tar.gz: 7b56029d3fee19cb4549d1433ff55201e3cf787abaecc40c9cf3d5b6cbbcda6cd49e8fcf2316f7543705b598a3d148270d94890fe3f92b93ac645fa477f00eac

data/lib/twb.rb

@@ -70,5 +70,5 @@ require_relative 'twb/analysis/Sheets/dashsheetsanalyzer'
 # Represents Tableau Workbooks, their contents, and classes that analyze and manipulate them.
 #
 module Twb
-  VERSION = '4.3.3'
+  VERSION = '4.4.1'
 end

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

@@ -81,7 +81,11 @@ module Analysis
 
 DOTHEADER
 
-      def initialize
+      def initialize(**args)
+          @csvAdd  = args[:csvMode] == :add
+          @csvMode = @csvAdd ? 'a' : 'w'
+          emit true, "@csvAdd : #{@csvAdd}" 
+          emit true, "@csvMode: #{@csvMode}" 
           init
           @funcdoc = {:class=>self.class, :blurb=>'Analyze Calculated Fields', :description=>'Calculated fields can be complex, this tool provides robust coverage.',}
           #-- CSV records collectors

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

@@ -53,7 +53,7 @@ module CalculatedFields
       @twb = twb #Twb::Workbook.new twb
       @docFileName = './ttdoc/' + @twb.name + '.CalculatedFields.md'
       @docFile     = File.open(@docFileName,'w')
-      addDocFile @docFileName,"Markdown file of Calculated fields for Workbook '#{@twb.name}'"
+      addDocFile @docFile, @docFileName, "Markdown file of Calculated fields for Workbook '#{@twb.name}'"
       @docFile.puts "# #{twb.name}"
       dsNames = @twb.datasourceUINames
       @docFile.puts "#{dsNames.length} Data Sources"
@@ -63,37 +63,37 @@ module CalculatedFields
         cnt = 0
         ds.calculatedFields.each do |cf|
           cnt += 1
-           @docFile.puts "### '#{cf.uiname}'"
-           @docFile.puts "```"
-            cf.formulaResolvedLines.each do 
-                |l|@docFile.puts "#{l.gsub('<<','[').gsub('>>',']')}" 
+          @docFile.puts "### '#{cf.uiname}'"
+          @docFile.puts "```"
+          cf.formulaResolvedLines.each do |l|
+            @docFile.puts "#{l.gsub('<<','[').gsub('>>',']')}" 
+          end
+          @docFile.puts "```"
+          if cf.calcFields.length > 0
+            fieldsRefOrder  = []
+            fieldsSortSet   = SortedSet.new
+            cf.calcFields.each do |field|
+              fieldsRefOrder.push field.uiname
+              fieldsSortSet << field.uiname
             end
-           @docFile.puts "```"
-           if cf.calcFields.length > 0
-               fieldsRefOrder  = []
-               fieldsSortSet   = SortedSet.new
-               cf.calcFields.each do |field|
-                   fieldsRefOrder.push field.uiname
-                   fieldsSortSet << field.uiname
-               end
-               if fieldsRefOrder != fieldsSortSet.to_a
-                  @docFile.puts "```"
-                  @docFile.puts "Fields - reference order:"
-                   fieldsRefOrder.each do |field|
-                      @docFile.puts "    '#{field}'"
-                   end
-                  @docFile.puts "```"
-               end
-               if fieldsSortSet.length > 0
-                  @docFile.puts "```"
-                  @docFile.puts "Fields:"
-                   fieldsSortSet.each do |field|
-                      @docFile.puts "    '#{field}'"
-                   end
-                  @docFile.puts "```"
-               end
-           end
-           @docFile.puts "\n "
+            if fieldsRefOrder != fieldsSortSet.to_a
+              @docFile.puts "```"
+              @docFile.puts "Fields - reference order:"
+              fieldsRefOrder.each do |field|
+                @docFile.puts "    '#{field}'"
+              end
+              @docFile.puts "```"
+            end
+            if fieldsSortSet.length > 0
+              @docFile.puts "```"
+              @docFile.puts "Fields:"
+              fieldsSortSet.each do |field|
+                @docFile.puts "    '#{field}'"
+              end
+              @docFile.puts "```"
+            end
+          end
+            @docFile.puts "\n "
         end
         @docFile.puts "counted #{cnt} calculated fields\n "
       end  # twb.datasources.each

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

@@ -27,14 +27,22 @@ module Analysis
 
     attr_accessor :localEmit
 
-    def initialize
+    def initialize(**args)
+      #-- TODO move @csvAdd * #csvMode resolution to TabTool
+      @csvAdd  = args[:csvMode] == :add
+      @csvMode = @csvAdd ? 'a' : 'w'
+      emit "@csvAdd : #{@csvAdd}" 
+      emit "@csvMode: #{@csvMode}" 
+      #--
       init
       @funcdoc    = {:class=>self.class, :blurb=>'Analyze Data Source Origins, i.e. where the data comes from', :description=>nil,}
       #--
       docFileName = docFile('DataSourceOrigins.csv')
       @csvFile  = CSV.open(docFileName,'w')
-      @csvFile  << ['Workbook', 'Workbook Version', 'Workbook Directory', 'Data Source', 'Data Source (tech)', 'Is Published?', "Rec #"]
-      addDocFile docFileName, "Workbooks, Data Sources, and the Data Sources' origins"
+      unless @csvAdd
+        @csvFile  << ['Workbook', 'Workbook Version', 'Workbook Directory', 'Data Source', 'Data Source (tech)', 'Is Published?', "Rec #"]
+      end
+      addDocFile @csvFile, docFileName, "Workbooks, Data Sources, and the Data Sources' origins"
       #--
       @twbCnt     = 0
       @dsCnt      = 0

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

@@ -27,7 +27,13 @@ module Analysis
     attr_accessor :localEmit
     attr_reader   :twbname, :twbcount
 
-    def initialize
+    def initialize(**args)
+      #-- TODO move @csvAdd * #csvMode resolution to TabTool
+      @csvAdd  = args[:csvMode] == :add
+      @csvMode = @csvAdd ? 'a' : 'w'
+      emit "@csvAdd : #{@csvAdd}" 
+      emit "@csvMode: #{@csvMode}" 
+      #--
       init
       #-- set up metrics
       @twbcount   = 0
@@ -38,8 +44,11 @@ module Analysis
       @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."}]
+      unless @csvAdd
+        @csv << ["Workbook",'Data Source','Connection','File Name','Type','Table Name','Field']
+      end
+      # @docfiles = [{:name=>docFileName,:description=>"CSV File containing the data relating Google Sheet-based Data Sources."}]
+      addDocFile @dashSheetsCSV, docFileName, "Workbooks, Dashboards, and their Worksheets"
     end
 
     def processTWB twb

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

@@ -25,14 +25,22 @@ module Analysis
 
     attr_accessor :localEmit
 
-    def initialize
+    def initialize(**args)
+      #-- TODO move @csvAdd * #csvMode resolution to TabTool
+      @csvAdd  = args[:csvMode] == :add
+      @csvMode = @csvAdd ? 'a' : 'w'
+      emit "@csvAdd : #{@csvAdd}" 
+      emit "@csvMode: #{@csvMode}" 
+      #--
       init
       @funcdoc     = {:class=>self.class, :blurb=>'Analyze Dashboard Worksheets', :description=>'Identifies the Worksheets present in Dashboards.',}
       #--
-      docFileName  = docFile('DashboardSheets.csv')
-      @dashSheetsCSV  = CSV.open(docFileName,'w')
-      @dashSheetsCSV  << ['Workbook','Workbook Dir','Modified','Dashboard','Worksheet','Hidden','Visible']
-      addDocFile docFileName, "Workbooks, Dashboards, and their Worksheets"
+      docFileName     = docFile('DashboardSheets.csv')
+      @dashSheetsCSV  = CSV.open(docFileName,@csvMode)
+      unless @csvAdd
+        @dashSheetsCSV  << ['Workbook','Workbook Dir','Modified','Dashboard','Worksheet','Hidden','Visible']
+      end
+      addDocFile @dashSheetsCSV, docFileName, "Workbooks, Dashboards, and their Worksheets"
       #--
       @twbCount    = 0
       @dashCount   = 0

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

@@ -40,14 +40,21 @@ module Analysis
 
     attr_accessor :localEmit
 
-    def initialize
+    def initialize(**args)
+      @csvAdd  = args[:csvMode] == :add
+      @csvMode = @csvAdd ? 'a' : 'w'
+      emit true, "@csvAdd : #{@csvAdd}" 
+      emit true, "@csvMode: #{@csvMode}" 
+      
       init
       @funcdoc    = {:class=>self.class, :blurb=>'Analyze Worksheet Fields', :description=>nil,}
       #--
       docFileName = docFile('WorksheetFields.csv')
       @sheetFieldsCSV  = CSV.open(docFileName,'w')
-      @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"
+      unless @csvAdd
+        @sheetFieldsCSV  << ['Rec #', 'Workbook','Worksheet','Data Source','Data Source (tech)','Field','Field (tech)','Usage','Usage - code']
+      end
+      addDocFile @sheetFieldsCSV, docFileName, "Workbooks, Worksheets, and the Sheets' Data Sources and Fields"
       #--
       @twbCnt     = 0
       @sheetCnt   = 0

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

@@ -25,14 +25,20 @@ module Analysis
 
     attr_accessor :localEmit
 
-    def initialize
+    def initialize(**args)
+      @csvAdd  = args[:csvMode] == :add
+      @csvMode = @csvAdd ? 'a' : 'w'
+      emit true, "@csvAdd : #{@csvAdd}" 
+      emit true, "@csvMode: #{@csvMode}" 
       init
       @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','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"
+      unless @csvAdd
+        $sheetFieldsCSV  << ['Workbook','Workbook Dir','Worksheet','Filter Type','Operation','Data Source','Field','Value','Alias', 'Alias?','Operation Mode','Include Null?','Kind']
+      end
+      addDocFile $sheetFieldsCSV, docFileName, "Workbooks, Worksheets and the sheets' Quick Filters"
       #--
       @sheetCount  = 0
       @filterCount = 0

data/lib/twb/tabtool.rb

@@ -103,9 +103,19 @@ module TabTool
     @docfiles ||= @docfiles = []
   end
 
-  def addDocFile name, description
+  def addDocFile file, name, description
     @docfiles = [] if @docfiles.nil?
-    @docfiles << {:name=>name,:description=>description}
+    @docfiles << {:file=>file, :name=>name, :description=>description}
+  end
+
+  def closeDocFiles
+    emit "Closing doc files"
+    @docfiles.each do |dfh|
+      docfile = dfh[:file]
+      emit "  -- #{dfh[:name]}"
+      docfile.close unless docfile.nil?
+    end
+    emit "-----------------"
   end
 
   def docFileMaxNameLen
@@ -148,7 +158,7 @@ module TabTool
     emit "init CSV #{csvName}"
     csvFile = CSV.open(csvName, 'w')
     csvFile << header unless header.nil?
-    addDocFile csvName,desc
+    addDocFile csvFile, csvName, desc
     return csvFile
   end
 

data/lib/twb/workbook.rb

@@ -64,6 +64,106 @@ module Twb
         @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
+
+    # Add a new Documentation Dashboard to the TWB.
+    # Ensure that the TWB has a <dashboards> node (it may not).
+    # Make sure that the new Doc Dashboard's name doesn't conflict with an existing Dashboard - increment the incoming name if necessary.
+    # Add Doc Dashboard's <dashboard> and <window> nodes to the TWB; there's always a <windows> node in the TWB.
+    def addDocDashboard docDashboard
+      ensureDashboardsNodeExists
+      ensureWindowsNodeExists
+      title = getNewDashboardTitle(docDashboard.title)
+      docDashboard.title=(title) unless title == docDashboard.title
+      @dashesNode.add_child(docDashboard.dashnode)
+      @windowsnode.add_child(docDashboard.winnode)
+    end
+
+    # Write the TWB to a file, with an optional name.
+    # Can be used to write over the existing TWB (dangerous), or to a new file (preferred).
+    def write(name=@name)
+      case @type
+      when :twb 
+        writeTwb(name)
+      when :twbx 
+        writeTwbx(name)
+      else
+        emit  "Cannot write this Workbook - it has an invalid type: #{@type}"
+        raise "Cannot write this Workbook - it has an invalid type: #{@type}"
+      end
+    end
+
+    # Write the TWB to a file, appending the base name with the provided string.
+    # Intended for use when making adjustments to the TWB without overwriting the original.
+    def writeAppend(str)
+      newName = @name.sub(/[.]twb$/,'') + str.gsub(/^[.]*/,'.') + '.twb'
+      write newName
+    end
+
+    private
+
     def processTWBX(twbxWithDir)
       Zip::File.open(twbxWithDir) do |zip_file|
         twb   = zip_file.glob('*.twb').first
@@ -92,14 +192,6 @@ module Twb
       @valid = true
     end
 
-    def build
-      @build ||= loadBuild
-    end
-
-    def release
-      @build ||= loadBuild
-    end
-
     def loadBuild
       # - earlier Version, need to confirm when source-build began 
       #   @build   = @ndoc.xpath('/workbook/comment()').text.gsub(/^[^0-9]+/,'').strip
@@ -189,35 +281,6 @@ module Twb
       end
     end
 
-    def actions
-      @actions.values
-    end
-
-    def actionNames
-      @actions.keys
-    end
-
-    # def datasources
-    #   # puts "ACCESSING DATASOURCES - #{@datasources.class} - #{@datasources.length} - #{@datasources.values.length}"
-    #   return @datasources.values
-    # end
-
-    def dashboards
-      @dashboards.values
-    end
-
-    def dashboardNames
-      @dashboards.keys
-    end
-
-    def dashboard name
-      @dashboards[name]
-    end
-
-    def orphanDataSources
-      @orphanDataSources ||= identifyOrphandatasoUrceS
-    end
-
     def identifyOrphandatasoUrceS
       sheetDataSources = Set.new
       @worksheets.values.each do |sheet|
@@ -228,56 +291,17 @@ module Twb
       @orphanDataSources = @datasourceUINames - sheetDataSources
     end
 
-    def storyboards
-      @storyboards.values
-    end
-
-    def worksheets
-      @worksheets.values
-    end
-
-    def storyboardNames
-      @storyboards.keys
-    end
-
-    def worksheetNames
-      @worksheets.keys
-    end
-
-    def datasource name
-      @dataSourceNamesMap[name]
-    end
-
-    def storyboard name
-      @storyboards[name]
-    end
-
-    def worksheet name
-      @worksheets[name]
-    end
-
-    def parameters
-      @parameters ||= loadParameters
-    end
-
-    def ensureWindowsNodeExists
-      if @windowsnode.nil?
-        @windowsnode = Nokogiri::XML::Node.new "windows", @ndoc
-        # TODO fix this @dataSourcesNode.add_next_sibling(@windowsnode)
+    def writeTwb(name=@name)
+      $f = File.open(name,'w')
+      if $f
+          $f.puts @ndoc
+          $f.close
       end
+      return name
     end
 
-    # Add a new Documentation Dashboard to the TWB.
-    # Ensure that the TWB has a <dashboards> node (it may not).
-    # Make sure that the new Doc Dashboard's name doesn't conflict with an existing Dashboard - increment the incoming name if necessary.
-    # Add Doc Dashboard's <dashboard> and <window> nodes to the TWB; there's always a <windows> node in the TWB.
-    def addDocDashboard docDashboard
-      ensureDashboardsNodeExists
-      ensureWindowsNodeExists
-      title = getNewDashboardTitle(docDashboard.title)
-      docDashboard.title=(title) unless title == docDashboard.title
-      @dashesNode.add_child(docDashboard.dashnode)
-      @windowsnode.add_child(docDashboard.winnode)
+    def writeTwbx(name=@name)
+        emit  "Writing the Workbook, need implementation"
     end
 
     # Make sure that the TWB has a <dashboards> node.
@@ -289,6 +313,13 @@ module Twb
       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)
@@ -304,44 +335,6 @@ module Twb
       return title
     end
 
-    # Write the TWB to a file, with an optional name.
-    # Can be used to write over the existing TWB (dangerous), or to a new file (preferred).
-    def write(name=@name)
-      case @type
-      when :twb 
-        writeTwb(name)
-      when :twbx 
-        writeTwbx(name)
-      else
-        emit  "Cannot write this Workbook - it has an invalid type: #{@type}"
-        raise "Cannot write this Workbook - it has an invalid type: #{@type}"
-      end
-    end
-
-    # Write the TWB to a file, appending the base name with the provided string.
-    # Intended for use when making adjustments to the TWB without overwriting the original.
-    def writeAppend(str)
-      newName = @name.sub(/[.]twb$/,'') + str.gsub(/^[.]*/,'.') + '.twb'
-      write newName
-    end
-
-    private
-
-    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
-
-
-
     def loadParameters
       @parameters = {}
       paramsDS = ndoc.at_xpath('./workbook/datasources/datasource[@name="Parameters"]')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 4.3.3
+  version: 4.4.1
 platform: ruby
 authors:
 - Chris Gerrard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-26 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: creek