lookbooklet 0.0.1

data/lib/booklet/visitor.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Booklet
+  # Double-dispatch node visitor base class. Adapted from the Refract gem (https://github.com/yippee-fun/refract).
+  #
+  # @see https://github.com/yippee-fun/refract/blob/main/lib/refract/basic_visitor.rb
+  class Visitor < Booklet::Object
+    prop :options, _Nilable(Booklet::Options), :** do |value|
+      Booklet::Options.new(value) if value.is_a?(Hash)
+    end
+
+    after_initialize do
+      @stack = []
+    end
+
+    def visit(node)
+      return unless node
+
+      @stack.push(node)
+      node.accept(self).tap { @stack.pop }
+    end
+
+    def visit_each(nodes)
+      nodes.compact.each { visit(_1) }
+    end
+
+    def method_missing(name, *args, &block)
+      if args.any? && name.start_with?("visit_")
+        node = args.first
+        if respond_to?(:visit_any)
+          visit_any(node)
+        else
+          visit_each(node.children) if node.children?
+          node
+        end
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, ...)
+      (name != :visit_any && name.start_with?("visit_")) || super
+    end
+
+    class << self
+      def visit(*node_classes, &block)
+        node_classes.flatten!
+        if node_classes.any?
+          node_classes.each do |node_class|
+            define_method("visit_#{node_class.type.name}", &block)
+          end
+        else
+          define_method(:visit_any, &block)
+        end
+      end
+    end
+  end
+end

data/lib/booklet/visitors/ascii_tree_renderer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Booklet
+  class AsciiTreeRenderer < Visitor
+    PIPE = "│"
+    BRANCH = "├──"
+    LEAF = "└──"
+    SPACE = " "
+
+    LABEL_PROC = proc { _1.respond_to?(:label) ? _1.label : _1.name }
+
+    prop :indent, Integer, default: 0
+    prop :to_label, _Nilable(Proc), :&, reader: :protected, default: -> { LABEL_PROC }
+
+    after_initialize do
+      @lines = []
+      @prefix = +""
+    end
+
+    visit do |node|
+      memo = @prefix
+
+      if node.root?
+        @lines << (SPACE * @indent) + to_label.call(node)
+      else
+        @lines << (SPACE * @indent) + @prefix + (node.last_sibling? ? LEAF : BRANCH) + SPACE + to_label.call(node)
+        @prefix += (node.last_sibling? ? SPACE : PIPE) + (SPACE * BRANCH.size)
+      end
+
+      visit_each(node.children)
+      @prefix = memo
+
+      @lines.join("\n")
+    end
+  end
+end

data/lib/booklet/visitors/entity_transformer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Booklet
+  class EntityTransformer < Visitor
+    LOCATABLE_ENTITIES = [FolderNode, SpecNode, DocumentNode, AssetNode, AnonNode]
+
+    visit DirectoryNode do |node|
+      folder = FolderNode.new(node.file.basename, file: node.file)
+      node.children.each { folder << visit(_1) }
+      folder
+    end
+
+    visit FileNode do |node|
+      type = LOCATABLE_ENTITIES.find { _1.matches?(node.file) }
+      type.from(node.file)
+    end
+  end
+end

