inkpen 0.9.2 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92089e260ac3068e3e269e864d4ec9f0294447bbb4e28764f02f5c722debc155
-  data.tar.gz: 1b824dd56c5ccd3f1c448cf841ea53db2660617f14a6b4fe5a41ee9b20f15f7e
+  metadata.gz: a928ec9dfc4d7e10782b6b51c17ee58487f13057ef6b5efa1bdb2c39858f292a
+  data.tar.gz: d9bd76686b1dfe78f494c7d79d5d723f708b964a568439334199dd18f0424f41
 SHA512:
-  metadata.gz: 5d6ceb94d0867ab0b0a5194f6a1468454c1ef8b6782b94cd62ce469a15667ca04ad3c764681130c1e148cc823ef0b8cdd770a0822a01ffb402be632300869ce0
-  data.tar.gz: 9420e9694ce248bec30176e60e26a3521749a1e7b5463ba14423a58b87df6b18b40a82b82ff5ab9aa1f9146637f8330e32f1abb309744ca89d09346deaa28e89
+  metadata.gz: 0e5254caa121d60d922fec39e797780f6d4e3eeee2ed979f1debc3a58e436df063a5818b04e4c050e6600cd6de60f7fcf30fad83b9585e7e437b3c86a45161bb
+  data.tar.gz: 3d0be135fbc285b521ca490113fb988390ee8a2ca9349c8d3ebe7140ca5f9647adf94c27716b1a124103b0838ce8559fbe43249e336a5b0901413569c55b0cab

data/.rubocop.yml

@@ -1,5 +1,23 @@
 AllCops:
   TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
+
+# Releases use the repository-scoped RUBYGEMS_API_KEY managed by GitHub Actions.
+Gemspec/RequireMFA:
+  Enabled: false
+
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*"
+
+Metrics/AbcSize:
+  Exclude:
+    - "test/**/*"
+
+Metrics/MethodLength:
+  Exclude:
+    - "test/**/*"
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/app/helpers/inkpen/editor_helper.rb

@@ -47,18 +47,9 @@ module Inkpen
     #   <%= inkpen_field :post, :body, extensions: [:mentions, :hashtags] %>
     #
     def inkpen_field(object_name, method, options = {})
-      value = options.delete(:value)
-
-      # Try to get value from object if not provided
-      if value.nil? && (object = instance_variable_get("@#{object_name}"))
-        value = object.public_send(method) if object.respond_to?(method)
-      end
-
-      name = "#{object_name}[#{method}]"
-
       editor = Inkpen::Editor.new(
-        name: name,
-        value: value,
+        name: "#{object_name}[#{method}]",
+        value: inkpen_field_value(object_name, method, options.delete(:value)),
         **options
       )
 
@@ -110,5 +101,12 @@ module Inkpen
     def render_inkpen_editor(editor)
       render partial: "inkpen/editor", locals: { editor: editor }
     end
+
+    def inkpen_field_value(object_name, method, explicit_value)
+      return explicit_value unless explicit_value.nil?
+
+      object = instance_variable_get("@#{object_name}")
+      object.public_send(method) if object.respond_to?(method)
+    end
   end
 end

data/config/importmap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Inkpen importmap — single vendored bundle, no third-party CDN.
 #
 # Before 0.8.0 this file pinned ~70 modules to a third-party module CDN.

data/docs/CHANGELOG.md

@@ -11,6 +11,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [0.9.4] - 2026-10-09
+
+### Changed
+- Removed the gem-level MFA publishing requirement so the existing repository-scoped RubyGems API key can publish releases from CI.
+- Restored the established API-key release workflow used by the other maintained gems; runtime editor behavior is unchanged.
+
+---
+
+## [0.9.3] - 2026-10-09
+
+### Fixed
+- Restored a green Ruby CI baseline by explicitly enabling new RuboCop cops and resolving the existing offenses without changing the editor's public behavior.
+- Added characterization coverage for editor initialization, data attributes, and model-bound field values so future refactors cannot silently change the Rails integration contract.
+
+---
+
 ## [0.9.2] - 2026-07-11
 
 ### Fixed

data/lib/inkpen/editor.rb

@@ -102,17 +102,9 @@ module Inkpen
     def initialize(name:, value: nil, **options)
       @name = name
       @value = value
