twb 0.0.31 → 0.0.33

data/lib/twb/localfield.rb

@@ -0,0 +1,42 @@
+#  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'
+
+module Twb
+
+  # Assumption: A field can only be either a MetadataField or a LocalField, not both in a given Workbook data connection.
+
+  class LocalField
+
+    attr_reader :type, :node, :name, :datatype, :role, :type, :hidden, :caption, :aggregation, :uiname
+
+    def initialize fieldNode
+      @node        = fieldNode
+      @type        = 'local'
+      @name        = @node.attr('name')
+      @datatype    = @node.attr('datatype')
+      @role        = @node.attr('role')
+      @type        = @node.attr('type')
+      @hidden      = @node.attr('hidden')
+      @caption     = @node.attr('caption')
+      @aggregation = @node.attr('aggregation')
+      @uiname      = if @caption.nil? || @caption == '' then @name else @caption end
+      return self
+    end
+
+  end
+
+end

data/lib/twb/metadatafield.rb

@@ -0,0 +1,55 @@
+#  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'
+
+module Twb
+
+  # Assumption: A field can only be either a MetadataField or a LocalField, not both in a given Workbook data connection.
+
+  class MetadataField
+
+    attr_reader :node, :aggregation, :containsnull, :localname, :localtype, :ordinal, :parentname, :precision, :remotealias, :remotename, :remotetype, :width, :name
+
+    def initialize fieldNode
+      @node              = fieldNode
+      @aggregation       = load 'aggregation'
+      @containsnull      = load 'contains-null'
+      @localname         = load 'local-name'
+      @localtype         = load 'local-type'
+      @ordinal           = load 'ordinal'
+      @parentname        = load 'parent-name'
+      @precision         = load 'precision'
+      @remotealias       = load 'remote-alias'
+      @remotename        = load 'remote-name'
+      @name              = @remotename
+      @remotetype        = load 'remote-type'
+      @width             = load 'width'
+      return self
+    end
+
+    def load nodeName
+      node = @node.at_xpath(nodeName)
+      val  = if node.nil? then  node else node.text end
+      # puts "==== MD node:'#{nodeName}' \t nil?'#{node.nil?}' \t == val:#{val} \t = '#{node}' "
+      return val
+    end
+
+  end
+
+end
+
+
+

data/lib/twb/util/hashtohtml.rb

@@ -0,0 +1,45 @@
+class HashToHTMLList
+  
+  def initialize(hash)
+    @hash      = hash
+    @indent    = "  "
+    @tag_space = ""
+    @level     = 0
+    @out       = []
+  end
+
+  def append(tag,value=nil)
+    str = @indent * @level + "#{tag}"
+    str += @tag_space + "<a>" + value + "</a>" unless value.nil?
+    str += "\n"
+    @out << str
+  end
+
+  def ul(hash)
+    open_tag('ul') { li(hash) }
+  end
+
+  def li(collection)
+    @level += 1
+    collection.each do |key,value|
+      open_tag('li',key) { ul(value) if value.is_a?(Hash) ||  value.is_a?(Array) }
+    end
+    @level -= 1
+  end
+
+  def list
+    ul(@hash)
+    @out.join
+  end
+
+  def open_tag(tag,value=nil,&block)
+    append("<#{tag}>",value)
+    yield if block_given?
+    append("</#{tag}>")
+  end
+  
+  def to_s
+    @out
+  end
+  
+end

data/lib/twb/util/htmllistcollapsible.rb

