simple_form-theme 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 437ec70587ba8a60a1c4d2dc5e8c3b02298439dc55ef904d5c71115c8cd1da48
-  data.tar.gz: 3d042a0e47a5ff75365a08dfd242134d7e8dfae4b75437afe70b95a1fd641da5
+  metadata.gz: 4e9ef112e8336bcefad7f46954411a7aa154bca3b05886aed6420e322818ead4
+  data.tar.gz: 0e7bf9b15e1ec7674bdd266bc1b0bde0d10f10338111cf48344981d8423ffccc
 SHA512:
-  metadata.gz: cfe2bbe85d5ba2ae74c8aea94f789028d0e42325c47a6a2e5fe490f9d5a005eaafdac420fc266656946dbb2af820e63cfa3291864ffdfa05b6d2cfe1612a1c9b
-  data.tar.gz: 9be70bb643d0cd348a5c91ff66c0820d7c7dce37b9dc6bbc8c6219f4080563ee1da85f37e188fc48f69bd68e4e29741f76ba015072ffd516e83ffe3f447209ad
+  metadata.gz: 0a5b0bf8a3e6db84204c357e383a19375251b001055797aaf2196a20e14d43a557e016cf2161f69355a65b59efdf3785ac2a7a2e0aff011b9d9d24f50bebdec9
+  data.tar.gz: 1e0cfb0ce5820477683b9aa4915949e8c0ca992e610a1339b10dbbaa6162c3add99c68c65e71ed9ecefad1a7c6472e33bf049af4a3efeed1568141eaf0a2816f

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/simple_form-theme.svg)](https://badge.fury.io/rb/simple_form-theme)
+
 # SimpleForm::Theme
 Short description and motivation.
 
@@ -34,13 +36,31 @@ However, if you install the gem, you will get the latest updates and improvement
 
 ## Usage
 
-### Install Tailwind CSS initializer
+### Install Tailwind CSS files
 
 ```bash
 bin/rails generate simple_form:theme:tailwind install
 ```
 
-### Install Bulma CSS initializer
+After running this generator, you will see the `config/initializers/simple_form_tailwindcss.rb` file.
+This file adds the Tailwind CSS styles to your application.
+Additionally, the `config/locales/simple_form_tailwind.en.yml` file will add the "required" mark to the required fields.
+However, you need to communicate Tailwind to "watch" those files by adding the following configuration:
+
+```js
+# tailwind.config.js
+
+module.exports = {
+  ...
+  content: [
+    './config/initializers/simple_form_tailwindcss.rb',
+    './config/locales/simple_form*.yml',
+    ...
+  ],
+}
+```
+
+### Install Bulma CSS files
 
 ```bash
 bin/rails generate simple_form:theme:bulma install

data/config/initializers/simple_form.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+#
+# Uncomment this and change the path if necessary to include your own
+# components.
+# See https://github.com/heartcombo/simple_form#custom-components to know
+# more about custom components.
+# Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
+#
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, class: :input,
+    hint_class: :field_with_hint, error_class: :field_with_errors, valid_class: :field_without_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    # and/or database column lengths
+    b.optional :maxlength
+
+    # Calculate minlength from length validations for string inputs
+    b.optional :minlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    # b.use :input, class: 'input', error_class: 'is-invalid', valid_class: 'is-valid'
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+
+    ## full_messages_for
+    # If you want to display the full error message for the attribute, you can
+    # use the component :full_error, like:
+    #
+    # b.use :full_error, wrap_with: { tag: :span, class: :error }
+  end
+
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   inline: input + label
+  #   nested: label > input
+  config.boolean_style = :nested
+
+  # Default class for buttons
+  config.button_class = 'btn'
+
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'error_notification'
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span.
+  # config.item_wrapper_tag = :span
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  # config.label_class = nil
+
+  # You can define the default class to be used on forms. Can be overridden
+  # with `html: { :class }`. Defaulting to none.
+  # config.default_form_class = nil
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
+  # These validations are enabled in SimpleForm's internal config but disabled by default
+  # in this configuration, which is recommended due to some quirks from different browsers.
+  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
+  # change this configuration to true.
+  config.browser_validations = false
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Custom wrappers for input types. This should be a hash containing an input
+  # type as key and the wrapper that will be used for all inputs with specified type.
+  # config.wrapper_mappings = { string: :prepend }
+
+  # Namespaces where SimpleForm should look for custom input classes that
+  # override default inputs.
+  # config.custom_inputs_namespaces << "CustomInputs"
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+
+  # Default class for inputs
+  # config.input_class = nil
+
+  # Define the default class of the input wrapper of the boolean input.
+  config.boolean_label_class = 'checkbox'
+
+  # Defines if the default input wrapper class should be included in radio
+  # collection wrappers.
+  # config.include_default_input_wrapper_class = true
+
+  # Defines which i18n scope will be used in Simple Form.
+  # config.i18n_scope = 'simple_form'
+
+  # Defines validation classes to the input_field. By default it's nil.
+  # config.input_field_valid_class = 'is-valid'
+  # config.input_field_error_class = 'is-invalid'
+end

data/lib/generators/simple_form/theme/tailwind/USAGE

@@ -1,8 +1,6 @@
-Description:
-    Install the simple form tailwindcss config file in your app.
-
-Example:
+Install Command:
     bin/rails generate simple_form:theme:tailwind install
 
     This will create:
         config/initializers/simple_form_tailwindcss.rb
+        config/locales/

data/lib/generators/simple_form/theme/tailwind/tailwind_generator.rb

@@ -3,8 +3,27 @@
 class SimpleForm::Theme::TailwindGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
-  desc 'Copy the tailwindcss initializer file for simple_form'
-  def copy_initializer_file
+  desc 'Copy the tailwindcss files for simple_form'
+  def generate
+    install if install?
+  end
+
+  private
+
+  def install
+    copy_initializers
+    copy_locales
+  end
+
+  def install?
+    name == 'install'
+  end
+
+  def copy_initializers
     template 'config/initializers/simple_form_tailwindcss.rb', 'config/initializers/simple_form_tailwindcss.rb'
   end
+
+  def copy_locales
+    directory 'config/locales'
+  end
 end

data/lib/generators/simple_form/theme/tailwind/templates/config/locales/simple_form_tailwind.en.yml

@@ -0,0 +1,6 @@
+en:
+  simple_form:
+    required:
+      text: 'required'
+      mark: '*'
+      html: '<abbr class="text-red-500 no-underline" title="required">*</abbr>'

data/lib/simple_form/theme/version.rb

@@ -1,5 +1,5 @@
 module SimpleForm
   module Theme
-    VERSION = '0.1.1'
+    VERSION = '0.1.3'
   end
 end

data/lib/simple_form/theme.rb

@@ -1,7 +1,12 @@
-require "simple_form/theme/version"
-require "simple_form/theme/engine"
+# frozen_string_literal: true
+
+require 'simple_form/theme/version'
+require 'simple_form/theme/engine'
+
+require 'simple_form'
 
 module SimpleForm
+  # SimpleFormTheme
   module Theme
     # Your code goes here...
   end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: simple_form-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Juan Vasquez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.7
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.7.8
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.7
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.7.8
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: simple_form
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +62,7 @@ files:
 - app/mailers/simple_form/theme/application_mailer.rb
 - app/models/simple_form/theme/application_record.rb
 - app/views/layouts/simple_form/theme/application.html.erb
+- config/initializers/simple_form.rb
 - config/routes.rb
 - lib/generators/simple_form/theme/bulma/USAGE
 - lib/generators/simple_form/theme/bulma/bulma_generator.rb
@@ -69,6 +70,7 @@ files:
 - lib/generators/simple_form/theme/tailwind/USAGE
 - lib/generators/simple_form/theme/tailwind/tailwind_generator.rb
 - lib/generators/simple_form/theme/tailwind/templates/config/initializers/simple_form_tailwindcss.rb
+- lib/generators/simple_form/theme/tailwind/templates/config/locales/simple_form_tailwind.en.yml
 - lib/simple_form/theme.rb
 - lib/simple_form/theme/engine.rb
 - lib/simple_form/theme/version.rb
@@ -89,6 +91,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.6.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="