rubyXL 3.4.3 → 3.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c75446108b8995ffdd2957484d7f3618191c01db2cf11992ad6093f981a7b75
-  data.tar.gz: 8854b4ae8d19f174a71fba19a67c66818a438db5b4b58f097762d6ac1bd591c0
+  metadata.gz: 586426c799d24402c0720de16f7f78298bbf0817882fd27f0f06b99ec62bcaa6
+  data.tar.gz: '0913fa39cc7c6654ec57cb7dc57fb887febcba04a5540954c118b4012ebbb7be'
 SHA512:
-  metadata.gz: 8732bd9c24a1119802c68b93a43b69104d01ebf4a9ac55790658b1c0ebba1443a4ab877189062866cc7effa0d0201dc2727ce72fe3697a4e44ed54b75f0e2fb1
-  data.tar.gz: f96d512a5c69442aea9d4b2ac65861f59a023102c7bc93222bde30c7692eb536bb8a05b6f0da9a3386d08b2eae25d79386b2cc153045cfb6f7a993e24429797d
+  metadata.gz: 39d0a9a6ec7b64d8aee8a7c080ebda36658579a73cf3678e0292ed6dd5f52c61931e3cd4bed1667b155bb1ebc9641aaffbbdf28d0c98cb0c732be40a6f3226e4
+  data.tar.gz: 5f327c3e959e3f1ed3a06cf0222885f9739996aa88abd8e93d0f085b63a9f5fc3637920314b0cc20210f6ec7bc1f0ce75fc93768517914822d173d9e9d98c177

data/.circleci/config.yml

@@ -0,0 +1,59 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/Gemfile

@@ -14,4 +14,5 @@ group :development, :test do
 
 #  gem 'stackprof'
   gem 'ruby-prof'
+  gem 'rspec_junit_formatter'
 end

data/Gemfile.lock

