lookbook 0.4.0.beta.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 870ef6a17d84bca0a9fbbc421e27c2d6d682965d96c646f44d3db817e5a5e4f2
-  data.tar.gz: 669ce3b709792be5bdf46ac806efdca269d694349e74f759b0997cbbb456792e
+  metadata.gz: 2f5cf46a07c480d8c8c3fe5f0a521ce01a316985f458becf36fb4c73c871f7cf
+  data.tar.gz: 2474c4105e357d9762c5228cee1190194a3b3069c6a9a9dc2afe0cf287339efe
 SHA512:
-  metadata.gz: b0293806f0d57b130c07ae84b5d30fad2625df0cbf2477303d924dddfd42ece6e49b10f15fc0b395fa65adfca3de3ab1096e72565a175bdab14df2af1ba57050
-  data.tar.gz: 2e5ad4ca7957d2684dc367b3a7d89d9922024cfc01cdbcd2567d30b830fe891b815924d64f5b7048783efd42736f41924354255f847850498fd596ba1c25e977
+  metadata.gz: 439aad3227d8e1e3c8d0202c4edf6b93983a2182c7a8d32c120c47f7fcd1c1dcdff675084029172c200d25fe052916b5cdcb812acd378b37af5e793ce5bea613
+  data.tar.gz: ab031ca977f442a1203fb059df65fe763db9e4877eeb594e44b09c63b2f0bd58bc7e6ab409ef2a11d7f33fe5b5a90f8b30a0eadd5114566c619dcc9b62be8a1e

data/README.md

@@ -76,7 +76,7 @@ Lookbook parses [Yard-style comment tags](https://rubydoc.info/gems/yard/file/do
 
 ```ruby
 # @label Basic Button
-# @display bg_color: "#fff"
+# @display bg_color "#fff"
 class ButtonComponentPreview < ViewComponent::Preview
 
   # Primary button
@@ -94,7 +94,7 @@ class ButtonComponentPreview < ViewComponent::Preview
   # ---------------
   # For light-on-dark screens
   #
-  # @display bg_color: "#000"
+  # @display bg_color "#000"
   def secondary
     render ButtonComponent.new(style: :inverted) do
       "Click me"
@@ -143,7 +143,7 @@ The following Lookbook-specific tags are available for use:
 
 * `@label <label>` -[Customise navigation labels](#-label-text)
 * `@hidden` - [Prevent items displaying in the navigation](#-hidden)
-* `@display <key>:<value>` - [Specify params to pass into the preview template](#-display-key-value)
+* `@display <key> <value>` - [Specify params to pass into the preview template](#-display-key-value)
 * `@!group <name> ... @!endgroup` - [Render examples in a group on the same page](#-group-name--endgroup)
 
 ### 🔖 `@label <text>`
@@ -180,16 +180,16 @@ class FooComponentPreview < ViewComponent::Preview
 end
 ```
 
-### 🔖 `@display <key>: <value>`
+### 🔖 `@display <key> <value>`
 
 The `@display` tag lets you pass custom parameters to your preview layout so that the component preview can be customised on a per-example basis.
 
 ```ruby
-# @display bg_color: "#eee"
+# @display bg_color "#eee"
 class FooComponentPreview < ViewComponent::Preview
 
-  # @display max_width: "500px"
-  # @display wrapper: true
+  # @display max_width "500px"
+  # @display wrapper true
   def default
   end
 end
@@ -198,7 +198,7 @@ end
 The `@display` tag can be applied at the preview (class) or at the example (method) level, and takes the following format:
 
 ```ruby
-# @display <key>: <value>
+# @display <key> <value>
 ```
 
 - `<key>` must be a valid Ruby hash key name, without quotes or spaces
@@ -249,19 +249,19 @@ Globally defined display params will be available to all previews. Any preview o
 Valid:
 
 ```ruby
-# @display body_classes: "bg-red border border-4 border-green"
-# @display wrap_in_container: true
-# @display emojis_to_show: 4
-# @display page_title: "Special example title"
+# @display body_classes "bg-red border border-4 border-green"
+# @display wrap_in_container true
+# @display emojis_to_show 4
+# @display page_title "Special example title"
 ```
 
 Invalid:
 
 ```ruby
-# @display body_classes: 'bg-red border border-4 border-green' [❌ single quotes]
-# @display wrap_in_container: should_wrap [❌ unquoted string, perhaps trying to call a method]
-# @display page title: "Special example title" [❌ space in key]
-# @display bg_color: #fff [❌ colors need quotes around them, it's not CSS!]
+# @display body_classes 'bg-red border border-4 border-green' [❌ single quotes]
+# @display wrap_in_container should_wrap [❌ unquoted string, perhaps trying to call a method]
+# @display page title "Special example title" [❌ space in key]
+# @display bg_color #fff [❌ colors need quotes around them, it's not CSS!]
 ```
 
 ### 🔖 `@!group <name> ... @!endgroup`

data/app/controllers/lookbook/app_controller.rb

@@ -50,7 +50,7 @@ module Lookbook
     def find_preview
       candidates = []
       params[:path].to_s.scan(%r{/|$}) { candidates << $` }
