lookbook 0.9.4 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5617747c0cc6eca338a14139a9bc770b155656496676d5bc1b1ffbc61f08a0c4
-  data.tar.gz: ec66261ebd66850c9e30893825d3bd03096e2425c207dc449b12f0bb2489f9c6
+  metadata.gz: 5e37b94615d684a28d33c6e058e62511007997df7ac6fc834a524e87aac05180
+  data.tar.gz: 81888f9888ada74bef21cc7f9ff37842e568789d9892aafd17e6c95b131e70f8
 SHA512:
-  metadata.gz: 9c9e23c5e73b16775efa80595fb06323f09417e62ece899aaae648c677ac30885e0dd354b7032cd74e85a04447754f55a88ef0f0ad62d9d69998958edb15d783
-  data.tar.gz: b6c78c07414bbe524881cd04719d0b04c69b470a70862f09bdfe2804fe33ab36b658298a5807726a413f0ae20bddaadbc7c60fff3632f9ac04dfc524c9437564
+  metadata.gz: b70b963ad24e380ca914a28bb7456a490ac8ad1de6cc87fe8afda2cfc48f7219cc73a864e74dfab05795f3ee16c0b935a1f283f76e4b7fc809400845eb695e40
+  data.tar.gz: b3c4da6fe93b94bdd2c7b58d1a9d21451e4e12ebdbe550b529203859518bf50a77edc80c7284e2d6de35bde22b6fef77bff9993c644662c59d7f489340f75526

data/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-<h1>👀 Lookbook 👀</h1>
+<h1>Lookbook</h1>
 
 <p>A native development UI for <a href="http://viewcomponent.org/">ViewComponent</a></p>
 
@@ -13,7 +13,9 @@
 ---
 
 <div align="center">
-<a href="#installing">Installing</a> • <a href="#previews">Previews</a>  • <a href="#pages">Pages</a> • <a href="#deployment">Deployment</a> • <a href="#config">Config</a>
+
+<p><a href="#installing">Installing</a> • <a href="#previews">Previews</a>  • <a href="#pages">Pages</a> • <a href="#deployment">Deployment</a> • <a href="#config">Config</a></p>
+<p><a href="#beta-info">🚨 Lookbook v1.0 (beta) - testers wanted! 🚨</a></p>
 </div>
 
 ---
