sublime_syntax_convertor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf748b7f3eb24b0659004f0e345516d014b2e0e8
+  data.tar.gz: 4799f199f90c2c46c458cc904a03e42913aeef05
+SHA512:
+  metadata.gz: f55c140f42b040c21e3467958eeaeaeb8204a3aa709265a97185412b82c3dea213c339fc63aafa9e1e79b902642f463218af6aed6846cfb2635103b20f4d0d8d
+  data.tar.gz: 95c6b82b8b0327337c54bb47a952b5cc399188e22a69e63c6ee332c893e3d23be370695e4805e1e67ef70a25e2370d3e37769cc05da2006373bc79aac3a844d0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# gem's dependencies are in sublime_syntax_convertor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Allen A. Bargi
+
+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,37 @@
+# Sublime Syntax Convertor
+Converts `tmLanguage` to `sublime-syntax`
+
+## Install
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sublime_syntax_convertor'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install sublime_syntax_convertor
+
+## USAGE
+
+### Command line 
+```bash
+sublime_syntax_convertor files
+sublime_syntax_convertor folder
+```
+
+### In your code
+```ruby
+require 'sublime_syntax_convertor'
+file = File.read(tmLanguage_file)
+convertor = SublimeSyntaxConvertor::Convertor.new(file)
+sublime_syntax = convertor.to_yaml
+```
+
+
+---
+© Copyright 2015 Allen Bargi. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/sublime_syntax_convertor

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+require 'yaml'
+require_relative '../lib/sublime_syntax_convertor'
+
+def difference(a, b)
+  diff = (a.size >= b.size) ? a.to_a - b.to_a : b.to_a - a.to_a
+  Hash[*diff.flatten]
+end
+
+if ARGV.empty?
+  puts "USAGE: sublime_syntax_convertor files"
+  puts "       sublime_syntax_convertor folder"
+else
+  filenames = []
+  ARGV.each do |path|
+    path = File.expand_path(path)
+    if File.directory?(path)
+      filenames.push(*Dir[File.join(path, '*.tmLanguage')])
+    else
+      filenames.push(path)
+    end
+  end
+
+  filenames.each do |fname|
+    outfile = File.join(File.dirname(fname), File.basename(fname, '.tmLanguage') + ".sublime-syntax")
+    if File.exist?(outfile)
+      puts "file already exists, deleting: #{outfile}"
+      File.delete(outfile)
+    end
+
+    convertor = SublimeSyntaxConvertor::Convertor.new(File.read(fname))
+    text = convertor.to_yaml
+
+    # verify that to_yaml produces valid yaml for this syntax
+    if convertor.syntax != YAML.load(text.gsub('%YAML 1.2', ''))
+      yaml = YAML.load(text.gsub('%YAML 1.2', ''))
+      syntax = convertor.syntax
+      diff = difference(yaml, syntax)
+      fail "Sorry, generated invalid YAML! #{fname}"
+    end
+
+    File.open(outfile, "w") { |f| f.write(text) }
+    puts "converted #{outfile}"
+  end
+end

data/lib/sublime_syntax_convertor.rb

@@ -0,0 +1,6 @@
+require 'plist'
+require_relative './sublime_syntax_convertor/version'
+require_relative './sublime_syntax_convertor/formatter'
+require_relative './sublime_syntax_convertor/patterns'
+require_relative './sublime_syntax_convertor/syntax_yaml'
+require_relative './sublime_syntax_convertor/convertor'

data/lib/sublime_syntax_convertor/convertor.rb

@@ -0,0 +1,111 @@
+module SublimeSyntaxConvertor
+  class Convertor
+    include Formatter
+    attr_reader :syntax
+
+    def initialize(lang)
+      @lang       = Plist.parse_xml(lang)
+      @repository = @lang.fetch('repository', {})
+      @patterns   = @lang.fetch('patterns', [])
+      @syntax     = {}
+      normalize_repository
+      convert
+    end
+
+    def to_yaml
+      SyntaxYaml.new(@syntax).yaml
+    end
+
+    private
+
+    def normalize_repository
+      @repository.each do |key, value|
+        if value.key?('begin') || value.key?('match')
+          @repository[key] = [value]
+        else
+          @repository[key] = value['patterns']
+        end
+      end
+    end
+
+    def create_contexts
+      contexts   = {}
+      contexts['main'] = make_context(@lang['patterns'])
+      @repository.each do |key, value|
+        fail 'Double definition of main context' if key == 'main'
+        contexts[key] = make_context(value)
+      end
+      contexts
+    end
+
+    def convert
+      syntax = {}
+      syntax['comment']          = format_comment(@lang['comment']) if @lang.key?('comment')
+      syntax['first_line_match'] = format_regex(@lang['firstLineMatch']) if @lang.key?('firstLineMatch')
+      syntax['name']             = @lang['name']           if @lang.key?('name')
+      syntax['scope']            = @lang['scopeName']      if @lang.key?('scopeName')
+      syntax['file_extensions']  = @lang['fileTypes']      if @lang.key?('fileTypes')
+      syntax['hidden']           = @lang['hideFromUser']   if @lang.key?('hideFromUser')
+      syntax['hidden']           = @lang['hidden']         if @lang.key?('hidden')
+      syntax['contexts']         = create_contexts
+      @syntax = syntax
+    end
+
+    def handle_begin_pattern(pattern)
+      entry = BeginEndPattern.new('begin', pattern).to_h
+      entry['comment'] = format_comment(pattern['comment']) if pattern.key?('comment') && !format_comment(pattern['comment']).empty?
+      entry['push'] = handle_child_pattern(pattern)
+      entry
+    end
+
+    def handle_child_pattern(pattern)
+      end_entry = BeginEndPattern.new('end', pattern).to_h
+      child_patterns =  pattern.key?('patterns') ? pattern["patterns"] : []
+      child = make_context(child_patterns)
+      apply_last = pattern.key?('applyEndPatternLast') && pattern['applyEndPatternLast'] == 1
+      apply_last ? child.push(end_entry) : child.unshift(end_entry)
+      child.unshift('meta_content_scope' => pattern['contentName']) if pattern.key?('contentName')
+      child.unshift('meta_scope' => pattern['name']) if pattern.key?('name')
+      if end_entry['match'].include? "\\G"
+        puts """WARNING:
+        pop pattern contains \\G, this will not work as expected
+        if it's intended to refer to the begin regex: #{end_entry['match']}"""
+      end
+      child
+    end
+
+    def handle_include_pattern(pattern)
+      key = pattern['include']
+      if key[0] == '#'
+        key = key[1..-1]
+        fail Exception("no entry in repository for #{key}") unless @repository.key?(key)
+        return { 'include' => key }
+      elsif key == '$self'
+        return { 'include' => 'main' }
+      elsif key == '$base'
+        return { 'include' => '$top_level_main' }
+      elsif key[0] == '$'
+        fail Exception "unknown include: #{key}"
+      else
+        return { 'include' => format_external_syntax(key) }
+      end
+    end
+
+    def make_context(patterns)
+      ctx = []
+      patterns.each do |pattern|
+        if pattern.key?('begin')
+          entry = handle_begin_pattern(pattern)
+        elsif pattern.key?('match')
+          entry = MatchPattern.new(pattern).to_h
+        elsif pattern.key?('include')
+          entry = handle_include_pattern(pattern)
+        else
+          fail Exception("unknown pattern type: #{pattern.keys}")
+        end
+        ctx.push(entry) if entry
+      end
+      ctx
+    end
+  end
+end

data/lib/sublime_syntax_convertor/formatter.rb