@@ -0,0 +1,92 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.5.0)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (3.6.0)
+    highline (2.0.2)
+    jeweler (2.3.9)
+      builder
+      bundler
+      git (>= 1.2.5)
+      github_api (~> 0.16.0)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      psych
+      rake
+      rdoc
+      semver2
+    json (2.2.0)
+    jwt (2.2.1)
+    mime-types (2.99.3)
+    mini_portile2 (2.4.0)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    psych (3.1.0)
+    rack (2.0.7)
+    rake (12.3.2)
+    rdoc (6.1.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    ruby-prof (0.18.0)
+    rubyzip (1.2.3)
+    semver2 (3.4.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  nokogiri (>= 1.4.4)
+  rake
+  rspec
+  rspec_junit_formatter
+  ruby-prof
+  rubyzip (>= 1.1.6)
+  simplecov
+
+BUNDLED WITH
+   1.17.3

data/README.rdoc

@@ -1,13 +1,14 @@
 = rubyXL
 {<img src="https://badge.fury.io/rb/rubyXL.svg" alt="Gem Version" />}[http://badge.fury.io/rb/rubyXL]
 {<img src="https://codeclimate.com/github/weshatheleopard/rubyXL.png" alt="Code Climate" />}[https://codeclimate.com/github/weshatheleopard/rubyXL]
+{<img src="https://circleci.com/gh/weshatheleopard/rubyXL.svg?style=svg" alt="CircleCI" />}[https://circleci.com/gh/weshatheleopard/rubyXL]
 
 This gem supports operating on +xlsx+ files (Open XML format). While it is capable
 of properly parsing the entire OOXML structure, its current main emphasis is on
 reading files produced by MS Excel, making minor modifications to them and saving
 them to be opened again, while preserving as much of the structure as possible.
 
-Please note that proprietary binary +xls+ format is *not* supported.
+Please note that proprietary binary +xls+ format is *not* supported by this gem. If you need to parse those files, try {spreadsheet}[https://github.com/zdavatz/spreadsheet] gem.
 
 == To Install:
   gem install rubyXL
@@ -224,6 +225,10 @@ It can also operate on +StringIO+ objects, thus eliminating the need to save the
   RubyXL::Reference.ind2ref(0,0) == 'A1'    # Converts row and column index to Excel-style cell reference
   RubyXL::Reference.ref2ind('A1') == [0, 0] # Converts Excel-style cell reference to row and column index
 
+=== Suppress warnings about malformed input files
+
+  RubyXL.class_variable_set(:@@suppress_warnings, true)
+
 == For more information
 Take a look at the files in spec/lib/ for rspecs on most methods
 

data/Rakefile

@@ -34,8 +34,8 @@ Rake::TestTask.new(:test) do |test|
 end
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+RSpec::Core::RakeTask.new(:rspec)
+task :default => :rspec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-3.4.3
+3.4.4

data/lib/rubyXL.rb

@@ -2,6 +2,7 @@ require 'rubyXL/objects/root'
 require 'rubyXL/parser'
 
 module RubyXL
+  @@silence_warnings = false
 
   # Convert any path passed to absolute path (within the XLSX file).
   def self.from_root(path)

data/lib/rubyXL/objects/chartsheet.rb

@@ -16,8 +16,8 @@ module RubyXL
 
   # http://www.datypic.com/sc/ooxml/e-ssml_sheetPr-4.html
   class ChartsheetProperties < OOXMLObject
-    define_attribute(:published,                         :bool, :default => true)
-    define_attribute(:codeName,                          :string)
+    define_attribute(:published,     :bool, :default => true)
+    define_attribute(:codeName,      :string)
     define_child_node(RubyXL::Color, :node_name => :tabColor)
     define_element_name 'sheetPr'
   end

data/lib/rubyXL/objects/color.rb

@@ -1,4 +1,5 @@
 require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
 
 module RubyXL
 
@@ -8,7 +9,7 @@ module RubyXL
 
     define_attribute(:auto,    :bool)
     define_attribute(:indexed, :uint)
-    define_attribute(:rgb,     ST_UnsignedIntHex)
+    define_attribute(:rgb,     RubyXL::ST_UnsignedIntHex)
     define_attribute(:theme,   :uint)
     define_attribute(:tint,    :double, :default => 0.0)
     define_element_name 'color'

data/lib/rubyXL/objects/connection.rb

@@ -0,0 +1,175 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+require 'rubyXL/objects/extensions'
+
+# Connections
+# https://msdn.microsoft.com/en-us/library/dd908547(v=office.12).aspx
+# http://www.datypic.com/sc/ooxml/s-sml-externalConnections.xsd.html
+
+module RubyXL
+  # http://www.datypic.com/sc/ooxml/e-ssml_dbPr-1.html
+  class OdbcOleDbProperties < OOXMLObject
+    define_attribute(:connection,    RubyXL::ST_Xstring, :required => true)
+    define_attribute(:command,       RubyXL::ST_Xstring)
+    define_attribute(:serverCommand, RubyXL::ST_Xstring)
+    define_attribute(:commandType,   :uint, :default => 2)
+
+    define_element_name 'dbPr'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_olapPr-1.html
+  class OlapProperties < OOXMLObject
+    define_attribute(:local,              :bool, :default => false)
+    define_attribute(:localConnection,    RubyXL::ST_Xstring)
+    define_attribute(:localRefresh,       :bool, :default => true)
+    define_attribute(:sendLocale,         :bool, :default => false)
+    define_attribute(:rowDrillCount,      :uint)
+    define_attribute(:serverFill,         :bool, :default => true)
+    define_attribute(:serverNumberFormat, :bool, :default => true)
+    define_attribute(:serverFont,         :bool, :default => true)
+    define_attribute(:serverFontColor,    :bool, :default => true)
+
+    define_element_name 'olapPr'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_s-1.html
+  # TODO: ssml:m & ssml:x... but how?
+  class ConnectionTable < OOXMLObject
+    define_attribute(:v, RubyXL::ST_Xstring, :required => true)
+
+    define_element_name 's'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_tables-1.html
+  class ConnectionTables < OOXMLObject
+    define_child_node(RubyXL::ConnectionTable, :collection => :with_count, :accessor => :tables, :node_name => :table)
+    define_element_name 'tables'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_webPr-1.html
+  class WebQueryProperties < OOXMLObject
+    define_attribute(:xml,         :bool, :default => false)
+    define_attribute(:sourceData,  :bool, :default => false)
+    define_attribute(:parsePre,    :bool, :default => false)
+    define_attribute(:consecutive, :bool, :default => false)
+    define_attribute(:firstRow,    :bool, :default => false)
+    define_attribute(:xl97,        :bool, :default => false)
+    define_attribute(:textDates,   :bool, :default => false)
+    define_attribute(:xl2000,      :bool, :default => false)
+    define_attribute(:url,         RubyXL::ST_Xstring)
+    define_attribute(:post,        RubyXL::ST_Xstring)
+    define_attribute(:htmlTables,  :bool, :default => false)
+    define_attribute(:htmlFormat,  ssml:ST_HtmlFmt, :default => "none")
+    define_attribute(:editPage,    RubyXL::ST_Xstring)
+
+    define_child_node(RubyXL::ConnectionTables)
+
+    define_element_name 'webPr'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_textField-1.html
+  class ConnectionTextField < OOXMLObject
+    define_attribute(:type, RubyXL::ST_ExternalConnectionType, :default => "general")
+    define_attribute(:position, :uint, :default => 0)
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_textFields-1.html
+  class ConnectionTextFields < OOXMLObject
+    define_child_node(RubyXL::ConnectionTextField, :collection => :with_count, :accessor => :text_fields, :node_name => :textField)
+
+    define_element_name 'textFields'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_textPr-1.html
+  class TextImportSettings < OOXMLObject
+    define_attribute(:prompt, :bool, :default => true)
+    define_attribute(:fileType,    RubyXL::ST_FileType, :default => "win")
+    define_attribute(:codePage,    :uint, :default => 1252)
+    define_attribute(:firstRow,    :uint, :default => 1)
+    define_attribute(:sourceFile,  RubyXL::ST_Xstring,  :default => "")
+    define_attribute(:delimited,   :bool, :default => true)
+    define_attribute(:decimal,     RubyXL::ST_Xstring,  :default => ".")
+    define_attribute(:thousands,   RubyXL::ST_Xstring,  :default => ",")
+    define_attribute(:tab,         :bool, :default => true)
+    define_attribute(:space,       :bool, :default => false)
+    define_attribute(:comma,       :bool, :default => false)
+    define_attribute(:semicolon,   :bool, :default => false)
+    define_attribute(:consecutive, :bool, :default => false)
+    define_attribute(:qualifier,   ssml:ST_Qualifier, :default => "doubleQuote")
+    define_attribute(:delimiter,   RubyXL::ST_Xstring)
+
+    define_child_node(RubyXL::ConnectionTextFields)
+
+    define_element_name 'textPr'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_parameter-1.html
+  class QueryParameter < OOXMLObject
+    define_attribute(:name,            RubyXL::ST_Xstring)
+    define_attribute(:sqlType,         :int, :default => 0)
+    define_attribute(:parameterType,   RubyXL::ST_ParameterType, :default => "prompt")
+    define_attribute(:refreshOnChange, :bool, :default => false)
+    define_attribute(:prompt,          RubyXL::ST_Xstring)
+    define_attribute(:boolean,         :bool)
+    define_attribute(:double,          :double)
+    define_attribute(:integer,         :int)
+    define_attribute(:string,          RubyXL::ST_Xstring)
+    define_attribute(:cell,            RubyXL::ST_Xstring)
+    define_element_name 'parameter'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_parameters-1.html
+  class QueryParameters < OOXMLObject
+    define_child_node(RubyXL::QueryParameter, :collection => :with_count, :accessor => :parameters, :node_name => :parameter)
+    define_element_name 'parameters'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_connection-1.html
+  class Connection < OOXMLObject
+    define_attribute(:id,                    :uint, :required => true)
+    define_attribute(:sourceFile,            RubyXL::ST_Xstring)
+    define_attribute(:odcFile,               RubyXL::ST_Xstring)
+    define_attribute(:keepAlive,             :bool, :default => false)
+    define_attribute(:interval,              :uint, :default => 0)
+    define_attribute(:name,                  RubyXL::ST_Xstring)
+    define_attribute(:description,           RubyXL::ST_Xstring)
+    define_attribute(:type,                  :uint)
+    define_attribute(:reconnectionMethod,    :uint, :default => 1)
+    define_attribute(:refreshedVersion,      :uint, :required => true)
+    define_attribute(:minRefreshableVersion, :uint, :default => 0)
+    define_attribute(:savePassword,          :bool, :default => false)
+    define_attribute(:new,                   :bool, :default => false)
+    define_attribute(:deleted,               :bool, :default => false)
+    define_attribute(:onlyUseConnectionFile, :bool, :default => false)
+    define_attribute(:background,            :bool, :default => false)
+    define_attribute(:refreshOnLoad,         :bool, :default => false)
+    define_attribute(:saveData,              :bool, :default => false)
+    define_attribute(:credentials,           RubyXL::ST_CredMethod, :default => "integrated")
+    define_attribute(:singleSignOnId,        RubyXL::ST_Xstring)
+
+    define_child_node(RubyXL::OdbcOleDbProperties)
+    define_child_node(RubyXL::OlapProperties)
+    define_child_node(RubyXL::WebQueryProperties)
+    define_child_node(RubyXL::TextImportSettings)
+    define_child_node(RubyXL::QueryParameters)
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'connection'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_connections.html
+  class Connections < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.connections+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/connections'
+
+    define_child_node(RubyXL::Connection, :collection => true, :accessor => :connections)
+
+    define_element_name 'connections'
+
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => nil)
+
+    def xlsx_path
+      ROOT.join('xl', 'connections.xml')
+    end
+  end
+end

data/lib/rubyXL/objects/query_table.rb

@@ -0,0 +1,104 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+require 'rubyXL/objects/extensions'
+require 'rubyXL/objects/relationships'
+require 'rubyXL/objects/sheet_common'
+
+# Query Tables
+# https://msdn.microsoft.com/en-us/library/hh643563(v=office.12).aspx
+
+module RubyXL
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTableField-1.html
+  class QueryTableField < OOXMLObject
+    define_attribute(:id,            :uint, :required => true)
+    define_attribute(:name,          RubyXL::ST_Xstring)
+    define_attribute(:dataBound,     :bool, :default => true)
+    define_attribute(:rowNumbers,    :bool, :default => false)
+    define_attribute(:fillFormulas,  :bool, :default => false)
+    define_attribute(:clipped,       :bool, :default => false)
+    define_attribute(:tableColumnId, :uint, :default => 0)
+
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'queryTableField'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTableFields-1.html
+  class QueryTableFields < OOXMLObject
+    define_child_node(RubyXL::QueryTableField, :collection => :with_count, :accessor => :fields, :node_name => :queryTableField)
+    define_element_name 'queryTableFields'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_deletedField-1.html
+  class QueryTableDeletedField < OOXMLObject
+    define_attribute(:name, RubyXL::ST_Xstring, :required => true)
+
+    define_element_name 'deletedField'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTableDeletedFields-1.html
+  class QueryTableDeletedFields < OOXMLObject
+    define_child_node(RubyXL::QueryTableDeletedField, :collection => :with_count, :accessor => :deleted_fields, :node_name => :deletedField)
+    define_element_name 'queryTableDeletedFields'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTableRefresh-1.html
+  class QueryTableRefresh < OOXMLObject
+    define_attribute(:preserveSortFilterLayout, :bool, :default => true)
+    define_attribute(:fieldIdWrapped,           :bool, :default => false)
+    define_attribute(:headersInLastRefresh,     :bool, :default => true)
+    define_attribute(:minimumVersion,           :uint, :default => 0)
+    define_attribute(:nextId,                   :uint, :default => 1)
+    define_attribute(:unboundColumnsLeft,       :uint, :default => 0)
+    define_attribute(:unboundColumnsRight,      :uint, :default => 0)
+
+    define_child_node(RubyXL::QueryTableFields) # [1..1]
+    define_child_node(RubyXL::QueryTableDeletedFields)
+    define_child_node(RubyXL::SortState)
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'queryTableRefresh'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTable.html
+  class QueryTable < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.queryTable+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/queryTable'
+
+    include RubyXL::RelationshipSupport
+
+    define_attribute(:name,                    RubyXL::ST_Xstring, :required => true)
+    define_attribute(:headers,                 :bool, :default => true)
+    define_attribute(:rowNumbers,              :bool, :default => false)
+    define_attribute(:disableRefresh,          :bool, :default => false)
+    define_attribute(:backgroundRefresh,       :bool, :default => true)
+    define_attribute(:firstBackgroundRefresh,  :bool, :default => false)
+    define_attribute(:refreshOnLoad,           :bool, :default => false)
+    define_attribute(:growShrinkType,          RubyXL::ST_GrowShrinkType, :default => 'insertDelete')
+    define_attribute(:fillFormulas,            :bool, :default => false)
+    define_attribute(:removeDataOnSave,        :bool, :default => false)
+    define_attribute(:disableEdit,             :bool, :default => false)
+    define_attribute(:preserveFormatting,      :bool, :default => true)
+    define_attribute(:adjustColumnWidth,       :bool, :default => true)
+    define_attribute(:intermediate,            :bool, :default => false)
+    define_attribute(:connectionId,            :uint, :required => true)
+    define_attribute(:autoFormatId,            :uint)
+    define_attribute(:applyNumberFormats,      :bool)
+    define_attribute(:applyBorderFormats,      :bool)
+    define_attribute(:applyFontFormats,        :bool)
+    define_attribute(:applyPatternFormats,     :bool)
+    define_attribute(:applyAlignmentFormats,   :bool)
+    define_attribute(:applyWidthHeightFormats, :bool)
+
+    define_child_node(RubyXL::QueryTableRefresh)
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'queryTable'
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => nil,
+                   'http://schemas.openxmlformats.org/officeDocument/2006/relationships' => 'r')
+
+    def xlsx_path
+      ROOT.join('xl', 'queryTables', "queryTable#{file_index}.xml")
+    end
+  end
+end