view_component_storybook 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dd708afcf2aa165339b0b1fde82ae610665554e3633c1e50b25509088b43e79
-  data.tar.gz: 950739b2892877a1451c262dc2110d6885a86c740c7fec9cd626a305feb8313d
+  metadata.gz: d7004b9355be5188f56964a21b76fd5e4929917a8a7db77fade82564cb54db30
+  data.tar.gz: 869698caed29c33a261571a8e064d5cc260f0882ceea11a7b2652981934d12bf
 SHA512:
-  metadata.gz: 3f9b37292f202ac1c79fd4d31b9ace6b067efff03bf60a6f6a7b44a241ce5661c3669a382d9e549461dfe391d9c77fe0b9b98d33a3a5a47ce821d47e9c26ec7d
-  data.tar.gz: 8e7db14af389ae4d4b2dbcf269269476ac9309c9e518226afedbef769e31f72d32ed44a61382f9830836cab5a4ceba45a701af0a66861de31f928713be9b6c55
+  metadata.gz: f067153bdb1ebfacf6a95c62bfe82c591f4984b621d7c37694202a31b1be333fd723f875127d16de037d6751e3474e0c31f4ea760b569166062deb27d13107e0
+  data.tar.gz: 22be61b5dee0d65f0641a167bfc848346bd10212dc6d5c76fd3c6de55e819aa0203c766f1c46a06c3a59dc0253e15a49aa65cd406833c6bddb5c40570c1e4ae6

data/lib/view_component/storybook/controls/base_options_config.rb

@@ -8,8 +8,8 @@ module ViewComponent
 
         validates :type, :options, presence: true
 
-        def initialize(type, options, default_value, labels: nil, param: nil, name: nil)
-          super(default_value, param: param, name: name)
+        def initialize(type, options, default_value, labels: nil, param: nil, name: nil, description: nil)
+          super(default_value, param: param, name: name, description: description)
           @type = type
           @options = options
           @labels = labels

data/lib/view_component/storybook/controls/color_config.rb

@@ -6,8 +6,8 @@ module ViewComponent
       class ColorConfig < SimpleControlConfig
         attr_reader :preset_colors
 
-        def initialize(default_value, preset_colors: nil, param: nil, name: nil)
-          super(default_value, param: param, name: name)
+        def initialize(default_value, preset_colors: nil, param: nil, name: nil, description: nil)
+          super(default_value, param: param, name: name, description: description)
           @preset_colors = preset_colors
         end
 

data/lib/view_component/storybook/controls/control_config.rb

@@ -8,9 +8,10 @@ module ViewComponent
 
         validates :param, presence: true
 
-        def initialize(param: nil, name: nil)
+        def initialize(param: nil, name: nil, description: nil)
           @param = param
           @name = name
+          @description = description
         end
 
         def name(new_name = nil)
@@ -22,6 +23,13 @@ module ViewComponent
           end
         end
 
+        def description(new_description = nil)
+          return @description if new_description.nil?
+
+          @description = new_description
+          self
+        end
+
         def param(new_param = nil)
           return @param if new_param.nil?
 

data/lib/view_component/storybook/controls/date_config.rb

@@ -4,8 +4,8 @@ module ViewComponent
   module Storybook
     module Controls
       class DateConfig < SimpleControlConfig
-        def initialize(default_value, param: nil, name: nil)
-          super(default_value, param: param, name: name)
+        def initialize(default_value, param: nil, name: nil, description: nil)
+          super(default_value, param: param, name: name, description: description)
         end
 
         def type

data/lib/view_component/storybook/controls/multi_options_config.rb

@@ -9,8 +9,8 @@ module ViewComponent
         validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
         validate :validate_default_value, unless: -> { options.nil? || default_value.nil? }
 
-        def initialize(type, options, default_value, labels: nil, param: nil, name: nil)
-          super(type, options, Array.wrap(default_value), labels: labels, param: param, name: name)
+        def initialize(type, options, default_value, labels: nil, param: nil, name: nil, description: nil)
+          super(type, options, Array.wrap(default_value), labels: labels, param: param, name: name, description: description)
         end
 
         def value_from_params(params)

data/lib/view_component/storybook/controls/number_config.rb

@@ -11,8 +11,8 @@ module ViewComponent
         validates :type, presence: true
         validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
 
-        def initialize(type, default_value, min: nil, max: nil, step: nil, param: nil, name: nil)
-          super(default_value, param: param, name: name)
+        def initialize(type, default_value, min: nil, max: nil, step: nil, param: nil, name: nil, description: nil)
+          super(default_value, param: param, name: name, description: description)
           @type = type
           @min = min
           @max = max

data/lib/view_component/storybook/controls/simple_control_config.rb

@@ -9,8 +9,8 @@ module ViewComponent
       class SimpleControlConfig < ControlConfig
         attr_reader :default_value
 
-        def initialize(default_value, param: nil, name: nil)
-          super(param: param, name: name)
+        def initialize(default_value, param: nil, name: nil, description: nil)
+          super(param: param, name: name, description: description)
           @default_value = default_value
         end
 
@@ -18,7 +18,9 @@ module ViewComponent
           validate!
           {
             args: { param => csf_value },
-            argTypes: { param => { control: csf_control_params, name: name } }
+            argTypes: {
+              param => { control: csf_control_params, name: name, description: description }.compact
+            }
           }
         end
 

data/lib/view_component/storybook/engine.rb

@@ -11,12 +11,14 @@ module ViewComponent
         options = app.config.view_component_storybook
 
         options.show_stories = Rails.env.development? if options.show_stories.nil?
-        options.stories_route ||= ViewComponent::Storybook.stories_route
+        options.stories_route ||= "/rails/stories"
 
         if options.show_stories
-          options.stories_path ||= defined?(Rails.root) ? Rails.root.join("test/components/stories") : nil
+          options.stories_path ||= defined?(Rails.root) ? Rails.root.join("test/components/stories").to_s : nil
         end
 
+        options.stories_title_generator ||= ViewComponent::Storybook.stories_title_generator
+
         ActiveSupport.on_load(:view_component_storybook) do
           options.each { |k, v| send("#{k}=", v) }
         end
@@ -25,7 +27,11 @@ module ViewComponent
       initializer "view_component.set_autoload_paths" do |app|
         options = app.config.view_component_storybook
 
-        ActiveSupport::Dependencies.autoload_paths << options.stories_path if options.show_stories && options.stories_path
+        if options.show_stories &&
+           options.stories_path &&
+           ActiveSupport::Dependencies.autoload_paths.exclude?(options.stories_path)
+          ActiveSupport::Dependencies.autoload_paths << options.stories_path
+        end
       end
 
       config.after_initialize do |app|
@@ -46,7 +52,7 @@ module ViewComponent
 end
 
 # :nocov:
-unless defined?(ViewComponent::Storybook)
+unless defined?(ViewComponent::Storybook::Stories)
   ActiveSupport::Deprecation.warn(
     "This manually engine loading is deprecated and will be removed in v1.0.0. " \
     "Remove `require \"view_component/storybook/engine\"`."

data/lib/view_component/storybook/slots/slot.rb

@@ -16,7 +16,7 @@ module ViewComponent
         end
 
         def call(&block)
-          component.send(slot_name, *slot_method_args.args, **slot_method_args.kwargs, &block)
+          component.send("with_#{slot_name}", *slot_method_args.args, **slot_method_args.kwargs, &block)
         end
       end
     end

data/lib/view_component/storybook/slots/slot_config.rb

@@ -27,10 +27,10 @@ module ViewComponent
           )
         end
 
-        def slot(componeont, params)
+        def slot(component, params)
           resolved_method_args = slot_method_args.resolve_method_args(params)
           story_content_block = resolve_content_block(params)
-          Slot.new(componeont, slot_name, resolved_method_args, story_content_block)
+          Slot.new(component, slot_name, resolved_method_args, story_content_block)
         end
 
         def controls

data/lib/view_component/storybook/stories.rb

@@ -99,7 +99,7 @@ module ViewComponent
         def inherited(other)
           super(other)
           # setup class defaults
-          other.stories_title = other.stories_name.humanize.titlecase
+          other.stories_title = Storybook.stories_title_generator.call(other)
           other.story_configs = []
         end
 

data/lib/view_component/storybook/version.rb

@@ -2,6 +2,6 @@
 
 module ViewComponent
   module Storybook
-    VERSION = "0.11.0"
+    VERSION = "0.12.0"
   end
 end

data/lib/view_component/storybook.rb

@@ -37,9 +37,7 @@ module ViewComponent
     #
     # Defaults to `/rails/stories` when `show_stories` is enabled.
     #
-    mattr_accessor :stories_route, instance_writer: false do
-      "/rails/stories"
-    end
+    mattr_accessor :stories_route, instance_writer: false
 
     # :nocov:
     if defined?(ViewComponent::Storybook::Engine)
@@ -52,6 +50,15 @@ module ViewComponent
     end
     # :nocov:
 
+    # Define how component stories titles are generated:
+    #
+    #     config.view_component_storybook.stories_title_generator = lambda { |stories|
+    #       stories.stories_name.humanize.upcase
+    #     }
+    #
+    mattr_accessor :stories_title_generator, instance_writer: false,
+                                             default: ->(stories) { stories.stories_name.humanize.titlecase }
+
     ActiveSupport.run_load_hooks(:view_component_storybook, self)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_storybook
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Jon Palmer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: view_component
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.36'
+        version: '2.54'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.36'
+        version: '2.54'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 description: Generate Storybook CSF JSON for rendering Rails View Components in Storybook
 email:
 - 328224+jonspalmer@users.noreply.github.com
@@ -253,14 +267,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Storybook for Rails View Components