@@ -0,0 +1,195 @@
+#  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 'fileutils'
+require_relative 'hashtohtml'
+
+module Twb
+
+  class HTMLListCollapsible
+
+    @@doc = Nokogiri::HTML::Document.parse  <<-COLLAPSIBLELIST
+    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+    <head>
+        <title>Tableau Documentation</title>
+    
+        <style type="text/css">
+            body, a {
+                color: #3B4C56;
+                font-family: sans-serif;
+                font-size: 14px;
+                text-decoration: none;
+            }
+            #pgtitle
+            {
+               margin: 0px 0px 20px;
+               font-size: 14pt;
+               text-align: center;
+            }
+            a{
+               cursor:pointer;
+            }
+            .tree ul {
+                list-style: none outside none;
+            }
+            .tree li a {
+                line-height: 25px;
+            }
+            .tree > ul > li > a {
+                color: #3B4C56;
+                display: block;
+                font-weight: normal;
+                position: relative;
+                text-decoration: none;
+            }
+            .tree li.parent > a {
+                padding: 0 0 0 28px;
+            }
+            .tree li.parent > a:before {
+                background-image: url("UpLeftArrowsNav.png");
+                background-position: 20px center;
+                 content: "";
+                display: block;
+                height: 20px;
+                left: 0;
+                position: absolute;
+                top: 2px;
+                vertical-align: middle;
+                width: 20px;
+            }
+            .tree ul li.active > a:before {
+                background-position: 0 center;
+            }
+            .tree ul li ul {
+                border-left: 1px solid #D9DADB;
+                display: none;
+                margin: 0 0 0 12px;
+                overflow: hidden;
+                padding: 0 0 0 25px;
+            }
+            .tree ul li ul li {
+                position: relative;
+            }
+            .tree ul li ul li:before {
+                border-bottom: 1px dashed #E2E2E3;
+                content: "";
+                left: -20px;
+                position: absolute;
+                top: 12px;
+                width: 15px;
+            }
+            #wrapper {
+                margin: 0 auto;
+                width: 300px;
+            }
+        </style>
+    
+        <script src="http://code.jquery.com/jquery-1.7.2.min.js" type="text/javascript" > </script>
+    
+        <script type="text/javascript">
+            $( document ).ready( function( ) {
+                    $( '.tree li' ).each( function() {
+                            if( $( this ).children( 'ul' ).length > 0 ) {
+                                    $( this ).addClass( 'parent' );
+                            }
+                    });
+    
+                    $( '.tree li.parent > a' ).click( function( ) {
+                            $( this ).parent().toggleClass( 'active' );
+                            $( this ).parent().children( 'ul' ).slideToggle( 'fast' );
+                    });
+    
+                    $( '#all' ).click( function() {
+    
+                        $( '.tree li' ).each( function() {
+                            $( this ).toggleClass( 'active' );
+                            $( this ).children( 'ul' ).slideToggle( 'fast' );
+                        });
+                    });
+    
+                    $( '.tree li' ).each( function() {
+                            $( this ).toggleClass( 'active' );
+                            $( this ).children( 'ul' ).slideToggle( 'fast' );
+                    });
+    
+            });
+    
+        </script>
+    
+    </head>
+    <body>
+        <div id="pgtitle">
+            Expandable nested list.
+        </div>
+        <div id="wrapper">
+        <div class="tree">
+        <button id="all">Toggle all</button>
+        <ul>
+        </ul>
+        </div>
+        </div>
+    
+    </body>
+    </html>
+COLLAPSIBLELIST
+    
+    def initialize(hash)
+      @htmldoc = @@doc
+      @list    = HashToHTMLList.new(hash).list
+      ul = @htmldoc.at_xpath('//ul')
+      ul.replace(@list)
+    end
+    
+    def title=(str)
+      title = @htmldoc.at_xpath('//div[@id="pgtitle"]')
+      title.content = str if title 
+    end
+    
+    def html
+      @htmldoc 
+    end
+    
+    # Write the HTML to a file using the provided name.
+    def write(name='collapsibleList.html')
+      $f = File.open(name,'w')
+      if $f
+          $f.puts @htmldoc
+          $f.close
+      end
+      installNavImageFile
+    end
+    
+    def installNavImageFile
+      puts "looking for nav controls image"
+      # puts "  __FILE__ #{__FILE__}"  #File.expand_path(File.dirname(_FILE_))
+      puts "  Dir.pwd #{Dir.pwd}"
+      puts "  File.dirname(__FILE__) #{File.dirname(__FILE__)}"
+      puts "  __FILE__ #{__FILE__}"
+      navimage = File.dirname(__FILE__) + "/UpLeftArrowsNav.png"
+      puts "  filemask: #{navimage}"
+      cnt = 0
+      Dir.glob(navimage) do |twb|
+        puts twb
+        cnt += 1
+      end
+      puts "  found #{cnt} files"
+      FileUtils.cp(navimage, Dir.pwd)
+    end
+
+  end
+
+end

data/lib/twb/window.rb

@@ -0,0 +1,31 @@
+#  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'
+
+module Twb
+
+  class Window
+
+    attr_reader :node, :name
+
+    def initialize node
+      @node    = node
+      @name    = @node.attr('name')
+    end
+
+  end
+
+end

data/lib/twb/workbook.rb

@@ -24,7 +24,7 @@ module Twb
 
     attr_reader :name, :dir, :modtime, :version, :build, :ndoc, :datasources, :dashboards, :storyboards, :worksheets
 
-    # Creates a Workbook, from it's file name.
+    # Creates a Workbook, from its file name.
     #
     # == Parameters:
     # twbWithDir
@@ -35,17 +35,20 @@ module Twb
       @name    = File.basename(twbWithDir)
       @dir     = File.dirname(File.expand_path(twbWithDir))
       @modtime = File.new(twbWithDir).mtime
