sublime_text_kit 10.0.2 → 11.0.0

data/lib/sublime_text_kit/metadata/handler.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "refinements/pathnames"
+
+module SublimeTextKit
+  module Metadata
+    # Handles the creation, deletion, and recreation of metadata.
+    class Handler
+      using Refinements::Pathnames
+
+      def self.with_project project_dir, metadata_dir
+        new "sublime-project",
+            serializer: Serializers::Project.new(
+              Pathway[project_dir: project_dir, metadata_dir: metadata_dir]
+            )
+      end
+
+      def self.with_workspace project_dir, metadata_dir
+        new "sublime-workspace",
+            serializer: Serializers::Workspace.new(
+              Pathway[project_dir: project_dir, metadata_dir: metadata_dir]
+            )
+      end
+
+      def initialize extension, serializer:
+        @extension = extension
+        @serializer = serializer
+      end
+
+      def create = path.exist? ? path : path.write(JSON.dump(serializer.to_h))
+
+      def delete = path.exist? ? path.delete : path
+
+      def recreate = delete && create
+
+      private
+
+      attr_reader :extension, :serializer
+
+      def path = serializer.pathway.metadata_file(extension)
+    end
+  end
+end

data/lib/sublime_text_kit/metadata/pathway.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module Metadata
+    # Defines metadata pathways.
+    Pathway = Struct.new :project_dir, :metadata_dir, keyword_init: true do
+      using Refinements::Pathnames
+
+      def initialize *arguments
+        super
+        each_pair { |key, value| self[key] = Pathname(value).expand_path }
+      end
+
+      def project_name = project_dir.basename
+
+      def metadata_file(extension) = metadata_dir.join("#{project_name}.#{extension}")
+    end
+  end
+end

data/lib/sublime_text_kit/metadata/serializers/project.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module Metadata
+    module Serializers
+      # Serializes project metadata.
+      class Project
+        attr_reader :pathway
+
+        def initialize pathway
+          @pathway = pathway
+        end
+
+        def to_h
+          {
+            folders: [
+              {path: pathway.project_dir.to_s}
+            ]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/metadata/serializers/workspace.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module Metadata
+    module Serializers
+      # Serializes workspace metadata.
+      class Workspace
+        attr_reader :pathway
+
+        def initialize pathway
+          @pathway = pathway
+        end
+
+        def to_h
+          {
+            expanded_folders: [pathway.project_dir.to_s],
+            select_project: {
+              selected_items: [
+                [pathway.project_name.to_s, pathway.metadata_file("sublime-project").to_s]
+              ]
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/sessions/rebuilder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "json"
+require "refinements/pathnames"
+
+module SublimeTextKit
+  module Sessions
+    # Manages the rebuilding of session information.
+    class Rebuilder
+      using Refinements::Pathnames
+
+      def initialize container: Container
+        @container = container
+      end
+
+      def call
+        session = read
+
+        return unless session.dig "workspaces", "recent_workspaces"
+
+        Pathname(metadata_dir).expand_path
+                              .files("*.sublime-workspace")
+                              .then do |workspaces|
+                                session["workspaces"]["recent_workspaces"] = workspaces
+                                write session
+                              end
+      end
+
+      private
+
+      attr_reader :container
+
+      def read = source_path.exist? ? JSON(source_path.read) : {}
+
+      def write(json) = JSON.dump(json).then { |content| source_path.write content }
+
+      def metadata_dir = configuration.metadata_dir
+
+      def source_path = configuration.session_path
+
+      def configuration = container[__method__]
+    end
+  end
+end

data/lib/sublime_text_kit/snippets/collector.rb

@@ -1,36 +1,30 @@
 # frozen_string_literal: true
 
-require "pathname"
-require "rexml/document"
+require "refinements/pathnames"
 
 module SublimeTextKit
   module Snippets
+    # Collects and loads all snippets into memory for further processing.
     class Collector
-      DEFAULT_USER_PATH = "Library/Application Support/Sublime Text 3/Packages/User"
+      using Refinements::Pathnames
 
-      def initialize model: Snippet, user_path: DEFAULT_USER_PATH, environment: ENV
-        @model = model
-        @user_path = user_path
-        @environment = environment
-      end
-
-      def home_path
-        Pathname environment.fetch("HOME")
-      end
-
-      def root_path
-        home_path.join user_path
+      def initialize reader: Reader.new, container: Container
+        @reader = reader
+        @container = container
       end
 
       def call
-        root_path.glob("*.sublime-snippet")
-                 .map { |path| model.new REXML::Document.new(path.read) }
-                 .sort_by(&:description)
+        configuration.user_dir
+                     .files("*.sublime-snippet")
+                     .map { |path| reader.call path }
+                     .sort_by(&:description)
       end
 
       private
 
-      attr_reader :model, :user_path, :environment
+      def configuration = container[__method__]
+
+      attr_reader :reader, :container
     end
   end
 end

data/lib/sublime_text_kit/snippets/model.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module Snippets
+    KEY_MAP = {
+      "content" => :content,
+      "tabTrigger" => :trigger,
+      "description" => :description,
+      "scope" => :scope
+    }.freeze
+
+    # Defines a snippet record.
+    Model = Struct.new(*KEY_MAP.values, keyword_init: true) do
+      def self.for document, key_map: KEY_MAP
+        root = document.root
+
+        return new unless root
+
+        root.elements
+            .reduce({}) { |attributes, element| attributes.merge element.name => element.text }
+            .transform_keys(key_map)
+            .then { |attributes| new(**attributes) }
+      end
+
+      def initialize *arguments
+        super
+        freeze
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/snippets/printers/ascii_doc.rb

@@ -1,24 +1,26 @@
 # frozen_string_literal: true
 
-require "rexml/document"
-
 module SublimeTextKit
   module Snippets
     module Printers
+      # Prints snippets in ASCII Doc format.
       class ASCIIDoc
-        def initialize collector: Collector.new
+        def initialize collector: Collector.new, container: Container
           @collector = collector
+          @container = container
         end
 
         def call
           collector.call.each do |snippet|
-            puts "* #{snippet.description} - `#{snippet.trigger}`\n"
+            logger.info "* #{snippet.description} - `#{snippet.trigger}`"
           end
         end
 
         private
 
-        attr_reader :collector
+        attr_reader :collector, :container
+
+        def logger = container[__method__]
       end
     end
   end

data/lib/sublime_text_kit/snippets/printers/markdown.rb

@@ -3,20 +3,24 @@
 module SublimeTextKit
   module Snippets
     module Printers
+      # Prints snippets in Markdown format.
       class Markdown
-        def initialize collector: Collector.new
+        def initialize collector: Collector.new, container: Container
           @collector = collector
+          @container = container
         end
 
         def call
           collector.call.each do |snippet|
-            puts "- #{snippet.description} - `#{snippet.trigger}`\n"
+            logger.info "- #{snippet.description} - `#{snippet.trigger}`"
           end
         end
 
         private
 
-        attr_reader :collector
+        attr_reader :collector, :container
+
+        def logger = container[__method__]
       end
     end
   end

data/lib/sublime_text_kit/snippets/reader.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rexml/document"
+
+module SublimeTextKit
+  module Snippets
+    # Reads snippet and loads record into memory.
+    class Reader
+      def initialize model: Model, document: REXML::Document
+        @model = model
+        @document = document
+      end
+
+      def call(path) = path.exist? ? model.for(document.new(path.read)) : model.new
+
+      private
+
+      attr_reader :model, :document
+    end
+  end
+end

data/lib/sublime_text_kit.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require "sublime_text_kit/identity"
-require "sublime_text_kit/metadata/base"
-require "sublime_text_kit/metadata/project_metadata"
-require "sublime_text_kit/metadata/workspace_metadata"
-require "sublime_text_kit/snippets/snippet"
-require "sublime_text_kit/snippets/collector"
-require "sublime_text_kit/snippets/printers/ascii_doc"
-require "sublime_text_kit/snippets/printers/markdown"
-require "sublime_text_kit/session"
-require "sublime_text_kit/cli"
+require "zeitwerk"
+
+Zeitwerk::Loader.for_gem
+                .then do |loader|
+                  loader.inflector.inflect "ascii_doc" => "ASCIIDoc", "cli" => "CLI"
+                  loader.setup
+                end
+
+# Main namespace.
+module SublimeTextKit
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sublime_text_kit
 version: !ruby/object:Gem::Version
-  version: 10.0.2
+  version: 11.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,22 +28,50 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-08-08 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.4'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
@@ -59,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '2.4'
 description:
 email:
 - brooke@alchemists.io
@@ -86,16 +114,30 @@ files:
 - README.adoc
 - bin/sublime_text_kit
 - lib/sublime_text_kit.rb
-- lib/sublime_text_kit/cli.rb
+- lib/sublime_text_kit/cli/actions/config.rb
+- lib/sublime_text_kit/cli/actions/metadata.rb
+- lib/sublime_text_kit/cli/actions/session.rb
+- lib/sublime_text_kit/cli/actions/snippets.rb
+- lib/sublime_text_kit/cli/actions/update.rb
+- lib/sublime_text_kit/cli/configuration/content.rb
+- lib/sublime_text_kit/cli/configuration/defaults.yml
+- lib/sublime_text_kit/cli/configuration/loader.rb
+- lib/sublime_text_kit/cli/parsers.rb
+- lib/sublime_text_kit/cli/parsers/assembler.rb
+- lib/sublime_text_kit/cli/parsers/core.rb
+- lib/sublime_text_kit/cli/shell.rb
+- lib/sublime_text_kit/container.rb
 - lib/sublime_text_kit/identity.rb
-- lib/sublime_text_kit/metadata/base.rb
-- lib/sublime_text_kit/metadata/project_metadata.rb
-- lib/sublime_text_kit/metadata/workspace_metadata.rb
-- lib/sublime_text_kit/session.rb
+- lib/sublime_text_kit/metadata/handler.rb
+- lib/sublime_text_kit/metadata/pathway.rb
+- lib/sublime_text_kit/metadata/serializers/project.rb
+- lib/sublime_text_kit/metadata/serializers/workspace.rb
+- lib/sublime_text_kit/sessions/rebuilder.rb
 - lib/sublime_text_kit/snippets/collector.rb
+- lib/sublime_text_kit/snippets/model.rb
 - lib/sublime_text_kit/snippets/printers/ascii_doc.rb
 - lib/sublime_text_kit/snippets/printers/markdown.rb
-- lib/sublime_text_kit/snippets/snippet.rb
+- lib/sublime_text_kit/snippets/reader.rb
 homepage: https://www.alchemists.io/projects/sublime_text_kit
 licenses:
 - Apache-2.0
@@ -119,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: A command line interface for managing Sublime Text metadata.

data/lib/sublime_text_kit/cli.rb

@@ -1,182 +0,0 @@
-# frozen_string_literal: true
-
-require "thor"
-require "thor/actions"
-require "runcom"
-
-module SublimeTextKit
-  # The Command Line Interface (CLI) for the gem.
-  class CLI < Thor
-    include Thor::Actions
-
-    package_name Identity::VERSION_LABEL
-
-    def self.configuration
-      Runcom::Config.new "#{Identity::NAME}/configuration.yml"
-    end
-
-    # Initialize.
-    def initialize args = [], options = {}, config = {}
-      super args, options, config
-      @markdown_printer = Snippets::Printers::Markdown.new
-      @ascii_doc_printer = Snippets::Printers::ASCIIDoc.new
-    end
-
-    desc "-u, [--update]", "Update Sublime Text with current settings."
-    map %w[-u --update] => :update
-    def update
-      create_metadata
-      say
-      rebuild_session
-    end
-
-    desc "-s, [--session]", "Manage session metadata."
-    map %w[-s --session] => :session
-    method_option :rebuild,
-                  aliases: "-R",
-                  desc: "Rebuild session metadata.",
-                  type: :boolean,
-                  default: false
-    def session
-      say
-      options.rebuild? ? rebuild_session : help("--session")
-      say
-    end
-
-    desc "-p, [--snippets]", "Print user defined snippets."
-    map %w[-p --snippets] => :snippets
-    method_option :ascii_doc,
-                  aliases: "-a",
-                  desc: "Print snippets in ASCII Doc format.",
-                  type: :boolean,
-                  default: false
-    method_option :markdown,
-                  aliases: "-m",
-                  desc: "Print snippets in Markdown format.",
-                  type: :boolean,
-                  default: false
-    def snippets
-      say
-
-      if options.ascii_doc? then ascii_doc_printer.call
-      elsif options.markdown? then markdown_printer.call
-      else help "--snippets"
-      end
-
-      say
-    end
-
-    desc "-m, [--metadata]", "Manage project/workspace metadata."
-    map %w[-m --metadata] => :metadata
-    method_option :create, aliases: "-c", desc: "Create metadata.", type: :boolean, default: false
-    method_option :destroy, aliases: "-D", desc: "Destroy metadata.", type: :boolean, default: false
-    method_option :rebuild, aliases: "-R", desc: "Rebuild metadata.", type: :boolean, default: false
-    def metadata
-      say
-
-      if options.create? then create_metadata
-      elsif options.destroy? then destroy_metadata
-      elsif options.rebuild? then rebuild_metadata
-      else help "--metadata"
-      end
-
-      say
-    end
-
-    desc "-c, [--config]", "Manage gem configuration."
-    map %w[-c --config] => :config
-    method_option :edit,
-                  aliases: "-e",
-                  desc: "Edit gem configuration.",
-                  type: :boolean,
-                  default: false
-    method_option :info,
-                  aliases: "-i",
-                  desc: "Print gem configuration.",
-                  type: :boolean,
-                  default: false
-    def config
-      path = self.class.configuration.current
-
-      if options.edit? then `#{ENV["EDITOR"]} #{path}`
-      elsif options.info?
-        path ? say(path) : say("Configuration doesn't exist.")
-      else help :config
-      end
-    end
-
-    desc "-v, [--version]", "Show gem version."
-    map %w[-v --version] => :version
-    def version
-      say Identity::VERSION_LABEL
-    end
-
-    desc "-h, [--help=COMMAND]", "Show this message or get help for a command."
-    map %w[-h --help] => :help
-    def help task = nil
-      say and super
-    end
-
-    private
-
-    attr_reader :ascii_doc_printer, :markdown_printer
-
-    def project_roots
-      @project_roots ||= self.class.configuration.to_h.fetch :project_roots, []
-    end
-
-    def metadata_dir
-      @metadata_dir ||= File.expand_path self.class.configuration.to_h.fetch(:metadata_dir)
-    end
-
-    def create_metadata
-      say_status :info, "Creating metadata...", :green
-      say_status :info, "Metadata Path: #{metadata_dir}", :green
-      project_roots.each do |project_root|
-        say_status :info, "Processing project root: #{File.expand_path project_root}...", :green
-        Metadata::Project.create project_root, metadata_dir
-        Metadata::Workspace.create project_root, metadata_dir
-      end
-      say_status :info, "Metadata created.", :green
-    end
-
-    def destroy_metadata
-      if yes? "Delete metadata in #{metadata_dir}?"
-        say_status :info, "Deleting metadata...", :green
-        Metadata::Project.delete metadata_dir
-        Metadata::Workspace.delete metadata_dir
-        say_status :info, "Metadata deleted.", :green
-      else
-        say_status :info, "Metadata deletion aborted.", :green
-      end
-    end
-
-    def rebuild_metadata
-      if yes? "Rebuild metadata in #{metadata_dir}?"
-        say_status :info, "Deleting metadata...", :green
-        Metadata::Project.delete metadata_dir
-        Metadata::Workspace.delete metadata_dir
-
-        say_status :info, "Creating metadata...", :green
-        project_roots.each do |project_root|
-          say_status :info, "Processing project root: #{File.expand_path project_root}...", :green
-          Metadata::Project.create project_root, metadata_dir
-          Metadata::Workspace.create project_root, metadata_dir
-        end
-
-        say_status :info, "Metadata rebuilt.", :green
-      else
-        say_status :info, "Metadata rebuild aborted.", :green
-      end
-    end
-
-    def rebuild_session
-      say_status :info, "Rebuilding session metadata...", :green
-      say_status :info, "Metadata (project/workspace) Path: #{metadata_dir}", :green
-      say_status :info, "Session Path: #{Session.session_path}", :green
-      session = Session.new metadata_dir
-      session.rebuild_recent_workspaces
-      say_status :info, "Session metadata rebuilt.", :green
-    end
-  end
-end