view_component_storybook 0.5.0 → 0.10.0

data/lib/view_component/storybook/stories.rb

@@ -4,19 +4,31 @@ module ViewComponent
   module Storybook
     class Stories
       extend ActiveSupport::DescendantsTracker
+      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)
@@ -26,6 +38,7 @@ module ViewComponent
         end
 
         def to_csf_params
+          validate!
           csf_params = { title: title }
           csf_params[:parameters] = parameters if parameters.present?
           csf_params[:stories] = story_configs.map(&:to_csf_params)
@@ -33,7 +46,7 @@ module ViewComponent
         end
 
         def write_csf_json
-          json_path = File.join(ViewComponent::Storybook.stories_path, "#{stories_name}.stories.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
@@ -56,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
 
@@ -66,23 +79,34 @@ 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
 
+        # validation - ActiveModel::Validations like but on the class vs the instance
+        def valid?
+          # use an instance so we can enjoy the benefits of ActiveModel::Validations
+          @validation_instance = new
+          @validation_instance.valid?
+        end
+
+        delegate :errors, to: :@validation_instance
+
+        def validate!
+          valid? || raise(ValidationError, @validation_instance)
+        end
+
         private
 
         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
 
         def default_component
           name.chomp("Stories").constantize
-        rescue StandardError
-          nil
         end
 
         def load_stories
@@ -93,14 +117,36 @@ module ViewComponent
           Storybook.stories_path
         end
 
-        def show_stories
-          Storybook.show_stories
-        end
-
         def story_id(name)
           "#{stories_name}/#{name.to_s.parameterize}".underscore
         end
       end
+
+      protected
+
+      def validate_story_configs
+        story_configs.reject(&:valid?).each do |story_config|
+          story_errors = story_config.errors.full_messages.join(', ')
+          errors.add(:story_configs, :invalid_story, story_name: story_config.name, story_errors: story_errors)
+        end
+
+        story_names = story_configs.map(&:name)
+        duplicate_names = story_names.group_by(&:itself).map { |k, v| k if v.length > 1 }.compact
+        return if duplicate_names.empty?
+
+        duplicate_name_sentence = duplicate_names.map { |name| "'#{name}'" }.to_sentence
+        errors.add(:story_configs, :duplicate_stories, count: duplicate_names.count, duplicate_names: duplicate_name_sentence)
+      end
+
+      class ValidationError < StandardError
+        attr_reader :stories
+
+        def initialize(stories)
+          @stories = stories
+
+          super("#{@stories.class.name} invalid: (#{@stories.errors.full_messages.join(', ')})")
+        end
+      end
     end
   end
 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

data/lib/view_component/storybook/story_config.rb

@@ -4,19 +4,73 @@ module ViewComponent
   module Storybook
     class StoryConfig
       include ActiveModel::Validations
+      include ContentConcern
+      include Controls::ControlsHelpers
 
-      attr_reader :id, :name, :component
-      attr_accessor :controls, :parameters, :layout, :content_block
+      attr_reader :id, :name, :component_class
 
-      def initialize(id, name, component, layout)
+      validate :validate_constructor_args
+
+      def initialize(id, name, component_class, layout)
         @id = id
         @name = name
-        @component = component
+        @component_class = component_class
         @layout = layout
-        @controls = []
+        @slots ||= {}
+      end
+
+      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
+          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?
         controls.each do |control|
@@ -25,18 +79,89 @@ module ViewComponent
         csf_params
       end
 
-      def values_from_params(params)
-        controls.map do |control|
-          value = control.value_from_param(params[control.param])
-          value = control.value if value.nil? # nil only not falsey
-          [control.param, value]
-        end.to_h
+      def validate!
+        valid? || raise(ValidationError, self)
+      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
+
+        story_content_block = resolve_content_block(params)
+
+        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
+        attr_reader :story_config
+
+        def initialize(story_config)
+          @story_config = story_config
+
+          super("'#{@story_config.name}' invalid: (#{@story_config.errors.full_messages.join(', ')})")
+        end
+      end
+
+      private
+
+      def constructor_args
+        @constructor_args ||= MethodArgs::ControlMethodArgs.new(component_constructor)
+      end
+
+      def component_constructor
+        component_class.instance_method(:initialize)
+      end
+
+      def slots
+        @slots.values.flatten
       end
 
-      def self.configure(id, name, component, layout, &configuration)
-        config = new(id, name, component, layout)
-        ViewComponent::Storybook::Dsl::StoryDsl.evaluate!(config, &configuration)
-        config
+      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

@@ -4,10 +4,16 @@ namespace :view_component_storybook do
   desc "Write CSF JSON stories for all Stories"
   task write_stories_json: :environment do
     puts "Writing Stories JSON"
+    exceptions = []
     ViewComponent::Storybook::Stories.all.each do |stories|
       json_path = stories.write_csf_json
       puts "#{stories.name} => #{json_path}"
+    rescue StandardError => e
+      exceptions << e
     end
+
+    raise StandardError, exceptions.map(&:message).join(", ") if exceptions.present?
+
     puts "Done"
   end
 end

data/lib/view_component/storybook/version.rb

@@ -2,6 +2,6 @@
 
 module ViewComponent
   module Storybook
-    VERSION = "0.5.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.5.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jon Palmer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-19 00:00:00.000000000 Z
+date: 2021-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: view_component
@@ -16,28 +16,42 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: '1.14'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,84 +86,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.81'
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.81'
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: '0.9'
 description: Generate Storybook CSF JSON for rendering Rails View Components in Storybook
 email:
 - 328224+jonspalmer@users.noreply.github.com
@@ -161,22 +189,35 @@ files:
 - README.md
 - app/controllers/view_component/storybook/stories_controller.rb
 - 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/story_dsl.rb
+- 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/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/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
@@ -195,14 +236,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.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