Project

swatchman

0.0
No commit activity in last 3 years
No release in over 3 years
swatchmanlivelink/swatchmanHomepageDocumentationSource CodeBug TrackerWiki
Simple gem for extracting swatches from an image with MiniMagick. Allows you to specify the number of swatches to extract.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
4,901
Stars
1
Forks
0
Watchers
5
 Releases
Current version
0.3.0
Total releases
3
First release
2021-02-11
Latest release
2021-02-12
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2021-02-11
Reverse Dependencies
0

 Dependencies

Runtime

mini_magick
~> 4.11.0
 Project Readme

Swatchman

Simple gem for extracting swatches from an image with MiniMagick. Allows you to specify the number of swatches to extract.

Dependencies

This gem makes use of the mini_magick gem, and therefore requires an installation of ImageMagick.

Installation

Add this line to your application's Gemfile:

gem 'swatchman'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install swatchman

Usage

Swatchman will return 3 swatches by default. Specify the size named parameter when calling the palette method to adjust the number of swatches returned.

swatch has a method for calculating the percentage which recieves one paramater being the total this can be retrieved through palette.total.

From a URL

Swatchman::Image.new('https://example.com/file.jpg').palette.swatches

From a File

Swatchman::Image.new('/some/file/path.png').palette.swatches

Custom number of swatches

Swatchman::Image.new('/some/file/path.png').palette(size: 5).swatches

API

Swatchman::Image

new(path_or_url)

Parameters
  • path_or_url (String) — A local file system path, or URL.
Returns
  • Swatchman::Image — Image instance.

palette(size: 3)

Parameters
  • size (Integer) — The amount of swatches this palette should contain. Defaults to 3.
Returns
  • Swatchman::Palette — Palette instance.

Swatchman::Palette

new(histogram, size)

Parameters
  • histogram (String) — An ImageMagick histogram string.
  • size (String) — The amount of swatches in the palette.
Returns
  • Swatchman::Palette — Palette instance.

size

Returns
  • Integer — The number of swatches in the palette.

swatches

Returns
  • Array — Array of Swatchman::Swatch instances.

Swatchman::Swatch

new(color, frequency)

Parameters
  • color — The hex color value.
  • frequency — The frequency it appears within the image.
Returns
  • Swatchman::Swatch — Swatch instance.

color

Returns
  • String — Hex color value.

frequency

Returns
  • Integer — The frequency it appears.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swatchman. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Swatchman project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.