tailwind_form 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3482e5a390bef7c76d33a7359fd453e51301b3846cbedb0df30d487ad95337c1
-  data.tar.gz: f5a66a1fb9038abe0dc2834eff607f7c7c1f4a7d283fb5fda21a53cccef273f0
+  metadata.gz: c8ea607b83292e5a3d3b3b440566f54cf638937fdd4bbf0d9beec0a82a804a0a
+  data.tar.gz: 5c0322940e9a55b583b23cf88e75d6b926cd4ab52947a611ffc6a3152b660a16
 SHA512:
-  metadata.gz: c5a75b73b3a05aea65c18e68b401fb83d05491ea49dca8f22931ff9edda6939c4aee3a749afb004c247a911f3d0dc20848f4cd5d3078102e1b7d73e96f837924
-  data.tar.gz: a466f3ceaec267b0503c1115375c0fe20012add9bb67f66504f6fbd5d703e47bed5fefdcb571084cc381800e25dc2c9297aa3f89e45ab061cda62f3b6efc6801
+  metadata.gz: a90b7a935465cfbff945710b70649da41a9240aed3fd0328ca71f4cb1621bcddcdd394328b93d6cc1302dd6da2bbb6cf63688a32d02fbf1710c1c4dd481212af
+  data.tar.gz: efdb6e8397b5edf468353c4309eeccb5bf910fed14bb9a37d3dc9435f8b4b765f504c274d8f56f481e2017e556c5c1fe899d376c253d60606a4bdf6ef8349ce8

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/*.gem
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -0,0 +1,69 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+
+AllCops:
+  Exclude:
+    - "bin/**/*"
+
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+Layout/DefEndAlignment:
+  EnforcedStyleAlignWith: def
+  AutoCorrect: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+Layout/LineLength:
+  AutoCorrect: true
+  Max: 120
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RegexpLiteral:
+  Enabled: true
+  AllowInnerSlashes: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+#
+### DISABLED COPS
+#
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,9 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tailwind_form.gemspec
 gemspec path: __dir__
+
+group :development do
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rails', require: false
+end

data/Gemfile.lock

@@ -1,16 +1,59 @@
 PATH
   remote: .
   specs:
-    tailwind_form (0.0.0)
+    tailwind_form (0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rails (2.6.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.82.0)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  rubocop-performance
+  rubocop-rails
   tailwind_form!
 
 BUNDLED WITH

data/README.md

@@ -10,6 +10,8 @@ Benefits of `tailwind_form`
 * Reduces errors
 * Makes `.erb` forms much more readable
 
+This gem is largely based on the [Bootstrap Form Gem](https://github.com/bootstrap-ruby/bootstrap_form), but implemented for TailwindCSS.
+
 ## Requirements
 
 Currently, `tailwind_form` is only tested with
@@ -62,45 +64,71 @@ A sample implementation is as follows:
 Here is an example of the form:
 
 ```erb
-<%= tailwind_form_with model: Lead.new, class: "space-y-6" do |f| %>
-  <%= f.form_group :name %>
-  <%= f.form_group :email %>
+<%= tailwind_form_with(model: @person, local: true) do |form| %>
+  <%= form.form_group :first_name %>
+  <%= form.form_group :last_name %>
+  <%= form.form_group :email, :email_field %>
+
+  <div class="actions">
+    <%= form.submit %>
+  </div>
 <% end %>
+
 ```
 
 Which generates the following form:
 
 ```html
-<form class="space-y-6" action="/leads" accept-charset="UTF-8" data-remote="true" method="post">
-  <input type="hidden" name="authenticity_token" value="S3wp;" />
+<form action="/people" accept-charset="UTF-8" method="post">
+  <input type="hidden" name="authenticity_token" value="cfuds;" />
+  <div class="form__group">
+    <label class="form__label" for="person_first_name">First name</label>
+    <div class="form__inputGroup">
+      <input class="form__input" type="text" name="person[first_name]" id="person_first_name" />
+    </div>
+  </div>
   <div class="form__group">
-    <label class="form__label" for="lead_name">Name</label>
+    <label class="form__label" for="person_last_name">Last name</label>
     <div class="form__inputGroup">
-      <input class="form__input" type="text" name="lead[name]" id="lead_name" />
+      <input class="form__input" type="text" name="person[last_name]" id="person_last_name" />
     </div>
   </div>
   <div class="form__group">
-    <label class="form__label" for="lead_email">Email</label>
+    <label class="form__label" for="person_email">Email</label>
     <div class="form__inputGroup">
-      <input class="form__input" type="text" name="lead[email]" id="lead_email" />
+      <input class="form__input" type="email" name="person[email]" id="person_email" />
     </div>
   </div>
+
+  <div class="actions">
+    <input type="submit" name="commit" value="Create Person" data-disable-with="Create Person" />
+  </div>
 </form>
 ```
 
 ## Development
 
-TODO: Update this.
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-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 do
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+So far, we have implemented the basic form but only have `text_field`, `text_area`, and `email_field`. Next steps are implementing all of the other input types.
+
+Additionally, here are other items on the todo list:
+* Add support for errors, both as an alert and as inline error helper
+* Add different layout options
+* Add different options for select and multiselect using AlpineJS
+
+If anyone happens to be seeing/using this gem and can think of other features, please let me know!
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/maxmetcalf12/tailwind_form. 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/maxmetcalf12/tailwind_form/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/tailwind_form.rb

@@ -10,6 +10,17 @@ module TailwindForm
 
   eager_autoload do
     autoload :FormBuilder
+    autoload :FormGroup
+    autoload :Components
+    autoload :Inputs
+  end
+
+  class << self
+    def eager_load!
+      super
+      TailwindForm::Components.eager_load!
+      TailwindForm::Inputs.eager_load!
+    end
   end
 end
 

data/lib/tailwind_form/components.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module Components
+    extend ActiveSupport::Autoload
+
+    autoload :Labels
+
+    include Labels
+  end
+end

data/lib/tailwind_form/components/labels.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module Components
+    module Labels
+      extend ActiveSupport::Concern
+
+      private
+
+        def tailwind_label_field(name)
+          field_options = { class: 'form__label' }
+          label(name, field_options)
+        end
+    end
+  end
+end

data/lib/tailwind_form/form_builder.rb

@@ -2,30 +2,14 @@
 
 module TailwindForm
   class FormBuilder < ActionView::Helpers::FormBuilder
-    def tailwind_label_field(name)
-      field_options = { class: 'form__label' }
-      label(name, field_options)
-    end
+    include TailwindForm::FormGroup
+    include TailwindForm::Components
 
-    def tailwind_text_field(name)
-      field_options = { class: 'form__input' }
-      @template.content_tag :div, class: 'form__inputGroup' do
-        text_field(name, field_options)
-      end
-    end
+    include TailwindForm::Inputs::Base
+    include TailwindForm::Inputs::EmailField
+    include TailwindForm::Inputs::TextArea
+    include TailwindForm::Inputs::TextField
 
-    def tailwind_text_area(name)
-      field_options = { class: 'form__input' }
-      @template.content_tag :div, class: 'form__inputGroup' do
-        text_area(name, field_options)
-      end
-    end
-
-    def form_group(name, classes = 'form__group', field_type = :text_field)
-      function_name = "tailwind_#{field_type}"
-      @template.content_tag :div, class: classes do
-        tailwind_label_field(name) + send(function_name, name)
-      end
-    end
+    delegate :concat, :tag, to: :@template
   end
 end

data/lib/tailwind_form/form_group.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module FormGroup
+    extend ActiveSupport::Concern
+
+    def form_group(name, field_type = :text_field, classes = 'form__group')
+      function_name = "#{field_type}_with_tailwind"
+      tag.div(class: classes) do
+        tailwind_label_field(name) + send(function_name, name, { class: 'form__input' })
+      end
+    end
+  end
+end

data/lib/tailwind_form/inputs.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module Inputs
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :EmailField
+    autoload :TextArea
+    autoload :TextField
+  end
+end

data/lib/tailwind_form/inputs/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module Inputs
+    module Base
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def tailwind_field(field_name)
+          define_method "#{field_name}_with_tailwind" do |name, options = {}|
+            @template.content_tag :div, class: 'form__inputGroup' do
+              send(field_name, name, options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tailwind_form/inputs/email_field.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module Inputs
+    module EmailField
+      extend ActiveSupport::Concern
+      include Base
+
+      included do
+        tailwind_field(:email_field)
+      end
+    end
+  end
+end

data/lib/tailwind_form/inputs/text_area.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module Inputs
+    module TextArea
+      extend ActiveSupport::Concern
+      include Base
+
+      included do
+        tailwind_field(:text_area)
+      end
+    end
+  end
+end

data/lib/tailwind_form/inputs/text_field.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module Inputs
+    module TextField
+      extend ActiveSupport::Concern
+      include Base
+
+      included do
+        tailwind_field(:text_field)
+      end
+    end
+  end
+end

data/lib/tailwind_form/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TailwindForm
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/tailwind_form.gemspec

@@ -3,23 +3,24 @@
 require_relative 'lib/tailwind_form/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'tailwind_form'
-  spec.version       = TailwindForm::VERSION
-  spec.authors       = ['maxmetcalf12']
-  spec.email         = ['maxmetcalf12@gmail.com']
+  spec.name = 'tailwind_form'
+  spec.version = TailwindForm::VERSION
+  spec.authors = ['maxmetcalf12']
+  spec.email = ['maxmetcalf12@gmail.com']
 
-  spec.summary       = 'Tailwind form builder makes it easy to style forms consistently using TailwindCSS'
-  spec.description   = 'Longer description'
-  spec.homepage      = 'https://github.com/maxmetcalf12/tailwind_form'
-  spec.license       = 'MIT'
+  spec.summary = 'Tailwind form builder makes it easy to style forms consistently using TailwindCSS'
+  spec.description = spec.summary
+  spec.homepage = 'https://github.com/maxmetcalf12/tailwind_form'
+  spec.license = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+    end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(/^exe\//) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: tailwind_form
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - maxmetcalf12
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies: []
-description: Longer description
+description: Tailwind form builder makes it easy to style forms consistently using
+  TailwindCSS
 email:
 - maxmetcalf12@gmail.com
 executables: []
@@ -19,6 +20,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -30,8 +32,16 @@ files:
 - bin/setup
 - lib/tailwind_form.rb
 - lib/tailwind_form/action_view_extensions/form_helper.rb
+- lib/tailwind_form/components.rb
+- lib/tailwind_form/components/labels.rb
 - lib/tailwind_form/engine.rb
 - lib/tailwind_form/form_builder.rb
+- lib/tailwind_form/form_group.rb
+- lib/tailwind_form/inputs.rb
+- lib/tailwind_form/inputs/base.rb
+- lib/tailwind_form/inputs/email_field.rb
+- lib/tailwind_form/inputs/text_area.rb
+- lib/tailwind_form/inputs/text_field.rb
 - lib/tailwind_form/version.rb
 - tailwind_form.gemspec
 homepage: https://github.com/maxmetcalf12/tailwind_form