swatchman 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +8 -0
- data/.travis.yml +6 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +12 -0
- data/Gemfile.lock +52 -0
- data/LICENSE.txt +21 -0
- data/README.md +60 -0
- data/Rakefile +10 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/swatchman.rb +5 -0
- data/lib/swatchman/image.rb +31 -0
- data/lib/swatchman/palette.rb +29 -0
- data/lib/swatchman/swatch.rb +10 -0
- data/lib/swatchman/version.rb +3 -0
- data/swatchman.gemspec +28 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 56354a93a4c024f57eb519c087816d098235a1cb6bee53d2c088d287856efffc
|
4
|
+
data.tar.gz: f6325a28b81d059e537cb0da7c3bf7f38b3227fad401bb69784694a56277336d
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: bafe1fcc02e4425e9ac51c48d8e3b596dd94196cc8aac345f20557335c98c56f87a69bbe9814da3e774a45e9c8ef2f824c75c421db8ed95cef6a7ebf9664f8ad
|
7
|
+
data.tar.gz: 25c0be6e5f884ade52348caf19916a77fb481bfe5922b830ebf27a993bac1b4b2894d7f88d015c4fc75738f09e036832a9b0e0aef904ce64f644f7231c04354a
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at jamie@thelucid.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
source "https://rubygems.org"
|
2
|
+
|
3
|
+
# Specify your gem's dependencies in swatchman.gemspec
|
4
|
+
gemspec
|
5
|
+
|
6
|
+
group :test do
|
7
|
+
gem 'minitest', '~> 5.0'
|
8
|
+
gem 'simplecov', '>= 0.21.2', require: false
|
9
|
+
end
|
10
|
+
|
11
|
+
gem "rake", "~> 12.0"
|
12
|
+
gem 'rubocop', '~> 1.8', require: false
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
swatchman (0.1.0)
|
5
|
+
mini_magick (~> 4.11.0)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
ast (2.4.2)
|
11
|
+
docile (1.3.5)
|
12
|
+
mini_magick (4.11.0)
|
13
|
+
minitest (5.14.3)
|
14
|
+
parallel (1.20.1)
|
15
|
+
parser (3.0.0.0)
|
16
|
+
ast (~> 2.4.1)
|
17
|
+
rainbow (3.0.0)
|
18
|
+
rake (12.3.3)
|
19
|
+
regexp_parser (2.0.3)
|
20
|
+
rexml (3.2.4)
|
21
|
+
rubocop (1.9.1)
|
22
|
+
parallel (~> 1.10)
|
23
|
+
parser (>= 3.0.0.0)
|
24
|
+
rainbow (>= 2.2.2, < 4.0)
|
25
|
+
regexp_parser (>= 1.8, < 3.0)
|
26
|
+
rexml
|
27
|
+
rubocop-ast (>= 1.2.0, < 2.0)
|
28
|
+
ruby-progressbar (~> 1.7)
|
29
|
+
unicode-display_width (>= 1.4.0, < 3.0)
|
30
|
+
rubocop-ast (1.4.1)
|
31
|
+
parser (>= 2.7.1.5)
|
32
|
+
ruby-progressbar (1.11.0)
|
33
|
+
simplecov (0.21.2)
|
34
|
+
docile (~> 1.1)
|
35
|
+
simplecov-html (~> 0.11)
|
36
|
+
simplecov_json_formatter (~> 0.1)
|
37
|
+
simplecov-html (0.12.3)
|
38
|
+
simplecov_json_formatter (0.1.2)
|
39
|
+
unicode-display_width (2.0.0)
|
40
|
+
|
41
|
+
PLATFORMS
|
42
|
+
ruby
|
43
|
+
|
44
|
+
DEPENDENCIES
|
45
|
+
minitest (~> 5.0)
|
46
|
+
rake (~> 12.0)
|
47
|
+
rubocop (~> 1.8)
|
48
|
+
simplecov (>= 0.21.2)
|
49
|
+
swatchman!
|
50
|
+
|
51
|
+
BUNDLED WITH
|
52
|
+
2.1.4
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2021 Jamie Hill
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
# Swatchman
|
2
|
+
|
3
|
+
Simple gem for extracting swatches from an image with MiniMagick. Allows you to specify the number of swatches to extract.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'swatchman'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle install
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install swatchman
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Swatchman will return 3 swatches by default. Specify the `swatches` named parameter to adjust the number of swatches returned.
|
24
|
+
|
25
|
+
### From a URL
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
Swatchman::Image.new('https://example.com/file.jpg').palette.swatches
|
29
|
+
```
|
30
|
+
|
31
|
+
### From a File
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
Swatchman::Image.new('/some/file/path.png').palette.swatches
|
35
|
+
```
|
36
|
+
|
37
|
+
### Custom number of swatches
|
38
|
+
|
39
|
+
```ruby
|
40
|
+
Swatchman::Image.new('/some/file/path.png').palette(size: 5).swatches
|
41
|
+
```
|
42
|
+
|
43
|
+
## Development
|
44
|
+
|
45
|
+
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.
|
46
|
+
|
47
|
+
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).
|
48
|
+
|
49
|
+
## Contributing
|
50
|
+
|
51
|
+
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](https://github.com/[USERNAME]/swatchman/blob/master/CODE_OF_CONDUCT.md).
|
52
|
+
|
53
|
+
|
54
|
+
## License
|
55
|
+
|
56
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
57
|
+
|
58
|
+
## Code of Conduct
|
59
|
+
|
60
|
+
Everyone interacting in the Swatchman project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/swatchman/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "swatchman"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/lib/swatchman.rb
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
require 'mini_magick'
|
2
|
+
require 'swatchman/palette'
|
3
|
+
|
4
|
+
module Swatchman
|
5
|
+
class Image
|
6
|
+
def initialize(path_or_url)
|
7
|
+
@resource = MiniMagick::Image.open(path_or_url)
|
8
|
+
end
|
9
|
+
|
10
|
+
def palette(size: 3)
|
11
|
+
Swatchman::Palette.new(
|
12
|
+
resource.run_command(
|
13
|
+
'convert',
|
14
|
+
resource.path,
|
15
|
+
'-format',
|
16
|
+
'%c',
|
17
|
+
'-colors',
|
18
|
+
size,
|
19
|
+
'-depth',
|
20
|
+
8,
|
21
|
+
'histogram:info:'
|
22
|
+
),
|
23
|
+
size
|
24
|
+
)
|
25
|
+
end
|
26
|
+
|
27
|
+
private
|
28
|
+
|
29
|
+
attr_reader :resource
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
require 'swatchman/swatch'
|
2
|
+
|
3
|
+
module Swatchman
|
4
|
+
class Palette
|
5
|
+
MATCH = /([0-9]+)\:.*(\#[0-9ABCDEF]{6})/
|
6
|
+
|
7
|
+
def initialize(histogram, size)
|
8
|
+
@histogram = histogram
|
9
|
+
@size = size
|
10
|
+
end
|
11
|
+
|
12
|
+
def swatches
|
13
|
+
swatches = histogram.scan(MATCH).map do |frequency, color|
|
14
|
+
Swatch.new(color, frequency.to_i)
|
15
|
+
end
|
16
|
+
|
17
|
+
total = swatches.map(&:frequency).reduce(:+).to_f
|
18
|
+
|
19
|
+
swatches
|
20
|
+
.sort_by { |swatch| swatch.frequency / total }
|
21
|
+
.reverse
|
22
|
+
.slice(0, size)
|
23
|
+
end
|
24
|
+
|
25
|
+
private
|
26
|
+
|
27
|
+
attr_reader :histogram, :size
|
28
|
+
end
|
29
|
+
end
|
data/swatchman.gemspec
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
require_relative 'lib/swatchman/version'
|
2
|
+
|
3
|
+
Gem::Specification.new do |spec|
|
4
|
+
spec.name = "swatchman"
|
5
|
+
spec.version = Swatchman::VERSION
|
6
|
+
spec.authors = ["Jamie Hill"]
|
7
|
+
spec.email = ["j.hill@livelinktechnology.net"]
|
8
|
+
|
9
|
+
spec.summary = %q{Simple gem for extracting swatches from an image with MiniMagick.}
|
10
|
+
spec.description = %q{Simple gem for extracting swatches from an image with MiniMagick. Allows you to specify the number of swatches to extract.}
|
11
|
+
spec.homepage = "https://github.com/livelink/swatchman"
|
12
|
+
spec.license = "MIT"
|
13
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
|
14
|
+
|
15
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
16
|
+
spec.metadata["source_code_uri"] = "https://github.com/livelink/swatchman"
|
17
|
+
|
18
|
+
# Specify which files should be added to the gem when it is released.
|
19
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
20
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
21
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
22
|
+
end
|
23
|
+
spec.bindir = "exe"
|
24
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
25
|
+
spec.require_paths = ["lib"]
|
26
|
+
|
27
|
+
spec.add_dependency "mini_magick", "~> 4.11.0"
|
28
|
+
end
|
metadata
ADDED
@@ -0,0 +1,76 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: swatchman
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Jamie Hill
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-02-11 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: mini_magick
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 4.11.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 4.11.0
|
27
|
+
description: Simple gem for extracting swatches from an image with MiniMagick. Allows
|
28
|
+
you to specify the number of swatches to extract.
|
29
|
+
email:
|
30
|
+
- j.hill@livelinktechnology.net
|
31
|
+
executables: []
|
32
|
+
extensions: []
|
33
|
+
extra_rdoc_files: []
|
34
|
+
files:
|
35
|
+
- ".gitignore"
|
36
|
+
- ".travis.yml"
|
37
|
+
- CODE_OF_CONDUCT.md
|
38
|
+
- Gemfile
|
39
|
+
- Gemfile.lock
|
40
|
+
- LICENSE.txt
|
41
|
+
- README.md
|
42
|
+
- Rakefile
|
43
|
+
- bin/console
|
44
|
+
- bin/setup
|
45
|
+
- lib/swatchman.rb
|
46
|
+
- lib/swatchman/image.rb
|
47
|
+
- lib/swatchman/palette.rb
|
48
|
+
- lib/swatchman/swatch.rb
|
49
|
+
- lib/swatchman/version.rb
|
50
|
+
- swatchman.gemspec
|
51
|
+
homepage: https://github.com/livelink/swatchman
|
52
|
+
licenses:
|
53
|
+
- MIT
|
54
|
+
metadata:
|
55
|
+
homepage_uri: https://github.com/livelink/swatchman
|
56
|
+
source_code_uri: https://github.com/livelink/swatchman
|
57
|
+
post_install_message:
|
58
|
+
rdoc_options: []
|
59
|
+
require_paths:
|
60
|
+
- lib
|
61
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
62
|
+
requirements:
|
63
|
+
- - ">="
|
64
|
+
- !ruby/object:Gem::Version
|
65
|
+
version: 2.3.0
|
66
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
67
|
+
requirements:
|
68
|
+
- - ">="
|
69
|
+
- !ruby/object:Gem::Version
|
70
|
+
version: '0'
|
71
|
+
requirements: []
|
72
|
+
rubygems_version: 3.1.2
|
73
|
+
signing_key:
|
74
|
+
specification_version: 4
|
75
|
+
summary: Simple gem for extracting swatches from an image with MiniMagick.
|
76
|
+
test_files: []
|