oss_xcodesnippet 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92e0fe6766191be24d9355ed56eba4166138f383
+  data.tar.gz: 29f706b05515390bfdcd58408fc9d30a1161ba9c
+SHA512:
+  metadata.gz: 1ad8907e478693713842cc5a415e8bae7613c4dea6322e1cd691699fb4d5e28308b87e29696a34e81c647ae477f2a4cf55e4ae1e6efb248f64afb314dc912c35
+  data.tar.gz: a2ffb93d4aa44f778e4dbc22c0af2ed08d54eafd962fc61f06ae3f6a60f2f511e17eb448106bb54d9180b8ad48005adc871971239e25fcd2d1d061436efda206

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    oss_xcodesnippet (0.0.2)
+      commander (~> 4.1)
+      plist
+      yaml-front-matter
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.4.3)
+      highline (~> 1.7.2)
+    highline (1.7.8)
+    plist (3.2.0)
+    rake (10.1.0)
+    yaml-front-matter (0.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  oss_xcodesnippet!
+  rake
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Mattt Thompson (http://mattt.me/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# xcodesnippet
+*A command-line interface for installing Xcode Snippets*
+
+## Installation
+
+```
+$ gem install oss_xcodesnippet
+```
+
+## Usage
+
+#### Sourcefile.swift
+
+```swift
+---
+title: "Hello, World!"
+summary: "Prints 'Hello World'"
+completion-scope: Function or Method
+---
+
+println("Hello, World!")
+```
+
+#### Terminal Command
+
+```
+$ oss_xcodesnippet install path/to/source.m
+```
+
+---
+
+## Creator
+
+Andy Cui
+
+Original Author:
+
+Mattt Thompson ([@mattt](https://twitter.com/mattt))
+
+## License
+
+xcodesnippet is released under an MIT license. See LICENSE for more information.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/setup"
+
+gemspec = eval(File.read("oss_xcodesnippet.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["oss_xcodesnippet.gemspec"] do
+  system "gem build oss_xcodesnippet.gemspec"
+end

data/bin/oss_xcodesnippet

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'oss_xcodesnippet'
+
+HighLine.track_eof = false # Fix for built-in Ruby
+Signal.trap("INT") {} # Suppress backtrace when exiting command
+
+program :version, OSSXcodeSnippet::VERSION
+program :description, 'A command-line interface for installing Xcode Snippets'
+
+program :help, 'Author', 'Andy Cui'
+program :help, 'Website', 'https://github.com/andy380743909/xcodesnippet'
+program :help_formatter, :compact
+
+default_command :help
+
+require 'oss_xcodesnippet/commands'

data/lib/oss_xcodesnippet.rb

@@ -0,0 +1,2 @@
+require 'oss_xcodesnippet/snippet'
+require 'oss_xcodesnippet/version'

data/lib/oss_xcodesnippet/commands.rb

@@ -0,0 +1,3 @@
+$:.push File.expand_path('../', __FILE__)
+
+require 'commands/install'

data/lib/oss_xcodesnippet/commands/install.rb

@@ -0,0 +1,73 @@
+require 'yaml'
+require 'yaml/front-matter'
+require 'fileutils'
+require 'securerandom'
+
+USER_XCODE_SNIPPETS_DIRECTORY = File.expand_path("~/Library/Developer/Xcode/UserData/CodeSnippets/")
+
+command :install do |c|
+  c.syntax = 'codesnippet install [SNIPPET]'
+  c.summary = 'Create and Install an Xcode Snippet'
+  c.description = 'Creates and installs an Xcode .codesnippet file from an source file annotated with YAML front matter.'
+
+  c.example 'description', 'codesnippet install /path/to/code.source'
+
+  c.action do |args, options|
+    say_error "Input file required" and abort unless @input_filepath = args.first
+    say_error "Input file does not exist" and abort unless File.exist?(@input_filepath)
+
+    @content = File.read(@input_filepath)
+    say_error "Input file is empty" and abort if @content.empty?
+
+    extract_front_matter!
+    
+    # UUID+basename is better than single UUID
+    # @output_filepath = File.join(USER_XCODE_SNIPPETS_DIRECTORY, @snippet.identifier + ".codesnippet")
+    file_basename = File.basename(@input_filepath, File.extname(@input_filepath))
+    @output_filepath = File.join(USER_XCODE_SNIPPETS_DIRECTORY, file_basename + @snippet.identifier + ".codesnippet")
+    
+    begin
+      FileUtils.mkdir_p(USER_XCODE_SNIPPETS_DIRECTORY)
+      # test if file name conflicts
+      
+      # if conflicts backup oldfile
+      
+      # else write to file
+      File.open(@output_filepath, 'w') do |f|
+        f.write @snippet.to_plist
+      end
+    rescue => error
+      say_error "Error: #{error.message}" and abort
+    end
+
+    say_ok "Installed Code Snippet"
+    puts @output_filepath
+  end
+end
+
+private
+
+def extract_front_matter!
+  @snippet = OSSXcodeSnippet::Snippet.new
+
+  front_matter, contents = YAML::FrontMatter.extract(@content)
+
+  if front_matter.empty?
+    say_error "No YAML Front Matter Detected" and abort
+  else
+    @snippet.contents = contents.strip
+    @snippet.completion_prefix = File.basename(@input_filepath, File.extname(@input_filepath))
+    @snippet.language = case File.extname(@input_filepath)
+                        when ".swift" then "Xcode.SourceCodeLanguage.Swift"
+                        when ".m" then "Xcode.SourceCodeLanguage.Objective-C"
+                        when ".mm" then "Xcode.SourceCodeLanguage.Objective-C++"
+                        else ""
+                        end
+    @snippet.title = front_matter["title"] || ""
+    @snippet.summary = front_matter["summary"] || ""
+    @snippet.completion_scopes = [front_matter["completion-scope"]] || front_matter["completion-scopes"] || "All"
+    @snippet.identifier = SecureRandom.uuid().upcase
+    @snippet.is_user_snippet = true
+    @snippet.version = 0
+  end
+end

data/lib/oss_xcodesnippet/snippet.rb

@@ -0,0 +1,29 @@
+require 'plist'
+
+module OSSXcodeSnippet
+  class Snippet
+    attr_accessor :completion_prefix
+    attr_accessor :completion_scopes
+    attr_accessor :contents
+    attr_accessor :identifier
+    attr_accessor :is_user_snippet
+    attr_accessor :language
+    attr_accessor :summary
+    attr_accessor :title
+    attr_accessor :version
+
+    def to_plist
+      {
+        "IDECodeSnippetCompletionPrefix" => @completion_prefix,
+        "IDECodeSnippetCompletionScopes" => @completion_scopes,
+        "IDECodeSnippetContents" => @contents,
+        "IDECodeSnippetIdentifier" => @identifier,
+        "IDECodeSnippetLanguage" => @language,
+        "IDECodeSnippetSummary" => @summary,
+        "IDECodeSnippetTitle" => @title,
+        "IDECodeSnippetUserSnippet" => @is_user_snippet,
+        "IDECodeSnippetVersion" => @version
+      }.to_plist
+    end
+  end
+end

data/lib/oss_xcodesnippet/version.rb

@@ -0,0 +1,3 @@
+module OSSXcodeSnippet
+  VERSION = "0.0.3"
+end

data/oss_xcodesnippet.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "oss_xcodesnippet/version"
+
+Gem::Specification.new do |s|
+  s.name        = "oss_xcodesnippet"
+  s.authors     = ["Andy Cui"]
+  s.email       = "andy380743909@gmail.com"
+  s.license     = "MIT"
+  s.homepage    = "https://github.com/andy380743909/xcodesnippet"
+  s.version     = OSSXcodeSnippet::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "dianping overseas xcodesnippet"
+  s.description = "A command-line interface for installing Xcode Snippets."
+
+  s.add_dependency "yaml-front-matter"
+  s.add_dependency "plist"
+  s.add_dependency "commander", "~> 4.1"
+
+  s.add_development_dependency "rake"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: oss_xcodesnippet
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Andy Cui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yaml-front-matter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: A command-line interface for installing Xcode Snippets.
+email: andy380743909@gmail.com
+executables:
+- oss_xcodesnippet
+extensions: []
+extra_rdoc_files: []
+files:
+- "./Gemfile"
+- "./Gemfile.lock"
+- "./LICENSE"
+- "./README.md"
+- "./Rakefile"
+- "./lib/oss_xcodesnippet.rb"
+- "./lib/oss_xcodesnippet/commands.rb"
+- "./lib/oss_xcodesnippet/commands/install.rb"
+- "./lib/oss_xcodesnippet/snippet.rb"
+- "./lib/oss_xcodesnippet/version.rb"
+- "./oss_xcodesnippet.gemspec"
+- bin/oss_xcodesnippet
+homepage: https://github.com/andy380743909/xcodesnippet
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: dianping overseas xcodesnippet
+test_files: []