tailwind_form 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3482e5a390bef7c76d33a7359fd453e51301b3846cbedb0df30d487ad95337c1
+  data.tar.gz: f5a66a1fb9038abe0dc2834eff607f7c7c1f4a7d283fb5fda21a53cccef273f0
+SHA512:
+  metadata.gz: c5a75b73b3a05aea65c18e68b401fb83d05491ea49dca8f22931ff9edda6939c4aee3a749afb004c247a911f3d0dc20848f4cd5d3078102e1b7d73e96f837924
+  data.tar.gz: a466f3ceaec267b0503c1115375c0fe20012add9bb67f66504f6fbd5d703e47bed5fefdcb571084cc381800e25dc2c9297aa3f89e45ab061cda62f3b6efc6801

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at maxmetcalf12@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tailwind_form.gemspec
+gemspec path: __dir__

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    tailwind_form (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  tailwind_form!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 maxmetcalf12
+
+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,110 @@
+# TailwindForm
+
+`tailwind_form` is a Rails form builder to easily implement custom, consistent TailwindCSS forms into your Rails app. It provides forms with preset `form__group`, `form__label`, `form__inputGroup`, and `form__input` css classes that you customize using Tailwind classes and `@apply` tag in SCSS.
+
+This gem is assuming you have [TailwindCSS](https://github.com/tailwindcss/tailwindcss) and [TailwindCSS Custom Forms](https://github.com/tailwindcss/custom-forms) already installed on your rails application.
+
+Benefits of `tailwind_form`
+* Makes implementing forms much more simple, thus slimming your `.erb` files
+* Makes forms more consistent across your entire website by forcing extraction of form classes
+* Reduces errors
+* Makes `.erb` forms much more readable
+
+## Requirements
+
+Currently, `tailwind_form` is only tested with
+* Rails 6.0.1
+* Tailwind 1.4.6
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tailwind_form'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tailwind_form
+
+Our gem depends on having preset form classes set in your local scss directory.
+A sample implementation is as follows:
+
+```scss
+.form__group {
+  @apply my-2;
+}
+
+.form__label {
+  @apply block text-sm font-medium text-gray-700;
+}
+
+.form__inputGroup {
+  @apply mt-1 rounded-md shadow-sm;
+}
+
+.form__input {
+  @apply form-input block w-full;
+
+  @screen sm {
+    @apply text-sm leading-tight;
+  }
+}
+```
+
+## Usage
+
+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 %>
+<% 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;" />
+  <div class="form__group">
+    <label class="form__label" for="lead_name">Name</label>
+    <div class="form__inputGroup">
+      <input class="form__input" type="text" name="lead[name]" id="lead_name" />
+    </div>
+  </div>
+  <div class="form__group">
+    <label class="form__label" for="lead_email">Email</label>
+    <div class="form__inputGroup">
+      <input class="form__input" type="text" name="lead[email]" id="lead_email" />
+    </div>
+  </div>
+</form>
+```
+
+## Development
+
+TODO: Update this.
+
+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 tags, 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/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).
+
+## Code of Conduct
+
+Everyone interacting in the TailwindForm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/maxmetcalf12/tailwind_form/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+  require 'rubocop/rake_task'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TailwindForm'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tailwind_form"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tailwind_form/action_view_extensions/form_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  module ActionViewExtensions
+    # This module creates TailwindForm wrappers around the default form_with
+    # and form_for methods
+    #
+    # Example:
+    #
+    #   tailwind_form_for @user do |f|
+    #     f.text_field :name
+    #   end
+    #
+    # Example:
+    #
+    #   tailwind_form_with model: @user do |f|
+    #     f.text_field :name
+    #   end
+    module FormHelper
+      def tailwind_form_with(options = {}, &block)
+        options.reverse_merge!(builder: TailwindForm::FormBuilder)
+
+        form_with(**options, &block)
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_view) do
+  include TailwindForm::ActionViewExtensions::FormHelper
+end

data/lib/tailwind_form/engine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module TailwindForm
+  class Engine < Rails::Engine
+    config.eager_load_namespaces << TailwindForm
+    config.autoload_paths << File.expand_path('lib', __dir__)
+  end
+end

data/lib/tailwind_form/form_builder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TailwindForm
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    def tailwind_label_field(name)
+      field_options = { class: 'form__label' }
+      label(name, field_options)
+    end
+
+    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
+
+    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
+  end
+end

data/lib/tailwind_form/version.rb

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

data/lib/tailwind_form.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'tailwind_form/version'
+require 'action_view'
+require 'action_pack'
+require 'tailwind_form/action_view_extensions/form_helper'
+
+module TailwindForm
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :FormBuilder
+  end
+end
+
+require 'tailwind_form/engine' if defined?(Rails)

data/tailwind_form.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+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.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.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.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: tailwind_form
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- maxmetcalf12
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-16 00:00:00.000000000 Z
+dependencies: []
+description: Longer description
+email:
+- maxmetcalf12@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tailwind_form.rb
+- lib/tailwind_form/action_view_extensions/form_helper.rb
+- lib/tailwind_form/engine.rb
+- lib/tailwind_form/form_builder.rb
+- lib/tailwind_form/version.rb
+- tailwind_form.gemspec
+homepage: https://github.com/maxmetcalf12/tailwind_form
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Tailwind form builder makes it easy to style forms consistently using TailwindCSS
+test_files: []