color_converters 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 571bd439610154032f4532335702ecb175cd3b022b966843b81ebc26c12a5411
-  data.tar.gz: 33dad1ab16c74560c7fd4587392400002cc863ee16e77bff739e28577f1b9451
+  metadata.gz: b9dbc30347819cfe3042c01530a7b28458f16286ca4267537148a86a918a684a
+  data.tar.gz: c8ce7ec66163f244f6714510acc883c8904275bea0ce0fada6bdcc364350b64a
 SHA512:
-  metadata.gz: 6c9138a8fa458032dfcc2319a2d188a545e9042cfe740d168b737a5d984b4ec94501efce7d384a54baf3ea717384e6b9cc0fbebc8d085a2eb46c24879fa2cefb
-  data.tar.gz: 5cdd92b601b6458552e617413ff4cd1b884571009d5d565e727e47d57da202feb9e9b4b6a6e8ac0fd2592b612b055bc9aa78cbe530f85336bc5fb0d2a07ed236
+  metadata.gz: 87e552e208529b594de4302d56c645217b6cfad12018b58b12e6fc57bc3bef86170139c9c63d2268ef88f05953203b175950b20c7a3bb6decf69823926a8a8e3
+  data.tar.gz: 79cd6ad185469e763f30c5cede6d3de05c1b1ec5406c44e88b1bf9caae181480b2617e32108807e548a224f3661d9c769d1e98b16377bba36c4a3093534e1ec9

data/README.md

@@ -1,161 +1,190 @@
-# Color Converters
-
-> Give me a color and I'll convert it.
-
-Color Converters is an ruby gem package for use in ruby or other projects that provides conversions for colors to other color spaces.
-Given a color in [Hexadecimal, RGA(A), HSL(A), HSV, HSB, CMYK, XYZ, CIELAB, or OKLCH format](https://github.com/devrieda/color_conversion), it can convert the color to those other spaces.
-
-> Lab and LCH color spaces are special in that the perceived difference between two colors is proportional to their Euclidean distance in color space. This special property, called perceptual uniformity, makes them ideal for accurate visual encoding of data. In contrast, the more familiar RGB and HSL color spaces distort data when used for visualization.
-
-## Converters
-
-Colors can be converted between the following spaces:
-
-- hex
-- rgb(a)
-- hsl(a)
-- hsv/hsb
-- cmyk
-- xyz
-- cielab
-- oklch
-- name
-
-## Installation
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add color_converters
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install color_converters
-```
-
-## Usage
-
-Initialize a color:
-
-```ruby
-# from hex
-color = ColorConverters::Color.new("#3366cc")
-color = ColorConverters::Color.new("#36c")
-
-# from rgb(a)
-color = ColorConverters::Color.new(r: 51, g: 102, b: 204)
-color = ColorConverters::Color.new(r: 51, g: 102, b: 204, a: 0.5)
-
-# from hsl(a)
-color = ColorConverters::Color.new(h: 225, s: 73, l: 57)
-color = ColorConverters::Color.new(h: 225, s: 73, l: 57, a: 0.5)
-
-# from hsv/hsb
-color = ColorConverters::Color.new(h: 220, s: 75, v: 80)
-color = ColorConverters::Color.new(h: 220, s: 75, b: 80)
-
-# from cmyk
-color = ColorConverters::Color.new(c: 74, m: 58, y: 22, k: 3)
-
-# from xyz
-color = ColorConverters::Color.new(x: 16, y: 44, z: 32)
-
-# from cielab
-color = ColorConverters::Color.new(l: 16, a: 44, b: 32, space: :cie)
-
-# from cielch
-color = ColorConverters::Color.new(l: 16, c: 44, h: 32, space: :cie)
-
-# from textual color
-color = ColorConverters::Color.new("blue")
-
-# from a css rgb(a) string
-color = ColorConverters::Color.new("rgb(51, 102, 204)")
-color = ColorConverters::Color.new("rgba(51, 102, 204, 0.5)")
-
-# from a css hsl(a) string
-color = ColorConverters::Color.new("hsl(225, 73%, 57%)")
-color = ColorConverters::Color.new("hsl(225, 73%, 57%, 0.5)")
-```
-
-Converters
-
-```ruby
-color = ColorConverters::Color.new(r: 70, g: 130, b: 180, a: 0.5)
-
-color.alpha
-=> 0.5
-
-color.rgb
-=> {:r=>70, :g=>130, :b=>180}
-
-color.hsl
-=> {:h=>207, :s=>44, :l=>49}
-
-color.hsv
-=> {:h=>207, :s=>61, :v=>71}
-
-color.hsb
-=> {:h=>207, :s=>61, :b=>71}
-
-color.cmyk
-=> {:c=>61, :m=>28, :y=>0, :k=>29}
-
-color.xyz
-=> {:x=>33, :y=>21, :z=>54}
-
-color.cielab
-=> {:l=>52.47, :a=>-4.08, :b=>-32.19}
-
-color.cielch
-=> {:l=>52.47, :c=>32.45, :h=>262.78}
-
-color.hex
-=> "#4682b4"
-
-color.name
-=> "steelblue"
-```
-
-## Options
-
-### space
-
-As there are certain color spaces that use the same letter keys, there needed to be a way to different between those space.
-The space parameter allows that, with examples in the usage code above
-
-```ruby
-ColorConverters::Color.new(l: 64, a: 28, b: -15, space: :cie)
-```
-
-### limit_override
-
-By default all values are checked to be within the expected number ranges, i.e.; rgb between 0-255 each.
-This parameter allows you to ignore those ranges and submit any values you want.
-
-```ruby
-ColorConverters::Color.new(r: 270, g: 1300, b: 380, a: 0.5, limit_override: true)
-```
-
-## Development
-
-[Converting Colors](https://convertingcolors.com/) can be usef to help verify results. Different calculators use different exponents and standards so there can be discrepency across them (like this calculator for LCH).
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at <https://github.com/louiswdavis/color_converters>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/louiswdavis/color_converters/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-Forked from original gem by Derek DeVries.
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the ColorConverters project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/louiswdavis/color_converters/blob/master/CODE_OF_CONDUCT.md).
+# Color Converters
+
+> Give me a colour and I'll convert it.
+
+Color Converters is an ruby gem package for use in ruby or other projects that provides conversions for colours to other colour spaces.
+Given a colour in [Hexadecimal, RGA(A), HSL(A), HSV, HSB, CMYK, XYZ, CIELAB, or OKLCH format](https://github.com/devrieda/color_conversion), it can convert the colour to those other spaces.
+
+> Lab and LCH colour spaces are special in that the perceived difference between two colours is proportional to their Euclidean distance in colour space. This special property, called perceptual uniformity, makes them ideal for accurate visual encoding of data. In contrast, the more familiar RGB and HSL colour spaces distort data when used for visualization.
+
+## Converters
+
+Colours can be converted between the following spaces:
+
+- hex
+- rgb(a)
+- hsl(a)
+- hsv/hsb
+- cmyk
+- xyz
+- cielab
+- cielch
+- oklab (not always reliable when going from oklab to the source colour)
+- oklch (not always reliable when going from oklch to the source colour)
+- name
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add color_converters
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install color_converters
+```
+
+## Usage
+
+Initialize a colour:
+
+```ruby
+# from hex
+colour = ColorConverters::Color.new("#3366cc")
+colour = ColorConverters::Color.new("#36c")
+
+# from rgb(a)
+colour = ColorConverters::Color.new(r: 51, g: 102, b: 204)
+colour = ColorConverters::Color.new(r: 51, g: 102, b: 204, a: 0.5)
+
+# from hsl(a)
+colour = ColorConverters::Color.new(h: 225, s: 73, l: 57)
+colour = ColorConverters::Color.new(h: 225, s: 73, l: 57, a: 0.5)
+
+# from hsv/hsb
+colour = ColorConverters::Color.new(h: 220, s: 75, v: 80)
+colour = ColorConverters::Color.new(h: 220, s: 75, b: 80)
+
+# from cmyk
+colour = ColorConverters::Color.new(c: 74, m: 58, y: 22, k: 3)
+
+# from xyz
+colour = ColorConverters::Color.new(x: 16, y: 44, z: 32)
+
+# from cielab
+colour = ColorConverters::Color.new(l: 16, a: 44, b: 32, space: :cie)
+
+# from cielch
+colour = ColorConverters::Color.new(l: 16, c: 44, h: 32, space: :cie)
+
+# from oklab
+colour = ColorConverters::Color.new(l: 16, a: 44, b: 32, space: :ok)
+
+# from oklch
+colour = ColorConverters::Color.new(l: 16, c: 44, h: 32, space: :ok)
+
+# from textual colour
+colour = ColorConverters::Color.new("blue")
+
+# from a css rgb(a) string
+colour = ColorConverters::Color.new("rgb(51, 102, 204)")
+colour = ColorConverters::Color.new("rgba(51, 102, 204, 0.5)")
+
+# from a css hsl(a) string
+colour = ColorConverters::Color.new("hsl(225, 73%, 57%)")
+colour = ColorConverters::Color.new("hsl(225, 73%, 57%, 0.5)")
+```
+
+Converters
+
+```ruby
+colour = ColorConverters::Color.new(r: 70, g: 130, b: 180, a: 0.5)
+
+colour.alpha
+=> 0.5
+
+colour.rgb
+=> {:r=>70, :g=>130, :b=>180}
+
+colour.hsl
+=> {:h=>207, :s=>44, :l=>49}
+
+colour.hsv
+=> {:h=>207, :s=>61, :v=>71}
+
+colour.hsb
+=> {:h=>207, :s=>61, :b=>71}
+
+colour.cmyk
+=> {:c=>61, :m=>28, :y=>0, :k=>29}
+
+colour.xyz
+=> {:x=>33, :y=>21, :z=>54}
+
+colour.cielab
+=> {:l=>52.47, :a=>-4.08, :b=>-32.19}
+
+colour.cielch
+=> {:l=>52.47, :c=>32.45, :h=>262.78}
+
+colour.oklab # not always accurate
+=> {:l=>52.47, :a=>-4.08, :b=>-32.19}
+
+colour.oklch # not always accurate
+=> {:l=>52.47, :c=>32.45, :h=>262.78}
+
+colour.hex
+=> "#4682b4"
+
+colour.name
+=> "steelblue"
+```
+
+## Options
+
+### space
+
+As there are certain colour spaces that use the same letter keys, there needed to be a way to different between those space.
+The space parameter allows that, with examples in the usage code above
+
+```ruby
+ColorConverters::Color.new(l: 64, a: 28, b: -15, space: :cie)
+ColorConverters::Color.new(l: 64, a: 28, b: -15, space: :ok)
+```
+
+### limit_override
+
+By default all values are checked to be within the expected number ranges, i.e.; rgb between 0-255 each.
+This parameter allows you to ignore those ranges and submit any values you want.
+
+```ruby
+ColorConverters::Color.new(r: 270, g: 1300, b: 380, a: 0.5, limit_override: true)
+```
+
+### fuzzy
+
+Name conversions by default look for exact matches between the hex value of the colour
+
+```ruby
+colour = ColorConverters::Color.new(r: 175.8, g: 196.4, b: 222.1)
+
+colour.name
+=> nil
+
+colour.name(fuzzy: true)
+=> 'lightsteelblue'
+```
+
+## Development
+
+[Converting Colors](https://convertingcolors.com/) and [Colorffy](https://colorffy.com/) can be used to help verify results. Different calculators use different exponents and standards so there can be discrepency across them (like this calculator for LCH).
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/louiswdavis/color_converters>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/louiswdavis/color_converters/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+Forked from original gem by Derek DeVries.
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ColorConverters project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/louiswdavis/color_converters/blob/master/CODE_OF_CONDUCT.md).