sublime_dsl 0.1.1

data/bin/subdsl

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'sublime_dsl'
+SublimeDSL::CLI.new(File.basename(__FILE__)).run

data/lib/sublime_dsl/cli/export.rb

@@ -0,0 +1,134 @@
+module SublimeDSL
+class CLI
+
+  class Export
+
+    def self.summary
+      "convert a set of DSL source files to a Sublime Text package"
+    end
+
+    attr_reader :main_cmd
+    attr_reader :reader, :exporter
+
+    def initialize(main_cmd)
+      @main_cmd = main_cmd
+    end
+
+    def run
+      parse_options
+      package = reader.package
+      exit 1 unless package
+      exporter.export package
+      exit
+    rescue OptionError => ex
+      Console.error ex.message
+      Console.error %(type "#{main_cmd.name} help export" for more information)
+      exit 2
+    end
+
+    def error(msg)
+      raise OptionError, msg
+    end
+
+    def parse_options
+      package_name = ARGV.shift
+      error 'missing package name' unless package_name
+      @reader = SublimeText::Package::Reader.new(package_name)
+      @exporter = SublimeText::Package::Exporter.new
+      while (option = ARGV.shift)
+        case option
+        when '-s', '--source'
+          path = ARGV.shift
+          path or error "#{option}: missing path"
+          reader.root = path
+        when '-i', '--include'
+          pattern = ARGV.shift
+          pattern or error "#{option}: missing pattern"
+          reader.include = pattern
+        when '-e', '--exclude'
+          pattern = ARGV.shift
+          pattern or error "#{option}: missing pattern"
+          reader.exclude = pattern
+        when '-t', '--target'
+          path = ARGV.shift
+          path or error "#{option}: missing path"
+          exporter.root = path
+        when '-b', '--backup'
+          policy = ARGV.shift
+          case policy
+          when nil
+            policy = :always
+          when /^-/
+            ARGV.unshift policy
+            policy = :always
+          end
+          exporter.backup = policy
+        when '-c', '--cleanup'
+          exporter.cleanup = true
+        when '-q', '--quiet'
+          Console.verbosity = 0
+        when '-V', '--verbose'
+          Console.verbosity = 2
+        else
+          error "invalid argument: #{option.inspect}"
+        end
+      end
+      ARGV.empty? or error "invalid arguments: #{ARGV.join(' ')}"
+    end
+
+    def help
+      <<-HELP.dedent
+        Usage: #{main_cmd.name} export <package> [options]
+
+        <package>
+          The name of a directory containing the DSL files to process.
+
+        Options:
+          -s, --source PATH
+            The path to the directory containing the directory <package>.
+            By default, it is the current directory.
+
+          -i, --include PATTERNS
+            Files to process or copy. By default, all files are processed
+            (except the files defined by the --exclude option).
+            PATTERNS must be a list of specifications separated by semicolons,
+            for instance "*.rb;*.py".
+
+          -e, --exclude PATTERNS
+            Files not to process nor copy. By default "*.keyboard.rb"
+            (keyboard definition files are processed when called from
+            keymap definitions).
+
+          -t, --target PATH
+            The path to the target root directory: the generated files
+            will be placed there in a subdirectory named <package>.
+            By default, it is the Sublime Text Packages directory.
+
+          -b, --backup [POLICY]
+            Define the backup policy if the directory <target_path>/<package>
+            already exists and contains files. POLICY may be:
+              never:  do not create a backup
+              always: always create a backup
+              once:   create a backup if there is not already one
+            Not giving a policy (-b or --backup alone) is the same
+            as 'always'. The default is 'always'.
+            The backup will be a zip file placed in <target_path>,
+            named <package_name>.<time_stamp>.zip
+
+          -c, --cleanup
+            Delete any file in the directory <target_path>/<package>
+            that is not generated by the export process. By default,
+            no file is removed from the target directory.
+
+          -q, --quiet
+            Do not report any information or warning.
+
+          -V, --verbose
+            Report detailed progress information.
+      HELP
+    end
+
+  end
+
+end
+end

