sublime_text_kit 10.0.2 → 11.0.3

data/lib/sublime_text_kit/cli/shell.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module CLI
+    # The main Command Line Interface (CLI) object.
+    class Shell
+      ACTIONS = {
+        config: Actions::Config.new,
+        metadata: Actions::Metadata.new,
+        session: Actions::Session.new,
+        snippets: Actions::Snippets.new,
+        update: Actions::Update.new
+      }.freeze
+
+      def initialize parser: Parsers::Assembler.new, actions: ACTIONS, container: Container
+        @parser = parser
+        @actions = actions
+        @container = container
+      end
+
+      def call arguments = []
+        perform parser.call(arguments)
+      rescue OptionParser::ParseError, Error => error
+        logger.error { error.message }
+      end
+
+      private
+
+      attr_reader :parser, :actions, :container
+
+      def perform configuration
+        case configuration
+          in action_config: Symbol => action then config action
+          in action_metadata: Symbol => kind then metadata kind
+          in action_session: true then session
+          in action_snippets: true then snippets
+          in action_update: true then update
+          in action_version: String => version then logger.info version
+          else usage
+        end
+      end
+
+      def config(action) = actions.fetch(__method__).call(action)
+
+      def metadata(kind) = actions.fetch(__method__).call(kind)
+
+      def session = actions.fetch(__method__).call
+
+      def snippets = actions.fetch(__method__).call
+
+      def update = actions.fetch(__method__).call
+
+      def usage = logger.unknown { parser.to_s }
+
+      def logger = container[__method__]
+    end
+  end
+end

data/lib/sublime_text_kit/container.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "logger"
+require "pastel"
+
+module SublimeTextKit
+  # Provides a global gem container for injection into other objects.
+  module Container
+    extend Dry::Container::Mixin
+
+    register(:configuration, memoize: true) { CLI::Configuration::Loader.call }
+    register(:colorizer) { Pastel.new enabled: $stdout.tty? }
+    register(:kernel) { Kernel }
+
+    register :log_colors do
+      {
+        "DEBUG" => self[:colorizer].white.detach,
+        "INFO" => self[:colorizer].green.detach,
+        "WARN" => self[:colorizer].yellow.detach,
+        "ERROR" => self[:colorizer].red.detach,
+        "FATAL" => self[:colorizer].white.bold.on_red.detach,
+        "ANY" => self[:colorizer].white.bold.detach
+      }
+    end
+
+    register :logger do
+      Logger.new $stdout,
+                 level: Logger.const_get(ENV.fetch("LOG_LEVEL", "INFO")),
+                 formatter: (
+                   lambda do |severity, _at, _name, message|
+                     self[:log_colors][severity].call "#{message}\n"
+                   end
+                 )
+    end
+  end
+end

data/lib/sublime_text_kit/identity.rb

@@ -5,7 +5,8 @@ module SublimeTextKit
   module Identity
     NAME = "sublime_text_kit"
     LABEL = "Sublime Text Kit"
-    VERSION = "10.0.2"
-    VERSION_LABEL = "#{LABEL} #{VERSION}"
+    VERSION = "11.0.3"
+    VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
+    SUMMARY = "A command line interface for managing Sublime Text metadata."
   end
 end

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,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: sublime_text_kit
 version: !ruby/object:Gem::Version
-  version: 10.0.2
+  version: 11.0.3
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
@@ -28,22 +28,50 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-08-08 00:00:00.000000000 Z
+date: 2021-11-20 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.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.5'
 - !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.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '2.5'
 description:
 email:
 - brooke@alchemists.io
@@ -84,18 +112,32 @@ extra_rdoc_files:
 files:
 - LICENSE.adoc
 - README.adoc
-- bin/sublime_text_kit
+- exe/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
@@ -103,6 +145,7 @@ metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/sublime_text_kit/issues
   changelog_uri: https://www.alchemists.io/projects/sublime_text_kit/changes.html
   documentation_uri: https://www.alchemists.io/projects/sublime_text_kit
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/sublime_text_kit
 post_install_message:
 rdoc_options: []
@@ -119,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: A command line interface for managing Sublime Text metadata.