swatchman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56354a93a4c024f57eb519c087816d098235a1cb6bee53d2c088d287856efffc
+  data.tar.gz: f6325a28b81d059e537cb0da7c3bf7f38b3227fad401bb69784694a56277336d
+SHA512:
+  metadata.gz: bafe1fcc02e4425e9ac51c48d8e3b596dd94196cc8aac345f20557335c98c56f87a69bbe9814da3e774a45e9c8ef2f824c75c421db8ed95cef6a7ebf9664f8ad
+  data.tar.gz: 25c0be6e5f884ade52348caf19916a77fb481bfe5922b830ebf27a993bac1b4b2894d7f88d015c4fc75738f09e036832a9b0e0aef904ce64f644f7231c04354a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

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 jamie@thelucid.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in swatchman.gemspec
+gemspec
+
+group :test do
+  gem 'minitest', '~> 5.0'
+  gem 'simplecov', '>= 0.21.2', require: false
+end
+
+gem "rake", "~> 12.0"
+gem 'rubocop', '~> 1.8', require: false

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    swatchman (0.1.0)
+      mini_magick (~> 4.11.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docile (1.3.5)
+    mini_magick (4.11.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rubocop (~> 1.8)
+  simplecov (>= 0.21.2)
+  swatchman!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jamie Hill
+
+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,60 @@
+# Swatchman
+
+Simple gem for extracting swatches from an image with MiniMagick. Allows you to specify the number of swatches to extract.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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 `swatches` named parameter to adjust the number of swatches returned.
+
+### From a URL
+
+```ruby
+Swatchman::Image.new('https://example.com/file.jpg').palette.swatches
+```
+
+### From a File
+
+```ruby
+Swatchman::Image.new('/some/file/path.png').palette.swatches
+```
+
+### Custom number of swatches
+
+```ruby
+Swatchman::Image.new('/some/file/path.png').palette(size: 5).swatches
+```
+
+## 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](https://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](https://github.com/[USERNAME]/swatchman/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+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 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

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swatchman"
+
+# 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/lib/swatchman.rb

@@ -0,0 +1,5 @@
+require 'swatchman/version'
+require 'swatchman/image'
+
+module Swatchman
+end

data/lib/swatchman/image.rb

@@ -0,0 +1,31 @@
+require 'mini_magick'
+require 'swatchman/palette'
+
+module Swatchman
+  class Image
+    def initialize(path_or_url)
+      @resource = MiniMagick::Image.open(path_or_url)
+    end
+
+    def palette(size: 3)
+      Swatchman::Palette.new(
+        resource.run_command(
+          'convert',
+          resource.path,
+          '-format',
+          '%c',
+          '-colors',
+          size,
+          '-depth',
+          8,
+          'histogram:info:'
+        ),
+        size
+      )
+    end
+
+    private
+
+    attr_reader :resource
+  end
+end

data/lib/swatchman/palette.rb

@@ -0,0 +1,29 @@
+require 'swatchman/swatch'
+
+module Swatchman
+  class Palette
+    MATCH = /([0-9]+)\:.*(\#[0-9ABCDEF]{6})/
+    
+    def initialize(histogram, size)
+      @histogram = histogram
+      @size = size
+    end
+
+    def swatches
+      swatches = histogram.scan(MATCH).map do |frequency, color|
+        Swatch.new(color, frequency.to_i)
+      end
+      
+      total = swatches.map(&:frequency).reduce(:+).to_f
+
+      swatches
+        .sort_by { |swatch| swatch.frequency / total }
+        .reverse
+        .slice(0, size)
+    end
+
+    private
+
+    attr_reader :histogram, :size
+  end
+end

data/lib/swatchman/swatch.rb

@@ -0,0 +1,10 @@
+module Swatchman
+  class Swatch
+    attr_reader :color, :frequency
+
+    def initialize(color, frequency)
+      @color = color.downcase
+      @frequency = frequency
+    end
+  end
+end

data/lib/swatchman/version.rb

@@ -0,0 +1,3 @@
+module Swatchman
+  VERSION = "0.1.0"
+end

data/swatchman.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/swatchman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swatchman"
+  spec.version       = Swatchman::VERSION
+  spec.authors       = ["Jamie Hill"]
+  spec.email         = ["j.hill@livelinktechnology.net"]
+
+  spec.summary       = %q{Simple gem for extracting swatches from an image with MiniMagick.}
+  spec.description   = %q{Simple gem for extracting swatches from an image with MiniMagick. Allows you to specify the number of swatches to extract.}
+  spec.homepage      = "https://github.com/livelink/swatchman"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/livelink/swatchman"
+
+  # 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"]
+  
+  spec.add_dependency "mini_magick", "~> 4.11.0"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: swatchman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Hill
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+description: Simple gem for extracting swatches from an image with MiniMagick. Allows
+  you to specify the number of swatches to extract.
+email:
+- j.hill@livelinktechnology.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swatchman.rb
+- lib/swatchman/image.rb
+- lib/swatchman/palette.rb
+- lib/swatchman/swatch.rb
+- lib/swatchman/version.rb
+- swatchman.gemspec
+homepage: https://github.com/livelink/swatchman
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/livelink/swatchman
+  source_code_uri: https://github.com/livelink/swatchman
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple gem for extracting swatches from an image with MiniMagick.
+test_files: []