twb 1.0.5 → 1.9.1

data/lib/twb/util/ftpPublisher.rb

@@ -0,0 +1,48 @@
+#  Copyright (C) 2014, 2017  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/>.
+
+module Twb
+module Util
+
+require 'net/ftp'
+
+  class FTPPublisher
+
+    attr_reader :fileName, :fileURL
+
+    def initialize
+      @ftp      = Net::FTP.new('gerrard.net')
+      @ftp.login("tableautools", 'TableauT00ls!')
+    end
+
+    def publish fileName
+      @fileName = fileName
+      @ftp.passive = true
+      @ftp.puttextfile(fileName, fileName)
+      @fileURL = "http://gerrard.net/tableautools/#{fileName}"
+    end
+
+    def list
+      @ftp.list()
+    end
+
+    def close
+      @ftp.close unless @ftp.nil?
+    end
+
+  end
+
+end  # module Util
+end  # module Twb

data/lib/twb/util/joinUtilities.rb

@@ -0,0 +1,52 @@
+#  Copyright (C) 2012, 2015  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/>.
+
+module Twb
+module Util
+
+  class JoinTable
+    attr_reader :table, :datasource
+    def initialize(table, datasource=nil)
+      @table = table
+      @datasource = datasource
+    end
+  end # class JoinTable
+
+
+  class JoinTablePair
+    attr_reader :from, :to
+    def initialize(from, to)
+      raise ParamaterException.new("'From' cannot be nil.") if from.nil?
+      raise ParamaterException.new("'To' cannot be nil.")   if to.nil?
+      @from = from
+      @to   = to
+    end
+  end # class JoinTablePair
+
+  class JoinTree
+    attr_reader  :root, :maxdepth
+    def initialize
+      @root = nil
+      @maxdepth = 0
+    end
+    def add from, to
+      puts "abc"
+    end
+    
+  end # class JoinTree
+
+
+end  # module Util
+end  # module Twb

data/lib/twb/workbook.rb

@@ -25,11 +25,12 @@ module Twb
   class Workbook
 
     attr_reader :workbooknode 
-    attr_reader :name,        :dir         
-    attr_reader :modtime,     :version,         :build
-    attr_reader :datasources, :datasourceNames, :datasourceUINames
-    attr_reader :dashboards,  :storyboards,     :worksheets,       :actions
-    attr_reader :valid,       :ndoc
+    attr_reader :name,            :dir         
+    attr_reader :modtime,         :version,           :build
+    attr_reader :datasources,     :datasource 
+    attr_reader :datasourceNames, :datasourceUINames, :dataSourceNamesMap
+    attr_reader :dashboards,      :storyboards,       :worksheets,         :actions
+    attr_reader :valid,           :ndoc
 
     ##
     # Creates a Workbook from its file name.
@@ -39,6 +40,9 @@ module Twb
     #   The Workbook's file name, the Workbook can be a TWB or TWBX file.
     #
     def initialize twbWithDir
+      raise ArgumentError.new("ERROR in Workbok creation: '#{twbWithDir}' must be a String, is a #{twbWithDir.class} \n ")        unless twbWithDir.is_a? String
+      raise ArgumentError.new("ERROR in Workbok creation: '#{twbWithDir}' must have an extension of .twb or .twbx \n ") unless twbWithDir.upcase.end_with?(".TWB", ".TWBX")
+      raise ArgumentError.new("ERROR in Workbok creation: '#{twbWithDir}' cannot be found, must be a Tableau Workbook file. \n ") unless File.file?(twbWithDir)
       @valid = false
       if File.file?(twbWithDir) then
         @name    = File.basename(twbWithDir)
@@ -66,8 +70,7 @@ module Twb
 
     def processDoc
       @workbooknode  = @ndoc.at_xpath('//workbook')
-      @version = @ndoc.xpath('/workbook/@version')
-      @build   = @ndoc.xpath('/workbook/comment()').text.gsub(/^[^0-9]+/,'').strip
+      @version = @ndoc.xpath('/workbook/@version').first.text
       loaddatasources
       loadWorksheets
       loadDashboards
@@ -77,17 +80,31 @@ module Twb
       @valid = true
     end
 
