xlsxrb 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8b8c2b9378d329cec5dcc6aed95650308ce816bacce500a11295f920fd2790e
-  data.tar.gz: a9a99158139e0d276d9b8aef63c5eff2bcd6f411c3d3e945eaf645afb9099e37
+  metadata.gz: 305368e1e5925e21411db3a34effb2aa2fb59328bf0aca626762657a7c2291c4
+  data.tar.gz: 6878a769b5ac0aca48a301f7cfbc632f263ff4befb96157c16f4f58bc1ef627e
 SHA512:
-  metadata.gz: 1816c156b76278dafd6d455a66daaf50aacbbad1c77a7b420036581c65d1e6295234ea82cb51374b09f1566dc95c826cb4c8f2a0331c9fce81003103041f9be1
-  data.tar.gz: 4437d72dac46dee22bd2ce6637b71814483e23f40a64b169fc16ef3d12bc12189a22a511aab3f159d7ee57a7d17a44fd8102deb4ba8d5e6dbae294c312cbe12a
+  metadata.gz: a3b70b346fc5481c3242b45ada1135e0a13da6cbf9fd7db2f3a8f084c5560041a0f4187b2b8142da93fd88f12b769f50f6dd4abe75612c6b1fdb0856604721d8
+  data.tar.gz: 5e18aa8c063522115e1320c74d550402cd9020088239b4d3061de2736a50dcab42487e20f1cb7d1e291f8fe31461251ca62703b299d2bb41d83ad1d1c03c79c6

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 ## [Unreleased]
 - No unreleased changes.
 
+## [0.1.7] - 2026-08-16
+
+### Added
+- Bundled native Ruby LSP Add-on (`RubyLsp::Xlsxrb::Addon`) for zero-configuration, context-aware method autocompletion and rich markdown documentation in VS Code and LSP-enabled editors for block arguments (`wb.`, `s.`, `sheet.`, `stream_writer.`, `stream_sheet.`).
+- Comprehensive YARD documentation (`@param`, `@return`, `@example`) across all public APIs, builders, proxies, and elements.
+
+### Developer Experience
+- Enhanced `rbs-inline` type signatures across all facade methods and builder objects with automated RBS generation.
+- Added VS Code Steep extension configuration for Dev Containers.
+
 ## [0.1.6] - 2026-08-15
 
 ### Added

data/README.md

@@ -82,8 +82,8 @@ Generate large files efficiently by writing data directly to the file stream:
 ```ruby
 require "xlsxrb"
 
-Xlsxrb.generate("large_output.xlsx") do |wb|
-  wb.sheet("Sales Data") do |sheet|
+Xlsxrb.generate("large_output.xlsx") do |stream_writer|
+  stream_writer.sheet("Sales Data") do |sheet|
     sheet.row(["Date", "Amount", "Status"])
     sheet.row([Date.today, 100, true])
     sheet.column(0, width: 15.5)
@@ -97,7 +97,7 @@ Read rows one at a time without loading the entire file into memory:
 require "xlsxrb"
 
 Xlsxrb.foreach("large_file.xlsx") do |sheet|
-  sheet.each do |row|
+  sheet.each_row do |row|
     puts "Row #{row.index}: #{row.cells.map(&:value).join(', ')}"
   end
 end
@@ -108,17 +108,17 @@ end
 `xlsxrb` provides a powerful, immutable-by-default API for modifying existing Excel files or building templates in-memory. 
 
 #### Modifying an Existing File
-You can update specific cells or sheets using the functional `Xlsxrb.modify` API, which yields the parsed `Workbook`.
+You can update specific cells or sheets using the functional `Xlsxrb.modify` API, which yields the parsed `Elements::Workbook`.
 
 ```ruby
 require "xlsxrb"
 
-# Create a dummy template.xlsx for this example
-Xlsxrb.build { |w| w.sheet("Invoice") }.write("template.xlsx")
+# Create a template.xlsx for this example
+Xlsxrb.build { |builder| builder.sheet("Invoice") }.write("template.xlsx")
 
-Xlsxrb.modify("template.xlsx", "output.xlsx") do |wb|
-  wb.update_sheet("Invoice") do |sheet|
-    # Update a specific cell
+Xlsxrb.modify("template.xlsx", "output.xlsx") do |workbook|
+  workbook.update_sheet("Invoice") do |sheet|
+    # Update specific cells (returns updated sheet)
     sheet = sheet.update_cell("C4", value: "INV-10042")
     sheet = sheet.update_cell("C5", value: Date.today)
     
@@ -134,16 +134,31 @@ end
 You can directly apply inline styles or use Ranges for multiple columns without boilerplate:
 
 ```ruby
-Xlsxrb.build do |wb|
+Xlsxrb.build do |builder|
   # Use [] accessor for sheets
-  wb["Report"].row(
+  builder["Report"].row(
     ["ID", "Name", "Score", "Rank"],
     # Apply 'header' style to first two columns, and bold inline style to the third
     styles: { 0..1 => "header", 2 => { font: { bold: true, color: "red" } } }
   )
   
   # Set multiple column widths at once using Ranges
-  wb["Report"].column("A".."D", width: 15.0)
+  builder["Report"].column("A".."D", width: 15.0)
+end
+```
+
+### IDE Autocompletion & Ruby LSP Support
+
+`xlsxrb` bundles a native **Ruby LSP Add-on** (`RubyLsp::Xlsxrb::Addon`) and full **RBS signatures**, enabling zero-configuration method autocompletion and rich Markdown documentation in VS Code and other LSP-enabled editors.
+
+Whether you use standard descriptive block variable names (`|stream_writer|`, `|sheet|`, `|workbook|`) or short names (`|wb|`, `|s|`), your editor will automatically provide complete method suggestions and parameter hints:
+
+```ruby
+Xlsxrb.generate("output.xlsx") do |stream_writer| # or |wb|
+  stream_writer.sheet("Data") do |sheet|           # or |s|
+    sheet.row(["Product", "Price"], styles: :bold)
+    sheet.auto_filter("A1:B100")
+  end
 end
 ```
 

data/Steepfile

@@ -2,6 +2,7 @@
 
 target :lib do
   signature "sig"
+  check "lib"
 
   library "date"
   library "time"

data/docs/visual/VisualGallery.md

@@ -1426,6 +1426,14 @@ sheet.rows.each do |row|
 end
 ```
 
+### Console Output
+
+```text
+=== Read Validation ===
+Row 0: A1: "Format" (String), B1: "Value" (String)
+Row 1: A2: "Rich Text Cell" (String), B2: "Normal BOLD RED ITALIC BLUE" (String)
+```
+
 <hr/>
 
 ## Cell Times

data/lib/ruby_lsp/xlsxrb/addon.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "ruby_lsp/addon"
+require_relative "completion_listener"
+require_relative "../../xlsxrb/version"
+
+module RubyLsp
+  module Xlsxrb
+    # Ruby LSP Add-on for xlsxrb.
+    #
+    # [Context & Lifecycle Note]
+    # This add-on serves as a bridge/polyfill for current Ruby LSP environments.
+    # While xlsxrb ships with complete RBS signatures (`sig/generated/`), Ruby LSP's
+    # type inferrer does not yet perform automatic static type inference from method
+    # block signatures to block parameters (e.g., `Xlsxrb.generate do |wb|`).
+    #
+    # This add-on enables immediate out-of-the-box autocompletion and rich Markdown
+    # documentation across all public block arguments.
+    #
+    # As the Ruby tooling ecosystem evolves and Ruby LSP gains native block argument
+    # type resolution from gem RBS signatures in the future, this add-on will become
+    # redundant and can eventually be deprecated or removed.
+    class Addon < ::RubyLsp::Addon
+      def activate(global_state, _message_queue)
+        @global_state = global_state
+      end
+
+      def deactivate; end
+
+      def name
+        "xlsxrb"
+      end
+
+      def version
+        ::Xlsxrb::VERSION
+      end
+
+      def create_completion_listener(response_builder, node_context, dispatcher, _uri = nil)
+        CompletionListener.new(response_builder, node_context, dispatcher, @global_state)
+      end
+    end
+  end
+end