twb 3.9.3 → 3.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01e007d30bd02da639fec0bef95e94e39bf4c51b
-  data.tar.gz: 6f07a8ac8308a197494e6d89211f9569e1d31884
+  metadata.gz: 8a3bca661db5662df120e34443a68874a5a0d5f6
+  data.tar.gz: 56e2f1171c7c4df1b64a6f4767070ecb9f023b76
 SHA512:
-  metadata.gz: 1c9413d8c790ebc4f11396b3c118a03e9bef3914b4a19b53384cf374572b24521f4f5de8cc6a7ebbc04d559d0ef13840263b68dd6da6566c22c69f39c3dacada
-  data.tar.gz: f0ebc5cbcf4e62b0b17021d97143d0b701b9af1ade87cee099c963d9af423b9cc5038c462239e9365460a69e4e0b0a144f8e52ca25c99f6852371d3e9547dd53
+  metadata.gz: 85fc520db33e97945985b457870f21f73ced2105ba7b60287ccefb09291292da2969f364a771d9d6283abd8b00b61a58f43864500dc8fd5c7e19fcfc1a73a1f4
+  data.tar.gz: 55834df4440a51aad3c9ed05aa069c961365aafa56254aaf99a59cd64734cdbf0c8ca1aa3cd9e5d64fbce7883380ebf116d4ee9ffbd58ac414dddb6fac2f6be2

data/lib/twb.rb

@@ -1,4 +1,4 @@
-#  Copyright (C) 2014, 2015  Chris Gerrard
+#  Copyright (C) 2014, 2015, 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
@@ -25,11 +25,14 @@ require_relative 'twb/storyboard'
 require_relative 'twb/window'
 require_relative 'twb/workbook'
 require_relative 'twb/worksheet'
+require_relative 'twb/parameter'
 require_relative 'twb/action'
 require_relative 'twb/columnfield.rb'
 require_relative 'twb/calculatedfield'
 require_relative 'twb/codedfield'
+require_relative 'twb/groupfield'
 require_relative 'twb/fieldcalculation'
+require_relative 'twb/quickfilter'
 require_relative 'twb/docdashboardimagevert'
 require_relative 'twb/docdashboardwebvert'
 require_relative 'twb/util/twbDashSheetDataDotBuilder'
@@ -54,6 +57,7 @@ require_relative 'twb/analysis/calculatedfields/csvemitter'
 require_relative 'twb/analysis/datasources/DataSourceFieldsCSVEmitter'
 require_relative 'twb/analysis/datasources/DataSourceTableFieldsCSVEmitter'
 require_relative 'twb/analysis/datasources/googlesheetdatasourcesanalyzer'
+require_relative 'twb/analysis/datasources/parametersanalyzer'
 require_relative 'twb/analysis/Sheets/WorksheetDataStructureCSVEmitter'
 require_relative 'twb/analysis/Sheets/sheetfiltersanalyzer'
 require_relative 'twb/analysis/Sheets/sheetfieldsanalyzer'
@@ -63,5 +67,5 @@ require_relative 'twb/analysis/Sheets/dashsheetsanalyzer'
 # Represents Tableau Workbooks and their contents.
 #
 module Twb
-  VERSION = '3.9.3'
+  VERSION = '3.9.7'
 end

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

@@ -0,0 +1,95 @@
+#  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'
+# require 'set'
+
+module Twb
+module Analysis
+
+  class ParametersAnalyzer
+
+    include TabTool
+
+    attr_accessor :localEmit
+    attr_reader   :twbname, :twbcount
+
+    def initialize
+      init
+      #-- set up metrics
+      @paramscount = 0
+      #--
+      @funcdoc    = {:class=>self.class, :blurb=>'Analyzing Parameters from Tableau Workbooks.', :description=>nil,}
+      docFileName = docFile('TWBParameters.csv')
+      @csv        = CSV.open(docFileName, 'w')
+      @csv       << ["Workbook",'Parameter','Caption','Name (tech)','Type','Format','Type (custom)','Type (domain)','Role', 'Value (current)', 'Value','Value (tech)']
+                  # [ @twbname,  name,       caption,  nameTech,     type,  format,  typeCustom,     domainType,     role]
+      @docfiles = [{:name=>docFileName,:description=>"CSV File containing the data relevant for Parameters."}]
+    end
+
+    #-- Parameter attributes
+    # caption                    : 11
+    # name                       : 11
+    # datatype                   : 11
+    # datatype-customized        : 9
+
+    # param-domain-type          : 11
+    # role                       : 11
+    # type                       : 11
+    # value                      : 11
+    # default-format             : 7
+    # alias                      : 1
+
+    def processTWB twb
+      if Twb::Workbook != twb.class
+        @twb = Twb::Workbook.new twb
+      else
+        @twb = twb
+      end
+      @twbname = @twb.name
+      emit  "Workbook:: #{@twbname}"
+      paramsDS = @twb.datasource 'Parameters'
+      @twb.parameters.each do |pName,param|
+        @paramscount += 1
+        param.values.each do |values|
+          @csv       << [ @twbname,
+                          param.uiname,
+                          param.caption,
+                          param.name,
+                          param.type,
+                          param.format,
+                          param.dataTypeCustom,
+                          param.domainType,
+                          param.role,
+                          param.currentValue, # 'Value (current)', 
+                          values[:value],     # 'Value',
+                          values[:valueTech]      # 'Value (tech)'
+                        ]
+        end
+      end
+    end
+
+    def metrics
+      {
+        '# of Parameters' => @paramscount,
+      }
+    end
+
+  end #class ParametersAnalyzer
+
+end # module Analysis
+
+end # module Twb

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

@@ -29,344 +29,53 @@ module Analysis
       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('TWBWorksheetFilters.csv')
+      docFileName  = docFile('WorksheetFilters.csv')
       $sheetFieldsCSV  = CSV.open( docFileName  ,'w')
-      $sheetFieldsCSV  << ['Workbook','Worksheet','Filter Type','Operation','Data Source','Field','Value','Alias', 'Alias?']
+      $sheetFieldsCSV  << ['Workbook','Worksheet','Filter Type','Operation','Data Source','Field','Value','Alias', 'Alias?','Operation Mode','Include Null?']
       addDocFile docFileName, "Workbooks, Worksheets and the sheets' Quick Filters"
       #--
-      @twbCount    = 0
       @sheetCount  = 0
       @filterCount = 0
     end
 
     def metrics
       {
-        '# of Workbooks'         => @twbcount,
         '# of Worksheets'        => @sheetCount,
         '# of Worksheet Filters' => @filterCount
       }
     end
 
     def processTWB twb
-       @twb = twb
-       emit "   -- #{@twb.name}"
-       @twbCount += 1
+       @twb     = twb
+       @twbName = @twb.name
+       emit "   -- #{@twbName}"
        @twbDomainsLoaded = false
        parseFilters
-       finis
     end
 
-
     def parseFilters
       @worksheets  = @twb.worksheets
       @worksheets.each do |sheet|
         emit "\n\nSHEET: #{sheet.name}"
-        @sheetCount += 1
-        filters = sheet.node.xpath('.//filter[@column]')
+        filters = sheet.filters
         filters.each do |filter|
-          @filterCount += 1
-          emit "\nFILTER:\n#{filter}\n====="
-          filterClass  = filter.attribute('class').text
-          fieldCode    = filter.attribute('column').text
-          codedField   = Twb::CodedField.new(fieldCode) 
-          fieldTech    = codedField.name
-          inexclude    = fieldTech =~ /^(Ex|In)clusions/
-          measureNames = ':Measure Names' == fieldTech
-          srcTech      = codedField.dataSource
-          dataSource   = @twb.datasource(srcTech)
-          @dsAliases   = dataSource.aliases
-          field        = measureNames || inexclude ? fieldTech : dataSource.field(fieldTech)
-          fieldName    = measureNames || inexclude ? fieldTech : dataSource.fieldUIName(fieldTech)
-          emit "\n::  FIELD  :: #{field} == #{fieldName}   --  #{fieldTech}  --  #{codedField.rawCode}"
-          emit "       filter class: #{filterClass}"
-          emit "         field code: #{fieldCode}"
-          emit "        coded field: #{codedField}"
-          emit "         field tech: #{fieldTech}"
-          emit "         field name: nil? #{fieldName.nil?}   #{fieldName}  "
-          emit "           src tech: #{srcTech}"
-          emit "       measureNames: #{measureNames}"
-          emit "              sheet: #{sheet.name}"
-          emit "               node: #{filter}"
-          emit "                 ds: #{dataSource.uiname}"
-          emit "              field: #{field}"
-          emit " "
-          aaa = case filterClass
-          when 'relative-date' then resolveRelativeDate(sheet, dataSource, fieldName, filter)
-          when 'quantitative'  then resolveQuantitative(sheet, dataSource, fieldName, filter)
-          when 'categorical'   then resolveCategoricalValues(sheet, dataSource, fieldName, filter, measureNames)
+          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]
           end
