vic 0.0.2 → 0.0.3

data/lib/vic.rb

@@ -1,6 +1,11 @@
+require 'set'
+
 module Vic
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end
 
 require 'vic/colorscheme'
-require 'vic/highlight'
+require 'vic/colorscheme/highlight'
+require 'vic/colorscheme/highlight_set'
+require 'vic/colorscheme/highlight/argument'
+require 'vic/colorscheme/highlight/argument_set'

data/lib/vic/colorscheme.rb

@@ -1,20 +1,31 @@
 module Vic
   class Colorscheme
-    attr_accessor :colors_name
+    attr_accessor :colors_name, :information
 
+    # A new instance of Colorscheme. If a block is given with no arguments, the
+    # the block will be evaluated in the context of the new colorscheme.
+    # Otherwise the block will yield self.
+    #
+    # @param [String] colors_name the name of the colorscheme
+    # @param [Proc] block the block to be evaluated
+    # @return [Colorscheme]
     def initialize(colors_name, &block)
       @colors_name = colors_name
-      instance_eval(&block) if block_given?
+      if block_given?
+        block.arity == 0 ? instance_eval(&block) : yield(self)
+      end
     end
 
-    # Adds info to the header of the scheme, or retrieves the info hash.
+    # Returns/sets the information attribute
     #
-    # @return [Hash,String]
-    def info(args={})
-      (@info ||= {}).merge!(args) if args.respond_to? :merge
+    # @param [Hash] information the information, :author => 'Joel Holdbrooks'
+    # @return [Hash]
+    def information(inf={})
+      (@information ||= {}).merge!(inf) if inf.respond_to? :merge
     end
+    alias_method :info, :information
 
-    # Retrieves the background color.
+    # Returns the background color.
     #
     # @return [String] 'light' or 'dark'
     def background
@@ -36,7 +47,7 @@ module Vic
     # @return[String] the background attribute
     def background!
       @background =
-        if (normal = highlights.select {|h| h.group_name == 'Normal'}.first)
+        if normal = highlights.find_by_group('Normal')
           return 'dark' unless color = normal.guibg
           color.partition('#').last.to_i(16) <= 8421504 ? 'dark' : 'light'
         else
@@ -44,32 +55,68 @@ module Vic
         end
     end
 
-    # Returns the set of highlights belonging the colorscheme
-    #
-    # @return[Array] the highlights
-    def highlights
-      @highlights ||= []
+    # Returns the set of highlights for the colorscheme
+    def highlight_set
+      @highlight_set ||= HighlightSet.new
     end
+    alias_method :highlights, :highlight_set
 
-    # Proxy method for `Vim::Highlight#new`. If inside of a language block the
-    # langauge name is automatcially prepended to the group name of the new
-    # highlight.
+    # Creates a new highlight or updates one if it exists.
+    #
+    # If inside of a language block the langauge name is automatcially prepended
+    # to the group name of the new highlight.
     #
-    # @see Vim::Highlight
-    # @return [Vim::Highlight] the new highlight
-    def highlight(group_name, args={}, &block)
-      group_name = "#{@language}#{group_name}" if @language
-      highlights.push(Highlight.new group_name, args, &block).first
+    # @see Vic::Highlight
+    # @return [Vic::Highlight] the new highlight
+    def highlight(group, args={})
+      hilight = highlight_set.find_by_group(group)
+      no_args = args.empty?
+
+      if not hilight and no_args
+        return
+      elsif hilight and no_args
+        return hilight
+      elsif hilight
+        hilight.update_arguments!(args)
+      else
+        hilight = Highlight.new("#{language}#{group}", args)
+        highlight_set.add(hilight)
+      end
+
+      hilight
     end
     alias_method :hi, :highlight
 
-    def language(name, &block)
+    # Sets the current language to name. Any new highlights created will have
+    # the language name automatically prepended.
+    #
+    # @return [String] the new language name
+    def language=(name)
       @language = name
-      yield if block_given?
-      @language = nil
     end
 
-    # The colorscheme header
+    # Returns the current language or temporarily sets the language to name if
+    # a block is given. If a block is given with no arguments, it will be
+    # evaluated in the context of the colorscheme, otherwise it will yield the
+    # colorscheme.
+    #
+    # @param [String,Symbol] name the name of the language
+    # @param [Proc] block the block to be evalauted
+    # @return [String] the current language
+    def language(name=nil, &block)
+      if @language and not name
+        return @language
+      elsif name and block_given?
+        previous_language = self.language
+        self.language = name
+        block.arity == 0 ? instance_eval(&block) : yield(self)
+        self.language = previous_language
+      end
+    end
+
+    # Returns the colorscheme header.
+    #
+    # @return [String] the colorscheme header
     def header
       <<-EOT.gsub(/^ {6}/, '')
       " Vim color file
@@ -87,9 +134,11 @@ module Vic
       EOT
     end
 
-    # Creates the colorscheme file
+    # Returns the colorscheme as a string
+    #
+    # @return [String] the colorscheme
     def write
-      [header, highlights.map {|h| h.write }].join("\n")
+      [header, highlights.map(&:write)].join("\n")
     end
   end
 end

data/lib/vic/colorscheme/highlight.rb

@@ -0,0 +1,64 @@
+module Vic
+  class Colorscheme::Highlight
+    attr_accessor :group
+
+    # Creates an instance of Vic::Colorscheme::Highlight. Uses
+    # `update_arguments!` to set the arguments.
+    #
+    # @param [String] group the group name, 'Normal', 'Function', etc.
+    # @param [Hash] args the arguments to set
+    # @return [Vic::Colorscheme::Highlight] the new highlight
+    def initialize(group, args={})
+      @group = group
+      update_arguments!(args)
+    end
+
+    # Returns and/or sets an argument for the current highlight.
+    #
+    # @param [String,Symbol] the argument key
+    # @param [String,Array,nil] the values to assign to the argument key
+    # @return [String,Symbol,Array,nil] the value of the argument key
+    def method_missing(key, *args)
+      super unless key =~ (/([a-z]+)=?/) and Argument.is_valid?($1)
+      lookup   = $1.to_s
+      argument = argument_set.find_by_key(lookup)
+      args     = args.first if args.first.respond_to? :chr
+
+      if not argument and args.empty?
+        return
+      elsif argument and not args.empty?
+        argument.arg = args
+      elsif argument and args.empty?
+        return argument.arg
+      elsif not args.empty?
+        argument = Argument.new(lookup, args)
+        arguments.add argument
+      end
+      argument.arg
+    end
+
+    # Updates/sets the current highlight's arguments.
+    #
+    # @param [Hash] args the arguments to update/set, `:guibg => '#333333'`
+    # @return [Vic::Colorscheme::Highlight::ArgumentSet] the updated argument set
+    def update_arguments!(args={})
+      args.each {|key, val| send("#{key}=", val)}
+      arguments
+    end
+
+    # Returns the set of arguments for the given highlight
+    #
+    # @return [Vic::Colorscheme::Highlight::ArgumentSet] the argument set
+    def argument_set
+      @argument_set ||= ArgumentSet.new
+    end
+    alias_method :arguments, :argument_set
+
+    # Writes the highlight contents.
+    #
+    # @return [String] the highlight as a string
+    def write
+      "hi #{group} #{arguments.sort_by_key.map(&:write).join(' ')}"
+    end
+  end
+end

data/lib/vic/colorscheme/highlight/argument.rb

@@ -0,0 +1,31 @@
+module Vic
+  class Colorscheme::Highlight::Argument
+    VALID = {
+      :normal_terminal => %w{term start stop},
+      :color_terminal  => %w{cterm ctermfg ctermbg},
+      :gui             => %w{gui guifg guibg guisp font}
+    }
+
+    attr_accessor :key, :arg
+
+    def initialize(key, arg)
+      @key, @arg = key, arg
+    end
+
+    # The argument as a string
+    #
+    # @return [String,nil] the string if argument has been set
+    def write
+      return unless arg
+      "#{key}=#{arg.respond_to?(:join) ? arg.join(',') : arg}"
+    end
+
+    # Checks if `key` is valid vim key for an argument
+    #
+    # @param [String,Symbol]
+    # @return [true,false] the key is valid
+    def self.is_valid?(key)
+      VALID.values.flatten.include?(key.to_s)
+    end
+  end
+end

data/lib/vic/colorscheme/highlight/argument_set.rb

@@ -0,0 +1,30 @@
+module Vic
+  class Colorscheme::Highlight::ArgumentSet < Set
+    # Adds a new argument to the set
+    #
+    # @param [Colorscheme::Highlight::Argument] argument the argument to add
+    # @return [Colorscheme::Highlight::ArgumentSet] the new set of arguments
+    def add(argument)
+      if argument.respond_to? :arg
+        super(argument)
+      else
+        # Raise an Exception
+      end
+    end
+
+    # Finds an argument by a key.
+    #
+    # @param [String,Symbol] key the key to search for
+    # @return [Colorscheme::Highlight::Argument,nil] the new argument
+    def find_by_key(key)
+      find {|a| a.key.to_s == key.to_s }
+    end
+
+    # Sorts the arguments by key name
+    #
+    # @return [Colorscheme::Highlight::ArgumentSet] the sorted set of arguments
+    def sort_by_key
+      sort {|a, b| a.key <=> b.key}
+    end
+  end
+end

data/lib/vic/colorscheme/highlight_set.rb

@@ -0,0 +1,19 @@
+module Vic
+  class Colorscheme::HighlightSet < Set
+    # Adds a highlight to the set.
+    #
+    # @param [Colorscheme::Highlight] highlight the highlight to add
+    # @return [Colorscheme::HighlightSet] the updated set of highlights
+    def add(highlight)
+      if highlight.respond_to?(:group)
+        super(highlight)
+      else
+        # Raise and Exception
+      end
+    end
+
+    def find_by_group(group)
+      find {|h| h.group == group }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-06 00:00:00.000000000Z
+date: 2012-01-09 00:00:00.000000000Z
 dependencies: []
 description: Create Vim colorschemes with Ruby
 email: cjholdbrooks@gmail.com
@@ -19,7 +19,10 @@ extra_rdoc_files: []
 files:
 - lib/vic.rb
 - lib/vic/colorscheme.rb
-- lib/vic/highlight.rb
+- lib/vic/colorscheme/highlight.rb
+- lib/vic/colorscheme/highlight_set.rb
+- lib/vic/colorscheme/highlight/argument.rb
+- lib/vic/colorscheme/highlight/argument_set.rb
 homepage: https://github.com/noprompt/vic
 licenses: []
 post_install_message: 

data/lib/vic/highlight.rb

@@ -1,34 +0,0 @@
-module Vic
-  class Highlight
-    VALID_ARGS = {
-      :normal_terminal => %w{term start stop},
-      :color_terminal  => %w{cterm ctermfg ctermbg},
-      :gui             => %w{gui guifg guibg guisp font}
-    }
-
-    attr_accessor :group_name, *VALID_ARGS.values.flatten
-
-    def initialize(group_name, args={})
-      @group_name = group_name
-
-      args.each {|arg, val| send("#{arg}=", val) if respond_to? arg }
-    end
-
-    def write
-      "hi #{group_name} #{arguments}" unless arguments.empty?
-    end
-
-    private
-
-      def arguments
-        valid_arguments.map do |arg|
-          val = send(arg)
-          "#{arg}=#{val}" unless val.nil? or val.empty?
-        end.compact.join(' ')
-      end
-
-      def valid_arguments
-        VALID_ARGS.values.flatten
-      end
-  end
-end