lookbook 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1f01b55ea75634f7e4cf2f7fe438ce6b56042daa5d7f178e50d0db7c267a644
-  data.tar.gz: 81fddb93ab9aed2d51a59ecd00deced19c97a395ced5de3223db0d229f3a57dd
+  metadata.gz: 9d2f6afc23ec83a6ed2c19314540d26f83406da564385337fe29f9769253a432
+  data.tar.gz: bc239282a1bbbca50a72da683e270efafd60f515cf59a9b56ffc98b73f5e53a6
 SHA512:
-  metadata.gz: 535340241df2352ba1c0fa5983f178cdb76d5fc39f0b4c9bcc8c34e4dc782177a4110f85a47ac6632064ac52b064f6936fe9cb764d5a5f2a8b527c9a80342bff
-  data.tar.gz: 1d580f19491db04693d6e31941c198c4b1416665836d90436e84ddf4dadad7e325612be88c959fd2fff1900c061e2e54e2b8cbf82cda5ce947addcdba7bd251d
+  metadata.gz: '08d4cf77cc06512be08c1f1baf567b55ac4e8d0328281896ddb2dd7381051b9ed538e8c2333a4437629cfc3e7852f5398672d013a271cacfae4dad0bc8769d97'
+  data.tar.gz: b748d37275d69d82522b7e7746d31ed54d296dac939c5610d3559834207fc0488d682ee86b161c42418af71a80eaee79ec10f16cd276b4d510a87e3446379253

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
 
@@ -95,7 +95,7 @@ module Lookbook
             html: preview_controller.render_example_to_string(@preview, example.name)
           }
         end
-        joined = render_to_string "./preview_group", locals: {examples: examples}, layout: nil
+        joined = render_to_string "lookbook/preview_group", locals: {examples: examples}, layout: nil
         preview_controller.render_in_layout_to_string(joined, @preview.lookbook_layout)
       else
         preview_controller.request.params[:path] = "#{@preview.preview_name}/#{@example.name}".chomp("/")
@@ -152,7 +152,7 @@ module Lookbook
     end
 
     def previews
-      Lookbook::Preview.all
+      Lookbook::Preview.all.sort_by(&:label)
     end
 
     def preview_controller

data/app/views/lookbook/app/index.html.erb

@@ -1,5 +1,5 @@
 <div class="flex flex-col h-full min-h-fill w-full">
-  <%= render "./shared/header" %>
+  <%= render "shared/header" %>
   <div class="flex flex-col items-center justify-center h-full min-h-fill">
     <div class="p-4 text-center">
       <svg class="feather w-10 h-10 text-gray-300 mx-auto">
@@ -8,4 +8,4 @@
       <h5 class="mt-4 text-gray-400 text-base">Select a preview to get started</h5>
     </div>
   </div>
-</div>
+</div>

data/app/views/lookbook/app/show.html.erb

@@ -1 +1 @@
-<%= render "./workbench" %>
+<%= render "shared/workbench" %>

data/app/views/lookbook/layouts/app.html.erb

@@ -10,7 +10,7 @@
 
   <% if config.auto_refresh %>
     <script>
-      window.SOCKET_PATH = "/lookbook/cable";
+      window.SOCKET_PATH = "<%= Lookbook::Engine.websocket_mount_path %>";
     </script>
   <% end %>
   <script src="/lookbook-assets/app.js" defer></script>
@@ -21,14 +21,14 @@
   <div
     x-data="page"
     x-effect="updateTitle"
-    @refresh.document="fetchHTML().then(doc => $dispatch('document:updated', {doc}))" 
+    @refresh.document="fetchHTML().then(doc => $dispatch('document:updated', {doc}))"
     @popstate.window="fetchHTML().then(doc => { $dispatch('document:loaded', {doc}); sidebarOpenMobile = false})"
     @sidebar:toggle.window="sidebarOpenMobile = !sidebarOpenMobile"
     :style="`grid-template-columns: ${$store.nav.width}px 1px 1fr;`"
     class="md:grid w-screen h-screen"
   >
     <div class="h-full bg-gray-100 overflow-hidden" x-show="$screen('md') || sidebarOpenMobile" x-cloak>
