phlexi-field 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0be36da5b3ce1dae979b31c55d9a0ad18e9b4aa9f206e47f29ea97f55bc2c89b
+  data.tar.gz: 73584d4874fa1fa59746b34053f5e5d77edf6f3780f73be42b3d2ca677167c12
+SHA512:
+  metadata.gz: de662238d5a8716422335d4d33b21e5b317e78c0fd247eb9c6185f3a0cd1294faab5192fcd1d1887a548825953c04ebfb2fc5696e3c7762fed662ae0199ee7d5
+  data.tar.gz: 631cdd6a03e32750863c632e61b0a447dde1ce20ccb5f20e1b513aba7937ea120f0733b1a6327c39f729561898c3f7a99e7bbefaf81736f0b27bd359d2cf23b8

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Appraisals

@@ -0,0 +1,8 @@
+appraise "default" do
+  # gem "phlex", "~> 1.10"
+end
+
+appraise "rails-7" do
+  gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+  gem "sqlite3", "~> 1.4"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.2.0] - 2024-07-31
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stefan Froelich
+
+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,196 @@
+# Phlexi::Form 
+
+Phlexi::Form is a flexible and powerful form builder for Ruby applications. It provides a more customizable and extensible way to create forms compared to traditional form helpers.
+
+[![Ruby](https://github.com/radioactive-labs/phlexi-form/actions/workflows/main.yml/badge.svg)](https://github.com/radioactive-labs/phlexi-form/actions/workflows/main.yml)
+
+## Features
+
+- Customizable form components (input, select, checkbox, radio button, etc.)
+- Automatic field type and attribute inference based on model attributes
+- Built-in support for validations and error handling
+- Flexible form structure with support for nested attributes
+- Works with Phlex or erb views
+- Extract input from parameters that match your form definition. No need to strong paramters.
+- Rails compatible form inputs
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phlexi-form'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install phlexi-form
+```
+
+## Usage
+
+There are 2 ways to use Phlexi::Form:
+
+### Direct Usage
+
+```ruby
+Phlexi::Form(User.new) do
+  field(:name) do |name|
+    render name.label_tag
+    render name.input_tag
+  end
+
+  field(:email) do |email|
+    render email.label_tag
+    render email.input_tag
+  end
+
+  nest_one(:address) do |address|
+    address.field(:street) do |street|
+      render street.label_tag
+      render street.input_tag
+    end
+
+    address.field(:city) do |city|
+      render city.label_tag
+      render city.input_tag
+    end
+  end
+
+  render submit_button
+end
+```
+
+> **Important**
+>
+> If you are rendering your form inline e.g. 
+> ```ruby
+> render Phlexi::Form(User.new) {
+>   render field(:name).label_tag
+>   render field(:name).input_tag
+> }
+> ```
+>
+> Make sure you use `{...}` in defining your block instead of `do...end`
+> This might be fixed in a future version.
+
+### Inherit form
+
+```ruby
+class UserForm < Phlexi::Form::Base
+  def form_template
+    field(:name) do |name|
+      render name.label_tag
+      render name.input_tag
+    end
+
+    field(:email) do |email|
+      render email.label_tag
+      render email.input_tag
+    end
+
+    nest_one(:address) do |address|
+      address.field(:street) do |street|
+        render street.label_tag
+        render street.input_tag
+      end
+
+      address.field(:city) do |city|
+        render city.label_tag
+        render city.input_tag
+      end
+    end
+
+    render submit_button
+  end
+end
+
+
+# In your view or controller
+form = UserForm.new(User.new)
+
+# Render the form
+render form
+
+# Extract params
+form.extract_input({
+  name: "Brad Pitt",
+  email: "brad@pitt.com",
+  address: {
+    street: "Plumbago",
+    city: "Accra",
+  }
+})
+```
+
+## Advanced Usage
+
+### Custom Components
+
+You can create custom form components by inheriting from `Phlexi::Form::Components::Base`:
+
+```ruby
+class CustomInput < Phlexi::Form::Components::Base
+  def template
+    div(class: "custom-input") do
+      input(**attributes)
+      span(class: "custom-icon")
+    end
+  end
+end
+
+# Usage in your form
+field(:custom_field) do |field|
+  render CustomInput.new(field)
+end
+```
+
+### Theming
+
+Phlexi::Form supports theming through a flexible theming system:
+
+```ruby
+class ThemedForm < Phlexi::Form::Base
+  class FieldBuilder < FieldBuilder
+    private
+    
+    def default_theme
+      {
+        input: "border rounded px-2 py-1",
+        label: "font-bold text-gray-700",
+        # Add more theme options here
+      }
+    end
+  end
+end
+```
+
+<!-- ## Configuration
+
+You can configure Phlexi::Form globally by creating an initializer:
+
+```ruby
+# config/initializers/phlexi_form.rb
+Phlexi::Form.configure do |config|
+  config.default_theme = {
+    # Your default theme options
+  }
+  # Add more configuration options here
+end
+``` -->
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/radioactive-labs/phlexi-form.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+task default: %i[test standard]
+
+# https://juincc.medium.com/how-to-setup-minitest-for-your-gems-development-f29c4bee13c2
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/TODO

@@ -0,0 +1,4 @@
+- Add tests for primary_key
+- Ensure composite primary keys are supported
+- add tests for formmethod override in submit_button
+- how can we automatically infer the file types accepted by the file_input component

data/config.ru

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development

data/gemfiles/default.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gemspec path: "../"

data/gemfiles/default.gemfile.lock

@@ -0,0 +1,194 @@
+PATH
+  remote: ..
+  specs:
+    phlexi-form (0.3.0.rc1)
+      activesupport
+      phlex (~> 1.11)
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ansi (1.5.0)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    bundle-audit (0.1.0)
+      bundler-audit
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    combustion (1.5.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    drb (2.2.1)
+    erubi (1.13.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    matrix (0.4.2)
+    mini_mime (1.1.5)
+    minitest (5.24.1)
+    minitest-reporters (1.7.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mutex_m (0.2.0)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    phlex (1.11.0)
+    phlex-testing-capybara (0.1.0)
+      capybara (~> 3.38)
+      phlex (>= 0.5)
+    psych (5.1.2)
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (3.1.7)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
+      io-console (~> 0.5)
+    rexml (3.3.2)
+      strscan
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.39.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    stringio (3.1.1)
+    strscan (3.1.0)
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.6.17)
+
+PLATFORMS
+  x86_64-darwin
+
+DEPENDENCIES
+  appraisal
+  bundle-audit
+  combustion
+  minitest
+  minitest-reporters
+  phlex-testing-capybara
+  phlexi-form!
+  rake
+  standard
+
+BUNDLED WITH
+   2.5.16

data/gemfiles/rails_7.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"