poetry-simple_form 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efb1cfb9d26aae8ccd85547dda550823f2dfdea920c07f6a40a020093969d477
-  data.tar.gz: 762c2d85ca167eadd14aab971a74d17969d9cf9d64705b37c96d6712737c5b7c
+  metadata.gz: ffccc7f78070ec926ea915e06374ac2a02a8fe19a7a7a25827e381e5220534ab
+  data.tar.gz: 53529f398491bc327e68792b4abea385174e3a76a50260df679c2f9d56563038
 SHA512:
-  metadata.gz: 9a0183db6dd0c3a93111917a96af19672e84f1670876a1e64b7e8c57333f9fd7ca16ca1580baf9993c807b5e4b16f4d7e8f0c9115eb8cd38344a822aee0d40d4
-  data.tar.gz: 222693900c3eea0c158805d999a5bb26df97ce5ae3e7d1545905731e889adf07510ddc2f8f382c3d3912e52fd6fb48609f5c5035c9e2f2e10bfdc59503284208
+  metadata.gz: f102f0337dec1b24ec672b9db9b1868f578d20eecc1780a22d2dbc377e072645e25bc31cce315e4ee4d465a49255f02702104b94eea7b11eb339ef5f35a028d0
+  data.tar.gz: 3dc8d52ed76c70af13033e56944f2c9ae06fd90c65a318f85d0c0f27844bfe8119d7d6f93763dfc10e4ccd06f9c72d80174fb845f0eec654597a06c1a2c067bc

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.1.5] - 2026-09-18
+
+### Changed
+
+- 1 method the reference already hid with `@api private` is Ruby-private now: each was called only by its own class or template, so the runtime enforces what the tag only stated. A host that reached one gets a NoMethodError instead of an internal that may change without notice. The tag remains on the internals the family shares between its gems and on whole internal classes.
+- Every class, module and method carries a one-sentence description, private helpers included: `rake yard:coverage:all` measures the whole tree (a tag-only docstring counts as blank) and the committed floor now stands at zero.
+
+## [0.1.4] - 2026-09-15
+
+Lockstep release with the family; no changes in this gem.
+
 ## [0.1.3] - 2026-09-13
 
 Lockstep release with the family; no changes in this gem.

data/lib/generators/poetry/simple_form/install/install_generator.rb

@@ -14,7 +14,6 @@ module Poetry
         source_root File.expand_path("templates", __dir__)
 
         # Write config/initializers/poetry_simple_form.rb.
-        # @api private
         def create_initializer
           create_file "config/initializers/poetry_simple_form.rb", <<~RUBY_FILE
             # poetry renders simple_form's inputs (the migration bridge):
@@ -24,6 +23,8 @@ module Poetry
             Poetry::SimpleForm.activate!
           RUBY_FILE
         end
+
+        private :create_initializer
       end
     end
   end

data/lib/poetry/simple_form/inputs/base.rb

@@ -24,6 +24,7 @@ module Poetry
         # Subclasses answer the poetry `as:` value (nil lets poetry infer).
         def poetry_as = nil
 
+        # A Poetry form builder over the same object, the one the inputs render through.
         def poetry_builder
           Poetry::Ui::FormBuilder.new(object_name, object, template, {})
         end

data/lib/poetry/simple_form/inputs/boolean_input.rb

@@ -8,6 +8,7 @@ module Poetry
       class BooleanInput < Base
         private
 
+        # Renders as Poetry's boolean field.
         def poetry_as = :boolean
       end
     end

data/lib/poetry/simple_form/inputs/collection_inputs.rb

@@ -10,6 +10,8 @@ module Poetry
       class CollectionBase < Base
         private
 
+        # The collection as label and value pairs, reading the configured label
+        # and value methods when the items are records.
         def label_value_pairs(collection = Array(options[:collection]))
           return [] if collection.empty?
 
@@ -27,6 +29,7 @@ module Poetry
           end
         end
 
+        # An item's label or value: a callable is called, a symbol is sent.
         def read(item, method)
           method.respond_to?(:call) ? method.call(item) : item.public_send(method)
         end
