coloration 0.3.3 → 0.4.0

data/lib/coloration/converters/textmate2jedit.rb

@@ -1,12 +1,34 @@
 module Coloration
+
   module Converters
+
     class Textmate2JEditConverter < AbstractConverter
-      @in_theme_type = "Textmate"
-      @in_theme_ext = "tmTheme"
-      @out_theme_type = "JEdit"
-      @out_theme_ext = "jedit-scheme"
+
       include Readers::TextMateThemeReader
       include Writers::JEditThemeWriter
-    end
-  end
-end
+
+      # @return [String]
+      def in_theme_type
+        'Textmate'
+      end
+
+      # @return [String]
+      def in_theme_ext
+        'tmTheme'
+      end
+
+      # @return [String]
+      def out_theme_type
+        'JEdit'
+      end
+
+      # @return [String]
+      def out_theme_ext
+        'jedit-scheme'
+      end
+
+    end # Textmate2JEditConverter
+
+  end # Converters
+
+end # Coloration

data/lib/coloration/converters/textmate2katepart.rb

@@ -1,12 +1,34 @@
 module Coloration
+
   module Converters
+
     class Textmate2KatePartConverter < AbstractConverter
-      @in_theme_type = "Textmate"
-      @in_theme_ext = "tmTheme"
-      @out_theme_type = "KatePart"
-      @out_theme_ext = "txt"
+
       include Readers::TextMateThemeReader
       include Writers::KatePartThemeWriter
-    end
-  end
-end
+
+      # @return [String]
+      def in_theme_type
+        'Textmate'
+      end
+
+      # @return [String]
+      def in_theme_ext
+        'tmTheme'
+      end
+
+      # @return [String]
+      def out_theme_type
+        'KatePart'
+      end
+
+      # @return [String]
+      def out_theme_ext
+        'txt'
+      end
+
+    end # Textmate2KatePartConverter
+
+  end # Converters
+
+end # Coloration

data/lib/coloration/converters/textmate2vim.rb

@@ -1,12 +1,34 @@
 module Coloration
+
   module Converters
+
     class Textmate2VimConverter < AbstractConverter
-      @in_theme_type = "Textmate"
-      @in_theme_ext = "tmTheme"
-      @out_theme_type = "Vim"
-      @out_theme_ext = "vim"
+
       include Readers::TextMateThemeReader
       include Writers::VimThemeWriter
-    end
-  end
-end
+
+      # @return [String]
+      def in_theme_type
+        'Textmate'
+      end
+
+      # @return [String]
+      def in_theme_ext
+        'tmTheme'
+      end
+
+      # @return [String]
+      def out_theme_type
+        'Vim'
+      end
+
+      # @return [String]
+      def out_theme_ext
+        'vim'
+      end
+
+    end # Textmate2VimConverter
+
+  end # Converters
+
+end # Colorationnd

data/lib/coloration/readers/textmate_theme_reader.rb

@@ -1,9 +1,11 @@
 require 'plist'
-require 'textpow'
 
 module Coloration
+
   module Readers
+
     module TextMateThemeReader
+
       class InvalidThemeError < RuntimeError; end
 
       def parse_input
@@ -49,31 +51,9 @@ module Coloration
         end
         self.items = ItemsLookup.new(items)
       end
-    end
 
-    class ItemsLookup
-      def initialize(items)
-        @items = items
-        @score_manager = Textpow::ScoreManager.new
-      end
+    end # TextMateThemeReader
 
-      def [](keys)
-        keys.split(",").each do |key|
-          best_selector = nil
-          best_score = 0
-          @items.keys.each do |selector|
-            score = @score_manager.score(selector, key)
-            if score > best_score
-              best_score, best_selector = score, selector
-            end
-          end
-          if best_selector
-            return @items[best_selector]
-          end
-        end
-        nil
-      end
-    end
-  end
+  end # Readers
 
-end
+end # Coloration

data/lib/coloration/style.rb

@@ -1,6 +1,7 @@
 module Coloration
 
   class Style
+
     attr_accessor :foreground, :background, :bold, :italic, :underline, :strike, :inverse, :comment
 
     def initialize(obj=nil, bg=nil)
@@ -32,6 +33,7 @@ module Coloration
     def blank?
       foreground.nil? && background.nil?
     end
-  end
 
-end
+  end # Style
+
+end # Coloration

data/lib/coloration/support/items_lookup.rb

@@ -0,0 +1,42 @@
+require 'textpow'
+
+module Coloration
+
+  module Readers
+
+    class ItemsLookup
+
+      def initialize(items)
+        @items = items
+      end
+
+      def [](keys)
+        keys.split(",").each do |key|
+          best_selector = nil
+          best_score = 0
+
+          @items.keys.each do |selector|
+            score = score_manager.score(selector, key)
+            if score > best_score
+              best_score, best_selector = score, selector
+            end
+          end
+
+          return @items[best_selector] if best_selector
+        end
+
+        nil
+      end
+
+      private
+
+      # @return [Textpow::ScoreManager]
+      def score_manager
+        @score_manager ||= Textpow::ScoreManager.new
+      end
+
+    end # ItemsLookup
+
+  end # Readers
+
+end # Coloration

data/lib/coloration/version.rb

@@ -1,3 +1,3 @@
 module Coloration
-  VERSION = "0.3.3".freeze
+  VERSION = "0.4.0".freeze
 end

data/lib/coloration/writers/abstract_writer.rb

@@ -0,0 +1,27 @@
+module Coloration
+
+  module Writers
+
+    module AbstractWriter
+
+      # @param line [String]
+      # @return [Array<String>]
+      def add_line(line = '')
+        (@lines ||= []) << line
+      end
+
+      # @param name [String]
+      # @param style [String]
+      # @raise RuntimeError
+      # @return [String]
+      def format_item(name, style)
+        raise RuntimeError, "Style for #{name} is missing!" unless style
+
+        "#{name}=#{format_style(style)}"
+      end
+
+    end # AbstractWriter
+
+  end # Writers
+
+end # Coloration

data/lib/coloration/writers/jedit_theme_writer.rb

@@ -1,9 +1,13 @@
 module Coloration
+
   module Writers
+
     module JEditThemeWriter
 
+      include Coloration::Writers::AbstractWriter
+
       def build_result
-        add_line(format_comment(comment_text))
+        add_line(format_comment(comment_message))
         add_line
 
         ui_mapping = {
@@ -32,10 +36,10 @@ module Coloration
           "view.style.operator"     => @items["keyword.operator"], # = < + -
           "view.style.function"     => @items["entity.name.function"], # def foo
           "view.style.literal3"     => @items["string.regexp"], # /jola/
-  #         "view.style.invalid"      => @items["invalid"], # errors etc
-          #"view.style.literal4" => :constant # MyClass, USER_SPACE
+          # "view.style.invalid" => @items["invalid"], # errors etc
+          # "view.style.literal4" => :constant # MyClass, USER_SPACE
           "view.style.markup"       => @items["meta.tag"] || @items["entity.name.tag"] # <div>
-          #TODO: gutter etc
+          # TODO: gutter etc
         }
 
         default_style = Style.new
@@ -49,10 +53,6 @@ module Coloration
 
       protected
 
-      def add_line(line="")
-        (@lines ||= []) << line
-      end
-
       def escape(value)
         value.gsub(':', '\:').gsub('#', '\#').strip
       end
@@ -67,11 +67,6 @@ module Coloration
         "#{name}=#{escape(value)}"
       end
 
-      def format_item(name, style)
-        raise RuntimeError.new("Style for #{name} is missing!") if style.nil?
-        "#{name}=#{format_style(style)}"
-      end
-
       def format_style(style)
         s = ""
         s << " color:#{style.foreground.html}" if style.foreground
@@ -89,6 +84,8 @@ module Coloration
         "\# #{text}"
       end
 
-    end
-  end
-end
+    end # JEditThemeWriter
+
+  end # Writers
+
+end # Coloration

data/lib/coloration/writers/katepart_theme_writer.rb

@@ -1,9 +1,13 @@
 module Coloration
+
   module Writers
+
     module KatePartThemeWriter
 
+      include Coloration::Writers::AbstractWriter
+
       def build_result
-        add_comment comment_text
+        add_comment comment_message
         add_comment "-" * 20 + " Put following in katesyntaxhighlightingrc " + "-" * 20
         add_line
 
@@ -90,21 +94,21 @@ module Coloration
           "Color Background"            => @ui["background"],
           "Color Highlighted Bracket"   => @ui["background"],
           "Color Highlighted Line"      => @ui["lineHighlight"],
-  #         "Color Icon Bar"              => @ui[:background],
-  #         "Color Line Number" => :,
-  #         "Color MarkType1" => :,
-  #         "Color MarkType2" => :,
-  #         "Color MarkType3" => :,
-  #         "Color MarkType4" => :,
-  #         "Color MarkType5" => :,
-  #         "Color MarkType6" => :,
-  #         "Color MarkType7" => :,
+          # "Color Icon Bar" => @ui[:background],
+          # "Color Line Number" => :,
+          # "Color MarkType1" => :,
+          # "Color MarkType2" => :,
+          # "Color MarkType3" => :,
+          # "Color MarkType4" => :,
+          # "Color MarkType5" => :,
+          # "Color MarkType6" => :,
+          # "Color MarkType7" => :,
           "Color Selection"             => @ui["selection"],
           "Color Tab Marker"            => @ui["invisibles"],
