twb 0.5.3 → 1.0

data/lib/twb/workbook.rb

@@ -19,14 +19,18 @@ require 'zip'
 module Twb
 
 
-  # Represents Tableau Workbooks and their parts.
+  # A Tableau Workbook and its parts.
   #
   class Workbook
 
-    attr_reader :workbooknode, :name,       :dir,         :modtime,    :version, :build
-    attr_reader :datasources,  :dashboards, :storyboards, :worksheets, :valid,   :ndoc
+    attr_reader :workbooknode 
+    attr_reader :name,        :dir         
+    attr_reader :modtime,     :version,         :build
+    attr_reader :datasources, :datasourceNames, :datasourceUINames
+    attr_reader :dashboards,  :storyboards,     :worksheets,       :actions
+    attr_reader :valid,       :ndoc
 
-    # Creates a Workbook, from its file name.
+    # Creates a Workbook from its file name.
     #
     # == Parameters:
     # twbWithDir
@@ -67,17 +71,29 @@ module Twb
       loadDashboards
       loadStoryboards
       loadWindows
+      loadActions
       @valid = true
     end
 
     def loaddatasources
-      @dataSourcesNode = @ndoc.at_xpath('//workbook/datasources')
-      @datasources     = {}
-      @datasourceNodes = @ndoc.xpath('//workbook/datasources/datasource').to_a
-      @datasourceNodes.each do |node|
+      # puts "LOAD DATA SOURCES"
+      # @dataSourcesNode = @ndoc.at_xpath('//workbook/datasources')
+      @datasources        = Set.new
+      @datasourceNames    = Set.new
+      @datasourceUINames  = Set.new
+      @dataSourceNamesMap = {}
+      datasourceNodes     = @ndoc.xpath('//workbook/datasources/datasource')
+      # puts "DATASOURCENODES : #{@datasourceNodes.length}"
+      datasourceNodes.each do |node|
         datasource = Twb::DataSource.new(node)
-        @datasources[datasource.name] = datasource
+        @datasources << datasource
+        @datasourceNames    << datasource.name
+        @datasourceNames    << datasource.uiname
+        @datasourceUINames  << datasource.uiname
+        @dataSourceNamesMap[datasource.name]   = datasource 
+        @dataSourceNamesMap[datasource.uiname] = datasource 
       end
+      # puts "DATASOURCES    : #{@datasources.length}"
     end
 
     def loadWorksheets
@@ -92,7 +108,7 @@ module Twb
     def loadDashboards
       @dashesNode = @ndoc.at_xpath('//workbook/dashboards')
       @dashboards = {}
-      dashes = @ndoc.xpath('//workbook/dashboards/dashboard' ).to_a
+      dashes = @ndoc.xpath('//workbook/dashboards/dashboard').to_a
       dashes.each do |node|
         unless node.attr('type') == 'storyboard' then
           dashboard = Twb::Dashboard.new(node, @worksheets)
@@ -120,10 +136,28 @@ module Twb
       end
     end
 
-    def datasources
-      @datasources.values
+    def loadActions
+      @actions = {}
+      actionNodes = @ndoc.xpath("//workbook/actions/action")
+      actionNodes.each do |anode|
+        action = Twb::Action.new(anode, @workbooknode)
+        @actions[action.uiname] = action
+      end
+    end
+
+    def actions
+      @actions.values
+    end
+
+    def actionNames
+      @actions.keys
     end
 
+    # def datasources
+    #   # puts "ACCESSING DATASOURCES - #{@datasources.class} - #{@datasources.length} - #{@datasources.values.length}"
+    #   return @datasources.values
+    # end
+
     def dashboards
       @dashboards.values
     end
@@ -132,6 +166,10 @@ module Twb
       @dashboards.keys
     end
 
+    def dashboard name
+      @dashboards[name]
+    end
+
     def storyboards
       @storyboards.values
     end
@@ -140,20 +178,6 @@ module Twb
       @worksheets.values
     end
 
