sublime_text_kit 8.4.0 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b98a6f65a6ec31ad8c445a4000e813066a638449539666f4cad5e9d4e60284b4
-  data.tar.gz: a4cffa1cf98f5e61a436b390129a7bfd62024bf1396b020486bf4fd44e1aced8
+  metadata.gz: 7b788ee61f4fdbadc934eb1fdecff98055a85689d9ac55f5f402d618c8a4e191
+  data.tar.gz: 6ffc9e2d639071d55d30e8458b340caea334d64531fe9cbaa764ac6f27d26699
 SHA512:
-  metadata.gz: 6426bbf5b6aede0ae8a89052de384f138da311b74abb1ff6761b22c6c67997ac1084e47c78d0386485526f926284c99fe0d0ae6359bfcf0fb0709a758f8566c5
-  data.tar.gz: 0143b37fcfee3cdfbfc0991b77a39e18fbd29b41045b623a9bf375bdc99ac0287f06d0426d2b878dd56111bc387dbdb70f6f962bf92931adfcc4d75a108fb87b
+  metadata.gz: dfd05a251edd98c2536d3f8ea76a9dd7325c823a0b4cf2e5374ad0b1cf5c7a0b5507c15756317fdcdb39f7ca5655150473731ee6d7ef9b6ec3c1d21355e99c54
+  data.tar.gz: 47f5373525585f6d6b5ae8c2c4d3da74afb5206b5381d93609f20cee10e1a7953faca0ef45477b02e112a8cd6ad7dcc339fd43dc9bd2c644d64a63c58a2ba02d

data.tar.gz.sig

@@ -1 +1,2 @@
-����P�ʮKZ�4�w�)��M�?:�S8���Ұ�`�ࣛ�>���E��2ܫ�Q>���,<�`N/�����
+`���&���!�;���Sy
��eGU����7_ь�A(�%f*��dŜ�.��H,vc�~`W*�c�
+��e��W�?��~D���1(`�"j��5inذ�ׂwUd\ş��Q���ZE�^=d�:�f��3���0��>�w	�+�Q�

data/README.md

@@ -44,7 +44,7 @@ A command line interface for managing Sublime Text metadata.
 
 ## Screencasts
 
-[![asciicast](https://asciinema.org/a/92707.png)](https://asciinema.org/a/92707)
+[![asciicast](https://asciinema.org/a/250653.svg)](https://asciinema.org/a/250653)
 
 ## Requirements
 
@@ -66,6 +66,7 @@ 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.
@@ -85,14 +86,17 @@ 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`
+
+    -m, [--markdown], [--no-markdown]  # Print snippets in Markdown format.
+
 ### Customization
 
 This gem can be configured via a global configuration:
 
     ~/.config/sublime_text_kit/configuration.yml
 
-It can also be configured via [XDG environment variables](https://github.com/bkuhlmann/runcom#xdg)
-as provided by the [Runcom](https://github.com/bkuhlmann/runcom) gem.
+It can also be configured via [XDG](https://github.com/bkuhlmann/xdg) environment variables.
 
 An example configuration could be:
 

data/lib/sublime_text_kit.rb

@@ -4,5 +4,7 @@ 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/printers/markdown"
 require "sublime_text_kit/session"
 require "sublime_text_kit/cli"

data/lib/sublime_text_kit/cli.rb

@@ -18,6 +18,7 @@ module SublimeTextKit
     # Initialize.
     def initialize args = [], options = {}, config = {}
       super args, options, config
+      @markdown_printer = Snippets::Printers::Markdown.new
     end
 
     desc "-u, [--update]", "Update Sublime Text with current settings."
@@ -41,6 +42,19 @@ module SublimeTextKit
       say
     end
 
+    desc "-p, [--snippets]", "Print user defined snippets."
+    map %w[-p --snippets] => :snippets
+    method_option :markdown,
+                  aliases: "-m",
+                  desc: "Print snippets in Markdown format.",
+                  type: :boolean,
+                  default: false
+    def snippets
+      say
+      options.markdown? ? markdown_printer.call : help("--snippets")
+      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
@@ -94,6 +108,8 @@ module SublimeTextKit
 
     private
 
+    attr_reader :markdown_printer
+
     def project_roots
       @project_roots ||= self.class.configuration.to_h.fetch :project_roots, []
     end

data/lib/sublime_text_kit/identity.rb

@@ -12,7 +12,7 @@ module SublimeTextKit
     end
 
     def self.version
-      "8.4.0"
+      "8.5.0"
     end
 
     def self.version_label

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "open3"
+
+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
+        end
+
+        def call
+          snippets.sort_by(&:description).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
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/snippets/snippet.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "rexml/document"
+
+module SublimeTextKit
+  module Snippets
+    class Snippet
+      ELEMENT_TRANSLATIONS = {
+        "content" => :content,
+        "tabTrigger" => :trigger,
+        "description" => :description,
+        "scope" => :scope
+      }.freeze
+
+      ALLOWED_METHODS = ELEMENT_TRANSLATIONS.values.freeze
+
+      def initialize document
+        @document = document
+        assign_elements
+      end
+
+      private
+
+      attr_reader :document,
+                  :content_element,
+                  :trigger_element,
+                  :description_element,
+                  :scope_element
+
+      def assign_elements
+        root_element.elements.each do |element|
+          name = element.name
+
+          fail StandardError, "Unknown element: #{element}." unless ELEMENT_TRANSLATIONS.key? name
+
+          instance_variable_set "@#{ELEMENT_TRANSLATIONS[name]}_element", element
+        end
+      end
+
+      def root_element
+        document.root || REXML::Element.new
+      end
+
+      def method_missing name, *arguments, &block
+        return super unless respond_to_missing? name
+
+        String((__send__("#{name}_element") || REXML::Element.new).text)
+      end
+
+      # :reek:BooleanParameter
+      def respond_to_missing? name, include_private = false
+        ALLOWED_METHODS.include?(name) || super
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sublime_text_kit
 version: !ruby/object:Gem::Version
-  version: 8.4.0
+  version: 8.5.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2019-06-01 00:00:00.000000000 Z
+date: 2019-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runcom
@@ -100,6 +100,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.5'
+- !ruby/object:Gem::Dependency
+  name: git-cop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -288,6 +316,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/printers/markdown.rb
+- lib/sublime_text_kit/snippets/snippet.rb
 homepage: https://github.com/bkuhlmann/sublime_text_kit
 licenses:
 - Apache-2.0