-      <%= render "./sidebar" %>
+      <%= render "shared/sidebar" %>
     </div>
     <div x-data="split(splitProps)" class="h-full gutter border-r border-gray-300 relative" x-show="$screen('md')" x-cloak>
       <div class="w-[9px] h-full bg-transparent hover:bg-indigo-100 hover:bg-opacity-20 transition absolute top-0 bottom-0 transform -translate-x-1/2 cursor-[col-resize] z-10"></div>

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

@@ -1,5 +1,5 @@
-<%= render "./nav/node", node: node do %>
+<%= render "nav/node", node: node do %>
   <% node.items.each do |item| %>
-    <%= render "./nav/#{item.type.to_s}", node: item %>
-  <% end %> 
-<% end %>
+    <%= render "nav/#{item.type.to_s}", node: item %>
+  <% end %>
+<% end %>

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

@@ -1,5 +1,5 @@
 <li id="<%= node.id %>" x-data="navNode" <% if node.hierarchy_depth == 1 %> class="py-1 border-b border-gray-300 cursor-pointer"<% end %> :class="{hidden}" x-cloak>
-  <div @click="toggle(); if (open()) { <%= "navigate('#{path}')" if defined?(path) %>}" style="<%= nav_padding_style(node.hierarchy_depth) %>" class="hover:bg-gray-200 hover:bg-opacity-50">
+  <div @click="toggle" style="<%= nav_padding_style(node.hierarchy_depth) %>" class="hover:bg-gray-200 hover:bg-opacity-50">
     <div class="flex items-center cursor-pointer pr-3 py-[5px]">
       <svg class="feather w-3 h-3 mr-1 text-gray-500 flex-none">
         <use xlink:href="/lookbook-assets/feather-sprite.svg#chevron-down" x-show="open" x-cloak />
@@ -8,7 +8,7 @@
       <svg class="feather h-3.5 w-3.5 mr-1.5 flex-none text-indigo-500">
         <use xlink:href="/lookbook-assets/feather-sprite.svg#<%= node.type == :preview ? 'layers' : 'folder' %>" />
       </svg>
-      <div class="truncate whitespace-nowrap text-left <%= "font-bold" if node.type == :preview %>">
+      <div class="truncate w-full whitespace-nowrap text-left <%= "font-bold" if node.type == :preview %>" @click.stop="toggle(); if (open()) { <%= "navigate('#{path}')" if defined?(path) %>}">
         <%= node.label %>
       </div>
     </div>

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

@@ -1,11 +1,11 @@
 <% examples = node.get_examples %>
 <% if examples.many? %>
-  <%= render "./nav/node", node: node, path: show_path(examples.first.path) do %>
+  <%= render "nav/node", node: node, path: show_path(examples.first.path) do %>
     <% examples.each do |example| %>
-      <%= render "./nav/leaf", leaf: example, depth: example.hierarchy_depth + 1 %>
+      <%= render "nav/leaf", leaf: example, depth: example.hierarchy_depth + 1 %>
     <% end %>
   <% end %>
 <% else %>
   <% example = examples.first %>
-  <%= render "./nav/leaf", leaf: example, depth: example.hierarchy_depth, label: node.label, display: :node %>
-<% end %>
+  <%= render "nav/leaf", leaf: example, depth: example.hierarchy_depth, label: node.label, display: :node %>
+<% end %>

data/app/views/lookbook/shared/_header.html.erb

@@ -5,4 +5,4 @@
     </svg>
   </button>
   <%= yield %>
-</header>
+</header>

data/app/views/lookbook/{_sidebar.html.erb → shared/_sidebar.html.erb}

@@ -27,7 +27,7 @@
         <% if @nav.items.any? %>
           <ul x-ref="items">
             <% @nav.items.each do |item| %>