data/lib/sublime_dsl/cli/import.rb

@@ -0,0 +1,143 @@
+module SublimeDSL
+class CLI
+
+  class Import
+
+    def self.summary
+      "convert a Sublime Text package to a set of DSL source files"
+    end
+
+    attr_reader :main_cmd
+    attr_reader :importer, :writer
+
+    def initialize(main_cmd)
+      @main_cmd = main_cmd
+    end
+
+    def run
+      parse_options
+      package = importer.package
+      exit 1 unless package
+      writer.write package
+      exit
+    rescue OptionError => ex
+      Console.error ex.message
+      Console.error %(type "#{main_cmd.name} help import" for more information)
+      exit 2
+    end
+
+    def error(msg)
+      raise OptionError, msg
+    end
+
+    def parse_options
+      package_name = ARGV.shift
+      error 'missing package name' unless package_name
+      @importer = SublimeText::Package::Importer.new(package_name)
+      @writer = SublimeText::Package::Writer.new
+      while (option = ARGV.shift)
+        case option
+        when '-s', '--source'
+          path = ARGV.shift
+          path or error "#{option}: missing path"
+          importer.root = path
+        when '-i', '--include'
+          pattern = ARGV.shift
+          pattern or error "#{option}: missing pattern"
+          importer.include = pattern
+        when '-e', '--exclude'
+          pattern = ARGV.shift
+          pattern or error "#{option}: missing pattern"
+          importer.exclude = pattern
+        when '-t', '--target'
+          path = ARGV.shift
+          path or error "#{option}: missing path"
+          writer.root = path
+        when '-k', '--keyboard'
+          keyboard = ARGV.shift
+          keyboard or error "#{option}: missing keyboard"
+          writer.keyboard = keyboard
+        when '-r', '--recognized'
+          writer.copy_other_files = false
+        when '-b', '--backup'
+          policy = ARGV.shift
+          case policy
+          when nil
+            policy = :always
+          when /^-/
+            ARGV.unshift policy
+            policy = :always
+          end
+          writer.backup = policy
+        when '-q', '--quiet'
+          Console.verbosity = 0
+        when '-V', '--verbose'
+          Console.verbosity = 2
+        else
+          error "invalid argument: #{option.inspect}"
+        end
+      end
+      ARGV.empty? or error "invalid arguments: #{ARGV.join(' ')}"
+    end
+
+    def help
+      <<-HELP.dedent
+        Usage: #{main_cmd.name} import <package> [options]
+
+        <package>
+          The name of a Sublime Text package directory containing
+          files to convert to DSL files.
+
+        Options:
+          -s, --source PATH
+            The path to the directory containing the directory <package>.
+            By default, it is the Sublime Text Packages directory.
+
+          -i, --include PATTERNS
+            Files to process or copy. By default, all files are processed
+            (except the files defined by the --exclude option).
+            PATTERNS must be a list of specifications separated by semicolons,
+            for instance "*.tmSnippet;*.tmLanguage".
+
+          -e, --exclude PATTERNS
+            Files not to process nor copy. By default "*.cache;*.pyc".
+
+          -t, --target PATH
+            The path to the target root directory: generated DSL files
+            will be placed there in a subdirectory named <package>.
+            By default, it is the current directory.
+
+          -k, --keyboard NAME
+            Convert keymap definitions for keyboard NAME. By default, no
+            keymap conversion is done. A file NAME.keyboard.rb will be
+            searched for in the subdirectories of <target_path>.
+
+          -r, --recognized
+            Do not copy non-recognized files to the target directory.
+            By default, non-recognized files (e.g., Python scripts)
+            are copied "as is" from the source directory to the target
+            directory.
+
+          -b, --backup [POLICY]
+            Define the backup policy if the directory <target_path>/<package>
+            already exists and contains files. POLICY may be:
+              never:  do not create a backup
+              always: always create a backup
+              once:   create a backup if there is not already one
+            Not giving a policy (-b or --backup alone) is the same
+            as 'always'. The default is 'once'.
+            The backup will be a zip file placed in <target_path>,
+            named <package_name>.<time_stamp>.zip
+
+          -q, --quiet
+            Do not report any information or warning.
+
+          -V, --verbose
+            Report detailed progress information.
+      HELP
+    end
+
+  end
+
+end
+end

data/lib/sublime_dsl/cli.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+
+module SublimeDSL
+
+  ##
+  # A Command Line Interpreter.
+  #
+  # Exit codes:
+  # * 0: command successful
+  # * 1: command did nothing
+  # * 2: something went wrong
+
+  class CLI
+
+    class << self
+
+      # Returns a Hash { command_name => command_class }.
+      def cmd_class_hash
+        @cmd_class_hash ||= load_commands
+      end
+
+      def load_commands
+        h = {}
+        Dir.chdir File.dirname(__FILE__) do
+          Dir["cli/*.rb"].each do |f|
+            require_relative f.sub(/\.rb$/, '')
+            c = File.basename(f, '.rb')
+            h[c] = CLI.const_get(c.pascal_case)
+          end
+        end
+        h
+      end
+
+    end
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def run
+
+      # honor help & version
+      while ARGV.first && ARGV.first.start_with?('-')
+        option = ARGV.shift
+        case option
+        when '-h', '--help'
+          puts help
+          exit 1
+        when '-v', '--version'
+          puts version
+          exit 1
+        else
+          Console.error "invalid option: #{option.inspect}"
+          exit 2
+        end
+      end
+
+      cmd_name = ARGV.shift
+
+      # if no argument, print help & exit
+      unless cmd_name
+        puts help
+        exit 2
+      end
+
+      if cmd_name == 'help'
+        if ARGV.empty?
+          puts help
+        else
+          arg = ARGV.shift
+          if arg == 'commands'
+            puts "Available commands:"
+            CLI.cmd_class_hash.each do |name, klass|
+              puts "  %-10s %s" % [name, klass.summary]
+            end
+          else
+            puts command(arg).help
+          end
+        end
+        exit 1
+      end
+
+      command(cmd_name).run
+    end
+
+    def command(name)
+      cmd_class = CLI.cmd_class_hash[name]
+      unless cmd_class
+        Console.error "invalid command #{name.inspect}\n" \
+          "valid commands: #{CLI.cmd_class_hash.keys.join(', ')}"
+        exit 2
+      end
+
+      cmd_class.new(self)
+    end
+
+    def help
+      <<-HELP.dedent
+      Sublime DSL allows defining Sublime Text packages using a Ruby DSL.
+
+        Usage:
+          #{name} -h/--help
+          #{name} -v/--version
+          #{name} <command> [arguments...] [options...]
+
+        Examples:
+          #{name} import Ruby
+          #{name} export Ruby --cleanup
+
+        Available commands:
+          import          import to DSL
+          export          export from DSL
+          help <command>  show help on <command>
+      HELP
+    end
+
+    def version
+      "SublimeDSL #{SublimeDSL::VERSION}"
+    end
+
+  end
+
+end

data/lib/sublime_dsl/core_ext/enumerable.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Enumerable
+
+  # Returns a hash <tt>{ key => element }</tt>, where +key+ is the
+  # value returned by the block when passed +element+.
+  #
+  # Raises an exception if two elements return the same key.
+  #
+  # Examples:
+  #   %w(a bb ccc).keyed_by(&:length)  #=>  {1 => 'a', 2 => 'bb', 3 => 'ccc'}
+  #   %w(a bb cc).keyed_by(&:length)   #=>  RuntimeError "duplicate key: 2"
+
+  def keyed_by
+    h = {}
+    each do |element|
+      key = yield(element)
+      h.key?(key) and raise "duplicate key: #{key.inspect}"
+      h[key] = element
+    end
+    h
+  end
+
+end

data/lib/sublime_dsl/core_ext/string.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+
+class String
+
+  # Same as #inspect, but between single quotes,
+  # so only \ and single quotes are escaped.
+  def inspect_sq
+    # escape all \ trailing, or followed by a \ or a '
+    # escape single quotes
+    "'" << self.gsub(/\\$|\\(?=[\\'])/, '\\\\\\\\').gsub("'", "\\\\'") << "'"
+  end
+
+  # Same as #inspect, but only escapes control characters and double quotes.
+  def inspect_dq
+    '"' << self.gsub(/[[:cntrl:]\\"]/) { |c| c.inspect[1..-2]  } << '"'
+  end
+
+  # Returns the shortest between #inspect_sq and #inspect_dq.
+  # If same length, acts according to +prefer_dq+
+  # (prefer double quotes?)
+  def to_source(prefer_dq = false)
+    sq = inspect_sq
+    dq = inspect_dq
+    case dq.length <=> sq.length
+    when  1 then sq
+    when -1 then dq
+    when  0 then prefer_dq ? dq : sq
+    end
+  end
+
+  HTML_ESCAPE_MAP = { '&' => '&amp;', '"' => '&quot;', '<' => '&lt;', '>' => '&gt;' }
+
+  # Returns the string with characters escaped to HTML entities:
+  #   < => &lt;
+  #   > => &gt;
+  #   & => &amp;
+  #   " => &quot;  (if escape_quotes == true)
+  def html_escape(escape_quotes = true)
+    if escape_quotes
+      self.gsub(/[&><"]/, HTML_ESCAPE_MAP)
+    else
+      self.gsub(/[&><]/, HTML_ESCAPE_MAP)
+    end
+  end
+
+  # <tt>pascal_case('snake_case') # => SnakeCase</tt>.
+  def pascal_case
+    self.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+
+ # <tt>camel_case('snake_case') # => snakeCase</tt>.
+ def camel_case
+   self.gsub(/_(.)/) { $1.upcase }
+ end
+
+ # <tt>snake_case('PascalCase') # => pascal_case</tt>.
+ # <tt>snake_case('camelCase') # => camel_case</tt>.
+  def snake_case
+    self
+      .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+      .downcase
+  end
+
+  # Shifts all lines left, preserving relative indentation.
+  def dedent
+    self.dup.dedent!
+  end
+
+  # Shifts all lines left, preserving relative indentation.
+  # Returns +self+.
+  def dedent!
+    if (re = dedent_regexp)
+      self.gsub! re, ''
+    end
+    self
+  end
+
+  # Indents all non-empty lines by the number of spaces passed.
+  def indent(spaces)
+    self.gsub(/^(.+)/, (' ' * spaces) + '\1')
+  end
+
+  # Indents all non-empty lines by the number of spaces passed.
+  # Returns +self+.
+  def indent!(spaces)
+    self.gsub!(/^(.+)/, (' ' * spaces) + '\1')
+    self
+  end
+
+  # Wraps at spaces so that no line is longer than the passed +width+,
+  # if possible. Multiple newlines, tabs & spaces are replaced by
+  # a single space.
+  def wrap(width = 80)
+    words = self.split(/\s+/m)
+    wrapped = words.shift
+    len = wrapped.length
+    words.each do |w|
+      len += 1 + w.length
+      if len > width
+        wrapped << "\n" << w
+        len = w.length
+      else
+        wrapped << ' ' << w
+      end
+    end
+    wrapped
+  end
+
+private
+
+  # Returns the regexp to dedent +self+, or +nil+ if no dedent is needed,
+  # or there are leading tabs on non-empty lines.
+  def dedent_regexp
+    min_indent = self.length
+    self.each_line do |line|
+      # if no leading space, no dedent
+      line =~ /^\S/ and return nil
+      # skip empty lines
+      line =~ /^\s*$/ and next
+      # do nothing when tabs are present
+      line =~ /^ *\t/ and return nil
+      indent = line.match(/^ +/).to_s.length
+      min_indent = indent if indent < min_indent
+    end
+    Regexp.new('^' << ' ' * min_indent, Regexp::MULTILINE)
+  end
+
+end

data/lib/sublime_dsl/core_ext.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+require_relative 'core_ext/enumerable'
+require_relative 'core_ext/string'