-        end
-      end
-    end
-
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-1' include-future='true' include-null='false' last-period='-1' period-type='day' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-1' include-future='true' include-null='false' last-period='-1' period-type='year' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-1' include-future='true' include-null='false' last-period='0' period-type='year' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-2' include-future='true' include-null='false' last-period='0' period-type='day' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-2' include-future='true' include-null='false' last-period='0' period-type='year' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='-6' include-future='true' include-null='false' last-period='0' period-type='day' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='false' include-null='false' last-period='0' period-type='year' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='0' period-type='day' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='0' period-type='year' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='2' period-type='day' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='2' period-type='year' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='0' include-future='true' include-null='false' last-period='4' period-type='day' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='1' include-future='true' include-null='false' last-period='1' period-type='day' />
-    # filter class='relative-date' column='[Sample - Superstore].[none:Order Date:qk]' first-period='1' include-future='true' include-null='false' last-period='1' period-type='year' />
-    def resolveRelativeDate sheet, dataSource, field, node
-      emit "resolveRelativeDate"
-      operation   = 'Inclusive'
-      periodType  = node['period-type']
-      inclFuture  = node['include-future'] == 'true'
-      firstPeriod = node['first-period'].to_i
-      lastPeriod  = node['last-period'].to_i
-      sum        = firstPeriod + lastPeriod
-      prod       = firstPeriod * lastPeriod
-      periodTech = "#{periodType} : #{firstPeriod} -> #{lastPeriod}"
-      period     = periodTech
-      if sum == 0 && prod == 0
-        period = case periodType
-                   when 'day'  then "Today"
-                   else inclFuture ? "This #{periodType.capitalize}" : "#{periodType.capitalize} to date"
-                 end
-      elsif firstPeriod == lastPeriod
-         future = firstPeriod > 0
-         reln   = future ? 'Next' : 'Previous'
-         period = case periodType
-                    when 'day' then  future ? 'Tomorrow' : 'Yesterday' 
-                    else        "#{reln} #{periodType.capitalize}"
-                  end
-      else
-         span = lastPeriod - firstPeriod + 1
-         future = firstPeriod == 0 
-         reln   = future ? "Next" : "Last"
-         period = "#{reln} #{span} #{periodType.capitalize}s"
-      end
-      $sheetFieldsCSV << [ @twb.name, sheet.name, 'Relative Date',operation, dataSource.uiname, field, period, periodTech  ]
-    end
-
-        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='in-range'>
-        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='in-range'>
-        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='in-range'>
-        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='all' />
-        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='non-null' />
-        # <filter class='quantitative' column='[Sample - Superstore].[none:Profit:qk]' included-values='null' />
-    def resolveQuantitative sheet, dataSource, field, node 
-      emit "resolveQuantitative"
-      operation  = 'Inclusive'
-      inclValues = node['included-values']
-      values = if 'in-range' == inclValues
-                   quantRangeValues node
-               else
-                   "#{inclValues.capitalize} Values"
-               end
-      $sheetFieldsCSV << [ @twb.name, sheet.name, 'Range (row)',operation.capitalize, dataSource.uiname, field, values, inclValues  ]         
-    end
-
-    def quantRangeValues node
-      min  = node.at_xpath('min')
-      max  = node.at_xpath('max')
-      emit "min: nil? %-6s  val: %-s " % [min.nil?,min]
-      emit "max: nil? %-6s  val: %-s " % [max.nil?,max]
-      minrv  = parseRangeVal min unless min.nil?
-      maxrv  = parseRangeVal max unless max.nil?
-      mintxt = min.nil? ? '' : max.nil? ? "At least: #{minrv}" : "Range #{minrv}"
-      maxtxt = max.nil? ? '' : min.nil? ? "At most: #{maxrv}"  : " ... #{maxrv}"
-      emit   "#{mintxt} #{maxtxt}"
-      return "#{mintxt} #{maxtxt}"
-    end
-
-    def parseRangeVal node
-      return 'nil' if node.nil?
-      text = node.text 
-      if text.start_with?('#') 
-        return text.gsub(/^[#]|[#]$/,'') 
-      end
-      num = text.to_f
-      # num.negative? ? num.floor : num.ceil
-      result = if num < 0
-                 num.floor
-               else
-                 num.ceil
-               end
-      return result
-    end   
-
-    def resolveCategoricalValues sheet, dataSource, field, node, measureNames
-      emit "resolveCategoricalValues"
-      emit "measureNames: #{measureNames}"
-      firstChild = node.at_xpath('./groupfilter')
-      results = {}
-      #-- handling Inclusions & Exclusions, in-sheet pick-data filters
-      if field =~ /^(Ex|In)clusions/ 
-          enumerate  = firstChild['user:ui-enumeration']
-          operation  = enumerate.nil? ? 'Inclusive' : enumerate.capitalize
-          $sheetFieldsCSV << [ @twb.name, sheet.name, 'In-Sheet', operation, dataSource.uiname, field, '+++', '+++'  ]
-          return results
-      end
-      #-- 
-      unless firstChild.nil?
-          function   = firstChild.attribute('function').text
-          enumerate  = firstChild['user:ui-enumeration']
-          operation  = enumerate.nil? ? 'Inclusive' : enumerate.capitalize
-          emit  "function : #{function}"
-          emit  "enumerate: #{enumerate}"
-          emit  "operation: #{operation}"
-          emit  node.to_s
-          #-- single element filter
-          if 'member'.eql? function
-            emit  "HANDLING SINGLE MEMBER FILTER"
-            member = firstChild['member']
-            value  = measureNames ?  dataSource.fieldUIName(Twb::CodedField.new(member).name) : member.gsub(/^"|"$/,'') 
-            alia   = dataSource.deAlias(field,value)
-            emit  "value :%-25s =>  alias: %-s" % [value, alia]
-            $sheetFieldsCSV << [ @twb.name, sheet.name, 'single', operation, dataSource.uiname, field, value, alia  ]
-            return  {value => alia}
-          end
-          #-- another single element filter
-          # <groupfilter function="level-members" level="[none:Business Line:nk]" user:ui-enumeration="all" user:ui-marker="enumerate"/>
-          # <filter class='categorical' column='[federated.1astm0q1hl2ydc1dyqhqq0igvxkp].[none:Business Line:nk]' context='true'>
-          #   <groupfilter function='level-members' 
-          #                level='[none:Business Line:nk]' 
-          #                user:ui-enumeration='all' 
-          #                user:ui-exclude='true' 
-          #                user:ui-marker='enumerate' />
-          # </filter>
-          # <filter class='categorical' column='[federated.1astm0q1hl2ydc1dyqhqq0igvxkp].[none:Business Line:nk]' context='true'>
-          #   <groupfilter function='level-members' 
-          #                level='[none:Business Line:nk]' 
-          #                user:ui-enumeration='all' 
-          #                user:ui-marker='enumerate' />
-          # </filter>
-          if 'level-members'.eql? function
-            emit  "HANDLING level-members FILTER"
-            inclorexcl = firstChild.has_attribute?('user:ui-exclude') ? 'Exclusive' : 'Inclusive'
-            $sheetFieldsCSV << [ @twb.name, sheet.name, 'single', inclorexcl, dataSource.uiname, field, operation, enumerate  ]
-          end
-          #-- otherwise filter contains multiple elements
-          #-- handle individual member elements
-          elements = firstChild.xpath('.//groupfilter')
-          elements.each do |element|
-            function = element.attribute('function').text
-            emit "element function: #{function}\n    node:\n#{element}"
-            if 'member'.eql? function
-              member = element.attribute('member').text
-              name   = measureNames ? dataSource.fieldUIName(Twb::CodedField.new(member).name) : member.gsub(/^"|"$/,'')
-              emit "%%%% member NAME:: #{name}"
-              if '%null%' == name then name = 'Null' end
-              alia  =  dataSource.fieldAlias(field,name) # $TableNameAliases[name]
-              results[name] = alia
-            end
-            if 'range'.eql? function
-              emit "%%%% range element:: #{element}"
-              t = filtersFromRangeNode(dataSource, field, element)
-
-              if t.empty?
-                from = element['from']
-                to   = element['to']
-                range = "#{from} ... #{to}"
-                results[range] = range
-              end 
-
-              t.each do |name,alia|
-                emit "%%%% range Name: %-20s   ALIAS: %-s " % [name, alia]
-                results[name] = dataSource.fieldAlias(field,name)
-              end
-            end
-          end
-          results.each do |name,alia|
-            $sheetFieldsCSV << [ @twb.name, sheet.name, 'single',operation, dataSource.uiname, field, name, alia, !name.eql?(alia) ]
-          end
-      end
-      return results
-    end
-
-    def processMeasureNames sheet, dataSource, field, node
-      emit 'processMeasureNames'
-    end
-
-    def filtersFromRangeNode dataSource, field, node
-      unless @twbDomainsLoaded
-        loadDomains 
-      end
-      emit  "filtersFromRangeNode"
-      emit  "    from: #{node.attribute('from')}"
-      emit  "    to. : #{node.attribute('to')}"
-      from = node.attribute('from').text.gsub(/^"|"$/,'')
-      to   = node.attribute(  'to').text.gsub(/^"|"$/,'')
-      emit  "    from: #{from}"
-      emit  "    to. : #{to}"
-      filtersInRange dataSource, field, from, to
-    end
-
-    def filtersInRange dataSource, field, from, to
-      emit  "filtersInRange"
-      results   = {}
-      dsFields  = @twbFielddomains[dataSource.uiname]
-      emit  "dsFields    : #{dsFields}"
-      if dsFields.nil? || dsFields.empty?
-          alert  "#### ALERT #### - '#{field}' FIELD DOMAIN VALUES FOR '#{@twb.name} DATASOURCE #{dataSource.uiname} NOT LOADED ####"
-          emit   @twbFieldDomains
-          emit   "==========="
-          emit   dsFields
-          emit   "==========="
-      else
-          fieldVals = dsFields[field].to_a
-          if dataSource.fieldHasAliases field
-            #-- resolve aliases
-            dbValues = SortedSet.new
-            aliases  = dataSource.fieldAliases field
-            fieldVals.each do |fv|
-              fvAliased = aliases.has_value? fv
-              if fvAliased
-                dbValues <<  aliases.key(fv)
-              else 
-                dbValues <<  fv
-              end
-            end
-            $fieldVals = dbValues.to_a
-          else
-            #-- use domain values as returned
-            $fieldVals = dsFields[field].to_a
-          end
-          # domainVals = dsFields[field].to_a
-          # #-- need to dealias (unalias?) the field domain values
-          # dbVals = SortedSet.new
-          # domainVals.each do |dv|
-          emit  "field values: #{$fieldVals}"
-          unless $fieldVals.nil? || $fieldVals.empty?
-              values = $fieldVals
-              f_i    = values.index from
-              t_i    = values.index to
-              emit  "      from: #{f_i} :: '#{from}'"
-              emit  "        to: #{t_i} :: '#{to}'"
-              badRange = f_i.nil? || t_i.nil?
-              emit "badRange: #{badRange}"
-              if badRange
-                emit  "BAD RANGE"
-              else
-                tnames  = values[f_i..t_i]
-                tnames.each do |tname|
-                  results[tname] = dataSource.deAlias(field,tname) # $TableNameAliases[tname]
-                end
-                emit  " filtersInRange  f:%-35s  t:%-s " % ["'#{from}:#{f_i}'", "'#{to}:#{t_i}'"]
-                emit  "         names:  #{results.keys}"
-                emit  "       aliases:  #{results.values}"
-              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]
           end
+        end
       end
-      return results
-    end
-
-    def loadDomains
-      emit  "def loadDomains\n=="
-      loader            = Twb::Util::FieldDomainLoader.new
-      @twbFielddomains  = loader.loadWorkbook @twb
-      emit  "FIELD DOMAINS:: #{@twbFielddomains}\n=="
-      @twbDomainsLoaded = true
     end
 
-end # class 
+end # class SheetFiltersAnalyzerA
 
 end # module Twb
 end # module Analysis