xcodesnippets 0.1.0 → 0.2.0

data/lib/xcode_snippets.rb

@@ -2,6 +2,7 @@ $:.unshift(File.dirname(__FILE__))
 
 require 'fileutils'
 require 'xcode_snippets/main'
+require 'xcode_snippets/version'
 
 module XcodeSnippets
   DEFAULT_INSTALLATION_PATH   = File.expand_path("~/Library/Developer/Xcode/UserData/ManagedCodeSnippets")

data/lib/xcode_snippets/main.rb

@@ -1,5 +1,7 @@
 require 'clamp/command'
+require 'highline/import'
 require 'xcode_snippets/snippet_manager'
+require 'xcode_snippets/migrator'
 
 module XcodeSnippets
   class Main < Clamp::Command
@@ -36,6 +38,28 @@ module XcodeSnippets
       end
     end
     
+    subcommand "migrate", "Migrates existing Xcode snippets to a default bundle" do
+      option "--skip-confirm", :flag, "Skips confirmation before doing the migration"
+      
+      def execute
+        snippets = migrator.migrate_snippets_from(XcodeSnippets.xcode_snippets_path, self)
+        migrator.clean_up
+        snippets
+      end
+      
+      def migrator_should_proceed_with_migration?(migrator, snippets_to_migrate)
+        prompt = %Q{*********************************************************************
+Warning: this will move #{snippets_to_migrate.count} code snippets under xcodesnippets control:
+*********************************************************************
+
+* #{snippets_to_migrate.map { |s| s.metadata.title}.join("\n* ")}
+
+Continue? (y/n)
+}
+        agree(prompt) unless skip_confirm?
+      end
+    end
+    
     private
     
     def manager
@@ -45,6 +69,10 @@ module XcodeSnippets
     def manifest
       Manifest.load(XcodeSnippets.installation_path, XcodeSnippets.xcode_snippets_path)
     end
+    
+    def migrator
+      @migrator ||= XcodeSnippets::Migrator.new(manager)
+    end
 
   end
 end

data/lib/xcode_snippets/migrator.rb

@@ -0,0 +1,42 @@
+module XcodeSnippets
+  class Migrator
+    def initialize(snippet_manager)
+      @snippet_manager = snippet_manager
+    end
+    
+    def migrate_snippets_from(path, confirmation_delegate = nil)
+      make_temp_dir(path)
+      snippet_files = Dir[File.join(path, "*.codesnippet")]
+      
+      snippets = snippet_files.map do |snippet_path|
+        XcodeSnippets::Snippet.new(snippet_path)
+      end
+      
+      if confirmation_delegate && confirmation_delegate.respond_to?(:migrator_should_proceed_with_migration?)
+        return unless confirmation_delegate.migrator_should_proceed_with_migration?(self, snippets)
+      end
+      
+      temp_paths = snippets.map do |snippet|
+        File.join(@tmp_dir, "#{snippet.metadata.title}.codesnippet").tap do |temp_path|
+          FileUtils.mv(snippet.path, temp_path)
+        end
+      end
+      
+      @snippet_manager.install_snippets_from_paths(temp_paths)
+    end
+    
+    def clean_up
+      FileUtils.rm_rf(@tmp_dir) if @tmp_dir
+      @tmp_dir = nil
+    end
+    
+    private
+    
+    def make_temp_dir(path)
+      unless @tmp_dir
+        @tmp_dir = File.join(path, "migrator")
+        FileUtils.mkdir_p(@tmp_dir)
+      end
+    end
+  end
+end

data/lib/xcode_snippets/snippet.rb

@@ -30,6 +30,10 @@ module XcodeSnippets
       File.basename(@path)
     end
     
+    def metadata
+      @metadata ||= MetaData.from_file(path)
+    end
+    
     def key
       @bundle ? "#{@bundle.name}/#{name}" : name
     end
@@ -41,5 +45,20 @@ module XcodeSnippets
     def symlinked?
       symlink && File.exist?(symlink)
     end
+    
+    class MetaData
+      def initialize(data)
+        @data = data
+      end
+      
+      def self.from_file(path)
+        raise "Could not parse metadata in file #{path}" unless File.exist?(path)
+        new(Plist.parse_xml(path))
+      end
+      
+      def title
+        @data["IDECodeSnippetTitle"]
+      end
+    end
   end
 end

data/lib/xcode_snippets/version.rb

@@ -0,0 +1,11 @@
+module XcodeSnippets
+  module Version
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 0
+    
+    def self.to_s
+      "#{MAJOR}.#{MINOR}.#{TINY}"
+    end
+  end
+end

data/spec/migrator_spec.rb

@@ -0,0 +1,90 @@
+require File.join(File.dirname(__FILE__), *%w[spec_helper])
+
+describe "Migrator" do
+  
+  before do
+    @manager  = mock("manager")
+    @migrator = XcodeSnippets::Migrator.new(@manager)
+    create_example_xcode_snippets_directory
+  end
+  
+  context "migrating existing snippets" do
+    
+    it "copies each snippet to a temporary directory with a filename that reflects the snippet name" do
+      @manager.stub(:install_snippets_from_paths)
+      @migrator.migrate_snippets_from(XCODE_SNIPPET_PATH)
+      file_at(temporary_snippet_path_for("appledoc class.codesnippet")).should exist
+    end
+    
+    it "removes the original snippet" do
+      @manager.stub(:install_snippets_from_paths)
+      @migrator.migrate_snippets_from(XCODE_SNIPPET_PATH)
+      file_at(xcode_snippet_path).should_not exist
+    end
+    
+    it "installs each snippet from it's temporary location" do
+      @manager.should_receive(:install_snippets_from_paths).with([temporary_snippet_path_for("appledoc class.codesnippet")])
+      @migrator.migrate_snippets_from(XCODE_SNIPPET_PATH)
+    end
+    
+    it "returns the created snippets" do
+      @manager.stub(:install_snippets_from_paths).and_return(["snippet"])
+      @migrator.migrate_snippets_from(XCODE_SNIPPET_PATH).should == ["snippet"]
+    end
+    
+  end
+  
+  context "migrating with a confirmation delegate" do
+    
+    before do
+      @delegate = stub("confirmation-delegate")
+    end
+    
+    it "migrates the snippets if the confirmation delegate returns true" do
+      @delegate.stub(:migrator_should_proceed_with_migration?).and_return(true)
+      @manager.should_receive(:install_snippets_from_paths)
+      @migrator.migrate_snippets_from(XCODE_SNIPPET_PATH, @delegate)
+    end
+    
+    it "migrates the snippets if the confirmation delegate returns false" do
+      @delegate.stub(:migrator_should_proceed_with_migration?).and_return(false)
+      @manager.should_receive(:install_snippets_from_paths).never
+      @migrator.migrate_snippets_from(XCODE_SNIPPET_PATH, @delegate)
+    end
+    
+  end
+  
+  context "cleaning up after migration" do
+    
+    before do
+      @manager.stub(:install_snippets_from_paths)
+      @migrator.migrate_snippets_from(XCODE_SNIPPET_PATH)
+    end
+    
+    it "removes the temporary migrator directory" do
+      @migrator.clean_up
+      directory(File.join(XCODE_SNIPPET_PATH, "migrator")).should_not exist
+    end
+    
+  end
+  
+  private
+  
+  def create_example_xcode_snippets_directory
+    FileUtils.cp(example_snippet_path, xcode_snippet_path)
+  end
+  
+  def temporary_snippet_path_for(name)
+    File.join(XCODE_SNIPPET_PATH, "migrator", name)
+  end
+  
+  def example_snippet_path
+    File.join(FIXTURES_PATH, "example.codesnippet")
+  end
+  
+  def xcode_snippet_path
+    @guid ||= UUIDTools::UUID.timestamp_create
+    File.join(XCODE_SNIPPET_PATH, "#{@guid}.codesnippet")
+  end
+  
+end

data/spec/spec_helper.rb

@@ -25,6 +25,28 @@ class FakeUUIDGenerator
   end
 end
 
+class FileQuery
+  def initialize(path)
+    @path = path
+  end
+  
+  def exist?
+    File.exist?(@path)
+  end
+  
+  def to_s
+    "<file at #{@path}>"
+  end
+end
+
+def file_at(path)
+  FileQuery.new(path)
+end
+
+def directory(path)
+  FileQuery.new(path)
+end
+
 def setup_testing_environment!
   [SNIPPETS_PATH, XCODE_SNIPPET_PATH].each do |dir|
     FileUtils.rm_rf(dir) && FileUtils.mkdir_p(dir)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcodesnippets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
-  requirement: &2152335840 !ruby/object:Gem::Requirement
+  requirement: &2156053140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152335840
+  version_requirements: *2156053140
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &2152335260 !ruby/object:Gem::Requirement
+  requirement: &2156045060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2152335260
+  version_requirements: *2156045060
 - !ruby/object:Gem::Dependency
   name: plist
-  requirement: &2152334680 !ruby/object:Gem::Requirement
+  requirement: &2156044380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152334680
+  version_requirements: *2156044380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152334200 !ruby/object:Gem::Requirement
+  requirement: &2156043980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152334200
+  version_requirements: *2156043980
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2152333660 !ruby/object:Gem::Requirement
+  requirement: &2156043300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152333660
+  version_requirements: *2156043300
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2152333120 !ruby/object:Gem::Requirement
+  requirement: &2156042600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152333120
+  version_requirements: *2156042600
 description: 
 email: luke@lukeredpath.co.uk
 executables:
@@ -90,13 +90,16 @@ files:
 - README.md
 - bin/xcodesnippets
 - spec/bundle_spec.rb
+- spec/migrator_spec.rb
 - spec/snippet_manager_spec.rb
 - spec/spec_helper.rb
 - lib/xcode_snippets/bundle.rb
 - lib/xcode_snippets/main.rb
 - lib/xcode_snippets/manifest.rb
+- lib/xcode_snippets/migrator.rb
 - lib/xcode_snippets/snippet.rb
 - lib/xcode_snippets/snippet_manager.rb
+- lib/xcode_snippets/version.rb
 - lib/xcode_snippets.rb
 has_rdoc: true
 homepage: http://lukeredpath.co.uk