sublime_text_kit 10.0.1 → 11.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e145b2083c5d4ce09d03116d1fb4dce5350602c04408bc47e9ef66521af2ae1c
-  data.tar.gz: ef04ac615a582b9f2aa7dfd6184a7fe2dc3c9ab11a955c8af682c040dae66968
+  metadata.gz: 2f8f675530354cbbc227b1c77e6225403854ad144023b7f6004b4bf14b195100
+  data.tar.gz: 2991173c6048e21b7269533f0b4d289d1784968c4514b515f018096a15575edc
 SHA512:
-  metadata.gz: 4b5805b739b68eb8cdefbf7ee2c8becccc58b336dc5a19af33c88faef32af5128504a34ea8971f30c19218121fe1376411e6f33f8ea2dffe3e907374147351cf
-  data.tar.gz: fdd3b820ed97ad419a42bb545d4a14cbe5ed7171802627e1ab6be640c98d1b032bf34e51133be10f45479307292a6820f8c1f92f87a43d87ea6edd8141e8290a
+  metadata.gz: bc17e4f0e7fa9d70ec52cd8e93f8dc64677207fe3c66a857157f6ca70ef8d72b01999988a035c9e5a400df16e1b8c600798fb1af74276f9a0e9d99b1b15efd4d
+  data.tar.gz: 3c2efc9fb3b060c010fd10480383afc37befb6d2bf436b28dea5cd2589bde81ec14e380b4e64f443cd26e33b461ea8c8b9c5bd769e741970e3f208ed508a7492

data/README.adoc

@@ -11,22 +11,20 @@ image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchem
 [link=https://circleci.com/gh/bkuhlmann/sublime_text_kit]
 image::https://circleci.com/gh/bkuhlmann/sublime_text_kit.svg?style=svg[Circle CI Status]
 
-A command line interface for managing Sublime Text metadata.
+Sublime Text Kit is a command line interface for managing Sublime Text metadata for multiple
+projects, sessions, snippets, etc. This allows you to avoiding manual maintenance of your workspace
+so you can stay focused on your own work.
 
 toc::[]
 
 == Features
 
-* Provides project metadata (i.e. `.sublime-project` and `.sublime-workspace` files) management for
-  project switching via the `CONTROL+COMMAND+P` shortcut.
-* Rebuilds project history (Project -> Recent Projects) from existing project files (assumes project
-  metadata is in a directory) so one can easily toggle between up-to-date project information via
-  the `CONTROL+COMMAND+P` shortcut.
-
-== Screencasts
-
-[link=https://www.alchemists.io/screencasts/sublime_text_kit]
-image::https://www.alchemists.io/images/screencasts/sublime_text_kit/cover.svg[Screencast,600,240,role=focal_point]
+* Manages project metadata (`.sublime-project` and `.sublime-workspace` files).
+* Manages session metadata so you can quickly toggle between projects via the `CONTROL+COMMAND+p`
+  shortcut.
+* Prints all of your custom snippets in either
+  link:https://daringfireball.net/projects/markdown[Markdown] or
+  link:https://asciidoctor.org[ASCII Doc] format.
 
 == Requirements
 
@@ -49,41 +47,14 @@ gem install sublime_text_kit
 From the command line, type: `sublime_text_kit`
 
 ....
-sublime_text_kit -c, [--config]        # Manage gem configuration.
-sublime_text_kit -h, [--help=COMMAND]  # Show this message or get help for a command.
-sublime_text_kit -m, [--metadata]      # Manage project/workspace metadata.
-sublime_text_kit -p, [--snippets]      # Print user defined snippets.
-sublime_text_kit -s, [--session]       # Manage session metadata.
-sublime_text_kit -u, [--update]        # Update Sublime Text with current settings.
-sublime_text_kit -v, [--version]       # Show gem version.
-....
-
-For configuration options, type: `sublime_text_kit --help --config`
-
-....
--e, [--edit], [--no-edit]  # Edit gem configuration.
--i, [--info], [--no-info]  # Print gem configuration.
-....
-
-For metadata options, type: `sublime_text_kit --help --metadata`
-
-....
--c, [--create], [--no-create]    # Create metadata.
--D, [--destroy], [--no-destroy]  # Destroy metadata.
--R, [--rebuild], [--no-rebuild]  # Rebuild metadata.
-....
-
-For session options, type: `sublime_text_kit --help --session`
-
-....
--R, [--rebuild], [--no-rebuild]  # Rebuild session metadata.
-....
-
-For snippet options, type: `sublime_text_kit --help --snippets`
-
-....
--a, [--ascii-doc], [--no-ascii-doc]  # Print snippets in ASCII Doc format.
--m, [--markdown], [--no-markdown]    # Print snippets in Markdown format.
+USAGE:
+  -c, --config ACTION                      Manage gem configuration. Actions: edit or view.
+  -h, --help                               Show this message.
+  -m, --metadata ACTION                    Manage project metadata. Actions: create, delete, or recreate.
+  -S, --session                            Rebuild session metadata.
+  -s, --snippets [FORMAT]                  View snippets. Default: ascii_doc. Formats: markdown or ascii_doc.
+  -u, --update                             Update project and session metadata based on current settings.
+  -v, --version                            Show gem version.
 ....
 
 === Customization
@@ -97,26 +68,26 @@ An example configuration could be:
 [source,yaml]
 ----
 :project_roots:
-  - "~/Dropbox/Development/Misc"
-  - "~/Dropbox/Development/OSS"
-  - "~/Dropbox/Development/Work"
+  - "~/Engineering/Organizations"
+  - "~/Engineering/OSS"
 :metadata_dir: "~/Dropbox/Cache/Sublime"
+:snippets_format: :ascii_doc
 ----
 
-Feel free to take this configuration, modify, and save as your own custom `+configuration.yml+`.
+Feel free to take this configuration, modify, and save as your own.
 
-The project roots define the root level directories where project folders are located. When project
-metadata (i.e. `.sublime-project`, `.sublime-workspace`) is generated, the name of the metadata file
-will be the same name as that of the project folder. All project metadata, regardless of root
-location, is written to the same metadata directory. If using the example settings shown above and
-assuming the following directory structure exists…
+The `project_roots` key defines the root level directories where your project folders are located.
+When project metadata (i.e. `.sublime-project`, `.sublime-workspace`) is generated, the name of the
+metadata file will be the same name as the project folder. All project metadata, regardless of root
+location, is written to the same metadata directory as defined by the `metadata_dir` key. If using
+the example settings shown above and assuming the following directory structure exists…
 
 ....
-~/Dropbox/Development/Misc/example
-~/Dropbox/Development/OSS/sublime_text_kit
+~/Engineering/OSS/example
+~/Engineering/OSS/sublime_text_kit
 ....
 
-…the project metadata will be created in the workspace directory as follows:
+...project metadata will be created in the `metadata_dir` as follows:
 
 ....
 ~/Dropbox/Cache/Sublime/example.sublime-project
@@ -125,25 +96,33 @@ assuming the following directory structure exists…
 ~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-workspace
 ....
 
+The `snippets_format` key allows you define what format to print your snippets as. The default
+format is Markdown but you can switch to ASCII Doc too. You can always override your default
+configuration by specifying the format from the command line: `sublime_text_kit -s ascii_doc`. For
+example, this is how link:https://www.alchemists.io/projects/sublime_text_setup/#_snippets[snippets
+documentation] is genereted for the
+link:https://www.alchemists.io/projects/sublime_text_setup[Sublime Text Setup] project.
+
 === Workflow
 
 The following demonstrates a default Sublime Text setup:
 
-. Run: `sublime_text_kit --config --edit` (define Sublime Text Kit settings for project roots and
-  metadata directory).
-. Shutdown Sublime Text (i.e. `CONTROL+Q`).
-. Run: `sublime_text_kit --metadata --create` (creates project metadata and rebuilds the session
-  metadata so Sublime Text has a complete project history from which to jump through via the
-  `CONTROL+COMMMAND+P` shortcut).
-. Launch Sublime Text and use the `CONTROL+COMMAND+P` keyboard shortcut to toggle between
-  projects. Notice that you can (fuzzy type) project names to jump between them.
-. Breeze through your project workload with ease. 😉
+1. Start by defining your configuration: `sublime_text_kit --config edit`.
+2. Shutdown Sublime Text (i.e. `COMMAND+q`).
+3. Run `sublime_text_kit --update` which will create project metadata and rebuild session metadata
+   so Sublime Text has a complete project history from which to switch between via the
+   `CONTROL+COMMMAND+p` shortcut.
+4. Launch Sublime Text and use the `CONTROL+COMMAND+p` keyboard shortcut to toggle between projects.
+   Notice that you can (fuzzy type) project names to jump between them.
+5. Navigate through your project workload with ease. 🎉
 
 === Troubleshooting
 
-* When rebuilding workspaces, ensure Sublime Text is shutdown or changes won’t be applied.
-* When rebuilding workspaces, ensure workspace_dir (as defined via settings.yml) points to a
-  directory containing `.sublime-project` and `.sublime-workspace` files.
+* When rebuilding your session, ensure Sublime Text is shut down or changes might not be applied
+  properly.
+* When rebuilding project metadata, ensure the `metadata_dir` -- as defined via your configuration
+  -- points to an existing directory which can contain `.sublime-project` and `.sublime-workspace`
+  files.
 
 == Development
 

data/bin/sublime_text_kit

@@ -2,8 +2,6 @@
 # frozen_string_literal: true
 
 require "sublime_text_kit"
-require "sublime_text_kit/cli"
-require "sublime_text_kit/identity"
 
 Process.setproctitle SublimeTextKit::Identity::VERSION_LABEL
-SublimeTextKit::CLI.start
+SublimeTextKit::CLI::Shell.new.call ARGV

data/lib/sublime_text_kit/cli/actions/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module CLI
+    module Actions
+      # Handles gem configuration action.
+      class Config
+        def initialize configuration: Configuration::Loader::HANDLER, container: Container
+          @configuration = configuration
+          @container = container
+        end
+
+        def call action
+          case action
+            when :edit then edit
+            when :view then view
+            else logger.error { "Invalid configuration action: #{action}." }
+          end
+        end
+
+        private
+
+        attr_reader :configuration, :container
+
+        def edit = kernel.system("$EDITOR #{configuration.current}")
+
+        def view = kernel.system("cat #{configuration.current}")
+
+        def kernel = container[__method__]
+
+        def logger = container[__method__]
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/actions/metadata.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "refinements/pathnames"
+
+module SublimeTextKit
+  module CLI
+    module Actions
+      # Handles metadata action.
+      class Metadata
+        using Refinements::Pathnames
+
+        def initialize handler: SublimeTextKit::Metadata::Handler, container: Container
+          @handler = handler
+          @container = container
+        end
+
+        def call kind
+          case kind
+            when :create then create
+            when :delete then delete
+            when :recreate then recreate
+            else logger.error "Unknown metadata action: #{kind}."
+          end
+        end
+
+        private
+
+        attr_reader :handler, :container
+
+        def create
+          logger.info "Creating metadata in #{metadata_dir}..."
+          process_projects __method__
+          logger.info "Metadata created."
+        end
+
+        def delete
+          logger.info "Deleting metadata in #{metadata_dir}..."
+          process_projects __method__
+          logger.info "Metadata deleted."
+        end
+
+        def recreate
+          logger.info "Recreating metadata in #{metadata_dir}..."
+          process_projects __method__
+          logger.info "Metadata recreated."
+        end
+
+        def process_projects method
+          configuration.project_dirs.each do |directory|
+            handler.with_project(directory, metadata_dir).public_send method
+            handler.with_workspace(directory, metadata_dir).public_send method
+          end
+        end
+
+        def metadata_dir = Pathname(configuration.metadata_dir).expand_path
+
+        def configuration = container[__method__]
+
+        def logger = container[__method__]
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/actions/session.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module CLI
+    module Actions
+      # Handles session action.
+      class Session
+        def initialize rebuilder: Sessions::Rebuilder.new, container: Container
+          @rebuilder = rebuilder
+          @container = container
+        end
+
+        def call
+          rebuilder.call
+          logger.info "Session rebuilt."
+        end
+
+        private
+
+        attr_reader :rebuilder, :container
+
+        def logger = container[__method__]
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/actions/snippets.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module CLI
+    module Actions
+      # Handles snippets action.
+      class Snippets
+        PRINTERS = {
+          ascii_doc: SublimeTextKit::Snippets::Printers::ASCIIDoc.new,
+          markdown: SublimeTextKit::Snippets::Printers::Markdown.new
+        }.freeze
+
+        def initialize printers: PRINTERS, container: Container
+          @printers = printers
+          @container = container
+        end
+
+        def call
+          kind = configuration.snippets_format
+          printers.fetch(kind).call
+        rescue KeyError
+          logger.error { "Invalid snippet format (must be a symbol): #{kind}. Use: #{formats}." }
+        end
+
+        private
+
+        attr_reader :printers, :container
+
+        def formats = printers.keys.map(&:inspect).join(" or ")
+
+        def configuration = container[__method__]
+
+        def logger = container[__method__]
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/actions/update.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SublimeTextKit
+  module CLI
+    module Actions
+      # Handles update action.
+      class Update
+        def initialize metadata: SublimeTextKit::Metadata::Handler,
+                       session: Sessions::Rebuilder.new,
+                       container: Container
+          @metadata = metadata
+          @session = session
+          @container = container
+        end
+
+        def call
+          logger.info "Updating metadata and session..."
+          create_metadata
+          session.call
+          logger.info "Metadata and session updated."
+        end
+
+        private
+
+        attr_reader :metadata, :session, :container
+
+        def create_metadata
+          configuration.project_dirs.each do |directory|
+            metadata.with_project(directory, metadata_dir).create
+            metadata.with_workspace(directory, metadata_dir).create
+          end
+        end
+
+        def metadata_dir = Pathname(configuration.metadata_dir).expand_path
+
+        def configuration = container[__method__]
+
+        def logger = container[__method__]
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/configuration/content.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "refinements/pathnames"
+
+module SublimeTextKit
+  module CLI
+    module Configuration
+      # Defines configuration content as the primary source of truth for use throughout the gem.
+      Content = Struct.new(
+        :action_config,
+        :action_help,
+        :action_metadata,
+        :action_session,
+        :action_snippets,
+        :action_update,
+        :action_version,
+        :project_roots,
+        :metadata_dir,
+        :snippets_format,
+        :session_path,
+        :user_dir,
+        keyword_init: true
+      ) do
+        using Refinements::Pathnames
+
+        def initialize *arguments
+          super
+
+          home = Pathname ENV["HOME"]
+
+          self[:session_path] ||= home.join(
+            "Library/Application Support/Sublime Text/Local/Session.sublime_session"
+          )
+
+          self[:user_dir] ||= home.join "Library/Application Support/Sublime Text/Packages/User"
+        end
+
+        def project_dirs
+          Array(project_roots).map { |path| Pathname(path).expand_path }
+                              .flat_map(&:directories)
+        end
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/configuration/defaults.yml

@@ -0,0 +1,3 @@
+:project_roots:
+:metadata_dir:
+:snippets_format: :markdown

data/lib/sublime_text_kit/cli/configuration/loader.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module SublimeTextKit
+  module CLI
+    module Configuration
+      # Represents the fully assembled Command Line Interface (CLI) configuration.
+      class Loader
+        using Refinements::Hashes
+        using Refinements::Structs
+
+        DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+        HANDLER = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
+
+        def self.call = new.call
+
+        def self.with_defaults = new(handler: DEFAULTS)
+
+        def initialize content: Content.new, handler: HANDLER
+          @content = content
+          @handler = handler
+        end
+
+        def call = content.merge(**handler.to_h.flatten_keys)
+
+        private
+
+        attr_reader :content, :handler
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/parsers/assembler.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "runcom"
+
+module SublimeTextKit
+  module CLI
+    module Parsers
+      # Assembles and parses all Command Line Interface (CLI) options.
+      class Assembler
+        def initialize section: Core, client: CLIENT, container: Container
+          @section = section
+          @client = client
+          @container = container
+        end
+
+        def call arguments = []
+          section.call client: client
+          client.parse! arguments
+          configuration
+        end
+
+        def to_s = client.to_s
+
+        private
+
+        attr_reader :section, :client, :container
+
+        def configuration = container[__method__]
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/parsers/core.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "versionaire/extensions/option_parser"
+
+module SublimeTextKit
+  module CLI
+    module Parsers
+      # Handles parsing of Command Line Interface (CLI) core options.
+      class Core
+        def self.call(...) = new(...).call
+
+        def initialize client: CLIENT, container: Container
+          @client = client
+          @container = container
+        end
+
+        def call arguments = []
+          client.banner = "#{Identity::LABEL} - #{Identity::SUMMARY}"
+          client.separator "\nUSAGE:\n"
+          collate
+          arguments.empty? ? arguments : client.parse!(arguments)
+        end
+
+        private
+
+        attr_reader :client, :container
+
+        def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
+
+        def add_config
+          client.on(
+            "-c",
+            "--config ACTION",
+            %i[edit view],
+            "Manage gem configuration. Actions: edit or view."
+          ) do |action|
+            configuration.action_config = action
+          end
+        end
+
+        def add_metadata
+          client.on(
+            "-m",
+            "--metadata ACTION",
+            %i[create delete recreate],
+            "Manage project metadata. Actions: create, delete, or recreate."
+          ) do |action|
+            configuration.action_metadata = action
+          end
+        end
+
+        def add_session
+          client.on "-S", "--session", "Rebuild session metadata." do
+            configuration.action_session = true
+          end
+        end
+
+        def add_snippets
+          client.on(
+            "-s",
+            "--snippets [FORMAT]",
+            %i[markdown ascii_doc],
+            "View snippets. Default: #{configuration.snippets_format}. " \
+            "Formats: markdown or ascii_doc."
+          ) do |kind|
+            configuration.action_snippets = true
+            configuration.snippets_format = kind if kind
+          end
+        end
+
+        def add_update
+          client.on(
+            "-u",
+            "--update",
+            "Update project and session metadata based on current settings."
+          ) do
+            configuration.action_update = true
+          end
+        end
+
+        def add_version
+          client.on "-v", "--version", "Show gem version." do
+            configuration.action_version = Identity::VERSION_LABEL
+          end
+        end
+
+        def add_help
+          client.on "-h", "--help", "Show this message." do
+            configuration.action_help = true
+          end
+        end
+
+        private_methods
+
+        def configuration = container[__method__]
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/cli/parsers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module SublimeTextKit
+  module CLI
+    module Parsers
+      CLIENT = OptionParser.new nil, 40, "  "
+    end
+  end
+end