twb 0.4.0 → 0.5.0

data/LICENSE.md

@@ -0,0 +1 @@
+## Header

data/lib/twb/util/twbDashSheetDataDotBuilder.rb

@@ -69,7 +69,6 @@ module Util
 
     def initDot
       @dotFileName = @workbook.name + '.dot'
-#      @dotFileName = gsub(/ /,'_')
       @dotFile = File.open(@dotFileName,'w')
       @dotFile.puts @@dotHeader
     end
@@ -110,7 +109,6 @@ module Util
 
     def closeDot
      @dotFile.puts ' '
-    #@dotFile.puts '// -------------------------------------------------------------'
      @dotFile.puts '}'
      @dotFile.close
     end

data/lib/twb/util/twbDashesSheetDataDotBuilder.rb

@@ -0,0 +1,153 @@
+#  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 TwbDashesSheetDataDotBuilder
+
+    @@dotHeader = <<-DOTHEADER
+    digraph g {
+        graph [rankdir="LR" splines="line"];
+        node  [shape="box"  width="2"];
+
+        "Tableau Tools generated Workbook map" [color="white" border="0"];
+    DOTHEADER
+
+    @@dotFooter = <<-DOTFOOTER
+      }
+
+       subgraph cluster_0 {
+        color=white;
+        node [shape="box3d"  style="filled" ];
+        "Workbook" -> "Dashboard" -> "Worksheet" -> "Data Source"
+        "Workbook"    "Dashboard";
+        "Worksheet";
+        "Data Source";
+       }
+
+    }
+    DOTFOOTER
+
+    attr_reader :workbook, :dotFile, :dotFileName, :dashCount, :sheetCount, :dataSourceCount
+
+    def initialize twb
+      @workbook = if twb.instance_of?(Twb::Workbook)
+                  then twb
+                  else Twb::Workbook.new(twb)
+                  end
+      @dashCount       = @workbook.dashboards.length
+      @worksheets      = @workbook.worksheetNames
+      @sheetCount      = @worksheets.length
+      @datasources     = @workbook.datasourceUINames
+      @dataSourceCount = @datasources.length
+      pairs  = processDashboards
+      pairs += processWorksheets
+      pairs += processOrphans
+      initDot
+      buildBody(pairs)
+      sameRank([@workbook.name]           )
+      sameRank( @workbook.dashboardNames  )
+      sameRank( @workbook.worksheetNames  )
+      sameRank( @workbook.datasourceNames )
+      buildHeader
+      labelDataSources
+      closeDot
+    end
+
+    def initDot
+      @dotFileName = @workbook.name + '.dot'
+      @dotFile = File.open(@dotFileName,'w')
+      @dotFile.puts @@dotHeader
+    end
+
+    def buildBody(pairs)
+      @dotFile.puts "\n   subgraph cluster_1 {"
+      @dotFile.puts "       color= grey;"
+      @dotFile.puts ""
+      pairs.each { |pair| @dotFile.puts "      \"#{pair[0]}\" -> \"#{pair[1]}\" " }
+      @dotFile.puts ""
+      @dotFile.puts "   }"
+    end
+
+    def sameRank(elements)
+      @dotFile.puts "\n  {rank=same "
+      elements.each do |e|
+        @dotFile.puts "     \"#{e}\""
+      end
+      @dotFile.puts "  }"
+    end
+
+    def buildHeader
+     @dotFile.puts ''
+     @dotFile.puts '   subgraph cluster_0 {'
+     @dotFile.puts '     color=white;'
+     @dotFile.puts '     node [shape="box3d"  style="filled" ];'
+     @dotFile.puts '     "Workbook" -> "Dashboard" -> "Worksheet" -> "Data Source"'
+     @dotFile.puts '   }'
+    end
+
+    def labelDataSources
+      @dotFile.puts " "
+      @workbook.datasources.each do |ds|
+        name = ds.name
+        @dotFile.puts "  \"#{name}\" [label=\"#{ds.uiname}\"];"
+      end
+    end
+
+    def closeDot
+     @dotFile.puts ' '
+     @dotFile.puts '}'
+     @dotFile.close
+    end
+
+    def processDashboards
+      pairs = []
+      @workbook.dashboards.each do |dash|
+        dashName = dash.name
+        pairs          << [@workbook.name,dashName]
+        dash.worksheets.each do |sheet|
+          sheetName = sheet.name
+          pairs << [dashName,sheetName]
+          @worksheets.delete sheetName
+        end
+      end
+      return pairs
+    end
+
+    def processWorksheets
+      pairs = []
+      @workbook.worksheets.each do |sheet|
+        sheetName   = sheet.name
+        sheet.datasources.each do |ds|
+          dsName = ds.name
+          pairs  << [sheetName,ds.name]
+          @datasources.delete ds.uiname
+        end
+      end
+      return pairs
+    end
+
+    def processOrphans
+      pairs = []
+      @datasources.each { |dsn| pairs << [@workbook.name,dsn] }
+      @worksheets.each  { |wsn| pairs << [@workbook.name,wsn] }
+      return pairs
+    end
+
+  end
+
+end
+end

data/lib/twb/workbook.rb

@@ -14,6 +14,7 @@
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'nokogiri'
+require 'zip'
 
 module Twb
 
@@ -22,7 +23,8 @@ module Twb
   #
   class Workbook
 
-    attr_reader :workbooknode, :name, :dir, :modtime, :version, :build, :ndoc, :datasources, :dashboards, :storyboards, :worksheets
+    attr_reader :workbooknode, :name,       :dir,         :modtime,    :version, :build
+    attr_reader :datasources,  :dashboards, :storyboards, :worksheets, :valid,   :ndoc
 
     # Creates a Workbook, from its file name.
     #
@@ -31,10 +33,32 @@ module Twb
     #   The Workbook's file name
     #
     def initialize twbWithDir
-      @name    = File.basename(twbWithDir)
-      @dir     = File.dirname(File.expand_path(twbWithDir))
-      @modtime = File.new(twbWithDir).mtime
-      @ndoc    = Nokogiri::XML(open(twbWithDir))
+      @valid = false
+      if File.file?(twbWithDir) then 
+        @name    = File.basename(twbWithDir)
+        @dir     = File.dirname(File.expand_path(twbWithDir)) 
+        @modtime = File.new(twbWithDir).mtime.strftime("%Y-%m-%d %H:%M:%S")
+        case File.extname(twbWithDir)
+          when '.twb'  then processTWB(twbWithDir)
+          when '.twbx' then processTWBX(twbWithDir)
+        end
+      end
+    end
+    
+    def processTWBX(twbxWithDir)
+      Zip::File.open(twbxWithDir) do |zip_file|
+        twb   = zip_file.glob('*.twb').first
+        @ndoc = Nokogiri::XML(twb.get_input_stream)
+        processDoc
+      end
+    end
+
+    def processTWB(twbFile)
+      @ndoc    = Nokogiri::XML(open(twbFile))
+      processDoc
+    end
+    
+    def processDoc
       @workbooknode  = @ndoc.at_xpath('//workbook')
       @version = @ndoc.xpath('/workbook/@version')
       @build   = @ndoc.xpath('/workbook/comment()').text.gsub(/^[^0-9]+/,'').strip
@@ -43,7 +67,7 @@ module Twb
       loadDashboards
       loadStoryboards
       loadWindows
-      return true
+      @valid = true
     end
 
     def loaddatasources

data/lib/twb.rb

@@ -33,5 +33,5 @@ require_relative 'twb/util/xraydashboards'
 # Represents Tableau Workbooks and their contents.
 #
 module Twb
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -37,6 +37,7 @@ files:
 - lib/twb/util/dotFileRenderer.rb
 - lib/twb/util/hashtohtml.rb
 - lib/twb/util/htmllistcollapsible.rb
+- lib/twb/util/twbDashesSheetDataDotBuilder.rb
 - lib/twb/util/twbDashSheetDataDotBuilder.rb
 - lib/twb/util/twbDashSheetDataDotRenderer.rb
 - lib/twb/util/xraydashboards.rb
@@ -55,6 +56,7 @@ files:
 - test/testTwbDashSheetDataDotBuilder.rb
 - test/testTwbGem.rb
 - test/testTwbWrite.rb
+- LICENSE.md
 - README.md
 - lib/twb/dashboard.txt
 - LICENSE.txt