sublime_text_kit 9.1.0 → 9.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e18a60bcea4e410a4e2c7b68927cb76f607eb06cde37fab3a6031f141d43f3b
-  data.tar.gz: edfc386ffd97eb1b02f56430e7b01d6e12b3c8737bc75922a4ca4ef5ffa0fe11
+  metadata.gz: 69803566c44ec04ac2ddb673df6084f90efcb40344c0f396e391e0b56bb106e2
+  data.tar.gz: ce5fdc6daa656d3026b9153c59a0ffa0d85c66a009b840432c57c5d74e9ad57b
 SHA512:
-  metadata.gz: b248d267aab2d9a936f5dc284b45f981df813200527ab177fd06fc80233bc0efecb9722d18029df3f3b8fa81055792da5dd48a8254fadfe7e703168368ca9128
-  data.tar.gz: 5e7ae4fdd9331a8a1f43a18a630ce6d3a7b0788790e359b9d71ff2a3c960a026dd46fcc452909e3a942a207aef6dd2c606bdd4a6b65381690ce0b2e5840022b2
+  metadata.gz: 3e03f2f696ccd6796d61226f39c8fcc97c8e6c4430023cfbb2dc640d2dfa4d41ba0cd54b40376c0e33ab2ad8ff84979c3016d2a57517323fae7910af8fd54ce9
+  data.tar.gz: e8dfdd209bfde7b0f60b41f761659d8c4999abbf005aa15b7c3c38838f346439f20559084db42d1305ea0f693c28d9f654a148a6afd9d68a3ca2a1652d56a6d9

data/LICENSE.adoc

@@ -150,7 +150,7 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright link:https://www.alchemists.io[Alchemists].
+Copyright 2014 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
 compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]

data/README.adoc

