storybook_rails 1.0.0

data/lib/action_view/storybook/story_config.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module ActionView
+  module Storybook
+    class StoryConfig
+      include ActiveModel::Validations
+
+      attr_reader :id, :name, :template
+      attr_accessor :controls, :parameters, :layout, :content_block
+
+      validate :valid_controls
+
+      def initialize(id, name, layout, template)
+        @id = id
+        @name = name
+        @layout = layout
+        @template = template
+        @controls = []
+      end
+
+      def to_csf_params
+        validate!
+        csf_params = { 
+          name: pretty_name(name),
+          parameters: { 
+            server: { 
+              id: id,
+              params: { 
+                story_name: name 
+              } 
+            } 
+          }
+        }
+        csf_params.deep_merge!(parameters: parameters) if parameters.present?
+        controls.each do |control|
+          csf_params.deep_merge!(control.to_csf_params)
+        end
+        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
+      end
+
+      def self.configure(id, name, layout, template, &configuration)
+        config = new(id, name, layout, template)
+        ActionView::Storybook::Dsl::StoryDsl.evaluate!(config, &configuration)
+        config
+      end
+
+      def pretty_name(name)
+        name.to_s.humanize.titlecase
+      end
+
+      protected
+
+      def valid_controls
+        controls.reject(&:valid?).each do |control|
+          errors.add(:controls, :invalid, value: control)
+        end
+
+        control_names = controls.map(&:name)
+        duplicate_names = control_names.group_by(&:itself).map { |k, v| k if v.length > 1 }.compact
+        return if duplicate_names.empty?
+
+        errors.add(:controls, :invalid, message: "Control #{'names'.pluralize(duplicate_names.count)} #{duplicate_names.to_sentence} are repeated")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+namespace :storybook_rails do
+  desc "Write CSF JSON stories for all Stories"
+  task write_stories_json: :environment do
+    puts "Writing Stories JSON"
+    ActionView::Storybook::Stories.all.each do |stories|
+      json_path = stories.write_csf_json
+      puts "#{stories.name} => #{json_path}"
+    end
+    puts "Done"
+  end
+end

data/lib/action_view/storybook/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActionView
+  module Storybook
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: storybook_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Pence
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: relaxed-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !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.9'
+description: Generate Storybook CSF JSON for rendering Rails View Partials in Storybook
+email:
+- danieldpence@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- app/controllers/action_view/storybook/stories_controller.rb
+- app/views/action_view/storybook/stories/show.html.erb
+- lib/action_view/storybook.rb
+- lib/action_view/storybook/controls.rb
+- lib/action_view/storybook/controls/array_config.rb
+- lib/action_view/storybook/controls/boolean_config.rb
+- lib/action_view/storybook/controls/color_config.rb
+- lib/action_view/storybook/controls/control_config.rb
+- lib/action_view/storybook/controls/date_config.rb
+- lib/action_view/storybook/controls/number_config.rb
+- lib/action_view/storybook/controls/object_config.rb
+- lib/action_view/storybook/controls/options_config.rb
+- lib/action_view/storybook/controls/text_config.rb
+- lib/action_view/storybook/dsl.rb
+- lib/action_view/storybook/dsl/controls_dsl.rb
+- lib/action_view/storybook/dsl/story_dsl.rb
+- lib/action_view/storybook/engine.rb
+- lib/action_view/storybook/helpers.rb
+- lib/action_view/storybook/helpers/story_params.rb
+- lib/action_view/storybook/stories.rb
+- lib/action_view/storybook/story_config.rb
+- lib/action_view/storybook/tasks/write_stories_json.rake
+- lib/action_view/storybook/version.rb
+homepage: https://github.com/danieldpence/storybook_rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/danieldpence/storybook_rails
+  source_code_uri: https://github.com/danieldpence/storybook_rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Storybook for Rails Partials
+test_files: []