ironcalc 0.7.1.3 → 0.7.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e423d8876c68053cd736a73c1c7b55590cf5acfad0cf6ac34c0e0b2560f16851
-  data.tar.gz: a7c31425bf0270ab1e34cd0ee11ddb582ef9cc194e01ea4aea626de560aa8fc2
+  metadata.gz: e511f58c879d0fdac27a5c4b2d06f424d836bb2c995f4a9562d61bef955f7ea4
+  data.tar.gz: 3761670586bb8ed3518e91d270391e51c1f3f9590a8e5aba5e100791de5446c0
 SHA512:
-  metadata.gz: b3065ab58649278cde300ca74dc6702659c452bd9c35cd962c1f8d65573b717ec8b4eb80536b1abbc39dc2a88c8cd551d204ef25a5c06efad4780d28fe2d4180
-  data.tar.gz: f176d0ddfffd5cff1088e221380c25008d296aeb857129d9e8427133731120b24a6d5f6f1a86d44e3cec035a8f4398017f14ce05c4b1688c1b4739a9eb4b5e4f
+  metadata.gz: 6728ca159b613acd5dbcd604c286b674a9c2903040a78d2bfdbb51273d31be5e77f0942f8f20587299778586c06fc83cf2e7ae0c2f92f7d2e1b70e1ba5f2aeac
+  data.tar.gz: 4e7b42714f19977be65194cd1af3ffadbf1ac370fc2572613f166c84229f29710b95d95baf0b3688a4387a6e519611e81816f0dd29feda48030ba603f2d18944

data/.yardopts

@@ -0,0 +1,11 @@
+--markup markdown
+--main README.md
+--readme README.md
+--output-dir doc
+--no-private
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE-MIT.md
+LICENSE-Apache-2.0.md

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.7.1.5
+
+- link to changelog and documentation in gemspec
+- update actions
+- work-around for yard bug
+
+## 0.7.1.4
+
+- build for Ruby 4.0
+- push with attestation
+- include .yardopts
+
 ## 0.7.1.3
 
 - fix build-provenance and setup github releases

data/README.md

@@ -1,4 +1,4 @@
-# IronCalc Ruby
+# IronCalc for Ruby
 
 Ruby bindings for [IronCalc](https://www.ironcalc.com/), a modern spreadsheet
 engine written in Rust. Create, read and manipulate xlsx files — manage sheets,
@@ -16,7 +16,9 @@ Add this line to your application's Gemfile:
 gem "ironcalc"
 ```
 
-A Rust toolchain is required to build from source.
+On common platforms (Linux, macOS, Windows) a precompiled gem is installed, so
+no Rust toolchain is required. On other platforms the gem builds the IronCalc
+engine from source, which requires a Rust toolchain.
 
 ## Usage
 
@@ -25,7 +27,7 @@ require "ironcalc"
 
 # Raw API — call evaluate yourself.
 model = IronCalc.create("model", "en", "UTC", "en")
-model.set_user_input(0, 1, 1, "=21*2")
+model.set_user_input(0, 1, 1, "=6*7")
 model.evaluate
 model.get_formatted_cell_value(0, 1, 1) # => "42"
 model.save_to_xlsx("out.xlsx")
@@ -67,7 +69,7 @@ via **pyo3**, Ruby via **magnus** / **rb-sys**) exposing a module named
   `create_user_model_from_bytes`.
 - **Method names and signatures** on `Model` / `UserModel` — `set_user_input`,
   `get_formatted_cell_value`, `evaluate`, `insert_rows`, `set_column_width`,
-  `add_sheet`, `save_to_xlsx`, `to_bytes`, … (Python's `snake_case` is also
+  `new_sheet`, `save_to_xlsx`, `to_bytes`, … (Python's `snake_case` is also
   Ruby's convention, so they match exactly).
 - **Coordinates**: `sheet` is a 0-based index; `row` and `column` are 1-based.
 - **Semantics**: the same engine, so the same inputs produce the same results.
@@ -76,7 +78,7 @@ via **pyo3**, Ruby via **magnus** / **rb-sys**) exposing a module named
 # Python
 import ironcalc as ic
 model = ic.create("model", "en", "UTC", "en")
-model.set_user_input(0, 1, 1, "=21*2")
+model.set_user_input(0, 1, 1, "=6*7")
 model.evaluate()
 model.get_formatted_cell_value(0, 1, 1)   # "42"
 ```
@@ -85,7 +87,7 @@ model.get_formatted_cell_value(0, 1, 1)   # "42"
 # Ruby
 require "ironcalc"
 model = IronCalc.create("model", "en", "UTC", "en")
-model.set_user_input(0, 1, 1, "=21*2")
+model.set_user_input(0, 1, 1, "=6*7")
 model.evaluate
 model.get_formatted_cell_value(0, 1, 1)   # "42"
 ```
@@ -103,21 +105,13 @@ ports:
 | Cell type | `CellType` enum | `Symbol` (`:number`, `:text`, …) |
 | Worksheet properties | list of `SheetProperty` objects | array of `Hash`es (`:name`, `:state`, `:sheet_id`, `:color`) |
 | Sheet dimensions | tuple `(min_row, max_row, min_col, max_col)` | 4-element `Array` |
-| Binary blobs | `bytes` | binary `String` |
+| Binary data | `bytes` | binary `String` |
 | Version | `ironcalc.__version__` | `IronCalc::VERSION` |
 
 Rather than reconstruct Python's per-field style classes, Ruby exchanges styles
 as plain hashes (serialized as JSON across the boundary). Everything else is kept
 as close to the Python bindings as the two languages allow.
 
-## Development
-
-```sh
-bundle install
-bundle exec rake compile
-bundle exec rake test
-```
-
 ## License
 
 Dual-licensed under [MIT](LICENSE-MIT.md) or [Apache-2.0](LICENSE-Apache-2.0.md),

data/lib/ironcalc/native_methods.rb

@@ -275,6 +275,11 @@ module IronCalc
     #   @param sheet [Integer]
     #   @return [Array(Integer, Integer, Integer, Integer)]
     #   @raise [IronCalc::Error]
+
+    # Without a real def, the @!method stubs above leak to the IronCalc module
+    # (yardoc bug lsegal/yard#1207). Doc-only file, never loaded at runtime.
+    # @!visibility private
+    def __yard_anchor__; end
   end
 
   # The recommended, higher-level IronCalc API. Auto-evaluates after every action
@@ -497,5 +502,9 @@ module IronCalc
     #   @param sheet [Integer]
     #   @return [Array(Integer, Integer, Integer, Integer)]
     #   @raise [IronCalc::Error]
+
+    # Anchors the @!method stubs above — see {Model}.
+    # @!visibility private
+    def __yard_anchor__; end
   end
 end

data/lib/ironcalc/version.rb

@@ -1,3 +1,3 @@
 module IronCalc
-  VERSION = "0.7.1.3"
+  VERSION = "0.7.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ironcalc
 version: !ruby/object:Gem::Version
-  version: 0.7.1.3
+  version: 0.7.1.5
 platform: ruby
 authors:
 - jvdp
@@ -33,6 +33,7 @@ extensions:
 - ext/ironcalc/extconf.rb
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - Cargo.lock
 - Cargo.toml
@@ -56,6 +57,8 @@ metadata:
   homepage_uri: https://www.ironcalc.com/
   source_code_uri: https://github.com/jvdp/IronCalc-Ruby
   bug_tracker_uri: https://github.com/jvdp/IronCalc-Ruby/issues
+  changelog_uri: https://raw.githubusercontent.com/jvdp/IronCalc-Ruby/refs/heads/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/ironcalc/
 rdoc_options: []
 require_paths:
 - lib