-              <%= render "./nav/#{item.type.to_s}", node: item %>
+              <%= render "nav/#{item.type.to_s}", node: item %>
             <% end %>
           </ul>
           <div class="p-4 text-center" x-show="hidden" x-cloak>
@@ -41,5 +41,5 @@
         <% end %>
       </nav>
     </div>
-  </div>   
-</div>
+  </div>
+</div>

data/app/views/lookbook/{_workbench.html.erb → shared/_workbench.html.erb}

@@ -1,12 +1,12 @@
 <div id="workbench" class="bg-gray-50 h-screen flex flex-col" x-data="workbench">
-  <%= render "./workbench/header" %>
+  <%= render "workbench/header" %>
   <div class="md:grid flex-grow" :style="`grid-template-rows: 1fr 1px ${$store.inspector.height}px`">
-    <%= render "./workbench/preview" %>
+    <%= render "workbench/preview" %>
     <div class="w-full gutter border-t border-gray-300 relative" x-data="split(splitProps)" x-show="$screen('md')">
       <div class="h-[11px] w-full bg-transparent hover:bg-indigo-100 hover:bg-opacity-20 transition absolute left-0 right-0 transform -translate-y-1/2 cursor-[row-resize]"></div>
     </div>
     <% if @inspector %>
-      <%= render "./workbench/inspector", **@inspector %>
+      <%= render "workbench/inspector", **@inspector %>
     <% end %>
-  </div>  
-</div>
+  </div>
+</div>

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

@@ -1,4 +1,4 @@
-<%= render "./shared/header" do %>
+<%= render "shared/header" do %>
   <div class="flex items-center">
     <div class="flex items-center space-x-1">
       <strong class="whitespace-nowrap truncate"><%= @preview.label %></strong>
@@ -36,4 +36,4 @@
       </svg>
     </a>
   </div>
-<% end %>
+<% end %>

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

@@ -21,12 +21,12 @@
     <% panes.each do |key, props| %>
       <div class="flex flex-col h-full relative" x-show="active('<%= key %>')" x-cloak>
         <% if props[:clipboard].present? %>
-          <%= render "./shared/clipboard" do %><%= h props[:clipboard].strip %><% end %>
+          <%= render "shared/clipboard" do %><%= h props[:clipboard].strip %><% end %>
         <% end %>
         <div class="flex flex-col h-full overflow-auto">
-          <%= render "./workbench/inspector/#{props[:template]}", key: key, **props %>
+          <%= render "workbench/inspector/#{props[:template]}", key: key, **props %>
         </div>
       </div>
     <% end %>
   </div>
-</div>
+</div>

data/lib/lookbook/collection.rb

@@ -12,11 +12,11 @@ module Lookbook
     end
 
     def name
-      @path ? @path.split("/").last : "root"
+      @path.present? ? @path.split("/").last : "root"
     end
 
     def label
-      name.titleize
+      name&.titleize
     end
 
     def hierarchy_depth
@@ -24,7 +24,7 @@ module Lookbook
     end
 
     def items(sorted = true)
-      sorted ? @items.sort_by(&:name) : @items
+      sorted ? @items.sort_by(&:label) : @items
     end
 
     def add(item)

data/lib/lookbook/engine.rb

@@ -23,6 +23,7 @@ module Lookbook
 
       options.auto_refresh = true if options.auto_refresh.nil?
       options.sort_examples = false if options.sort_examples.nil?
+      options.debug = false unless options.debug == true
 
       options.preview_paths = options.preview_paths.map(&:to_s)
       options.preview_paths += vc_options.preview_paths
@@ -43,10 +44,6 @@ module Lookbook
       end
     end
 
-    initializer "lookbook.cable.logger" do
-      Lookbook::Engine.cable.logger ||= Rails.logger
-    end
-
     initializer "lookbook.parser.tags" do
       Lookbook::Parser.define_tags
     end
