view_component_storybook 0.9.0 → 0.10.0

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

@@ -9,7 +9,7 @@ module ViewComponent
         validate :validate_value_method_args
 
         def with_value(*args, **kwargs, &block)
-          @value_method_args = ViewComponent::Storybook::MethodArgs::ControlMethodArgs.new(block, *args, **kwargs, &block)
+          @value_method_args = MethodArgs::ControlMethodArgs.new(block, *args, **kwargs)
           @value_method_args.with_param_prefix(param)
           self
         end
@@ -35,9 +35,7 @@ module ViewComponent
         end
 
         def value_from_params(params)
-          method_args = value_method_args.resolve_method_args(params)
-
-          method_args.block.call(*method_args.args, **method_args.kwargs)
+          value_method_args.call(params)
         end
 
         private

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Controls
+      class MultiOptionsConfig < BaseOptionsConfig
+        TYPES = %i[multi-select check inline-check].freeze
+
+        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)
+        end
+
+        def value_from_params(params)
+          params_value = super(params)
+
+          if params_value.is_a?(String)
+            params_value = params_value.split(',')
+            params_value = params_value.map(&:to_sym) if symbol_values
+          end
+          params_value
+        end
+
+        def to_csf_params
+          super.deep_merge(argTypes: { param => { options: options } })
+        end
+
+        private
+
+        def csf_control_params
+          labels.nil? ? super : super.merge(labels: labels)
+        end
+
+        def symbol_values
+          @symbol_values ||= default_value.first.is_a?(Symbol)
+        end
+
+        def validate_default_value
+          errors.add(:default_value, :inclusion) unless default_value.to_set <= options.to_set
+        end
+      end
+    end
+  end
+end

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

@@ -3,33 +3,11 @@
 module ViewComponent
   module Storybook
     module Controls
-      class OptionsConfig < SimpleControlConfig
-        class << self
-          # support the options being a Hash or an Array. Storybook supports either.
-          def inclusion_in(config)
-            case config.options
-            when Hash
-              config.options.values
-            when Array
-              config.options
-            end
-          end
-        end
-
-        TYPES = %i[select multi-select radio inline-radio check inline-check].freeze
+      class OptionsConfig < BaseOptionsConfig
+        TYPES = %i[select radio inline-radio].freeze
 
-        attr_reader :type, :options, :symbol_value
-
-        validates :type, :options, presence: true
         validates :type, inclusion: { in: TYPES }, unless: -> { type.nil? }
-        validates :default_value, inclusion: { in: method(:inclusion_in) }, unless: -> { options.nil? || default_value.nil? }
-
-        def initialize(type, options, default_value, param: nil, name: nil)
-          super(default_value, param: param, name: name)
-          @type = type
-          @options = options
-          @symbol_value = default_value.is_a?(Symbol)
-        end
+        validates :default_value, inclusion: { in: ->(config) { config.options } }, unless: -> { options.nil? || default_value.nil? }
 
         def value_from_params(params)
           params_value = super(params)
@@ -40,10 +18,18 @@ module ViewComponent
           end
         end
 
+        def to_csf_params
+          super.deep_merge(argTypes: { param => { options: options } })
+        end
+
         private
 
         def csf_control_params
-          super.merge(options: options)
+          labels.nil? ? super : super.merge(labels: labels)
+        end
+
+        def symbol_value
+          @symbol_value ||= default_value.is_a?(Symbol)
         end
       end
     end

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

@@ -23,7 +23,7 @@ module ViewComponent
         end
 
         def value_from_params(params)
-          params[param]
+          params.key?(param) ? params[param] : default_value
         end
 
         private

data/lib/view_component/storybook/dsl.rb

@@ -7,8 +7,6 @@ module ViewComponent
     module Dsl
       extend ActiveSupport::Autoload
 
-      autoload :StoryDsl
-      autoload :ControlsDsl
       autoload :LegacyControlsDsl
     end
   end

data/lib/view_component/storybook/dsl/legacy_controls_dsl.rb

@@ -56,8 +56,8 @@ module ViewComponent
           controls << Controls::OptionsConfig.new(:'inline-check', options, value, param: param, name: name)
         end
 
