Color
¶ ↑
- home
- code
- bugs
- rdoc
- continuous integration
- test coverage
-
<img src=“https://coveralls.io/repos/halostatue/color/badge.png” alt=“Coverage Status” />
Description¶ ↑
Color
is a Ruby library to provide basic RGB, CMYK, HSL, and other colourspace manipulation support to applications that require it. It also provides 152 named RGB colours (184 with spelling variations) that are commonly supported in HTML, SVG, and X11 applications. A technique for generating monochromatic contrasting palettes is also included.
The Color
library performs purely mathematical manipulation of the colours based on colour theory without reference to colour profiles (such as sRGB or Adobe RGB). For most purposes, when working with RGB and HSL colour spaces, this won’t matter. Absolute colour spaces (like CIE L*a*b* and XYZ) and cannot be reliably converted to relative colour spaces (like RGB) without colour profiles.
Color
1.8 adds an alpha parameter to all #css_rgba
calls, fixes a bug exposed by new constant lookup semantics in Ruby 2, and ensures that Color.equivalent?
can only be called on Color
instances.
Barring bugs introduced in this release, this (really) is the last version of color that supports Ruby 1.8, so make sure that your gem specification is set properly (to ~> 1.8
) if that matters for your application. This version will no longer be supported one year after the release of color 2.0.
History¶ ↑
Color
is the result of a project merge between color.rb 0.1.0 by Matt Lyon and color-tools 1.3 by Austin Ziegler. Please see History.txt for details on the changes this merge brings.
Color::Palette::MonoContrast
was developed based on techniques described by Andy “Malarkey” Clarke, implemented in JavaScript by Steve G. Chipman at SlayerOffice and by Patrick Fitzgerald of BarelyFitz in PHP.
Contributor Code of Conduct¶ ↑
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
-
The use of sexualized language or imagery
-
Personal attacks
-
Trolling or insulting/derogatory comments
-
Public or private harassment
-
Publishing other’s private information, such as physical or electronic addresses, without explicit permission
-
Other unethical or unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
This Code of Conduct is adapted from the Contributor Covenant, version 1.2.0, available at contributor-covenant.org/version/1/2/0/.
Contributing¶ ↑
I value any contribution to Color
you can provide: a bug report, a feature request, or code contributions.
Code contributions to Color
are especially <del>welcome</del>encouraged. Because Color
is a complex codebase, there are a few guidelines:
-
Changes <strong>will not</strong> be accepted without tests.
-
Match my coding style.
-
Use a thoughtfully-named topic branch that contains your change. Rebase your commits into logical chunks as necessary.
-
Do not change the version number; when your patch is accepted and a release is made, the version will be updated at that point.
-
Submit a GitHub pull request with your changes.
-
New features require new documentation.
Test Dependencies¶ ↑
To run the test suite, you will need to install the development dependencies for Color
. If you have Bundler, you can accomplish this easily:
$ bundle install
Color
uses Ryan Davis’s excellent Hoe to manage the release process, and it adds a number of rake tasks. You will mostly be interested in:
$ rake
which runs the tests the same way that:
$ rake spec $ rake test $ rake travis
will do.
Workflow¶ ↑
Here’s the most direct way to get your work merged into the project:
-
Fork the project.
-
Clone down your fork (+git clone git://github.com/<username>/color.git+).
-
Create a topic branch to contain your change (+git checkout -b my_awesome_feature+).
-
Hack away, add tests. Not necessarily in that order.
-
Make sure everything still passes by running ‘rake`.
-
If necessary, rebase your commits into logical chunks, without errors.
-
Push the branch up (+git push origin my_awesome_feature+).
-
Create a pull request against halostatue/color and describe what your change does and the why you think it should be merged.
Contributors¶ ↑
-
Austin Ziegler created color-tools.
-
Matt Lyons created color.
-
Dave Heitzman (contrast comparison)
-
Thomas Sawyer
-
Aaron Hill (CIE94 colour matching)
-
Luke Bennellick
-
Matthew Draper
Licence¶ ↑
This software is available under an MIT-style licence.
-
Copyright 2005–2014 Austin Ziegler, Matt Lyon, and other contributors
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 names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission.
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.