sublime_text_kit 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cba74006e1c0762c5f6315ffecc80c916edb758
-  data.tar.gz: f40453ee36378702f4480b9368692dc9535e2955
+  metadata.gz: 4a314305161fb7d4e24fa3d19a53838ce27f1708
+  data.tar.gz: fe173ec68939df2d472460f9350eab1caaaf620d
 SHA512:
-  metadata.gz: 034b7546cc13db1748b3fedc393122ccf2584b64d6bb8d972799d08c8705d043d64efdb4d32524e4d08337d29fa0b95782b784747866648563603630ff15f2d6
-  data.tar.gz: a27974c98239debab3c42d6e89a4145dd245402d7acee92173ad7154ecc0df2a0912e45b53bccdb845eca896cd9aeb88771f57bcd1f02d74cf7df38f03185052
+  metadata.gz: 9e38ddf46046f2dba762e4dbbf15e29e6c62465a135973c0d2db60c72e31f92903014939d77c8624f1359089d67f566e07a2d9e9489e019ad56734636dc29da9
+  data.tar.gz: 789a7ff63ca6eb6a2ba5d9383e70de11432de3c6a685da1ffc97aeda9d42f168d23f101e00c05e6c4be832d6326728fb622d450504ddc9176feff50024986ec6

data.tar.gz.sig

@@ -1,3 +1,2 @@
-S�r[�x�#��~���Lk��-�DA�U?�˶
-
������l�_�r��\u	~��by���֞Y6���!<;�m��`B����u5_p%�;�#�J�p��oN/N��[J*���>�����ٌ�u���h"ZJ�~茣\��e�q">O�Z�rڲT�����{��)Ǹs�������h�4SS�7��S�q	�Ϧ���&d8�'6����R�e&���v	�zA���"$��
-��6�bl_QՁ��C#�$��f`
+J+��+?ƌ�gr��Q�ϵ�Tv�סڗ0�u��(B��u��'���������z�t�#�*��Gʈ������Ÿ}Wߨѹ� V󤿝�w,~
+죕���>�����f�O�d�F�

data/README.md

@@ -11,12 +11,13 @@ Provides a collection of utilities that aid in Sublime Text management.
 
 # Features
 
-- Creates project metadata (i.e. *.sublime-project files) for easy project switching via the `COMMAND+CONTROL+P`
-  shortcut.
-- Destroys project metadata (i.e. *.sublime-project and *.sublime-workspace files).
-- Rebuilds recent workspace history (via Project -> Recent Projects) from existing project files (assumes workspaces are
-  in a single directory) so one can easily toggle between up-to-date project information via the `COMMAND+CONTROL+P`
-  shortcut.
+- 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.
+
+[![asciicast](https://asciinema.org/a/19858.png)](https://asciinema.org/a/19858)
 
 # Requirements
 
@@ -50,12 +51,12 @@ Example:
       - "~/Dropbox/Development/Misc"
       - "~/Dropbox/Development/OSS"
       - "~/Dropbox/Development/Work"
-    :workspace_dir: "~/Dropbox/Cache/Sublime"
+    :metadata_dir: "~/Dropbox/Cache/Sublime"
 
-The project roots are the root level directories to where project folders are located. When project metadata (i.e.
-*.sublime-project) 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 workspace directory. If using the example settings
-shown above and assuming the following directory structure exists...
+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...
 
     ~/Dropbox/Development/Misc/example
     ~/Dropbox/Development/OSS/sublime_text_kit
@@ -63,26 +64,30 @@ shown above and assuming the following directory structure exists...
 ...the project metadata will be created in the workspace directory as follows:
 
     ~/Dropbox/Cache/Sublime/example.sublime-project
+    ~/Dropbox/Cache/Sublime/example.sublime-workspace
     ~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-project
+    ~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-workspace
 
 # Usage
 
-From the command line, type: stk
+From the command line, type: `stk`
 
+    stk -c, [--configure]  # Configure Sublime Text with current settings.
     stk -e, [--edit]       # Edit settings in default editor (assumes $EDITOR environment variable).
     stk -h, [--help=HELP]  # Show this message or get help for a command.
-    stk -p, [--project]    # Manage project metadata.
-    stk -s, [--session]    # Manage session data.
+    stk -m, [--metadata]   # Manage project/workspace metadata.
+    stk -s, [--session]    # Manage session metadata.
     stk -v, [--version]    # Show version.
 
-For project options, type: stk --project
+For metadata options, type: `stk --metadata`
 
-    -c, [--create], [--no-create]    # Create project metadata.
-    -D, [--destroy], [--no-destroy]  # Destroy all project metadata.
+    -c, [--create], [--no-create]    # Create metadata.
+    -D, [--destroy], [--no-destroy]  # Destroy metadata.
+    -R, [--rebuild], [--no-rebuild]  # Rebuild metadata.
 
-For session options, type: stk --session
+For session options, type: `stk --session`
 
-    -r, [--rebuild-recent-workspaces]  # Rebuild recent workspaces.
+    -r, [--rebuild-session], [--no-rebuild-session]  # Rebuild session metadata.
 
 # Tests
 
@@ -90,26 +95,35 @@ 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
 
-The following demonstrates a common workflow that makes you more productive with Sublime Text:
+The following demonstrates a default Sublime Text setup:
 
-0. Run: `stk -e` (define Sublime Text Kit settings for project roots and workspace directory).
+0. Run: `stk -e` (define Sublime Text Kit settings for project roots and metadata directory).
 0. Shutdown Sublime Text (i.e. `CONTROL+Q`).
-0. Run: `stk -p -D` (optional -- start with a clean slate. WARNING: This deletes all project metadata in the workspace
-   dir).
-0. Run: `stk -p -c` (creates project metadata so Sublime Text knows where to source the project from).
-0. Run: `stk -s -r` (rebuilds Sublime Text recent workspace metadata based on the project metadata created in Step #4).
-0. Launch Sublime Text
-0. Type: `COMMAND+CONTROL+P` to toggle between projects. Notice that you can easily (fuzzy type) project names to jump
-   between them.
+0. Run: `stk -c` (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).
+   ).
+0. 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.
 0. Breeze 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 files.
+  *.sublime-project and *.sublime-workspace files.
 
 # Versioning
 
@@ -119,13 +133,14 @@ Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 - Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
 - Major (X.y.z) - Incremented for any backwards incompatible public API changes.
 
-# Contributions
+# Code of Conduct
 
-Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
+you agree to abide by its terms.
 
-# Credits
+# Contributions
 
-Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io).
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 # License
 
@@ -136,3 +151,8 @@ Read the [LICENSE](LICENSE.md) for details.
 
 Read the [CHANGELOG](CHANGELOG.md) for details.
 Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io).
+

data/lib/sublime_text_kit.rb

@@ -1,3 +1,5 @@
 require "sublime_text_kit/version"
-require "sublime_text_kit/project_metadata"
 require "sublime_text_kit/session"
+require "sublime_text_kit/metadata/base"
+require "sublime_text_kit/metadata/project_metadata"
+require "sublime_text_kit/metadata/workspace_metadata"

data/lib/sublime_text_kit/cli.rb

@@ -3,7 +3,7 @@ require "thor"
 require "thor/actions"
 require "thor_plus/actions"
 
-module SublimeTextKit
+  module SublimeTextKit
   class CLI < Thor
     include Thor::Actions
     include ThorPlus::Actions
@@ -15,30 +15,54 @@ module SublimeTextKit
       @settings = load_yaml @settings_file
     end
 
-    desc "-p, [--project]", "Manage project metadata."
-    map %w(-p --project) => :project
-    method_option :create, aliases: "-c", desc: "Create project metadata.", type: :boolean, default: false
-    method_option :destroy, aliases: "-D", desc: "Destroy all project metadata.", type: :boolean, default: false
-    def project
+    desc "-c, [--configure]", "Configure Sublime Text with current settings."
+    map %w(-c --configure) => :configure
+    def configure
+      create_metadata
+      say
+      rebuild_session
+    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 "-m, [--metadata]", "Manage project/workspace metadata."
+    map %w(-m --metadata) => :metadata
+    method_option :create, aliases: "-c", desc: "Create metadata.", type: :boolean, default: false
+    method_option :destroy, aliases: "-D", desc: "Destroy metadata.", type: :boolean, default: false
+    method_option :rebuild, aliases: "-R", desc: "Rebuild metadata.", type: :boolean, default: false
+    def metadata
       say
 
       case
-        when options[:create] then create_project_metadata
-        when options[:destroy] then destroy_project_metadata
-        else help("--project")
+        when options[:create] then create_metadata
+        when options[:destroy] then destroy_metadata
+        when options[:rebuild] then rebuild_metadata
+        else help("--metadata")
       end
 
       say
     end
 
-    desc "-s, [--session]", "Manage session data."
+    desc "-s, [--session]", "Manage session metadata."
     map %w(-s --session) => :session
-    method_option :rebuild_recent_workspaces, aliases: "-r", desc: "Rebuild recent workspaces.", type: :boolean, default: false
+    method_option :rebuild_session, aliases: "-r", desc: "Rebuild session metadata.", type: :boolean, default: false
     def session
       say
 
       case
-        when options[:rebuild_recent_workspaces] then rebuild_recent_workspaces
+        when options[:rebuild_session] then rebuild_session
         else help("--session")
       end
 
@@ -69,37 +93,58 @@ module SublimeTextKit
       @project_roots ||= @settings.fetch :project_roots, []
     end
 
-    def workspace_dir
-      @workspace_dir ||= File.expand_path @settings.fetch(:workspace_dir)
+    def metadata_dir
+      @metadata_dir ||= File.expand_path @settings.fetch(:metadata_dir)
     end
 
-    def create_project_metadata
-      info "Creating project metadata..."
-      info "Workspaces Path: #{workspace_dir}"
+    def create_metadata
+      info "Creating metadata..."
+      info "Metadata Path: #{metadata_dir}"
       project_roots.each do |project_root|
         info "Processing project root: #{File.expand_path project_root}..."
-        SublimeTextKit::ProjectMetadata.create project_root, workspace_dir
+        SublimeTextKit::Metadata::Project.create project_root, metadata_dir
+        SublimeTextKit::Metadata::Workspace.create project_root, metadata_dir
+      end
+      info "Metadata created."
+    end
+
+    def destroy_metadata
+      if yes? "Delete metadata in #{metadata_dir}?"
+        info "Deleting metadata..."
+        SublimeTextKit::Metadata::Project.delete metadata_dir
+        SublimeTextKit::Metadata::Workspace.delete metadata_dir
+        info "Metadata deleted."
+      else
+        info "Metadata deletion aborted."
       end
-      info "Project metadata created."
     end
 
-    def destroy_project_metadata
-      if yes? "Delete all project metadata in #{workspace_dir}?"
-        info "Deleting project metadata..."
-        SublimeTextKit::ProjectMetadata.delete workspace_dir
-        info "Project metadata deleted."
+    def rebuild_metadata
+      if yes? "Rebuild metadata in #{metadata_dir}?"
+        info "Deleting metadata..."
+        SublimeTextKit::Metadata::Project.delete metadata_dir
+        SublimeTextKit::Metadata::Workspace.delete metadata_dir
+
+        info "Creating metadata..."
+        project_roots.each do |project_root|
+          info "Processing project root: #{File.expand_path project_root}..."
+          SublimeTextKit::Metadata::Project.create project_root, metadata_dir
+          SublimeTextKit::Metadata::Workspace.create project_root, metadata_dir
+        end
+
+        info "Metadata rebuilt."
       else
-        info "Project metadata deletion aborted."
+        info "Metadata rebuild aborted."
       end
     end
 
-    def rebuild_recent_workspaces
-      info "Rebuilding recent workspaces..."
-      info "Workspaces Path: #{workspace_dir}"
-      info "Sublime Text Session: #{SublimeTextKit::Session.session_path}"
-      session = SublimeTextKit::Session.new workspace_dir: workspace_dir
+    def rebuild_session
+      info "Rebuilding session metadata..."
+      info "Metadata (project/workspace) Path: #{metadata_dir}"
+      info "Session Path: #{SublimeTextKit::Session.session_path}"
+      session = SublimeTextKit::Session.new metadata_dir
       session.rebuild_recent_workspaces
-      info "Recent workspaces rebuilt."
+      info "Session metadata rebuilt."
     end
   end
 end

data/lib/sublime_text_kit/metadata/base.rb

@@ -0,0 +1,58 @@
+require "multi_json"
+require "pathname"
+
+module SublimeTextKit
+  module Metadata
+    class Base
+      attr_reader :name, :project_dir, :metadata_dir, :metadata_file
+
+      def self.create projects_dir, metadata_dir
+        instance = new projects_dir, metadata_dir
+        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.each { |project_dir| new(project_dir, metadata_dir).save }
+      end
+
+      def self.delete metadata_dir
+        instance = new '', metadata_dir
+        return unless valid_dir?(instance.metadata_dir, "Metadata")
+
+        ::Pathname.glob("#{instance.metadata_dir}/*.#{instance.file_extension}").each(&:delete)
+      end
+
+      def initialize project_dir, metadata_dir
+        @name = File.basename project_dir
+        @project_dir = File.expand_path project_dir
+        @metadata_dir = File.expand_path metadata_dir
+        @metadata_file = File.join @metadata_dir, "#{name}.#{file_extension}"
+      end
+
+      def file_extension
+        "sublime-unknown"
+      end
+
+      def to_h
+        {}
+      end
+
+      def save
+        unless File.exist? metadata_file
+          File.open(metadata_file, 'w') { |file| file.write MultiJson.dump(to_h, pretty: true) }
+        end
+      end
+
+      private
+
+      def self.valid_dir? dir, label
+        if File.exist?(dir)
+          true
+        else
+          puts "#{label} directory doesn't exist: #{dir}."
+          false
+        end
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/metadata/project_metadata.rb

@@ -0,0 +1,21 @@
+module SublimeTextKit
+  module Metadata
+    class Project < Base
+      def initialize project_dir, metadata_dir
+        super project_dir, metadata_dir
+      end
+
+      def file_extension
+        "sublime-project"
+      end
+
+      def to_h
+        {
+          folders: [
+            {path: "#{project_dir}"}
+          ]
+        }
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/metadata/workspace_metadata.rb

@@ -0,0 +1,24 @@
+module SublimeTextKit
+  module Metadata
+    class Workspace < Base
+      def initialize project_dir, metadata_dir
+        super project_dir, metadata_dir
+      end
+
+      def file_extension
+        "sublime-workspace"
+      end
+
+      def to_h
+        {
+          expanded_folders: ["#{project_dir}"],
+          select_project: {
+            selected_items: [
+              [name, File.join(metadata_dir, "#{name}.sublime-project")]
+            ]
+          }
+        }
+      end
+    end
+  end
+end

data/lib/sublime_text_kit/session.rb

@@ -2,22 +2,22 @@ require "multi_json"
 
 module SublimeTextKit
   class Session
-    attr_reader :workspace_dir
+    attr_reader :metadata_dir
 
     def self.home_path
       ENV.fetch "HOME"
     end
 
     def self.session_path
-      "#{home_path}/Library/Application Support/Sublime Text 2/Settings/Session.sublime_session"
+      "#{home_path}/Library/Application Support/Sublime Text 3/Local/Session.sublime_session"
     end
 
-    def initialize options = {}
-      @workspace_dir = File.expand_path options.fetch(:workspace_dir)
+    def initialize metadata_directory
+      @metadata_dir = File.expand_path metadata_directory
     end
 
     def workspaces
-      Dir["#{workspace_dir}/*.sublime-project"].sort
+      Dir["#{metadata_dir}/*.sublime-workspace"].sort
     end
 
     def rebuild_recent_workspaces

data/lib/sublime_text_kit/version.rb

@@ -1,3 +1,3 @@
 module SublimeTextKit
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sublime_text_kit
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   fMlZDUGx3lQarp/vPjK+6XH7DLXjBEKqeIGBIpLthYUvDxJRp23C+T3liGSL32vg
   mSpxxwmK95GDFuEy2mNPaxnazdkw8c+7DbrSpzd/CnNZkRgitxOavs8=
   -----END CERTIFICATE-----
-date: 2015-01-01 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -257,7 +257,9 @@ files:
 - bin/stk
 - lib/sublime_text_kit.rb
 - lib/sublime_text_kit/cli.rb
-- lib/sublime_text_kit/project_metadata.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/version.rb
 homepage: https://github.com/bkuhlmann/sublime_text_kit
@@ -280,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Command line utilities for Sublime Text.

data/lib/sublime_text_kit/project_metadata.rb

@@ -1,59 +0,0 @@
-require "multi_json"
-require "pathname"
-
-module SublimeTextKit
-  class ProjectMetadata
-    attr_reader :name, :project_dir, :workspace_dir, :project_file
-
-    def self.create projects_dir, workspace_dir
-      projects_dir = File.expand_path projects_dir
-      workspace_dir = File.expand_path workspace_dir
-
-      return unless valid_dir?(projects_dir, "Projects")
-      return unless valid_dir?(workspace_dir, "Workspace")
-
-      project_paths = ::Pathname.new(projects_dir).children.select {|child| child if child.directory? }
-      project_paths.each { |project_dir| new(project_dir, workspace_dir).save }
-    end
-
-    def self.delete workspace_dir
-      workspace_dir = File.expand_path workspace_dir
-
-      return unless valid_dir?(workspace_dir, "Workspace")
-
-      ::Pathname.glob("#{workspace_dir}/*.sublime-*").each(&:delete)
-    end
-
-    def initialize project_dir, workspace_dir
-      @name = File.basename project_dir
-      @project_dir = File.expand_path project_dir
-      @workspace_dir = File.expand_path workspace_dir
-      @project_file = File.join @workspace_dir, "#{name}.sublime-project"
-    end
-
-    def to_h
-      {
-        folders: [
-          {path: "#{project_dir}"}
-        ]
-      }
-    end
-
-    def save
-      unless File.exist? project_file
-        File.open(project_file, 'w') { |file| file.write MultiJson.dump(to_h, pretty: true) }
-      end
-    end
-
-    private
-
-    def self.valid_dir? dir, label
-      if File.exist?(dir)
-        true
-      else
-        puts "#{label} directory doesn't exist: #{dir}."
-        false
-      end
-    end
-  end
-end