colorpress 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4029097c4dd27546952ad3d3a951379fbb393ff5666f80948b28737fd7c43eaf
+  data.tar.gz: 2fcb97f0274c7e65a425a34faf123ab8e7a53151f097141f132c2734febc9892
+SHA512:
+  metadata.gz: 0b22f563cec3b89010a9b1d5dd09d0b77b97486f852d03dc3dae8a330445d6318e7f54d4df216ba4423f50aaf97d61fe5d2b8b5f8b4488de5779a824670f4249
+  data.tar.gz: f8c3016b99fd5759542a55d31707536ef6b744d33327a4f9a9c05d0a8d1e40428970c59b80482f79ae1fff4ae0aaaf073b5a413578b6d170da58aaab3dbbff61

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in colorpress.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Luc Street
+
+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,30 @@
+# colorpress
+
+## Usage
+
+Encode bytes of a file to PNG format:
+```ruby
+Colorpress::encode('file.txt') # creates file.txt.png, minimum width 50 px
+Colorpress::encode('file.txt', 'out.png', min_width=100) # creates out.png, minimum width 100 px
+```
+Decode bytes of a PNG back into character data:
+```ruby
+Colorpress::decode('file.txt.png') # creates file.txt, deletes file.txt.png
+Colorpress::decode('file.txt.png', cleanup=false) # creates file.txt, keeps file.txt.png
+Colorpress::decode('out.png', 'original.txt') # creates original.txt, deletes out.png
+```
+Documentation for all methods can be generated by running `yard doc` in a development environment.
+
+## 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/lucis-fluxum/colorpress. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
+
+## License
+
+This gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end
+desc 'Run tests'
+
+task default: :test

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/colorpress.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'colorpress/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'colorpress'
+  spec.version = Colorpress::VERSION
+  spec.authors = ['Luc Street']
+
+  spec.summary = 'Visualize arbitrary files as PNG images'
+  spec.homepage = 'https://github.com/lucis-fluxum/colorpress'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.1.2'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'yard', '~> 0.9.24'
+  spec.add_development_dependency 'minitest', '~> 5.14.0'
+
+  spec.add_dependency 'chunky_png', '~> 1.3.11'
+end

data/lib/colorpress.rb

@@ -0,0 +1,97 @@
+require 'chunky_png'
+require 'colorpress/version'
+
+module Colorpress
+  # Encode a file to PNG format.
+  #
+  # @param file_name [String] the name of the file to encode
+  # @param output_name [String, nil] the optional name of the output file
+  # @param min_width [Integer] the minimum width of the image, in pixels
+  def self.encode(file_name, output_name=nil, min_width=50)
+    file_size = File.stat(file_name).size
+    # Increase width until it divides number of bytes evenly
+    while file_size % min_width != 0
+      min_width += 1
+    end
+    image = ChunkyPNG::Image.new(min_width, file_size/min_width)
+
+    y = 0
+    read_bytes(file_name, min_width) do |buffer|
+      unpacked_data = buffer.unpack('C*')
+      unpacked_data.each_with_index do |value, index|
+        # Randomly pick between red/green/blue
+        rgb = [0, 0, 0]
+        rgb[(rand * 3).to_i] = value
+        image[index, y] = ChunkyPNG::Color.rgb(*rgb)
+      end
+      y += 1
+    end
+
+    image.save(output_name.nil? ? file_name + '.png' : output_name)
+  end
+
+  # Decode a file from PNG format.
+  #
+  # @param image_name [String] the name of the image to decode, ex: 'filename.txt.png'
+  # @param output_name [String, nil] the name of the output file (no extension needed), ex: 'my_file'
+  # @param cleanup [Boolean] whether to delete PNG file after decoding
+  def self.decode(image_name, output_name=nil, cleanup=true)
+    output_name = image_name[0...-4] unless output_name # Remove .png extension
+    image = ChunkyPNG::Image.from_file(image_name)
+
+    write_data(output_name, '', true) # Make sure the output file is empty
+
+    bytes = []
+    (0..image.dimension.height-1).each do |y|
+      (0..image.dimension.width-1).each do |x|
+        # It's either red, green, or blue, so add them all
+        bytes << ChunkyPNG::Color.r(image[x, y]) +
+          ChunkyPNG::Color.g(image[x, y]) +
+          ChunkyPNG::Color.b(image[x, y])
+      end
+      write_data(output_name, bytes)
+      bytes = []
+    end
+
+    write_data(output_name, bytes) if bytes.any? # Write if any bytes still in array
+
+    File.delete(image_name) if cleanup
+  end
+
+  private
+
+  # Reads bytes from a file into a buffer, yielding the buffer to a given block.
+  #
+  # @param filename [String] the name of the file to read
+  # @param buffer_size[Integer, nil]
+  #   amount of bytes to read into the buffer at a time
+  #
+  # @example Reading all of a file
+  #   other_bytes = ''
+  #   Colorpress::FileIO.read_bytes('filename.txt', 20) do |buffer|
+  #     other_bytes += buffer
+  #   end
+  #   # other_bytes now contains all bytes of the file
+  def self.read_bytes(filename, buffer_size=20)
+    File.open(filename, 'rb') do |file|
+      until file.eof? do
+        buffer = file.read(buffer_size)
+        yield buffer
+      end
+    end
+  end
+
+  # Writes the given data to the given filename. Truncates the file if desired.
+  #
+  # @param filename [String] the name of the file to write
+  # @param data [String, Array] the data to write to the file,
+  #   it may be a string or an array of bytes
+  # @param truncate [Boolean] whether or not to empty the file before writing
+  def self.write_data(filename, data, truncate=false)
+    mode = truncate ? 'wb' : 'ab'
+    File.open(filename, mode) do |file|
+      data = data.pack('C*') if data.is_a? Array
+      file.write(data)
+    end
+  end
+end

data/lib/colorpress/version.rb

@@ -0,0 +1,3 @@
+module Colorpress
+  VERSION = '2.0.0'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: colorpress
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Luc Street
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+description: 
+email: 
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- colorpress.gemspec
+- lib/colorpress.rb
+- lib/colorpress/version.rb
+homepage: https://github.com/lucis-fluxum/colorpress
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Visualize arbitrary files as PNG images
+test_files: []