rubohash 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21ae00543eb4f8f3b4a94616f1d730355e92635fdd95c5a0febc31b80fe2ae5f
+  data.tar.gz: 87b6ff9172dd54bce6fecd3af1b3ed739fc3e3887b13502ae349de934f5c765c
+SHA512:
+  metadata.gz: 03ee912152ae61bd84a5451c9f9f103cbdb0a620f5b35748d3a5aa47b2fa47718fe82af05185668d9ce5e2eced161fba045305cbc5baad6a7d6c4fe016233541
+  data.tar.gz: e5ceb38b5d5b72213dc8e6ddcb608cc35af29af30bcd4cb309403ba59df255de597837aa2791a5b6ecdd8108317d5d7e8d89a388f290afb444cd63fa96339519

data/.github/workflows/gem-push.yml

@@ -0,0 +1,46 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2.2'
+        bundler-cache: true
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,38 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-11-16 13:57:57 -0700 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 39
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 29
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 137
+
+# Offense count: 15
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 229
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 33
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/rubohash/factory.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

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 rubohash.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    rubohash (0.1.1)
+      mini_magick (~> 4.9.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.9)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    bigdecimal (4.0.1)
+    diff-lcs (1.3)
+    json (2.19.2)
+    json-schema (6.2.0)
+      addressable (~> 2.8)
+      bigdecimal (>= 3.1, < 5)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    mcp (0.8.0)
+      json-schema (>= 4.1)
+    mini_magick (4.9.5)
+    parallel (1.12.1)
+    parser (3.3.10.2)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    public_suffix (7.0.5)
+    racc (1.8.1)
+    rainbow (2.2.2)
+      rake
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.85.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      mcp (~> 0.6)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.4)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (>= 1.60, < 2.0)
+  rubohash!
+  yard (~> 0.9, >= 0.9.20)
+
+BUNDLED WITH
+   2.7.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mark Holmberg
+
+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,75 @@
+# Rubohash
+
+A ruby implementation for generating unique images based on the checksum of a given string.
+
+## Installation
+
+Add it to your Gemfile from GitHub:
+
+```rb
+gem 'rubohash', github: 'nedzib/rubohash', group: :development
+```
+
+For reproducible installs, prefer pinning a ref:
+
+```rb
+gem 'rubohash', github: 'nedzib/rubohash', tag: 'v0.1.0', group: :development
+```
+
+By default, generated files are written to `./output` from your current working directory.
+
+For local development in this repository, you can use `./bin/build.sh`.
+
+## Usage
+
+From Ruby code:
+
+```rb
+  Rubohash.assemble!("my_test_string_here")
+```
+
+To generate transparent PNGs without background composition:
+
+```rb
+Rubohash.configure do |config|
+  config.use_background = false
+end
+
+Rubohash.assemble!("my_test_string_here")
+```
+
+This will run the algorithm and output the file to `@robot_output_path`. You also need to have ImageMagick installed on your system.
+
+From the command line:
+
+```sh
+rubohash my_test_string_here
+rubohash my_test_string_here --output ./tmp/robots --format jpg
+rubohash my_test_string_here --no-background
+```
+
+Rubohash can also be mounted inside a Rails application by setting `mounted` to `true`.
+
+## Cleaning Up
+
+You should be able to completely uninstall the gem by running:
+
+```sh
+  ./bin/clean.sh
+```
+
+## License and Attribution
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+### Derivation Notice! :
+
+The images are licensed under Creative Commons by attribution
+
+> Robots lovingly provided by robohash.org
+
+This ruby gem is a derivation of the python repository at: https://github.com/e1ven/Robohash
+
+> The Python Code is available under the MIT/Expat license. See the LICENSE.txt file for the full text of this license. Copyright (c) 2011, Colin Davis.
+
+> The RoboHash images are available under the CC-BY-3.0 license.

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/build.sh

@@ -0,0 +1,17 @@
+#!/bin/bash -
+echo "Starting Install of Rubohash..."
+source ./bin/install.sh
+
+irb -r 'rubohash'
+
+# TODO: You can set the configuration options for Rubohash here
+# Rubohash.configure do |c|
+#   c.default_extensions = %w[.png .gif .jpg .bmp .jpeg .ppm .datauri]
+#   c.default_set        = "set1"
+#   c.use_default_set    = false
+#   c.robot_output_path  = '/Users/mark/dev/backend-tools/rubohash/output/'
+#   c.default_format     = 'png'
+#   c.default_bg_set     = 'bg1'
+#   c.use_default_bg_set = false
+#   c.mounted            = false
+# end

data/bin/clean.sh

@@ -0,0 +1,18 @@
+#!/bin/bash -
+echo "Uninstalling Gem"
+gem uninstall rubohash
+
+# Find version number
+GEM_VERSION=$(grep -E "(VERSION =\s'[0-9]+.[0-9]+.[0-9]+')" ./lib/rubohash/version.rb | grep -Eo "([0-9]+.[0-9]+.[0-9]+)")
+
+if [ -f "rubohash-$GEM_VERSION.gem" ]; then
+  echo "Removing source gem"
+  rm rubohash-$GEM_VERSION.gem
+fi
+
+if [ -d 'output/' ]; then
+  echo "Nuking Output Folder"
+  rm -Rf output
+  mkdir output
+  touch output/.gitkeep
+fi

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rubohash'
+
+# 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/document.sh

@@ -0,0 +1,7 @@
+#!/bin/bash -
+
+echo "Generating documentation..."
+yardoc .
+
+echo "Finding missing documentation..."
+yard stats . --list-undoc

data/bin/install.sh

@@ -0,0 +1,9 @@
+#!/bin/bash -
+echo "Building Gemspec..."
+gem build rubohash.gemspec
+
+# Find version number
+GEM_VERSION=$(grep -E "(VERSION =\s'[0-9]+.[0-9]+.[0-9]+')" ./lib/rubohash/version.rb | grep -Eo "([0-9]+.[0-9]+.[0-9]+)")
+
+echo "Installing Gem..."
+gem install rubohash-$GEM_VERSION.gem --local

data/bin/police.sh

@@ -0,0 +1,11 @@
+#!/bin/bash -
+# Does an rspec, yard, and rubocop call
+
+echo "Running R-Spec..."
+bundle exec rspec spec/
+
+echo "Running YARD..."
+bundle exec yard stats --list-undoc
+
+echo "Running Rubocop..."
+bundle exec rubocop .

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/exe/rubohash

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rubohash'
+
+options = {
+  output: Rubohash.robot_output_path,
+  format: Rubohash.default_format,
+  background: Rubohash.use_background
+}
+
+parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: rubohash INPUT [options]'
+
+  opts.on('-o', '--output PATH', 'Output directory') { |v| options[:output] = v }
+  opts.on('-f', '--format FORMAT', 'Image format (png, jpg, gif, ...)') { |v| options[:format] = v }
+  opts.on('--[no-]background', 'Enable or disable background composition') { |v| options[:background] = v }
+end
+
+parser.parse!
+input = ARGV.shift
+
+if input.nil? || input.empty?
+  warn parser.to_s
+  exit 1
+end
+
+Rubohash.configure do |config|
+  config.robot_output_path = File.expand_path(options[:output])
+  config.default_format = options[:format]
+  config.use_background = options[:background]
+end
+
+robot = Rubohash.assemble!(input)
+puts File.join(Rubohash.robot_output_path, "#{robot.name}.#{options[:format]}")