amber_component 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fe50a4aaf1482572196e8ae5fd9fd7e2f04ef1ee07b9b5275b0454623e54a6d
-  data.tar.gz: 17c1e2848263efac38a029621d26a8d2eae5b4b3d47d2c9eaf8e040b14fe3eae
+  metadata.gz: 46dc65dbef14224da8e0ce373eb07528188c399444eb2b90968c1cf3dc049864
+  data.tar.gz: d547837963b2e6148a0724d961f3ba9fa1f540365a711d40d483a24ccdcf8909
 SHA512:
-  metadata.gz: e566cb7199d6d8c890081557ed20ac02410085992b036b6a603e909a62ac6fb6af0e853910ab02ac087fd8e3bcaf398d59496e7172ac1233d843206785b15509
-  data.tar.gz: 3b8bb6257ba09f3f6fbf98c68a128ab99adfa289e8ee3d674de744052b4b69f7b06c0e5f43a5e7bb4ae54533a78728fea15ba2534b947b4e730869b5e09b8932
+  metadata.gz: 9f060bd9c1a97475c0678ddc5c0df166bf6f05001cde7f43a41bdc130c068b2ea24c15518d384016aeef2e8ef592b2928c305a41aaaa24dcebf038783a96b57b
+  data.tar.gz: 8f2f8029094be9ac3eccbb55b1c46a3c1ed43bb5e7d4c55263bf9bf0a2501862589f7644b8c357ceaa1d8762ea2370125f29c85bce7299925588570ba5118860

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    amber_component (1.1.0)
+    amber_component (1.1.1)
       actionview (>= 6)
       activemodel (>= 6)
       activesupport (>= 6)

data/README.md

