sublime_text_kit 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d173993643e980feb91e623938bfa50be976e514
-  data.tar.gz: 8f065e8668bbe900fd3227cf3cbd163e5434bfb5
+  metadata.gz: daef9d1fb25afffabeafc440ba2263086f5a6f11
+  data.tar.gz: ca7141c16811f8d87e38879079126a21ec47c9e8
 SHA512:
-  metadata.gz: 79199642c7b5deb93287f908db304dd8549b89079c407fc669841d0d8bb9e0c7b916a9b0a226f6695a74386dffbd9061d05bf858b273afa22523382aedaeb77e
-  data.tar.gz: aaa6e737013786db418efa92c217d3d08456fa6774b2a81cb239f9d740bb8c26ad7445afca915c2f5fa3dc0c09faea35c0c44580fa5aee39638043288d30487d
+  metadata.gz: 7b0299ab99e1957eb5eb3c30947a7a83e1c23737d4c70da90e579e0cfa1735435fcd4a94292e8da8bf7d4a527d9d5d18708f244385a533d272bcc6c669a04891
+  data.tar.gz: f47dd9c9780516b952adb8851cf73aea9875c58214b414a7dcef0d43f68731ef9cbdecbca60ef2a601aad6fdf4fbb44cd2c2092291338c26b6c397728f1e5b82

checksums.yaml.gz.sig