-        def array(param, value, separator = ",", name: nil)
-          controls << Controls::ArrayConfig.new(value, separator, param: param, name: name)
+        def array(param, value, _separator = nil, name: nil)
+          controls << Controls::ObjectConfig.new(value, param: param, name: name)
         end
 
         def date(param, value, name: nil)

data/lib/view_component/storybook/engine.rb

@@ -12,6 +12,7 @@ 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
 
         if options.show_stories
           options.stories_path ||= defined?(Rails.root) ? Rails.root.join("test/components/stories") : nil
@@ -33,7 +34,7 @@ module ViewComponent
 
         if options.show_stories
           app.routes.prepend do
-            get "/rails/stories/*stories/:story" => "view_component/storybook/stories#show", :internal => true
+            get "#{options.stories_route}/*stories/:story" => "view_component/storybook/stories#show", :internal => true
           end
         end
       end

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

@@ -6,9 +6,9 @@ module ViewComponent
       ##
       # Class representing arguments passed to a method which can be validated
       # against the args of the target method
-      # I addition the args and kwargs can contain Controls the values of which can
+      # In addition the args and kwargs can contain Controls the values of which can
       # be resolved from a params hash
-      class ControlMethodArgs < ValidatableMethodArgs
+      class ControlMethodArgs < MethodArgs
         include ActiveModel::Validations::Callbacks
 
         attr_reader :param_prefix
@@ -21,6 +21,15 @@ module ViewComponent
           self
         end
 
+        ##
+        # resolve the controls values from the params
+        # call the target method or block with those values
+        def call(params, &target_block)
+          method_args = resolve_method_args(params)
+
+          (target_block || target_method).call(*method_args.args, **method_args.kwargs)
+        end
+
         def resolve_method_args(params)
           assign_control_params
 
@@ -31,7 +40,7 @@ module ViewComponent
             value_from_params(arg, params)
           end
 
-          MethodArgs.new(args_from_params, kwargs_from_params, block)
+          MethodArgs.new(target_method, *args_from_params, **kwargs_from_params)
         end
 
         def controls
@@ -59,21 +68,15 @@ module ViewComponent
 
           arg.param(param) if arg.param.nil? # don't overrite if set
           # Always add prefix
-          arg.param("#{param_prefix}__#{arg.param}".to_sym) if param_prefix.present?
+          arg.prefix_param(param_prefix) if param_prefix.present?
         end
 
         def value_from_params(arg, params)
-          if control?(arg)
-            value = arg.value_from_params(params)
-            value = arg.default_value if value.nil? # nil only not falsey
-            value
-          else
-            arg
-          end
+          control?(arg) ? arg.value_from_params(params) : arg
         end
 
         def control?(arg)
-          arg.is_a?(ViewComponent::Storybook::Controls::ControlConfig)
+          arg.is_a?(Controls::ControlConfig)
         end
 
         def validate_controls

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

@@ -4,14 +4,47 @@ module ViewComponent
   module Storybook
     module MethodArgs
       ##
-      # Simple class representing arguments passed to a method
+      # Class representing arguments passed to a method which can be validated
+      # against the args of the target method
       class MethodArgs
-        attr_reader :args, :kwargs, :block
+        include ActiveModel::Validations
 
-        def initialize(args, kwargs, block)
+        attr_reader :args, :kwargs, :target_method, :target_method_params_names
+
+        validate :validate_args, :validate_kwargs
+
+        def initialize(target_method, *args, **kwargs)
+          @target_method = target_method
           @args = args
           @kwargs = kwargs
-          @block = block
+          @target_method_params_names = MethodParametersNames.new(target_method)
+        end
+
+        private
+
+        def validate_args
+          arg_count = args.count
+
+          if arg_count > target_method_params_names.max_arg_count
+            errors.add(:args, :too_many, max: target_method_params_names.max_arg_count, count: arg_count)
+          elsif arg_count < target_method_params_names.min_arg_count
+            errors.add(:args, :too_few, min: target_method_params_names.min_arg_count, count: arg_count)
+          end
+        end
+
+        def validate_kwargs
+          kwargs.each_key do |kwarg|
+            unless target_method_params_names.include_kwarg?(kwarg)
+              errors.add(:kwargs, :invalid_arg, kwarg: kwarg)
+            end
+          end
+
+          return if target_method_params_names.covers_required_kwargs?(kwargs.keys)
+
+          expected_keys = target_method_params_names.req_kwarg_names.join(', ')
+          actual_keys = kwargs.keys.join(', ')
+
+          errors.add(:kwargs, :invalid, expected_keys: expected_keys, actual_keys: actual_keys)
         end
       end
     end

data/lib/view_component/storybook/slots.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_support/dependencies/autoload"
+
+module ViewComponent
+  module Storybook
+    module Slots
+      extend ActiveSupport::Autoload
+
+      autoload :SlotConfig
+      autoload :Slot
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Slots
+      class Slot
+        attr_reader :component, :slot_name, :slot_method_args, :content_block
+
+        # delegate :args, :kwargs, :controls, to: :slot_method_args
+
+        def initialize(component, slot_name, slot_method_args, content_block)
+          @component = component
+          @slot_name = slot_name
+          @slot_method_args = slot_method_args
+          @content_block = content_block
+        end
+
+        def call(&block)
+          component.send(slot_name, *slot_method_args.args, **slot_method_args.kwargs, &block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    module Slots
+      class SlotConfig
+        include ContentConcern
+
+        attr_reader :slot_name, :slot_method_args, :param, :content_block
+
+        def initialize(slot_name, slot_method_args, param, content_block)
+          @slot_name = slot_name
+          @slot_method_args = slot_method_args
+          @param = param
+          @content_block = content_block
+        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)
+        end
+
+        def slot(componeont, 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)
+        end
+
+        def controls
+          list = slot_method_args.controls.dup
+          list << content_control if content_control
+          list
+        end
+
+        def content_param
+          "#{param}__content".to_sym
+        end
+      end
+    end
+  end
+end

data/lib/view_component/storybook/stories.rb

@@ -7,19 +7,28 @@ module ViewComponent
       include ActiveModel::Validations
 
       class_attribute :story_configs, default: []
-      class_attribute :parameters, :title, :stories_layout
+      class_attribute :stories_parameters, :stories_title, :stories_layout
 
       validate :validate_story_configs
 
       class << self
+        def title(title = nil)
+          # if no argument is passed act like a getter
+          self.stories_title = title unless title.nil?
+          stories_title
+        end
+
         def story(name, component = default_component, &block)
-          story_config = StoryConfig.configure(story_id(name), name, component, layout, &block)
+          story_config = StoryConfig.new(story_id(name), name, component, layout, &block)
+          story_config.instance_eval(&block)
           story_configs << story_config
           story_config
         end
 
-        def parameters(**params)
-          self.parameters = params
+        def parameters(params = nil)
+          # if no argument is passed act like a getter
+          self.stories_parameters = params unless params.nil?
+          stories_parameters
         end
 
         def layout(layout = nil)
@@ -60,7 +69,7 @@ module ViewComponent
         end
 
         # Find a component stories by its underscored class name.
-        def find_stories(stories_name)
+        def find_story_configs(stories_name)
           all.find { |stories| stories.stories_name == stories_name }
         end
 
@@ -70,7 +79,7 @@ module ViewComponent
         end
 
         # find the story by name
-        def find_story(name)
+        def find_story_config(name)
           story_configs.find { |config| config.name == name.to_sym }
         end
 
@@ -92,7 +101,7 @@ module ViewComponent
         def inherited(other)
           super(other)
           # setup class defaults
-          other.title = other.stories_name.humanize.titlecase
+          other.stories_title = other.stories_name.humanize.titlecase
           other.story_configs = []
         end
 

data/lib/view_component/storybook/story.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Storybook
+    class Story
+      include ActiveModel::Validations
+
+      attr_reader :component, :content_block, :slots, :layout
+
+      def initialize(component, content_block, slots, layout)
+        @component = component
+        @content_block = content_block
+        @slots = slots
+        @layout = layout
+      end
+    end
+  end
+end