twb 4.6.0 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e049f4ada5ac7d92e8c34a843e3593a632b2c009854fa09f3c085567e7904289
-  data.tar.gz: 423d1b5cd090535b6a60409e468df0ffd7fd28583660a5ff86c9ce9101dcfb1a
+  metadata.gz: 199291219b0d5c06c822c4eedce63579a9a7cf80a1c4acfc53429403aeddc7f6
+  data.tar.gz: c6889a7c889c8c0890bde9f6e9e8b8a016af6a319d75dc3634d266ce36a7cbab
 SHA512:
-  metadata.gz: a814663aa667f6af9e62bff76c3bedf7497eb248e8883e1cbfa09a2631f8cf51a3714929c98f852f5c328f66d9a022c8f0df28c767e39e90ce860cd311cb99a3
-  data.tar.gz: 6bcd9e6d20bab6ca85dfc6d954c99d711dc4475784068c8d7598a4f718a2fc446d90d277c03924b122a402fddd06b594efb93ec827668694bdfd3aeb865d9c84
+  metadata.gz: 74f35bd36b750b031999d6fbdfc3f57113114ab54c8fbec33e9874203402e09c24374619ec74af683cd5c687e5dea5d8e5a7a2ec5f99a06851f975590aeceabc
+  data.tar.gz: 92af9190a8661aee7e1e45fe689c7737c802b617ba74eac8efd409c5c7b5569bbfa5a822bd16e4b9b4a18f7d297c889c8e27c1ab566df105722ae32db1b01bcb

data/lib/twb.rb

@@ -56,7 +56,8 @@ require_relative 'twb/analysis/calculatedfields/calculatedfieldsanalyzer'
 require_relative 'twb/analysis/calculatedfields/groupfieldsanalyzer'
 require_relative 'twb/analysis/calculatedfields/markdownemitter'
 require_relative 'twb/analysis/calculatedfields/csvemitter'
-require_relative 'twb/analysis/datasources/datasourcefieldscsvemitter'
+# require_relative 'twb/analysis/datasources/datasourcefieldscsvemitter'
+require_relative 'twb/analysis/datasources/datasourcefieldsanalyzer'
 require_relative 'twb/analysis/datasources/datasourcetablefieldscsvemitter'
 require_relative 'twb/analysis/datasources/categoricalcolorcodinganalyzer'
 require_relative 'twb/analysis/datasources/googlesheetdatasourcesanalyzer'
@@ -71,5 +72,5 @@ require_relative 'twb/analysis/sheets/dashsheetsanalyzer'
 # Represents Tableau Workbooks, their contents, and classes that analyze and manipulate them.
 #
 module Twb
-  VERSION = '4.6.0'
+  VERSION = '4.6.1'
 end

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

@@ -0,0 +1,284 @@
+#  calculatedfieldsanalyzer.rb - this Ruby script Copyright 2017, 2018 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 DataSourceFieldsAnalyzer
+
+    include TabTool
+
+    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'
+
+    @@fullFileType = 'DataSourceFieldsDetails'
+    @@fullFileName = @@fullFileType + '.csv'
+    @@fullHeader = ['Field #',
+                    'Workbook',
+                    'Data Source',
+                    'Field',
+                    'Field - source',
+                    'Field - class',
+                    'Field - path',
+                    'Property - Name',
+                    'Property - Value'
+                   ]
+
+    # @@techFileType = 'TwbDataSourceFieldsTech'
+    # @@techFileName = @@techFileType + '.csv'
+    # @@techHeader = ['Field #',
+    #                 'Workbook',           
+    #                 'Workbook Dir',
+    #                 'Data Source',
+    #                 'Field',
+    #                 'Field Type',
+    #                 'Property - Name',
+    #                 'Property - Value'
+    #                ]
+
+    def initialize(**args)
+      @args      = args
+      # puts "@args: #{@args}"
+      @recordDir = !@args.nil? && @args[:recordDir] == true
+      @ttdocdir  = @args[:ttdocdir]
+      @csvAdd    = args[:csvMode] == :add
+      @csvMode   = @csvAdd ? 'a' : 'w'
+      init
+      @funcdoc   = {:class=>self.class, :blurb=>'Analyze Data Source Fields', :description=>'Documents Data Source fields, with (some) technical information.',}
+      #--
+      docFileName = docFile(@@fullFileName)
+      @csvFile    = CSV.open( docFileName,@csvMode)
+      unless @csvAdd
+        if @recordDir
+          @csvFile  << @@fullHeader + ['Workbook Dir']
+        else
+          @csvFile  << @@fullHeader
+        end
+      end
+      addDocFile @csvFile, docFileName, "Workbooks, Data Sources, and Fields."
+      #--
+      # --
+      @dsCount     = 0
+      @recNum      = 0
+    end
+
+    def initializeX
+      # @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(@@techFileName,'w')
+      # @csvFileTech << @@techHeader
+      # puts "Opened: #{!@csvFileTech.nil?} - #{@@techFileName}"
+      # --
+    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
+      @fieldCnt = 0
+      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 metrics
+      {
+        '# of Data Sources'        => @dsCount,
+        '# of Records'             => @recNum
+      }
+    end
+
+    private
+
+    def recordFieldFull field, source
+      # print field.properties.nil? ? '-' : ":#{field.properties.length}"
+      # puts field.properties
+      @fieldCnt+=1
+      field.properties.each do |name,value|
+        # print name 
+        csvRec = [ @recNum+=1,
+                   @twb.name,
+                   # @twb.dir,
+                   @dsname,
+                   field.uiname,
+                   source,
+                   field.class,
+                   field.node.path.to_s.gsub(/[0-9]/,'').gsub('[]',''),
+                   name,
+                   value
+                 ]
+        csvRec << @twb.dir if @recordDir
+        @csvFile << 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

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

@@ -22,6 +22,8 @@ module DataSources
 
   class DataSourceFieldsCSVEmitter
 
+    include TabTool
+
     attr_reader :csvFileName, :csvRecords
     attr_reader :dsCount,     :fieldsCount  
 
@@ -67,7 +69,33 @@ module DataSources
     #                 'Property - Value'
     #                ]
 
-    def initialize
+    def initialize(**args)
+      @args      = args
+      # puts "@args: #{@args}"
+      @recordDir = !@args.nil? && @args[:recordDir] == true
+      @ttdocdir  = @args[:ttdocdir]
+      @csvAdd    = args[:csvMode] == :add
+      @csvMode   = @csvAdd ? 'a' : 'w'
+      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(@@fullFileName)
+      @sheetFieldsCSV  = CSV.open( docFileName,@csvMode)
+      unless @csvAdd
+        if @recordDir
+          @sheetFieldsCSV  << ['Rec #','Workbook','Workbook Modified','Worksheet','Filter Type','Operation','Data Source','Field','Value','Alias', 'Alias?','Operation Mode','Include Null?','Kind','Workbook Dir']
+        else
+          @sheetFieldsCSV  << ['Rec #','Workbook','Workbook Modified','Worksheet','Filter Type','Operation','Data Source','Field','Value','Alias', 'Alias?','Operation Mode','Include Null?','Kind']
+        end
+      end
+      addDocFile @sheetFieldsCSV, docFileName, "Workbooks, Worksheets and the sheets' Quick Filters"
+      #--
+      @sheetCount  = 0
+      @filterCount = 0
+      @recNum      = 0
+    end
+
+    def initializeX
       # @csvFile     = CSV.open(@@csvFileName,'w')
       # @csvFile     << @@csvHeader
       # @csvRecords  = Set.new

data/lib/twb/datasource.rb

@@ -461,7 +461,10 @@ module Twb
     end
 
     def allFields
-      return @allFields unless @allFields.nil?
+      return @allFields ||= loadAllFields
+    end
+
+    def loadAllFields
       @allFields = SortedSet.new
       dbf = dbFields
       @allFields << dbf.keys

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.6.1
 platform: ruby
 authors:
 - Chris Gerrard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: creek
@@ -66,6 +66,7 @@ files:
 - lib/twb/analysis/calculatedfields/groupfieldsanalyzer.rb
 - lib/twb/analysis/calculatedfields/markdownemitter.rb
 - lib/twb/analysis/datasources/categoricalcolorcodinganalyzer.rb
+- lib/twb/analysis/datasources/datasourcefieldsanalyzer.rb
 - lib/twb/analysis/datasources/datasourcefieldscsvemitter.rb
 - lib/twb/analysis/datasources/datasourceoriginsanalyzer.rb
 - lib/twb/analysis/datasources/datasourceslocationsanalyzer.rb