-      @toolbar = options.fetch(:toolbar, Inkpen.configuration.toolbar)
-      @sticky_toolbar = options.fetch(:sticky_toolbar, nil)
-      @markdown_mode = options.fetch(:markdown_mode, nil)
-      @extensions = options.fetch(:extensions, Inkpen.configuration.extensions)
-      @extension_config = options.fetch(:extension_config, {})
-      @placeholder = options.fetch(:placeholder, Inkpen.configuration.placeholder)
-      @autosave = options.fetch(:autosave, Inkpen.configuration.autosave)
-      @autosave_interval = options.fetch(:autosave_interval, Inkpen.configuration.autosave_interval)
-      @min_height = options.fetch(:min_height, Inkpen.configuration.min_height)
-      @max_height = options.fetch(:max_height, Inkpen.configuration.max_height)
-      @html_attributes = options.fetch(:html, {})
+      assign_interface_options(options)
+      assign_behavior_options(options)
+      assign_dimension_options(options)
     end
 
     ##
@@ -124,32 +116,7 @@ module Inkpen
     # @return [Hash] data attributes hash
     #
     def data_attributes
-      controllers = ["inkpen--editor"]
-      controllers << "inkpen--sticky-toolbar" if sticky_toolbar&.enabled?
-
-      attrs = {
-        data: {
-          controller: controllers.join(" "),
-          "inkpen--editor-extensions-value" => extensions.to_json,
-          "inkpen--editor-extension-config-value" => extension_config.to_json,
-          "inkpen--editor-toolbar-value" => toolbar.to_s,
-          "inkpen--editor-placeholder-value" => placeholder,
-          "inkpen--editor-autosave-value" => autosave.to_s,
-          "inkpen--editor-autosave-interval-value" => autosave_interval.to_s
-        }
-      }
-
-      # Merge sticky toolbar data attributes if enabled
-      if sticky_toolbar&.enabled?
-        attrs[:data].merge!(sticky_toolbar.data_attributes)
-      end
-
-      # Merge markdown mode data attributes if enabled
-      if markdown_mode&.enabled?
-        attrs[:data].merge!(markdown_mode.data_attributes)
-      end
-
-      attrs
+      { data: editor_data_attributes.merge(optional_data_attributes) }
     end
 
     ##
@@ -200,5 +167,53 @@ module Inkpen
     def input_id
       name.to_s.gsub(/[\[\]]/, "_").gsub(/_+/, "_").chomp("_")
     end
+
+    private
+
+    def assign_interface_options(options)
+      @toolbar = options.fetch(:toolbar, Inkpen.configuration.toolbar)
+      @sticky_toolbar = options.fetch(:sticky_toolbar, nil)
+      @markdown_mode = options.fetch(:markdown_mode, nil)
+      @extensions = options.fetch(:extensions, Inkpen.configuration.extensions)
+      @extension_config = options.fetch(:extension_config, {})
+      @placeholder = options.fetch(:placeholder, Inkpen.configuration.placeholder)
+    end
+
+    def assign_behavior_options(options)
+      @autosave = options.fetch(:autosave, Inkpen.configuration.autosave)
+      @autosave_interval = options.fetch(:autosave_interval, Inkpen.configuration.autosave_interval)
+    end
+
+    def assign_dimension_options(options)
+      @min_height = options.fetch(:min_height, Inkpen.configuration.min_height)
+      @max_height = options.fetch(:max_height, Inkpen.configuration.max_height)
+      @html_attributes = options.fetch(:html, {})
+    end
+
+    def editor_data_attributes
+      {
+        controller: editor_controllers.join(" "),
+        "inkpen--editor-extensions-value" => extensions.to_json,
+        "inkpen--editor-extension-config-value" => extension_config.to_json,
+        "inkpen--editor-toolbar-value" => toolbar.to_s,
+        "inkpen--editor-placeholder-value" => placeholder,
+        "inkpen--editor-autosave-value" => autosave.to_s,
+        "inkpen--editor-autosave-interval-value" => autosave_interval.to_s
+      }
+    end
+
+    def editor_controllers
+      controllers = ["inkpen--editor"]
+      controllers << "inkpen--sticky-toolbar" if sticky_toolbar&.enabled?
+      controllers
+    end
+
+    def optional_data_attributes
+      attributes = {}
+      attributes.merge!(sticky_toolbar.data_attributes) if sticky_toolbar&.enabled?
+      attributes.merge!(markdown_mode.data_attributes) if markdown_mode&.enabled?
+
+      attributes
+    end
   end
 end

data/lib/inkpen/engine.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Inkpen
+  # Rails integration for Inkpen assets, import maps, and view helpers.
   class Engine < ::Rails::Engine
     isolate_namespace Inkpen
 