+    def build
+      @build ||= loadBuild
+    end
+
+    def loadBuild
+      # - earlier Version, need to confirm when source-build began 
+      #   @build   = @ndoc.xpath('/workbook/comment()').text.gsub(/^[^0-9]+/,'').strip
+      @build = if !@ndoc.xpath('/workbook/@source-build').nil?
+                   @ndoc.xpath('/workbook/@source-build').first.text
+               else 
+                   @ndoc.xpath('/workbook/comment()').text.gsub(/^[^0-9]+/,'').strip
+               end
+    end
+
     def loaddatasources
       # puts "LOAD DATA SOURCES"
       # @dataSourcesNode = @ndoc.at_xpath('//workbook/datasources')
       @datasources        = Set.new
-      @datasourceNames    = Set.new
-      @datasourceUINames  = Set.new
+      @datasourceNames    = SortedSet.new
+      @datasourceUINames  = SortedSet.new
       @dataSourceNamesMap = {}
       datasourceNodes     = @ndoc.xpath('//workbook/datasources/datasource')
       # puts "DATASOURCENODES : #{@datasourceNodes.length}"
       datasourceNodes.each do |node|
-        datasource = Twb::DataSource.new(node)
+        datasource = Twb::DataSource.new(node,self)
         @datasources << datasource
         @datasourceNames    << datasource.name
         @datasourceNames    << datasource.uiname

data/lib/twb/worksheet.rb

@@ -1,4 +1,4 @@
-#  Copyright (C) 2014, 2015  Chris Gerrard
+#  Copyright (C) 2014, 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
@@ -18,22 +18,13 @@ require 'digest/md5'
 
 module Twb
 
-  class WorksheetDataSource
-    attr_reader :node, :name, :caption, :uiname
-    def initialize node
-      @node   = node
-      @caption = node.attr('caption')
-      @name    = node.attr('name')
-      @uiname  = if @caption.nil? || @caption == '' then @name else @caption end
-    end
-  end
-
   class Worksheet
 
     @@hasher = Digest::SHA256.new
 
     attr_reader :node,   :name,      :datasourcenames, :datasources
-    attr_reader :fields, :rowFields, :colFields,       :datasourceFields
+    attr_reader :panesCount
+    attr_reader :fields, :rowFields, :colFields, :paneFields, :datasourceFields
 
     def initialize sheetNode
       @node    = sheetNode
@@ -61,33 +52,34 @@ module Twb
     end
 
     def datasourceFields
-      @datasourceFields.nil? ? loadFields : @datasourceFields
+      @datasourceFields ||= loadFields
     end
 
     def fields
-      @fields.nil? ? loadFields : @fields
+      @fields ||= loadFields
+      # @fields.nil? ? loadFields : @fields
     end
 
     def loadFields
       # puts "WORKSHEET loadFields"
+      @fields = {}
       @datasourceFields = {}
       dsNodes = @node.xpath('.//datasource-dependencies')
       dsNodes.each do |dsn|
-        dsName = dsn.attribute('datasource').text
-        dsfs = @datasourceFields[dsName] = []
+        dsName     = dsn.attribute('datasource').text
+        dsFields   = @datasourceFields[dsName] = Set.new
         fieldNodes = dsn.xpath('./column')
         fieldNodes.each do |fn|
-          fname = fn.attribute('name')
-          dsfs.push fname.text.gsub(/^\[/,'').gsub(/\]$/,'') unless fname.nil?
+          dsFields.add WorksheetField.new fn, dsName
         end
       end
+      @fields[:dsfields] = @datasourceFields
       # <rows>([DATA Connection (copy 2)].[none:JIRA HARVEST Correspondence  Name:nk] / [DATA Connection (copy 2)].[none:CreatedDate (Issue) (DAY):ok])</rows>
       # <cols>[DATA Connection (copy 2)].[:Measure Names]</cols>
-      @fields = {}
-      @rowFields = pullRowColFields './/rows' # returns map of data source => (Set of) field names
-      @fields[:rows] = @rowFields
-      @colFields = pullRowColFields './/cols' # returns map of data source => (Set of) field names
-      @fields[:cols] = @colFields
+      @rowFields     ||= loadRowColFields(:rows) # returns map of data source => (Set of) field names
+      @fields[:rows]   = @rowFields
+      @colFields     ||= loadRowColFields(:cols) # returns map of data source => (Set of) field names
+      @fields[:cols]   = @colFields
     end
 
     def addDSFields fields, usage
@@ -95,41 +87,142 @@ module Twb
       end
     end
 
-    def pullRowColFields xpath
-      dsFields   = {}                  # data source => (Set of) fields by names 
-      node       = @node.xpath(xpath)  # expect only one each of <rows> & <cols> node per <worksheet node
-      code       = node.text
-      # puts "\n CODE: '#{code}'"
-      return dsFields if code.nil?
-      codeFields = code.gsub(/^[(]|[)]$/,'').split(/] [\/+*] [(]?\[/)
-      return dsFields if codeFields.nil?  # - commented out, left here for logic clarity   
-      codeFields.each do |dsf|
-        parts = dsf.split('].[')
-        if parts.length == 2
-          ds = parts[0].gsub(/^\[|\]$/,'')
-
-          # remove prefix(es), if any 
-          f1 = parts[1].gsub(/^pcto:|^fVal:/,'').gsub(/^[a-z]+:/,'')          
-          #                  /^pcto:|^fVal:/  - special handling based upon actual codings
-
-          # remove terminating )s
-          f2 = f1.gsub(/[\)]+$/,'')                                           
-
-          # remove suffix(es), if any
-          f3 = f2.gsub(/:[0-9]+[\]]?$/,'').gsub(/:[a-z]+[\]]?$|[\]]?$/,'')    
-          #            /:[0-9]+[\]]?$/  - special handling based upon actual codings
-                                                                              
-          dsFields[ds] = Set.new unless dsFields.include? ds
-          dsFields[ds].add(f3)
-        end
+    def panesCount
+      @panesCount ||= @panesCount = node.xpath('.//panes/pane').length
+    end
+
+    def loadRowColFields(type)
+      fields = []
+      xpath = case type
+        when :rows then './/rows'
+        when :cols then './/cols'
+      end
+      return fields if xpath.nil?
+      node = @node.at_xpath(xpath)
+      RowsColsSplitter.new(node).fields.each do |fcode|
+        fields << CodedField.new(fcode)
       end
-      return dsFields
+      return fields
+    end
+
+    def paneFields
+      @paneFields ||= loadPaneFields
+    end
+
+    def loadPaneFields
+      @paneFields = Set.new
+      panes = @node.xpath('.//pane')
     end
 
     def datasourcenames
       @datasources.keys
     end
-
   end
 
