caxlsx 3.4.1 → 4.1.0

data/lib/axlsx/stylesheet/xf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The Xf class defines a formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style
   # @see Styles#add_style
@@ -93,51 +95,104 @@ module Axlsx
     attr_reader :applyProtection
 
     # @see Xf#alignment
-    def alignment=(v) DataTypeValidator.validate "Xf.alignment", CellAlignment, v; @alignment = v end
+    def alignment=(v)
+      DataTypeValidator.validate "Xf.alignment", CellAlignment, v
+      @alignment = v
+    end
 
     # @see protection
-    def protection=(v) DataTypeValidator.validate "Xf.protection", CellProtection, v; @protection = v end
+    def protection=(v)
+      DataTypeValidator.validate "Xf.protection", CellProtection, v
+      @protection = v
+    end
 
     # @see numFmtId
-    def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end
+    def numFmtId=(v)
+      Axlsx.validate_unsigned_int v
+      @numFmtId = v
+    end
 
     # @see fontId
-    def fontId=(v) Axlsx::validate_unsigned_int v; @fontId = v end
+    def fontId=(v)
+      Axlsx.validate_unsigned_int v
+      @fontId = v
+    end
+
     # @see fillId
-    def fillId=(v) Axlsx::validate_unsigned_int v; @fillId = v end
+    def fillId=(v)
+      Axlsx.validate_unsigned_int v
+      @fillId = v
+    end
+
     # @see borderId
-    def borderId=(v) Axlsx::validate_unsigned_int v; @borderId = v end
+    def borderId=(v)
+      Axlsx.validate_unsigned_int v
+      @borderId = v
+    end
+
     # @see xfId
-    def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
+    def xfId=(v)
+      Axlsx.validate_unsigned_int v
+      @xfId = v
+    end
+
     # @see quotePrefix
-    def quotePrefix=(v) Axlsx::validate_boolean v; @quotePrefix = v end
+    def quotePrefix=(v)
+      Axlsx.validate_boolean v
+      @quotePrefix = v
+    end
+
     # @see pivotButton
-    def pivotButton=(v) Axlsx::validate_boolean v; @pivotButton = v end
+    def pivotButton=(v)
+      Axlsx.validate_boolean v
+      @pivotButton = v
+    end
+
     # @see applyNumberFormat
-    def applyNumberFormat=(v) Axlsx::validate_boolean v; @applyNumberFormat = v end
+    def applyNumberFormat=(v)
+      Axlsx.validate_boolean v
+      @applyNumberFormat = v
+    end
+
     # @see applyFont
-    def applyFont=(v) Axlsx::validate_boolean v; @applyFont = v end
+    def applyFont=(v)
+      Axlsx.validate_boolean v
+      @applyFont = v
+    end
+
     # @see applyFill
-    def applyFill=(v) Axlsx::validate_boolean v; @applyFill = v end
+    def applyFill=(v)
+      Axlsx.validate_boolean v
+      @applyFill = v
+    end
 
     # @see applyBorder
-    def applyBorder=(v) Axlsx::validate_boolean v; @applyBorder = v end
+    def applyBorder=(v)
+      Axlsx.validate_boolean v
+      @applyBorder = v
+    end
 
     # @see applyAlignment
-    def applyAlignment=(v) Axlsx::validate_boolean v; @applyAlignment = v end
+    def applyAlignment=(v)
+      Axlsx.validate_boolean v
+      @applyAlignment = v
+    end
 
     # @see applyProtection
-    def applyProtection=(v) Axlsx::validate_boolean v; @applyProtection = v end
+    def applyProtection=(v)
+      Axlsx.validate_boolean v
+      @applyProtection = v
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<xf '
       serialized_attributes str
       str << '>'
-      alignment.to_xml_string(str) if self.alignment
-      protection.to_xml_string(str) if self.protection
+      alignment.to_xml_string(str) if alignment
+      protection.to_xml_string(str) if protection
       str << '</xf>'
     end
   end

data/lib/axlsx/util/accessors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # This module defines some of the more common validating attribute
   # accessors that we use in Axlsx
@@ -42,19 +44,21 @@ module Axlsx
         validated_attr_accessor(symbols, :validate_boolean)
       end
 
-      # Template for defining validated write accessors
-      SETTER = "def %s=(value) Axlsx::%s(value); @%s = value; end".freeze
-
       # Creates the reader and writer access methods
-      # @param [Array] symbols The names of the attributes to create
-      # @param [String] validator The axlsx validation method to use when
+      # @param [Array<Symbol, String>] symbols The names of the attributes to create
+      # @param [Symbol|String] validator The axlsx validation method to use when
       # validating assignation.
       # @see lib/axlsx/util/validators.rb
       def validated_attr_accessor(symbols, validator)
         symbols.each do |symbol|
           attr_reader symbol
 
-          module_eval(SETTER % [symbol, validator, symbol], __FILE__, __LINE__)
+          module_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+            def #{symbol}=(value)      # def name=(value)
+              Axlsx.#{validator} value #   Axlsx.validate_string value
+              @#{symbol} = value       #   @name = value
+            end                        # end
+          RUBY_EVAL
         end
       end
     end

data/lib/axlsx/util/buffered_zip_output_stream.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Axlsx
+  # The BufferedZipOutputStream buffers the output in order to avoid appending many small strings directly to the
+  # the `Zip::OutputStream`.
+  #
+  # The methods provided here mimic `Zip::OutputStream` so that this class can be used a drop-in replacement.
+  class BufferedZipOutputStream
+    # The 4_096 was chosen somewhat arbitrary, however, it was difficult to see any obvious improvement with larger
+    # buffer sizes.
+    BUFFER_SIZE = 4_096
+
+    def initialize(zos)
+      @zos = zos
+      @buffer = String.new(capacity: BUFFER_SIZE * 2)
+    end
+
+    # Create a temporary directory for writing files to.
+    #
+    # The directory and its contents are removed at the end of the block.
+    def self.open(file_name, encrypter = nil)
+      Zip::OutputStream.open(file_name, encrypter) do |zos|
+        bzos = new(zos)
+        yield(bzos)
+      ensure
+        bzos.flush if bzos
+      end
+    end
+
+    def self.write_buffer(io = ::StringIO.new, encrypter = nil)
+      Zip::OutputStream.write_buffer(io, encrypter) do |zos|
+        bzos = new(zos)
+        yield(bzos)
+      ensure
+        bzos.flush if bzos
+      end
+    end
+
+    # Closes the current entry and opens a new for writing.
+    def put_next_entry(entry)
+      flush
+      @zos.put_next_entry(entry)
+    end
+
+    # Write to a buffer that will be written to the current entry
+    def write(content)
+      @buffer << content.to_s
+      flush if @buffer.size > BUFFER_SIZE
+      self
+    end
+    alias << write
+
+    def flush
+      return if @buffer.empty?
+
+      @zos << @buffer
+      @buffer.clear
+    end
+  end
+end