@@ -0,0 +1,93 @@
+module SublimeSyntaxConvertor
+  module Formatter
+    def format_comment(str)
+      str = str.strip.gsub("\t", "    ")
+      str = str.rstrip + "\n" if str.include?("\n")
+      str
+    end
+
+    def format_regex(str)
+      if str.include? "\n"
+        lines = str.split("\n")
+        # trim common indentation off of each line
+        if lines.size > 1
+          common_indent = leading_whitespace(lines[1])
+          lines[2..-1].each do |line|
+            cur_indent = leading_whitespace(line)
+            if cur_indent.start_with?(common_indent)
+              next
+            elsif common_indent.start_with?(cur_indent)
+              common_indent = cur_indent
+            else
+              common_indent = ''
+            end
+          end
+          # Generally the first line doesn't have any indentation, add some
+          lines[0] = common_indent + lines[0].lstrip unless lines[0].start_with?(common_indent)
+        else
+          common_indent = leading_whitespace(lines[0])
+        end
+        str = lines.map { |line| line[common_indent.size..-1] }.join("\n").rstrip
+      end
+      str
+    end
+
+    def format_captures(cap)
+      captures = {}
+      cap.each do |key, value|
+        unless value.key?('name')
+          puts "patterns and includes are not supported within captures: #{cap}"
+          next
+        end
+
+        begin
+          captures[key.to_i] = value['name']
+        rescue
+          puts 'named capture used, this is unsupported'
+          captures[key] = value['name']
+        end
+      end
+      captures
+    end
+
+    def format_external_syntax(key)
+      fail 'invalid external syntax name' if '#$'.include?(key[0])
+      if key.include?('#')
+        syntax, rule = key.split('#')
+        return "scope:#{syntax}##{rule}"
+      else
+        return "scope:#{key}"
+      end
+    end
+
+    def needs_quoting?(str)
+      (
+        str == "" ||
+        str.start_with?('<<') ||
+        "\"'%-:?@`&*!,#|>0123456789=".include?(str[0]) ||
+        %w(true false null).include?(str) ||
+        str.include?("# ") ||
+        str.include?(': ') ||
+        str.include?('[') ||
+        str.include?(']') ||
+        str.include?('{') ||
+        str.include?('}') ||
+        str.include?("\n") ||
+        ":#".include?(str[-1]) ||
+        str.strip != str
+      )
+    end
+
+    def quote(str)
+      if str.include?("\\") || str.include?('"')
+        return "'" + str.gsub("'", "''") + "'"
+      else
+        return '"' + str.gsub("\\", "\\\\").gsub('"', '\\"') + '"'
+      end
+    end
+
+    def leading_whitespace(str)
+      str[0...(str.size - str.lstrip.size)]
+    end
+  end
+end

data/lib/sublime_syntax_convertor/patterns.rb

@@ -0,0 +1,58 @@
+require_relative './formatter'
+
+module SublimeSyntaxConvertor
+  class MatchPattern
+    include Formatter
+    attr_reader :match, :scope, :captures, :comment
+
+    def initialize(pat)
+      @match = format_regex(pat['match'])
+      @scope = pat['name'] if pat.key?('name')
+      @captures = format_captures(pat['captures']) if pat.key?('captures')
+      @comment = format_comment(pat['comment']) if pat.key?('comment') && !format_comment(pat['comment']).empty?
+    end
+
+    def to_h
+      hash = {}
+      hash['match'] = @match if @match
+      hash['scope'] = @scope if @scope
+      hash['captures'] = @captures if @captures
+      hash['comment'] = @comment if @comment
+      hash
+    end
+  end
+
+  class BeginEndPattern
+    include Formatter
+    attr_reader :match, :pop, :captures
+
+    def initialize(type, pattern)
+      @pattern = pattern
+      @type = type
+      @match = format_regex(pattern[type])
+      @pop = true if type == 'end'
+      handle_captures
+    end
+
+    def to_h
+      hash = {}
+      hash['match'] = @match if @match
+      hash['pop'] = @pop if @pop
+      hash['captures'] = @captures if @captures
+      hash
+    end
+
+    private
+
+    def handle_captures
+      pattern_captures = @pattern["#{@type}Captures"] || @pattern["captures"]
+      return unless pattern_captures
+      captures = format_captures(pattern_captures)
+      if captures.key?('0')
+        entry['scope'] = captures['0']
+        captures.delete('0')
+      end
+      @captures = captures if captures.size > 0
+    end
+  end
+end

data/lib/sublime_syntax_convertor/syntax_yaml.rb

@@ -0,0 +1,108 @@
+require_relative './formatter'
+
+module SublimeSyntaxConvertor
+  class SyntaxYaml
+    include Formatter
+    attr_reader :yaml
+    TAB_SIZE = 2
+
+    def initialize(val)
+      @yaml = to_yaml(val, false, 0)
+    end
+
+    private
+
+    def to_yaml(val, start_block_on_newline, indent)
+      out = ''
+
+      if indent == 0
+        out += "%YAML 1.2\n---\n"
+        out += "# http://www.sublimetext.com/docs/3/syntax.html\n"
+      end
+
+      if val.is_a?(Array)
+        out += array_to_yaml(val, start_block_on_newline, indent)
+      elsif val.is_a?(Hash)
+        out += hash_to_yaml(val, start_block_on_newline, indent)
+      elsif val.is_a?(String)
+        out += string_to_yaml(val, start_block_on_newline, indent)
+      elsif val.is_a?(TrueClass) || val.is_a?(FalseClass)
+        out += boolean_to_yaml(val)
+      else
+        out += "#{val}\n"
+      end
+      # to_yaml will leave some trailing whitespace, remove it
+      out.split("\n").map(&:rstrip).join("\n") + "\n"
+    end
+
+    def array_to_yaml(val, start_block_on_newline, indent)
+      out = ''
+      if val.size == 0
+        out += "[]\n"
+      else
+        out += "\n" if start_block_on_newline
+        val.each { |item| out += ' ' * indent + '- ' + to_yaml(item, false, indent + 2) }
+      end
+      out
+    end
+
+    def hash_to_yaml(val, start_block_on_newline, indent)
+      out = ''
+      out += "\n" if start_block_on_newline
+      first = true
+      order_keys(val.keys).each do |key|
+        value = val[key]
+        if !first || start_block_on_newline
+          out += ' ' * indent
+        else
+          first = false
+        end
+
+        if key.is_a?(Numeric)
+          out += key.to_s
+        elsif needs_quoting?(key)
+          out += quote(key)
+        else
+          out += key
+        end
+
+        out += ": "
+        out += to_yaml(value, true, indent + TAB_SIZE)
+      end
+      out
+    end
+
+    def string_to_yaml(val, start_block_on_newline, indent)
+      out = ''
+      if needs_quoting?(val)
+        if val.include?("\n")
+          fail unless start_block_on_newline
+          out += (val[-1] == "\n") ? "|\n" : "|-\n"
+          val.split("\n").each { |line| out += "#{' ' * indent}#{line}\n" }
+        else
+          out += "#{quote(val)}\n"
+        end
+        return out
+      else
+        return "#{val}\n"
+      end
+    end
+
+    def boolean_to_yaml(val)
+      val ? "true\n" : "false\n"
+    end
+
+    def order_keys(list)
+      key_order = %w(name main match comment file_extensions first_line_match hidden match scope main).reverse
+      list = list.sort
+      key_order.each do |key|
+        if list.include?(key)
+          list.delete_at(list.index(key))
+          list.insert(0, key)
+        end
+      end
+      list
+    end
+
+  end
+end

data/lib/sublime_syntax_convertor/version.rb

@@ -0,0 +1,3 @@
+module SublimeSyntaxConvertor
+  VERSION = '0.1.0'
+end

data/sublime_syntax_convertor.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sublime_syntax_convertor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sublime_syntax_convertor'
+  spec.version       = SublimeSyntaxConvertor::VERSION
+  spec.authors       = ['Allen Bargi']
+  spec.email         = ['allen.bargi@gmail.com']
+  spec.description   = 'Converts tmLanguage to sublime-syntax'
+  spec.summary       = 'Converts tmLanguage to sublime-syntax'
+  spec.homepage      = 'https://github.com/aziz/SublimeSyntaxConvertor'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'plist'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubycritic'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: sublime_syntax_convertor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Allen Bargi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-02 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: awesome_print
+  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: guard-rspec
+  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: simplecov
+  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: rubycritic
+  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: Converts tmLanguage to sublime-syntax
+email:
+- allen.bargi@gmail.com
+executables:
+- sublime_syntax_convertor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/sublime_syntax_convertor
+- lib/sublime_syntax_convertor.rb
+- lib/sublime_syntax_convertor/convertor.rb
+- lib/sublime_syntax_convertor/formatter.rb
+- lib/sublime_syntax_convertor/patterns.rb
+- lib/sublime_syntax_convertor/syntax_yaml.rb
+- lib/sublime_syntax_convertor/version.rb
+- sublime_syntax_convertor.gemspec
+homepage: https://github.com/aziz/SublimeSyntaxConvertor
+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.6
+signing_key: 
+specification_version: 4
+summary: Converts tmLanguage to sublime-syntax
+test_files: []