twb 0.0.31 → 0.0.33

data/bg.cmd

@@ -0,0 +1,5 @@
+cls
+@echo.
+call gem build twb.gemspec
+@echo.
+call gem install %1%

data/lib/twb.rb

@@ -3,10 +3,15 @@ require_relative 'twb/dashboard'
 require_relative 'twb/worksheet'
 require_relative 'twb/datasource'
 require_relative 'twb/storyboard'
+require_relative 'twb/window'
+require_relative 'twb/localfield'
+require_relative 'twb/metadatafield'
+require_relative 'twb/docdashboard'
+require_relative 'twb/util/htmllistcollapsible'
 
-# Represents Tableau Workbooks and theis contents.
+# Represents Tableau Workbooks and their contents.
 #
 module Twb
-  VERSION = '0.0.31'
+  VERSION = '0.0.33'
 end
 

data/lib/twb/dashboard.rb

@@ -22,25 +22,25 @@ module Twb
 
     @@hasher = Digest::SHA256.new
 
-    attr_reader :node, :name, :worksheets, :autosize, :size, :maxheight, :maxwidth, :minheight, :minwidth, :rangesize, :dimensions
+    attr_reader :node, :name, :worksheets, :autosize, :size, :maxheight, :maxwidth, :minheight, :minwidth, :rangesize, :dimensions, :zonecount
 
-    def initialize dashboardNode
-      "initialize Dashboard"
+    def initialize dashboardNode, twbworksheets
       @node     = dashboardNode
       @name     = @node.attr('name')
       @size     = @node.xpath('./size')
       @autosize = @size.empty?
       loadSize @size unless @autosize
-      loadSheets
+      loadSheets twbworksheets
+      @zonecount = @node.xpath('.//zone').length
       return self
     end
 
-    def loadSheets
+    def loadSheets twbworksheets
       @sheets = {}
       dsheets = @node.xpath('.//zone[@name]').to_a
       dsheets.each do |sheetNode|
-        sheet = Twb::Worksheet.new sheetNode
-        @sheets[sheet.name] = sheet
+        sheetname = sheetNode.attr('name')
+        @sheets[sheetname] = twbworksheets[sheetname]
       end
     end
 

data/lib/twb/datasource.rb

@@ -22,7 +22,7 @@ module Twb
 
     @@hasher = Digest::SHA256.new
 
-    attr_reader :node, :name, :caption, :uiname, :connHash, :class, :connection, :tables
+    attr_reader :node, :name, :caption, :uiname, :connHash, :class, :connection, :tables, :localfields, :metadatafields
 
     def initialize dataSourceNode
       @node    = dataSourceNode
@@ -30,25 +30,33 @@ module Twb
       @caption = @node.attr('caption')
       @uiname  = if @caption.nil? || @caption == '' then @name else @caption end
       processConnection
+      processFields
       return self
     end
 
     def processConnection
-      @connHash    = ''
       @connection  = @node.at_xpath('./connection')
       unless @connection.nil?
         @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)
+        setConnectionHash
         loadTables @connection
       end
     end
 
+    # Notes:
+    #      - TODO: need to determine which, if any, of the connection attributes should be
+    #              included in the hash in order to identify it unambiguously - without
+    #              local values that obscure the data source's 'real' identity
+    #      - attributes with value '' don't contribute to the hash
+    def setConnectionHash
+      dsAttributes = @node.xpath('./connection/@*')
+      dsConnStr    = ''
+      dsAttributes.each do |attr|
+        dsConnStr += attr.text
+      end
+      @connHash = Digest::MD5.hexdigest(dsConnStr)
+    end
+
     def loadTables connection
       @tables = {}
       nodes = connection.xpath(".//relation[@type='table']")
@@ -61,6 +69,27 @@ module Twb
       @name == 'Parameters'
     end
 
+    def processFields
+      # --
+      @localfields    = {}
+      nodes = @node.xpath(".//column")
+      nodes.each do |node|
+        field = Twb::LocalField.new(node)
+        @localfields[field.name] = field
+      end
+      # --
+      @metadatafields = {}
+      nodes = @node.xpath("./connection/metadata-records/metadata-record")
+      nodes.each do |node|
+        field = Twb::MetadataField.new(node)
+        @metadatafields[field.name] = field
+      end
+    end
+
+    def field name
+      field = if localfields[name].nil? then metadatafields[name] end
+    end
+
   end
 
 end

data/lib/twb/docdashboard.rb

