anydoc-ruby 0.1.7 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b73a92386a7dc619a85892686d5fb139df873bd2c762be8e78c29f602261e405
-  data.tar.gz: 694607679a045c2599469b6b499c8970aa4963134364b9aebf1904a321518f50
+  metadata.gz: a2086cb8f0c30c724ca64d4d5aeb00072189a51357edfb881709de9af72217cf
+  data.tar.gz: e35914998d4551c7d708804e6160f8b71d843cb06ec0c0ad1aced211798a4b3e
 SHA512:
-  metadata.gz: 6fef910cd6101ca804b3e6d58b3fbcd4cb6250238349d0b0c387c57e040ed4a4d141e1f8b6814790847d7e070e01ac550547ed43b144ca4e7dc1a4b2ddc8e9ce
-  data.tar.gz: 736c2870384cf448e7fc504e328ce835ac1b255bd6f09fff10011ba6a63b6852b544d6af9643bfa2088d15d80ae6c1c793b2019dedbbbaf3fb3864d29738e71f
+  metadata.gz: 66306a144c36a1bf378f98f0555de76d203c316b396ca60da5ce476d83f3ba46be47e225d276dc6295e053daba7f35572c8889a3dddc3f89515fe0bb4b1d6251
+  data.tar.gz: 3fd87984463be1fa6ecc379288a3b0e2f05e7768b45f7a811df0b682c5772e6826a7d3a238622db3031a9dea44dc0f0efcf83988bb579f28267f25a5bab738ae

data/README.md

@@ -144,6 +144,18 @@ bundle exec rake gems:all            # the source gem and all seven platforms
 
 Run these through Rake rather than calling `rb-sys-dock` from this directory: the container mounts the shell's working directory, and the build needs the crate one level above it, so the tasks run the CLI from the repository root with `--directory ruby`. The first build of each platform pulls a multi-gigabyte image.
 
+### Releasing
+
+The gem version tracks the version of the crate it wraps, so a release starts from a crate version bump:
+
+1. Bump `lib/anydoc/version.rb` and the `anydoc` dependency in `ext/anydoc/Cargo.toml` to the crate's version.
+2. `sh scripts/check-versions.sh` from the repository root, which fails unless all seven version locations agree.
+3. Tag `ruby-v<version>` and push it.
+
+The tag runs [`.github/workflows/release-ruby.yml`](../.github/workflows/release-ruby.yml), which cross-compiles every platform gem, installs and tests each one, pushes them through RubyGems trusted publishing, and attaches them to a GitHub release. A `workflow_dispatch` run does everything except publish.
+
+Because the versions are locked together, a fix that touches only the bindings waits for the next crate release. Shipping one sooner means relaxing the version gate for that release.
+
 ## License
 
 [MIT](https://github.com/honzasterba/anydoc/blob/main/LICENSE)

data/ext/anydoc/Cargo.toml

@@ -16,7 +16,7 @@ crate-type = ["cdylib"]
 # From crates.io, so an installed source gem builds anywhere. Builds inside
 # this repository redirect it to the local crate through ruby/.cargo/config.toml,
 # and scripts/check-versions.sh keeps this requirement on the release version.
-anydoc = "0.1.7"
+anydoc = "0.2.3"
 magnus = "0.8"
 # For rb_thread_call_without_gvl; magnus resolves to the same major version.
 rb-sys = "0.9"

data/ext/anydoc/src/document.rs

@@ -95,6 +95,7 @@ impl Build<'_> {
                 BlockFields { lang, text: Some(text), ..BlockFields::of("code_block") }
             }
             model::Block::Rule => BlockFields::of("rule"),
+            model::Block::Math(tex) => BlockFields { text: Some(tex), ..BlockFields::of("math") },
         };
         self.classes.block.funcall(
             "new",
@@ -136,6 +137,12 @@ impl Build<'_> {
                 InlineFields { note_id: Some(id), ..InlineFields::of("note_ref") }
             }
             model::Inline::LineBreak => InlineFields::of("line_break"),
+            model::Inline::Math(tex) => {
+                InlineFields { text: Some(tex), ..InlineFields::of("math") }
+            }
+            model::Inline::Checkbox(checked) => {
+                InlineFields { checked: Some(checked), ..InlineFields::of("checkbox") }
+            }
         };
         self.classes.inline.funcall(
             "new",
@@ -149,6 +156,7 @@ impl Build<'_> {
                 fields.source,
                 fields.anchor,
                 fields.note_id,
+                fields.checked,
             ),
         )
     }
