view_component_storybook 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ef1bcb6cf8fd3beccec9242854aa913bd31fe1c7c44c44cdde6b59be8fd67f
-  data.tar.gz: de047bb6e4e453db106270ba7f28b4d252fed881816266e10b99bb8c2d4b93f0
+  metadata.gz: 0dd708afcf2aa165339b0b1fde82ae610665554e3633c1e50b25509088b43e79
+  data.tar.gz: 950739b2892877a1451c262dc2110d6885a86c740c7fec9cd626a305feb8313d
 SHA512:
-  metadata.gz: 4d96299b59366d1f50d034399299209a7edc01aa99f3ff728b0e6ed1721b1f80679aa8f7bbb953be549baa59fd74d090eb8d5b7e615bdc7b26164ebb0f011373
-  data.tar.gz: d97204b485ac6d1b61c7848e6c2b68cec798328eef7e78738f3f675daa805dc6db73a0e6d1e6e7f17373de4b5ca90cfe000716bb4b25f29f8ae77d9985f0580e
+  metadata.gz: 3f9b37292f202ac1c79fd4d31b9ace6b067efff03bf60a6f6a7b44a241ce5661c3669a382d9e549461dfe391d9c77fe0b9b98d33a3a5a47ce821d47e9c26ec7d
+  data.tar.gz: 8e7db14af389ae4d4b2dbcf269269476ac9309c9e518226afedbef769e31f72d32ed44a61382f9830836cab5a4ceba45a701af0a66861de31f928713be9b6c55

data/lib/view_component/storybook/engine.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rails"
-require "view_component/storybook"
 
 module ViewComponent
   module Storybook
@@ -45,3 +44,14 @@ module ViewComponent
     end
   end
 end
+
+# :nocov:
+unless defined?(ViewComponent::Storybook)
+  ActiveSupport::Deprecation.warn(
+    "This manually engine loading is deprecated and will be removed in v1.0.0. " \
+    "Remove `require \"view_component/storybook/engine\"`."
+  )
+
+  require "view_component/storybook"
+end
+# :nocov:

data/lib/view_component/storybook/method_args/component_constructor_args.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module MethodArgs
+      ##
+      # Class representing the constructor args for a Component
+      class ComponentConstructorArgs < ControlMethodArgs
+        def self.from_component_class(component_class, *args, **kwargs)
+          if DryInitializerComponentConstructorArgs.dry_initialize?(component_class)
+            DryInitializerComponentConstructorArgs.new(component_class, *args, **kwargs)
+          else
+            new(component_class, *args, **kwargs)
+          end
+        end
+
+        def initialize(component_class, *args, **kwargs)
+          super(component_class.instance_method(:initialize), *args, **kwargs)
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/method_args/dry_initializer_component_constructor_args.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module MethodArgs
+      ##
+      # Class representing the constructor args for a Component the extends dry-initializer
+      class DryInitializerComponentConstructorArgs < ControlMethodArgs
+        INITIALIZE_METHOD = :__dry_initializer_initialize__
+
+        ##
+        # Method Parameters names that are dry-initialize aware
+        # THe main difference is that Dry Initializer keyword args cannot be deduced from the constructor initialize params
+        # Instead we have to introspect the dry_initializer config for the option definitions
+        class DryConstructorParametersNames < MethodParametersNames
+          attr_reader :dry_initializer
+
+          def initialize(component_class)
+            super(component_class.instance_method(INITIALIZE_METHOD))
+            @dry_initializer = component_class.dry_initializer
+          end
+
+          # Required keywords are the only thing we need.
+          # We could define kwarg_names similarly but wihout the `optional` check. However, dry-initializer
+          # always ends has supports_keyrest? == true so kwarg_names isn't needed
+          def req_kwarg_names
+            @req_kwarg_names ||= dry_initializer.definitions.map do |name, definition|
+              name if definition.option && !definition.optional
+            end.compact
+          end
+        end
+
+        def self.dry_initialize?(component_class)
+          component_class.private_method_defined?(INITIALIZE_METHOD)
+        end
+
+        def initialize(component_class, *args, **kwargs)
+          super(component_class.instance_method(INITIALIZE_METHOD), *args, **kwargs)
+
+          @target_method_params_names = DryConstructorParametersNames.new(component_class)
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/method_args/method_parameters_names.rb

@@ -57,7 +57,7 @@ module ViewComponent
         def kwarg_names
           @kwarg_names ||= parameters.map do |type, name|
             name if KWARG_TYPES.include?(type)
-          end.compact.to_set
+          end.compact
         end
 
         def arg_names

data/lib/view_component/storybook/method_args.rb

@@ -9,8 +9,9 @@ module ViewComponent
 
       autoload :MethodArgs
       autoload :MethodParametersNames
-      autoload :ValidatableMethodArgs
       autoload :ControlMethodArgs
+      autoload :ComponentConstructorArgs
+      autoload :DryInitializerComponentConstructorArgs
     end
   end
 end

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

@@ -4,10 +4,13 @@ module ViewComponent
   module Storybook
     module Slots
       class SlotConfig
+        include ActiveModel::Validations
         include ContentConcern
 
         attr_reader :slot_name, :slot_method_args, :param, :content_block
 
+        validate :validate_slot_method_args
+
         def initialize(slot_name, slot_method_args, param, content_block)
           @slot_name = slot_name
           @slot_method_args = slot_method_args
@@ -16,11 +19,12 @@ module ViewComponent
         end
 
         def self.from_component(component_class, slot_name, param, *args, **kwargs, &block)
