view_component_storybook 0.9.0 → 0.10.0

data/lib/view_component/storybook/story_config.rb

@@ -4,37 +4,76 @@ module ViewComponent
   module Storybook
     class StoryConfig
       include ActiveModel::Validations
+      include ContentConcern
+      include Controls::ControlsHelpers
 
-      attr_reader :id, :name, :component
-      attr_accessor :parameters, :layout, :content_block
+      attr_reader :id, :name, :component_class
 
       validate :validate_constructor_args
 
-      def initialize(id, name, component, layout)
+      def initialize(id, name, component_class, layout)
         @id = id
         @name = name
-        @component = component
+        @component_class = component_class
         @layout = layout
+        @slots ||= {}
       end
 
-      def constructor_args(*args, **kwargs, &block)
-        if args.empty? && kwargs.empty? && block.nil?
-          @constructor_args ||= ViewComponent::Storybook::MethodArgs::ControlMethodArgs.new(component_constructor)
+      def constructor(*args, **kwargs, &block)
+        @constructor_args = MethodArgs::ControlMethodArgs.new(
+          component_constructor,
+          *args,
+          **kwargs
+        )
+        content(nil, &block)
+
+        self
+      end
+
+      # Once deprecated block version is removed make this a private getter
+      def controls(&block)
+        if block_given?
+          ActiveSupport::Deprecation.warn("`controls` will be removed in v1.0.0. Use `#constructor` instead.")
+          controls_dsl = Dsl::LegacyControlsDsl.new
+          controls_dsl.instance_eval(&block)
+
+          controls_hash = controls_dsl.controls.index_by(&:param)
+          constructor(**controls_hash)
         else
-          @constructor_args = ViewComponent::Storybook::MethodArgs::ControlMethodArgs.new(
-            component_constructor,
-            *args,
-            **kwargs,
-            &block
-          )
+          list = constructor_args.controls.dup
+          list << content_control if content_control
+          list += slots.flat_map(&:controls) if slots
+          list
         end
       end
 
+      def layout(layout = nil)
+        @layout = layout unless layout.nil?
+        @layout
+      end
+
+      def parameters(parameters = nil)
+        @parameters = parameters unless parameters.nil?
+        @parameters
+      end
+
+      def method_missing(method_name, *args, **kwargs, &block)
+        if component_class.slot_type(method_name)
+          slot(method_name, *args, **kwargs, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, _include_private = false)
+        component_class.slot_type(method_name).present?
+      end
+
       def to_csf_params
         validate!
         csf_params = { name: name, parameters: { server: { id: id } } }
         csf_params.deep_merge!(parameters: parameters) if parameters.present?
-        constructor_args.controls.each do |control|
+        controls.each do |control|
           csf_params.deep_merge!(control.to_csf_params)
         end
         csf_params
@@ -44,17 +83,25 @@ module ViewComponent
         valid? || raise(ValidationError, self)
       end
 
-      def self.configure(id, name, component, layout, &configuration)
-        config = new(id, name, component, layout)
-        ViewComponent::Storybook::Dsl::StoryDsl.evaluate!(config, &configuration)
-        config
-      end
+      ##
+      # Build a Story from this config
+      # * Resolves the values of the constructor args from the params
+      # * constructs the component
+      # * resolve the content_control and content_block to a single block
+      # * builds a list of Slots by resolving their args from the params
+      def story(params)
+        # constructor_args.target_method is UnboundMethod so can't call it directly
+        component = constructor_args.call(params) do |*args, **kwargs|
+          component_class.new(*args, **kwargs)
+        end
 
-      def validate_constructor_args
-        return if constructor_args.valid?
+        story_content_block = resolve_content_block(params)
 
-        constructor_args_errors = constructor_args.errors.full_messages.join(', ')
-        errors.add(:constructor_args, :invalid, errors: constructor_args_errors)
+        story_slots = slots.map do |slot_config|
+          slot_config.slot(component, params)
+        end
+
+        Storybook::Story.new(component, story_content_block, story_slots, layout)
       end
 
       class ValidationError < StandardError
@@ -69,8 +116,52 @@ module ViewComponent
 
       private
 
+      def constructor_args
+        @constructor_args ||= MethodArgs::ControlMethodArgs.new(component_constructor)
+      end
+
       def component_constructor
-        component.instance_method(:initialize)
+        component_class.instance_method(:initialize)
+      end
+
+      def slots
+        @slots.values.flatten
+      end
+
+      def validate_constructor_args
+        return if constructor_args.valid?
+
+        constructor_args_errors = constructor_args.errors.full_messages.join(', ')
+        errors.add(:constructor_args, :invalid, errors: constructor_args_errors)
+      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
+          # generate a unique param generated by the count of slots with this name already added
+          @slots[slot_name] ||= []
+          slot_index = @slots[slot_name].count + 1
+          slot_config = Slots::SlotConfig.from_component(
+            component_class,
+            slot_name,
+            "#{slot_name}#{slot_index}".to_sym,
+            *args,
+            **kwargs,
+            &block
+          )
+          @slots[slot_name] << slot_config
+        else
+          slot_config = Slots::SlotConfig.from_component(
+            component_class,
+            slot_name,
+            slot_name,
+            *args,
+            **kwargs,
+            &block
+          )
+          @slots[slot_name] = slot_config
+        end
+        slot_config
       end
     end
   end