-  #         "Color Template Background" => :,
-  #         "Color Template Editable Placeholder" => :,
-  #         "Color Template Focused Editable Placeholder" => :,
-  #         "Color Template Not Editable Placeholder" => :,
+          # "Color Template Background" => :,
+          # "Color Template Editable Placeholder" => :,
+          # "Color Template Focused Editable Placeholder" => :,
+          # "Color Template Not Editable Placeholder" => :,
           "Color Word Wrap Marker"      => @ui["invisibles"]
         }
         ui_mapping.keys.each do |key|
@@ -120,10 +124,6 @@ module Coloration
         add_line(format_comment(c))
       end
 
-      def add_line(line="")
-        (@lines ||= []) << line
-      end
-
       def format_style(style)
         style ||= @default_style
         # normal,selected,bold,italic,strike,underline,bg,bg_selected,---
@@ -140,11 +140,6 @@ module Coloration
         s.join(",")
       end
 
-      def format_item(name, style)
-        raise RuntimeError.new("Style for #{name} is missing!") if style.nil?
-        "#{name}=#{format_style(style)}"
-      end
-
       def format_comment(text)
         "# #{text}"
       end
@@ -153,6 +148,8 @@ module Coloration
         "#{(col.r*255).to_i},#{(col.g*255).to_i},#{(col.b*255).to_i}"
       end
 
-    end
-  end
-end
+    end # KatePartThemeWriter
+
+  end # Writers
+
+end # Coloration

data/lib/coloration/writers/vim_theme_writer.rb

@@ -1,6 +1,11 @@
 module Coloration
+
   module Writers
+
     module VimThemeWriter
+
+      include Coloration::Writers::AbstractWriter
+
       XTERM_COLORS = [ 0x00, 0x5F, 0x87, 0xAF, 0xD7, 0xFF ]
       XTERM_GREYS  = [ 0x08, 0x12, 0x1C, 0x26, 0x30, 0x3A,
                        0x44, 0x4E, 0x58, 0x62, 0x6C, 0x76,
@@ -9,7 +14,7 @@ module Coloration
 
       def build_result
         add_line "\" Vim color file"
-        add_line "\" #{comment_text}"
+        add_line "\" #{comment_message}"
         add_line
 
         add_line "set background=dark"
@@ -66,111 +71,111 @@ module Coloration
 
         items_mapping = {
           # general colors for all languages
-          "Normal" => Style.new(:fg => @ui["foreground"], :bg => @ui["background"]),
-          "Boolean" => "constant.language",
-          "Character" => "constant.character",
-          "Comment" => "comment",
+          "Normal"      => Style.new(:fg => @ui["foreground"], :bg => @ui["background"]),
+          "Boolean"     => "constant.language",
+          "Character"   => "constant.character",
+          "Comment"     => "comment",
           "Conditional" => "keyword.control",
-          "Constant" => "constant",
-          #"Debug" => [],
-          "Define" => "keyword",
-          #"Delimiter" => "meta.separator",
-          "DiffAdd" => Style.new(:bg => green.mix_with(@ui['background'], 80), :fg => @ui['foreground'], :bold => true),
-          "DiffDelete" => Style.new(:fg => red.mix_with(@ui['background'], 80)),
-          "DiffChange" => Style.new(:bg => blue.mix_with(@ui['background'], 50), :fg => @ui['foreground']),
-          "DiffText" => Style.new(:bg => blue.mix_with(@ui['background'], 100), :fg => @ui['foreground'], :bold => true),
-          "ErrorMsg" => "invalid",
-          "WarningMsg" => "invalid",
-          #"Exception" => [],
-          "Float" => "constant.numeric",
-          "Function" => "entity.name.function",
-          "Identifier" => "storage.type",
-          #"Include" => [],
-          "Keyword" => "keyword",
-          "Label" => "string.other",
-          #"Macro" => [],
-          "NonText" => Style.new(:fg => @ui["invisibles"], :bg => @ui["background"].mix_with(@ui["foreground"], 95)),
-          "Number" => "constant.numeric",
-          "Operator" => "keyword.operator",
-          #"PreCondit" => [],
-          "PreProc" => "keyword.other",
-          #"Repeat" => [],
-          "Special" => Style.new(:fg => @ui["foreground"]),
-          #"SpecialChar" => [],
-          #"SpecialComment" => [],
-          "SpecialKey" => Style.new(:fg => @ui["invisibles"], :bg => bg_line_color),
-          "Statement" => "keyword.control",
+          "Constant"    => "constant",
+          # "Debug" => [],
+          "Define"      => "keyword",
+          # "Delimiter" => "meta.separator",
+          "DiffAdd"     => Style.new(:bg => green.mix_with(@ui['background'], 80), :fg => @ui['foreground'], :bold => true),
+          "DiffDelete"  => Style.new(:fg => red.mix_with(@ui['background'], 80)),
+          "DiffChange"  => Style.new(:bg => blue.mix_with(@ui['background'], 50), :fg => @ui['foreground']),
+          "DiffText"    => Style.new(:bg => blue.mix_with(@ui['background'], 100), :fg => @ui['foreground'], :bold => true),
+          "ErrorMsg"    => "invalid",
+          "WarningMsg"  => "invalid",
+          # "Exception" => [],
+          "Float"       => "constant.numeric",
+          "Function"    => "entity.name.function",
+          "Identifier"  => "storage.type",
+          # "Include" => [],
+          "Keyword"     => "keyword",
+          "Label"       => "string.other",
+          # "Macro" => [],
+          "NonText"     => Style.new(:fg => @ui["invisibles"], :bg => @ui["background"].mix_with(@ui["foreground"], 95)),
+          "Number"      => "constant.numeric",
+          "Operator"    => "keyword.operator",
+          # "PreCondit" => [],
+          "PreProc"     => "keyword.other",
+          # "Repeat" => [],
+          "Special"     => Style.new(:fg => @ui["foreground"]),
+          # "SpecialChar" => [],
+          # "SpecialComment" => [],
+          "SpecialKey"   => Style.new(:fg => @ui["invisibles"], :bg => bg_line_color),
+          "Statement"    => "keyword.control",
           "StorageClass" => "storage.type",
-          "String" => "string,string.quoted",
-          #"Structure" => [],
-          "Tag" => "entity.name.tag",
-          "Title" => Style.new(:fg => @ui["foreground"], :bold => true),
-          "Todo" => (@items["comment"] || default_style).clone.tap { |c| c.inverse = true; c.bold = true },
-          "Type" => "entity.name.type",
-          #"Typedef" => [],
-          "Underlined" => Style.new(:underline => true),
+          "String"       => "string,string.quoted",
+          # "Structure" => [],
+          "Tag"          => "entity.name.tag",
+          "Title"        => Style.new(:fg => @ui["foreground"], :bold => true),
+          "Todo"         => (@items["comment"] || default_style).clone.tap { |c| c.inverse = true; c.bold = true },
+          "Type"         => "entity.name.type",
+          # "Typedef" => [],
+          "Underlined"   => Style.new(:underline => true),
 
           # ruby
-          "rubyClass" => "keyword.controll.class.ruby",
-          "rubyFunction" => "entity.name.function.ruby",
+          "rubyClass"                  => "keyword.controll.class.ruby",
+          "rubyFunction"               => "entity.name.function.ruby",
           "rubyInterpolationDelimiter" => "",
-          "rubySymbol" => "constant.other.symbol.ruby",
-          "rubyConstant" => "support.class",
-          "rubyStringDelimiter" => "string,string.quoted",
-          "rubyBlockParameter" => "variable.parameter",
-          "rubyInstanceVariable" => "variable.language",
-          "rubyInclude" => "keyword.other.special-method.ruby",
-          "rubyGlobalVariable" => "variable.other",
-          "rubyRegexp" => "string.regexp",
-          "rubyRegexpDelimiter" => "string.regexp",
-          "rubyEscape" => "constant.character.escape",
-          "rubyControl" => "keyword.control",
-          "rubyClassVariable" => "variable",
-          "rubyOperator" => "keyword.operator",
-          "rubyException" => "keyword.other.special-method.ruby",
-          "rubyPseudoVariable" => "variable.language.ruby",
+          "rubySymbol"                 => "constant.other.symbol.ruby",
+          "rubyConstant"               => "support.class",
+          "rubyStringDelimiter"        => "string,string.quoted",
+          "rubyBlockParameter"         => "variable.parameter",
+          "rubyInstanceVariable"       => "variable.language",
+          "rubyInclude"                => "keyword.other.special-method.ruby",
+          "rubyGlobalVariable"         => "variable.other",
+          "rubyRegexp"                 => "string.regexp",
+          "rubyRegexpDelimiter"        => "string.regexp",
+          "rubyEscape"                 => "constant.character.escape",
+          "rubyControl"                => "keyword.control",
+          "rubyClassVariable"          => "variable",
+          "rubyOperator"               => "keyword.operator",
+          "rubyException"              => "keyword.other.special-method.ruby",
+          "rubyPseudoVariable"         => "variable.language.ruby",
 
           # rails
-          "rubyRailsUserClass" => "support.class.ruby",
+          "rubyRailsUserClass"           => "support.class.ruby",
           "rubyRailsARAssociationMethod" => "support.function.activerecord.rails",
-          "rubyRailsARMethod" => "support.function.activerecord.rails",
-          "rubyRailsRenderMethod" => "support.function",
-          "rubyRailsMethod" => "support.function",
+          "rubyRailsARMethod"            => "support.function.activerecord.rails",
+          "rubyRailsRenderMethod"        => "support.function",
+          "rubyRailsMethod"              => "support.function",
 
           # eruby
-          "erubyDelimiter" => "punctuation.section.embedded.ruby",
-          "erubyComment" => "comment",
+          "erubyDelimiter"   => "punctuation.section.embedded.ruby",
+          "erubyComment"     => "comment",
           "erubyRailsMethod" => "support.function",
-          #"erubyExpression" => "text.html.ruby source",
-          #"erubyDelimiter" => "",
+          # "erubyExpression" => "text.html.ruby source",
+          # "erubyDelimiter" => "",
 
           # html
-          "htmlTag" => "meta.tag entity",
-          "htmlEndTag" => "meta.tag entity",
-          "htmlTagName" => "meta.tag entity",
-          "htmlArg" => "meta.tag entity",
+          "htmlTag"         => "meta.tag entity",
+          "htmlEndTag"      => "meta.tag entity",
+          "htmlTagName"     => "meta.tag entity",
+          "htmlArg"         => "meta.tag entity",
           "htmlSpecialChar" => "constant.character.entity.html",
 
           # javascript
-          "javaScriptFunction" => "storage.type.function.js",
+          "javaScriptFunction"      => "storage.type.function.js",
           "javaScriptRailsFunction" => "support.function",
-          "javaScriptBraces" => "meta.brace.curly.js",
+          "javaScriptBraces"        => "meta.brace.curly.js",
 
           # yaml
-          "yamlKey" => "entity.name.tag.yaml",
-          "yamlAnchor" => "variable.other.yaml",
-          "yamlAlias" => "variable.other.yaml",
+          "yamlKey"            => "entity.name.tag.yaml",
+          "yamlAnchor"         => "variable.other.yaml",
+          "yamlAlias"          => "variable.other.yaml",
           "yamlDocumentHeader" => "string.unquoted.yaml",
 
           # css
-          "cssURL" => "variable.parameter.misc.css",
-          "cssFunctionName" => "support.function.misc.css",
-          "cssColor" => "constant.other.color.rgb-value.css",
+          "cssURL"           => "variable.parameter.misc.css",
+          "cssFunctionName"  => "support.function.misc.css",
+          "cssColor"         => "constant.other.color.rgb-value.css",
           "cssPseudoClassId" => "entity.other.attribute-name.pseudo-class.css",
-          "cssClassName" => "entity.other.attribute-name.class.css",
-          "cssValueLength" => "constant.numeric.css",
-          "cssCommonAttr" => "support.constant.property-value.css",
-          "cssBraces" => "punctuation.section.property-list.css",
+          "cssClassName"     => "entity.other.attribute-name.class.css",
+          "cssValueLength"   => "constant.numeric.css",
+          "cssCommonAttr"    => "support.constant.property-value.css",
+          "cssBraces"        => "punctuation.section.property-list.css",
         }
 
         items_mapping.keys.each do |key|
@@ -182,12 +187,9 @@ module Coloration
 
       protected
 
-      def add_line(line="")
-        (@lines ||= []) << line
-      end
-
       def format_item(name, style_or_item_name)
-        raise RuntimeError.new("Style for #{name} is missing!") if style_or_item_name.nil?
+        raise RuntimeError, "Style for #{name} is missing!" if style_or_item_name.nil?
+
         if style_or_item_name == :inverse
           "hi #{name} gui=inverse"
         else
@@ -277,6 +279,9 @@ module Coloration
 
         colors.last
       end
-    end
-  end
-end
+
+    end # VimThemeWriter
+
+  end # Writers
+
+end # Coloration