twb 0.0.24 → 0.0.25

data/README.txt

@@ -0,0 +1,12 @@
+A number of Ruby scripts that parse Workbooks and emit a variety of their contents/properties have been published at Tableau Friction, including a couple that identify Calculated fields and the fields they reference:
+http://tableaufriction.blogspot.ca/2015/02/more-calculated-field-analysis-fields.html
+http://tableaufriction.blogspot.ca/2014/09/do-you-know-what-your-calculated-fields.html
+
+Other scripts find and record other useful information, others yet enable Workbook management, e.g. unhiding worksheets and making field comments consistent across workbook. One of them produces HTML pages with dynamic dashboard wire frames, making it easy to see what's in the dashboards and their properties 
+
+There's also TWIS - the Tableau Workbook Inventory System, an app that extracts into CSV files most of the important Workbook elements, allowing one to see things such as which sheets are in which with dashboards, the data sources they connect to, and which Workbooks they're in. TWIS also generates diagrams/maps of the Workbook - Dashboard - Worksheet - Data Source relationships, one for each Workbook in PDF, PNG, and SVG.
+TWIS is described and available here: http://betterbi.biz/TWIS.html
+
+I created TWIS in Java and am working to re-implement its functionality in Ruby with the intention of releasing it as a open source project. The initial Ruby Gem - "twb" - is already available on http://rubygems.org - and can be downloaded and used via "gem install twb". At this point it only represents Workbooks and Data Sources, but I'll be extending it pretty regularly and posting updates to Tableau Friction. Anyone who's interested can comment here or there.
+
+The basic philosophy I'm following is that Tableau Workbook governance should be simple and straightforward in the way that basic data analysis is simple and straightforward in Tableau, and that the tools for it should be free, as in beer and speech, and constantly evolving to incorporate new and interesting things people can think of to see about do with their Workbooks.

data/lib/twb/dashboard.rb

@@ -0,0 +1,48 @@
+#  Copyright (C) 2014, 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 'nokogiri'
+require 'digest/md5'
+
+module Twb
+
+  class Dashboard
+
+    @@hasher = Digest::SHA256.new
+
+    attr_reader :node, :name, :sheets
+
+    def initialize dashboardNode
+      puts "Dashboard initialize"
+      @node    = dashboardNode
+      @name    = @node.attr('name').text
+      loadSheets
+      return self
+    end
+
+    def loadSheets
+      puts "$$$ in loadSheets"
+      @sheets = []
+      @ndoc.xpath('.//zone[@name]').to_a.each do |sheetNode|
+        sheet = Twb::Worksheet.new sheetNode
+        puts "### :: #{sheet.nil?} :: '#{sheet}'"
+        @dashboards.push sheet unless sheet.name == '' || sheet.name.nil?
+      end
+
+    end
+
+  end
+
+end

data/lib/twb/dashboard.txt

@@ -0,0 +1,57 @@
+#  Copyright (C) 2014, 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 'nokogiri'
+require 'digest/md5'
+
+module Twb
+
+  class Dashboard
+
+    @@hasher = Digest::SHA256.new
+
+    attr_reader :node, :name, :caption, :uiname, :connHash, :class, :connection
+
+    def initialize dataSourceNode
+      @node    = dataSourceNode
+      @name    = @node.xpath('./@name').text
+      @caption = @node.xpath('./@caption').text
+      @uiname  = if @caption.nil? || @caption == '' then @name else @caption end
+      processConnection
+      return self
+    end
+
+    def processConnection
+      @connHash    = ''
+      @connection  = @node.at_xpath('./connection')
+      if !@connection.nil? then
+        @class       = @connection.attribute('class').text
+        dsAttributes = @node.xpath('./connection/@*')
+        dsConnStr  = ''
+        dsAttributes.each do |attr|
+          dsConnStr += attr.text
+          # Note: '' attributes with value '' don't contribute to the hash
+        end
+        @connHash = Digest::MD5.hexdigest(dsConnStr)
+      end
+    end
+
+    def Parameters?
+      @name == 'Parameters'
+    end
+
+  end
+
+end

data/lib/twb/datasource.rb

@@ -29,12 +29,6 @@ module Twb
       @name    = @node.xpath('./@name').text
       @caption = @node.xpath('./@caption').text
       @uiname  = if @caption.nil? || @caption == '' then @name else @caption end
-      # puts "DS:        n:#{@name}"
-      # puts "     caption:#{@caption}"
-      # puts "      c.len :#{@caption.length}"
-      # puts "      c.nil?:#{@caption.nil?}"
-      # puts "      uiname:#{@uiname}"
-      # puts " "
       processConnection
       return self
     end
@@ -48,7 +42,7 @@ module Twb
         dsConnStr  = ''
         dsAttributes.each do |attr|
           dsConnStr += attr.text
-          # Note: only collects non-'' attribute values
+          # Note: '' attributes with value '' don't contribute to the hash
         end
         @connHash = Digest::MD5.hexdigest(dsConnStr)
       end

data/lib/twb/workbook.rb

