caxlsx 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ed41402c88039c2627ffba600babaf4891f260c120262d40a8ae2759ca9dca3
-  data.tar.gz: ed7540073afe8febc4435eb3bdf0503843e61ce3edb52c2df22fe79708727a2a
+  metadata.gz: 19ed8a99faeb1aed190458ebbafb65c6e4f9c2a08770ca366f55d2b4279aadf7
+  data.tar.gz: 88714dcfc3922ac44990181d63ade2d555c1f5328e3ed5af7ae0e4c2008f1e46
 SHA512:
-  metadata.gz: 6562cf90cfbf0b9a42012ac225a586e0900486e44930ca5c8ee3e6c3f4c2d3f6d66b8566ac81854f48106bf78732e076ee5cf2771d1cc2ba6abf2cf22dc966e2
-  data.tar.gz: fd1af696b89b4d4a6594e6ef4eb55d98a3170dfa23d9b96bf06de13692b0957bf4c0a329014b2c9be9ca05337845e83bad0b5644c14ac7862eb26ab981f41f7b
+  metadata.gz: bf267db5ffc5b32ac9e0c8a1d17590da46acf8005fdb6dbe2caa94adc46b1fffa8acf8416a8947e503e9dd2b8bed7bb970f01dd82947bb2a01200dfabda11903
+  data.tar.gz: 342555ba2c32d49c896c407be8877b194df97ddfa3a107ccd19ce1950e452983aef0469575bd60f18701cc06e0d8faf34b71b4dd1479909bb2d01a1c8a75fe70

data/CHANGELOG.md

@@ -1,10 +1,5 @@
 CHANGELOG
 ---------
-- **April.1.17**:3.0.0-pre
-  - Support for ruby versions limited to officially supported version
-  - Updates to dependency gems, especially nokogiri and ruby-zip
-  - Patch options parsing for two cell anchor
-  - Remove support for depreciated worksheet members
 - **November.25.12**:1.3.4
   - Support for headers and footers for worksheets
   - bug fix: Properly escape hyperlink urls
@@ -12,7 +7,6 @@ CHANGELOG
   - Improvements in autowidth calculation.
 - **November.8.12**:1.3.3
   - Patched cell run styles for u and validation for family
-
 - **November.5.12**:1.3.2
   - MASSIVE REFACTORING
   - Patch for apostrophes in worksheet names

data/README.md

@@ -2,24 +2,22 @@ Notice: Community Axlsx organization
 ===================================================
 All Axlsx related gems have been forked or moved to a community organization: http://github.com/caxlsx
 * Axlsx
-* acts_as_axlsx
+* acts_as_caxlsx
 * axlsx_rails
-* activeadmin-axlsx
-
-The gems will be released as is as a starting point to allow releases of other gems that depend on these gems. Submit issues as usual. 
+* activeadmin-caxlsx
 
 Please consider helping develop and test these gems.
 
 Axlsx: Office Open XML Spreadsheet Generation
 ====================================
-[![Build Status](https://secure.travis-ci.org/randym/axlsx.svg?branch=master)](http://travis-ci.org/randym/axlsx/)
+[![Build Status](https://travis-ci.com/caxlsx/caxlsx.svg?branch=master)](https://travis-ci.com/caxlsx/caxlsx)
 
 If you are using axlsx for commercial purposes, or just want to show your
 appreciation for the gem, please don't hesitate to make a donation.
 
 **IRC**:[irc.freenode.net / #axlsx](irc://irc.freenode.net/axlsx)
 
-**Git**:[http://github.com/caxlsx/axlsx](http://github.com/randym/axlsx)
+**Git**:[http://github.com/caxlsx/caxlsx](http://github.com/caxlsx/caxlsx)
 
 **Google Group**: [https://groups.google.com/forum/?fromgroups#!forum/axlsx](https://groups.google.com/forum/?fromgroups#!forum/axlsx)
 
@@ -29,9 +27,9 @@ appreciation for the gem, please don't hesitate to make a donation.
 
 **License**: MIT License
 
-**Latest Version**: 3.0.0
+**Latest Version**: 3.0.1
 
-**Ruby Version**: 2.2.7, 2.3.4, 2.4.1
+**Ruby Version**: 2.3.8, 2.4.5, 2.5.3, 2.6.3
 
 **JRuby Version**: 1.9 modes
 
@@ -40,9 +38,9 @@ appreciation for the gem, please don't hesitate to make a donation.
 **Release Date**: September 12th 2013
 
 If you are working in rails, or with active record see:
-[acts_as_xlsx](http://github.com/caxlsx/acts_as_xlsx)
+[acts_as_caxlsx](http://github.com/caxlsx/acts_as_caxlsx)
 
-acts_as_xlsx is a simple ActiveRecord mixin that lets you generate a workbook with:
+acts_as_caxlsx is a simple ActiveRecord mixin that lets you generate a workbook with:
 
 ```ruby
 Posts.where(created_at > Time.now-30.days).to_xlsx
@@ -58,7 +56,7 @@ There are guides for using axlsx and acts_as_xlsx here:
 
 If you are working with ActiveAdmin see:
 
-[activeadmin-axlsx](http://github.com/caxlsx/activeadmin-axlsx)
+[activeadmin-caxlsx](http://github.com/caxlsx/activeadmin-caxlsx)
 
 It provides a plugin and dsl for generating downloadable reports.
 
@@ -127,9 +125,9 @@ Installing
 
 To install Axlsx, use the following command:
 
-    $ gem install axlsx
+    $ gem install caxlsx
 
-#Examples
+Examples
 ------
 
 The example listing is getting overly large to maintain here.
@@ -156,7 +154,7 @@ Please see the [examples](https://github.com/caxlsx/axlsx/tree/master/examples/e
 
 There is much, much more you can do with this gem. If you get stuck, grab me on IRC or submit an issue to GitHub. Chances are that it has already been implemented. If it hasn't - let's take a look at adding it in.
 
-#Documentation
+Documentation
 --------------
 
 This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:
@@ -165,13 +163,25 @@ This gem is 100% documented with YARD, an exceptional documentation library. To
 
      yard server -g
 
-#Specs
+Specs
 ------
 
 This gem has 100% test coverage using test/unit. To execute tests for this gem, simply run rake in the gem directory.
 
-#Change log
+Change log
 ---------
+- **October.4.19**:3.0.1
+  - Support for ruby versions limited to officially supported version
+  - Updates to dependency gems, especially nokogiri and ruby-zip
+  - Fix Relationship.instances cache
+  - Autoload fix for Rails
+- **September.17.19**:3.0.0
+  - First release of caxlsx, fork of axlsx
+- **April.1.17**:3.0.0-pre
+  - Support for ruby versions limited to officially supported version
+  - Updates to dependency gems, especially nokogiri and ruby-zip
+  - Patch options parsing for two cell anchor
+  - Remove support for depreciated worksheet members
 - **
   - Added Cell#name so you you can quickly create a defined name for a single cell in your workbook.
   - Added full book view and sheet state management. This means you can specify how the workbook renders as well as manage sheet visibility.
@@ -251,14 +261,15 @@ related to themes, which axlsx does not implement at this time.
    - charts do not render
 
 
-#Thanks!
+Thanks!
+----------
 
 Open source software is a community effort. None of this could have been
 done without the help of these awesome folks.
 
-[contributors](https://github.com/caxlsx/axlsx/graphs/contributors)
+[contributors](https://github.com/caxlsx/caxlsx/graphs/contributors)
 
-#License
+License
 ----------
 
 Axlsx is licensed under the MIT license. Please see the LICENSE document for more information.

data/lib/axlsx/package.rb

@@ -100,11 +100,13 @@ module Axlsx
     #   File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
     def serialize(output, confirm_valid=false)
       return false unless !confirm_valid || self.validate.empty?
-      Relationship.clear_cached_instances
+      Relationship.initialize_ids_cache
       Zip::OutputStream.open(output) do |zip|
         write_parts(zip)
       end
       true
+    ensure
+      Relationship.clear_ids_cache
     end
 
 
@@ -113,11 +115,13 @@ module Axlsx
     # @return [StringIO|Boolean] False if confirm_valid and validation errors exist. rewound string IO if not.
     def to_stream(confirm_valid=false)
       return false unless !confirm_valid || self.validate.empty?
-      Relationship.clear_cached_instances
+      Relationship.initialize_ids_cache
       zip = write_parts(Zip::OutputStream.new(StringIO.new, true))
       stream = zip.close_buffer
       stream.rewind
       stream
+    ensure
+      Relationship.clear_ids_cache
     end
 
     # Encrypt the package into a CFB using the password provided

data/lib/axlsx/rels/relationship.rb

@@ -5,32 +5,40 @@ module Axlsx
   class Relationship
     
     class << self
-      # Keeps track of all instances of this class.
+      # Keeps track of relationship ids in use.
       # @return [Array]
-      def instances
-        @instances ||= []
+      def ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] ||= {}
       end
-      
-      # Clear cached instances.
+
+      # Initialize cached ids.
       # 
       # This should be called before serializing a package (see {Package#serialize} and
       # {Package#to_stream}) to make sure that serialization is idempotent (i.e. 
       # Relationship instances are generated with the same IDs everytime the package
       # is serialized).
+      def initialize_ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] = {}
+      end
+      
+      # Clear cached ids.
       # 
-      # Also, calling this avoids memory leaks (cached instances lingering around 
+      # This should be called after serializing a package (see {Package#serialize} and
+      # {Package#to_stream}) to free the memory allocated for cache.
+      # 
+      # Also, calling this avoids memory leaks (cached ids lingering around 
       # forever). 
-      def clear_cached_instances
-        @instances = []
+      def clear_ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] = nil
       end
       
       # Generate and return a unique id (eg. `rId123`) Used for setting {#Id}. 
       #
-      # The generated id depends on the number of cached instances, so using
-      # {clear_cached_instances} will automatically reset the generated ids, too.
+      # The generated id depends on the number of previously cached ids, so using
+      # {clear_ids_cache} will automatically reset the generated ids, too.
       # @return [String]
       def next_free_id
-        "rId#{@instances.size + 1}"
+        "rId#{ids_cache.size + 1}"
       end
     end
 
@@ -80,12 +88,7 @@ module Axlsx
       self.Target=target
       self.Type=type
       self.TargetMode = options[:target_mode] if options[:target_mode]
-      @Id = if (existing = self.class.instances.find{ |i| should_use_same_id_as?(i) })
-        existing.Id
-      else
-        self.class.next_free_id
-      end
-      self.class.instances << self
+      @Id = (self.class.ids_cache[ids_cache_key] ||= self.class.next_free_id)
     end
 
     # @see Target
@@ -106,7 +109,7 @@ module Axlsx
       str << '/>'
     end
     
-    # Whether this relationship should use the same id as `other`.
+    # A key that determines whether this relationship should use already generated id.
     #
     # Instances designating the same relationship need to use the same id. We can not simply
     # compare the {#Target} attribute, though: `foo/bar.xml`, `../foo/bar.xml`, 
@@ -116,13 +119,11 @@ module Axlsx
     # then {#Target} will be an absolute URL and thus can safely be compared).
     #
     # @todo Implement comparison of {#Target} based on normalized path names.
-    # @param other [Relationship]
-    def should_use_same_id_as?(other)
-      result = self.source_obj == other.source_obj && self.Type == other.Type && self.TargetMode == other.TargetMode
-      if self.TargetMode == :External
-        result &&= self.Target == other.Target
-      end
-      result
+    # @return [Array]
+    def ids_cache_key
+      key = [source_obj, self.Type, self.TargetMode]
+      key << self.Target if self.TargetMode == :External
+      key
     end
     
   end

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
 module Axlsx
 
   # The current version
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/lib/caxlsx.rb

@@ -0,0 +1,2 @@
+# encoding: UTF-8
+require 'axlsx.rb'

data/test/rels/tc_relationship.rb

@@ -13,6 +13,14 @@ class TestRelationships < Test::Unit::TestCase
     instance = Axlsx::Relationship.new(source_obj, Axlsx::WORKSHEET_R, 'target')
     assert_equal instance.Id, Axlsx::Relationship.new(source_obj, Axlsx::WORKSHEET_R, 'target').Id
   end
+
+  def test_ids_cache_is_thread_safe
+    cache1, cache2 = nil
+    t1 = Thread.new { cache1 = Axlsx::Relationship.ids_cache }
+    t2 = Thread.new { cache2 = Axlsx::Relationship.ids_cache }
+    [t1, t2].each(&:join)
+    assert_not_same(cache1, cache2)
+  end
   
   def test_target_is_only_considered_for_same_attributes_check_if_target_mode_is_external
     source_obj = Object.new

data/test/tc_package.rb

@@ -236,6 +236,8 @@ class TestPackage < Test::Unit::TestCase
     # this is just a roundabout guess for a package as it is build now
     # in testing.
     assert(stream.size > 80000)
+    # Cached ids should be cleared
+    assert(Axlsx::Relationship.ids_cache.empty?)
   end
 
   def test_encrypt

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: caxlsx
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Randy Morgan
 - Jurriaan Pruis
-- Noel Peden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-08 00:00:00.000000000 Z
+date: 2019-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -18,40 +17,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.10.4
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -320,6 +319,7 @@ files:
 - lib/axlsx/workbook/worksheet/worksheet_drawing.rb
 - lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb
 - lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
+- lib/caxlsx.rb
 - lib/schema/dc.xsd
 - lib/schema/dcmitype.xsd
 - lib/schema/dcterms.xsd
@@ -474,7 +474,7 @@ files:
 - test/workbook/worksheet/tc_table_style_info.rb
 - test/workbook/worksheet/tc_worksheet.rb
 - test/workbook/worksheet/tc_worksheet_hyperlink.rb
-homepage: https://github.com/caxlsx/axlsx
+homepage: https://github.com/caxlsx/caxlsx
 licenses:
 - MIT
 metadata: {}
@@ -484,9 +484,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="