-end
+  class WorksheetDataSource
+    # --
+    attr_reader :node, :name, :caption, :uiname
+    # --
+    def initialize node
+      @node   = node
+      @caption = node.attr('caption')
+      @name    = node.attr('name').gsub(/^\[/,'').gsub(/\]$/,'')
+      @uiname  = if @caption.nil? || @caption == '' then @name else @caption end
+    end
+  end # class WorksheetDataSource
+
+
+  class WorksheetField
+    # --
+    attr_reader :datasource, :name, :caption, :uiname, :node
+    # --
+    def initialize node, dsName
+      @node    = node
+      @name    = node.attr('name').gsub(/^\[/,'').gsub(/\]$/,'')
+      @caption = node.attr('caption').nil? ? nil : node.attr('caption').gsub(/^\[/,'').gsub(/\]$/,'') 
+      @uiname  = if @caption.nil? || @caption == '' then @name else @caption end
+      @datasource = dsName
+    end
+    # --
+    def to_s
+      "name:#{@name}|caption:#{@caption}|uiname:#{@uiname}||ds:#{datasource}"
+    end
+  end # WorksheetField
+
+
+  class RowsColsSplitter
+    include Comparable
+    attr_reader :fields
+    def initialize node
+      @fields = []
+      return fields if node.nil?
+      unless node.text.nil?
+        codes = node.text.split(/[\])] [\/+*] [(]?\[/)
+        codes.each {|c| @fields << c.gsub(/^[(]*[\[]*|[)\]]*$/,'')}
+      end
+    end
+  end # class RowsColsSplitter
+
+
+
+  class CodedField
+
+    include Comparable
+
+    attr_reader :code, :dataSource, :prefix, :name, :suffix
+
+    def initialize incode
+      # puts "CF: #{incode}"
+      @code       = incode
+      trimCode    = code.gsub(/^\[/,'').gsub(/\]$/,'')
+      # puts "  : '#{trimCode}'"
+      @dataSource = nil
+      dsFldBits = trimCode.split('].[')
+      if dsFldBits.length == 2
+        @dataSource = dsFldBits[0]
+        fieldCode   = dsFldBits[1]
+      else
+        fieldCode   = dsFldBits[0]
+      end
+      # puts "fc: #{fieldCode}"
+      parts = fieldCode.split(':')
+      bits = 
+      if ':Measure Names'.eql?(fieldCode)
+          {:prefix => nil, :name => fieldCode, :suffix => nil }
+      else 
+          case parts.length
+          when 1
+              bits = {:prefix => nil, :name => parts[0], :suffix => nil}
+          when 3
+              bits = {:prefix => parts[0], :name => parts[1], :suffix => parts[2]}
+          when 4
+              if parts[-1].match(/^(\d)+$/)
+                  bits = {:prefix => parts[0], :name => parts[1], :suffix => "#{parts[2]}:#{parts[3]}"}
+              else
+                  bits = {:prefix => "#{parts[0]}:#{parts[1]}", :name => parts[2], :suffix => parts[3]}
+              end
+          when 5
+              bits = {:prefix => "#{parts[0]}:#{parts[1]}", :name => parts[2], :suffix => "#{parts[3]}:#{parts[4]}"}
+          else
+              bits = {:prefix => "OOPS #{parts.inspect}", :name => '', :suffix => '' }
+          end
+      end
+      @prefix = bits[:prefix]
+      @name   = bits[:name]
+      @suffix = bits[:suffix]
+      # puts "       l: #{parts.length}   == #{bits}"
+      # bits.each { |k,v| puts "       l: %-7s %s" % [k,v] }
+    end
+    # --
+    def to_s
+      @code
+    end
+
+    def <=>(other)
+      @code <=> other.code
+    end
+
+  end #class CodedField
+
+
+end # module Twb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.9.1
 platform: ruby
 authors:
 - Chris Gerrard
@@ -24,9 +24,13 @@ files:
 - lib/twb.rb
 - lib/twb/TwbTest.rb
 - lib/twb/action.rb
-- lib/twb/analysis/calculatedfieldsanalyzer.rb
-- lib/twb/apps/X-Ray Dashboards.rb
-- lib/twb/countNodes.rb
+- lib/twb/analysis/CalculatedFields/CSVEmitter.rb
+- lib/twb/analysis/CalculatedFields/CalculatedFieldsAnalyzer.rb
+- lib/twb/analysis/CalculatedFields/MarkdownEmitter.rb
+- lib/twb/analysis/DataSources/DataSourceTableFieldsCSVEmitter.rb
+- lib/twb/analysis/Sheets/WorksheetDataStructureCSVEmitter.rb
+- lib/twb/calculatedfield.rb
+- lib/twb/columnfield.rb
 - lib/twb/dashboard.rb
 - lib/twb/dashboard.txt
 - lib/twb/datasource.rb
@@ -47,11 +51,13 @@ files:
 - lib/twb/storyboard.rb
 - lib/twb/there.rb
 - lib/twb/util/dotFileRenderer.rb
+- lib/twb/util/ftpPublisher.rb
 - lib/twb/util/graphedge.rb
 - lib/twb/util/graphedges.rb
 - lib/twb/util/graphnode.rb
 - lib/twb/util/hashtohtml.rb
 - lib/twb/util/htmllistcollapsible.rb
+- lib/twb/util/joinUtilities.rb
 - lib/twb/util/twbDashSheetDataDotBuilder.rb
 - lib/twb/util/twbDashSheetDataDotRenderer.rb
 - lib/twb/util/twbDashesSheetDataDotBuilder.rb
@@ -90,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Classes for accessing Tableau Workbooks and their contents.