-    def datasourceNames
-      @datasources.keys
-    end
-
-    def datasourceUINames
-      uiNames = []
-      @datasources.values.each {|ds| uiNames << ds.uiname}
-      return uiNames
-    end
-
-    def dashboardNames
-      @dashboards.keys
-    end
-
     def storyboardNames
       @storyboards.keys
     end
@@ -163,11 +187,7 @@ module Twb
     end
 
     def datasource name
-      @datasources[name]
-    end
-
-    def dashboard name
-      @dashboards[name]
+      @dataSourceNamesMap[name]
     end
 
     def storyboard name
@@ -178,15 +198,6 @@ module Twb
       @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
-        # TODO fix this @dataSourcesNode.add_next_sibling(@dashesNode)
-      end
-    end
-
     def ensureWindowsNodeExists
       if @windowsnode.nil?
         @windowsnode = Nokogiri::XML::Node.new "windows", @ndoc
@@ -207,6 +218,15 @@ module Twb
       @windowsnode.add_child(docDashboard.winnode)
     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
+        # TODO fix this @dataSourcesNode.add_next_sibling(@dashesNode)
+      end
+    end
+
     def getNewDashboardTitle(t)
       title = t
       if @datasources.include?(title)

data/lib/twb/worksheet.rb

@@ -32,12 +32,14 @@ module Twb
 
     @@hasher = Digest::SHA256.new
 
-    attr_reader :node, :name, :datasourcenames, :datasources
+    attr_reader :node,   :name,      :datasourcenames, :datasources
+    attr_reader :fields, :rowFields, :colFields,       :datasourceFields
 
     def initialize sheetNode
       @node    = sheetNode
       @name    = @node.attr('name')
       loadDataSourceNames
+      loadFields
       return self
     end
 
@@ -58,6 +60,72 @@ module Twb
       @datasources[name]
     end
 
+    def datasourceFields
+      @datasourceFields.nil? ? loadFields : @datasourceFields
+    end
+
+    def fields
+      @fields.nil? ? loadFields : @fields
+    end
+
+    def loadFields
+      # puts "WORKSHEET loadFields"
+      @datasourceFields = {}
+      dsNodes = @node.xpath('.//datasource-dependencies')
+      dsNodes.each do |dsn|
+        dsName = dsn.attribute('datasource').text
+        dsfs = @datasourceFields[dsName] = []
+        fieldNodes = dsn.xpath('./column')
+        fieldNodes.each do |fn|
+          fname = fn.attribute('name')
+          dsfs.push fname.text.gsub(/^\[/,'').gsub(/\]$/,'') unless fname.nil?
+        end
+      end
+      # <rows>([DATA Connection (copy 2)].[none:JIRA HARVEST Correspondence  Name:nk] / [DATA Connection (copy 2)].[none:CreatedDate (Issue) (DAY):ok])</rows>
+      # <cols>[DATA Connection (copy 2)].[:Measure Names]</cols>
+      @fields = {}
+      @rowFields = pullRowColFields './/rows' # returns map of data source => (Set of) field names
+      @fields[:rows] = @rowFields
+      @colFields = pullRowColFields './/cols' # returns map of data source => (Set of) field names
+      @fields[:cols] = @colFields
+    end
+
+    def addDSFields fields, usage
+      fields.each do  
+      end
+    end
+
+    def pullRowColFields xpath
+      dsFields   = {}                  # data source => (Set of) fields by names 
+      node       = @node.xpath(xpath)  # expect only one each of <rows> & <cols> node per <worksheet node
+      code       = node.text
+      # puts "\n CODE: '#{code}'"
+      return dsFields if code.nil?
+      codeFields = code.gsub(/^[(]|[)]$/,'').split(/] [\/+*] [(]?\[/)
+      return dsFields if codeFields.nil?  # - commented out, left here for logic clarity   
+      codeFields.each do |dsf|
+        parts = dsf.split('].[')
+        if parts.length == 2
+          ds = parts[0].gsub(/^\[|\]$/,'')
+
+          # remove prefix(es), if any 
+          f1 = parts[1].gsub(/^pcto:|^fVal:/,'').gsub(/^[a-z]+:/,'')          
+          #                  /^pcto:|^fVal:/  - special handling based upon actual codings
+
+          # remove terminating )s
+          f2 = f1.gsub(/[\)]+$/,'')                                           
+
+          # remove suffix(es), if any
+          f3 = f2.gsub(/:[0-9]+[\]]?$/,'').gsub(/:[a-z]+[\]]?$|[\]]?$/,'')    
+          #            /:[0-9]+[\]]?$/  - special handling based upon actual codings
+                                                                              
+          dsFields[ds] = Set.new unless dsFields.include? ds
+          dsFields[ds].add(f3)
+        end
+      end
+      return dsFields
+    end
+
     def datasourcenames
       @datasources.keys
     end

data/lib/twb.rb

@@ -23,15 +23,20 @@ require_relative 'twb/storyboard'
 require_relative 'twb/window'
 require_relative 'twb/workbook'
 require_relative 'twb/worksheet'
+require_relative 'twb/action'
+require_relative 'twb/fieldcalculation'
 require_relative 'twb/docdashboardimagevert.rb'
 require_relative 'twb/docdashboardwebvert.rb'
 require_relative 'twb/util/twbDashSheetDataDotBuilder'
 require_relative 'twb/util/dotFileRenderer'
 require_relative 'twb/util/htmllistcollapsible'
 require_relative 'twb/util/xraydashboards'
+require_relative 'twb/util/graphnode'
+require_relative 'twb/util/graphedge'
+require_relative 'twb/util/graphedges'
 
 # Represents Tableau Workbooks and their contents.
 #
 module Twb
-  VERSION = '0.5.3'
+  VERSION = '1.0'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twb
 version: !ruby/object:Gem::Version
-  version: 0.5.3
-  prerelease: 
+  version: '1.0'
 platform: ruby
 authors:
 - Chris Gerrard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies: []
 description: A sollection of Ruby classes designed for accessing and recording information
   about, and for manipulating, Tableau Workbooks and their contents.
@@ -18,33 +17,47 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.md
+- LICENSE.txt
+- README.md
 - bin/twb.rb
+- lib/twb.rb
+- lib/twb/TwbTest.rb
+- lib/twb/action.rb
 - lib/twb/apps/X-Ray Dashboards.rb
+- lib/twb/countNodes.rb
 - lib/twb/dashboard.rb
+- lib/twb/dashboard.txt
 - lib/twb/datasource.rb
 - lib/twb/docdashboard.rb
 - lib/twb/docdashboardimagevert.rb
 - lib/twb/docdashboardwebvert.rb
 - lib/twb/field.rb
 - lib/twb/fieldcalculation.rb
+- lib/twb/findDSFields.rb
+- lib/twb/graph.rb
+- lib/twb/graphedges.rb
+- lib/twb/graphnode.rb
 - lib/twb/hashtohtml.rb
 - lib/twb/htmllistcollapsible.rb
+- lib/twb/identifyFields.rb
 - lib/twb/localfield.rb
 - lib/twb/metadatafield.rb
 - lib/twb/storyboard.rb
 - lib/twb/there.rb
-- lib/twb/TwbTest.rb
 - lib/twb/util/dotFileRenderer.rb
+- lib/twb/util/graphedge.rb
+- lib/twb/util/graphedges.rb
+- lib/twb/util/graphnode.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/twbDashesSheetDataDotBuilder.rb
 - lib/twb/util/xraydashboards.rb
 - lib/twb/window.rb
 - lib/twb/workbook.rb
 - lib/twb/worksheet.rb
-- lib/twb.rb
 - test/testDashboardXRay.rb
 - test/testDocDashboard.rb
 - test/testDocDashboardCreate.rb
@@ -56,33 +69,28 @@ files:
 - test/testTwbDashSheetDataDotBuilder.rb
 - test/testTwbGem.rb
 - test/testTwbWrite.rb
-- LICENSE.md
-- README.md
-- lib/twb/dashboard.txt
-- LICENSE.txt
 homepage: http://rubygems.org/gems/twb
 licenses:
-- GNU General Public License v3.0
+- GPL-3.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 2.6.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Classes for accessing Tableau Workbooks and their contents.
 test_files: []