style_palette 0.0.1

data/.gitignore

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

data/.rvmrc.example

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3-p374@style_palette

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fernando Guillen
+
+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,147 @@
+![style_palette](https://raw.github.com/fguillen/StylePalette/master/etc/style_palette.png)
+
+# StylePalette
+
+When you have a bunch of _tags_ and you want to render them in a colorize way you can implement your own colorize system or you can use **ColorPallete**.
+
+StylePalette offers a json based configured color collections that can be associate with words.
+
+StylePalette offers also helpers to render already styled `.label` elements.
+
+
+## Installation
+
+    gem "style_palette"
+
+## Usage
+
+    StylePalette.brush(<word>, <palette_name>)
+
+    StylePalette.brush("cat", :tags).background # => #f5abd5
+    StylePalette.brush("cat", :tags).foreground # => #000
+    StylePalette::Helper.style("cat", :tags) # => background-color: #f5abd5; color: #000;
+    StylePalette::Helper.label("cat", :tags) # => <span class="label" style="background-color: #f5abd5; color: #000;">cat</span>
+
+## Configuration & Initialization
+
+Create a _json_ file with the name of the **palettes** and with an array of _colorized_ styles for each palette, like this:
+
+    {
+      "states": [
+        { "style": "background-color: #cd8745; color: #000;" },
+        { "style": "background-color: #82d37c; color: #000;" },
+        { "style": "background-color: #81dbde; color: #000;" }
+      ],
+
+      "tags": [
+        { "style": "background-color: #f5acb0; color: #000;" },
+        { "style": "background-color: #f5abd5; color: #000;" },
+        { "style": "background-color: #e7abf5; color: #000;" },
+        { "style": "background-color: #b2a6f5; color: #000;" }
+      ]
+    }
+
+Check a [configuration example file](https://github.com/fguillen/StylePalette/blob/master/etc/style_palettes.example.json).
+
+Then initialize StylePalette this way:
+
+    StylePalette.palettes_config = <palettes_file_path.json>
+
+## Rails integration
+
+Configuration:
+
+    # config/style_palettes.json
+    {
+      "states": [
+        { "style": "background-color: #cd8745; color: #000;" },
+        { "style": "background-color: #82d37c; color: #000;" },
+        { "style": "background-color: #81dbde; color: #000;" }
+      ]
+    }
+
+Initialization:
+
+    # config/initializers/style_palette.rb
+    StylePalette.palettes_config = "#{Rails.root}/config/style_palettes.json"
+
+Helper:
+
+    # app/helpers/application_helper.rb
+    def render_label(word, palette_name)
+      StylePalette::Helper.label(word, palette_name).html_safe
+    end
+
+Use:
+
+    # in any template
+    <%= render_label(current_user.state, :states) %>
+
+
+## Word/Color assignment
+
+In the basic configuration ColorPallete takes a random _color_ for each _word_ (**always the same color for each word**), this is very helpful when you don't really care about the associated color for each word, for example if you have docens of _tags_ you are not gonna assign one specific color to each _tag_ just create a big enough palette and let StylePalette to choose.
+
+But if you want to _force_ a color for an specific word you can do it using the special _regex_ attribute for a color in this way:
+
+    "states": [
+      { "style": "background-color: #cd8745; color: #000;" },
+      { "style": "background-color: #82d37c; color: #000;" },
+      { "style": "background-color: #81dbde; color: #000;", "regex": "blocked" }
+    ],
+
+Now if the _word_ is **blocked** then the last color is gonna be choosen.
+
+As you can guess, any valid _regex_ can be used in this field.
+
+Check the [examples in the tests](https://github.com/fguillen/StylePalette/blob/master/test/style_palette_test.rb)
+
+Also check the next examples:
+
+### Number assignment
+
+  	"number": [
+  	  { "style": "background-color: #CCCCCC; color: #000;", "regex": "^0$" },
+  	  { "style": "background-color: #91E391; color: #000;", "regex": "^[^-]" },
+  	  { "style": "background-color: #E68585; color: #000;", "regex": "^-" }
+  	],
+
+  	StylePalette::Helper.label(0, :number) # => <span class="label" style="background-color: #CCCCCC; color: #000;">0</span>
+  	StylePalette::Helper.label(123, :number) # => <span class="label" style="background-color: #91E391; color: #000;">123</span>
+  	StylePalette::Helper.label(-99, :number) # => <span class="label" style="background-color: #E68585; color: #000;">-99</span>
+
+* For _zero_ the first color will be choosen
+* For _positive numbers_ the second color will be choosen
+* For _negative numbers_ the last color while be choosen
+
+### Range assignment
+
+    "ranges": [
+      { "style": "background-color: #fff385; color: #000;", "range": "..0" },
+      { "style": "background-color: #85ffd0; color: #000;", "range": "0..20" },
+      { "style": "background-color: #85c2ff; color: #000;", "range": "20..80" },
+      { "style": "background-color: #ff85f3; color: #000;", "range": "80.." }
+    ]
+
+    StylePalette::Helper.label(0, :ranges) # => <span class="label" style="background-color: #fff385; color: #000;">0</span>
+    StylePalette::Helper.label(45, :ranges) # => <span class="label" style="background-color: #85c2ff; color: #000;">45</span>
+
+### Boolean assignment
+
+  	"boolean": [
+  	  { "style": "background-color: #91E391; color: #000;", "regex": "^(yes|1|true)$" },
+  	  { "style": "background-color: #E68585; color: #000;", "regex": "^(no|0|false)$" }
+  	],
+
+  	StylePalette::Helper.label(0, :boolean) # => <span class="label" style="background-color: #91E391; color: #000;">0</span>
+  	StylePalette::Helper.label("no", :boolean) # => <span class="label" style="background-color: #91E391; color: #000;">no</span>
+  	StylePalette::Helper.label("yes", :boolean) # => <span class="label" style="background-color: #E68585; color: #000;">yes</span>
+  	StylePalette::Helper.label(true, :boolean) # => <span class="label" style="background-color: #E68585; color: #000;">true</span>
+
+
+## The Gallery playground
+
+You can check your _style palettes_ in the [StylePaletteGallery](http://spg.fernandoguillen.info) or [fork the app](https://raw.github.com/fguillen/StylePaletteGallery) and create your own playground.
+
+
+

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "."
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/etc/style_palettes.example.json

@@ -0,0 +1,52 @@
+{
+  "states": [
+    { "style": "background-color: #cd8745; color: #000;" },
+    { "style": "background-color: #82d37c; color: #000;" },
+    { "style": "background-color: #81dbde; color: #000;" },
+    { "style": "background-color: #90a26b; color: #000;" },
+    { "style": "background-color: #c2b19d; color: #000;" },
+    { "style": "background-color: #c1e0a3; color: #000;" },
+    { "style": "background-color: #afaa78; color: #000;" },
+    { "style": "background-color: #C2BB68; color: #000;" },
+    { "style": "background-color: #63E17C; color: #000;" },
+    { "style": "background-color: #34B4C8; color: #000;" }
+  ],
+
+  "number": [
+    { "style": "background-color: #CCCCCC; color: #000;", "regex": "^0$" },
+    { "style": "background-color: #91E391; color: #000;", "regex": "^[^-]" },
+    { "style": "background-color: #E68585; color: #000;", "regex": "^-" }
+  ],
+
+  "boolean": [
+    { "style": "background-color: #91E391; color: #000;", "regex": "^(yes|1|true)$" },
+    { "style": "background-color: #E68585; color: #000;", "regex": "^(no|0|false)$" }
+  ],
+
+  "tags": [
+    { "style": "background-color: #f5acb0; color: #000;" },
+    { "style": "background-color: #f5abd5; color: #000;" },
+    { "style": "background-color: #e7abf5; color: #000;" },
+    { "style": "background-color: #b2a6f5; color: #000;" },
+    { "style": "background-color: #abc9f6; color: #000;" },
+    { "style": "background-color: #acf5ea; color: #000;" },
+    { "style": "background-color: #acf5c5; color: #000;" },
+    { "style": "background-color: #adf6ac; color: #000;" },
+    { "style": "background-color: #caf5ac; color: #000;" },
+    { "style": "background-color: #f5f1a7; color: #000;" },
+    { "style": "background-color: #f5caab; color: #000;" },
+    { "style": "background-color: #ff85a8; color: #000;" },
+    { "style": "background-color: #ffd685; color: #000;" },
+    { "style": "background-color: #fff385; color: #000;" },
+    { "style": "background-color: #85ffd0; color: #000;" },
+    { "style": "background-color: #85c2ff; color: #000;" },
+    { "style": "background-color: #ff85f3; color: #000;" }
+  ],
+
+  "ranges": [
+    { "style": "background-color: #fff385; color: #000;", "range": "..0" },
+    { "style": "background-color: #85ffd0; color: #000;", "range": "0..20" },
+    { "style": "background-color: #85c2ff; color: #000;", "range": "20..80" },
+    { "style": "background-color: #ff85f3; color: #000;", "range": "80.." }
+  ]
+}

data/lib/style_palette/helper.rb

@@ -0,0 +1,6 @@
+module StylePalette::Helper
+  def self.label(word, palette_name)
+    style = StylePalette.brush(word, palette_name).style
+    "<span class=\"label\" style=\"#{style}\">#{word}</span>"
+  end
+end

data/lib/style_palette/version.rb

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

data/lib/style_palette.rb

@@ -0,0 +1,52 @@
+require "json"
+require "ostruct"
+
+require_relative "style_palette/version"
+require_relative "style_palette/helper"
+
+module StylePalette
+  def self.brush(word, palette_name)
+    word = word.to_s
+    palette_name = palette_name.to_sym
+
+    raise ArgumentError, "Palette not found '#{palette_name}'" unless palettes[palette_name]
+    brush_by_regex(word, palette_name) || brush_by_range(word, palette_name) || brush_by_index(word, palette_name)
+  end
+
+  def self.brush_by_regex(word, palette_name)
+    palettes[palette_name].select{ |e| e.regex && word =~ /#{e.regex}/  }.first
+  end
+
+  def self.brush_by_range(word, palette_name)
+    palettes[palette_name].select do |e|
+      result = false
+
+      if e.range
+        from = e.range.split("..")[0].length > 0 ? e.range.split("..")[0].to_i : -Float::INFINITY
+        to = e.range.split("..")[1] ? e.range.split("..")[1].to_i : Float::INFINITY
+        result = (from..to).include?(word.to_i)
+      end
+
+      result
+    end.to_a.first
+  end
+
+  def self.brush_by_index(word, palette_name)
+    index = word.each_byte.inject( &:+ )
+    palettes[palette_name][ index % palettes[palette_name].length ]
+  end
+
+  def self.palettes_config=(style_palettes_file_path)
+    palettes = {}
+
+    JSON.parse(File.read(style_palettes_file_path)).each do |palette_name, palette|
+      palettes[palette_name.to_sym] = palette.map { |e| OpenStruct.new(e) }
+    end
+
+    @palettes = palettes
+  end
+
+  def self.palettes
+    @palettes || raise(Exception, "Palettes not initialized, try `StylePalette.palettes_config = <file_path>`")
+  end
+end

data/style_palette.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'style_palette/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "style_palette"
+  spec.version       = StylePalette::VERSION
+  spec.authors       = ["Fernando Guillen"]
+  spec.email         = ["fguillen.mail@gmail.com"]
+  spec.description   = "Create collections of stylized labels without effort"
+  spec.summary       = "Create collections of stylized labels without effort"
+  spec.homepage      = "https://raw.github.com/fguillen/StylePalette"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+end

data/test/fixtures/style_palettes.json

@@ -0,0 +1,33 @@
+{
+  "states": [
+    { "style": "style 1" },
+    { "style": "style 2" },
+    { "style": "style 3" },
+    { "style": "style 4", "regex": "blocked" }
+  ],
+
+  "number": [
+    { "style": "style 4", "regex": "^0$" },
+    { "style": "style 5", "regex": "^[^-]" },
+    { "style": "style 6", "regex": "^-" }
+  ],
+
+  "boolean": [
+    { "style": "style 7", "regex": "^(yes|1|true)$" },
+    { "style": "style 8", "regex": "^(no|0|false)$" }
+  ],
+
+  "tags": [
+    { "style": "style 9" },
+    { "style": "style 10" },
+    { "style": "style 11" },
+    { "style": "style 12" }
+  ],
+
+  "ranges": [
+    { "style": "style 13", "range": "..0" },
+    { "style": "style 14", "range": "0..20" },
+    { "style": "style 15", "range": "20..80" },
+    { "style": "style 16", "range": "80.." }
+  ]
+}

data/test/helper_test.rb

@@ -0,0 +1,11 @@
+require_relative "test_helper"
+
+class HelperTest < MiniTest::Unit::TestCase
+  def setup
+    StylePalette.palettes_config = "#{FIXTURES}/style_palettes.json"
+  end
+
+  def test_label
+    assert_equal("<span class=\"label\" style=\"style 10\">a</span>", StylePalette::Helper.label("a", :tags))
+  end
+end

data/test/style_palette_test.rb

@@ -0,0 +1,68 @@
+require_relative "test_helper"
+
+class StylePaletteTest < MiniTest::Unit::TestCase
+  def setup
+    StylePalette.palettes_config = "#{FIXTURES}/style_palettes.json"
+  end
+
+  def test_style
+    assert_equal("style 10" , StylePalette.brush("a", :tags).style )
+    assert_equal("style 11" , StylePalette.brush("b", :tags).style )
+    assert_equal("style 12" , StylePalette.brush("c", :tags).style )
+    assert_equal("style 9" , StylePalette.brush("d", :tags).style )
+    assert_equal("style 10" , StylePalette.brush("e", :tags).style )
+  end
+
+  def test_style_by_regex
+    assert_equal("style 1" , StylePalette.brush("active", :states).style )
+    assert_equal("style 2" , StylePalette.brush("deactive", :states).style )
+    assert_equal("style 4" , StylePalette.brush("blocked", :states).style )
+  end
+
+  def test_style_by_range
+    assert_equal("style 13" , StylePalette.brush("-10", :ranges).style )
+    # assert_equal("style 14" , StylePalette.brush("0", :ranges).style )
+    # assert_equal("style 14" , StylePalette.brush("20", :ranges).style )
+    # assert_equal("style 15" , StylePalette.brush("40", :ranges).style )
+    # assert_equal("style 16" , StylePalette.brush("85", :ranges).style )
+    # assert_equal("style 16" , StylePalette.brush("99999", :ranges).style )
+  end
+
+  def test_style_by_regex_numbers
+    assert_equal("style 4" , StylePalette.brush(0, :number).style )
+    assert_equal("style 6" , StylePalette.brush(-10, :number).style )
+    assert_equal("style 5" , StylePalette.brush(10, :number).style )
+  end
+
+  def test_style_by_regex_boolean
+    assert_equal("style 7" , StylePalette.brush(true, :boolean).style )
+    assert_equal("style 7" , StylePalette.brush(1, :boolean).style )
+    assert_equal("style 7" , StylePalette.brush("yes", :boolean).style )
+
+    assert_equal("style 8" , StylePalette.brush(false, :boolean).style )
+    assert_equal("style 8" , StylePalette.brush(0, :boolean).style )
+    assert_equal("style 8" , StylePalette.brush("no", :boolean).style )
+
+    assert_equal("style 7" , StylePalette.brush("other", :boolean).style )
+  end
+
+  def test_raise_error_if_palette_name_not_found
+    exception =
+      assert_raises(ArgumentError) do
+        StylePalette.brush("a", :not_found)
+      end
+
+    assert_match(/Palette not found/, exception.message)
+  end
+
+  def test_raise_error_if_palettes_not_initialized
+    StylePalette.instance_variable_set(:@palettes, nil)
+
+    exception =
+      assert_raises(Exception) do
+        StylePalette.brush("a", :tags)
+      end
+
+    assert_match(/Palettes not initialized/, exception.message)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require "minitest/unit"
+require "minitest/autorun"
+require "mocha/setup"
+
+require_relative "../lib/style_palette"
+
+class MiniTest::Unit::TestCase
+  FIXTURES = File.expand_path("#{File.dirname(__FILE__)}/fixtures")
+end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: style_palette
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fernando Guillen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70292865623820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70292865623820
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70292865623380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70292865623380
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70292865622920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70292865622920
+description: Create collections of stylized labels without effort
+email:
+- fguillen.mail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc.example
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- etc/style_palette.png
+- etc/style_palettes.example.json
+- lib/style_palette.rb
+- lib/style_palette/helper.rb
+- lib/style_palette/version.rb
+- style_palette.gemspec
+- test/fixtures/style_palettes.json
+- test/helper_test.rb
+- test/style_palette_test.rb
+- test/test_helper.rb
+homepage: https://raw.github.com/fguillen/StylePalette
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Create collections of stylized labels without effort
+test_files:
+- test/fixtures/style_palettes.json
+- test/helper_test.rb
+- test/style_palette_test.rb
+- test/test_helper.rb