sublime_dsl 0.1.1

data/lib/sublime_dsl/tools/regexp_wannabe.rb

@@ -0,0 +1,154 @@
+# encoding: utf-8
+
+module SublimeDSL
+module Tools
+
+  ##
+  # A string that would like to be a Regexp.
+  # May contain back-references to another RegexpWannabe,
+  # stored as '§1', '§2', etc.
+
+  class RegexpWannabe
+
+    attr_reader :source
+    attr_reader :regexp   # may be nil if error
+    attr_reader :backref
+    attr_reader :error
+    attr_reader :warnings
+
+    # FIXME: warnings ignored in JSON DSLs
+
+    # FIXME: 3 possible sources: PList, JSON, Ruby Regexp
+    # - when from PList, the current way of doing things seems ok
+    # - when from JSON, \t & \n should be converted to \\t and \\n
+    #   and back to \t & \n on output (they don't use (?x))
+    # - when from Ruby, source should not be altered on input,
+    #   but the output depends on JSON vs PList
+
+    def initialize(source, backref = nil)
+      # encode in utf-8, remove escaped newlines
+      @source = source.encode('utf-8').gsub(/(^|[^\\](\\\\)*+)\\\n/, '\1')
+      @backref = backref
+      @regexp = nil
+      @error = nil
+      @warnings = []
+      try_conversion
+      @error = message_only(@error) if @error
+      @source.gsub!("\t", "  ") if extended?
+    end
+
+    # Returns the ruby syntax.
+    #
+    # If #source contains a '/', tries to return an r-form <tt>%r'...'</tt> or <tt>%r:...:</tt> or
+    # <tt>%r!...!</tt>. If it does not, or if the #source contains all 3 characters <tt>':!</tt>,
+    # return <tt>/.../</tt> if +rform+ is false (the default), or <tt>%r/.../</tt> if +rform+ is
+    # true. (The latter syntax avoids warnings when the regexp is the first argument to a method
+    # and parentheses are not used around arguments.)
+
+    def inspect(rform = false)
+      str = extended? ? source : source.gsub("\t", '\t').gsub("\n", '\n')
+      s = rform ? '%r' : ''
+      return "#{s}/#{str}/" unless str.include?('/')
+      %w(' : !).each { |c| return "%r#{c}#{str}#{c}" unless str.include?(c) }
+      # replace / with \/ unless already escaped
+      escaped = str.gsub( %r"(^|[^\\](\\\\)*+)(?=/)", '\1\\')
+      "#{s}/#{escaped}/"
+    end
+
+    # Returns the string syntax.
+    # * If +json+ == false, the string is suitable for PList.
+    # * If +json+ == true, the string is suitable for JSON output with String#inspect.
+
+    def to_s(for_json = false)
+      if regexp
+        # remove \/ escapes
+        str = regexp.source.gsub( %r"(^|[^\\](\\\\)*+)\\(?=/)", '\1')
+        str = str.gsub("\t", '\t').gsub("\n", '\n') unless extended?
+        if for_json
+          str.gsub!( %r"(^|[^\\](\\\\)*+)\\n", "\\1\n")
+          str.gsub!( %r"(^|[^\\](\\\\)*+)\\t", "\\1\t")
+        end
+      else
+        str = source
+      end
+      str.gsub(/§(?=[1-9])/, '\\')
+    end
+
+    # Returns an array of fixme comments.
+    def fixmes
+      comments = []
+      error and
+        comments << "# FIXME: (error) #{error}"
+      source =~ /#[@${]/ and
+        comments << "# FIXME: (error) '#$&' will be interpreted as interpolation: escape '#' as '\\#'"
+      comments.concat warnings.map { |w| "# FIXME: (warning) #{w}" }
+      comments
+    end
+
+    # Returns the fixme comments for this regexp.
+    # If no fixme, returns an empty string.
+
+    def fixme_comments(indent = '  ')
+      fixmes.map { |c| "#{indent}#{c}\n" }.join
+    end
+
+  private
+
+    def extended?
+      source =~ /\(\?[im]*x(:|[-im]*\))/
+    end
+
+    def try_conversion
+      @warnings = capture_warnings { @regexp = Regexp.new(source) }
+      @backref = nil unless source =~ /§[1-9]/
+    rescue RegexpError => ex
+      msg = ex.message
+      unless backref && msg =~ /^invalid backref|^invalid pattern in look-behind/
+        @error = msg
+        return
+      end
+
+      if backref.error
+        warnings << 'contains references to a Regexp with an error'
+        return
+      end
+
+      # replace \n with §n (but \\n remains \\n, while \\\n => \\§n, etc.)
+      source.gsub!(/((^|[^\\])(\\\\)*)\\(?=[1-9])/, '\1§')
+
+      unless backref.warnings.empty?
+        warnings << 'contains references to a Regexp with warning(s)'
+        return
+      end
+
+      begin
+        @warnings = capture_warnings { @regexp = Regexp.new(source) }
+      rescue RegexpError => ex
+        @error = ex.message
+      end
+    end
+
+    def capture_warnings
+      prev_verbose, $VERBOSE = $VERBOSE, 2
+      prev_stderr, $stderr = $stderr, StringIO.new('', 'wb:utf-8')
+      yield
+      msg = $stderr.string
+      msg.lines.grep(/ warning: /).map do |line|
+        line = line[/.*? warning: (.*)/, 1]
+        message_only(line)
+      end
+    ensure
+      $stderr = prev_stderr
+      $VERBOSE = prev_verbose
+    end
+
+    def message_only(msg)
+      line = msg.lines.first.strip
+      line =~ /(.*?):/ and line = $1.strip
+      line
+    end
+
+  end
+
+end
+end

data/lib/sublime_dsl/tools/stable_inspect.rb

@@ -0,0 +1,20 @@
+
+module SublimeDSL
+module Tools
+
+  ##
+  # A mix-in redefining #inspect so that it does not depend on #to_s.
+
+  module StableInspect
+
+    # Method not calling #to_s, and producing the standard #inspect output.
+    def inspect
+      '#<' << self.class.name << ':0x' << '%x' % (object_id << 1)  <<
+        instance_variables.map { |v| " #{v}=#{instance_variable_get(v).inspect}" }.join(',') <<
+        '>'
+    end
+
+  end
+
+end
+end

data/lib/sublime_dsl/tools/value_equality.rb

@@ -0,0 +1,37 @@
+
+module SublimeDSL
+module Tools
+
+  ##
+  # A mix-in allowing to compare objects based on value rather than identity.
+  #
+  # It redefines #eql?, #hash and #== based on a #value_id method, and
+  # provides a default implementation for #value_id.
+
+  module ValueEquality
+
+    # Returns true if the class of +other+ is the same or a subclass of +self.class+,
+    # and #value_id are the same using "==".
+
+    def eql?(other)
+      other.is_a?(self.class) && other.value_id == self.value_id
+    end
+
+    alias == eql?
+
+    # Returns #hash for #value_id.
+
+    def hash
+      value_id.hash
+    end
+
+    # Default value identity: array of instance variable values.
+
+    def value_id
+      instance_variables.map { |v| instance_variable_get(v) }
+    end
+
+  end
+
+end
+end

data/lib/sublime_dsl/tools/xml.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+module SublimeDSL
+module Tools
+
+  ##
+  # Tools to process XML.
+
+  module XML
+
+    # Regexp matching forbidden control characters.
+    FORBIDDEN_CHARS_RE = /[\x00-\x08\x0b\x0c\x0e-\x1f]/
+
+    # Hash { 'forbidden character' => 'abbreviation' }.
+    FORBIDDEN_CHARS_MAP = {
+      "\x00" => 'NUL',
+      "\x01" => 'SOH',
+      "\x02" => 'STX',
+      "\x03" => 'ETX',
+      "\x04" => 'EOT',
+      "\x05" => 'ENQ',
+      "\x06" => 'ACK',
+      "\x07" => 'BEL',
+      "\x08" => 'BS',
+      # "\x09" => 'HT',
+      # "\x0a" => 'LF',
+      "\x0b" => 'VT',
+      "\x0c" => 'FF',
+      # "\x0d" => 'CR',
+      "\x0e" => 'SO',
+      "\x0f" => 'SI',
+      "\x10" => 'DLE',
+      "\x11" => 'DC1',
+      "\x12" => 'DC2',
+      "\x13" => 'DC3',
+      "\x14" => 'DC4',
+      "\x15" => 'NAK',
+      "\x16" => 'SYN',
+      "\x17" => 'ETB',
+      "\x18" => 'CAN',
+      "\x19" => 'EM',
+      "\x1a" => 'SUB',
+      "\x1b" => 'ESC',
+      "\x1c" => 'FS',
+      "\x1d" => 'GS',
+      "\x1e" => 'RS',
+      "\x1f" => 'US'
+    }
+
+    # Returns a Nokogiri::XML::Document.
+    # Raises an exception if the text contains control characters
+    # forbidden in an XML document.
+    def self.load(string_or_io)
+      text = string_or_io.respond_to?(:read) ? string_or_io.read : string_or_io
+      if text =~ FORBIDDEN_CHARS_RE
+        abbrev = FORBIDDEN_CHARS_MAP[$&]
+        raise Error, "illegal control character in XML: #{$&.inspect} (#{abbrev})"
+      end
+
+      Nokogiri.XML(text, &:noblanks) # I hate this API
+    end
+
+  end
+
+end
+end

data/lib/sublime_dsl/tools.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require_relative 'tools/blank_slate'
+require_relative 'tools/console'
+require_relative 'tools/helpers'
+require_relative 'tools/regexp_wannabe'
+require_relative 'tools/stable_inspect.rb'
+require_relative 'tools/value_equality.rb'
+require_relative 'tools/xml'
+
+module SublimeDSL
+
+  module Tools
+
+    # Zips the content of +dir+ into file +archive+.
+    def self.zip(dir, archive)
+      dir = dir + '/' unless dir.end_with?('/')
+      Zip::File.open(archive, Zip::File::CREATE) do |zipfile|
+        Dir["#{dir}**/*"].each { |f| zipfile.add(f.sub(dir, ''), f) }
+      end
+    end
+
+    # Returns the running OS: :Windows, :OSX or :Linux.
+    def self.os
+      @os ||=
+        case RbConfig::CONFIG['host_os']
+        when /mswin|mingw/
+          :Windows
+        when /darwin/
+          :OSX
+        else
+          :Linux
+        end
+    end
+
+    # Replacement for characters forbidden in Windows file names.
+    FORBIDDEN_CHARS_MAP = {
+      '<' => '˂',  # \u02C2 - modifier letter left arrowhead
+      '>' => '˃',  # \u02C3 - modifier letter right arrowhead
+      ':' => '˸',  # \u02F8 - modifier letter raised colon
+      '"' => 'ʺ',  # \u02BA - double prime
+      '/' => '∕',  # \u2215 - division slash
+      '|' => '¦',  # \u00A6 - broken bar
+      '?' => 'ʔ',  # \u0294 - latin letter glottal stop
+      '*' => '✶',  # \u2736 - six pointed black star
+      '\\' => 'ʅ'  # \u0285 - latin small letter squat reversed esh
+    }
+
+    # Regexp matching characters forbidden in Windows file names.
+    FORBIDDEN_RE = /[#{FORBIDDEN_CHARS_MAP.keys.map { |s| '\\' << s }.join}]/
+
+    # Returns an OS-compatible file name for +text+.
+    #
+    # Maps forbidden characters in Windows file names to something
+    # visually close (even on OSX and Linux):
+    #   <>:"/|?*\  =>  ˂˃˸ʺ∕¦ʔ✶ʅ
+    #--
+    # TODO: allow the user to control this (with a config file).
+
+    def self.filename(text)
+      text.gsub(FORBIDDEN_RE, FORBIDDEN_CHARS_MAP)
+    end
+
+  end
+
+end

data/lib/sublime_dsl.rb

@@ -0,0 +1,23 @@
+require 'rbconfig'
+require 'json'
+require 'nokogiri'
+require 'tmpdir'
+require 'zip'
+
+require_relative 'sublime_dsl/core_ext'
+require_relative 'sublime_dsl/tools'
+require_relative 'sublime_dsl/textmate'
+require_relative 'sublime_dsl/sublime_text'
+require_relative 'sublime_dsl/cli'
+
+module SublimeDSL
+
+  VERSION = '0.1.1'
+
+  class Error < StandardError; end
+  class OptionError < Error; end
+  class DSLError < Error; end
+
+  Console = Tools::Console.new
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sublime_dsl
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Thierry Lambert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: |
+  Sublime DSL allows generating Sublime Text configuration files
+  from a Ruby DSL, giving the power of Ruby to develop and maintain
+  themes, grammars, snippets, key bindings, etc.
+email: thyresias@gmail.com
+executables:
+- subdsl
+extensions: []
+extra_rdoc_files:
+- README.md
+- SYNTAX.md
+files:
+- README.md
+- Rakefile
+- SYNTAX.md
+- bin/subdsl
+- lib/sublime_dsl.rb
+- lib/sublime_dsl/cli.rb
+- lib/sublime_dsl/cli/export.rb
+- lib/sublime_dsl/cli/import.rb
+- lib/sublime_dsl/core_ext.rb
+- lib/sublime_dsl/core_ext/enumerable.rb
+- lib/sublime_dsl/core_ext/string.rb
+- lib/sublime_dsl/sublime_text.rb
+- lib/sublime_dsl/sublime_text/command.rb
+- lib/sublime_dsl/sublime_text/command_set.rb
+- lib/sublime_dsl/sublime_text/keyboard.rb
+- lib/sublime_dsl/sublime_text/keymap.rb
+- lib/sublime_dsl/sublime_text/keymap/dsl_reader.rb
+- lib/sublime_dsl/sublime_text/macro.rb
+- lib/sublime_dsl/sublime_text/menu.rb
+- lib/sublime_dsl/sublime_text/mouse.rb
+- lib/sublime_dsl/sublime_text/mousemap.rb
+- lib/sublime_dsl/sublime_text/package.rb
+- lib/sublime_dsl/sublime_text/package/dsl_reader.rb
+- lib/sublime_dsl/sublime_text/package/exporter.rb
+- lib/sublime_dsl/sublime_text/package/importer.rb
+- lib/sublime_dsl/sublime_text/package/reader.rb
+- lib/sublime_dsl/sublime_text/package/writer.rb
+- lib/sublime_dsl/sublime_text/setting_set.rb
+- lib/sublime_dsl/textmate.rb
+- lib/sublime_dsl/textmate/custom_base_name.rb
+- lib/sublime_dsl/textmate/grammar.rb
+- lib/sublime_dsl/textmate/grammar/dsl_reader.rb
+- lib/sublime_dsl/textmate/grammar/dsl_writer.rb
+- lib/sublime_dsl/textmate/grammar/plist_reader.rb
+- lib/sublime_dsl/textmate/grammar/plist_writer.rb
+- lib/sublime_dsl/textmate/plist.rb
+- lib/sublime_dsl/textmate/preference.rb
+- lib/sublime_dsl/textmate/snippet.rb
+- lib/sublime_dsl/textmate/theme.rb
+- lib/sublime_dsl/textmate/theme/dsl_reader.rb
+- lib/sublime_dsl/textmate/theme/item.rb
+- lib/sublime_dsl/textmate/theme/plist_writer.rb
+- lib/sublime_dsl/tools.rb
+- lib/sublime_dsl/tools/blank_slate.rb
+- lib/sublime_dsl/tools/console.rb
+- lib/sublime_dsl/tools/helpers.rb
+- lib/sublime_dsl/tools/regexp_wannabe.rb
+- lib/sublime_dsl/tools/stable_inspect.rb
+- lib/sublime_dsl/tools/value_equality.rb
+- lib/sublime_dsl/tools/xml.rb
+homepage: https://github.com/thyresias/sublime_dsl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- Sublime DSL
+- "--main"
+- README.md
+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.1
+signing_key: 
+specification_version: 4
+summary: A DSL to specify Sublime Text packages.
+test_files: []