data/lib/booklet/visitors/filesystem_loader.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Booklet
+  class FilesystemLoader < Visitor
+    visit DirectoryNode do |node|
+      files = Dir[%(#{node.file.path}/*)].sort.map { File.new(_1) }
+      files.each do |file|
+        node_type = file.directory? ? DirectoryNode : FileNode
+        visit(node << node_type.from(file))
+      end
+      node
+    end
+
+    visit FileNode do |node|
+      node
+    end
+  end
+end

data/lib/booklet/visitors/frontmatter_extractor.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Booklet
+  class FrontmatterExtractor < Visitor
+    visit DocumentNode do |node|
+      # Not yet implemented
+      node
+    end
+  end
+end

data/lib/booklet/visitors/preview_class_parser.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Booklet
+  class PreviewClassParser < Visitor
+    after_initialize do
+      @yard = YardParser.new
+    end
+
+    visit SpecNode do |spec|
+      class_object = @yard.parse_file(spec.file.path)
+
+      comments = strip_whitespace(class_object.docstring)
+      if comments.present?
+        spec.notes = TextSnippet.new(comments)
+      end
+
+      scenarios = class_object
+        .meths(inherited: false, included: false)
+        .filter { _1.visibility == :public }
+        .map(&method(:to_scenario))
+
+      spec.push(*scenarios)
+      spec
+    end
+
+    protected def to_scenario(method_object)
+      parameters = method_object.parameters # TODO: 'parameters' Value object
+
+      source = MethodSnippet.new(
+        method_object.source,
+        name: method_object.path,
+        lang: method_object.source_type,
+        location: [method_object.file, method_object.line]
+      )
+
+      comments = strip_whitespace(method_object.docstring)
+      notes = TextSnippet.new(comments) if comments.present?
+
+      ScenarioNode.new(method_object.name, source:, parameters:, notes:)
+    end
+  end
+end

data/lib/booklet/yard_parser.rb

@@ -0,0 +1,23 @@
+require "yard"
+
+module Booklet
+  class YardParser < Booklet::Object
+    def initialize(log_level: YARD::Logger::ERROR)
+      @log_level = log_level
+    end
+
+    def parse(*path_sets)
+      paths = Array.wrap(path_sets).flatten.map(&:to_s)
+
+      YARD::Logger.instance.enter_level(@log_level) do
+        YARD.parse(paths)
+      end
+
+      YARD::Registry.all(:class).filter { paths.include?(_1.file) }
+    end
+
+    def parse_file(path)
+      parse(path).first
+    end
+  end
+end

data/lib/booklet.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "literal"
+require "active_support"
+require "active_support/core_ext"
+require "booklet/version"
+
+loader = Zeitwerk::Loader.new
+loader.push_dir("#{__dir__}/booklet", namespace: Booklet)
+loader.collapse("#{__dir__}/booklet/**/*")
+loader.ignore("#{__dir__}/booklet/version.rb")
+loader.inflector.inflect(
+  "cli" => "CLI"
+)
+loader.setup
+
+module Booklet
+  class << self
+    def version
+      VERSION
+    end
+
+    def analyze(dir_path, **props)
+      analyzer = Analyzer.new(**props)
+      analyzer.analyze(dir_path)
+    end
+  end
+end

data/lib/lookbooklet.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "booklet"

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: lookbooklet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Perkins
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: literal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description:
+email:
+executables:
+- booklet
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/booklet
+- lib/booklet.rb
+- lib/booklet/analyzer.rb
+- lib/booklet/cli/cli.rb
+- lib/booklet/cli/commands/analyze_command.rb
+- lib/booklet/cli/commands/version_command.rb
+- lib/booklet/cli/concerns/colorful.rb
+- lib/booklet/concerns/locatable.rb
+- lib/booklet/file.rb
+- lib/booklet/helpers.rb
+- lib/booklet/node.rb
+- lib/booklet/nodes/anon_node.rb
+- lib/booklet/nodes/asset_node.rb
+- lib/booklet/nodes/directory_node.rb
+- lib/booklet/nodes/document_node.rb
+- lib/booklet/nodes/file_node.rb
+- lib/booklet/nodes/folder_node.rb
+- lib/booklet/nodes/prose_node.rb
+- lib/booklet/nodes/scenario_node.rb
+- lib/booklet/nodes/spec_node.rb
+- lib/booklet/object.rb
+- lib/booklet/options.rb
+- lib/booklet/value.rb
+- lib/booklet/values.rb
+- lib/booklet/values/code_snippet.rb
+- lib/booklet/values/method_snippet.rb
+- lib/booklet/values/node_type.rb
+- lib/booklet/values/parser_result.rb
+- lib/booklet/values/source_location.rb
+- lib/booklet/values/text_snippet.rb
+- lib/booklet/version.rb
+- lib/booklet/visitor.rb
+- lib/booklet/visitors/ascii_tree_renderer.rb
+- lib/booklet/visitors/entity_transformer.rb
+- lib/booklet/visitors/filesystem_loader.rb
+- lib/booklet/visitors/frontmatter_extractor.rb
+- lib/booklet/visitors/preview_class_parser.rb
+- lib/booklet/yard_parser.rb
+- lib/lookbooklet.rb
+homepage: https://github.com/lookbook-hq/booklet
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: An experimental new parser-analyzer engine for Lookbook
+test_files: []