-      @ndoc = Nokogiri::XML(open(twbWithDir))
+      @ndoc    = Nokogiri::XML(open(twbWithDir))
+      @wbnode  = @ndoc.at_xpath('//workbook')
       @version = @ndoc.xpath('/workbook/@version')
       @build   = @ndoc.xpath('/workbook/comment()').text.gsub(/^[^0-9]+/,'').strip
       loaddatasources
+      loadWorksheets
       loadDashboards
       loadStoryboards
-      loadWorksheets
+      loadWindows
       return true
     end
 
     def loaddatasources
+      @dataSources = @ndoc.at_xpath('//workbook/datasources')
       @datasources = {}
       @datasourceNodes = @ndoc.xpath('//workbook/datasources/datasource').to_a
       @datasourceNodes.each do |node|
@@ -55,12 +58,22 @@ module Twb
       return true
     end
 
+    def loadWorksheets
+      @worksheets = {}
+      sheets = @ndoc.xpath('//workbook/worksheets/worksheet' ).to_a
+      sheets.each do |node|
+        sheet = Twb::Worksheet.new(node)
+        @worksheets[sheet.name] = sheet
+      end
+    end
+
     def loadDashboards
+      @dashesNode = @ndoc.at_xpath('//workbook/dashboards')
       @dashboards = {}
       dashes = @ndoc.xpath('//workbook/dashboards/dashboard' ).to_a
       dashes.each do |node|
         unless node.attr('type') == 'storyboard' then
-          dashboard = Twb::Dashboard.new(node)
+          dashboard = Twb::Dashboard.new(node, @worksheets)
           @dashboards[dashboard.name] = dashboard
         end
       end
@@ -75,12 +88,13 @@ module Twb
       end
     end
 
-    def loadWorksheets
-      @worksheets = {}
-      sheets = @ndoc.xpath('//workbook/worksheets/worksheet' ).to_a
-      sheets.each do |node|
-        sheet = Twb::Worksheet.new(node)
-        @worksheets[sheet.name] = sheet
+    def loadWindows
+      @windowsnode = @ndoc.at_xpath("//workbook/windows")
+      @windows = {}
+      windows  = @ndoc.xpath("//workbook/windows/window[@name]")
+      windows.each do |node|
+        window = Twb::Window.new(node)
+        @windows[window.name] = window
       end
     end
 
@@ -101,7 +115,6 @@ module Twb
       @worksheets.values
     end
 
-
     def datasourceNames
       @datasources.keys
     end
@@ -118,7 +131,6 @@ module Twb
       @worksheets.keys
     end
 
-
     def datasource name
       @datasources[name]
     end
@@ -134,6 +146,59 @@ module Twb
     def worksheet name
       @worksheets[name]
     end
+    
+    # Make sure that the TWB has a <dashboards> node.
+    # It's possible for a TWB to have no dashboards, and therefore no <dashboards> node.
+    def ensureDashboardsNodeExists
+      if @dashesNode.nil?
+        @dashesNode = Nokogiri::XML::Node.new "dashboards", @ndoc
+        @dataSources.add_next_sibling(@dashesNode)
+      end
+    end
+
+    # Add a new Documentation Dashboard to the TWB.
+    # Ensure that the TWB has a <dashboards> node (it may not).
+    # Make sure that the new Doc Dashboard's name doesn't conflict with an existing Dashboard - increment the incoming name if necessary.
+    # Add Doc Dashboard's <dashboard> and <window> nodes to the TWB; there's always a <windows> node in the TWB.
+    def addDocDashboard docDashboard
+      ensureDashboardsNodeExists
+      title      = getNewDashboardTitle(docDashboard.title)
+      docDashboard.title=(title) unless title == docDashboard.title
+      @dashesNode.add_child(docDashboard.dashnode)
+      @windowsnode.add_child(docDashboard.winnode)     
+    end
+ 
+    def getNewDashboardTitle(t)
+      title = t
+      if @datasources.include?(title)
+        inc = 0
+        loop do
+          inc+=1
+          title = t + ' ' + inc.to_s
+          if !@datasources.include?(title)
+            break
+          end
+        end
+      end
+      return title
+    end
+
+    # Write the TWB to a file, with an optional name.
+    # Can be used to write over the existing TWB (dangerous), or to a new file (preferred).
+    def write(name=@name)
+      $f = File.open(name,'w')
+      if $f
+          $f.puts @ndoc
+          $f.close
+      end
+    end
+   
+    # Write the TWB to a file, appending the base name with the provided string.
+    # Intended for use when making adjustments to the TWB without overwriting the original.
+    def writeAppend(str)
+      newName = @name.sub(/[.]twb$/,'') + str.gsub(/^[.]*/,'.') + '.twb'
+      write newName
+    end
 
   end