@@ -1 +1,2 @@
-��5��r⠪�m�>$İ_��uX���ٮ3��%��;U�HER�F�L_}�q�F�4r!�ם��;�����O�5��Uꞣ�h ��V�8/Pk�|�����i�&:o �A0f�~�J�#J����^z��Ie`->�� h?�3�N{еc�CjlL�P��U��M!� e6���&ME!ȣ�C�������wϘ�n�����͉�V��Œ�'�y��Ȑ�e���ı�����ln��܁�N��
+GɃ�uq��s���G�Ft�z}/2�W��-X��I���^t6�����qẒ?�kKZ>�ma��ߢ��fH�KTܣ��[ ĝů��Qk�V�n&�/��7���(H7�@���FW?躠/��±���c�Tq�}"L5�^k/"������
+	�Z���Q;�+���S�F��V��xF�S[��4��c"6���D	Eέ��v�(]\@dtC�@+u��a+�8𬝾�,$�3p�5�� ����%�;�+^dn!�

data/README.md

@@ -7,21 +7,23 @@
 [![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 managment. These utilities are fairly sparse at the
-moment but will grow over time as new needs arise.
+Provides a collection of utilities that aid in Sublime Text management.
 
 # Features
 
-* 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.
+- 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.
 
 # Requirements
 
 0. Any of the following Ruby VMs:
-    * [MRI 2.x.x](http://www.ruby-lang.org)
-    * [JRuby 1.x.x](http://jruby.org)
-    * [Rubinius 2.x.x](http://rubini.us)
+    - [MRI 2.x.x](http://www.ruby-lang.org)
+    - [JRuby 1.x.x](http://jruby.org)
+    - [Rubinius 2.x.x](http://rubini.us)
 0. [Sublime Text 2](http://www.sublimetext.com).
 
 # Setup
@@ -45,7 +47,24 @@ You can define settings by creating the following file:
 Example:
 
     ---
-    :workspaces_path: ~/Dropbox/Cache/Sublime
+    :project_roots:
+      - "~/Dropbox/Development/Misc"
+      - "~/Dropbox/Development/OSS"
+      - "~/Dropbox/Development/Work"
+    :workspace_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...
+
+    ~/Dropbox/Development/Misc/example
+    ~/Dropbox/Development/OSS/sublime_text_kit
+
+...the project metadata will be created in the workspace directory as follows:
+
+    ~/Dropbox/Cache/Sublime/example.sublime-project
+    ~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-project
 
 # Usage
 
@@ -53,18 +72,18 @@ From the command line, type: stk
 
     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 -v, [--version]    # Show version.
 
-For session options, type: stk help --session
+For project options, type: stk --project
 
-    -r, [--rebuild-recent-workspaces]  # Rebuild recent workspaces.
+    -c, [--create], [--no-create]    # Create project metadata.
+    -D, [--destroy], [--no-destroy]  # Destroy all project metadata.
 
-# Troubleshooting
+For session options, type: stk --session
 
-* When rebuilding workspaces, ensure Sublime Text is shutdown or changes won't be applied.
-* When rebuilding workspaces, ensure workspaces_path (as defined via settings.yml) points to a directory containing
-  both *.sublime-project and *.sublime-workspace files.
+    -r, [--rebuild-recent-workspaces]  # Rebuild recent workspaces.
 
 # Tests
 
@@ -72,13 +91,34 @@ To test, run:
 
     bundle exec rspec spec
 
+# Workflow
+
+The following demonstrates a common workflow that makes you more productive with Sublime Text:
+
+0. Run: `stk -e` (define Sublime Text Kit settings for project roots and workspace 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. 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.
+
 # Versioning
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
-* Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
-* 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.
+- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- 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
 

data/lib/sublime_text_kit/cli.rb

@@ -11,10 +11,26 @@ module SublimeTextKit
     # Initialize.
     def initialize args = [], options = {}, config = {}
       super args, options, config
-      @settings_file = File.join ENV["HOME"], ".sublime", "settings.yml"
+      @settings_file = File.join ENV.fetch("HOME"), ".sublime", "settings.yml"
       @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
+      say
+
+      case
+        when options[:create] then create_project_metadata
+        when options[:destroy] then destroy_project_metadata
+        else help("--project")
+      end
+
+      say
+    end
+
     desc "-s, [--session]", "Manage session data."
     map %w(-s --session) => :session
     method_option :rebuild_recent_workspaces, aliases: "-r", desc: "Rebuild recent workspaces.", type: :boolean, default: false
@@ -22,8 +38,8 @@ module SublimeTextKit
       say
 
       case
-      when options[:rebuild_recent_workspaces] then rebuild_recent_workspaces
-      else help("--session")
+        when options[:rebuild_recent_workspaces] then rebuild_recent_workspaces
+        else help("--session")
       end
 
       say
@@ -49,11 +65,39 @@ module SublimeTextKit
 
     private
 
+    def project_roots
+      @project_roots ||= @settings.fetch :project_roots, []
+    end
+
+    def workspace_dir
+      @workspace_dir ||= File.expand_path @settings.fetch(:workspace_dir)
+    end
+
+    def create_project_metadata
+      info "Creating project metadata..."
+      info "Workspaces Path: #{workspace_dir}"
+      project_roots.each do |project_root|
+        info "Processing project root: #{File.expand_path project_root}..."
+        SublimeTextKit::ProjectMetadata.create project_root, workspace_dir
+      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."
+      else
+        info "Project metadata deletion aborted."
+      end
+    end
+
     def rebuild_recent_workspaces
       info "Rebuilding recent workspaces..."
-      session = SublimeTextKit::Session.new workspaces_path: @settings[:workspaces_path]
-      info "Workspaces Path: #{session.workspaces_absolute_path}"
+      info "Workspaces Path: #{workspace_dir}"
       info "Sublime Text Session: #{SublimeTextKit::Session.session_path}"
+      session = SublimeTextKit::Session.new workspace_dir: workspace_dir
       session.rebuild_recent_workspaces
       info "Recent workspaces rebuilt."
     end

data/lib/sublime_text_kit/project_metadata.rb

@@ -0,0 +1,40 @@
+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
+      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
+      ::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
+  end
+end

data/lib/sublime_text_kit/session.rb

@@ -2,10 +2,10 @@ require "multi_json"
 
 module SublimeTextKit
   class Session
-    attr_accessor :workspaces_path
+    attr_reader :workspace_dir
 
     def self.home_path
-      ENV["HOME"]
+      ENV.fetch "HOME"
     end
 
     def self.session_path
@@ -13,15 +13,11 @@ module SublimeTextKit
     end
 
     def initialize options = {}
-      @workspaces_path = options.fetch :workspaces_path, ''
-    end
-
-    def workspaces_absolute_path
-      File.expand_path workspaces_path
+      @workspace_dir = File.expand_path options.fetch(:workspace_dir)
     end
 
     def workspaces
-      Dir["#{workspaces_absolute_path}/*.sublime-project"].sort
+      Dir["#{workspace_dir}/*.sublime-project"].sort
     end
 
     def rebuild_recent_workspaces
@@ -40,7 +36,7 @@ module SublimeTextKit
     end
 
     def save_session json
-      File.open(self.class.session_path, 'w') { |file| file.write MultiJson.dump(json) }
+      File.open(self.class.session_path, 'w') { |file| file.write MultiJson.dump(json, pretty: true) }
     end
   end
 end

data/lib/sublime_text_kit/version.rb

@@ -1,3 +1,3 @@
 module SublimeTextKit
-  VERSION = "0.4.0"
+  VERSION = "1.0.0"
 end

data/lib/sublime_text_kit.rb

@@ -1,2 +1,3 @@
 require "sublime_text_kit/version"
+require "sublime_text_kit/project_metadata"
 require "sublime_text_kit/session"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sublime_text_kit
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   fMlZDUGx3lQarp/vPjK+6XH7DLXjBEKqeIGBIpLthYUvDxJRp23C+T3liGSL32vg
   mSpxxwmK95GDFuEy2mNPaxnazdkw8c+7DbrSpzd/CnNZkRgitxOavs8=
   -----END CERTIFICATE-----
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2014-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -200,6 +200,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  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
@@ -215,7 +229,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Command line utilities for Sublime Text packaged as a Ruby Gem.
-email: brooke@redalchemist.com
+email:
+- brooke@redalchemist.com
 executables:
 - stk
 extensions: []
@@ -228,6 +243,7 @@ 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/session.rb
 - lib/sublime_text_kit/version.rb
 homepage: https://github.com/bkuhlmann/sublime_text_kit
@@ -250,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Command line utilities for Sublime Text.