@@ -58,6 +55,15 @@ module Lookbook
       )
     end
 
+    initializer "lookbook.logging" do
+      if config.lookbook.debug == true
+        Lookbook::Engine.cable.logger ||= Rails.logger
+      else
+        Lookbook::Engine.cable.logger = Lookbook::NullLogger.new
+        config.action_view.logger = Lookbook::NullLogger.new
+      end
+    end
+
     initializer "lookbook.preview.extend" do
       ActiveSupport.on_load(:view_component) do
         ViewComponent::Preview.extend Lookbook::Preview
@@ -93,6 +99,10 @@ module Lookbook
         end
       end
 
+      def websocket_mount_path
+        "#{Lookbook::Engine.routes.find_script_name({})}#{cable.mount_path}"
+      end
+
       def cable
         @cable ||= ActionCable::Server::Configuration.new
       end

data/lib/lookbook/null_logger.rb

@@ -0,0 +1,47 @@
+module Lookbook
+  class NullLogger
+    def unknown(*)
+      nil
+    end
+
+    def fatal(*)
+      nil
+    end
+
+    def fatal?
+      false
+    end
+
+    def error(*)
+      nil
+    end
+
+    def error?
+      false
+    end
+
+    def warn(*)
+      nil
+    end
+
+    def warn?
+      false
+    end
+
+    def info(*)
+      nil
+    end
+
+    def info?
+      false
+    end
+
+    def debug(*)
+      nil
+    end
+
+    def debug?
+      false
+    end
+  end
+end

data/lib/lookbook/parser.rb

@@ -5,7 +5,7 @@ module Lookbook
     YARDOC_FILE_PATH = Rails.root.join("tmp/storage/.yardoc").to_s
 
     def initialize(paths)
-      @paths = paths.map { |p| "#{p}/**/*.rb" }
+      @paths = paths.map { |p| "#{p}/**/*_preview.rb" }
       YARD::Registry.yardoc_file = YARDOC_FILE_PATH
     end
 

data/lib/lookbook/preview.rb

@@ -80,7 +80,7 @@ module Lookbook
 
     class << self
       def all
-        ViewComponent::Preview.all
+        ViewComponent::Preview.all.sort_by(&:label)
       end
 
       def find(path)
@@ -90,8 +90,6 @@ module Lookbook
       def exists?(path)
         !!find(path)
       end
-
-      
     end
 
     private

data/lib/lookbook/taggable.rb

@@ -1,17 +1,19 @@
 module Lookbook
   module Taggable
     def lookbook_hidden?
-      if code_object.tag(:hidden)
+      if code_object&.tag(:hidden)
         code_object.tag(:hidden).text.strip != "false"
       end
     end
 
     def lookbook_label
-      code_object.tag(:label)&.text
+      code_object&.tag(:label)&.text
     end
 
     def lookbook_notes
-      code_object.docstring.to_s.strip
+      if code_object&.docstring
+        code_object.docstring.to_s.strip
+      end
     end
 
     def lookbook_group

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "0.3.1"
+  VERSION = "0.3.5"
 end

data/lib/lookbook.rb

@@ -12,4 +12,5 @@ module Lookbook
   autoload :PreviewExample, "lookbook/preview_example"
   autoload :PreviewGroup, "lookbook/preview_group"
   autoload :Taggable, "lookbook/taggable"
+  autoload :NullLogger, "lookbook/null_logger"
 end

data/lib/tasks/lookbook_tasks.rake

@@ -6,7 +6,7 @@ namespace :lookbook do
     task :bump_version, [:version] do |t, args|
       filename = Lookbook::Engine.root.join("lib/lookbook/version.rb")
       current_version = Lookbook::VERSION.to_s
-      new_version = args[:version].sub("v", "").gsub("-",".")
+      new_version = args[:version].sub("v", "").tr("-", ".")
       file = File.open(filename)
       contents = file.read
       File.write(filename, contents.gsub(current_version, new_version))