@@ -26,16 +28,32 @@ Lookbook uses [RDoc/Yard-style comment tags](#annotating-preview-files) to exten
 
 ![Lookbook UI](.github/assets/lookbook_screenshot.png)
 
-### Features
 
-- Tree-style navigation menu with live search/filter
-- Resizable preview window for responsive testing
-- Highlighted preview source code and HTML output
-- Auto-updating UI when component or preview files are updated _(Rails v6.0+ only)_
-- Use comment tag annotations for granular customisation of the preview experience
-- Fully compatible with standard the ViewComponent preview system
-- In-browser live-editable preview parameters (similar to basic Storybook Controls/Knobs)
-- [**Experimental**] Markdown-powerered documentation pages with embeddable previews
+<h2 id="beta-info">🚨 Lookbook v1.0 (beta)</h3>
+
+The Lookbook v1.0 release is coming soon with a bunch of new features and under-the hood improvements.
+
+### Testing out the beta
+
+If you are already using Lookbook in your project, just update the Lookbook gem to the latest beta release and then head over to the [beta documentation site](https://beta.lookbook.build/) to read more about the new features.
+
+```ruby
+gem "lookbook", ">= 1.0.0.beta.7"
+```
+
+If you are **new to Lookbook** then check out the <a href="https://beta.lookbook.build/guide/quick-start/">v1.0 quick start guide</a> for more detailed instructions on installing Lookbook in your project
+
+> Please do <a href="https://github.com/allmarkedup/lookbook/issues">open an issue</a> or <a href="https://github.com/allmarkedup/lookbook/discussions">start a discussion</a> if you need any help with anything. Comments, feedback and suggestions are always appreciated!
+
+<h4>Useful Resources</h4>
+
+* 👉 <a href="https://lookbook-demo-app-v1-0-beta.herokuapp.com/lookbook">v1.0 demo app</a> <em>(The repo for the demo app <a href="https://github.com/allmarkedup/lookbook-demo/tree/v1.0-beta">is here</a> if you want to dig in further)</em>
+* 👉 <a href="https://beta.lookbook.build/">v1.0 documentation site</a> _(work in progress!)_
+* 👉 <a href="https://github.com/allmarkedup/lookbook/tree/v1.0-beta">v1.0-beta branch</a> 
+
+---
+
+**⚠️ Note: The rest of the documentation on this page is related to the current, stable `v0.9.x` branch.**
 
 ## Lookbook demo
 

data/app/controllers/lookbook/application_controller.rb

@@ -1,5 +1,6 @@
 module Lookbook
   class ApplicationController < ActionController::Base
+    content_security_policy false, if: -> { Rails.env.development? }
     protect_from_forgery with: :exception
 
     helper Lookbook::ApplicationHelper

data/lib/lookbook/engine.rb

@@ -2,6 +2,7 @@ require "rails"
 require "view_component"
 require "action_cable/engine"
 require "listen"
+require "rake"
 
 module Lookbook
   class << self
@@ -83,10 +84,36 @@ module Lookbook
       @preview_controller = Lookbook.config.preview_controller.constantize
       @preview_controller.include(Lookbook::PreviewController)
 
+      if Gem::Version.new(Rails.version) >= Gem::Version.new("6.1.3.1")
+        # Rails.application.server is only available for newer Rails versions
+        Rails.application.server do
+          init_listeners
+        end
+      else
+        # Fallback for older Rails versions - don't start listeners if running in a rake task.
+        unless File.basename($0) == "rake" || Rake.application.top_level_tasks.any?
+          init_listeners 
+        end
+      end
+
+      if config.lookbook.runtime_parsing
+        Lookbook::Engine.parser.parse
+      else
+        unless File.exist?(config.lookbook.parser_registry_path)
+          Lookbook.logger.warn "
+            Runtime parsing is disabled but no registry file has been found.
+            Did you run `rake lookbook:preparse` before starting the app?
+            Expected to find registry file at #{config.lookbook.parser_registry_path}
+          "
+        end
+      end
+    end
+
+    def init_listeners
       if config.lookbook.listen
         @preview_listener = Listen.to(*config.lookbook.listen_paths, only: /\.(#{config.lookbook.listen_extensions.join("|")})$/) do |modified, added, removed|
           begin
-            parser.parse
+            Lookbook::Engine.parser.parse
           rescue
           end
           Lookbook::Preview.clear_cache
@@ -109,18 +136,6 @@ module Lookbook
           @page_listener.start
         end
       end
-
-      if config.lookbook.runtime_parsing
-        parser.parse
-      else
-        unless File.exist?(config.lookbook.parser_registry_path)
-          Lookbook.logger.warn "
-            Runtime parsing is disabled but no registry file has been found.
-            Did you run `rake lookbook:preparse` before starting the app?
-            Expected to find registry file at #{config.lookbook.parser_registry_path}
-          "
-        end
-      end
     end
 
     at_exit do
@@ -141,9 +156,9 @@ module Lookbook
           @websocket ||= if Rails.version.to_f >= 6.0
             ActionCable::Server::Base.new(config: cable)
           else
-            @websocket ||= ActionCable::Server::Base.new
-            @websocket.config = cable
-            @websocket
+            ws = ActionCable::Server::Base.new
+            ws.config = cable
+            ws
           end
         end
       end

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "0.9.4"
+  VERSION = "0.9.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lookbook
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.7
 platform: ruby
 authors:
 - Mark Perkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable