cpalette 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c81724f8b77e7868578b57539301575cda7c715b
-  data.tar.gz: 2ae699cbd1b0573d9026dd9131164bb5eea78c35
+  metadata.gz: 34efed280ebbd1257990a1b2cfcb9ec64ae65cf8
+  data.tar.gz: f85f5b678de5acf6b8200921085a7a91c9a481fd
 SHA512:
-  metadata.gz: 7aee40652bad9dc1a00f9f268fd47f769e27b80cc71c8cf31971fcf5c509d4f0d47c47ff525a81d88e0a8e8e0e769127e01fc1d0678002e077b0141c641f5857
-  data.tar.gz: 5f7ef62eff03e9578f662466bed267a45760bed58c5605089c70cbf40af02e109b91b3d58400fb8cf54e9d420bbdba270d2aed78fa33bda33b12ceb0b60e19c5
+  metadata.gz: addb05641ca25fdf2b6d430432115476377de4069bd074ca82ef8bee401d3ab1210ecbab7981ccc35513797ee27826f2be631ce726d7502406eab967098902a7
+  data.tar.gz: 5b7276c8f0b3de2bcf5549cf56d1a48403962f0ce0c0817b1e9a89b44d9f9da493d7002580b646dc321b9cd44803d01f30a149365e4a3b1ce2d331b0dcaa98a7

data/Gemfile.lock

@@ -1,12 +1,20 @@
 PATH
   remote: .
   specs:
-    cpalette (0.0.2)
+    cpalette (0.0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.3.2)
     rspec (3.0.0)
       rspec-core (~> 3.0.0)
@@ -20,6 +28,12 @@ GEM
     rspec-mocks (3.0.2)
       rspec-support (~> 3.0.0)
     rspec-support (3.0.2)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
 
 PLATFORMS
   ruby
@@ -27,5 +41,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.6)
   cpalette!
-  rake
-  rspec
+  pry (~> 0.10)
+  rake (~> 10)
+  rspec (~> 3.0)
+  simplecov (~> 0.9)

data/README.md

@@ -1,8 +1,5 @@
 # Cpalette
 
-Cpalette
-----------------------
-
 A simple color gem that returns you with a palette of colors which are web friendly and easy to use.
 
 ## Installation
@@ -21,22 +18,26 @@ Or install it yourself as:
 
 ## Usage
   
-  Case 1:
+  _Case 1:_
+
+  Just pass in the number of colors you needs, returns you an array of 4 hashes with hsl, rgb and hex values for each color.
+
+  ```ruby
 	colors_array = Cpalette.palette(4)
 	
  => [{"hsl"=>"359,62%,46%", "rgb"=>"190,45,47", "hex"=>"#be2d2f"}, {"hsl"=>"89,62%,80%", "rgb"=>"205,236,172", "hex"=>"#cdecac"}, {"hsl"=>"269,80%,71%", "rgb"=>"179,122,240", "hex"=>"#b37af0"}, {"hsl"=>"179,69%,79%", "rgb"=>"165,238,237", "hex"=>"#a5eeed"}]
+ ```
 
- colors_array returns you with an array of 4 hashes with hsl, rgb and hex values for each color.
+ _Case 2:_
 
- Case 2:
-  You can pass an option :hex => true, which would return you an array containing only Hex values of required number of colors.
+  You can pass an optional :hex => true, which return you an array containing only Hex values of required number of colors.
 
-  
+  ```ruby
   colors_array = Cpalette.palette(4, {:hex => true})
 
   => ["#37e1de", "#a468e3", "#f0383b", "#a5e660"]
 
-  Returned colors_array contains only hex values of 4 different colors.
+  ```
 
 ## Contributing
 

data/cpalette.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.9"
 end

data/lib/cpalette.rb

@@ -1,26 +1,13 @@
 require "cpalette/version"
 
 module Cpalette
-  def get_hsl_values_decimal(color)
-
-  end
-  def get_color_codes_in_hex(h, s, l)
-
-  end
-  def self.hue2rgb(p,q,t)
-    t = t + 1 if t < 0
-    t = t -1 if t > 1
-    if 6 * t < 1
-      return p+(q-p)*6*t
-    end
-    if 2 * t < 1
-      return q
-    end
-    if 3 * t < 2
-      return p + (q - p) * ((2.0/3 - t) * 6)
-    end
-    return p
-  end
+  # Given Hue, Saturation and Lightness values return RGB values to it.
+  # Function adopted from - http://easyrgb.com
+  # Assumes inputs: h, s, l are in the range of [0,1]
+  # Returns outputs: R, G, B valu in the range of [0,255]
+  # E.g.
+  # Inputs: h: 0.25, s: 0.89, l: 0.54
+  # Output: r: 141, g: 242, b: 33
   def self.get_color_codes_in_rgb(h, s, l)
     if s == 0
       r = g = b = l * 255
@@ -37,12 +24,41 @@ module Cpalette
     end
     return "#{r},#{g},#{b}"
   end
+
+  # Converts hue to rgb based on following conditions
+  def self.hue2rgb(p,q,t)
+    t = t + 1 if t < 0
+    t = t -1 if t > 1
+    if 6 * t < 1
+      return p+(q-p)*6*t
+    end
+    if 2 * t < 1
+      return q
+    end
+    if 3 * t < 2
+      return p + (q - p) * ((2.0/3 - t) * 6)
+    end
+    return p
+  end
+
+  # Converts RGB to HEX code values
+  # R, G, B are converted to string of base 16 and padded a 0 if length is less than 2
+  # Assumes input r, g, b in the range of [0, 255]
+  # Returns a HEX value
+  # E.g Input - r: 255, g:255, b:255 => #FFFFFF
+  # 
   def self.rgb2hex(r, g, b)
     h1 = r.to_s(16).length == 2 ? r.to_s(16) : "0"+r.to_s(16)
     h2 = g.to_s(16).length == 2 ? g.to_s(16) : "0"+g.to_s(16)
     h3 = b.to_s(16).length == 2 ? b.to_s(16) : "0"+b.to_s(16)
     return "##{h1}#{h2}#{h3}"
   end
+
+  # Takes an input parameter of size (no of colors and options hash)
+  # Returns equivalent number of random colors with HSL, RGB, HEX codes
+  # Max possible values for Hue: 360, Saturation: 100, Lightness: 100
+  # Saturation and Lightness values tend to determine the extremes of a color
+  # Choosing a range of 60..90 tends to give optimum colors
 	def self.palette(size, options = {})
     color_palette = []
     hue_array = []
@@ -53,7 +69,7 @@ module Cpalette
       hue_array.push(hue)
       hue = hue - step_size
     end
-    hue_array.shuffle!
+    hue_array.shuffle! #Inplace
     hue_array.each do |hue|
       s = Random.new.rand(60..90)
       l = Random.new.rand(40..80)
@@ -64,6 +80,7 @@ module Cpalette
       color_codes["hex"] = rgb2hex(rgb[0].to_i, rgb[1].to_i, rgb[2].to_i)
       color_palette.push(color_codes) unless color_palette.include?(color_codes)
     end
+    # If only hex option is set by user
     if options[:hex] != nil
       if options[:hex] == true
         cpalette = []
@@ -73,6 +90,7 @@ module Cpalette
         color_palette = cpalette
       end
     end
+    # binding.pry
     return color_palette
   end
 end

data/lib/cpalette/version.rb

@@ -1,3 +1,3 @@
 module Cpalette
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/cpalette_spec.rb

@@ -1,7 +1,27 @@
 require 'spec_helper'
 
-describe 'Cpalette' do
-  xit 'gives all three types of color codes' do
-
+describe Cpalette do
+  describe "#get_color_codes_in_rgb" do
+    let(:output) {"117,240,240"}
+    it 'returns RGB values for given HSL values' do
+      expect(Cpalette.get_color_codes_in_rgb(0.5, 0.8, 0.7)).to eq(output)
+    end
+    it 'handles case when saturation is 0' do
+      expect(Cpalette.get_color_codes_in_rgb(0.5, 0, 1)).to eq("255,255,255")
+    end
+  end
+  describe "#rgb2hex" do
+    let(:output) {"#ffffff"}
+    it 'returns RGB values for given HSL values' do
+      expect(Cpalette.rgb2hex(255, 255, 255)).to eq(output)
+    end
+  end
+  describe "#palette" do
+    it 'gives all three types of color codes' do
+      expect(Cpalette.palette(4)).to be_truthy
+    end
+    it 'returns only hex values when options[:hex] is true' do
+      expect(Cpalette.palette(4, {:hex => true})).to be_truthy
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,4 @@
-require 'cpalette'
+require 'simplecov'
+# Must be ahead of requiring core library to start the code coverage.
+SimpleCov.start
+require 'cpalette'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpalette
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - avinash-vllbh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,30 +28,58 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: A simple color gem that returns you with a palette of colors which are
   web friendly and easy to use.
 email: