storybook_rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3156e720148b32541cf3a26364ab48422d8578c0f77ed0a5af2b79d6464c389c
-  data.tar.gz: 5c8aca3a712de9a7b937967629e465cac1319f339163f3a3e81fcd6877098ac6
+  metadata.gz: 3d9e73c7b0bf6d8f82291a937ef7d37f74621b5e1803d561a7396829ca4f61c3
+  data.tar.gz: ce0f60e3dd44c77e3678287d74ac340b3d5dd3233b1f7d52e31f083d734acb8d
 SHA512:
-  metadata.gz: 1f4973da1272dfb432b3a6cbd8d9fc09430aad699887885f947550c95a6a5045e520c4cf200c2f34b876fb553e4e257d53a32efb5bb173dbaf3653078374d940
-  data.tar.gz: 277c3bf438cc3f5f438072abd7066a76d4b4242e3754d7b0d24cc48123afd037de985aff8a996b146bfb016b1af91b239c580cd6d5ac460d2269db3ddea6835c
+  metadata.gz: 6a7b37fc8c986e55f9926c307e8966b40cc855f0174f2cf9c9fd7b4e2458abe3b634471edcfc007b85b1822f4ca2a231e149cfe995228fa499a7a280f54794b7
+  data.tar.gz: 8f6e2d0188d83131473477881735d314c3f118f3dbe08c6028e5650fe4b58e6b9b804b0df66d3f022043a1f262a5deb5d43e92d2c5db26ff09ed0cfc2340c772

data/LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2020 Jon Palmer
+Copyright (c) 2021 Daniel Pence
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -22,7 +22,7 @@ This gem is a fork of [ViewComponent::Storybook](https://github.com/jonspalmer/v
 #### Configure Asset Hosts
 
 If your views depend on Javascript, CSS or other assets served by the Rails application you will need to configure `asset_hosts`
-apporpriately for your various environments. For local development this is a simple as adding to `config/development.rb`:
+appropriately for your various environments. For local development, do this by adding the following to `config/development.rb`:
 ```ruby
 Rails.application.configure do
   ...
@@ -65,7 +65,7 @@ Equivalent configuration will be necessary in `config/production.rb` or `applica
    };
    ```
 
-#### Webpacker
+### Webpacker
 If your application uses Webpacker to compile your JavaScript and/or CSS, you will need to modify the default Storybook webpack configuration. Please see the [Storybook Webpack config](https://storybook.js.org/docs/react/configure/webpack) for more information on how to do that. Here's an example:
 
 ```javascript
@@ -105,6 +105,26 @@ module.exports = {
 };
 ```
 
+### Optional Nice-To-Haves
+#### Setup File-Watching and Automatically run `rake storybook_rails:write_stories_json`
+For a better developer experience, install your favorite file watching utility, such as [chokidar](https://github.com/kimmobrunfeldt/chokidar-cli) and add a couple scripts to enable automatic regeneration of `*.stories.json` files when you update `*_stories.rb` files:
+
+`yarn add -D chokidar-cli`
+
+In package.json:
+```js
+{
+  ...
+  "scripts": {
+    "storybook:start": "rm -rf node_modules/.cache/storybook && start-storybook",
+    "storybook:write-json": "bundle exec rake storybook_rails:write_stories_json",
+    "storybook:watch": "chokidar '**/*_stories.rb' -c 'yarn storybook:write-json'"
+  },
+  ...
+}
+```
+    
+
 ## Usage
 
 ### Writing Stories
@@ -195,6 +215,17 @@ By Default `storybook_rails` expects to find stories in the folder `test/compone
 config.storybook_rails.stories_path = Rails.root.join("spec/components/stories")
 ```
 
+### Troubleshooting
+#### Restarting Storybook Fails
+If Storybook fails to load with a `cannot get /` error, it could be related to [this issue](https://github.com/storybookjs/storybook/issues/14152). As a workaround, you can update the `yarn storybook` script to remove the `node_modules/.cache/storybook` files before Storybook starts:
+```json
+{
+  "scripts": {
+    "storybook": "rm -rf node_modules/.cache/storybook && start-storybook"
+  }
+}
+```
+
 ### The Story DSL
 
 Coming Soon

data/app/controllers/action_view/storybook/stories_controller.rb

@@ -18,7 +18,7 @@ module ActionView
         story_params = @story.values_from_params(params.permit!.to_h)
         story_params.deep_merge!(story_name: params[:story_name])
 
-        render template: "#{@story.template}", layout: @story.layout, locals: { story_params: story_params }
+        render template: @story.template.to_s, layout: @story.layout, locals: { story_params: story_params }
       end
 
       private

data/lib/action_view/storybook/helpers/story_params.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module StoryParamsHelper
   def story_params
-    params.dig(:story_params)
+    params[:story_params]
   end
 end

data/lib/action_view/storybook/stories.rb

@@ -97,14 +97,14 @@ module ActionView
         end
 
         def default_template
-          "#{name.chomp("Stories").underscore}_stories"
+          "#{name.chomp('Stories').underscore}_stories"
         end
 
         def load_stories
-          if stories_path
-            Dir["#{stories_path}/**/*_stories.rb"].sort.each do |file|
-              require_dependency file
-            end
+          return unless stories_path
+
+          Dir["#{stories_path}/**/*_stories.rb"].sort.each do |file|
+            require_dependency file
           end
         end
 

data/lib/action_view/storybook/story_config.rb

@@ -20,15 +20,15 @@ module ActionView
 
       def to_csf_params
         validate!
-        csf_params = { 
+        csf_params = {
           name: pretty_name(name),
-          parameters: { 
-            server: { 
+          parameters: {
+            server: {
               id: id,
-              params: { 
-                story_name: name 
-              } 
-            } 
+              params: {
+                story_name: name
+              }
+            }
           }
         }
         csf_params.deep_merge!(parameters: parameters) if parameters.present?
@@ -59,10 +59,6 @@ module ActionView
       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?

data/lib/action_view/storybook/version.rb

@@ -2,6 +2,6 @@
 
 module ActionView
   module Storybook
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storybook_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Pence
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler