xlsxrb 0.1.8 → 0.1.9

data/sig/generated/xlsxrb.rbs

@@ -27,6 +27,15 @@ module Xlsxrb
   class ZipError < Error
   end
 
+  class EncryptedFileError < Error
+  end
+
+  class InvalidPasswordError < EncryptedFileError
+  end
+
+  class DecryptionError < EncryptedFileError
+  end
+
   TRACER: untyped
 
   def self.in_span: (untyped name, ?attributes: untyped) ?{ (?) -> untyped } -> untyped
@@ -290,34 +299,38 @@ module Xlsxrb
   #   puts doc_sheet["A1"].value     # coordinate random access
   #
   # @param source [String, IO] File path, binary content string (starting with PK..), or IO object.
+  # @param password [String, nil] Optional password to decrypt password-protected XLSX files.
   # @yield [sheet] Yields each streaming sheet.
   # @yieldparam sheet [StreamSheet] The streaming worksheet object.
   # @return [Elements::Workbook, void] Returns Elements::Workbook when no block is given.
   # @api public
-  # : (String | IO source) { (StreamSheet) -> void } -> void
-  # : (String | IO source) -> Elements::Workbook
-  def self.read: (String | IO source) { (StreamSheet) -> void } -> void
-               | (String | IO source) -> Elements::Workbook
+  # : (untyped source, ?password: String?) { (StreamSheet) -> void } -> void
+  # : (untyped source, ?password: String?) -> Elements::Workbook
+  def self.read: (untyped source, ?password: String?) { (StreamSheet) -> void } -> void
+               | (untyped source, ?password: String?) -> Elements::Workbook
 
   # Writes an XLSX file or IO stream (streaming or in-memory), or returns a binary string.
   #
-  # @overload write(target, strict_excel_mode: true, &block)
+  # @overload write(target, password: nil, strict_excel_mode: true, &block)
   #   Streaming write: yields a StreamWriter context for high-speed, zero-allocation XLSX generation.
   #   @param target [String, IO] Destination file path or writable IO object.
+  #   @param password [String, nil] Optional password to encrypt the generated XLSX file.
   #   @param strict_excel_mode [Boolean] Whether to enforce Excel specifications.
   #   @yield [stream_writer]
   #   @yieldparam stream_writer [Xlsxrb::StreamWriter]
   #   @return [void]
   #
-  # @overload write(workbook)
+  # @overload write(workbook, password: nil)
   #   In-memory write: exports the workbook to an in-memory binary String.
   #   @param workbook [Elements::Workbook] The workbook to write.
+  #   @param password [String, nil] Optional password to encrypt the binary string.
   #   @return [String] Binary data representing the XLSX file.
   #
-  # @overload write(target, workbook)
+  # @overload write(target, workbook, password: nil)
   #   In-memory write: writes the workbook to a file path or IO stream.
   #   @param target [String, IO] Destination file path or writable IO object.
   #   @param workbook [Elements::Workbook] The workbook to write.
+  #   @param password [String, nil] Optional password to encrypt the output file.
   #   @return [void]
   #
   # @example Streaming write to file
@@ -325,6 +338,11 @@ module Xlsxrb
   #     writer.sheet("Sheet1") { |s| s.row(["Hello", "World"]) }
   #   end
   #
+  # @example Password-protected streaming write
+  #   Xlsxrb.write("protected.xlsx", password: "secret_password") do |writer|
+  #     writer.sheet("Confidential") { |s| s.row(["Private Data", 100]) }
+  #   end
+  #
   # @example In-memory export to binary string
   #   binary_data = Xlsxrb.write(workbook)
   #
@@ -332,12 +350,12 @@ module Xlsxrb
   #   Xlsxrb.write("output.xlsx", workbook)
   #
   # @api public
-  # : (Elements::Workbook workbook) -> String
-  # : (String | IO target, Elements::Workbook workbook) -> void
-  # : (String | IO target, ?strict_excel_mode: bool) ?{ (StreamWriter) -> void } -> void
-  def self.write: (Elements::Workbook workbook) -> String
-                | (String | IO target, Elements::Workbook workbook) -> void
-                | (String | IO target, ?strict_excel_mode: bool) ?{ (StreamWriter) -> void } -> void
+  # : (Elements::Workbook workbook, ?password: String?, ?encryption_mode: Symbol) -> String
+  # : (untyped target, Elements::Workbook | untyped workbook, ?password: String?, ?encryption_mode: Symbol) -> void
+  # : (untyped target_or_workbook, ?Elements::Workbook | untyped workbook_or_nil, ?password: String?, ?encryption_mode: Symbol, ?strict_excel_mode: bool) ?{ (StreamWriter) -> void } -> untyped
+  def self.write: (Elements::Workbook workbook, ?password: String?, ?encryption_mode: Symbol) -> String
+                | (untyped target, Elements::Workbook | untyped workbook, ?password: String?, ?encryption_mode: Symbol) -> void
+                | (untyped target_or_workbook, ?Elements::Workbook | untyped workbook_or_nil, ?password: String?, ?encryption_mode: Symbol, ?strict_excel_mode: bool) ?{ (StreamWriter) -> void } -> untyped
 
   # Modifies an existing XLSX file.
   # Reads the workbook, passes it to the block, and writes the result.
@@ -354,13 +372,14 @@ module Xlsxrb
   #
   # @param source [String, IO] The source file path or IO object.
   # @param target [String, IO, nil] The target file path or IO object. If nil, overwrites source.
+  # @param password [String, nil] Optional password for reading and writing protected files.
   # @yield [workbook] Yields the parsed workbook.
   # @yieldparam workbook [Elements::Workbook] The parsed workbook.
   # @yieldreturn [Elements::Workbook] The modified workbook.
   # @return [void]
   # @api public
-  # : (untyped source, ?untyped target) ?{ (Elements::Workbook) -> untyped } -> void
-  def self.modify: (untyped source, ?untyped target) ?{ (Elements::Workbook) -> untyped } -> void
+  # : (untyped source, ?untyped target, ?password: String?) ?{ (Elements::Workbook) -> untyped } -> void
+  def self.modify: (untyped source, ?untyped target, ?password: String?) ?{ (Elements::Workbook) -> untyped } -> void
 
   # Represents a sheet being streamed sequentially from an XLSX file.
   # Provides O(1) constant-memory streaming over rows and cells.
@@ -401,8 +420,9 @@ module Xlsxrb
     # @return [Enumerator, void]
     # @api public
     # : () { (StreamRow | Elements::Row) -> void } -> void
-    # : | () -> Enumerator[StreamRow | Elements::Row, void]
+    # : () -> Enumerator[StreamRow | Elements::Row, void]
     def each_row: () { (StreamRow | Elements::Row) -> void } -> void
+                | () -> Enumerator[StreamRow | Elements::Row, void]
 
     # Iterate over all cells across rows continuously (O(1) memory).
     #
@@ -411,8 +431,9 @@ module Xlsxrb
     # @return [Enumerator, void]
     # @api public
     # : () { (Elements::Cell) -> void } -> void
-    # : | () -> Enumerator[Elements::Cell, void]
+    # : () -> Enumerator[Elements::Cell, void]
     def each_cell: () { (Elements::Cell) -> void } -> void
+                 | () -> Enumerator[Elements::Cell, void]
 
     # Default Enumerable iteration iterates rows in the streaming sheet.
     #
@@ -421,8 +442,9 @@ module Xlsxrb
     # @return [Enumerator, void]
     # @api public
     # : () { (StreamRow | Elements::Row) -> void } -> void
-    # : | () -> Enumerator[StreamRow | Elements::Row, void]
+    # : () -> Enumerator[StreamRow | Elements::Row, void]
     def each: () { (StreamRow | Elements::Row) -> void } -> void
+            | () -> Enumerator[StreamRow | Elements::Row, void]
 
     # Loads this sheet completely into an in-memory Elements::Worksheet,
     # enabling coordinate random access (sheet["A1"]), row lookups (row_at),

data/vendor/sdk_runner/Program.cs

@@ -46,13 +46,15 @@ async Task<ScenarioExecResult> RunScenario(string code, string xlsxPath)
             typeof(Enumerable).Assembly,
             typeof(Console).Assembly,
             typeof(SpreadsheetDocument).Assembly,
-            typeof(OpenXmlValidator).Assembly
+            typeof(OpenXmlValidator).Assembly,
+            typeof(System.Security.Cryptography.Aes).Assembly
         )
         .AddImports(
             "System",
             "System.IO",
             "System.Linq",
             "System.Collections.Generic",
+            "System.Security.Cryptography",
             "DocumentFormat.OpenXml",
             "DocumentFormat.OpenXml.Packaging",
             "DocumentFormat.OpenXml.Spreadsheet",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xlsxrb
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - niku
@@ -190,6 +190,10 @@ files:
 - lib/xlsxrb/elements/workbook.rb
 - lib/xlsxrb/elements/worksheet.rb
 - lib/xlsxrb/ooxml.rb
+- lib/xlsxrb/ooxml/cfb.rb
+- lib/xlsxrb/ooxml/crypto.rb
+- lib/xlsxrb/ooxml/crypto/agile.rb
+- lib/xlsxrb/ooxml/crypto/standard.rb
 - lib/xlsxrb/ooxml/reader.rb
 - lib/xlsxrb/ooxml/shared_strings_parser.rb
 - lib/xlsxrb/ooxml/styles_parser.rb
@@ -219,6 +223,10 @@ files:
 - sig/generated/xlsxrb/elements/workbook.rbs
 - sig/generated/xlsxrb/elements/worksheet.rbs
 - sig/generated/xlsxrb/ooxml.rbs
+- sig/generated/xlsxrb/ooxml/cfb.rbs
+- sig/generated/xlsxrb/ooxml/crypto.rbs
+- sig/generated/xlsxrb/ooxml/crypto/agile.rbs
+- sig/generated/xlsxrb/ooxml/crypto/standard.rbs
 - sig/generated/xlsxrb/ooxml/reader.rbs
 - sig/generated/xlsxrb/ooxml/shared_strings_parser.rbs
 - sig/generated/xlsxrb/ooxml/styles_parser.rbs