inker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b10c6175394e05edd4ed0b06d2918ef04afbdcea95622e5750c775190e9ab1be
+  data.tar.gz: c7624699d33612900f67e7c56a305c25c9e9383bc0b8018027e824f48232712f
+SHA512:
+  metadata.gz: b09ec678085c9d58e157999e41cfdc6edfb6317dfeec283aa9736319897b387e0eca9d27fbe9344f5143b2b4e864e4c64e991144a72be276712856f13b41e8b2
+  data.tar.gz: 2eb54559b2f4d05cee14c792a1362cb6678e5957e69a776ae87d5ea35f209b1f6ada3c27d4fc9ca3bef82700d57dadbfc8f461dc4d8b61fb00a45c31827c50fc

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+.rspec_status
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+jobs:
+  include:
+    - name: "Ruby 2.2"
+      rvm: 2.2
+      env: "BUNDLER_VERSION=1.17.3"
+    - name: "Ruby 2.3"
+      rvm: 2.3
+      env: "BUNDLER_VERSION=2.1.4"
+    - name: "Ruby 2.4"
+      rvm: 2.4
+      env: "BUNDLER_VERSION=2.1.4"
+    - name: "Ruby 2.5"
+      rvm: 2.5
+      env: "BUNDLER_VERSION=2.1.4"
+    - name: "Ruby 2.6"
+      rvm: 2.6
+      env: "BUNDLER_VERSION=2.1.4"
+    - name: "Ruby 2.7"
+      rvm: 2.7
+      env: "BUNDLER_VERSION=2.1.4"
+before_install: gem install bundler -v $BUNDLER_VERSION

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at serioja90@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in inker.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Sergiu Groza
+
+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,142 @@
+# Inker
+
+Inker is a Ruby gem for color parsing and manipulation, which allows to parse a HEX, RGB/RGBA and HSL/HSLA color string and provides functionalities for getting more info on color, like brigthness, lightness, saturation, hue. It also allows to change RGBA values in order to obtain new colors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inker'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install inker
+```
+
+## Parsing colors
+
+There're 2 different ways to parse colors with `Inker`. The first (most direct and simple) is to use
+`String#to_color` method, which returns a `Inker::Color` object. The other is by calling `Inker#color`, which has the same effect as `String#to_color`.
+
+```ruby
+require "inker"
+
+"magenta".to_color                   # parse a named color
+"#880e4f".to_color                   # parse a hex6 color
+"#000".to_color                      # parse a hex3 color
+"#b71c1c99".to_color                 # parse a hex8 color (the last 2 chars chars represent alpha value)
+"rgb(74, 20, 140)".to_color          # parse a RGB color
+"rgba(26, 35, 126, 0.75)".to_color   # parse a RGBA color
+"hsl(174, 100%, 29%)".to_color       # parse a HSL color with percentages
+"hsl(174, 1.0, 0.29)".to_color       # parse a HSL color with decimals
+"hsla(21, 100%, 45%, 0.5)".to_color  # parse a HSLA color with percentages
+"hsla(21, 1.0, 0.45, 0.5)".to_color  # parse a HSLA color with decimals
+
+Inker.color("magenta")               # parse a named color
+Inker.color("#880e4f")               # parse a hex6 color
+Inker.color("rgb(74, 20, 140)")      # parse a rgb color
+```
+
+## Output formats
+
+`Inker::Color#to_s` by default outputs the color in HEX format when called, but there're different output formats you can choose from.
+
+```ruby
+require "inker"
+
+# convert named color to HEX
+"magenta".to_color.hex                             #=> "#ff00ff"
+"magenta".to_color.to_s                            #=> "#ff00ff"
+
+# convert HEX color to RGB
+"#880e4f".to_color.rgb                              #=> "rgb(136, 14, 79)"
+"#880e4f".to_color.to_s(:rgb)                       #=> "rgb(136, 14, 79)"
+
+# convert HEX color to RGBA
+"#b71c1c99".to_color.rgba                           #=> "rgba(183, 28, 28, 0.6)"
+"#b71c1c99".to_color.to_s(:rgba)                    #=> "rgba(183, 28, 28, 0.6)"
+
+# convert RGB color to HEX (the last forces alpha channel presence)
+"rgb(74, 20, 140)".to_color.to_s                    #=> "#4a148c"
+"rgb(74, 20, 140)".to_color.hex                     #=> "#4a148c"
+"rgb(74, 20, 140)".to_color.hex(force_alpha: true)  #=> "#4a148cff"
+
+# convert RGBA to HEX (the last ignores alpha channel)
+"rgba(26, 35, 126, 0.75)".to_color.to_s             #=> "#1a237ebf"
+"rgba(26, 35, 126, 0.75)".to_color.hex              #=> "#1a237ebf"
+"rgba(26, 35, 126, 0.75)".to_color.hex6             #=> "#1a237e"
+
+# convert HSL to HEX, RGB and RGBA
+"hsl(174, 100%, 29%)".to_color.to_s                 #=> "#009485"
+"hsl(174, 100%, 29%)".to_color.hex                  #=> "#009485"
+"hsl(174, 100%, 29%)".to_color.rgb                  #=> "rgb(0, 148, 133)"
+"hsl(174, 100%, 29%)".to_color.rgba                 #=> "rgb(0, 148, 133, 1.0)"
+
+# convert HSLA to HEX, RGB and RGBA
+"hsla(21, 100%, 45%, 0.5)".to_color.to_s            #=> "#e650007f"
+"hsla(21, 100%, 45%, 0.5)".to_color.hex             #=> "#e650007f"
+"hsla(21, 100%, 45%, 0.5)".to_color.hex6            #=> "#e65000"
+"hsla(21, 100%, 45%, 0.5)".to_color.rgb             #=> "rgb(230, 80, 0)"
+"hsla(21, 100%, 45%, 0.5)".to_color.rgba            #=> "rgba(230, 80, 0, 0.5)"
+```
+
+## Features
+
+Inker implements some useful features for getting useful color info an color manipulation.
+
+### Instance methods
+
+| Method name   | Description                                                       |
+|---------------|-------------------------------------------------------------------|
+| `#red`        | Returns the value of red component in range `0-255`               |
+| `#red=`       | Allows to set a new value for red component in range `0-255`      |
+| `#green`      | Returns the value of green component in range `0-255`             |
+| `#green=`     | Allows to set a new value for green component in range `0-255`    |
+| `#blue`       | Returns the value of blue component in range `0-255`              |
+| `#blue=`      | Allows to set a new value for blue component in range `0-255`     |
+| `#alpha`      | Returns the value of alpha component in range `0.0-1.0`           |
+| `#alpha=`     | Allows to set a new value for alpha component in range `0.0-1.0`  |
+| `#brightness` | Returns the brightness of the color in range `0-255`              |
+| `#dark?`      | Returns a boolean (`true` when color is dark)                     |
+| `#light?`     | Returns a boolean (`true` when color is light)                    |
+| `#lightness`  | Returns the lightness of the color in range `0.0-1.0`             |
+| `#saturation` | Returns the saturation of the color in range `0.0-1.0`            |
+| `#hue`        | Retursn the value of HUE component of the color in range `0-360`  |
+
+### Class methods
+
+| Method name                                                 | Description                                                                                             |
+|-------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| `Inker::Color.from_rgb(Integer, Integer, Integer)`          | Create a new `Inker::Color` instance from RGB components values                                         |
+| `Inker::Color.from_rgba(Integer, Integer, Integer, Float)`  | Same as `Inker::Color.from_rgb`, but has also the alpha component                                       |
+| `Inker::Color.from_hsl(Integer, Float, Float)`              | Create a new `Inker::Color` instance from HSL components (Saturation and Lightness in range `0.0-1.0`)  |
+| `Inker::Color.from_hsla(Integer, Float, Float, Float)`      | Same as `Inker::Color.from_hsl`, but has also the alpha component                                       |
+| `Inker::Color.from_custom_string(String, options)`          | Generate a new `Inker::Color` from a custom string, by getting HEX characters from MD5 digest of input string. By setting `:position` option you can change the index of target HEX chars that are used for HEX color generation. (default `position: [0, 29, 14, 30, 28, 31]`)                                                         |
+| `Inker::Color.random`                                       | Generate a random `Inker::Color` instance                                                               |
+
+## Development
+
+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 tags, 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/serioja90/inker](https://github.com/serioja90/inker). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).
+
+## Code of Conduct
+
+Everyone interacting in the Inker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "inker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/inker.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "inker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "inker"
+  spec.version       = Inker::VERSION
+  spec.authors       = ["Groza Sergiu"]
+  spec.email         = ["serioja90@gmail.com"]
+
+  spec.summary       = %q{A Ruby gem for color manipulation.}
+  spec.description   = %q{Inker is a gem wrtitten in Ruby which can be used to parse and manipulate colors.}
+  spec.homepage      = "https://github.com/serioja90/inker"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  bundler_version = (RUBY_VERSION >= '2.3' ? '~> 2.1' : '~> 1.17')
+  rake_version = (RUBY_VERSION >= '2.2' ? '~> 13.0' : '~> 12.0')
+
+
+  spec.add_development_dependency "bundler", bundler_version
+  spec.add_development_dependency "rake", rake_version
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/lib/data/colors.yml

@@ -0,0 +1,163 @@
+# RED
+red: "#FF0000"
+crimson: "#DC143C"
+darkred: "#8B0000"
+darksalmon: "#E9967A"
+firebrick: "#B22222"
+indianred: "#CD5C5C"
+lightcoral: "#F08080"
+maroon: "#800000"
+palevioletred: "#DB7093"
+salmon: "#FA8072"
+
+# PINK
+pink: "#FFC0CB"
+lightpink: "#FFB6C1"
+hotpink: "#FF69B4"
+deeppink: "#FF1493"
+mediumvioletred: "#C71585"
+palevioletred: "#DB7093"
+
+# ORANGE
+orange: "#FFA500"
+lightsalmon: "#FFA07A"
+coral: "#FF7F50"
+tomato: "#FF6347"
+orangered: "#FF4500"
+darkorange: "#FF8C00"
+
+# YELLOW
+yellow: "#FFFF00"
+gold: "#FFD700"
+lightyellow: "#FFFFE0"
+lemonchiffon: "#FFFACD"
+lightgoldenrodyellow: "#FAFAD2"
+papayawhip: "#FFEFD5"
+moccasin: "#FFE4B5"
+peachpuff: "#FFDAB9"
+palegoldenrod: "#EEE8AA"
+khaki: "#F0E68C"
+darkkhaki: "#BDB76B"
+
+# PURPLE
+purple: "#800080"
+lavender: "#E6E6FA"
+thistle: "#D8BFD8"
+plum: "#DDA0DD"
+violet: "#EE82EE"
+orchid: "#DA70D6"
+fuchsia: "#FF00FF"
+magenta: "#FF00FF"
+mediumorchid: "#BA55D3"
+mediumpurple: "#9370DB"
+rebeccapurple: "#663399"
+blueviolet: "#8A2BE2"
+darkviolet: "#9400D3"
+darkorchid: "#9932CC"
+darkmagenta: "#8B008B"
+indigo: "#4B0082"
+slateblue: "#6A5ACD"
+darkslateblue: "#483D8B"
+mediumslateblue: "#7B68EE"
+
+# GREEN
+green: "#00FF00"
+greenyellow: "#ADFF2F"
+chartreuse: "#7FFF00"
+lawngreen: "#7CFC00"
+lime: "#00FF00"
+limegreen: "#32CD32"
+palegreen: "#98FB98"
+lightgreen: "#90EE90"
+mediumspringgreen: "#00FA9A"
+springgreen: "#00FF7F"
+mediumseagreen: "#3CB371"
+seagreen: "#2E8B57"
+forestgreen: "#228B22"
+darkgreen: "#006400"
+yellowgreen: "#9ACD32"
+olivedrab: "#6B8E23"
+olive: "#808000"
+darkolivegreen: "#556B2F"
+mediumaquamarine: "#66CDAA"
+darkseagreen: "#8FBC8B"
+lightseagreen: "#20B2AA"
+darkcyan: "#008B8B"
+teal: "#008080"
+
+# BLUE
+blue: "#0000FF"
+aqua: "#00FFFF"
+cyan: "#00FFFF"
+lightcyan: "#E0FFFF"
+paleturquoise: "#AFEEEE"
+aquamarine: "#7FFFD4"
+turquoise: "#40E0D0"
+mediumturquoise: "#48D1CC"
+darkturquoise: "#00CED1"
+cadetblue: "#5F9EA0"
+steelblue: "#4682B4"
+lightsteelblue: "#B0C4DE"
+powderblue: "#B0E0E6"
+lightblue: "#ADD8E6"
+skyblue: "#87CEEB"
+lightskyblue: "#87CEFA"
+deepskyblue: "#00BFFF"
+dodgerblue: "#1E90FF"
+cornflowerblue: "#6495ED"
+mediumslateblue: "#7B68EE"
+royalblue: "#4169E1"
+mediumblue: "#0000CD"
+darkblue: "#00008B"
+navy: "#000080"
+midnightblue: "#191970"
+
+# BROWN
+brown: "#A52A2A"
+cornsilk: "#FFF8DC"
+blanchedalmond: "#FFEBCD"
+bisque: "#FFE4C4"
+navajowhite: "#FFDEAD"
+wheat: "#F5DEB3"
+burlywood: "#DEB887"
+tan: "#D2B48C"
+rosybrown: "#BC8F8F"
+sandybrown: "#F4A460"
+goldenrod: "#DAA520"
+darkgoldenrod: "#B8860B"
+peru: "#CD853F"
+chocolate: "#D2691E"
+saddlebrown: "#8B4513"
+sienna: "#A0522D"
+maroon: "#800000"
+
+# WHITE
+white: "#FFFFFF"
+snow: "#FFFAFA"
+honeydew: "#F0FFF0"
+mintcream: "#F5FFFA"
+azure: "#F0FFFF"
+aliceblue: "#F0F8FF"
+ghostwhite: "#F8F8FF"
+whitesmoke: "#F5F5F5"
+seashell: "#FFF5EE"
+beige: "#F5F5DC"
+oldlace: "#FDF5E6"
+floralwhite: "#FFFAF0"
+ivory: "#FFFFF0"
+antiquewhite: "#FAEBD7"
+linen: "#FAF0E6"
+lavenderblush: "#FFF0F5"
+mistyrose: "#FFE4E1"
+
+# GRAY
+gray: "#808080"
+gainsboro: "#DCDCDC"
+lightgray: "#D3D3D3"
+silver: "#C0C0C0"
+darkgray: "#A9A9A9"
+dimgray: "#696969"
+lightslategray: "#778899"
+slategray: "#708090"
+darkslategray: "#2F4F4F"
+black: "#000000"