twb 3.7.5 → 3.9.3

data/lib/twb/calculatedfield.rb

@@ -21,10 +21,11 @@ module Twb
   class CalculatedField < TabClass
 
     attr_reader :dataSource
-    attr_reader :node,     :properties
-    attr_reader :caption,  :name, :uiname
-    attr_reader :datatype, :role, :propType  
-    attr_reader :calculation, :calcFields
+    attr_reader :node,        :properties
+    attr_reader :caption,     :name,       :uiname
+    attr_reader :datatype,    :role,       :propType  
+    attr_reader :calculation, :calcFields 
+    attr_reader :isGroup,     :groupMembers
     attr_reader :hidden
 
     def initialize(calcNode, datasource=nil)
@@ -42,6 +43,7 @@ module Twb
         @calculation = Twb::FieldCalculation.new(self, datasource)
         # -- 
         @hidden      = true if calcNode.has_attribute?('caption')
+        @isGroup     = !@node.at_xpath('./calculation[@class="categorical-bin"]').nil?
     end
 
     def properties
@@ -64,6 +66,22 @@ module Twb
         @calculation.formulaResolved
     end
 
+    def groupMembers
+        @groupMembers ||= loadgroupmembers
+    end
+
+    def binValues binName
+        values   = []
+        binValue = "\"#{binName}\""
+        binNode = @node.at_xpath("./calculation[@class='categorical-bin']/bin[@value='#{binValue}']")
+        unless binNode.nil?
+            binNode.xpath('.//value').each do |v|
+                values << v.text.gsub(/^['"]|['"]$/,'')
+            end
+        end
+        return values
+    end
+
     def loadProperties
       @properties= {}
       @node.attributes.each do |name,attr|
@@ -91,5 +109,25 @@ module Twb
         "%s(%s) => %s" % [uiname, name, @calculation.formulaFlat]
     end
 
+    private
+
+    def loadgroupmembers
+        @groupMembers = Hash.new { |h,k| h[k] = [] } 
+        if @isGroup
+            groupLeads =  @node.xpath('./calculation[@class="categorical-bin"]//bin')
+            groupLeads.each do |gl|
+                lead = gl['value']
+                groupAlias = @node.at_xpath("./aliases/alias[@key='#{lead}']")
+                groupNamex = groupAlias.nil? ? lead : groupAlias['value']
+                groupName  = groupNamex.gsub(/^['"]|['"]$/,'')
+                values = gl.xpath('./value')
+                values.each do |v|
+                    @groupMembers[groupName] << v.text.gsub(/^['"]|['"]$/,'').gsub('\"','"')
+                end
+            end
+        end
+        return @groupMembers
+    end
+
   end # class
 end # module

data/lib/twb/codedfield.rb

@@ -24,12 +24,13 @@ module Twb
     include Comparable
 
     attr_reader :dataSource
-    attr_reader :name, :techCode, :rawCode 
+    attr_reader :name, :techCode, :function, :rawCode 
 
     def initialize code
      #puts "\n\nCodedField ::  #{code}"
       @rawCode = code
-      trimmed  = code.gsub(/^"|"$/,'').gsub(/^\[|\]$/,'')
+      trimmed  = code.gsub(/^['"]|['"]$/,'').gsub(/^\[|\]$/,'')
+      # puts "trimmed: #{trimmed}"
       parts    = trimmed.split('].[')
      #puts "Field: #{code}  parts: #{parts.length} - #{parts.inspect}"
      #puts "   p1: #{parts[0]}"
@@ -38,12 +39,12 @@ module Twb
        #puts '==1'
         @name = parts[0]
         @techCode = "[#{@name}]"
-      else # parts.length <> 1
+      elsif # parts.length <> 1
        #puts '<>1'
        #puts "p[0]: #{parts[0]}"
        #puts "p[1]: #{parts[1]}"
-        @dataSource = parts[0]
-        fldName     = parts[1]
+        @dataSource  = parts[0]
+        fldName = parts[1]
         if fldName.start_with?(':') && fldName.count(':') == 1
           @name = fldName
         else
@@ -56,21 +57,21 @@ module Twb
     def parseField str
       # puts "parseField: #{str}"
       parts = str.split(':')
-      # puts "parseField: #{str}"
-      # puts "    parts : #{parts}"
-      # puts "    partsl: #{parts.length}"
-      # puts "      p[0]: #{parts[0]}"
-      # puts "      p[1]: #{parts[1]}"
       case parts.length
       when 1
-        @name = parts[0]
+        @name     = parts[0]
       else
-        @name = parts[1]
+        @name     = parts[-2]
+        @function = parts[0]
       end
     end
 
     def id
-      @id ||= @id = "#{@dataSourceName}::#{@uiname}"
+      @id ||= @id = "#{@dataSource}::#{@uiname}"
+    end
+
+    def to_s
+      "ds:#{dataSource}|n:#{name}|tc:#{techCode}"
     end
 
     def <=>(other)

data/lib/twb/datasource.rb

@@ -432,6 +432,10 @@ module Twb
       dbFieldsMap.has_key? fieldName
     end
 
+    def field fieldName
+      dbFieldsMap[fieldName]
+    end
+
     def fieldTable fieldName
       loadTableFields if @tableFieldsMap.nil?
       dbField = @tableFieldsMap[fieldName]

data/lib/twb/tabtool.rb

@@ -17,29 +17,63 @@ require 'logger'
 
 module TabTool
 
-  attr_accessor :ttdocdir, :logger,   :loglevel, :logfilename
-  attr_reader   :funcdoc,  :docfiles, :metrics 
+  @@licensed = false
+
+  TTDOCDIR   = './ttdoc'
 
-  TTDOCDIR = './ttdoc'
+  attr_accessor :ttdocdir, :logger,   :loglevel, :logfilename
+  attr_reader   :licensed, :funcdoc,  :docfiles, :metrics,    :alerts 
 
   @funcdoc     = {:class=>nil, :blurb=>nil, :description=>nil,}
   @docfiles    = []  # should be of form [{:name=>'docFileName',:description=>'doc file description'}]
 
-  @ttdocdir    = './ttdoc'
-  @logfilename = 'TabTools.ttlog'
-  @loglevel    = Logger::DEBUG
-  @localEmit   = false
-  @docDirSet   = false
+  # @logfilename = 'TabTools.ttlog'
+  @@loglevel    = Logger::INFO
+  # @localEmit   = false
+  # @docDirSet   = false
 
-  def funcdoc
-    @funcdoc.nil? ? {:class=>'n/a', :blurb=>'generic TabTool blurb', :description=>'A useful Tableau Tool.'} : @funcdoc
+  def init
+    @alerts = []
+    initDocDir
+    # initLogger
+  end
+
+  def initDocDir
+    # return if TTDOCDIR.nil?
+    # return if ''.eql?($ttdocdir) && ''.eql?(TTDOCDIR)
+    @docDir = TTDOCDIR
+    return if Dir.exists?(@docDir)
+    if File.exists? @docDir
+      @docDir = ''
+    else
+      Dir.mkdir @docDir
+    end
+    return @docDir
+  end
+
+  def initLogger
+    logFileName   = docFile("#{self.class.to_s.split('::').last}.ttlog")
+    @logger       = Logger.new(logFileName, 2, 100*1024)
+    @logger.level = Logger::INFO
+    return @logger
   end
 
   def docFile name
-    initDocDir unless @docDirSet
     @docDir.nil? ? name : "#{@docDir}/#{name}"
   end
 
+  def license= fileName
+    @@licensed = fileName.is_a?(String) && File.exist?(fileName)
+  end
+
+  def licensed?
+    @@licensed
+  end
+
+  def funcdoc
+    @funcdoc.nil? ? {:class=>'n/a', :blurb=>'generic TabTool blurb', :description=>'A useful Tableau Tool.'} : @funcdoc
+  end
+
   def docfiles
     @docfiles ||= @docfiles = []
   end
@@ -66,16 +100,18 @@ module TabTool
         lines << "    - %-#{nameLen}s    %-s " % [ dfi[:name], dfi[:description] ]
       end
     end
-    docLines = lines.empty? ? [] : [' ','For documentation and generated data see the following:',' ']
+    docLines = lines.empty? ? [] : [' ',' For documentation and generated data see the following:',' ']
     lines.each do |l|
       docLines << l
     end
     return docLines
   end
 
+  # def metrics
+  #   {}
+  # end
+
   def initCSV(fileName, desc=nil, header=nil)
-    # puts 'initCSV'
-    # puts "  @docDirSet: #{@docDirSet}    "
     csvName =  docFile(fileName)
     emit "init CSV #{csvName}"
     csvFile = CSV.open(csvName, 'w')
@@ -85,48 +121,28 @@ module TabTool
   end
 
   def emit(local=@localEmit, stuff)
-      initDocDir if @docDirSet.nil? || !@docDirSet
-      initLogger if @logger.nil?
+      # if @logger.closed? 
+      #   @logger.reopen 
+      # end
       if stuff.is_a? String then
         lines = stuff.split(/\n/)
         lines.each do |line|
-          @logger.debug "#{@emitPrefix}#{line}"
+          @logger.debug "#{@emitPrefix}#{line}" unless @logger.nil?
                    puts "#{@emitPrefix}#{line}" if local
         end
       else
-          @logger.debug "#{@emitPrefix}#{stuff}"
+          @logger.debug "#{@emitPrefix}#{stuff}" unless @logger.nil?
                    puts "#{@emitPrefix}#{stuff}" if local
       end
   end
 
-  def initLogger
-    initDocDir unless @docDirSet
-    initDocDir
-    logFileName   = docFile("#{self.class.to_s.split('::').last}.ttlog")
-    @logger       = Logger.new(logFileName)
-    @logger.level = Logger::DEBUG
+  def alert str
+    @alerts << str
+    emit "#{self.class} :: #{str}"
   end
 
-  def initDocDir
-    # puts 'initDocDir - begin'
-    # puts "  @docDirSet: #{@docDirSet}    "
-    # puts "  TTDOCDIR  : #{TTDOCDIR}    "
-    # puts "  $ttdocdir : #{$ttdocdir}    "
-    # puts "  @docDir   : #{@docDir}    "
-    return if @docDirSet
-    return if TTDOCDIR.nil?      && $ttdocdir.nil?
-    return if ''.eql?($ttdocdir) && ''.eql?(TTDOCDIR)
-    @docDir = $ttdocdir.nil? ? TTDOCDIR : $ttdocdir
-    return if Dir.exists?(@docDir)
-    if File.exists? @docDir
-        @docDir = nil
-        return
-    end
-    Dir.mkdir @docDir
-    @docDirSet = true
-    # puts "  @docDirSet: #{@docDirSet}    "
-    # puts "  @docDir   : #{@docDir}    "
-    # puts 'initDocDir - end'
+  def finis
+    # @logger.close unless @logger.nil? || @logger.closed?
   end
 
 

data/lib/twb/util/fielddomainloader.rb

@@ -20,6 +20,7 @@ require 'creek'
 require 'csv'
 
   class FieldDomainLoader
+    include TabTool
 
     @@xmlLocation = './ttdoc'
 
@@ -27,6 +28,7 @@ require 'csv'
     attr_accessor :xmllocation, :workboook, :datasource, :csvOption
 
     def initialize
+      init
       reset
     end
 
@@ -82,7 +84,7 @@ require 'csv'
               end
           end
         else
-          puts "#### ALERT #### XLSX file does not exist: #{fileName}"
+          alert  "#### ALERT #### Twb:'#{@workbook}' DS: '#{@datasource}' DomRef: #{fileName}' file does not exist."
         end
         return fieldDomains
     end

data/lib/twb/worksheet.rb

@@ -25,6 +25,7 @@ module Twb
     attr_reader :node,   :name,      :datasourcenames, :datasources
     attr_reader :panesCount
     attr_reader :fields, :rowFields, :colFields, :paneFields, :datasourceFields
+    attr_reader :hidden, :visible
 
     def initialize sheetNode
       @node    = sheetNode
@@ -64,6 +65,14 @@ module Twb
       # @fields.nil? ? loadFields : @fields
     end
 
+    def hidden
+      @hidden ||= resolveHidden
+    end
+
+    def visible
+      @visible ||= !hidden
+    end
+
     def loadFields
       # puts "WORKSHEET loadFields"
       @fields = {}
@@ -121,7 +130,13 @@ module Twb
     def datasourcenames
       @datasources.keys
     end
-  end
+
+    def resolveHidden
+      windowNode = node.at_xpath("//windows/window[@name='#{@name}']")
+      @hidden    = !windowNode.nil? && 'true' == windowNode['hidden']
+    end
+  
+  end # class Worksheet
 
   class WorksheetDataSource
     # --

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 3.7.5
+  version: 3.9.3
 platform: ruby
 authors:
 - Chris Gerrard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies: []
 description: A sollection of Ruby classes designed for accessing and recording information
   about, and for manipulating, Tableau Workbooks and their contents.
@@ -27,12 +27,15 @@ files:
 - lib/twb/analysis/CalculatedFields/CSVEmitter.rb
 - lib/twb/analysis/CalculatedFields/CalculatedFieldsAnalyzer.rb
 - lib/twb/analysis/CalculatedFields/MarkdownEmitter.rb
+- lib/twb/analysis/CalculatedFields/groupfieldsanalyzer.rb
 - lib/twb/analysis/DataSources/DataSourceFieldsCSVEmitter.rb
 - lib/twb/analysis/DataSources/DataSourceTableFieldsCSVEmitter.rb
 - lib/twb/analysis/DataSources/googlesheetdatasourcesanalyzer.rb
 - lib/twb/analysis/DocumentedFieldsCSVEmitter.rb
 - lib/twb/analysis/DocumentedFieldsMarkdownEmitter.rb
 - lib/twb/analysis/Sheets/WorksheetDataStructureCSVEmitter.rb
+- lib/twb/analysis/Sheets/analyzeDashboardSheets.rb
+- lib/twb/analysis/Sheets/dashsheetsanalyzer.rb
 - lib/twb/analysis/Sheets/sheetfieldsanalyzer.rb
 - lib/twb/analysis/Sheets/sheetfiltersanalyzer.rb
 - lib/twb/calculatedfield.rb