rubylens 0.1.0.pre.1

data/lib/rubylens/report_asset_assembler.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "errors"
+
+module RubyLens
+  class ReportAssetAssembler
+    STYLES_PLACEHOLDER = "{{REPORT_STYLES}}"
+    RUNTIME_PLACEHOLDER = "{{REPORT_RUNTIME}}"
+
+    def initialize(
+      shell_path: File.expand_path("../../assets/shells/report.html", __dir__),
+      stylesheet_path: File.expand_path("../../assets/styles/report.css", __dir__),
+      runtime_path: File.expand_path("../../assets/runtime/report.js", __dir__)
+    )
+      @shell_path = shell_path
+      @stylesheet_path = stylesheet_path
+      @runtime_path = runtime_path
+    end
+
+    def assemble
+      shell = File.read(@shell_path)
+      validate_placeholder(shell, STYLES_PLACEHOLDER)
+      validate_placeholder(shell, RUNTIME_PLACEHOLDER)
+
+      shell
+        .sub(STYLES_PLACEHOLDER, File.read(@stylesheet_path))
+        .sub(RUNTIME_PLACEHOLDER, File.read(@runtime_path))
+    end
+
+    private
+
+    def validate_placeholder(shell, placeholder)
+      return if shell.scan(placeholder).length == 1
+
+      raise Error, "report shell must contain exactly one #{placeholder} placeholder"
+    end
+  end
+end

data/lib/rubylens/report_writer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "base64"
+require "fileutils"
+require "json"
+require "securerandom"
+require_relative "report_asset_assembler"
+
+module RubyLens
+  class ReportWriter
+    MODEL_PLACEHOLDER = "{{MODEL_BASE64}}"
+
+    def initialize(template_path: nil, asset_assembler: nil)
+      raise ArgumentError, "provide template_path or asset_assembler, not both" if template_path && asset_assembler
+
+      @template_path = template_path
+      @asset_assembler = asset_assembler || ReportAssetAssembler.new unless template_path
+    end
+
+    def write(model, output:)
+      output = File.expand_path(output)
+      directory = File.dirname(output)
+      FileUtils.mkdir_p(directory, mode: 0o700)
+      protect_default_directory(directory)
+      template = @template_path ? File.read(@template_path) : @asset_assembler.assemble
+      unless template.scan(MODEL_PLACEHOLDER).length == 1
+        raise Error, "report template must contain exactly one #{MODEL_PLACEHOLDER} placeholder"
+      end
+
+      payload = Base64.strict_encode64(JSON.generate(model))
+      html = template.sub(MODEL_PLACEHOLDER, payload)
+      atomic_write(output, html)
+      output
+    end
+
+    def rubylens_report?(path)
+      File.file?(path) && File.open(path, "rb") { |file| file.read(2048).include?('<meta name="generator" content="RubyLens">') }
+    rescue Errno::ENOENT, Errno::EACCES
+      false
+    end
+
+    private
+
+    def protect_default_directory(directory)
+      return unless File.basename(directory) == ".rubylens"
+
+      ignore = File.join(directory, ".gitignore")
+      atomic_write(ignore, "*\n") unless File.exist?(ignore)
+    end
+
+    def atomic_write(path, contents)
+      temporary = File.join(File.dirname(path), ".#{File.basename(path)}.#{SecureRandom.hex(6)}.tmp")
+      File.open(temporary, File::WRONLY | File::CREAT | File::EXCL, 0o600) { |file| file.write(contents) }
+      File.chmod(0o600, temporary)
+      File.rename(temporary, path)
+      File.chmod(0o600, path)
+    ensure
+      FileUtils.rm_f(temporary) if temporary && File.exist?(temporary)
+    end
+  end
+end

data/lib/rubylens/showcase_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "generator"
+require_relative "showcase_model"
+require_relative "showcase_writer"
+
+module RubyLens
+  class ShowcaseGenerator
+    DEFAULT_SHOWCASE_NAME = "rubylens-showcase.html"
+
+    def initialize(
+      manifest_builder: Index::Manifest,
+      adapter: Index::RubydexAdapter.new,
+      model_builder: ArtModelBuilder.new,
+      showcase_model: ShowcaseModel.new,
+      showcase_writer: ShowcaseWriter.new,
+      pipeline: nil
+    )
+      @pipeline = pipeline || GenerationPipeline.new(manifest_builder:, adapter:, model_builder:)
+      @showcase_model = showcase_model
+      @showcase_writer = showcase_writer
+    end
+
+    def call(path: Dir.pwd, output: nil, lockfile: nil)
+      root = File.realpath(path)
+      if output.nil?
+        output = File.join(root, DEFAULT_SHOWCASE_NAME)
+        if File.exist?(output) && !@showcase_writer.rubylens_showcase?(output)
+          raise Error, "default showcase path already exists and is not a RubyLens showcase"
+        end
+        GitRepository.new(root).exclude_local(output, description: "showcase")
+      end
+      model, warnings = @pipeline.call(root:, lockfile:)
+      output_path = @showcase_writer.write(@showcase_model.call(model), output: output)
+
+      Result.new(output_path:, counts: model.fetch("totals").freeze, warnings:)
+    rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP => error
+      raise Error, error.message
+    end
+  end
+end