@@ -190,7 +198,7 @@ impl Build<'_> {
 
     fn list_item(&self, item: model::ListItem) -> Result<Value, Error> {
         let blocks = self.array(item.blocks, Self::block)?;
-        self.classes.list_item.funcall("new", (blocks, item.checked, item.marker_label))
+        self.classes.list_item.funcall("new", (blocks, item.marker_label))
     }
 
     fn table(&self, table: model::Table) -> Result<Value, Error> {
@@ -291,6 +299,7 @@ struct InlineFields {
     source: Option<Value>,
     anchor: Option<String>,
     note_id: Option<String>,
+    checked: Option<bool>,
 }
 
 impl InlineFields {
@@ -305,6 +314,7 @@ impl InlineFields {
             source: None,
             anchor: None,
             note_id: None,
+            checked: None,
         }
     }
 }

data/lib/anydoc/document.rb

@@ -32,7 +32,7 @@ module Anydoc
   #
   # @!attribute [r] kind
   #   @return [Symbol] +:heading+, +:paragraph+, +:list+, +:table+,
-  #     +:block_quote+, +:code_block+, or +:rule+.
+  #     +:block_quote+, +:code_block+, +:rule+, or +:math+.
   # @!attribute [r] level
   #   @return [Integer, nil] heading: 1-6.
   # @!attribute [r] anchor
@@ -49,7 +49,8 @@ module Anydoc
   # @!attribute [r] lang
   #   @return [String, nil] code_block.
   # @!attribute [r] text
-  #   @return [String, nil] code_block.
+  #   @return [String, nil] code_block, math (LaTeX source without
+  #     delimiters).
   class Block < Data.define(
     :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
   )
@@ -59,10 +60,10 @@ module Anydoc
   #
   # @!attribute [r] kind
   #   @return [Symbol] +:text+, +:link+, +:image+, +:anchor+ (a zero-width
-  #     marker for an internal link target at this position), +:note_ref+, or
-  #     +:line_break+.
+  #     marker for an internal link target at this position), +:note_ref+,
+  #     +:line_break+, +:math+, or +:checkbox+.
   # @!attribute [r] text
-  #   @return [String, nil] text.
+  #   @return [String, nil] text; math (LaTeX source without delimiters).
   # @!attribute [r] style
   #   @return [Style, nil] text.
   # @!attribute [r] content
@@ -78,8 +79,11 @@ module Anydoc
   # @!attribute [r] note_id
   #   @return [String, nil] note_ref: the id of the note in
   #     {Document#notes}.
+  # @!attribute [r] checked
+  #   @return [Boolean, nil] checkbox: its state.
   class Inline < Data.define(
-    :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
+    :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id,
+    :checked
   )
   end
 
@@ -141,14 +145,11 @@ module Anydoc
   #
   # @!attribute [r] blocks
   #   @return [Array<Block>]
-  # @!attribute [r] checked
-  #   @return [Boolean, nil] task-list state, when the item carries a
-  #     checkbox.
   # @!attribute [r] marker_label
   #   @return [String, nil] literal marker text that overrides the list marker
   #     when the source number text cannot be reproduced from the marker and
   #     position alone (composite number text such as +1-a)+).
-  class ListItem < Data.define(:blocks, :checked, :marker_label)
+  class ListItem < Data.define(:blocks, :marker_label)
   end
 
   # A table as a canonical grid: every logical grid position appears exactly

data/lib/anydoc/version.rb

@@ -2,5 +2,5 @@
 
 module Anydoc
   # The gem version, which is the version of the anydoc crate it wraps.
-  VERSION = "0.1.7"
+  VERSION = "0.2.3"
 end

data/sig/anydoc.rbs

@@ -61,7 +61,7 @@ module Anydoc
   end
 
   class Block < ::Data
-    # :heading | :paragraph | :list | :table | :block_quote | :code_block | :rule
+    # :heading | :paragraph | :list | :table | :block_quote | :code_block | :rule | :math
     attr_reader kind: Symbol
     attr_reader level: Integer?
     attr_reader anchor: String?
@@ -74,7 +74,7 @@ module Anydoc
   end
 
   class Inline < ::Data
-    # :text | :link | :image | :anchor | :note_ref | :line_break
+    # :text | :link | :image | :anchor | :note_ref | :line_break | :math | :checkbox
     attr_reader kind: Symbol
     attr_reader text: String?
     attr_reader style: Style?
@@ -84,6 +84,7 @@ module Anydoc
     attr_reader source: ImageSource?
     attr_reader anchor: String?
     attr_reader note_id: String?
+    attr_reader checked: bool?
   end
 
   class Style < ::Data
@@ -122,7 +123,6 @@ module Anydoc
 
   class ListItem < ::Data
     attr_reader blocks: Array[Block]
-    attr_reader checked: bool?
     attr_reader marker_label: String?
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: anydoc-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.3
 platform: ruby
 authors:
 - Jan Sterba
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Convert documents (doc, docx, odt, rtf, epub, pdf, presentations, spreadsheets,
   csv) to GitHub-Flavored Markdown