@@ -3,7 +3,7 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/ad84af499e9791933a87/maintainability)](https://codeclimate.com/github/amber-ruby/amber_component/maintainability)
 [![CI badge](https://github.com/amber-ruby/amber_component/actions/workflows/ci_ruby.yml/badge.svg)](https://github.com/amber-ruby/amber_component/actions/workflows/ci_ruby.yml)
 [![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Verseth/6a095c79278b074d79feaa4f8ceeb2a8/raw/amber_component__heads_main.json)](https://github.com/amber-ruby/amber_component/actions/workflows/ci_ruby.yml)
-[![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/amber_component)]((https://rubygems.org/gems/amber_component))
+<!-- [![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/amber_component)]((https://rubygems.org/gems/amber_component)) -->
 
 <img src="banner.png" width="500px" style="margin-bottom: 2rem;"/>
 
@@ -54,6 +54,13 @@ Every component consists of:
 - a style file (css, scss, sass etc.)
 - [optional] a JavaScript file with a Stimulus controller (if you installed the gem with `--stimulus`)
 
+`amber_component` automatically detects what kind of view and stylesheet formats your app is configured to use.
+
+So if you've got `haml-rails`, components will be generated with `haml`. When your app uses `slim-rails`, components will be generated with `slim`. When your `Gemfile` contains `sassc-rails`, components will use `scss` etc.
+
+All of these formats can be overridden in
+an initializer or by adding arguments to the component generator.
+
 ```
 app/components/
 ├─ [name]_component.rb
@@ -197,13 +204,20 @@ This will generate a new component in `app/components/[name]_component.rb` along
 app/components/
 ├─ [name]_component.rb
 └─ [name]_component/
-   ├─ style.css
-   ├─ view.html.erb
+   ├─ style.css     # may be `.scss` or `.sass`
+   ├─ view.html.erb # may be `.haml` or `.slim`
    └─ controller.js # if stimulus is configured
 test/components/
 └─ [name]_component_test.rb
 ```
 
+View and stylesheet formats can be overridden by providing options.
+
+```
+-v, [--view=VIEW]          # Indicate what type of view should be generated eg. [:erb, :haml, :slim]
+--styles, -c, [--css=CSS]  # Indicate what type of styles should be generated eg. [:css, :scss, :sass]
+```
+
 ### Component properties
 
 There is a neat prop DSL.
@@ -411,6 +425,21 @@ This makes component views very flexible and convenient.
 <% end %>
 ```
 
+### Configuration
+
+This gem can be configured in an initializer.
+If you used the installer generator it should already be present.
+
+```ruby
+# config/initializers/amber_component.rb
+
+::AmberComponent.configure do |c|
+    c.stimulus = nil # [nil, :importmap, :webpacker, :jsbundling, :webpack, :esbuild, :rollup]
+    c.stylesheet_format = :css # [:css, :scss, :sass]
+    c.view_format = :erb # [:erb, :haml, :slim]
+end
+```
+
 ### Testing Components
 
 ### Rails

data/lib/amber_component/configuration.rb

@@ -4,18 +4,36 @@ module ::AmberComponent
   # Object which stores configuration options
   # for this gem.
   class Configuration
-    # @return [Array<Symbol>]
-    STIMULUS_INTEGRATIONS = %i[importmap jsbundling webpack esbuild rollup].freeze
+    # @return [Set<Symbol>]
+    STIMULUS_INTEGRATIONS = ::Set[nil, :importmap, :webpacker, :jsbundling, :webpack, :esbuild, :rollup]
+    # @return [Set<Symbol>]
+    ALLOWED_STYLES = ::Set.new(%i[css scss sass])
+    # @return [Set<Symbol>]
+    ALLOWED_VIEWS = ::Set.new(%i[erb haml slim])
 
     # How Stimulus.js is bundled in this app.
-    # Possible values: `[nil, :importmap, :jsbundling, :webpack, :esbuild, :rollup]`
+    # Possible values: `[nil, :importmap, :webpacker, :jsbundling, :webpack, :esbuild, :rollup]`
     # `nil` indicates that stimulus should not be used (default behaviour).
     #
     # @return [Symbol, nil]
     attr_reader :stimulus
 
+    # The default format that the generators will use
+    # for the view/template file of a component.
+    # Possible values: `[nil, :erb, :haml, :slim]`
+    #
+    # @return [Symbol, nil]
+    attr_reader :view_format
+
+    # The default format that the generators will use
+    # for the stylesheets of a component.
+    # Possible values: `[nil, :css, :scss, :sass]`
+    #
+    # @return [Symbol, nil]
+    attr_reader :stylesheet_format
+
     # How Stimulus.js is bundled in this app.
-    # Possible values: `[nil, :importmap, :jsbundling, :webpack, :esbuild, :rollup]`
+    # Possible values: `[nil, :importmap, :webpacker, :jsbundling, :webpack, :esbuild, :rollup]`
     # `nil` indicates that stimulus should not be used (default behaviour).
     #
     # @param val [Symbol, String, nil]
@@ -23,13 +41,37 @@ module ::AmberComponent
       val = val&.to_sym
       unless val.nil? || STIMULUS_INTEGRATIONS.include?(val)
         raise(::ArgumentError,
-              "Invalid value for `stimulus` bundling. " \
+              "Invalid value for `#{__method__}` bundling. " \
               "Received #{val.inspect}, expected one of #{STIMULUS_INTEGRATIONS.inspect}")
       end
 
       @stimulus = val
     end
 
+    # @param val [Symbol, String, nil]
+    def stylesheet_format=(val)
+      val = val&.to_sym
+      unless val.nil? || ALLOWED_STYLES.include?(val)
+        raise(::ArgumentError,
+              "Invalid value for `#{__method__}`. " \
+              "Received #{val.inspect}, expected one of #{ALLOWED_STYLES.inspect}")
+      end
+
+      @stylesheet_format = val
+    end
+
+    # @param val [Symbol, String, nil]
+    def view_format=(val)
+      val = val&.to_sym
+      unless val.nil? || ALLOWED_VIEWS.include?(val)
+        raise(::ArgumentError,
+              "Invalid value for `#{__method__}`. " \
+              "Received #{val.inspect}, expected one of #{ALLOWED_VIEWS.inspect}")
+      end
+
+      @view_format = val
+    end
+
     # @return [Boolean]
     def stimulus?
       !@stimulus.nil?

data/lib/amber_component/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ::AmberComponent
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/lib/amber_component/views.rb

@@ -8,7 +8,7 @@ module ::AmberComponent
     # @return [Set<Symbol>]
     VIEW_TYPES_WITH_RUBY = ::Set[:erb, :haml, :slim].freeze
     # @return [Set<Symbol>]
-    ALLOWED_VIEW_TYPES = ::Set[:erb, :haml, :slim, :html, :md, :markdown].freeze
+    ALLOWED_VIEW_TYPES = ::Set[:erb, :haml, :slim, :html].freeze
     # @return [Regexp]
     VIEW_FILE_REGEXP  = /^view\./.freeze
 

data/lib/amber_component.rb

@@ -3,6 +3,7 @@
 require 'active_support'
 require 'active_support/core_ext'
 require 'pathname'
+require 'set'
 
 require_relative 'amber_component/configuration'
 

data/lib/generators/amber_component/install_generator.rb

@@ -10,14 +10,22 @@ module ::AmberComponent
       desc 'Install the AmberComponent gem'
       source_root ::File.expand_path('templates', __dir__)
 
-      # @return [Array<Symbol>]
-      STIMULUS_INTEGRATIONS = %i[stimulus importmap jsbundling webpack esbuild rollup].freeze
-
       class_option :stimulus,
                    desc: "Configure the app to use Stimulus.js wih components to make them interactive " \
-                         "[options: importmap (default), jsbundling, webpack, esbuild, rollup]"
+                         "[options: importmap (default), webpacker (legacy), jsbundling, webpack, esbuild, rollup]"
+
+      class_option :styles,
+                   desc: "Configure the app to generate components with a particular stylesheet format " \
+                         "[options: css (default), scss, sass]"
+
+      class_option :views,
+                   desc: "Configure the app to generate components with a particular view format " \
+                         "[options: erb (default), haml, slim]"
 
       def setup
+        detect_stimulus
+        detect_styles
+        detect_views
         copy_file 'application_component.rb', 'app/components/application_component.rb'
         copy_file 'application_component_test_case.rb', 'test/application_component_test_case.rb'
         append_file 'test/test_helper.rb', "require_relative 'application_component_test_case'"
@@ -30,40 +38,107 @@ module ::AmberComponent
         require_components_css_in 'app/assets/stylesheets/application.scss.sass'
         require_components_css_in 'app/assets/stylesheets/application.sass.scss'
         configure_stimulus
+        create_initializer
       end
 
       private
 
-      def configure_stimulus
-        stimulus = options[:stimulus]&.to_sym
-        return unless stimulus
+      def detect_styles
+        styles_option = options[:styles]&.to_sym
+        if !styles_option.nil? && !Configuration::ALLOWED_STYLES.include?(styles_option)
+          raise ::ArgumentError, "no such `stylesheet_format` as #{styles_option.inspect}"
+        end
 
-        case stimulus
+        @styles =
+          if styles_option
+            styles_option
+          elsif defined?(::SassC)
+            :scss
+          else
+            :css
+          end
+      end
+
+      def detect_views
+        views_option = options[:views]&.to_sym
+        if !views_option.nil? && !Configuration::ALLOWED_VIEWS.include?(views_option)
+          raise ::ArgumentError, "no such `view_format` as #{views_option.inspect}"
+        end
+
+        @views =
+          if views_option
+            views_option
+          elsif defined?(::Haml)
+            :haml
+          elsif defined?(::Slim)
+            :slim
+          else
+            :erb
+          end
+      end
+
+      def detect_stimulus
+        stimulus_option = options[:stimulus]&.to_sym
+        return unless stimulus_option
+
+        case stimulus_option
         when :stimulus
           if defined?(::Jsbundling)
-            stimulus_integration = :jsbundling
-            configure_stimulus_jsbundling
+            stimulus_jsbundling!
+          elsif defined?(::Webpacker)
+            stimulus_webpacker!
           else
-            stimulus_integration = :importmap
-            configure_stimulus_importmap
+            stimulus_importmap!
           end
         when :importmap
-          stimulus_integration = :importmap
-          configure_stimulus_importmap
+          stimulus_importmap!
         when :jsbundling, :webpack, :esbuild, :rollup
-          stimulus_integration = :jsbundling
-          configure_stimulus_jsbundling
+          stimulus_jsbundling!
+        when :webpacker
+          stimulus_webpacker!
+        else
+          raise ::ArgumentError,
+                "no such stimulus integration as `#{options[:stimulus].inspect}`"
         end
+      end
+
+      def assert_styles
+        return if options[:styles].nil?
+        return if options[:styles].nil?
+      end
 
+      def configure_stimulus
+        case @stimulus
+        when :importmap  then configure_stimulus_importmap
+        when :jsbundling then configure_stimulus_jsbundling
+        when :webpacker  then configure_stimulus_webpacker
+        end
+      end
+
+      def create_initializer
         create_file 'config/initializers/amber_component.rb', <<~RUBY
           # frozen_string_literal: true
 
           ::AmberComponent.configure do |c|
-            c.stimulus = :#{stimulus_integration}
+            c.stimulus = #{@stimulus.inspect} # #{Configuration::STIMULUS_INTEGRATIONS.to_a}
+            c.stylesheet_format = #{@styles.inspect} # #{Configuration::ALLOWED_STYLES.to_a}
+            c.view_format = #{@views.inspect} # #{Configuration::ALLOWED_VIEWS.to_a}
           end
         RUBY
       end
 
+      def stimulus_jsbundling!
+        @stimulus = :jsbundling
+      end
+
+      def stimulus_importmap!
+        @stimulus = :importmap
+      end
+
+      def stimulus_webpacker!
+        @stimulus = :webpacker
+      end
+
       def configure_stimulus_importmap
         install_importmap
         install_stimulus
@@ -88,6 +163,17 @@ module ::AmberComponent
         JS
       end
 
+      def configure_stimulus_webpacker
+        install_stimulus
+        append_file 'app/javascript/packs/application.js', %(import "controllers"\n)
+        append_file 'app/javascript/controllers/index.js', %(import "./components"\n)
+        create_file 'app/javascript/controllers/components.js', <<~JS
+          // This file has been created by `amber_component` and will
+          // register all stimulus controllers from your components
+          import { application } from "./application"
+        JS
+      end
+
       # @return [void]
       def install_importmap
         return if ::File.exist?('config/importmap.rb') && defined?(::Importmap)

data/lib/generators/amber_component_generator.rb

@@ -7,33 +7,26 @@ class AmberComponentGenerator < ::Rails::Generators::NamedBase
   desc 'Generate a new component'
   source_root ::File.expand_path('templates', __dir__)
 
-  # @return [Array<Symbol>]
-  VIEW_FORMATS = %i[html erb haml slim].freeze
-  # @return [Array<Symbol>]
-  STYLE_FORMATS = %i[css scss sass].freeze
-
   class_option :view,
                aliases: ['-v'],
-               desc: "Indicate what type of view should be generated eg. #{VIEW_FORMATS}"
+               desc: "Indicate what type of view should be generated " \
+                     "eg. #{::AmberComponent::Configuration::ALLOWED_VIEWS}"
 
   class_option :css,
-               aliases: ['--style', '-c'],
-               desc: "Indicate what type of styles should be generated eg. #{STYLE_FORMATS}"
+               aliases: ['--styles', '-c'],
+               desc: "Indicate what type of styles should be generated " \
+                     "eg. #{::AmberComponent::Configuration::ALLOWED_STYLES}"
 
   def generate_component
-    @view_format = (options[:view] || :html).to_sym
-    @view_format = :html if @view_format == :erb
-
-    @style_format = options[:css]&.to_sym
+    set_view_format
+    set_stylesheet_format
 
-    unless VIEW_FORMATS.include? @view_format
-      puts "No such view format as `#{@view_format}`"
-      return
+    unless ::AmberComponent::Configuration::ALLOWED_VIEWS.include? @view_format
+      raise ::ArgumentError, "No such view format as `#{@view_format}`"
     end
 
-    if !@style_format.nil? && STYLE_FORMATS.include?(@style_format)
-      puts "No such css/style format as `#{@style_format}`"
-      return
+    unless ::AmberComponent::Configuration::ALLOWED_STYLES.include?(@stylesheet_format)
+      raise ::ArgumentError, "No such css/style format as `#{@stylesheet_format}`"
     end
 
     template 'component.rb.erb', "app/components/#{file_path}.rb"
@@ -53,6 +46,14 @@ class AmberComponentGenerator < ::Rails::Generators::NamedBase
 
   private
 
+  def set_view_format
+    @view_format = options[:view]&.to_sym || ::AmberComponent.configuration.view_format || :erb
+  end
+
+  def set_stylesheet_format
+    @stylesheet_format = options[:style]&.to_sym || ::AmberComponent.configuration.stylesheet_format || :css
+  end
+
   # @return [Boolean]
   def stimulus?
     ::AmberComponent.configuration.stimulus?
@@ -90,9 +91,10 @@ class AmberComponentGenerator < ::Rails::Generators::NamedBase
 
   # @return [void]
   def create_stylesheet
-    if (@style_format.nil? && defined?(::SassC)) || @style_format == :scss
+    case @stylesheet_format
+    when :scss
       template 'style.scss.erb', "app/components/#{file_path}/style.scss"
-    elsif @style_format == :sass
+    when :sass
       template 'style.sass.erb', "app/components/#{file_path}/style.sass"
     else
       template 'style.css.erb', "app/components/#{file_path}/style.css"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amber_component
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Ruby-Amber
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview