palette 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+*.DS_Store
+*.sw[nop]

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in palette.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    palette (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    mocha (0.9.9)
+      rake
+    rake (0.8.7)
+    rspec (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (= 0.9.9)
+  palette!
+  rspec (= 1.3.0)

data/README.markdown

@@ -0,0 +1,59 @@
+# Palette
+
+## An easier way to write Vim color schemes
+
+## Install
+
+Install with Rubygems:
+
+    gem install palette
+
+## Usage
+
+    puts Palette::Dsl.run lambda {
+      vim_colors "great" do
+        # rules etc go here
+      end
+    }
+
+## Syntax
+
+    vim_colors "sweet" do
+      author "Josh Clayton"
+      notes  "My really sweet theme"
+
+      reset      true
+      background :light
+
+      Normal "222", "f8f8ff"
+
+      Folded "808080", "ECECEC", :gui => "bold"
+      link :vimFold, :FoldColumn, :to => :Folded
+    end
+
+This color scheme would generate the following output:
+
+    " Vim color file
+    "   This file was generated by Palette
+    "   http://rubygems.org/gems/palette
+    "
+    " Author: Josh Clayton
+    " My really sweet theme
+    let colors_name="sweet"
+    hi clear
+    if version > 580
+        if exists("syntax_on")
+            syntax reset
+        endif
+    endif
+    if has("gui_running")
+        set background=light
+    endif
+    hi Normal guifg=#222222 ctermfg=235 guibg=#F8F8FF ctermbg=231
+    hi Folded guifg=#808080 ctermfg=244 guibg=#ECECEC ctermbg=255 gui=bold cterm=bold
+    hi link vimFold    Folded
+    hi link FoldColumn Folded
+
+## Author
+
+Written by Josh Clayton.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/palette.rb

@@ -0,0 +1,9 @@
+require "palette/dsl"
+require "palette/color_scheme"
+require "palette/color"
+require "palette/rule"
+require "palette/link"
+require "palette/version"
+
+module Palette
+end

data/lib/palette/color.rb

@@ -0,0 +1,74 @@
+module Palette
+  class Color
+    BASE_SET = [0, 95, 135, 175, 215, 255]
+    GRAY_SET = [  8,  18,  28,  38,  48,  58,  68,  78,  88,  98, 108, 118,
+                128, 138, 148, 158, 168, 178, 188, 198, 208, 218, 228, 238]
+
+    def initialize(value)
+      @hex = self.class.parse(value)
+    end
+
+    def to_hex
+      @hex
+    end
+
+    def to_cterm
+      self.class.color_map.index(closest_cterm_hex)
+    end
+
+    private
+
+    def self.parse(hex)
+      if hex.upcase =~ /^[A-F\d]{3}$/
+        hex.split(//).map {|code| code * 2 }.join
+      elsif hex.upcase =~ /^[A-F\d]{6}$/
+        hex
+      else
+        raise "invalid hex value: #{hex}"
+      end.upcase
+    end
+
+    def closest_cterm_hex
+      all_colors = self.class.color_map.values.map do |hexcode|
+        original_r, original_g, original_b = self.class.hex_to_decimal(@hex)
+        r, g, b = self.class.hex_to_decimal(hexcode)
+        distance = (original_r - r).abs + (original_g - g).abs + (original_b - b).abs
+        [hexcode, distance]
+      end
+      Hash[*all_colors.flatten].min {|a, b| a[1] <=> b[1] }[0]
+    end
+
+    def self.color_map
+      @colors = {}
+      counter = 16
+      (0...6).each do |red|
+        (0...6).each do |green|
+          (0...6).each do |blue|
+            @colors[counter] = [
+              decimal_to_hex(BASE_SET[red]),
+              decimal_to_hex(BASE_SET[green]),
+              decimal_to_hex(BASE_SET[blue])
+            ].join
+            counter += 1
+          end
+        end
+      end
+
+      GRAY_SET.each do |scale|
+        @colors[counter] = decimal_to_hex(scale) * 3
+        counter += 1
+      end
+      @colors
+    end
+
+    def self.decimal_to_hex(decimal)
+      base = ("%x" % decimal).strip
+      base = "0#{base}" if base.length == 1
+      base
+    end
+
+    def self.hex_to_decimal(hex)
+      hex.scan(/../).map {|x| ("%2d" % "0x#{x}").to_i }
+    end
+  end
+end

data/lib/palette/color_scheme.rb

@@ -0,0 +1,98 @@
+module Palette
+  class ColorScheme
+    attr_reader :name
+
+    def initialize(color_name)
+      @name = color_name
+    end
+
+    def author(author_name)
+      @author_name = author_name
+    end
+
+    def notes(notes)
+      @notes = notes
+    end
+
+    def reset(reset)
+      @reset = !!reset
+    end
+
+    def background(shade)
+      return unless %w(light dark).include?(shade.to_s)
+      @background = shade.to_s
+    end
+
+    def method_missing(name, *args)
+      @rules ||= []
+      @rules << Palette::Rule.new(name.to_s, *args)
+    end
+
+    def String(*args)
+      @rules ||= []
+      @rules << Palette::Rule.new("String", *args)
+    end
+
+    def to_s
+      output = []
+      output << header
+      output << color_scheme_name
+      output << generate_reset
+      output << generate_background
+      output << @rules
+      output << @links
+      output.compact.join("\n")
+    end
+
+    def link(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      @links ||= []
+      args.each do |arg|
+        @links << Link.new(arg, options[:to])
+      end
+    end
+
+    def header
+      %{
+" Vim color file
+"   This file was generated by Palette
+"   http://rubygems.org/gems/palette
+"
+" Author: #{@author_name}
+#{%{" #{@notes}} if @notes}
+      }.strip
+    end
+
+    def generate_reset
+      return unless @reset
+      %{
+hi clear
+if version > 580
+    if exists("syntax_on")
+        syntax reset
+    endif
+endif
+      }.strip
+    end
+
+    def generate_background
+      return unless @background
+      %{
+if has("gui_running")
+    set background=#{@background}
+endif
+      }.strip
+    end
+
+    def color_scheme_name
+      %{let colors_name="#{@name}"}
+    end
+
+    def self.run(name, block)
+      instance = new(name)
+      instance.instance_eval(&block)
+      instance.to_s
+    end
+  end
+end

data/lib/palette/dsl.rb

@@ -0,0 +1,11 @@
+module Palette
+  class Dsl
+    def self.run(block)
+      new.instance_eval(&block)
+    end
+
+    def vim_colors(color_name, &block)
+      Palette::ColorScheme.run(color_name, block)
+    end
+  end
+end

data/lib/palette/link.rb

@@ -0,0 +1,16 @@
+module Palette
+  class Link
+    @@max_length = 0
+    attr_reader :from, :to
+
+    def initialize(from, to)
+      @from = from.to_s
+      @to   = to.to_s
+      @@max_length = @from.length if @from.length > @@max_length
+    end
+
+    def to_s
+      %{hi link #{sprintf("%-#{@@max_length}s", self.from)} #{self.to}}
+    end
+  end
+end

data/lib/palette/rule.rb

@@ -0,0 +1,40 @@
+module Palette
+  class Rule
+    attr_reader :name, :fg, :bg, :gui
+
+    def initialize(name, *args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      @name = name.to_s
+      @fg   = options[:fg]  || args.first
+      @bg   = options[:bg]  || (args.length > 1 ? args.last : nil)
+      @gui  = options[:gui]
+    end
+
+    def to_s
+      return "" if fg.nil? && bg.nil? && gui.nil?
+      output = ["hi", name]
+
+      if fg
+        color = Palette::Color.new(fg)
+        output << %{guifg=##{color.to_hex}}
+        output << %{ctermfg=#{color.to_cterm}}
+      end
+
+      if bg
+        color = Palette::Color.new(bg)
+        output << %{guibg=##{color.to_hex}}
+        output << %{ctermbg=#{color.to_cterm}}
+      end
+
+      if gui
+        output << %{gui=#{gui}}
+        if gui !~ /italic/
+          output << %{cterm=#{gui}}
+        end
+      end
+
+      output.join(" ")
+    end
+  end
+end

data/lib/palette/version.rb

@@ -0,0 +1,3 @@
+module Palette
+  VERSION = "0.0.1"
+end

data/palette.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "palette/version"
+
+Gem::Specification.new do |s|
+  s.name        = "palette"
+  s.version     = Palette::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josh Clayton"]
+  s.email       = ["joshua.clayton@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/palette"
+  s.summary     = %q{Build Vim colorschemes with ease}
+  s.description = %q{Palette provides an easy way to build Vim color schemes}
+
+  all_files = %x{git ls-files}.split("\n")
+
+  s.files         = all_files.reject {|file| file =~ /^(spec|features|cucumber)/ }
+  s.test_files    = all_files.select {|file| file =~ /^(spec|features|cucumber)/ }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec",  "1.3.0"
+  s.add_development_dependency "mocha",  "0.9.9"
+end

data/spec/color_scheme_spec.rb

@@ -0,0 +1,191 @@
+require "spec_helper"
+
+describe Palette::ColorScheme do
+  let(:color_name) { "great" }
+  subject          { Palette::ColorScheme.new(color_name) }
+
+  it "accepts a name as a constructor argument" do
+    subject.name.should == color_name
+    subject.to_s.should include(%{let colors_name="#{color_name}"})
+  end
+end
+
+describe Palette::ColorScheme, "notes" do
+  subject { Palette::ColorScheme.new("abc") }
+
+  it "allows assignment of author" do
+    subject.notes "Based on something great"
+    subject.to_s.should =~ /".*Based on something great/
+  end
+end
+
+describe Palette::ColorScheme, "author" do
+  subject { Palette::ColorScheme.new("abc") }
+
+  it "allows assignment of author" do
+    subject.author "John Doe"
+    subject.to_s.should include(%{" Author: John Doe})
+  end
+end
+
+describe Palette::ColorScheme, "reset" do
+  subject { Palette::ColorScheme.new("abc") }
+
+  let(:header) do
+    %{
+hi clear
+if version > 580
+    if exists("syntax_on")
+        syntax reset
+    endif
+endif
+    }.strip
+  end
+
+  it "generates a reset when set" do
+    subject.reset(true)
+    subject.to_s.should include(header)
+  end
+
+  it "doesn't include a reset by default" do
+    subject.to_s.should_not include(header)
+  end
+end
+
+describe Palette::ColorScheme, "background" do
+  subject { Palette::ColorScheme.new("abc") }
+
+  it "generates a light background when set" do
+    background = %{
+if has("gui_running")
+    set background=light
+endif
+    }.strip
+    subject.background(:light)
+    subject.to_s.should include(background)
+  end
+
+  it "generates a dark background when set" do
+    background = %{
+if has("gui_running")
+    set background=dark
+endif
+    }.strip
+    subject.background(:dark)
+    subject.to_s.should include(background)
+  end
+
+  it "doesn't create a background by default" do
+    subject.to_s.should_not include("set background")
+  end
+
+  it "doesn't create a background if bad data is passed" do
+    subject.background("lame")
+    subject.to_s.should_not include("set background")
+  end
+end
+
+describe Palette::ColorScheme, "rule generation" do
+  before { Palette::Rule.stubs(:new => "Custom rule") }
+
+  it "creates simple rules" do
+    Palette::ColorScheme.run "one", lambda {
+      Comment "ABCDEF", :gui => "bold"
+    }
+    Palette::Rule.should have_received(:new).with("Comment", "ABCDEF", :gui => "bold")
+  end
+
+  it "creates multiple rules" do
+    Palette::ColorScheme.run "one", lambda {
+      Comment "ABCDEF", :gui => "bold"
+      Regexp  :gui => "bold"
+    }
+    Palette::Rule.should have_received(:new).with("Comment", "ABCDEF", :gui => "bold")
+    Palette::Rule.should have_received(:new).with("Regexp", :gui => "bold")
+  end
+
+  it "handles Ruby naming conflicts" do
+    Palette::ColorScheme.run "one", lambda {
+      String "ABCDEF"
+    }
+    Palette::Rule.should have_received(:new).with("String", "ABCDEF")
+  end
+
+  it "outputs rules" do
+    output = Palette::ColorScheme.run "one", lambda {
+      Comment "ABCDEF", :gui => "bold"
+      String "ABCDEF"
+    }
+
+    output.should include(%{Custom rule\nCustom rule})
+  end
+end
+
+describe Palette::ColorScheme, "linking" do
+  before { Palette::Link.stubs(:new => "Custom link") }
+
+  it "handles simple linking" do
+    Palette::ColorScheme.run "one", lambda {
+      link :Something, :to => :Another
+    }
+    Palette::Link.should have_received(:new).with(:Something, :Another)
+  end
+
+  it "handles complex linking" do
+    Palette::ColorScheme.run "one", lambda {
+      link :Something, :Else, :to => :Another
+      link :Red, :to => :Black
+    }
+    Palette::Link.should have_received(:new).with(:Something, :Another)
+    Palette::Link.should have_received(:new).with(:Else, :Another)
+    Palette::Link.should have_received(:new).with(:Red, :Black)
+  end
+
+  it "outputs links" do
+    output = Palette::ColorScheme.run "one", lambda {
+      link :Something, :Else, :to => :Another
+      link :Red, :to => :Black
+    }
+
+    output.should include(%{Custom link\nCustom link\nCustom link})
+  end
+end
+
+describe Palette::ColorScheme, "output order" do
+  subject                 { Palette::ColorScheme.new("abc") }
+  let(:header)            { "header" }
+  let(:color_scheme_name) { "color scheme name" }
+  let(:reset)             { "reset" }
+  let(:background)        { "background" }
+
+  before do
+    subject.stubs(:header              => header,
+                  :color_scheme_name   => color_scheme_name,
+                  :generate_reset      => reset,
+                  :generate_background => background)
+  end
+
+  it "generates the color file in the correct order" do
+    subject.to_s.should == [header, color_scheme_name, reset, background].join("\n")
+  end
+end
+
+describe Palette::ColorScheme, ".run" do
+  let(:color_scheme) do
+    mock("color-scheme").tap do |scheme|
+      scheme.stubs(:great => "things")
+    end
+  end
+
+  before do
+    Palette::ColorScheme.stubs(:new => color_scheme)
+  end
+
+  it "creates a new color scheme with the correct name" do
+    Palette::ColorScheme.run "Great", lambda {
+      great
+    }
+    Palette::ColorScheme.should have_received(:new).with("Great")
+    color_scheme.should have_received(:great)
+  end
+end

data/spec/color_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Palette::Color, "color conversion" do
+  it "generates hex from three hex digits" do
+    Palette::Color.new("AAA").to_hex.should == "AAAAAA"
+  end
+
+  it "generates hex from six hex digits" do
+    Palette::Color.new("FAFAFA").to_hex.should == "FAFAFA"
+  end
+
+  it "generates cterm colors from three hex digits" do
+    Palette::Color.new("000").to_cterm.should == 16
+  end
+
+  it "generates cterm colors from six hex digits" do
+    Palette::Color.new("eeeeee").to_cterm.should == 255
+  end
+
+  it "generates the closest cterm colors to a hex value" do
+    Palette::Color.new("eeeeef").to_cterm.should == 255
+    Palette::Color.new("d7005f").to_cterm.should == 161
+    Palette::Color.new("fffffa").to_cterm.should == 231
+  end
+
+  it "raises an error if a bad color is passed" do
+    expect { Palette::Color.new("abcdfg") }.to raise_error
+    expect { Palette::Color.new("abcdf") }.to raise_error
+    expect { Palette::Color.new("00ff") }.to raise_error
+    expect { Palette::Color.new("0f") }.to raise_error
+  end
+
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe Palette::Dsl do
+  let(:color_name) { "great" }
+
+  it "creates a new scheme" do
+    Palette::ColorScheme.stubs(:run)
+    Palette::Dsl.new.vim_colors(color_name) {}
+    Palette::ColorScheme.should have_received(:run)
+  end
+
+  it "runs schemes" do
+    Palette::ColorScheme.stubs(:run)
+    Palette::Dsl.run lambda {
+      vim_colors("awesome") {}
+    }
+    Palette::ColorScheme.should have_received(:run)
+  end
+end

data/spec/link_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Palette::Link do
+  it "creates a link from one rule to another" do
+    Palette::Link.new("one", "two").to_s.should == %{hi link one two}
+  end
+
+  it "uses the longest 'from' as a base length" do
+    Palette::Link.new("three", "four")
+    Palette::Link.new("one",   "two").to_s.should == %{hi link one   two}
+  end
+end

data/spec/rule_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+shared_examples_for "rule with colors" do
+  let(:fg)    { "DEF" }
+  let(:bg)    { "ABC" }
+  let(:hex)   { "ABCDEF" }
+  let(:cterm) { 123 }
+  let(:color) do
+    mock("color").tap do |color|
+      color.stubs(:to_hex => hex, :to_cterm => cterm)
+    end
+  end
+
+  before { Palette::Color.stubs(:new => color) }
+end
+
+describe Palette::Rule, "with a foreground" do
+  it_should_behave_like "rule with colors"
+  subject { Palette::Rule.new("Awesome", fg) }
+
+  it "highlights the correct colors" do
+    subject.to_s.should == "hi Awesome guifg=##{hex} ctermfg=#{cterm}"
+  end
+
+  it "converts the correct colors" do
+    subject.to_s
+    Palette::Color.should have_received(:new).with(fg)
+    Palette::Color.should_not have_received(:new).with(bg)
+  end
+end
+
+describe Palette::Rule, "with a foreground and background" do
+  it_should_behave_like "rule with colors"
+  subject { Palette::Rule.new("Awesome", fg, bg) }
+
+  it "highlights the correct colors" do
+    subject.to_s.should == "hi Awesome guifg=##{hex} ctermfg=#{cterm} guibg=##{hex} ctermbg=#{cterm}"
+  end
+
+  it "converts the correct colors" do
+    subject.to_s
+    Palette::Color.should have_received(:new).with(fg)
+    Palette::Color.should have_received(:new).with(bg)
+  end
+end
+
+describe Palette::Rule, "with a hash passed" do
+  it_should_behave_like "rule with colors"
+  subject { Palette::Rule.new("Awesome", :fg => fg, :bg => bg) }
+
+  it "highlights the correct colors" do
+    subject.to_s.should == "hi Awesome guifg=##{hex} ctermfg=#{cterm} guibg=##{hex} ctermbg=#{cterm}"
+  end
+
+  it "converts the correct colors" do
+    subject.to_s
+    Palette::Color.should have_received(:new).with(fg)
+    Palette::Color.should have_received(:new).with(bg)
+  end
+end
+
+describe Palette::Rule, "with a gui" do
+  subject { Palette::Rule.new("Awesome", :gui => "bold") }
+
+  it "sets the gui correctly" do
+    subject.to_s.should == "hi Awesome gui=bold cterm=bold"
+  end
+end
+
+describe Palette::Rule, "with a gui as italic" do
+  subject { Palette::Rule.new("Awesome", :gui => "italic") }
+
+  it "sets the gui correctly" do
+    subject.to_s.should == "hi Awesome gui=italic"
+  end
+end
+
+describe Palette::Rule, "without colors" do
+  subject { Palette::Rule.new("Awesome") }
+
+  it "is empty" do
+    subject.to_s.should == ""
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "spec"
+require "mocha"
+require "palette"
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+
+  Mocha::Configuration.warn_when(:stubbing_non_existant_method)
+  Mocha::Configuration.warn_when(:stubbing_non_public_method)
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: palette
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josh Clayton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 0
+        - 9
+        - 9
+        version: 0.9.9
+  type: :development
+  version_requirements: *id002
+description: Palette provides an easy way to build Vim color schemes
+email: 
+- joshua.clayton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- lib/palette.rb
+- lib/palette/color.rb
+- lib/palette/color_scheme.rb
+- lib/palette/dsl.rb
+- lib/palette/link.rb
+- lib/palette/rule.rb
+- lib/palette/version.rb
+- palette.gemspec
+- spec/color_scheme_spec.rb
+- spec/color_spec.rb
+- spec/dsl_spec.rb
+- spec/link_spec.rb
+- spec/rule_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/palette
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Build Vim colorschemes with ease
+test_files: 
+- spec/color_scheme_spec.rb
+- spec/color_spec.rb
+- spec/dsl_spec.rb
+- spec/link_spec.rb
+- spec/rule_spec.rb
+- spec/spec_helper.rb