-      match = candidates.detect { |candidate| Lookbook::Preview.exists?(candidate) }
+      match = candidates.reverse.detect { |candidate| Lookbook::Preview.exists?(candidate) }
       @preview = match ? Lookbook::Preview.find(match) : nil
     end
 
@@ -96,8 +96,7 @@ module Lookbook
           }
         end
         set_params
-        joined = render_to_string "lookbook/preview_group", locals: {examples: examples}, layout: nil
-        preview_controller.render_in_layout_to_string(joined, @preview.lookbook_layout || current_layout)
+        preview_controller.render_in_layout_to_string("lookbook/preview/group", {examples: examples}, @preview.lookbook_layout)
       else
         set_params(@example)
         preview_controller.params[:path] = "#{@preview.preview_name}/#{@example.name}".chomp("/")
@@ -106,18 +105,14 @@ module Lookbook
     end
 
     def set_params(example = nil)
-      example_params = @preview.lookbook_display_params.deep_merge(example ? example.lookbook_display_params : {})
+      example_params = example.nil? ? @preview.display_params : example.display_params
       preview_controller.params.merge!({
         lookbook: {
-          display: Lookbook.config.preview_display_params.deep_merge(example_params)
+          display: example_params
         }
       })
     end
 
-    def current_layout
-      preview_controller.send :_layout, preview_controller.lookup_context, [:html]
-    end
-
     def assign_inspector
       @inspector = {
         panes: {

data/app/helpers/lookbook/application_helper.rb

@@ -8,7 +8,12 @@ module Lookbook
     end
 
     def markdown(text)
-      Markdown.new(text).to_html.html_safe
+      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, {
+        tables: true,
+        fenced_code_blocks: true,
+        disable_indented_code_blocks: true,
+      })
+      markdown.render(text).html_safe
     end
 
     def highlight(source, language)

data/app/views/lookbook/nav/_preview.html.erb

@@ -1,4 +1,4 @@
-<% examples = node.get_examples %>
+<% examples = node.get_examples.reject(&:hidden?) %>
 <% if examples.many? %>
   <%= render "nav/node", node: node, path: show_path(examples.first.path) do %>
     <% examples.each do |example| %>

data/app/views/lookbook/workbench/_inspector.html.erb

@@ -3,6 +3,7 @@
     <nav class="-mb-px flex space-x-8 cursor-auto">
       <% panes.each do |key, props| %>
         <a
+          id="inspector-tab-<%= key %>"
           href="#<%= key %>"
           class="whitespace-nowrap py-2 px-1 border-b-2 cursor-pointer <%= "!text-gray-300" if props[:disabled] %>"
           :class="{
@@ -23,7 +24,7 @@
         <% if props[:clipboard].present? %>
           <%= render "shared/clipboard" do %><%= h props[:clipboard].strip %><% end %>
         <% end %>
-        <div class="flex flex-col h-full overflow-auto">
+        <div id="inspector-content-<%= key %>" class="flex flex-col h-full overflow-auto">
           <%= render "workbench/inspector/#{props[:template]}", key: key, **props %>
         </div>
       </div>

data/lib/lookbook/engine.rb

@@ -30,7 +30,7 @@ module Lookbook
 
       options.preview_controller = vc_options.preview_controller if options.preview_controller.nil?
       options.preview_srcdoc = true if options.preview_srcdoc.nil?
-      options.preview_display_params ||= {}
+      options.preview_display_params ||= {}.with_indifferent_access
 
       options.listen_paths = options.listen_paths.map(&:to_s)
       options.listen_paths += options.preview_paths

data/lib/lookbook/preview.rb

@@ -23,8 +23,8 @@ module Lookbook
       return @lookbook_examples if @lookbook_examples.present?
       public_methods = public_instance_methods(false)
       public_method_objects = code_object.meths.filter { |m| public_methods.include?(m.name) }
-      visible = public_method_objects.map { |m| PreviewExample.new(m.name.to_s, self) }.reject(&:hidden?)
-      sorted = Lookbook.config.sort_examples ? visible.sort_by(&:label) : visible
+      examples = public_method_objects.map { |m| PreviewExample.new(m.name.to_s, self) }
+      sorted = Lookbook.config.sort_examples ? examples.sort_by(&:label) : examples
       @lookbook_examples = []
       if code_object.groups.any?
         sorted.group_by { |m| m.group }.each do |name, examples|
@@ -78,6 +78,10 @@ module Lookbook
       defined?(@layout) ? @layout : nil
     end
 
+    def display_params
+      Lookbook.config.preview_display_params.deep_merge(lookbook_display_params)
+    end
+
     class << self
       def all
         ViewComponent::Preview.all.sort_by(&:label)

data/lib/lookbook/preview_controller.rb

@@ -14,9 +14,9 @@ module Lookbook
       render_to_string template, opts
     end
 
-    def render_in_layout_to_string(content, layout_override)
-      layout = determine_layout(layout_override, prepend_views: false)[:layout]
-      render_to_string html: content, layout: layout
+    def render_in_layout_to_string(template, locals, layout = nil)
+      append_view_path Lookbook::Engine.root.join("app/views")
+      render_to_string template, locals: locals, **determine_layout(@preview.lookbook_layout)
     end
   end
 end

data/lib/lookbook/preview_example.rb

@@ -21,6 +21,10 @@ module Lookbook
       lookbook_label.presence || name.titleize
     end
 
+    def display_params
+      @preview.display_params.merge(lookbook_display_params)
+    end
+
     def method_source
       code_object.source.split("\n")[1..-2].join("\n").strip_heredoc
     end

data/lib/lookbook/preview_group.rb

@@ -26,6 +26,10 @@ module Lookbook
       :group
     end
 
+    def hidden?
+      false
+    end
+
     def matchers
       [@preview.label, label].map { |m| m.gsub(/\s/, "").downcase }
     end

data/lib/lookbook/taggable.rb

@@ -21,15 +21,15 @@ module Lookbook
     end
 
     def lookbook_display_params
-      display_params = {}
+      display_params = {}.with_indifferent_access
       if code_object&.tags(:display).present?
         code_object.tags(:display).each do |tag|
-          parts = tag.text.match(/^\s?([^:]*)\s?:\s?(.*)\s?$/)
+          parts = tag.text.strip.match(/^([^\s]*)\s?(.*)$/)
           if parts.present?
             begin
               display_params[parts[1]] = JSON.parse parts[2]
             rescue JSON::ParserError => err
-              Rails.logger.error("\n👀 [Lookbook] Invalid JSON in @display tag.\n👀 [Lookbook] (#{err.to_s})\n")
+              Rails.logger.error("\n👀 [Lookbook] Invalid JSON in @display tag.\n👀 [Lookbook] (#{err})\n")
             end
           end
         end

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "0.4.0.beta.1"
+  VERSION = "0.4.3"
 end

data/lib/tasks/lookbook_tasks.rake

@@ -11,5 +11,10 @@ namespace :lookbook do
       contents = file.read
       File.write(filename, contents.gsub(current_version, new_version))
     end
+
+    desc "Build Gem and push to RubyGems"
+    task :build_and_push do
+      sh("rake build && gem push pkg/lookbook-#{Lookbook::VERSION}.gem")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lookbook
 version: !ruby/object:Gem::Version
-  version: 0.4.0.beta.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Mark Perkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -216,7 +216,7 @@ files:
 - app/views/lookbook/nav/_leaf.html.erb
 - app/views/lookbook/nav/_node.html.erb
 - app/views/lookbook/nav/_preview.html.erb
-- app/views/lookbook/preview_group.html.erb
+- app/views/lookbook/preview/group.html.erb
 - app/views/lookbook/shared/_clipboard.html.erb
 - app/views/lookbook/shared/_header.html.erb
 - app/views/lookbook/shared/_sidebar.html.erb
@@ -259,9 +259,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: