colorizable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76aa0d86161bd8357776d0b8520e23fad2188f49
+  data.tar.gz: af8e9b6d1d90ba4788c4ac14582093e2133be846
+SHA512:
+  metadata.gz: ee6522325bc9406d589b6679177eadc06ee9786dad588d172924a40e11098105498f5e7adf9f4744b378672d7a320452dba4742c64ce2e704966930b957b3a1d
+  data.tar.gz: 5bf2f791621631e682efb7a0320a192e11af56bc455a4236adceb168140ed563b045cbe1e019b0d5772a89965ae3b4b4f6f07637cd7ea6cdfd2d73fa21aa4344

data/.gitignore

@@ -0,0 +1,10 @@
+coverage
+*.gem
+.bundle
+.rbenv-version
+Gemfile.lock
+.rvmrc
+.ruby-version
+.ruby-gemset
+spec/*.sqlite3
+spec/*.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ideal Project Group
+
+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,52 @@
+# Colorizable
+
+This library provides integration of the [color](https://github.com/halostatue/color) gem with Rails. Use 'colorize' to specify which fields you want to be backed by `Color::RGB` objects.
+
+## Install
+
+Add the gem to your application's Gemfile:
+
+```
+gem 'colorizable'
+```
+
+And execute:
+
+```
+bundle
+```
+
+You can also install it yourself using:
+
+```
+gem install colorizable
+```
+
+## Usage
+
+### ActiveRecord
+
+The Uniform model has three string columns called primary_color, secondary_color, and font_color. Each column has a hex value stored in it. Instead of dealing with a string, it would be helpful to deal with `Color::RGB` objects which provide a number of helpers.
+
+```ruby
+class Uniform < ActiveRecord::Base
+
+  colorize :primary_color, :secondary_color, :font_color
+
+end
+```
+
+Each color on the model is now a `Color::RGB` object. The objects come with a number of helpers to convert the color to other formats like rgb.
+
+## How to contribute
+
+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. Write your tests and check everything passes
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request (into the master branch)
+
+## License
+
+Please refer to [LICENSE](https://github.com/idealprojectgroup/colorizable/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w[--color]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :test => :spec
+task :default => :spec
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))

data/colorizable.gemspec

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'colorizable/version_number'
+
+Gem::Specification.new do |s|
+  s.name          = 'colorizable'
+  s.version       = Colorizable.version
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = "Provides an integration of the color gem with Rails"
+  s.description   = s.summary
+  s.authors       = ["Derek Hopper"]
+  s.email         = 'hopper.derek@gmail.com'
+  s.homepage      = 'http://github.com/idealprojectgroup/colorizable'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_rubygems_version = '>= 1.3.6'
+  s.required_ruby_version = '>= 1.9'
+
+  s.add_dependency('rails','>= 3.1')
+  s.add_dependency('color', '~> 1.8')
+
+  s.add_development_dependency('rspec', '~> 3.0')
+  s.add_development_dependency('rspec-rails')
+  s.add_development_dependency('database_cleaner', '~> 1.3.0')
+  s.add_development_dependency('sqlite3')
+  s.add_development_dependency('rake')
+end

data/lib/colorizable.rb

@@ -0,0 +1,11 @@
+require 'colorizable/color'
+require 'colorizable/model_extensions'
+
+module Colorizable
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, Colorizable::ModelExtensions)
+end
+
+require 'colorizable/version_number'

data/lib/colorizable/color.rb

@@ -0,0 +1,9 @@
+require 'color'
+
+module Colorizable
+  class Color < Color::RGB
+    def to_s
+      "##{hex}"
+    end
+  end
+end

data/lib/colorizable/model_extensions.rb

@@ -0,0 +1,30 @@
+module Colorizable
+  module ModelExtensions
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def colorize(*fields)
+        fields.each do |field|
+          name = field
+
+          define_method name do |*args|
+            Color.by_hex(self[name]) rescue Color.new
+          end
+
+          define_method "#{name}=" do |value|
+            color = if value.kind_of?(Hash)
+              value = value.symbolize_keys
+              Color.new(value[:r], value[:g], value[:b]) rescue nil
+            else
+              Color.by_hex(value.to_s) rescue nil
+            end.try(:hex)
+
+            self[name] = color
+          end
+        end
+      end
+    end
+  end
+end

data/lib/colorizable/version_number.rb

@@ -0,0 +1,18 @@
+module Colorizable
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+
+    def self.to_s
+      STRING
+    end
+  end
+
+  def self.version
+    VERSION::STRING
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.send(:include, Colorizable::ModelExtensions)

data/spec/active_record_helper.rb

@@ -0,0 +1,22 @@
+require 'rails/all'
+require 'database_cleaner'
+require 'yaml'
+
+dbconfig = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+ActiveRecord::Base.establish_connection(dbconfig[ENV['DB'] || 'sqlite'])
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner[:active_record].strategy = :transaction
+    DatabaseCleaner[:active_record].clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner[:active_record].start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner[:active_record].clean
+  end
+end

data/spec/active_record_models.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :themes, force: true do |t|
+    t.column :primary_color, :string
+    t.column :secondary_color, :string
+    t.column :accent_color, :string
+  end
+end
+
+class Theme < ActiveRecord::Base
+  colorize :primary_color, :secondary_color, :accent_color
+end

data/spec/colorizable/model_extensions_spec.rb

@@ -0,0 +1,46 @@
+require "active_record_models"
+
+describe Colorizable::ModelExtensions do
+  describe "colorize" do
+    it "provides a Color::RGB object for each attribute" do
+      theme = Theme.new(primary_color: "#333", secondary_color: "#CCC", accent_color: "#acacac")
+
+      [:primary_color, :secondary_color, :accent_color].each do |attribute|
+        expect(theme.send(attribute)).to be_a Color::RGB
+      end
+    end
+
+    it "accepts a hash of rgb values on setter" do
+      theme = Theme.new
+      theme.primary_color = { r: 204, g: 204, b: 204 }
+      expect(theme.primary_color.to_s).to eq "#cccccc"
+    end
+
+    it "accepts a hex value string on setter" do
+      theme = Theme.new
+      theme.primary_color = "#ccc"
+      expect(theme.primary_color.to_s).to eq "#cccccc"
+    end
+
+    it "does not clobber ActiveModel::Dirty" do
+      theme = Theme.new
+      theme.primary_color = "#ccc"
+      expect(theme.primary_color_changed?).to be true
+
+      theme = Theme.create(primary_color: "#ccc")
+      theme.primary_color = "#ddd"
+      expect(theme.primary_color_changed?).to be true
+      expect(theme.primary_color_was).to eq "cccccc"
+    end
+
+    it "provides a blank Color object if value is blank" do
+      theme = Theme.new(primary_color: nil)
+      expect(theme.primary_color.to_s).to eq "#000000"
+    end
+
+    it "provides a blank Color object if value is an invalid color" do
+      theme = Theme.new(primary_color: "asdfasdfasdf")
+      expect(theme.primary_color.to_s).to eq "#000000"
+    end
+  end
+end

data/spec/colorizable_spec.rb

@@ -0,0 +1,7 @@
+describe Colorizable do
+  describe ".version" do
+    it "provides a version" do
+      expect(Colorizable.version).to be
+    end
+  end
+end

data/spec/database.yml

@@ -0,0 +1,3 @@
+sqlite:
+  adapter: sqlite3
+  database: spec/colorizable.sqlite3

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'active_record_helper'
+require 'rspec/rails'
+require 'colorizable'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: colorizable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derek Hopper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: 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'
+description: Provides an integration of the color gem with Rails
+email: hopper.derek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- colorizable.gemspec
+- lib/colorizable.rb
+- lib/colorizable/color.rb
+- lib/colorizable/model_extensions.rb
+- lib/colorizable/version_number.rb
+- rails/init.rb
+- spec/active_record_helper.rb
+- spec/active_record_models.rb
+- spec/colorizable/model_extensions_spec.rb
+- spec/colorizable_spec.rb
+- spec/database.yml
+- spec/spec_helper.rb
+homepage: http://github.com/idealprojectgroup/colorizable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides an integration of the color gem with Rails
+test_files:
+- spec/active_record_helper.rb
+- spec/active_record_models.rb
+- spec/colorizable/model_extensions_spec.rb
+- spec/colorizable_spec.rb
+- spec/database.yml
+- spec/spec_helper.rb
+has_rdoc: