superform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f11fa90121336cea5cba3e376930c7c03c59f1a4cad8383de46482921651a94
+  data.tar.gz: cfec05650064dcb07e6eadb0b78c501317cace17bd7062c666ad3972379e4c1b
+SHA512:
+  metadata.gz: ec98e31913b9ca5f3aac6c75952b2ee51a19c01c82368f2dc5c87f58c91eb6dd0f41dfae969165f6be7fc1ac2e87595f85c30d19ef43938e3c95a58e2cd1c7ba
+  data.tar.gz: b138902a808ecbff61fbc8b3ae37a34e576895972512a7c0c5d78e8c318130fa567d53570d9163210d2015141ea47a38e3c0b021082be936341d9f5c951a4b25

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at bradgessler@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in superform.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Brad Gessler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,199 @@
+# Superform
+
+Superform aims to be the best way to build forms in Rails applications. Here's what it does differently.
+
+* **Everything is a component.** Superform is built on top of [Phlex](https://phlex.fun), so every bit of HTML in the form can be customized to your precise needs. Use it with your own CSS Framework or go crazy customizing every last bit of TailwindCSS.
+
+* **Strong Params are built in.** Superform automatically permits the form fields for you. How many times have you changed the form and forgot to permit a param from the controller? No more! Superform has you covered.
+
+* **Compose forms with Plain 'ol Ruby Objects**. Superform is built on top of POROs, so you can easily compose forms together to create complex forms. You can even extend forms to create new forms with a different look and feel.
+
+It's a complete rewrite of Rails form's internals that's inspired by Reactive component system. [Chris McCord said it very eloquently in a love letter to react](https://fly.io/blog/love-letter-react/). This aspires to be that, but in Ruby.
+
+## Installation
+
+Install the gem and add to the Rails application's Gemfile by executing:
+
+    $ bundle add superform
+
+## Usage
+
+Super Forms streamlines the development of forms on Rails applications by making everything a component.
+
+Here's what a Superform looks in your Erb files.
+
+```erb
+<%= render ApplicationForm.new model: @user do
+      render field(:email).input(type: :email)
+      render field(:name).input
+
+      button(type: :submit) { "Sign up" }
+    end %>
+```
+
+That's very spartan form! Let's add labels and HTML between each form row so we have something to work with.
+
+```erb
+<%= render ApplicationForm.new do
+      div class: "form-row" do
+        render field(:email).label
+        render field(:email).input(type: :email)
+      end
+      div class: "form-row" do
+        render field(:name).label
+        render field(:name).input
+      end
+
+      button(type: :submit) { "Sign up" }
+    end %>
+```
+
+Jumpin' Jimmidy! That's starting to get purty verbose. Let's add some helpers to `ApplicationForm` and tighten things up.
+
+## Customizing Look & Feel
+
+Superforms are built entirely out of Phlex components. The method names correspeond with the tag, its arguments are attributes, and the blocks are the contents of the element.
+
+```ruby
+class ApplicationForm < Superform::Base
+  class MyInputComponent < ApplicationComponent
+    def template(&)
+      div class: "form-field" do
+        input(**attributes)
+        if field.errors?
+          p(class: "form-field-error") { field.errors.to_sentence }
+        end
+      end
+    end
+  end
+
+  class Field < Field
+    def input(**attributes)
+      MyInputComponent.new(self, attributes: attributes)
+    end
+  end
+
+  def labeled(component)
+    div class: "form-row" do
+      render component.field.label
+      render component
+    end
+  end
+
+  def submit(text)
+    button(type: :submit) { text }
+  end
+end
+```
+
+That looks like a LOT of code, and it is, but look at how easy it is to create forms.
+
+```erb
+<%= render ApplicationForm.new model: @user do
+      labeled field(:name).input
+      labeled field(:email).input(type: :email)
+
+      submit "Sign up"
+    end %>
+```
+
+Much better!
+
+### Extending Forms
+
+The best part? If you have forms with a completely different look and feel, you can extend the forms just like you would a Ruby class:
+
+```ruby
+class AdminForm < ApplicationForm
+  class AdminInput < ApplicationComponent
+    def template(&)
+      input(**attributes)
+      small { admin_tool_tip_for field.key }
+    end
+  end
+
+  class Field < Field
+    def tooltip_input(**attributes)
+      AdminInput.new(self, attributes: attributes)
+    end
+  end
+end
+```
+
+Then, just like you did in your Erb, you create the form:
+
+```erb
+<%= render AdminForm.new model: @user do
+      labeled field(:name).tooltip_input
+      labeled field(:email).tooltip_input(type: :email)
+
+      submit "Save"
+    end %>
+```
+
+### Self-permitting Parameters
+
+Guess what? It also permits form fields for you in your controller, like this:
+
+```ruby
+class UserController < ApplicationController
+  # Your actions
+
+  private
+
+  def permitted_params
+    @form.permit params
+  end
+end
+```
+
+To do that though you need to move the form into your controller, which is pretty easy:
+
+```ruby
+class UserController < ApplicationController
+  class Form < ApplicationForm
+    render field(:email).input(type: :email)
+    render field(:name).input
+
+    button(type: :submit) { "Sign up" }
+  end
+
+  before_action :assign_form
+
+  # Your actions
+
+  private
+
+  def assign_form
+    @form = Form.new(model: @user)
+  end
+
+  def permitted_params
+    @form.permit params
+  end
+end
+```
+
+Then render it from your Erb in less lines, like this:
+
+```
+<%= render @form %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubymonolith/superform. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rubymonolith/superform/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Superform project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubymonolith/superform/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/superform/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Superform
+  VERSION = "0.1.0"
+end

data/lib/superform.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "superform/version"
+
+module Superform
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/superform.rbs

@@ -0,0 +1,4 @@
+module Superform
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: superform
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-24 00:00:00.000000000 Z
+dependencies: []
+description: A better way to customize and build forms for your Rails application
+email:
+- bradgessler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/superform.rb
+- lib/superform/version.rb
+- sig/superform.rbs
+homepage: https://github.com/rubymonolith/superform
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rubymonolith/superform
+  source_code_uri: https://github.com/rubymonolith/superform
+  changelog_uri: https://github.com/rubymonolith/superform
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Build forms in Rails
+test_files: []