pixelchart 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adb12fcdae7b3b9b31e255e10e95a6eb060cf7e9ef08fa900b3ec141468660d9
+  data.tar.gz: 485112259502b71d2c83db71d3e90cf2937bdfcba7d3faac24488ecc7d89eb0b
+SHA512:
+  metadata.gz: 55509fb90bc7113e81f135f630eec895106a9bb903549b24d6d1dab9229d8c229d023840eec93fa3aa57bd1590d8c19216e1e640ebb987cd230994edd5cf7ddf
+  data.tar.gz: bccbb03b7030e8ca398255f1dd8e91f7d3ede15551449460f071dbdff36d20d34f768536f527de0fabb4aef142ce8a87a5316b37c78843c56de4692e8bcb1d67

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-2020 Alexandre ZANNI
+
+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/bin/pixelchart

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Ruby internal
+require 'pp'
+# Project internal
+require 'pixelchart'
+# External
+require 'docopt'
+require 'paint'
+
+doc = <<~DOCOPT
+  PixelChart - Map binary data into a beautiful chart
+
+  Usage:
+    pixelchart draw <input> <output> (--width <pixel> --height <pixel>) [--colors <colors>] [--backend <name>] [--scale <ratio>] [--no-color] [--debug]
+    pixelchart calc (--area <size>|<input>) [--no-color] [--debug]
+    pixelchart -H | --help
+    pixelchart -V | --version
+
+  Options:
+    <input>                         Input file containing values
+    <output>                        Output image (filename)
+    -w <pixel>, --width <pixel>     Width of the output image (in number pixel)
+    -h <pixel>, --height <pixel>    Height of the output image (in number pixel)
+    -c <colors>, --colors <colors>  Colors of the image (in RGB or random)
+    -b <name>, --backend <name>     Image processing backend (rmagick or ruby-vips)
+    -s <ratio>, --scale <ratio>     Scale ratio or dimensions
+    --area <size>                   Area, number of values, total number of pixel
+    --no-color      Disable colorized output
+    --debug         Display arguments
+    -H, --help      Show this screen
+    -V, --version   Show version
+
+  Examples:
+    pixelchart draw test.csv test.png -w 100 -h 100
+    pixelchart draw test.csv test.png -w 100 -h 100 -c 'random|125,125,125' -b rubyvips
+    pixelchart calc test.csv
+    pixelchart calc --area 10000 --no-color
+DOCOPT
+
+begin
+  args = Docopt.docopt(doc, version: PixelChart::VERSION)
+  pp args if args['--debug']
+  Paint.mode = 0 if args['--no-color']
+  if args['draw']
+    data = PixelChart.load_file(args['<input>'])
+    width = args['--width'].to_i
+    height = args['--height'].to_i
+    filename = args['<output>']
+    opts = {}
+    if args['--colors']
+      colors = args['--colors'].split('|')
+      colors.each_with_index do |col, i|
+        colors[i] = if col == 'random'
+                      col.to_sym
+                    else
+                      colors[i] = col.split(',').map(&:to_i)
+                    end
+      end
+      opts[:colors] = colors
+    end
+    opts[:backend] = args['--backend'].to_sym if args['--backend']
+    if args['--scale']
+      opts[:scale] =  if /,/.match?(args['--scale']) # dimensions
+                        args['--scale'].split(',').map(&:to_i)
+                      else # ratio
+                        args['--scale'].to_f
+                      end
+    end
+    pc = PixelChart.new(data, width, height, opts)
+    pc.draw(filename, opts)
+    puts Paint['[+]', :green] + ' Image saved'
+  elsif args['calc']
+    dimensions = nil
+    if args['--area']
+      dimensions = PixelChart.dimensions(args['--area'].to_i)
+    elsif args['<input>']
+      data = PixelChart.load_file(args['<input>'])
+      dimensions = PixelChart.dimensions(data.size)
+    end
+    puts 'Possible dimensions: width x height or height x width'
+    dimensions.each do |xy|
+      puts Paint[xy[0], :magenta] + ' x ' + Paint[xy[1], :magenta]
+    end
+  end
+rescue Docopt::Exit => e
+  puts e.message
+end

data/lib/pixelchart.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+# Ruby internal
+require 'set'
+# Project internal
+require 'pixelchart/version'
+# External
+require 'rmagick'
+require 'vips'
+
+# PixelChart class
+class PixelChart
+  # Constants
+  include Version
+
+  # A new instance of PixelChart
+  # @param data [Array<Boolean>] An array containing values
+  #   (0, 1) used to generate the image.
+  # @param width [Integer] Desired width of the image.
+  # @param height [Integer] Desired height of the image.
+  # @option opts [Array<Color>] :colors Must be an array containing 2 values.
+  #   Each value is either the +:random+ symbol to get a random color or a
+  #   color given as RGB, so 3 integers in an array.
+  # @option opts [Scale] :scale Scale the image to dimensions or with a ratio.
+  #   Ratio must be a positive (non-nul) float or integer, and dimensions must
+  #   be a set of width and height separated by a comma.
+  def initialize(data, width, height, opts = {})
+    @width = check_int(width)
+    @height = check_int(height)
+    @data = check_data(data)
+    opts[:colors] ||= [[255, 255, 255], [0, 0, 0]] # white, black
+    check_colors(opts[:colors])
+    opts[:colors].each_with_index do |color, i|
+      opts[:colors][i] = (0..2).map { |_x| rand(256) } if color == :random
+    end
+    @colors = opts[:colors]
+    opts[:scale] ||= nil
+    @scale = opts[:scale]
+  end
+
+  # Generate and save the image
+  # @param filename [String] Name of the output image.
+  # @param opts [Hash] options for image processing
+  # @option opts [Symbol] :backend Image processing backend, +:rmagick+ for
+  #   Rmagick/Imagemagick or +:rubyvips+ for ruby-vips/libvips.
+  def draw(filename, opts = {})
+    opts[:backend] ||= :rmagick
+    backend = check_backend(opts[:backend])
+    if backend == :rmagick
+      draw_rmagick(filename)
+    elsif backend == :rubyvips
+      draw_rubyvips(filename)
+    end
+  end
+
+  # Calculate the possible dimensions (width, height) for a given area
+  # @param area [Integer] number of values, total of pixels
+  # @return [Array<Array<Integer>>] Array of possible dimensions
+  def self.dimensions(area)
+    dim = []
+    (1..Math.sqrt(area).to_i).each do |x|
+      y, rem = area.divmod(x)
+      dim.push([x, y]) if rem.zero?
+    end
+    dim
+  end
+
+  # Calculate the possible dimensions (width, height) for the data of the object
+  # @return [Array<Array<Integer>>] Array of possible dimensions
+  def dimensions
+    dimensions(@data.size)
+  end
+
+  # Read the input file to extract the values
+  # @param filename [String] Name of the input file containing data. Values must
+  #   be 0, 1, true, false and separated by commas.
+  # @return [Array<Integer>] Array of 0, 1. Can be directly passed to initialize
+  def self.load_file(filename)
+    content = File.read(filename).gsub(/\s+/, '')
+    data = content.split(',')
+    data.each_with_index do |x, i|
+      data[i] = 0 if x == '0' || x.downcase == 'false'
+      data[i] = 1 if x == '1' || x.downcase == 'true'
+    end
+    data
+  end
+
+  private
+
+  # Generate and save the image with Rmagick
+  # @param filename [String] Name of the output image.
+  def draw_rmagick(filename)
+    img = Magick::Image.new(@width, @height)
+    i = 0
+    (0...@height).each do |y|
+      (0...@width).each do |x|
+        if [1, true].include?(@data[i]) # true color
+          img.pixel_color(x, y, "rgb(#{@colors[1].join(',')}")
+        else # false color
+          img.pixel_color(x, y, "rgb(#{@colors[0].join(',')})")
+        end
+        i += 1
+      end
+    end
+    unless @scale.nil?
+      if @scale.is_a?(Numeric)
+        if @scale.zero?
+          raise(ArgumentError, 'Scale must be a ratio or a set of width and height')
+        end
+
+        img.scale!(@scale)
+      elsif @scale.is_a?(Array)
+        img.scale!(@scale[0], @scale[1])
+      else
+        raise(ArgumentError, 'Scale must be a ratio or a set of width and height')
+      end
+    end
+    img.write(filename)
+  end
+
+  # Generate and save the image ruby-vips
+  # @param filename [String] Name of the output image.
+  def draw_rubyvips(filename)
+    # true -> 1, false -> 0
+    @data.map! { |x| x == true ? 1 : x }
+    @data.map! { |x| x == false ? 0 : x }
+    # make a 2D image from the data array
+    im = Vips::Image.new_from_array(@data.each_slice(@width).to_a)
+    im = (im == 1).ifthenelse(@colors[1], @colors[0], blend: true)
+    if @scale.is_a?(Numeric)
+      opts = { kernel: :nearest }
+      im = im.resize(@scale, **opts)
+    end
+    im.write_to_file(filename, compression: 9, palette: true, colours: 2, Q: 0)
+  end
+
+  # Check if the argument is an integer else raise an error
+  # @param data [Object] The object to check
+  # @return [Object] Untouched input object
+  def check_int(data)
+    unless data.is_a?(Integer)
+      raise(ArgumentError, 'Argument is not an integer')
+    end
+
+    data
+  end
+
+  # Check if the data is in the format expected by #initialize else raise an
+  #   error
+  # @param data [Object] The object to check
+  # @return [Object] Untouched input object
+  def check_data(data)
+    raise(ArgumentError, 'Argument is not an array') unless data.is_a?(Array)
+
+    possible_values = PixelChart.dimensions(data.size)
+    possible_sets = possible_values.map(&:to_set)
+
+    unless possible_sets.include?(Set[@width, @height])
+      raise(ArgumentError, 'The number of values does not match with the possible dimensions')
+    end
+
+    data
+  end
+
+  # Check if the colors are in the format expected by #initialize else raise an
+  #   error
+  # @param data [Object] The object to check
+  # @return [Object] Untouched input object
+  def check_colors(data)
+    raise(ArgumentError, 'Argument is not an array') unless data.is_a?(Array)
+
+    data.each do |item|
+      if item == :random
+        # nothing
+      elsif item.is_a?(Array)
+        raise(ArgumentError, 'RGB must contains 3 values') unless item.size == 3
+
+        item.each do |i|
+          unless i.is_a?(Integer)
+            raise(ArgumentError, 'RGB values are not integers')
+          end
+          unless (0..255).include?(i)
+            raise(ArgumentError, 'RGB values must be between 0 and 255')
+          end
+        end
+      else
+        raise(ArgumentError, 'Colors are not a RGB array or :random')
+      end
+    end
+    data
+  end
+
+  # Check if the backend option is in the format expected by #draw else raise
+  #   an error
+  # @param data [Object] The object to check
+  # @return [Object] Untouched input object
+  def check_backend(data)
+    accepted_values = %i[rmagick rubyvips]
+    unless accepted_values.include?(data)
+      raise(ArgumentError, "Backend must be #{accepted_values.join(' or ')}")
+    end
+
+    data
+  end
+end

data/lib/pixelchart/version.rb

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

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: pixelchart
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexandre ZANNI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Create a binary pixel map
+email: alexandre.zanni@engineer.com
+executables:
+- pixelchart
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- bin/pixelchart
+- lib/pixelchart.rb
+- lib/pixelchart/version.rb
+homepage: 
+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.4'
+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: Create a binary pixel map
+test_files: []