-          slot_method_args =
-            MethodArgs::ControlMethodArgs
-            .new(component_class.instance_method(slot_name), *args, **kwargs)
-            .with_param_prefix(param)
-          new(slot_name, slot_method_args, param, block)
+          new(
+            slot_name,
+            slot_method_args(component_class, slot_name, *args, **kwargs).with_param_prefix(param),
+            param,
+            block
+          )
         end
 
         def slot(componeont, params)
@@ -38,6 +42,37 @@ module ViewComponent
         def content_param
           "#{param}__content".to_sym
         end
+
+        private
+
+        def validate_slot_method_args
+          return if slot_method_args.valid?
+
+          slot_method_args_errors = slot_method_args.errors.full_messages.join(', ')
+          errors.add(:slot_method_args, :invalid, errors: slot_method_args_errors)
+        end
+
+        def self.slot_method_args(component_class, slot_name, *args, **kwargs)
+          # Reverse engineer the signature of the slot so that we can validate control args to the slot
+          # The slot methods themselves just have rest params so we can't introspect them. Instead we
+          # look for 'renderable' details of the registered slot
+          # This approach is tightly coupled to internal ViewCopmonent apis and might prove to be brittle
+          registred_slot_name = component_class.slot_type(slot_name) == :collection_item ? ActiveSupport::Inflector.pluralize(slot_name).to_sym : slot_name
+
+          registered_slot = component_class.registered_slots[registred_slot_name]
+
+          if registered_slot[:renderable] || registered_slot[:renderable_class_name]
+            # The slot is a component - either a class or a string representing the class
+            component_class = registered_slot[:renderable] || component_class.const_get(registered_slot[:renderable_class_name])
+            MethodArgs::ComponentConstructorArgs.from_component_class(component_class, *args, **kwargs)
+          else
+            # the slot is a lamba or a simple content slot
+            slot_lamba = registered_slot[:renderable_function] || proc {}
+            MethodArgs::ControlMethodArgs.new(slot_lamba, *args, **kwargs)
+          end
+        end
+
+        private_class_method :slot_method_args
       end
     end
   end

data/lib/view_component/storybook/stories.rb

@@ -47,9 +47,7 @@ module ViewComponent
 
         def write_csf_json
           json_path = File.join(stories_path, "#{stories_name}.stories.json")
-          File.open(json_path, "w") do |f|
-            f.write(JSON.pretty_generate(to_csf_params))
-          end
+          File.write(json_path, JSON.pretty_generate(to_csf_params))
           json_path
         end
 

data/lib/view_component/storybook/story_config.rb

@@ -9,7 +9,7 @@ module ViewComponent
 
       attr_reader :id, :name, :component_class
 
-      validate :validate_constructor_args
+      validate :validate_constructor_args, :validate_slots_args
 
       def initialize(id, name, component_class, layout)
         @id = id
@@ -20,8 +20,8 @@ module ViewComponent
       end
 
       def constructor(*args, **kwargs, &block)
-        @constructor_args = MethodArgs::ControlMethodArgs.new(
-          component_constructor,
+        @constructor_args = MethodArgs::ComponentConstructorArgs.from_component_class(
+          component_class,
           *args,
           **kwargs
         )
@@ -117,11 +117,7 @@ module ViewComponent
       private
 
       def constructor_args
-        @constructor_args ||= MethodArgs::ControlMethodArgs.new(component_constructor)
-      end
-
-      def component_constructor
-        component_class.instance_method(:initialize)
+        @constructor_args ||= MethodArgs::ComponentConstructorArgs.from_component_class(component_class)
       end
 
       def slots
@@ -135,6 +131,13 @@ module ViewComponent
         errors.add(:constructor_args, :invalid, errors: constructor_args_errors)
       end
 
+      def validate_slots_args
+        slots.reject(&:valid?).each do |slot_config|
+          slot_errors = slot_config.errors.full_messages.join(', ')
+          errors.add(:slots, :invalid, errors: slot_errors)
+        end
+      end
+
       def slot(slot_name, *args, **kwargs, &block)
         # if the name is a slot then build a SlotConfig with slot_name and param the same
         if component_class.slot_type(slot_name) == :collection_item

data/lib/view_component/storybook/version.rb

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

data/lib/view_component/storybook.rb

@@ -41,6 +41,17 @@ module ViewComponent
       "/rails/stories"
     end
 
+    # :nocov:
+    if defined?(ViewComponent::Storybook::Engine)
+      ActiveSupport::Deprecation.warn(
+        "This manually engine loading is deprecated and will be removed in v1.0.0. " \
+        "Remove `require \"view_component/storybook/engine\"`."
+      )
+    elsif defined?(Rails::Engine)
+      require "view_component/storybook/engine"
+    end
+    # :nocov:
+
     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.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Jon Palmer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-08 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: view_component
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +224,9 @@ files:
 - lib/view_component/storybook/dsl/legacy_controls_dsl.rb
 - lib/view_component/storybook/engine.rb
 - lib/view_component/storybook/method_args.rb
+- lib/view_component/storybook/method_args/component_constructor_args.rb
 - lib/view_component/storybook/method_args/control_method_args.rb
+- lib/view_component/storybook/method_args/dry_initializer_component_constructor_args.rb
 - lib/view_component/storybook/method_args/method_args.rb
 - lib/view_component/storybook/method_args/method_parameters_names.rb
 - lib/view_component/storybook/slots.rb
@@ -228,6 +244,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/jonspalmer/view_component_storybook
   source_code_uri: https://github.com/jonspalmer/view_component_storybook
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -243,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Storybook for Rails View Components