@@ -6,6 +6,8 @@
 
 [link=http://badge.fury.io/rb/sublime_text_kit]
 image::https://badge.fury.io/rb/sublime_text_kit.svg[Gem Version]
+[link=https://www.alchemists.io/projects/code_quality]
+image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
 [link=https://circleci.com/gh/bkuhlmann/sublime_text_kit]
 image::https://circleci.com/gh/bkuhlmann/sublime_text_kit.svg?style=svg[Circle CI Status]
 
@@ -23,18 +25,16 @@ toc::[]
 
 == Screencasts
 
-[link=https://www.alchemists.io/screencasts/sublime_text_kit.html]
-image::https://www.alchemists.io/images/screencasts/sublime_text_kit/cover-original.png[Screencast,role=focal_point]
+[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]
 
 == Requirements
 
-. https://www.ruby-lang.org[Ruby 2.7.x].
-. https://www.sublimetext.com[Sublime Text 3].
+. link:https://www.ruby-lang.org[Ruby]
+. link:https://www.sublimetext.com[Sublime Text]
 
 == Setup
 
-=== Production
-
 To install, run:
 
 [source,bash]
@@ -42,24 +42,6 @@ To install, run:
 gem install sublime_text_kit
 ----
 
-=== Development
-
-To contribute, run:
-
-[source,bash]
-----
-git clone https://github.com/bkuhlmann/sublime_text_kit.git
-cd sublime_text_kit
-bin/setup
-----
-
-You can also use the IRB console for direct access to all objects:
-
-[source,bash]
-----
-bin/console
-----
-
 == Usage
 
 === Command Line Interface (CLI)
@@ -100,7 +82,8 @@ For session options, type: `sublime_text_kit --help --session`
 For snippet options, type: `sublime_text_kit --help --snippets`
 
 ....
--m, [--markdown], [--no-markdown]  # Print snippets in Markdown format.
+-a, [--ascii-doc], [--no-ascii-doc]  # Print snippets in ASCII Doc format.
+-m, [--markdown], [--no-markdown]    # Print snippets in Markdown format.
 ....
 
 === Customization
@@ -162,6 +145,24 @@ The following demonstrates a default Sublime Text setup:
 * When rebuilding workspaces, ensure workspace_dir (as defined via settings.yml) points to a
   directory containing `.sublime-project` and `.sublime-workspace` files.
 
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/sublime_text_kit.git
+cd sublime_text_kit
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
 == Tests
 
 To test, run:
@@ -198,4 +199,4 @@ Read link:CHANGES.adoc[CHANGES] for details.
 
 == Credits
 
-Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann.html[Brooke Kuhlmann].
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/sublime_text_kit.rb

@@ -5,6 +5,8 @@ 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"

data/lib/sublime_text_kit/cli.rb

@@ -19,6 +19,7 @@ module SublimeTextKit
     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."
@@ -44,6 +45,11 @@ module SublimeTextKit
 
     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.",
@@ -51,7 +57,12 @@ module SublimeTextKit
                   default: false
     def snippets
       say
-      options.markdown? ? markdown_printer.call : help("--snippets")
+
+      if options.ascii_doc? then ascii_doc_printer.call
+      elsif options.markdown? then markdown_printer.call
+      else help "--snippets"
+      end
+
       say
     end
 
@@ -63,9 +74,9 @@ module SublimeTextKit
     def metadata
       say
 
-      if options[:create] then create_metadata
-      elsif options[:destroy] then destroy_metadata
-      elsif options[:rebuild] then rebuild_metadata
+      if options.create? then create_metadata
+      elsif options.destroy? then destroy_metadata
+      elsif options.rebuild? then rebuild_metadata
       else help "--metadata"
       end
 
@@ -108,7 +119,7 @@ module SublimeTextKit
 
     private
 
-    attr_reader :markdown_printer
+    attr_reader :ascii_doc_printer, :markdown_printer
 
     def project_roots
       @project_roots ||= self.class.configuration.to_h.fetch :project_roots, []

data/lib/sublime_text_kit/identity.rb

@@ -5,7 +5,7 @@ module SublimeTextKit
   module Identity
     NAME = "sublime_text_kit"
     LABEL = "Sublime Text Kit"
-    VERSION = "9.1.0"
+    VERSION = "9.6.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

data/lib/sublime_text_kit/metadata/project_metadata.rb

@@ -4,10 +4,6 @@ module SublimeTextKit
   module Metadata
     # Processes project metadata.
     class Project < Base
-      def initialize project_dir, metadata_dir
-        super project_dir, metadata_dir
-      end
-
       def file_extension
         "sublime-project"
       end

data/lib/sublime_text_kit/metadata/workspace_metadata.rb

@@ -4,10 +4,6 @@ module SublimeTextKit
   module Metadata
     # Processes workspace metadata.
     class Workspace < Base
-      def initialize project_dir, metadata_dir
-        super project_dir, metadata_dir
-      end
-
       def file_extension
         "sublime-workspace"
       end

data/lib/sublime_text_kit/snippets/collector.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "rexml/document"
+
+module SublimeTextKit
+  module Snippets
+    class Collector
+      DEFAULT_USER_PATH = "Library/Application Support/Sublime Text 3/Packages/User"
+
+      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
+      end
+
+      def call
+        root_path.glob("*.sublime-snippet")
+                 .map { |path| model.new REXML::Document.new(path.read) }
+                 .sort_by(&:description)
+      end
+
+      private
+
+      attr_reader :model, :user_path, :environment
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rexml/document"
+
+module SublimeTextKit
+  module Snippets
+    module Printers
+      class ASCIIDoc
+        def initialize collector: Collector.new
+          @collector = collector
+        end
+
+        def call
+          collector.call.each do |snippet|
+            puts "* #{snippet.description} - `#{snippet.trigger}`\n"
+          end
+        end
+
+        private
+
+        attr_reader :collector
+      end
+    end
+  end
+end

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

@@ -1,41 +1,22 @@
 # frozen_string_literal: true
 
-require "rexml/document"
-
 module SublimeTextKit
   module Snippets
     module Printers
       class Markdown
-        DEFAULT_USER_PATH = "Library/Application Support/Sublime Text 3/Packages/User"
-
-        def initialize user_path = DEFAULT_USER_PATH, environment: ENV
-          @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 collector: Collector.new
+          @collector = collector
         end
 
         def call
-          snippets.sort_by(&:description).each do |snippet|
+          collector.call.each do |snippet|
             puts "- #{snippet.description} - `#{snippet.trigger}`\n"
           end
         end
 
         private
 
-        attr_reader :user_path, :environment
-
-        def snippets
-          root_path.glob("*.sublime-snippet").map do |path|
-            Snippet.new REXML::Document.new(File.open(path))
-          end
-        end
+        attr_reader :collector
       end
     end
   end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: sublime_text_kit
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -28,233 +28,51 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: runcom
+  name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.16'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '6.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: bundler-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.0'
-- !ruby/object:Gem::Dependency
-  name: git-cop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.79'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.79'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-- !ruby/object:Gem::Dependency
-  name: simplecov
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
+        version: '0.20'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
-description: 
+        version: '0.20'
+description:
 email:
 - brooke@alchemists.io
 executables:
@@ -274,6 +92,8 @@ files:
 - 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/snippets/collector.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
 homepage: https://www.alchemists.io/projects/sublime_text_kit
@@ -284,7 +104,7 @@ metadata:
   changelog_uri: https://www.alchemists.io/projects/sublime_text_kit/changes.html
   documentation_uri: https://www.alchemists.io/projects/sublime_text_kit
   source_code_uri: https://github.com/bkuhlmann/sublime_text_kit
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -299,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.0
+signing_key:
 specification_version: 4
 summary: A command line interface for managing Sublime Text metadata.
 test_files: []