@@ -0,0 +1,123 @@
+#  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 'set'
+
+module Twb
+
+  class DocDashboard
+
+  @@types = Set.new( ['h', 'horiz', 'horizontal',
+                      'v', 'vert',  'vertical'   ] )
+
+  attr_reader :title, :dashnode, :winnode, :type #, :panels, :autosize, :size
+  
+  @@oneColWebPageDash = Nokogiri::XML::Document.parse  <<-ONECOlWEBDASH
+  <dashdoc>
+    <dashboard name='Single Column Web Page Automatic'>
+      <style></style>
+      <zones>
+        <zone h='100000' id='3' param='vert' type='layout-flow' w='100000' x='0' y='0'>
+          <zone h='6221' id='1' type='title' w='100000' x='0' y='0'></zone>
+          <zone h='93157' id='4' param='horz' type='layout-flow' w='100000' x='0' y='6221'>
+            <zone forceUpdate='' h='93157' id='6' param='URL' type='web' w='99655' x='0' y='6221'></zone>
+          </zone>
+        </zone>
+      </zones>
+    </dashboard>
+    <window auto-hidden='0' class='dashboard' maximized='1' name='Single Column Web Page Automatic'>
+      <zones>
+        <zone h='6221' id='1' name='' type='title' w='100000' x='0' y='0' />
+        <zone forceUpdate='' h='93157' id='5' name='' param='Web Page' type='web' w='50000' x='50000' y='6221' />
+      </zones>
+    </window>
+  </dashdoc>
+  ONECOlWEBDASH
+  # notes:
+  #  - adding a size element to the <dashboard element will change it from automatic, e.g.
+  #
+  #    <dashboard name='One Column Web Page Laptop (800w 600h)'>
+  #    <style>
+  #    </style>
+  #    <size maxheight='600' maxwidth='800' minheight='600' minwidth='800' />
+  #
+  #  - the 'name' sttributes for the window and dashboard must match
+  
+  def title=(title)
+    @title = title
+    @dashnode['name'] = title
+    @winnode['name']  = title
+  end
+
+  def size=(size)
+    @size = size
+  end
+
+  def initialize type
+    dashboard = if @@types.include?(type)
+                then if type[0] == 'v'
+                     then DocDashboardVert.new
+                     else DocDashboardHoriz.new
+                     end
+                else nil
+                end
+    return dashboard
+  end
+  
+  def to_s
+    return title + ' :: ' + type
+  end
+
+  end
+
+  class DocDashboardWebVert < DocDashboard
+    
+    attr_reader :url 
+    
+    def initialize
+      @type = 'columnar Web Page'
+      @dashnode = @@oneColWebPageDash.at_xpath('//dashboard')
+      @winnode  = @@oneColWebPageDash.at_xpath('//window')
+    end
+    
+    def title=(title)
+      @title = title
+      @dashnode['name'] = title
+      @winnode['name']  = title
+    end
+    
+    def url=(url)
+        dashwebzone = @dashnode.at_xpath('.//zone[@type="web"]')
+        dashwebzone['param'] = url # unless dashwebzone.nil? 
+        winwebzone  = @winnode.at_xpath('.//zone[@type="web"]')
+        winwebzone['param'] = url  # unless winwebzone.nil?
+    end
+    
+    def url
+        dashurl = @dashnode.at_xpath('.//zone[@type="web"]').attribute('param').value
+        winurl  = @winnode.at_xpath( './/zone[@type="web"]').attribute('param').value
+        url = if dashurl == winurl then dashurl end
+    end
+
+  end
+
+  class DocDashboardWebHoriz < DocDashboard
+    def initialize
+      @type = 'horizontal'
+    end
+  end
+
+end

data/lib/twb/field.rb

@@ -0,0 +1,39 @@
+#  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 Field
+
+    attr_reader :node, :name, :datatype, :role, :type, :hidden, :caption, :aggregation, :uiname
+
+    def initialize fieldNode
+      @node        = fieldNode
+      @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/hashtohtml.rb

@@ -0,0 +1,39 @@
+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 + value unless value.nil?
+    str += "\n"
+    @out << str
+  end
+
+  def ul(hash)
+    open_tag('ul') { li(hash) }
+  end
+
+  def li(hash)
+    @level += 1
+    hash.each do |key,value|
+      open_tag('li',key) { ul(value) if value.is_a?(Hash) }
+    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
+end

data/lib/twb/htmllistcollapsible.rb

@@ -0,0 +1,154 @@
+#  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 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("Controls.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 html
+     " here's the @@doc"
+    end
+
+  end
+
+end