colordom 0.8.0-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4ad77aa114ee000cba996bd9f8b2f6c03b9c90a51b1abd27d2b23a357a57cbf
+  data.tar.gz: 8634b6159db5fca34d1e339c5567a488f87fbcdc6c3a33bc4ecec8ac21d175cd
+SHA512:
+  metadata.gz: 748820d4d341bb738f08b4b822dadb27aad560e2ccb9fe86e1d8837a3d7d0c375eb1a0fe453225e967981f379b4615ca9f63b907ebea74e720cc9219fa5c9157
+  data.tar.gz: 1a6f0886b944164a991b1084d0e4435570e73564d3e99cae416e736130b27bada6e4bee4bcd8751689e07cd9dc555df17e13ee36032e756ceac9a8fae7731573

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,37 @@
+# Code of Conduct
+
+All participants of this project are expected to abide by our Code of Conduct, both online and during in-person events that are hosted and/or associated with this project.
+
+## The Pledge
+
+In the interest of fostering an open and welcoming environment, we pledge to make 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.
+
+## The Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Referring to people by their preferred pronouns and using gender-neutral pronouns when uncertain
+* 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
+* Dismissing or attacking inclusion-oriented requests
+
+## Enforcement
+
+Violations of the Code of Conduct may be reported by sending an email to info@hardpixel.eu. All reports will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Further details of specific enforcement policies may be posted separately.
+
+We hold the right and responsibility to remove comments or other contributions that are not aligned to this Code of Conduct, or to suspend temporarily or permanently any members for other behaviors that are inappropriate, threatening, offensive, or harmful.
+
+## Attribution
+
+This Code of Conduct is adapted from [dev.to](https://dev.to/code-of-conduct).

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 jonian
+
+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,53 @@
+# Colordom
+
+Ruby gem to extract dominant colors from images using native extension implemented in Rust. Rust must be available on your system to install this gem.
+
+[![Gem Version](https://badge.fury.io/rb/colordom.svg)](https://badge.fury.io/rb/colordom)
+[![Build](https://github.com/hardpixel/colordom/actions/workflows/build.yml/badge.svg)](https://github.com/hardpixel/colordom/actions/workflows/build.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6040c6d79abf2d6e7efb/maintainability)](https://codeclimate.com/github/hardpixel/colordom/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'colordom'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install colordom
+
+## Usage
+
+```ruby
+require 'colordom'
+
+# Get colors using histogram algorithm
+Colordom.histogram(image_path)
+
+# Get colors using median cut algorithm
+Colordom.mediancut(image_path)
+
+# Get colors using kmeans algorithm
+Colordom.kmeans(image_path)
+```
+
+## 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/hardpixel/colordom.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/colordom/color.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Colordom
+  # Color object with RGB and HEX values implemented in Rust.
+  class Color
+    # @!method initialize(r, g, b)
+    # A new instance of Color.
+    # @return [Color]
+
+    # @!attribute [r] r
+    # Red color value.
+    # @return [Integer]
+
+    # @!attribute [r] g
+    # Green color value.
+    # @return [Integer]
+
+    # @!attribute [r] b
+    # Blue color value.
+    # @return [Integer]
+
+    # @!method rgb
+    # @!parse [ruby] alias to_rgb rgb
+    # Get the RGB representation of the color.
+    # @return [Array<Integer>]
+
+    # @!method hex
+    # @!parse [ruby] alias to_hex hex
+    # Get the hex representation of the color.
+    # @return [String]
+
+    # Compare with other color value.
+    # @param other [Color, Array<Integer>, String]
+    # @return [Boolean]
+
+    def ==(other)
+      case other
+      when Array
+        rgb == other
+      when String
+        hex == other
+      when self.class
+        rgb == other.rgb
+      else
+        false
+      end
+    end
+  end
+end

data/lib/colordom/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Colordom
+  class Error < StandardError
+  end
+end

data/lib/colordom/image.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Colordom
+  # Image object implemented in Rust that extracts dominant colors.
+  class Image
+    # @!method initialize(path)
+    # A new instance of Image.
+    # @param path [String, Pathname, File]
+    # @return [Image]
+    # @raise [Error] if path is not a valid image
+
+    # @!method histogram(max_colors)
+    # Get dominant colors using histogram quantization.
+    # @param max_colors [Integer]
+    # @return [Array<Color>]
+
+    # @!method mediancut(max_colors)
+    # Get dominant colors using median cut quantization.
+    # @param max_colors [Integer]
+    # @return [Array<Color>]
+
+    # @!method kmeans(max_colors)
+    # Get dominant colors using k-means clustering.
+    # @param max_colors [Integer]
+    # @return [Array<Color>]
+  end
+end

data/lib/colordom/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Colordom
+  VERSION = '0.8.0'
+end

data/lib/colordom.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "colordom/#{$1}/colordom"
+rescue LoadError
+  require 'colordom/colordom'
+end
+
+require 'colordom/error'
+require 'colordom/color'
+require 'colordom/image'
+require 'colordom/version'
+
+# Module that extracts dominant colors from images
+# using native extension implemented in Rust.
+module Colordom
+  class << self
+    # Get dominant colors using histogram quantization.
+    # @param path (see Image#initialize)
+    # @param max_colors (see Image#histogram)
+    # @return (see Image#histogram)
+    # @raise (see Image#initialize)
+
+    def histogram(path, max_colors = 5)
+      image = Image.new(path)
+      image.histogram(max_colors)
+    end
+
+    # Get dominant colors using median cut quantization.
+    # @param path (see Image#initialize)
+    # @param max_colors (see Image#mediancut)
+    # @return (see Image#mediancut)
+    # @raise (see Image#initialize)
+
+    def mediancut(path, max_colors = 5)
+      image = Image.new(path)
+      image.mediancut(max_colors)
+    end
+
+    # Get dominant colors using k-means clustering.
+    # @param path (see Image#initialize)
+    # @param max_colors (see Image#kmeans)
+    # @return (see Image#kmeans)
+    # @raise (see Image#initialize)
+
+    def kmeans(path, max_colors = 5)
+      image = Image.new(path)
+      image.kmeans(max_colors)
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: colordom
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: x86_64-linux
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Extract dominant colors from images using native extension implemented
+  in Rust.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/colordom.rb
+- lib/colordom/2.6/colordom.so
+- lib/colordom/2.7/colordom.so
+- lib/colordom/3.0/colordom.so
+- lib/colordom/3.1/colordom.so
+- lib/colordom/3.2/colordom.so
+- lib/colordom/color.rb
+- lib/colordom/error.rb
+- lib/colordom/image.rb
+- lib/colordom/version.rb
+homepage: https://github.com/hardpixel/colordom
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.3.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: Extract dominant colors from images
+test_files: []