data/lib/rubylens/showcase_model.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "art_model_builder"
+require_relative "errors"
+
+module RubyLens
+  class ShowcaseModel
+    SIGNAL_FIELDS = ArtModelBuilder::SIGNAL_FIELDS
+    TOTAL_FIELDS = %w[namespaces packages dependencyStars renderedDependencyStars].freeze
+    CATEGORY_FIELDS = %w[core tests].freeze
+
+    def call(model)
+      {
+        "schema" => "rubylens.showcase.v1",
+        "projectName" => model.fetch("projectName"),
+        "totals" => project_hash(model.fetch("totals"), TOTAL_FIELDS),
+        "domains" => project_hash(model.fetch("domains"), SIGNAL_FIELDS),
+        "categoryStats" => CATEGORY_FIELDS.to_h do |category|
+          [category, numeric_row(model.fetch("categoryStats").fetch(category), 4)]
+        end,
+        "namespaces" => model.fetch("namespaces").map { |row| numeric_row(row, 15) },
+        "packages" => model.fetch("packages").map { |row| numeric_row(row, 8) },
+        "dependencyStars" => model.fetch("dependencyStars").map { |row| numeric_row(row, 8) },
+      }
+    end
+
+    private
+
+    def project_hash(source, fields)
+      fields.to_h { |field| [field, Integer(source.fetch(field))] }
+    end
+
+    def numeric_row(row, length)
+      raise Error, "showcase model row has an unexpected shape" unless row.length >= length
+
+      row.first(length).map { |value| Integer(value) }
+    rescue ArgumentError, TypeError
+      raise Error, "showcase model rows must contain only numbers"
+    end
+  end
+end

data/lib/rubylens/showcase_writer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "report_writer"
+
+module RubyLens
+  class ShowcaseWriter < ReportWriter
+    MARKER = '<meta name="rubylens-artifact" content="showcase">'
+    SHELL_PATH = File.expand_path("../../assets/shells/showcase.html", __dir__)
+    STYLESHEET_PATH = File.expand_path("../../assets/styles/showcase.css", __dir__)
+    RUNTIME_PATH = File.expand_path("../../assets/runtime/report.js", __dir__)
+
+    def initialize(template_path: nil, asset_assembler: nil)
+      asset_assembler ||= ReportAssetAssembler.new(
+        shell_path: SHELL_PATH,
+        stylesheet_path: STYLESHEET_PATH,
+        runtime_path: RUNTIME_PATH,
+      ) unless template_path
+      super(template_path:, asset_assembler:)
+    end
+
+    def rubylens_showcase?(path)
+      File.file?(path) && File.open(path, "rb") { |file| file.read(2048).include?(MARKER) }
+    rescue Errno::ENOENT, Errno::EACCES
+      false
+    end
+  end
+end

data/lib/rubylens/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyLens
+  VERSION = "0.1.0.pre.1"
+end

data/lib/rubylens.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "rubylens/version"
+require_relative "rubylens/errors"
+require_relative "rubylens/paths"
+require_relative "rubylens/git_repository"
+require_relative "rubylens/index/manifest"
+require_relative "rubylens/index/rubydex_adapter"
+require_relative "rubylens/art_model_builder"
+require_relative "rubylens/report_asset_assembler"
+require_relative "rubylens/report_writer"
+require_relative "rubylens/generator"
+require_relative "rubylens/showcase_model"
+require_relative "rubylens/showcase_writer"
+require_relative "rubylens/showcase_generator"
+
+module RubyLens
+  module_function
+
+  def generate_report(path: Dir.pwd, output: nil, lockfile: nil)
+    Generator.new.call(path: path, output: output, lockfile: lockfile)
+  end
+
+  def generate_showcase(path: Dir.pwd, output: nil, lockfile: nil)
+    ShowcaseGenerator.new.call(path: path, output: output, lockfile: lockfile)
+  end
+
+  def generate(path: Dir.pwd, output: nil, lockfile: nil)
+    generate_report(path: path, output: output, lockfile: lockfile)
+  end
+end
+
+require_relative "rubylens/cli"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rubylens
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.1
+platform: ruby
+authors:
+- RubyLens contributors
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubydex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: |-
+  RubyLens uses Rubydex to index Ruby semantics and generate private, local-first
+  data for local interactive reports and autonomous visual showcases.
+executables:
+- rubylens
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- assets/runtime/report.js
+- assets/shells/report.html
+- assets/shells/showcase.html
+- assets/styles/report.css
+- assets/styles/showcase.css
+- exe/rubylens
+- lib/rubylens.rb
+- lib/rubylens/art_model_builder.rb
+- lib/rubylens/cli.rb
+- lib/rubylens/errors.rb
+- lib/rubylens/generator.rb
+- lib/rubylens/git_repository.rb
+- lib/rubylens/index/manifest.rb
+- lib/rubylens/index/rubydex_adapter.rb
+- lib/rubylens/model/dependency_aggregation.rb
+- lib/rubylens/paths.rb
+- lib/rubylens/report_asset_assembler.rb
+- lib/rubylens/report_writer.rb
+- lib/rubylens/showcase_generator.rb
+- lib/rubylens/showcase_model.rb
+- lib/rubylens/showcase_writer.rb
+- lib/rubylens/version.rb
+homepage: https://st0012.dev/rails-galaxy/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://st0012.dev/rails-galaxy/
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 4.1.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Turn a Ruby codebase into self-contained stellar HTML
+test_files: []