chroma 0.0.1.alpha.2 → 0.0.1.alpha.3

data/lib/chroma/rgb_generator/base.rb

@@ -1,5 +1,7 @@
 module Chroma
   module RgbGenerator
+    # Base rgb generator class.
+    # @abstract
     class Base
       include Helpers::Bounders
     end

data/lib/chroma/rgb_generator/from_hex_string_values.rb

@@ -1,11 +1,18 @@
 module Chroma
   module RgbGenerator
     class FromHexStringValues < Base
+      # @param format [Symbol] color format
+      # @param r      [String] red value
+      # @param g      [String] green value
+      # @param b      [String] blue value
+      # @param a      [String] alpha value
       def initialize(format, r, g, b, a = 'ff')
         @format = format || :hex
         @r, @g, @b, @a = r, g, b, a
       end
 
+      # Generates a {ColorModes::Rgb}.
+      # @return [ColorModes::Rgb]
       def generate
         r, g, b = [@r, @g, @b].map { |n| n.to_i(16) }
         a = @a.to_i(16) / 255.0
@@ -13,14 +20,36 @@ module Chroma
       end
 
       class << self
+        # Generates a {ColorModes::Rgb} from 3-character hexadecimal.
+        # @return [ColorModes::Rgb]
+        #
+        # @param format [Symbol] color format
+        # @param r      [String] red value
+        # @param g      [String] green value
+        # @param b      [String] blue value
         def from_hex3(format, r, g, b)
           new(format || :hex3, r * 2, g * 2, b * 2)
         end
 
+        # Generates a {ColorModes::Rgb} from 6-character hexadecimal.
+        # @return [ColorModes::Rgb]
+        #
+        # @param format [Symbol] color format
+        # @param r      [String] red value
+        # @param g      [String] green value
+        # @param b      [String] blue value
         def from_hex6(format, r, g, b)
           new(format, r, g, b)
         end
 
+        # Generates a {ColorModes::Rgb} from 8-character hexadecimal.
+        # @return [ColorModes::Rgb]
+        #
+        # @param format [Symbol] color format
+        # @param r      [String] red value
+        # @param g      [String] green value
+        # @param b      [String] blue value
+        # @param a      [String] alpha value
         def from_hex8(format, a, r, g, b)
           new(format || :hex8, r, g, b, a)
         end

data/lib/chroma/rgb_generator/from_hsl.rb

@@ -1,11 +1,15 @@
 module Chroma
   module RgbGenerator
     class FromHsl < Base
+      # @param format [Symbol] color format
+      # @param hsl    [ColorModes::Hsl]
       def initialize(format, hsl)
         @format = format
         @hsl = hsl
       end
 
+      # Generates a {ColorModes::Rgb}.
+      # @return [ColorModes::Rgb]
       def generate
         FromHslValues.new(@format, *@hsl.to_a).generate
       end

data/lib/chroma/rgb_generator/from_hsl_values.rb

@@ -1,6 +1,11 @@
 module Chroma
   module RgbGenerator
     class FromHslValues < Base
+      # @param format [Symbol]          color format
+      # @param h      [String, Numeric] hue value
+      # @param s      [String, Numeric] saturation value
+      # @param l      [String, Numeric] lightness value
+      # @param a      [String, Numeric] alpha value
       def initialize(format, h, s, l, a = 1)
         s = to_percentage(s)
         l = to_percentage(l)
@@ -9,6 +14,8 @@ module Chroma
         @hsl = ColorModes::Hsl.new(h, s, l, a)
       end
 
+      # Generates a {ColorModes::Rgb}.
+      # @return [ColorModes::Rgb]
       def generate
         [Converters::RgbConverter.convert_hsl(@hsl), @format]
       end

data/lib/chroma/rgb_generator/from_hsv.rb

@@ -1,11 +1,15 @@
 module Chroma
   module RgbGenerator
     class FromHsv < Base
+      # @param format [Symbol] color format
+      # @param hsv    [ColorModes::Hsv]
       def initialize(format, hsv)
         @format = format
         @hsv = hsv
       end
 
+      # Generates a {ColorModes::Rgb}.
+      # @return [ColorModes::Rgb]
       def generate
         FromHsvValues.new(@format, *@hsv.to_a).generate
       end

data/lib/chroma/rgb_generator/from_hsv_values.rb

@@ -1,6 +1,11 @@
 module Chroma
   module RgbGenerator
     class FromHsvValues < Base
+      # @param format [Symbol]          color format
+      # @param h      [String, Numeric] hue value
+      # @param s      [String, Numeric] saturation value
+      # @param v      [String, Numeric] value value
+      # @param a      [String, Numeric] alpha value
       def initialize(format, h, s, v, a = 1)
         s = to_percentage(s)
         v = to_percentage(v)
@@ -9,6 +14,8 @@ module Chroma
         @hsv = ColorModes::Hsv.new(h, s, v, a)
       end
 
+      # Generates a {ColorModes::Rgb}.
+      # @return [ColorModes::Rgb]
       def generate
         [Converters::RgbConverter.convert_hsv(@hsv), @format]
       end

data/lib/chroma/rgb_generator/from_rgb.rb

@@ -1,11 +1,15 @@
 module Chroma
   module RgbGenerator
     class FromRgb < Base
+      # @param format [Symbol] color format
+      # @param rgb    [ColorModes::Rgb]
       def initialize(format, rgb)
-        @format = format || :rgb
+        @format = format
         @rgb = rgb
       end
 
+      # Generates a {ColorModes::Rgb}.
+      # @return [ColorModes::Rgb]
       def generate
         FromRgbValues.new(@format, @rgb.r, @rgb.g, @rgb.b, @rgb.a).generate
       end

data/lib/chroma/rgb_generator/from_rgb_values.rb

@@ -1,11 +1,18 @@
 module Chroma
   module RgbGenerator
     class FromRgbValues < Base
+      # @param format [Symbol]          color format
+      # @param r      [String, Numeric] red value
+      # @param g      [String, Numeric] green value
+      # @param b      [String, Numeric] blue value
+      # @param a      [String, Numeric] alpha value
       def initialize(format, r, g, b, a = 1)
-        @format = format
+        @format = format || :rgb
         @r, @g, @b, @a = r, g, b, a
       end
 
+      # Generates a {ColorModes::Rgb}.
+      # @return [ColorModes::Rgb]
       def generate
         r, g, b = [@r, @g, @b].map { |n| bound01(n, 255) * 255 }
         a = bound_alpha(@a)

data/lib/chroma/rgb_generator/from_string.rb

@@ -1,6 +1,11 @@
 module Chroma
   module RgbGenerator
     class FromString < Base
+      # Returns the regex matchers and rgb generation classes for various
+      # string color formats.
+      #
+      # @api private
+      # @return [Hash<Symbol, Hash>]
       def self.matchers
         @matchers ||= begin
           # TinyColor.js matchers
@@ -28,10 +33,14 @@ module Chroma
         end
       end
 
+      # @param format [Symbol] unused
+      # @param input  [String] input to parse
       def initialize(format, input)
         @input = normalize_input(input)
       end
 
+      # Generates a {ColorModes::Rgb}.
+      # @return [ColorModes::Rgb]
       def generate
         get_generator.generate
       end
@@ -52,7 +61,9 @@ module Chroma
           !(match = h[:regex].match(color)).nil?
         end
 
-        raise 'Unrecognized color' if match.nil?
+        if match.nil?
+          raise Errors::UnrecognizedColor, "Unrecognized color `#{color}'"
+        end
 
         build_generator(match[1..-1], hash[:class_name], hash[:builder], format)
       end

data/lib/chroma/version.rb

@@ -1,3 +1,3 @@
 module Chroma
-  VERSION = '0.0.1.alpha.2'
+  VERSION = '0.0.1.alpha.3'
 end

data/spec/chroma/define_palette_spec.rb

@@ -30,4 +30,10 @@ describe Chroma, '.define_palette' do
     expect(red.palette.foo).
       to generate_palette %w(#ff0000 #ffff00 #00ffff #ffff33 #808080)
   end
+
+  it 'keeps the same format' do
+    add_palette
+
+    expect('red'.paint.palette.foo).to all have_format :name
+  end
 end

data/spec/color/palette_spec.rb

@@ -0,0 +1,173 @@
+describe Chroma::Color, '#palette' do
+  let(:red) { 'red'.paint }
+
+  def palette(name, *args)
+    red.palette.send(name, *args)
+  end
+
+  it 'returns an instance of Harmonies' do
+    expect(red.palette).to be_a Chroma::Harmonies
+  end
+
+  describe '#complement' do
+    it 'returns the color and its complement' do
+      expect(red.palette.complement).to generate_palette %w(red cyan)
+    end
+
+    it 'keeps the same format' do
+      expect(red.palette.complement).to all have_format :name
+    end
+
+    context 'with option :as' do
+      it 'outputs the palette as an array of the string format' do
+        expect(red.palette.complement(as: :hex)).
+          to eq %w(#ff0000 #00ffff)
+      end
+    end
+  end
+
+  describe '#triad' do
+    it 'returns the triad palette' do
+      expect(red.palette.triad).to generate_palette %w(red lime blue)
+    end
+
+    it 'keeps the same format' do
+      expect(red.palette.triad).to all have_format :name
+    end
+
+    context 'with option :as' do
+      it 'outputs the palette as an array of the string format' do
+        expect(red.palette.triad(as: :hex)).
+          to eq %w(#ff0000 #00ff00 #0000ff)
+      end
+    end
+  end
+
+  describe '#tetrad' do
+    it 'returns the tetrad palette' do
+      expect(red.palette.tetrad).to generate_palette %w(red #80ff00 cyan #7f00ff)
+    end
+
+    it 'keeps the same format' do
+      expect(red.palette.tetrad).to all have_format :name
+    end
+
+    context 'with option :as' do
+      it 'outputs the palette as an array of the string format' do
+        expect(red.palette.tetrad(as: :hex)).
+          to eq %w(#ff0000 #80ff00 #00ffff #7f00ff)
+      end
+    end
+  end
+
+  describe '#split_complement' do
+    it 'returns the split complement palette' do
+      expect(red.palette.split_complement).to generate_palette %w(red #cf0 #06f)
+    end
+
+    it 'keeps the same format' do
+      expect(red.palette.split_complement).to all have_format :name
+    end
+
+    context 'with option :as' do
+      it 'outputs the palette as an array of the string format' do
+        expect(red.palette.split_complement(as: :hex)).
+          to eq %w(#ff0000 #ccff00 #0066ff)
+      end
+    end
+  end
+
+  describe '#analogous' do
+    context 'with default parameters' do
+      it 'returns the analogous palette' do
+        expect(red.palette.analogous).
+          to generate_palette %w(#f00 #f06 #f03 #f00 #f30 #f60)
+      end
+
+      it 'keeps the same format' do
+        expect(red.palette.analogous).to all have_format :name
+      end
+
+      context 'with option :as' do
+        it 'outputs the palette as an array of the string format' do
+          expect(red.palette.analogous(as: :hex)).
+            to eq %w(#ff0000 #ff0066 #ff0033 #ff0000 #ff3300 #ff6600)
+        end
+      end
+    end
+
+    context 'with `results` argument' do
+      it 'returns the analogous palette' do
+        expect(red.palette.analogous(results: 3)).
+          to generate_palette %w(#f00 #ff001a #ff1a00)
+      end
+
+      it 'keeps the same format' do
+        expect(red.palette.analogous(results: 3)).to all have_format :name
+      end
+
+      context 'with option :as' do
+        it 'outputs the palette as an array of the string format' do
+          expect(red.palette.analogous(results: 3, as: :hex)).
+            to eq %w(#ff0000 #ff001a #ff1a00)
+        end
+      end
+    end
+
+    context 'with `results` and `slices` arguments' do
+      it 'returns the analogous palette' do
+        expect(red.palette.analogous(results: 3, slices: 10)).
+          to generate_palette %w(#f00 #ff004c #ff4d00)
+      end
+
+      it 'keeps the same format' do
+        expect(red.palette.analogous(results: 3, slices: 10)).to all have_format :name
+      end
+
+      context 'with option :as' do
+        it 'outputs the palette as an array of the string format' do
+          expect(red.palette.analogous(results: 3, slices: 10, as: :hex)).
+            to eq %w(#ff0000 #ff004c #ff4d00)
+        end
+      end
+    end
+  end
+
+  describe '#monochromatic' do
+    context 'with default parameters' do
+      it 'returns the monochromatic palette' do
+        expect(red.palette.monochromatic).
+          to generate_palette %w(#f00 #2a0000 #500 #800000 #a00 #d40000)
+      end
+
+      it 'keeps the same format' do
+        expect(red.palette.monochromatic).to all have_format :name
+      end
+
+      context 'with option :as' do
+        it 'outputs the palette as an array of the string format' do
+          expect(red.palette.monochromatic(as: :hex)).
+            to eq %w(#ff0000 #2a0000 #550000 #800000 #aa0000 #d40000)
+        end
+      end
+    end
+
+    context 'with `results` argument' do
+      it 'returns the monochromatic palette' do
+        expect(red.palette.monochromatic(results: 3)).
+          to generate_palette %w(#f00 #500 #a00)
+      end
+
+      it 'keeps the same format' do
+        expect(red.palette.monochromatic(results: 3)).to all have_format :name
+      end
+
+      context 'with option :as' do
+        it 'outputs the palette as an array of the string format' do
+          expect(red.palette.monochromatic(results: 3, as: :hex)).
+            to eq %w(#ff0000 #550000 #aa0000)
+        end
+      end
+    end
+  end
+end

data/spec/custom_matchers.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :generate_palette do |expected|
+  expected.map!(&:paint)
+
+  match do |actual|
+    actual == expected
+  end
+end
+
+RSpec::Matchers.define :have_format do |expected|
+  match do |actual|
+    actual.format == expected
+  end
+end

data/spec/spec_helper.rb

@@ -90,10 +90,4 @@ RSpec.configure do |config|
 =end
 end
 
-RSpec::Matchers.define :generate_palette do |expected|
-  expected.map!(&:paint)
-
-  match do |actual|
-    actual == expected
-  end
-end
+require_relative 'custom_matchers'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chroma
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha.2
+  version: 0.0.1.alpha.3
 platform: ruby
 authors:
 - Jeremy Fairbank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -77,6 +78,7 @@ files:
 - lib/chroma/converters/hsl_converter.rb
 - lib/chroma/converters/hsv_converter.rb
 - lib/chroma/converters/rgb_converter.rb
+- lib/chroma/errors.rb
 - lib/chroma/extensions/string.rb
 - lib/chroma/harmonies.rb
 - lib/chroma/helpers/bounders.rb
@@ -96,8 +98,10 @@ files:
 - spec/chroma/define_palette_spec.rb
 - spec/chroma/paint_spec.rb
 - spec/color/modifiers_spec.rb
+- spec/color/palette_spec.rb
 - spec/color/serializers_spec.rb
 - spec/color_spec.rb
+- spec/custom_matchers.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jfairbank/chroma
 licenses:
@@ -127,6 +131,8 @@ test_files:
 - spec/chroma/define_palette_spec.rb
 - spec/chroma/paint_spec.rb
 - spec/color/modifiers_spec.rb
+- spec/color/palette_spec.rb
 - spec/color/serializers_spec.rb
 - spec/color_spec.rb
+- spec/custom_matchers.rb
 - spec/spec_helper.rb