well_formed 0.1.0

data/sig/well_formed.rbs

@@ -0,0 +1,129 @@
+module WellFormed
+  VERSION: String
+
+  # Interface for objects that can be used as the `resource` argument to a form.
+  # Matches the subset of ActiveModel/ActiveRecord that form modules depend on.
+  interface _ActiveModelLike
+    def id: () -> untyped
+    def persisted?: () -> bool
+    def save: () -> bool
+    def errors: () -> ::ActiveModel::Errors
+    def valid?: (?untyped context) -> bool
+  end
+
+  class Error < StandardError
+  end
+
+  class UnmatchedAttributesError < Error
+  end
+
+  class RecordInvalid < Error
+    attr_reader record: untyped
+
+    def initialize: (untyped record) -> void
+  end
+
+  # Resource form without a user argument.
+  # Inherit from this when no authentication context is needed.
+  class SimpleResource
+    include _ActiveModelLike
+
+    def self.resource_alias: (::Class | ::Symbol | ::String resource) -> void
+    def self.unmatched_attributes: (:ignore | :warn | :raise mode) -> void
+    def self.merge_model_errors: () -> void
+    def self.save_within_transaction: () -> void
+    def self.nested_attributes_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+    def self.nested_attribute_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+    def initialize: (::WellFormed::_ActiveModelLike resource, ?::Hash[::Symbol | ::String, untyped] params) -> void
+
+    attr_reader resource: ::WellFormed::_ActiveModelLike
+
+    def id: () -> untyped
+    def persisted?: () -> bool
+    def new_record?: () -> bool
+    def to_param: () -> ::String?
+
+    def save: () -> bool
+    def save!: () -> bool
+    def submit: () -> (::WellFormed::_ActiveModelLike | false)
+    def submit!: () -> ::WellFormed::_ActiveModelLike
+  end
+
+  # Resource form with a user argument.
+  # Inherit from this for standard create/update flows.
+  class ResourceForm < SimpleResource
+    def self.nested_attributes_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+    def self.nested_attribute_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+
+    def initialize: (::WellFormed::_ActiveModelLike resource, untyped user, ?::Hash[::Symbol | ::String, untyped] params) -> void
+
+    attr_reader user: untyped
+  end
+
+  # Action form without a user argument.
+  # Inherit from this when no authentication context is needed.
+  class SimpleAction
+    def self.resource_alias: (::Class | ::Symbol | ::String resource) -> void
+    def self.nested_attributes_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+    def self.nested_attribute_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+
+    def initialize: (::WellFormed::_ActiveModelLike resource, ?::Hash[::Symbol | ::String, untyped] params) -> void
+
+    attr_reader resource: ::WellFormed::_ActiveModelLike
+
+    def id: () -> untyped
+    def persisted?: () -> bool
+    def new_record?: () -> bool
+    def to_param: () -> ::String?
+
+    def perform: () -> void
+    def submit: () -> bool
+    def submit!: () -> bool
+  end
+
+  # Action form with a user argument.
+  # Define a `perform` method; call `submit` or `submit!` to run it.
+  class ActionForm < SimpleAction
+    def self.nested_attributes_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+    def self.nested_attribute_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+
+    def initialize: (::WellFormed::_ActiveModelLike resource, untyped user, ?::Hash[::Symbol | ::String, untyped] params) -> void
+
+    attr_reader user: untyped
+  end
+
+  # Resource form for plain Ruby objects that may not fully implement the ActiveRecord interface.
+  # id and persisted? delegate to the resource if it responds to them, otherwise return nil/false.
+  # Does not support save_within_transaction (no ActiveRecord transaction available).
+  class SimpleStruct
+    def self.resource_alias: (::Class | ::Symbol | ::String resource) -> void
+    def self.unmatched_attributes: (:ignore | :warn | :raise mode) -> void
+    def self.merge_model_errors: () -> void
+    def self.nested_attributes_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+    def self.nested_attribute_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+
+    def initialize: (::WellFormed::_ActiveModelLike resource, ?::Hash[::Symbol | ::String, untyped] params) -> void
+
+    attr_reader resource: ::WellFormed::_ActiveModelLike
+
+    def id: () -> untyped
+    def persisted?: () -> bool
+    def new_record?: () -> bool
+    def to_param: () -> ::String?
+
+    def save: () -> bool
+    def save!: () -> bool
+    def submit: () -> (::WellFormed::_ActiveModelLike | false)
+    def submit!: () -> ::WellFormed::_ActiveModelLike
+  end
+
+  # SimpleStruct with a user argument.
+  class Struct < SimpleStruct
+    def self.nested_attributes_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+    def self.nested_attribute_for: (::Symbol name, ?::Class form_class) ?{ () -> void } -> void
+
+    def initialize: (::WellFormed::_ActiveModelLike resource, untyped user, ?::Hash[::Symbol | ::String, untyped] params) -> void
+
+    attr_reader user: untyped
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: well_formed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Morrall
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: WellFormed provides tools to create and manage form objects in Rails
+  applications, including support for nested resources, validations, callbacks, and
+  error handling.
+email:
+- bemo56@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- gems/well_formed-pundit/.rspec
+- gems/well_formed-pundit/Gemfile
+- gems/well_formed-pundit/README.md
+- gems/well_formed-pundit/Rakefile
+- gems/well_formed-pundit/lib/well_formed-pundit.rb
+- gems/well_formed-pundit/lib/well_formed/pundit.rb
+- gems/well_formed-pundit/lib/well_formed/pundit/version.rb
+- gems/well_formed-pundit/spec/spec_helper.rb
+- gems/well_formed-pundit/spec/well_formed/pundit_integration_spec.rb
+- gems/well_formed-pundit/spec/well_formed/pundit_spec.rb
+- gems/well_formed-pundit/well_formed-pundit.gemspec
+- lib/generators/resource_form_generator.rb
+- lib/generators/templates/form.rb.tt
+- lib/well_formed.rb
+- lib/well_formed/action_form.rb
+- lib/well_formed/attribute_assignment.rb
+- lib/well_formed/collections.rb
+- lib/well_formed/errors.rb
+- lib/well_formed/initializer.rb
+- lib/well_formed/nested_attributes.rb
+- lib/well_formed/nested_form.rb
+- lib/well_formed/performer.rb
+- lib/well_formed/persistence.rb
+- lib/well_formed/railtie.rb
+- lib/well_formed/record_identity.rb
+- lib/well_formed/resource_form.rb
+- lib/well_formed/simple_action.rb
+- lib/well_formed/simple_nested_form.rb
+- lib/well_formed/simple_resource.rb
+- lib/well_formed/simple_struct.rb
+- lib/well_formed/struct.rb
+- lib/well_formed/transactional.rb
+- lib/well_formed/translations.rb
+- lib/well_formed/version.rb
+- lib/well_formed/with_user.rb
+- rbs_collection.yaml
+- sig/well_formed.rbs
+homepage: https://github.com/bmorrall/well_formed
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bmorrall/well_formed
+  source_code_uri: https://github.com/bmorrall/well_formed
+  changelog_uri: https://github.com/bmorrall/well_formed/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Form objects for Rails applications.
+test_files: []