data/lib/view_component/storybook/tasks/write_stories_json.rake

@@ -12,7 +12,7 @@ namespace :view_component_storybook do
       exceptions << e
     end
 
-    raise StandardError, exceptions.map(:message).join(", ") if exceptions.present?
+    raise StandardError, exceptions.map(&:message).join(", ") if exceptions.present?
 
     puts "Done"
   end

data/lib/view_component/storybook/version.rb

@@ -2,6 +2,6 @@
 
 module ViewComponent
   module Storybook
-    VERSION = "0.9.0"
+    VERSION = "0.10.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_storybook
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jon Palmer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2021-08-08 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.2'
+        version: '2.36'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.36'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -177,29 +191,33 @@ files:
 - app/views/view_component/storybook/stories/show.html.erb
 - config/locales/en.yml
 - lib/view_component/storybook.rb
+- lib/view_component/storybook/content_concern.rb
 - lib/view_component/storybook/controls.rb
-- lib/view_component/storybook/controls/array_config.rb
+- lib/view_component/storybook/controls/base_options_config.rb
 - lib/view_component/storybook/controls/boolean_config.rb
 - lib/view_component/storybook/controls/color_config.rb
 - lib/view_component/storybook/controls/control_config.rb
+- lib/view_component/storybook/controls/controls_helpers.rb
 - lib/view_component/storybook/controls/custom_config.rb
 - lib/view_component/storybook/controls/date_config.rb
+- lib/view_component/storybook/controls/multi_options_config.rb
 - lib/view_component/storybook/controls/number_config.rb
 - lib/view_component/storybook/controls/object_config.rb
 - lib/view_component/storybook/controls/options_config.rb
 - lib/view_component/storybook/controls/simple_control_config.rb
 - lib/view_component/storybook/controls/text_config.rb
 - lib/view_component/storybook/dsl.rb
-- lib/view_component/storybook/dsl/controls_dsl.rb
 - lib/view_component/storybook/dsl/legacy_controls_dsl.rb
-- lib/view_component/storybook/dsl/story_dsl.rb
 - lib/view_component/storybook/engine.rb
 - lib/view_component/storybook/method_args.rb
 - lib/view_component/storybook/method_args/control_method_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/method_args/validatable_method_args.rb
+- lib/view_component/storybook/slots.rb
+- lib/view_component/storybook/slots/slot.rb
+- lib/view_component/storybook/slots/slot_config.rb
 - lib/view_component/storybook/stories.rb
+- lib/view_component/storybook/story.rb
 - lib/view_component/storybook/story_config.rb
 - lib/view_component/storybook/tasks/write_stories_json.rake
 - lib/view_component/storybook/version.rb
@@ -225,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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

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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Storybook
-    module Controls
-      class ArrayConfig < SimpleControlConfig
-        attr_reader :separator
-
-        validates :separator, presence: true
-
-        def initialize(default_value, separator = ",", param: nil, name: nil)
-          super(default_value, param: param, name: name)
-          @separator = separator
-        end
-
-        def type
-          :array
-        end
-
-        def value_from_params(params)
-          params_value = super(params)
-          if params_value.is_a?(String)
-            params_value.split(separator)
-          else
-            params_value
-          end
-        end
-
-        private
-
-        def csf_control_params
-          super.merge(separator: separator)
-        end
-      end
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Storybook
-    module Dsl
-      class StoryDsl
-        include ControlsDsl
-
-        def self.evaluate!(story_config, &block)
-          new(story_config).instance_eval(&block)
-        end
-
-        def parameters(**params)
-          story_config.parameters = params
-        end
-
-        def controls(&block)
-          ActiveSupport::Deprecation.warn("`controls` will be removed in v1.0.0. Use `#constructor` instead.")
-          controls_dsl = LegacyControlsDsl.new
-          controls_dsl.instance_eval(&block)
-
-          controls_hash = controls_dsl.controls.index_by(&:param)
-          story_config.constructor_args(**controls_hash)
-        end
-
-        def layout(layout)
-          story_config.layout = layout
-        end
-
-        def content(&block)
-          story_config.content_block = block
-        end
-
-        def constructor(*args, **kwargs, &block)
-          story_config.constructor_args(*args, **kwargs)
-          story_config.content_block = block
-        end
-
-        delegate :component, to: :story_config
-
-        private
-
-        attr_reader :story_config
-
-        def initialize(story_config)
-          @story_config = story_config
-        end
-      end
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Storybook
-    module MethodArgs
-      ##
-      # Class representing arguments passed to a method which can be validated
-      # against the args of the target method
-      class ValidatableMethodArgs < MethodArgs
-        include ActiveModel::Validations
-
-        attr_reader :target_method_params_names
-
-        validate :validate_args, :validate_kwargs
-
-        def initialize(target_method, *args, **kwargs, &block)
-          @target_method_params_names = MethodParametersNames.new(target_method)
-          super(args, kwargs, block)
-        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
-  end
-end