@@ -39,6 +42,7 @@ module Poetry
         # Render the collection as a Field-wrapped Select;
         # include_blank/prompt becomes the placeholder option.
         #
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered Field HTML
         def input(_wrapper_options = nil)
           poetry_builder.poetry_select(attribute_name, label_value_pairs,
@@ -52,6 +56,7 @@ module Poetry
       class CollectionRadioButtonsInput < CollectionBase
         # Render the collection as a Field-wrapped RadioGroup.
         #
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered Field HTML
         def input(_wrapper_options = nil)
           pairs = label_value_pairs.map { |label, value| [value, label] }
@@ -64,6 +69,7 @@ module Poetry
       class CollectionCheckBoxesInput < CollectionBase
         # Render the collection as a Field-wrapped checkbox group.
         #
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered Field HTML
         def input(_wrapper_options = nil)
           pairs = label_value_pairs.map { |label, value| [value, label] }
@@ -74,6 +80,8 @@ module Poetry
       # Serves `as: :native_select`: a poetry Field wrapping the styled
       # native <select> (the no-JS picker).
       class NativeSelectInput < CollectionBase
+        # Renders the field as a native select.
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered Field HTML
         def input(_wrapper_options = nil)
           poetry_builder.native_select(attribute_name, label_value_pairs,
@@ -84,6 +92,8 @@ module Poetry
 
       # Serves `as: :combobox`: a poetry Field wrapping the filterable Combobox.
       class ComboboxInput < CollectionBase
+        # Renders the field as a combobox.
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered Field HTML
         def input(_wrapper_options = nil)
           poetry_builder.poetry_combobox(attribute_name, label_value_pairs,
@@ -95,6 +105,8 @@ module Poetry
       # Serves `as: :autocomplete`: a poetry Field wrapping the Autocomplete;
       # the collection becomes its suggestions.
       class AutocompleteInput < CollectionBase
+        # Renders the field as an autocomplete.
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered Field HTML
         def input(_wrapper_options = nil)
           poetry_builder.autocomplete(attribute_name, label_value_pairs, **poetry_options)
@@ -105,6 +117,8 @@ module Poetry
       # group_label_method resolve the groups, poetry's Select renders them
       # as labelled groups.
       class GroupedCollectionSelectInput < CollectionBase
+        # Renders the field as a select with labelled groups.
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered Field HTML
         def input(_wrapper_options = nil)
           poetry_builder.poetry_select(attribute_name, grouped_pairs,
@@ -124,6 +138,7 @@ module Poetry
           end
         end
 
+        # A group's label, through the configured or the first responding label method.
         def group_label_for(group)
           method = options[:group_label_method] ||
                    ::SimpleForm.collection_label_methods.find { |m| group.respond_to?(m) }
@@ -135,6 +150,8 @@ module Poetry
       # Select, the priority zones (priority: or SimpleForm.time_zone_priority)
       # listed first.
       class TimeZoneInput < CollectionBase
+        # Renders the field as a select over the time zones.
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered Field HTML
         def input(_wrapper_options = nil)
           poetry_builder.poetry_select(attribute_name, zone_pairs,
@@ -144,6 +161,7 @@ module Poetry
 
         private
 
+        # Every time zone as a label and name pair, the priority zones first.
         def zone_pairs
           zones = ActiveSupport::TimeZone.all
           priority = Array(options[:priority] || ::SimpleForm.time_zone_priority)

data/lib/poetry/simple_form/inputs/custom_inputs.rb

@@ -11,6 +11,7 @@ module Poetry
       class SwitchInput < Base
         private
 
+        # Renders as Poetry's switch field.
         def poetry_as = :switch
       end
 
@@ -18,6 +19,7 @@ module Poetry
       class SliderInput < Base
         private
 
+        # Renders as Poetry's slider field.
         def poetry_as = :slider
       end
 
@@ -25,6 +27,7 @@ module Poetry
       class OtpInput < Base
         private
 
+        # Renders as Poetry's one-time-code field.
         def poetry_as = :otp
       end
 
@@ -32,6 +35,7 @@ module Poetry
       class SensitiveInput < Base
         private
 
+        # Renders as Poetry's sensitive field.
         def poetry_as = :sensitive
       end
 
@@ -39,6 +43,7 @@ module Poetry
       class TagGroupInput < Base
         private
 
+        # Renders as Poetry's tag group field.
         def poetry_as = :tag_group
       end
 
@@ -46,6 +51,7 @@ module Poetry
       class DatePickerInput < Base
         private
 
+        # Renders as Poetry's date picker field.
         def poetry_as = :date_picker
       end
 
@@ -53,6 +59,7 @@ module Poetry
       class CalendarInput < Base
         private
 
+        # Renders as Poetry's inline calendar field.
         def poetry_as = :calendar
       end
     end

data/lib/poetry/simple_form/inputs/date_time_input.rb

@@ -9,6 +9,7 @@ module Poetry
         # Render :date/:time/:datetime attributes as poetry DateField /
         # TimeField / DateTimeField - one control each, ISO on the wire.
         #
+        # @param _wrapper_options [Hash, nil] Simple Form's wrapper options, unused: the Field is the wrapper
         # @return [String] the rendered HTML
         def input(_wrapper_options = nil)
           Poetry::Ui::FormBuilder.new(object_name, object, template, {})

data/lib/poetry/simple_form/inputs/file_input.rb

@@ -9,6 +9,7 @@ module Poetry
       class FileInput < Base
         private
 
+        # Renders as Poetry's file field.
         def poetry_as = :file
       end
     end

data/lib/poetry/simple_form/inputs/numeric_input.rb

@@ -8,6 +8,7 @@ module Poetry
       class NumericInput < Base
         private
 
+        # Renders as Poetry's number field.
         def poetry_as = :number
       end
     end

data/lib/poetry/simple_form/inputs/password_input.rb

@@ -8,6 +8,7 @@ module Poetry
       class PasswordInput < Base
         private
 
+        # Renders as Poetry's password field.
         def poetry_as = :password
       end
     end

data/lib/poetry/simple_form/inputs/string_input.rb

@@ -8,6 +8,7 @@ module Poetry
       class StringInput < Base
         private
 
+        # The Poetry field type for a string column, or nil so Poetry infers one for the no-column fallback.
         def poetry_as
           # :string is simple_form's no-column fallback (ActiveModel,
           # virtual attributes) - hand poetry a nil so ITS inference runs

data/lib/poetry/simple_form/inputs/text_input.rb

@@ -8,6 +8,7 @@ module Poetry
       class TextInput < Base
         private
 
+        # Renders as Poetry's text area field.
         def poetry_as = :text
       end
     end

data/lib/poetry/simple_form/version.rb

@@ -3,6 +3,6 @@
 module Poetry
   module SimpleForm
     # The gem version.
-    VERSION = "0.1.3"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poetry-simple_form
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Matt Solt
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: simple_form
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: 'The simple_form migration bridge for Poetry: f.input renders Poetry Fields.'
 test_files: []