sublime_text_kit 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2239271c10f2b155d088c491aa65e30129bff7a1
-  data.tar.gz: b1788def92004f8065a1354c9644764a9305a8b5
+  metadata.gz: 2d9e9aa5ee813bd01378aa676a7e5bc791bfdb7c
+  data.tar.gz: 815656149157d6e29e1460ce7aa940ff3c1d91ec
 SHA512:
-  metadata.gz: f42f30b0c1e3e38ea4117e9b573d7d087fa303e02117edfb215e43c0cb959384a873eb519b55124175d29436faa59606d8fd75dc733a1c19ef32049eb55277f7
-  data.tar.gz: b4be6906f7090262b1744850b1a00fc92773c90478c6fa8ca70bc44ed80ff15ade305f98596123d968d131553c7e943d6350a5fbbd00560e0d0e069d3c0c958a
+  metadata.gz: 52d69e28ef667843eb1d9a5e4f808435e9903c1e3f2065bed201bd4d8cec86d5d78413c392946eb29a9f1b8e679354a108cc28585506377ee418f9261701d1c8
+  data.tar.gz: 8897f213815a660c1347e658203ab1bd9cad204c27c84d9a654e971d0d55b3da67938ac18dd79afcc76a2fe163e6087cc37e21f72bc6866c9c63a287e698d3a7

data/README.md

@@ -1,13 +1,34 @@
-# Overview
-
-[![Gem Version](https://badge.fury.io/rb/sublime_text_kit.png)](http://badge.fury.io/rb/sublime_text_kit)
-[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/sublime_text_kit.png)](https://codeclimate.com/github/bkuhlmann/sublime_text_kit)
-[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/sublime_text_kit/coverage.png)](https://codeclimate.com/github/bkuhlmann/sublime_text_kit)
-[![Gemnasium Status](https://gemnasium.com/bkuhlmann/sublime_text_kit.png)](https://gemnasium.com/bkuhlmann/sublime_text_kit)
-[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/sublime_text_kit.png)](http://travis-ci.org/bkuhlmann/sublime_text_kit)
-[![Gittip](http://img.shields.io/gittip/bkuhlmann.svg)](https://www.gittip.com/bkuhlmann)
-
-Provides a collection of utilities that aid in Sublime Text management.
+# Sublime Text Kit
+
+[![Gem Version](https://badge.fury.io/rb/sublime_text_kit.svg)](http://badge.fury.io/rb/sublime_text_kit)
+[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/sublime_text_kit.svg)](https://codeclimate.com/github/bkuhlmann/sublime_text_kit)
+[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/sublime_text_kit/coverage.svg)](https://codeclimate.com/github/bkuhlmann/sublime_text_kit)
+[![Gemnasium Status](https://gemnasium.com/bkuhlmann/sublime_text_kit.svg)](https://gemnasium.com/bkuhlmann/sublime_text_kit)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/sublime_text_kit.svg)](https://travis-ci.org/bkuhlmann/sublime_text_kit)
+[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
+
+A command line interface for managing Sublime Text metadata.
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Setup](#setup)
+  - [Upgrading](#upgrading)
+- [Usage](#usage)
+  - [Workflow](#workflow)
+  - [Troubleshooting](#troubleshooting)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
 
 # Features
 
@@ -21,8 +42,8 @@ Provides a collection of utilities that aid in Sublime Text management.
 
 # Requirements
 
-0. [MRI 2.x.x](http://www.ruby-lang.org).
-0. [Sublime Text 2](http://www.sublimetext.com).
+0. [MRI 2.x.x](https://www.ruby-lang.org).
+0. [Sublime Text 2](https://www.sublimetext.com).
 
 # Setup
 
@@ -66,6 +87,17 @@ If using the example settings shown above and assuming the following directory s
     ~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-project
     ~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-workspace
 
+## Upgrading
+
+For those upgrading from Sublime Text Kit v2.0.0 or earlier, be mindful of the following changes:
+
+0. Ensure you are using Sublime Text 3 (it is currently in Beta but your v2.0.0 license will work).
+0. Update the `~/.sublime/settings.yml` file to switch from a `workspace_dir` to a `metadata_dir` instead.
+0. Run the following commands to rebuild your project/workspace and session metadata:
+
+        stk -m -R # Destroys and rebuilds your existing project/workspace metadata to Sublime Text 3 format.
+        skt -s -r # Rebuilds your session history with project metadata as generated above.
+
 # Usage
 
 From the command line, type: `stk`
@@ -87,24 +119,7 @@ For session options, type: `stk --session`
 
     -r, [--rebuild-session], [--no-rebuild-session]  # Rebuild session metadata.
 
-# Tests
-
-To test, run:
-
-    bundle exec rspec spec
-
-# Upgrading
-
-For those upgrading from Sublime Text Kit v2.0.0 or earlier, be mindful of the following changes:
-
-0. Ensure you are using Sublime Text 3 (it is currently in Beta but your v2.0.0 license will work).
-0. Update the `~/.sublime/settings.yml` file to switch from a `workspace_dir` to a `metadata_dir` instead.
-0. Run the following commands to rebuild your project/workspace and session metadata:
-
-        stk -m -R # Destroys and rebuilds your existing project/workspace metadata to Sublime Text 3 format.
-        skt -s -r # Rebuilds your session history with project metadata as generated above.
-
-# Workflow
+## Workflow
 
 The following demonstrates a default Sublime Text setup:
 
@@ -117,12 +132,18 @@ The following demonstrates a default Sublime Text setup:
    you can (fuzzy type) project names to jump between them.
 0. Breeze through your project workload with ease. :)
 
-# Troubleshooting
+## 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.
 
+# Tests
+
+To test, run:
+
+    bundle exec rake
+
 # Versioning
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:

data/bin/stk

@@ -4,5 +4,5 @@ require "sublime_text_kit"
 require "sublime_text_kit/cli"
 require "sublime_text_kit/identity"
 
-Process.setproctitle SublimeTextKit::Identity.label_version
+Process.setproctitle SublimeTextKit::Identity.version_label
 SublimeTextKit::CLI.start

data/lib/sublime_text_kit/cli.rb

@@ -3,11 +3,14 @@ require "thor"
 require "thor/actions"
 require "thor_plus/actions"
 
-  module SublimeTextKit
+module SublimeTextKit
+  # The Command Line Interface (CLI) for the gem.
   class CLI < Thor
     include Thor::Actions
     include ThorPlus::Actions
 
+    package_name SublimeTextKit::Identity.version_label
+
     # Initialize.
     def initialize args = [], options = {}, config = {}
       super args, options, config
@@ -55,36 +58,22 @@ require "thor_plus/actions"
       say
     end
 
-    desc "-s, [--session]", "Manage session metadata."
-    map %w(-s --session) => :session
-    method_option :rebuild_session, aliases: "-r", desc: "Rebuild session metadata.", type: :boolean, default: false
-    def session
-      say
-
-      case
-        when options[:rebuild_session] then rebuild_session
-        else help("--session")
-      end
-
-      say
-    end
-
-    desc "-e, [--edit]", "Edit settings in default editor (assumes $EDITOR environment variable)."
+    desc "-e, [--edit]", "Edit #{SublimeTextKit::Identity.label} settings in default editor."
     map %w(-e --edit) => :edit
     def edit
       `#{editor} #{@settings_file}`
     end
 
-    desc "-v, [--version]", "Show version."
+    desc "-v, [--version]", "Show #{SublimeTextKit::Identity.label} version."
     map %w(-v --version) => :version
     def version
-      say SublimeTextKit::Identity.label_version
+      say SublimeTextKit::Identity.version_label
     end
 
     desc "-h, [--help=HELP]", "Show this message or get help for a command."
     map %w(-h --help) => :help
     def help task = nil
-      say and super
+      say && super
     end
 
     private

data/lib/sublime_text_kit/identity.rb

@@ -1,4 +1,5 @@
 module SublimeTextKit
+  # Gem identity information.
   module Identity
     def self.name
       "sublime_text_kit"
@@ -9,11 +10,15 @@ module SublimeTextKit
     end
 
     def self.version
-      "3.1.0"
+      "3.2.0"
     end
 
-    def self.label_version
-      [label, version].join " "
+    def self.version_label
+      "#{label} #{version}"
+    end
+
+    def self.file_name
+      ".#{name}rc"
     end
   end
 end

data/lib/sublime_text_kit/metadata/base.rb

@@ -3,6 +3,7 @@ require "pathname"
 
 module SublimeTextKit
   module Metadata
+    # Abstract class for processing metadata.
     class Base
       attr_reader :name, :project_dir, :metadata_dir, :metadata_file
 
@@ -11,12 +12,12 @@ module SublimeTextKit
         return unless valid_dir?(instance.project_dir, "Projects")
         return unless valid_dir?(instance.metadata_dir, "Metadata")
 
-        project_paths = ::Pathname.new(instance.project_dir).children.select {|child| child.directory? }
+        project_paths = ::Pathname.new(instance.project_dir).children.select(&:directory?)
         project_paths.each { |project_dir| new(project_dir, metadata_dir).save }
       end
 
       def self.delete metadata_dir
-        instance = new '', metadata_dir
+        instance = new "", metadata_dir
         return unless valid_dir?(instance.metadata_dir, "Metadata")
 
         ::Pathname.glob("#{instance.metadata_dir}/*.#{instance.file_extension}").each(&:delete)
@@ -38,13 +39,10 @@ module SublimeTextKit
       end
 
       def save
-        unless File.exist? metadata_file
-          File.open(metadata_file, 'w') { |file| file.write MultiJson.dump(to_h, pretty: true) }
-        end
+        return if File.exist? metadata_file
+        File.open(metadata_file, "w") { |file| file.write MultiJson.dump(to_h, pretty: true) }
       end
 
-      private
-
       def self.valid_dir? dir, label
         if File.exist?(dir)
           true
@@ -53,6 +51,7 @@ module SublimeTextKit
           false
         end
       end
+      private_class_method :valid_dir?
     end
   end
 end

data/lib/sublime_text_kit/metadata/project_metadata.rb

@@ -1,5 +1,6 @@
 module SublimeTextKit
   module Metadata
+    # Processes project metadata.
     class Project < Base
       def initialize project_dir, metadata_dir
         super project_dir, metadata_dir

data/lib/sublime_text_kit/metadata/workspace_metadata.rb

@@ -1,5 +1,6 @@
 module SublimeTextKit
   module Metadata
+    # Processes workspace metadata.
     class Workspace < Base
       def initialize project_dir, metadata_dir
         super project_dir, metadata_dir

data/lib/sublime_text_kit/session.rb

@@ -1,6 +1,7 @@
 require "multi_json"
 
 module SublimeTextKit
+  # Manages Sublime Text session data.
   class Session
     attr_reader :metadata_dir
 
@@ -22,21 +23,20 @@ module SublimeTextKit
 
     def rebuild_recent_workspaces
       session = load_session
+      return unless session && session["workspaces"] && session["workspaces"]["recent_workspaces"]
 
-      if session && session["workspaces"] && session["workspaces"]["recent_workspaces"]
-        session["workspaces"]["recent_workspaces"] = workspaces
-        save_session session
-      end
+      session["workspaces"]["recent_workspaces"] = workspaces
+      save_session session
     end
 
     private
 
     def load_session
-      File.exists?(self.class.session_path) ? MultiJson.load(File.read(self.class.session_path)) : {}
+      File.exist?(self.class.session_path) ? MultiJson.load(File.read(self.class.session_path)) : {}
     end
 
     def save_session json
-      File.open(self.class.session_path, 'w') { |file| file.write MultiJson.dump(json, pretty: true) }
+      File.open(self.class.session_path, "w") { |file| file.write MultiJson.dump(json, pretty: true) }
     end
   end
 end

data/lib/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -1,36 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sublime_text_kit
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZicm9v
-  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
-  aW8wHhcNMTUwNzA1MTQ1MzExWhcNMTYwNzA0MTQ1MzExWjBBMQ8wDQYDVQQDDAZi
-  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
-  GRYCaW8wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCzhOVcvLGBCceM
-  PppVpJLUKsnskWzc1VqBXmv30feKNw+MOxMQaDsIP421qwqGO/2JHY60Kuobssk+
-  8/wqZkVFF/FFKxoQjuhlhc+VWLm8jWgXd4N1kwO2yytscQTzxc5qXarwA+36fqVH
-  RhBAHhjka+HdBI+6o3CXRHJoC47iav+QpR7u/wYl3gNq6MJO3MmTKqHegEDLjRN0
-  FJAr3bRAwq03ZtTuAVA2bdKLGThehe1RRRtJHJ/PHpmL2c203/GTXYtG6C8ILZIp
-  ZroTqQ8yglCJ+3hSOmodZqSAQ0Rj7GJgtuNH81qlSrHu5sTvoZjGmEqSIhvsSJ80
-  wKoPdZnFAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBSUnF478a5lB4xuOBiktJdMJv6JmDAfBgNVHREEGDAWgRRicm9va2VAYWxjaGVt
-  aXN0cy5pbzAfBgNVHRIEGDAWgRRicm9va2VAYWxjaGVtaXN0cy5pbzANBgkqhkiG
-  9w0BAQUFAAOCAQEAT7KtBXWsq1KA7NOSMeFEDeSvhrgdLwCG/37pIu0rjvx9iAW4
-  gncxV0MccqIUtaF+lekjlXkIO+rXAVjvdha23KtpFTW90dYXp4NLPnPlSdyvYzJy
-  FIAaWGvujOT8xEu4umd45q5aepE8li4bR071i5Z7F0trKNVYYrxjQFmH5SSKYRT/
-  fXtICtAh1de3z3SOSK58IMPwjuoApYBxiqlmx0Uhla7mrzCE5+NmLPit3hLH6JFK
-  aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
-  xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
-  -----END CERTIFICATE-----
-date: 2015-07-05 00:00:00.000000000 Z
+cert_chain: []
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -88,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
+  name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -131,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-remote
+  name: pry-state
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -158,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -228,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -242,7 +262,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Command line utilities for Sublime Text packaged as a Ruby Gem.
+description: A command line interface for managing Sublime Text metadata.
 email:
 - brooke@alchemists.io
 executables:
@@ -262,6 +282,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/tasks/rspec.rake
+- lib/tasks/rubocop.rake
 homepage: https://github.com/bkuhlmann/sublime_text_kit
 licenses:
 - MIT
@@ -282,8 +304,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
-summary: Command line utilities for Sublime Text.
+summary: A command line interface for managing Sublime Text metadata.
 test_files: []