@@ -19,7 +19,7 @@ module Twb
 
   class Workbook
 
-    attr_reader :name, :dir, :modtime, :version, :build, :ndoc
+    attr_reader :name, :dir, :modtime, :version, :build, :ndoc, :dataSources, :dashboards
 
     def initialize twbWithDir
       file     = File.new(twbWithDir)
@@ -29,9 +29,25 @@ module Twb
       @ndoc = Nokogiri::XML(open(twbWithDir))
       @version = @ndoc.xpath('/workbook/@version')
       @build   = @ndoc.xpath('/workbook/comment()').text.gsub(/^[^0-9]+/,'').strip
+      loadDataSources
       return self
     end
 
+    def loadDataSources
+      @dataSources = []
+      @dataSourceNodes = @ndoc.xpath('//workbook/datasources/datasource').to_a
+      @dataSourceNodes.each do |dsn|
+        @dataSources.push Twb::DataSource.new(dsn)
+      end
+    end
+
+    def loadDashboards
+      @dashboards = []
+      @ndoc.xpath('//workbook/dashboards/dashboard').to_a.each do |dshn|
+        @dashboards.push Twb::Dashboard.new(dshn)
+      end
+    end
+
     def dataSourceNodes
       @ndoc.xpath('//workbook/datasources/datasource').to_a
     end
@@ -44,6 +60,19 @@ module Twb
       return sources
     end
 
+    def dashboardNodes
+      @ndoc.xpath('//workbook/datasources/datasource').to_a
+    end
+
+    def dashboards
+      sources = []
+      dataSourceNodes.each do |dsn|
+        puts "adding dashboard"
+        sources.push Twb::Dashboard.new(dsn)
+      end
+      return sources
+    end
+
   end
 
 end

data/lib/twb/worksheet.rb

@@ -0,0 +1,36 @@
+#  Copyright (C) 2014, 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 'nokogiri'
+require 'digest/md5'
+
+module Twb
+
+  class Worksheet
+
+    @@hasher = Digest::SHA256.new
+
+    attr_reader :node, :name
+
+    def initialize sheetNode
+      puts "Worksheet initialize"
+      @node    = sheetNode
+      @name    = @node.attr('name').text
+      return self
+    end
+
+  end
+
+end

data/testTwbGem.rb

@@ -2,8 +2,9 @@
 
 require 'nokogiri'
 require 'open-uri'
-require 'twb'
 
+#require 'twb'
+require 'C:\tech\Tableau\tools\Ruby\gems\twb\lib\twb.rb'
 
 def processTWB twbWithDir
   twb     = Twb::Workbook.new twbWithDir
@@ -11,18 +12,12 @@ def processTWB twbWithDir
   doc =  twb.ndoc
   puts "  Data Sources"
   twb.dataSources.each do |ds|
-    puts "    - #{ds.name} :: c-#{ds.caption} :: uin-#{ds.uiname}  :: ch-#{ds.connHash} :: params?-#{ds.Paramaters?} "
+    puts "\n\t    n\t-#{ds.name}\n\t :: c\t-#{ds.caption}\n\t :: uin\t-#{ds.uiname} \n\t :: ch\t-#{ds.connHash}\n\t :: prms?\t-#{ds.Parameters?} "
+  end
+  puts "\n  Dashboards ...."
+  twb.dashboards.each do |dsh|
+    puts "\t    n\t-#{dsh.name} "
   end
-end
-
-def getConnectionHash dataSource
-    dsAttributes = dataSource.xpath('./connection/@*')
-    dsConnStr  = ''
-    dsAttributes.each do |attr|
-     dsConnStr += attr.text
-     # Note: only collects non-'' attribute values
-    end
-    dsConnStr.hash
 end
 
 def getName techName

data/twb.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
   s.name        = 'twb'
   s.summary     = "Classes for accessing Tableau Workbooks and their contents - summary."
   s.description = "Classes for accessing Tableau Workbooks and their contents - description"
-  s.version     = '0.0.24'
+  s.version     = '0.0.25'
   s.date        = "2015-03-14"
   s.author      = "Chris Gerrard"
   s.email       = "Chris@Gerrard.net"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.25
   prerelease: 
 platform: ruby
 authors:
@@ -19,18 +19,23 @@ extra_rdoc_files: []
 files:
 - bin/twb.cmd
 - bin/twb.rb
+- lib/twb/dashboard.rb
+- lib/twb/dashboard.txt
 - lib/twb/datasource.rb
 - lib/twb/there.rb
 - lib/twb/TwbTest.rb
 - lib/twb/workbook.rb
+- lib/twb/worksheet.rb
 - lib/twb.rb
 - LICENSE.txt
+- README.txt
 - testTwbGem.rb
 - twb-0.0.1.gem
 - twb-0.0.2.gem
 - twb-0.0.21.gem
 - twb-0.0.22.gem
 - twb-0.0.23.gem
+- twb-0.0.24.gem
 - twb.gemspec
 homepage: http://rubygems.org/gems/twb
 licenses: