twb 2.2.1 → 3.7.2

data/lib/twb/localfield.rb

@@ -19,7 +19,7 @@ module Twb
 
   # Assumption: A field can only be either a MetadataField or a LocalField, not both in a given Workbook data connection.
 
-  class LocalField
+  class LocalField < TabClass
 
     attr_reader :node, :type, :datatype, :name, :uiname, :hidden, :ordinal, :properties
 
@@ -44,6 +44,10 @@ module Twb
       # return self
     end
 
+    def id
+        @id ||= @id = @name.hash
+    end
+
     def properties
       @properties ||= loadProperties
     end

data/lib/twb/mappedfield.rb

@@ -17,7 +17,7 @@ require 'nokogiri'
 
 module Twb
 
-  class DbField
+  class DbField < TabClass
 
     include Comparable
 
@@ -37,6 +37,10 @@ module Twb
       @id      = "#{dataSource}::#{dbname}::#{dbtable}::#{uiname}"
     end
 
+    def id
+        @id ||= @id = @name.hash
+    end
+
     def properties
       @properties ||= loadProperties
     end

data/lib/twb/metadatafield.rb

@@ -17,7 +17,7 @@ require 'nokogiri'
 
 module Twb
 
-  class MetadataField
+  class MetadataField < TabClass
 
     include Comparable
 
@@ -78,6 +78,10 @@ module Twb
       @id                = "'%s::%s' " % [@table,@remoteName]   
     end
 
+    def id
+        @id ||= @id = @name.hash
+    end
+
     def properties
       @properties ||= loadProperties
     end

data/lib/twb/storyboard.rb

@@ -18,7 +18,7 @@ require 'digest/md5'
 
 module Twb
 
-  class Storyboard
+  class Storyboard < TabClass
 
     @@hasher = Digest::SHA256.new
 
@@ -31,6 +31,10 @@ module Twb
       loadSheets
     end
 
+    def id
+        @id ||= @id = @name.hash
+    end
+
     def loadSheets
       @sheets = {}
       sheets = @node.xpath('.//story-point').to_a

data/lib/twb/tabclass.rb

@@ -0,0 +1,71 @@
+#  Copyright (C) 2014, 2015, 2016  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 'logger'
+
+module Twb
+
+    class TabClass
+
+        attr_accessor :uuid, :type, :id, :properties, :ttlogfile, :ttlogfilename
+
+        @@ttlogfilename = 'TableauTools.ttlog'
+        @@ttdocdir      = './ttdoc'
+        @localEmit      = false
+
+        def initialize
+            @ttlogfile    = 'TableauTools.ttlog'
+            @logger       = Logger.new(@ttlogfile)
+            @logger.level = Logger::DEBUG
+        end
+
+        def type
+            @type ||= @type = self.class.to_s.split(/(?=[A-Z])/).join(' ')
+        end
+
+        def uuid
+            @uuid ||= @uuid = SecureRandom.uuid
+        end
+
+        def properties
+            {}
+        end
+
+        def setDocFileName
+            docFile @@ttlogfilename
+        end
+
+        def docFile name
+          @ttdocdir.nil? ? name : "#{@@ttdocdir}/#{name}"
+        end
+
+        def emit(local=@localEmit, stuff)
+            # puts "\nstuff.class #{stuff.class}  :: #{stuff}" if local
+            if stuff.is_a? String then
+              lines = stuff.split(/\n/)
+              lines.each do |line|
+                @logger.debug "#{@emitPrefix}#{line}"
+                         puts "#{@emitPrefix}#{line}" if local
+              end
+            else
+                @logger.debug "#{@emitPrefix}#{stuff}"
+                         puts "#{@emitPrefix}#{stuff}" if local
+            end
+        end
+
+    end
+
+end
+

data/lib/twb/tabtest.rb

@@ -0,0 +1,31 @@
+#  Copyright (C) 2014, 2015, 2016  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 'tabtool'
+
+module Twb
+
+    class TabToolTest
+        include TabTool
+
+        def initialize
+            @ttlogfile    = 'TableauTools.ttlog'
+            @logger       = Logger.new(@ttlogfile)
+            @logger.level = Logger::DEBUG
+        end
+
+    end # class TabToolTest  
+
+end # module Twb

data/lib/twb/tabtool.rb

@@ -0,0 +1,63 @@
+#  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
+#  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 'logger'
+
+module TabTool
+
+  attr_accessor :ttdocdir, :logger,  :loglevel, :logfilename
+  attr_reader   :funcdoc,  :docfiles
+
+  TTDOCDIR = './ttdoc'
+
+  @funcdoc     = {:class=>nil, :blurb=>nil, :description=>nil,}
+  @docfiles    = {}
+
+  @ttdocdir    = './ttdoc'
+  @logfilename = 'TabTools.ttlog'
+  @loglevel    = Logger::DEBUG
+  @localEmit   = false
+
+  def funcdoc
+    @funcdoc.nil? ? {:class=>'n/a', :blurb=>'generic TabTool blurb', :description=>'A useful Tableau Tool.'} : @funcdoc
+  end
+
+  def docFile name
+    # emit "docFile:  TTDOCDIR: #{TTDOCDIR}  name:'#{name}'"
+    TTDOCDIR.nil? ? name : "#{TTDOCDIR}/#{name}"
+  end
+
+  def emit(local=@localEmit, stuff)
+      initLogger if @logger.nil?
+      if stuff.is_a? String then
+        lines = stuff.split(/\n/)
+        lines.each do |line|
+          @logger.debug "#{@emitPrefix}#{line}"
+                   puts "#{@emitPrefix}#{line}" if local
+        end
+      else
+          @logger.debug "#{@emitPrefix}#{stuff}"
+                   puts "#{@emitPrefix}#{stuff}" if local
+      end
+  end
+
+  def initLogger
+    lfn = docFile("#{self.class.to_s.split('::').last}.ttlog")
+    @logger       = Logger.new(lfn)
+    @logger.level = Logger::DEBUG
+  end
+
+end # module TabTool
+

data/lib/twb/twbcodedfield.rb

@@ -0,0 +1,87 @@
+  class CodedField
+
+    include Comparable
+
+    attr_reader :name,       :techCode     
+    attr_reader :uiname,     :uiCode 
+    attr_reader :dataSource, :dataSourceName, :dataSourceRef, :dataSourceExists
+    attr_reader :fqName,     :type
+    attr_reader :techUIdiff
+
+    def initialize code, datasource
+      # puts "\n\nCalculationField ::  %-25s  |  %s  " % [datasource.uiname, code]
+      @dataSource       = datasource
+      @dataSourceName   = datasource.uiname
+      @dataSourceRef    = :local
+      @dataSourceExists = true
+      @techUIdiff       = false
+      @uiname           = ''
+      rawCode  = code.gsub(/^\[|\]$/,'')
+      parts    = rawCode.split('].[')
+      #puts "Field: #{code}  \t parts: #{parts.length} - #{parts.inspect}"
+      if parts.length == 1
+        @name = parts[0]
+        @techCode = "[#{parts[0]}]"
+        #puts "@name: #{@name}"
+        if datasource.nil?
+          # puts 'a'
+          @uiname = @name
+          @uiCode = @techCode
+          @techUIdiff = false
+        else # !datasource.nil?
+          # puts 'b'
+          #puts "b - found uiname for '#{@name}'?: #{!datasource.fieldUIName(@name).nil?} \t is:#{datasource.fieldUIName(@name)} "
+          @uiname = datasource.fieldUIName(@name).nil? ? @name : datasource.fieldUIName(@name) 
+          @uiCode = @uiname.nil? ? @techCode :  "[#{@uiname}]"
+          @techUIdiff = !@techCode.eql?(@uiCode)
+          # puts ":b #{datasource.fieldUIName(@name).nil?}  ... #{@name}  ... #{@uiname}"
+          # puts "CalculationField ::       uin: %-25s | @name:%-s" % [@uiname,@name]
+        end
+      else # parts.length <> 1
+        # puts 'c'
+        rdstech   = parts[0]
+        calcField = parts[1]
+        @uiname   = calcField
+        @dataSourceName = rdstech
+        @dataSourceRef  = :remote
+        @techCode = "[#{rdstech}].[#{calcField}]"
+        workbook  = datasource.workbook
+        @dataSource  = workbook.nil? ? nil : workbook.datasource(rdstech)
+       # puts "\t  twb: #{workbook.class}  /  remoteds: #{remoteds.class}  : #{remoteds.nil? ? "<<NOT FOUND:#{rdstech}:>>" : remoteds.uiname} "
+        #--
+        if @dataSource.nil? || @dataSource.fieldUIName(calcField).nil?
+          # puts 'd'
+          @uiname     = calcField
+          @uiCode     = "[<<NOT FOUND>>#{rdstech}].[#{calcField}]"
+          @techUIdiff = true
+          @dataSourceExists = false
+        else  # !remoteds.nil?
+          # puts 'e'
+          @dataSourceName = @dataSource.uiname
+          @uiname         = @dataSource.fieldUIName(calcField)
+          @uiCode         = "[#{@dataSourceName}].[#{@uiname}]"
+          @techUIdiff     = !@techCode.eql?(@uiCode)
+          @dataSourceExists = true
+        end
+      end
+      # puts "\t     dsName: #{@dataSourceName}"
+      # puts "\t   @name: #{@name}"
+      # puts "\t     uiname: #{@uiname}"
+      @fqName = "#{@dataSourceName}::#{@uiname}"
+      @type   = @dataSource.calculatedField(@uiname).nil? ? :DatabaseField : :CalculatedField
+    end # initialize
+
+    def id
+      @id ||= @id = "#{@dataSourceName}::#{@uiname}"
+    end
+
+    def <=>(other)
+      # myName    = @uiname.nil? ? '' : @uiname
+      # otherName = other.uiName.nil? ? "" : other.uiName
+      # # puts "#{@uiname} / #{myName} <=>  #{otherName} / #{other.uiName}"
+      # # puts "#{@uiname.nil?} // #{other.uiName.nil?}"
+      # myName <=> otherName
+      @fqName <=> other.fqName
+    end
+
+  end # class CalculationField

data/lib/twb/util/cypher.rb

@@ -0,0 +1,112 @@
+#  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/>.
+
+require 'csv'
+
+module Twb
+module Util
+
+  class Cypher
+
+    include TabTool
+
+    @@hasher = Digest::SHA256.new
+
+#====================================================================
+
+    attr_accessor :nodes, :edges, :fileName, :fileName
+    attr_accessor :cleanup
+
+    def initialize
+      emit "Cypher.initialize"
+      @fileName  = 'Neo4jCommands'
+      @nodes     = []
+      @edges     = []
+      @cleanup   = false
+    end
+
+    def render
+      @file = File.open(docFile("#{@fileName}.cypher"),'w')
+      renderNodes
+      renderEdges
+      @file.close
+      return @file
+    end
+
+    def renderNodes
+      csv = CSV.open(docFile("#{@fileName}.nodes.csv"),'w')
+      csv << ['Type','Name','UUID']
+      nodesCSV = Set.new
+      nodeCmds = SortedSet.new
+      nodesByType = Hash.new { |type,nodes| type[nodes] = [] }
+      @nodes.each do |node|
+        nodesCSV << [node.type, node.name, node.uuid]
+        nodeCmds << encode('MERGE','node',node,';')
+        nodesByType[node.type] << node
+      end
+      if @cleanup
+        nodesByType.keys.each do |type|
+          @file.puts "DROP   CONSTRAINT ON (node:#{type}) ASSERT node.uuid IS UNIQUE ;"
+        end
+        @file.puts "MATCH (n) DETACH DELETE n ;"
+        nodesByType.keys.each do |type|
+          @file.puts "CREATE CONSTRAINT ON (node:#{type}) ASSERT node.uuid IS UNIQUE ;"
+        end
+        @file.puts "//--"
+      end
+      nodesCSV.each do |rec|
+        csv << rec
+      end
+      nodeCmds.each do |cmd|
+        @file.puts cmd
+      end
+      csv.close
+    end
+    # USING PERIODIC COMMIT
+    # LOAD CSV WITH HEADERS FROM "file:://C:/tech/Tableau/Tableau Tools/Ruby/experiments/GraphElements.nodes.csv" AS row
+    # CREATE (:row.Type {name: row.Name, uuid: row.UUID});
+
+    def renderEdges
+      csv = CSV.open("./ttdoc/#{@fileName}.edges.csv",'w')
+      csv << ['Source Type' , 'Source Name'  , 'Source UUID'  , 'Relationship', 'Target Type', 'Target Name', 'Target UUID' ]
+      @edges.each do |edge|
+        relationship = edge.relationship.upcase.gsub(/[ ]+/,'_')
+        csv << [edge.from.type,  edge.from.name,  edge.from.uuid,  relationship ,  edge.to.type , edge.to.name,  edge.to.uuid ]
+        @file.puts ' '
+        @file.puts encodeEdge('MATCH', 'source', edge.from)
+        @file.puts encodeEdge('MATCH', 'target', edge.to)
+        @file.puts "%-8s (source)-[r:%s]->(target) " % ['MERGE', edge.relationship.upcase.gsub(/[ ]+/,'_')]
+        @file.puts "RETURN source.name, type(r), target.name ;"
+      end
+      csv.close
+    end
+
+    def encode command, varName, node, terminator=''
+      "%-8s (%s:%s { name:'%s', uuid: '%s' } ) %s" % [command, varName, node.type, node.name, node.uuid, terminator ]
+    end
+
+    def encodeEdge command, varName, node, terminator=''
+      "%-8s (%s:%s { uuid: '%s' } ) %s" % [command, varName, node.type, node.uuid, terminator ]
+    end
+
+    def to_s
+      "file:#{@fileName}; #nodes:#{@nodes.length}; #edges:#{@edges.length}"
+    end
+
+
+  end
+
+end  # module Util
+end  # module Twb