data/lib/inkpen/extensions/code_block_syntax.rb

@@ -147,6 +147,8 @@ module Inkpen
       #
       # @return [Hash] configuration for the TipTap extension
       #
+      # Declarative JavaScript extension configuration is clearest as one hash.
+      # rubocop:disable Metrics/MethodLength
       def to_config
         {
           languages: languages,
@@ -160,6 +162,7 @@ module Inkpen
           }
         }
       end
+      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/inkpen/extensions/document_section.rb

@@ -70,7 +70,7 @@ module Inkpen
       #
       def max_depth
         depth = options.fetch(:max_depth, DEFAULT_MAX_DEPTH)
-        [[depth, 1].max, 3].min # Clamp between 1 and 3
+        depth.clamp(1, 3)
       end
 
       ##

data/lib/inkpen/extensions/forced_document.rb

@@ -142,6 +142,8 @@ module Inkpen
       #
       # @return [Hash] configuration for the TipTap extension
       #
+      # Declarative JavaScript extension configuration is clearest as one hash.
+      # rubocop:disable Metrics/MethodLength
       def to_config
         config = {
           titleLevel: title_level,
@@ -164,6 +166,7 @@ module Inkpen
 
         config
       end
+      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/inkpen/extensions/slash_commands.rb

@@ -28,30 +28,46 @@ module Inkpen
       # Default command set matching Notion/Paper experience
       DEFAULT_COMMANDS = [
         # Text blocks
-        { name: "paragraph", label: "Text", description: "Plain text block", icon: "text", group: "Basic", shortcut: nil },
-        { name: "heading1", label: "Heading 1", description: "Large heading", icon: "h1", group: "Basic", shortcut: "#" },
-        { name: "heading2", label: "Heading 2", description: "Medium heading", icon: "h2", group: "Basic", shortcut: "##" },
-        { name: "heading3", label: "Heading 3", description: "Small heading", icon: "h3", group: "Basic", shortcut: "###" },
+        { name: "paragraph", label: "Text", description: "Plain text block", icon: "text", group: "Basic",
+          shortcut: nil },
+        { name: "heading1", label: "Heading 1", description: "Large heading", icon: "h1", group: "Basic",
+          shortcut: "#" },
+        { name: "heading2", label: "Heading 2", description: "Medium heading", icon: "h2", group: "Basic",
+          shortcut: "##" },
+        { name: "heading3", label: "Heading 3", description: "Small heading", icon: "h3", group: "Basic",
+          shortcut: "###" },
 
         # Lists
-        { name: "bullet_list", label: "Bullet List", description: "Unordered list", icon: "list", group: "Lists", shortcut: "-" },
-        { name: "ordered_list", label: "Numbered List", description: "Ordered list", icon: "list-ordered", group: "Lists", shortcut: "1." },
-        { name: "task_list", label: "Task List", description: "Checklist with checkboxes", icon: "check-square", group: "Lists", shortcut: "[]" },
+        { name: "bullet_list", label: "Bullet List", description: "Unordered list", icon: "list", group: "Lists",
+          shortcut: "-" },
+        { name: "ordered_list", label: "Numbered List", description: "Ordered list", icon: "list-ordered",
+          group: "Lists", shortcut: "1." },
+        { name: "task_list", label: "Task List", description: "Checklist with checkboxes", icon: "check-square",
+          group: "Lists", shortcut: "[]" },
 
         # Blocks
-        { name: "blockquote", label: "Quote", description: "Quote block", icon: "quote", group: "Blocks", shortcut: ">" },
-        { name: "code_block", label: "Code Block", description: "Code with syntax highlighting", icon: "code", group: "Blocks", shortcut: "```" },
-        { name: "horizontal_rule", label: "Divider", description: "Horizontal line", icon: "minus", group: "Blocks", shortcut: "---" },
+        { name: "blockquote", label: "Quote", description: "Quote block", icon: "quote", group: "Blocks",
+          shortcut: ">" },
+        { name: "code_block", label: "Code Block", description: "Code with syntax highlighting", icon: "code",
+          group: "Blocks", shortcut: "```" },
+        { name: "horizontal_rule", label: "Divider", description: "Horizontal line", icon: "minus", group: "Blocks",
+          shortcut: "---" },
 
         # Media
-        { name: "image", label: "Image", description: "Upload or embed an image", icon: "image", group: "Media", shortcut: nil },
-        { name: "youtube", label: "YouTube", description: "Embed a YouTube video", icon: "youtube", group: "Media", shortcut: nil },
+        { name: "image", label: "Image", description: "Upload or embed an image", icon: "image", group: "Media",
+          shortcut: nil },
+        { name: "youtube", label: "YouTube", description: "Embed a YouTube video", icon: "youtube", group: "Media",
+          shortcut: nil },
 
         # Advanced
-        { name: "table", label: "Table", description: "Insert a table", icon: "table", group: "Advanced", shortcut: nil },
-        { name: "callout", label: "Callout", description: "Highlighted callout box", icon: "alert-circle", group: "Advanced", shortcut: nil },
-        { name: "section", label: "Section", description: "Page section with width control", icon: "layout", group: "Advanced", shortcut: nil },
-        { name: "preformatted", label: "Plain Text", description: "Preformatted text for ASCII art", icon: "file-text", group: "Advanced", shortcut: nil }
+        { name: "table", label: "Table", description: "Insert a table", icon: "table", group: "Advanced",
+          shortcut: nil },
+        { name: "callout", label: "Callout", description: "Highlighted callout box", icon: "alert-circle",
+          group: "Advanced", shortcut: nil },
+        { name: "section", label: "Section", description: "Page section with width control", icon: "layout",
+          group: "Advanced", shortcut: nil },
+        { name: "preformatted", label: "Plain Text", description: "Preformatted text for ASCII art", icon: "file-text",
+          group: "Advanced", shortcut: nil }
       ].freeze
 
       DEFAULT_GROUPS = %w[Basic Lists Blocks Media Advanced].freeze
@@ -60,6 +76,8 @@ module Inkpen
         :slash_commands
       end
 
+      # Declarative JavaScript extension configuration is clearest as one hash.
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def to_config
         {
           trigger: options[:trigger],
@@ -76,9 +94,12 @@ module Inkpen
           groupClass: options[:group_class]
         }.compact
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       private
 
+      # Option defaults mirror the JavaScript extension's public configuration.
+      # rubocop:disable Metrics/MethodLength
       def default_options
         super.merge(
           trigger: "/",
@@ -95,6 +116,7 @@ module Inkpen
           group_class: "inkpen-slash-group"
         )
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/inkpen/extensions/table.rb

@@ -145,6 +145,8 @@ module Inkpen
       #
       # @return [Hash] configuration for the TipTap extension
       #
+      # Declarative JavaScript extension configuration is clearest as one hash.
+      # rubocop:disable Metrics/MethodLength
       def to_config
         {
           resizable: resizable?,
@@ -160,9 +162,12 @@ module Inkpen
           withHeaderRow: with_header_row?
         }.compact
       end
+      # rubocop:enable Metrics/MethodLength
 
       private
 
+      # Option defaults mirror the JavaScript extension's public configuration.
+      # rubocop:disable Metrics/MethodLength
       def default_options
         super.merge(
           resizable: true,
@@ -177,6 +182,7 @@ module Inkpen
           with_header_row: true
         )
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/inkpen/extensions/task_list.rb

@@ -117,6 +117,8 @@ module Inkpen
       #
       # @return [Hash] configuration for the TipTap extension
       #
+      # Declarative JavaScript extension configuration is clearest as one hash.
+      # rubocop:disable Metrics/MethodLength
       def to_config
         {
           nested: nested?,
@@ -130,6 +132,7 @@ module Inkpen
           keyboardShortcut: keyboard_shortcut
         }
       end
+      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/inkpen/markdown_mode.rb

@@ -80,6 +80,8 @@ module Inkpen
     # @param sync_delay [Integer] debounce delay for split sync (ms)
     # @param keyboard_shortcuts [Boolean] enable keyboard shortcuts
     #
+    # Seven keywords form the stable public configuration API.
+    # rubocop:disable Metrics/ParameterLists
     def initialize(
       enabled: false,
       default_mode: :wysiwyg,
@@ -97,6 +99,7 @@ module Inkpen
       @sync_delay = sync_delay.to_i
       @keyboard_shortcuts = keyboard_shortcuts
     end
+    # rubocop:enable Metrics/ParameterLists
 
     ##
     # Check if markdown mode is enabled.

data/lib/inkpen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Inkpen
-  VERSION = "0.9.2"
+  VERSION = "0.9.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inkpen
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.4
 platform: ruby
 authors:
 - Nauman Tariq
@@ -10,33 +10,33 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: importmap-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '7.0'
 description: Inkpen provides a modern, extensible rich text editor built on TipTap/ProseMirror
   with Stimulus controllers for Rails applications.
 email: