fauve 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62e3905a46d1054c308be5dda7bb4c41d3371eac
+  data.tar.gz: 1cc8599130f0f3240e1ee16e2e9ed4745ee5863a
+SHA512:
+  metadata.gz: 8ed476915a985221daba2f9fddb42fcce17e02d584029fb89b59f39460e946799e9834392a582df187a352a9dbcba7701ac47b88f8e600ad48ed0344cbd1098c
+  data.tar.gz: a4e0e32cbe55744dd9fbd95749a8bb0b7ea3d5c4f3c3d058bce490a165fd63778eaa3c8d1b656eed541182c24e32051a00611f13a4fa0c9c544fabdcd68b6c20

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*sublime-project
+*sublime-workspace

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--profile

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fauve.gemspec
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', '~> 0.1', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Angel-Bradford
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Fauve
+
+[![Build Status](https://travis-ci.org/clouseauu/fauve.svg?branch=master)](https://travis-ci.org/clouseauu/fauve)
+[![Code Climate](https://codeclimate.com/github/clouseauu/fauve/badges/gpa.svg)](https://codeclimate.com/github/clouseauu/fauve)
+[![Test Coverage](https://codeclimate.com/github/clouseauu/fauve/badges/coverage.svg)](https://codeclimate.com/github/clouseauu/fauve)
+[![Dependencies](https://gemnasium.com/clouseauu/fauve.svg)](https://gemnasium.com/clouseauu/fauve)
+
+Fauve is a Rails/Sass gem to help you manage your app's colour schemes.
+
+Have you had to scour through a sizeable app's CSS/SCSS/Sass files to change hard-coded colour hex values because you're re-branding? Have you ended up with a `colors.sass` or similar file with 1000 lines of variables? Solving this problem is Fauve's _raison d'être_.
+
+## The basic premise
+
+As a rule of thumb, you want to work with about five colours when selecting a scheme. You can have fewer, but when you have _too many_, that's when maintenance becomes nightmarish.
+
+Fauve allows you to have a basic set of colours and define variations to use in different scenarios.
+
+## Usage
+
+1. Add a `fauve.yml` file under `config` in your rails app:
+
+```yaml
+---
+scheme:
+- '#131210'
+- '#c05d33'
+- '#e5b455'
+- '#3c8399'
+- '#d8ccb2'
+
+links:
+  main_text:      scheme[1]
+  main_hover:     scheme[1]
+
+buttons:
+  main_bg:        scheme[3]
+  main_text:      scheme[0]
+  success_bg:     scheme[3]
+
+odd_case:
+  main:           '#4de3ef'
+```
+
+2. Reference the colours in your SCSS/Sass files by calling the `fauve` function, passing `section` and `key`:
+
+```sass
+.button
+  background: fauve(buttons, main_bg)
+  color: fauve(buttons, main_text)
+  padding: 20px
+  ...
+```
+
+You can also use number keys to reference your colours if you use Array syntax, so the config file above references `scheme` as:
+
+```sass
+.button
+  background: fauve(scheme, 3)
+  color: fauve(scheme, 2)
+  padding: 20px
+  ...
+```
+
+Furthermore, you may add any number of Sass colour filters using the following syntax:
+
+```sass
+.button
+  background: fauve(buttons, main_bg, $darken: 20, $rgba: .5)
+  color: fauve(buttons, main_text, $lighten: 5)
+  padding: 20px
+  ...
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fauve'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fauve
+
+
+## TODO
+
+- [ ] Allow filtering (colour mixing) in yaml file
+- [ ] Generate colour scheme page
+- [ ] [Combustion](https://github.com/pat/combustion) testing
+- [ ] Rationale as to why this is a better approach to SassScript Maps
+- [ ] A logo
+
+
+## License ([MIT](https://en.wikipedia.org/wiki/MIT_License))
+
+Copyright (c) 2015
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/bin/fauve

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'fauve/cli'
+
+fauve = Fauve::CLI.run
+exit(1) unless fauve

data/fauve.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fauve/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'fauve'
+  s.version       = Fauve::VERSION
+  s.authors       = ['Daniel Angel-Bradford', 'Timothy Dang']
+  s.email         = ['locusdelicti@gmail.com', 'timothyqd@gmail.com']
+  s.description   = %q{Fauve lets you manage your app's colour scheme}
+  s.summary       = %q{Fauve lets you manage your app's colour scheme}
+  s.homepage      = ''
+  s.license       = 'MIT'
+
+  s.files                 = `git ls-files`.split($/)
+  s.executables           = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files            = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths         = ['lib']
+  s.required_ruby_version = '~> 2'
+
+  s.add_dependency 'sass',            '>= 3.1.10'
+  s.add_dependency 'rails',           '>= 4.1'
+  s.add_dependency 'slim'
+  s.add_dependency 'railties'
+  s.add_dependency 'sprockets-rails', '>= 2.1'
+  s.add_dependency 'trollop'
+
+  s.add_development_dependency 'bundler',     '~> 1.3'
+  s.add_development_dependency 'rspec-rails', '>= 3.1'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'awesome_print'
+
+end

data/lib/fauve/cli.rb

@@ -0,0 +1,27 @@
+require 'trollop'
+require 'rails'
+
+module Fauve
+
+  #fauve -o x/y/x.html [rails/public] -i x/y/z.yml [rails/config/fauve.xml] -v [variations default true]
+
+  module CLI
+
+    def run
+    end
+
+    module_function :run
+
+    def options
+      # Trollop::options do
+      #   opt :output, "Output",  :type => :string, :default => ( defined?(Rails) ? Rails.public_path.to_s : "./" )
+      #   opt :input, "Input",    :type => :string, :default => ( defined?(Rails) ? "#{Rails.root}/config" : "./" )
+      #   opt :skip_variations, "Skip variations", :short => "-v"
+      # end
+    end
+    module_function :options
+
+
+  end
+
+end

data/lib/fauve/colour_scheme.rb

@@ -0,0 +1,24 @@
+module Fauve
+
+    # Representation of a colour_scheme.
+    # Holds a raw colour map as well as the current section,
+    # reference and colour
+
+  class ColourScheme
+
+    attr_accessor :colour
+    alias_method :to_s, :colour
+
+    def initialize(map: Fauve::Config::colour_map, section_name: :app, reference_name: 0)
+      @colour_map       = Fauve::Scheme::ColourMap.new(map)
+      @section          = Fauve::Scheme::Section.new(colour_map, section_name)
+      @reference        = Fauve::Scheme::Reference.new(reference_name)
+      @colour           = Fauve::Scheme::Colour.new(colour_map, section, reference).colour
+    end
+
+    private
+
+    attr_reader :section, :reference, :colour_map
+
+  end
+end

data/lib/fauve/config.rb

@@ -0,0 +1,12 @@
+module Fauve
+
+  module Config
+
+    def self.colour_map
+      YAML.load_file Fauve::Rails::Railtie.config.fauve.config_file
+    end
+
+  end
+
+end
+

data/lib/fauve/engine.rb

@@ -0,0 +1,41 @@
+module Fauve
+
+  # Interface for Fauve to talk to Sass.
+  # Applies filters and returns Sass-Object colours
+  # Requires Fauve::Scheme::ColourMap, Fauve::Scheme::Section
+  # and Fauve::Scheme::Reference
+
+  class Engine
+
+    attr_reader :colour
+
+    def initialize(context: Sass::Script::Functions::EvaluationContext.new({}), raw_colour: raw_colour, filters: {})
+      @sass_context     = context
+      @filters          = filters
+      @raw_colour       = raw_colour
+      @colour           = sass_colour
+      run_filters
+    end
+
+    private
+
+    attr_reader :filters, :sass_context, :raw_colour
+
+    def sass_colour
+      Sass::Script::Color.new to_rgb
+    end
+
+    def to_rgb
+      raw_colour.scan(/^#(..?)(..?)(..?)$/).first.map {|num| num.ljust(2, num).to_i(16)}
+    end
+
+    def run_filters
+      # binding.pry
+      filters.keys.each do |filter|
+        @colour = sass_context.send filter.to_sym, colour, filters[filter]
+      end
+    end
+
+  end
+
+end

data/lib/fauve/errors.rb

@@ -0,0 +1,10 @@
+# Error for undefined sections in yaml file
+class Fauve::UndefinedSectionError    < StandardError; end
+# Error for undefined references in yaml file
+class Fauve::UndefinedReferenceError  < StandardError; end
+# Error for invalid references in yaml file
+class Fauve::InvalidReferenceError    < StandardError; end
+# Error for circular references in yaml file
+class Fauve::CircularReferenceError   < StandardError; end
+# Error for syntax issues in yaml file
+class Fauve::SyntaxError              < StandardError; end

data/lib/fauve/helpers.rb

@@ -0,0 +1,35 @@
+module Sass
+  module Script
+    module Functions
+
+      declare(:fauve, [:section, :reference], var_kwargs: true)
+
+      def fauve(section, reference, filters = {})
+        @fauve_section   = section
+        @fauve_reference = reference
+        @fauve_filters   = filters
+        engine_colour
+      end
+
+      private
+
+      attr_reader :fauve_section, :fauve_reference, :fauve_filters
+
+      def raw_colour
+        Fauve::ColourScheme.new(
+          map: Fauve::Config::colour_map,
+          section_name: fauve_section,
+          reference_name: fauve_reference
+        ).to_s
+      end
+
+      def engine_colour
+        Fauve::Engine.new(
+          context: self,
+          raw_colour: raw_colour,
+          filters: fauve_filters
+        ).colour
+      end
+    end
+  end
+end

data/lib/fauve/railtie.rb

@@ -0,0 +1,14 @@
+module Fauve::Rails
+
+  # Tie Fauve options to Rails.
+
+  class Railtie < ::Rails::Railtie
+    config.fauve = ActiveSupport::OrderedOptions.new
+
+    initializer :fauve_setup do |app|
+      config.fauve.config_file = File.join(Rails.root, 'config/fauve.yml') unless config.fauve.config_file
+    end
+
+  end
+
+end

data/lib/fauve/scheme/colour.rb

@@ -0,0 +1,79 @@
+module Fauve
+  module Scheme
+
+    # Representation of a colour as part of a wider scheme.
+    # Holds a raw colour and a colour with filters applied.
+    # Requires Fauve::Scheme::ColourMap, Fauve::Scheme::Section
+    # and Fauve::Scheme::Reference
+
+    class Colour
+
+      @@candidates = []
+
+      attr_reader :filters, :raw_colour
+
+      def initialize(colour_map, section, reference)
+        @colour_map = colour_map
+        @section    = section
+        @reference  = reference
+        @candidate  = operations.shift
+        @filters    = operations
+        @raw_colour = determine_raw_colour
+      end
+
+      def colour
+        raw_colour
+      end
+
+      private
+
+      HEX_COLOUR_REGEX     = /^#(?:[0-9a-fA-F]{3}){1,2}$/
+      REFERENCE_REGEX      = /\[([a-z_]|[0-9])+\]/
+      SECTION_NAME_REGEX   = /[^\[]+/
+      REFERENCE_NAME_REGEX = /\[(.*?)\]/
+
+      attr_reader :colour_map, :section, :reference, :operations, :candidate
+
+      def determine_raw_colour
+        return candidate if is_valid_hex_colour?
+        while references_another_section? do
+          resolve(candidate)
+        end
+        @@candidates = []
+        candidate
+      end
+
+      def resolve(colour)
+        raise Fauve::CircularReferenceError.new('Circular reference detected') if @@candidates.include?(colour)
+        @@candidates << colour
+        @candidate = recursed(colour).raw_colour
+      end
+
+      def recursed(colour)
+        self.class.new(colour_map, source_section(colour), source_reference(colour))
+      end
+
+      def source_section(key)
+        section.class.new(colour_map, key[SECTION_NAME_REGEX])
+      end
+
+      def source_reference(key)
+        reference.class.new(key.match(REFERENCE_NAME_REGEX)[1])
+      end
+
+      def operations
+        @operations ||= section.to_h[reference.key].split(',').collect{ |element| element.strip }
+      rescue
+        raise Fauve::UndefinedReferenceError.new("Reference isn't a valid index or key")
+      end
+
+      def is_valid_hex_colour?
+        HEX_COLOUR_REGEX === candidate
+      end
+
+      def references_another_section?
+        REFERENCE_REGEX === candidate
+      end
+    end
+  end
+end

data/lib/fauve/scheme/colour_map.rb

@@ -0,0 +1,18 @@
+module Fauve
+  module Scheme
+
+    # Representation of a colour map as part of a wider scheme.
+    # Holds the colour map hash as defined in the options yaml file
+
+    class ColourMap
+
+      attr_reader :map
+
+      def initialize(map)
+        @map = map
+      end
+
+      private
+    end
+  end
+end

data/lib/fauve/scheme/reference.rb

@@ -0,0 +1,43 @@
+module Fauve
+  module Scheme
+
+      # Representation of a reference as part of a wider scheme.
+      # Holds a reference, which can be an integer, a string or a
+      # reference to another section[ref] as a string in the form
+      # "scheme[1]" or "buttons[main_text]"
+      # depending on how the config yaml file has been defined.
+
+    class Reference
+
+      def initialize(reference_name)
+        @reference_name = reference_name.to_s
+      end
+
+      def key
+        case
+        when reference_is_digit?
+          reference_name.to_i
+        when reference_is_valid_string?
+          reference_name.to_s
+        else
+          raise Fauve::InvalidReferenceError.new("Reference isn't a valid index or key")
+        end
+      end
+
+      private
+
+      DIGIT_KEY_REGEX         = /^[0-9]*$/
+      ALPHANUMERIC_KEY_REGEX  = /^[a-z]+[a-zA-Z0-9\-_]+$/
+
+      attr_reader :reference_name
+
+      def reference_is_digit?
+        DIGIT_KEY_REGEX === reference_name
+      end
+
+      def reference_is_valid_string?
+        ALPHANUMERIC_KEY_REGEX === reference_name
+      end
+    end
+  end
+end

data/lib/fauve/scheme/section.rb

@@ -0,0 +1,33 @@
+module Fauve
+  module Scheme
+
+    # Representation of a section key as part of a wider scheme.
+    # Holds a section name, which points to a top-level key within
+    # a colour scheme.
+    # Takes a Fauve::Scheme::ColourMap and a section name (string)
+
+    class Section
+
+      attr_reader :name
+
+      def initialize(colour_map, name)
+        @colour_map = colour_map
+        @name       = name.to_s
+      end
+
+      def to_h
+        return colour_map.map[name] if section_exists?
+        raise Fauve::UndefinedSectionError.new('Section is not referenced in config')
+      end
+
+      private
+
+      attr_reader :colour_map
+
+      def section_exists?
+        !!colour_map.map[name]
+      end
+
+    end
+  end
+end

data/lib/fauve/version.rb

@@ -0,0 +1,3 @@
+module Fauve
+  VERSION = "0.0.7"
+end

data/lib/fauve.rb

@@ -0,0 +1,21 @@
+require 'fauve/version'
+require 'fauve/errors'
+require 'fauve/config'
+
+if defined? Rails
+  require 'sprockets/railtie'
+  require 'fauve/engine'
+  require 'fauve/scheme/colour_map'
+  require 'fauve/scheme/section'
+  require 'fauve/scheme/reference'
+  require 'fauve/scheme/colour'
+  require 'fauve/colour_scheme'
+  require 'fauve/railtie'
+  require 'fauve/helpers'
+end
+
+module Fauve
+  module Rails
+  end
+end
+

data/spec/fixtures/fauve.yml

@@ -0,0 +1,29 @@
+scheme:
+- '#131210'
+- '#c05d33'
+- '#e5b455'
+- '#3c8399'
+- '#d8ccb2'
+
+forms:
+  main_bg:        '#f60'
+  alternate_bg:   '#9cde0d'
+  main_text:      '#5af8de'
+
+links:
+  main_text:      scheme[1]
+  main_hover:     scheme[1], lighten=10, hue=20
+  invalid_ref:    scheme[7]
+  circular_1:     links[circular_2]
+  circular_2:     links[circular_1]
+
+buttons:
+  main_bg:        scheme[3]
+  main_text:      scheme[2]
+  success_bg:     scheme[3], darken=10
+
+multi_level:
+  level:          buttons[main_text]
+
+odd_case:
+  main:           '#4de3ef'

data/spec/lib/fauve/colour_scheme_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module Fauve
+
+  describe ColourScheme do
+
+    let(:map)   { YAML.load_file File.expand_path("./spec/fixtures/fauve.yml") }
+    let(:section_name) { :scheme }
+    let(:reference_name) { 2 }
+
+    subject { described_class.new( map: map, section_name: section_name, reference_name: reference_name ) }
+
+    describe '#initialize' do
+      it 'instantiates a full colour scheme' do
+        expect(subject).to respond_to :colour
+      end
+    end
+
+    describe '#colour' do
+
+      context 'when using integers as a reference' do
+        let(:reference_name) { 3 }
+
+        it 'interprets primary colour correctly' do
+          expect(subject.colour).to eq "#3c8399"
+        end
+      end
+
+      context 'when using keys as a reference' do
+        let(:section_name) { :forms }
+        let(:reference_name) { :main_text }
+
+        it 'interprets primary colour correctly' do
+          expect(subject.colour).to eq "#5af8de"
+        end
+      end
+
+      context 'when referencing a multi-level tree' do
+        let(:section_name)   { :multi_level }
+        let(:reference_name) { :level }
+
+        context 'when the reference is valid' do
+          it 'interprets the colour correctly' do
+            expect(subject.colour).to eq '#e5b455'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/fauve/config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module Fauve
+  describe Config do
+
+    let(:config_file)   { File.expand_path("./spec/fixtures/fauve.yml") }
+
+    before do
+      allow(Fauve::Rails::Railtie.config.fauve).to receive(:config_file).and_return(config_file)
+    end
+
+    subject { described_class }
+
+    describe '.colour_map' do
+      it 'returns a hashified colour scheme' do
+        expect(subject.colour_map).to be_a Hash
+      end
+
+      it 'includes all sections' do
+        expect(subject.colour_map).to have_key 'scheme'
+        expect(subject.colour_map).to have_key 'forms'
+        expect(subject.colour_map).to have_key 'links'
+        expect(subject.colour_map).to have_key 'buttons'
+        expect(subject.colour_map).to have_key 'multi_level'
+        expect(subject.colour_map).to have_key 'odd_case'
+      end
+    end
+  end
+end

data/spec/lib/fauve/engine_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Fauve::Engine do
+
+  let(:sass_context) { Sass::Script::Functions::EvaluationContext.new( Sass::Environment.new ) }
+  let(:amount) { Sass::Script::Number.new(20) }
+  let(:filters) { Hash.new }
+  let(:raw_colour) { "#ff69b3" }
+
+  let(:engine) { Fauve::Engine.new(
+    context: sass_context,
+    raw_colour: raw_colour,
+    filters: filters
+    )
+  }
+
+  before :each do
+    engine.colour.options = {}
+  end
+
+  describe "#colour" do
+
+    it 'returns a base colour in the form of a SASS colour object' do
+      expect(engine.colour).to be_an_instance_of Sass::Script::Color
+    end
+
+    context "when applied filters" do
+
+      let(:filters) { { "lighten" => amount, "saturate" => amount } }
+
+      it 'applies said filters and returns the correct colour' do
+        expect(engine.colour.to_s).to eq "#ffcfe7"
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/fauve/helpers_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module Sass
+  module Script
+    describe Functions do
+
+      let(:config)    { YAML.load_file File.expand_path("./spec/fixtures/fauve.yml") }
+      let(:section)   { :scheme }
+      let(:filters)   { Hash.new }
+      let(:reference) { 3 }
+
+      before do
+        allow(Fauve::Config).to receive(:colour_map).and_return(config)
+      end
+
+      subject { FauveFunction.new }
+
+      describe '#fauve' do
+        it 'returns a Sass colour' do
+          expect(subject.fauve(section, reference)).to be_a Sass::Script::Value::Color
+        end
+
+        it 'returns the right colour' do
+          colour = subject.fauve(section, reference)
+          colour.options = {}
+          expect(colour.to_s).to eq '#3c8399'
+        end
+
+      end
+    end
+  end
+end
+
+# Dummy class for testing the module
+class FauveFunction; include Sass::Script::Functions; end

data/spec/lib/fauve/railtie_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+# TODO: This is a bit meh. We need something like combustion to properly test
+# the gem inside a rails application.
+
+module Fauve
+  module Rails
+    describe Railtie do
+
+      let(:config_file)   { File.expand_path("./spec/fixtures/fauve.yml") }
+
+      subject { described_class }
+
+      context 'config' do
+        it 'ties to Rails config' do
+          expect(subject.config.fauve).to be_a ActiveSupport::OrderedOptions
+        end
+      end
+    end
+  end
+end
+

data/spec/lib/fauve/scheme/colour_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+module Fauve
+  module Scheme
+    describe Colour do
+
+      let(:config)        { YAML.load_file File.expand_path("./spec/fixtures/fauve.yml") }
+      let(:colour_map)    { Fauve::Scheme::ColourMap.new(config) }
+      let(:section_name)  { :scheme }
+      let(:section)       { Fauve::Scheme::Section.new(colour_map, section_name) }
+      let(:reference)     { Fauve::Scheme::Reference.new(reference_name) }
+
+      subject { described_class.new( colour_map, section, reference ) }
+
+      describe '#initialize' do
+        context 'when passed filters' do
+          let(:section_name)   { :links }
+          let(:reference_name) { :main_hover }
+
+          it 'correctly interprets filters' do
+            expect(subject.filters).to be_a Array
+            expect(subject.filters.length).to eq 2
+          end
+        end
+
+        context 'when not passed filters' do
+          let(:section_name)   { :links }
+          let(:reference_name) { :main_text }
+
+          it 'correctly interprets filters' do
+            expect(subject.filters).to be_empty
+          end
+        end
+      end
+
+      describe '#raw_colour' do
+        context "when using integers in the reference" do
+          let(:reference_name) { 0 }
+
+          it 'interprets primary colour correctly' do
+            expect(subject.raw_colour).to eq "#131210"
+          end
+
+          context "when invoking other integers" do
+            let(:reference_name) { 2 }
+
+            it 'interprets colours in the scheme correctly' do
+              expect(subject.raw_colour).to eq "#e5b455"
+            end
+          end
+
+          context "when invoking the last existing integer" do
+            let(:reference_name) { 4 }
+
+            it 'interprets the colour correctly' do
+              expect(subject.raw_colour).to eq "#d8ccb2"
+            end
+          end
+        end
+
+        context 'when using keys' do
+          let(:section_name) { :forms }
+          let(:reference_name) { :main_bg }
+
+          it 'interprets primary colour correctly' do
+            expect(subject.raw_colour).to eq "#f60"
+          end
+
+          context "when invoking other keys" do
+            let(:reference_name) { :alternate_bg }
+
+            it 'interprets colours in the scheme correctly' do
+              expect(subject.raw_colour).to eq "#9cde0d"
+            end
+          end
+
+          context 'when invoking the last existing key' do
+            let(:reference_name) { :main_text }
+
+            it 'interprets the colour correctly' do
+              expect(subject.raw_colour).to eq '#5af8de'
+            end
+          end
+        end
+
+        context 'when referencing another section' do
+          let(:section_name)   { :links }
+          let(:reference_name) { :main_text }
+
+          context 'when the reference is valid' do
+            it 'interprets the colour correctly' do
+              expect(subject.raw_colour).to eq '#c05d33'
+            end
+          end
+
+          context 'when the reference is invalid' do
+            let(:reference_name) { :invalid_red }
+            it 'raises an UndefinedReference error' do
+            expect{ subject }.to raise_exception Fauve::UndefinedReferenceError
+            end
+          end
+
+          context 'when the reference is circular' do
+            let(:reference_name) { :circular_1 }
+            it 'raises a CircularReferenceError error' do
+            expect{ subject }.to raise_exception Fauve::CircularReferenceError
+            end
+          end
+        end
+
+        context 'when passed incorrect / non-existent references' do
+          let(:section_name) { :scheme }
+
+          context 'with integers' do
+            let(:reference_name) { 10 }
+
+            it 'raises an UndefinedReference error' do
+              expect{ subject }.to raise_exception Fauve::UndefinedReferenceError
+            end
+          end
+
+          context 'with keys' do
+            let(:reference_name) { :a_non_declared_key }
+
+            it 'raises an UndefinedReference error' do
+              expect{ subject }.to raise_exception Fauve::UndefinedReferenceError
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/fauve/scheme/reference_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+module Fauve
+  module Scheme
+    describe Reference do
+
+      subject { described_class.new(reference_name) }
+
+      describe '#key' do
+
+        context 'when the reference is numeric' do
+          let(:reference_name) { '1' }
+
+          it 'returns an integer' do
+            expect( subject.key ).to eq 1
+          end
+        end
+
+        context 'when the reference is a key' do
+
+          context 'with an invalid key' do
+            let(:reference_name) { 'like oh my god yo!' }
+
+            it 'raises an InvalidReferenceError error' do
+              expect{ subject.key }.to raise_exception Fauve::InvalidReferenceError
+            end
+          end
+
+          context 'with a valid symbol key' do
+            let(:reference_name) { :a_valid_key }
+
+            it 'returns the key' do
+              expect( subject.key ).to eq 'a_valid_key'
+            end
+          end
+
+          context 'with a valid string key' do
+            let(:reference_name) { 'another_valid_key' }
+
+            it 'returns the key' do
+              expect( subject.key ).to eq 'another_valid_key'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/fauve/scheme/section_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module Fauve
+  module Scheme
+    describe Section do
+
+      let(:section_name) { 'i_like_bananas' }
+      let(:config)  { YAML.load_file File.expand_path("./spec/fixtures/fauve.yml") }
+      let(:colour_map) { Fauve::Scheme::ColourMap.new(config) }
+
+      subject { described_class.new(colour_map, section_name) }
+
+      describe '#initialize' do
+        it 'exposes the section name' do
+          expect(subject.name).to eq section_name
+        end
+      end
+
+      describe '#to_h' do
+
+        context 'when the section exists' do
+          let(:section_name) { :odd_case }
+
+          it 'returns the section hash' do
+            expect(subject.to_h).to eq({ 'main' => '#4de3ef' })
+          end
+        end
+
+        context 'when the section does not exist' do
+          let(:section_name) { 'i_like_bananas' }
+
+          it 'returns the section hash' do
+            expect{subject.to_h}.to raise_exception Fauve::UndefinedSectionError
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'pry'
+require 'sass'
+require 'yaml'
+require 'sprockets/railtie'
+require 'fauve/config'
+require 'fauve/railtie'
+require 'fauve/errors'
+require 'fauve/engine'
+require 'fauve/scheme/colour_map'
+require 'fauve/scheme/section'
+require 'fauve/scheme/reference'
+require 'fauve/scheme/colour'
+require 'fauve/colour_scheme'
+require 'fauve/helpers'

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: fauve
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Daniel Angel-Bradford
+- Timothy Dang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.10
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fauve lets you manage your app's colour scheme
+email:
+- locusdelicti@gmail.com
+- timothyqd@gmail.com
+executables:
+- fauve
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fauve
+- fauve.gemspec
+- lib/fauve.rb
+- lib/fauve/cli.rb
+- lib/fauve/colour_scheme.rb
+- lib/fauve/config.rb
+- lib/fauve/engine.rb
+- lib/fauve/errors.rb
+- lib/fauve/helpers.rb
+- lib/fauve/railtie.rb
+- lib/fauve/scheme/colour.rb
+- lib/fauve/scheme/colour_map.rb
+- lib/fauve/scheme/reference.rb
+- lib/fauve/scheme/section.rb
+- lib/fauve/version.rb
+- spec/fixtures/fauve.yml
+- spec/lib/fauve/colour_scheme_spec.rb
+- spec/lib/fauve/config_spec.rb
+- spec/lib/fauve/engine_spec.rb
+- spec/lib/fauve/helpers_spec.rb
+- spec/lib/fauve/railtie_spec.rb
+- spec/lib/fauve/scheme/colour_spec.rb
+- spec/lib/fauve/scheme/reference_spec.rb
+- spec/lib/fauve/scheme/section_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fauve lets you manage your app's colour scheme
+test_files:
+- spec/fixtures/fauve.yml
+- spec/lib/fauve/colour_scheme_spec.rb
+- spec/lib/fauve/config_spec.rb
+- spec/lib/fauve/engine_spec.rb
+- spec/lib/fauve/helpers_spec.rb
+- spec/lib/fauve/railtie_spec.rb
+- spec/lib/fauve/scheme/colour_spec.rb
+- spec/lib/fauve/scheme/reference_spec.rb
+- spec/lib/fauve/scheme/section_spec.rb
+- spec/spec_helper.rb