catpix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f6ffca3e7a8a1ecda737a7035cfc6098464c0f6
+  data.tar.gz: e8477a9b2b92e321275044fc0a4bcb3a8a5f5525
+SHA512:
+  metadata.gz: c75fcf501af41168264127be579d69a62029649a4e134e846aadf6143b37e6279b62392e9ed76da1f5640d5809bbb3023a99ceff4e604ba564d3ea2b8a517fe5
+  data.tar.gz: c8add99b4d071378f05a1f3e954214ea3346de0bf6a5dce16065630da857f62b3b52d2a25e17ef499cf3180e141c7d19836e2ff1c86df70635da467581e81a41

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Radek Pazdera
+
+MIT License
+
+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,29 @@
+# Catpix
+
+TODO: Write a gem description
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'catpix'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install catpix
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/catpix/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/catpix

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require 'docopt'
+require 'catpix'
+
+doc = <<DOCOPT
+Print images in the terminal.
+
+Usage:
+  #{__FILE__} --help | --version
+  #{__FILE__} [options] <path>
+
+Options:
+  -w=<width>, --limit-width     Limit width of the image (factor of the size
+                                of the terminal window) [default: 1].
+  -h=<height>, --limit-height   Limit height of the image (factor of the size
+                                of the terminal window) [default: 0],
+  -c=<pos>, --center            Set x, y or xy centering in the window.
+  -b=<colour>, --bg             Set background colour.
+  -f, --bg-fill                 Draw background around the image as well.
+
+  --help                        Show this message.
+  --version                     Print the version.
+DOCOPT
+
+begin
+  args = Docopt::docopt doc, :version => Catpix::VERSION
+rescue Docopt::Exit => e
+  $stderr.puts e.message
+  exit 1
+end
+
+require 'pp'
+
+pp args
+options = {
+  :limit_x => args['--limit-width'].to_f,
+  :limit_y => args['--limit-height'].to_f,
+  :bg_fill => args['--bg-fill']
+}
+
+if args['--center']
+  options[:center_x] = true if args['--center'].include? 'x'
+  options[:center_y] = true if args['--center'].include? 'y'
+
+  if not args['--center'].include? 'x' or not args['--center'].include? 'x'
+    $stderr.puts "Error: Invalid --center argument. Use x, y or xy."
+    $stderr.puts doc
+  end
+end
+
+options[:bg] = args['--bg'] if args['--bg']
+
+Catpix::print_image args['<path>'], options
+exit 0

data/catpix.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'catpix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "catpix"
+  spec.version       = Catpix::VERSION
+  spec.authors       = ["Radek Pazdera"]
+  spec.email         = ["me@radek.io"]
+  spec.summary       = %q{Cat images into the terminal.}
+  spec.description   = %q{A library and a script that lets you easily print
+                          images (png, jpg, gif and others) inside the command
+                          line using imagemagick and the extended 256 colour
+                          palette.}
+  spec.homepage      = "https://github.com/pazdera/catpix"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tco", "~> 0.1", ">= 0.1.6"
+  spec.add_dependency "rmagick", "~> 2.15", ">= 2.15.2"
+  spec.add_dependency "docopt", "~> 0.5", ">= 0.5.0"
+  spec.add_dependency "ruby-terminfo", "~> 0.1", ">= 0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.4"
+end

data/lib/catpix.rb

@@ -0,0 +1,75 @@
+require "catpix/version"
+require "catpix/private"
+
+# Provides a function to print images in the terminal. A range of different
+# formats is supported (check out what ImageMagick supports). Under the hood,
+# this module uses two components:
+#
+# * [rmagick](https://rmagick.github.io/) to read and scale the images and
+# * [tco](https://github.com/pazdera/tco) to map their pixels on the extended
+#   colour palette in the terminal.
+#
+# Some other minor features like centering and handling background colours
+# are supplied directly by this module.
+module Catpix
+  # Print an image to the terminal.
+  #
+  # All formats supported by ImageMagick are supported. The image's colours
+  # will be mapped onto the extended 256 colour palette. Also by default, it
+  # will be scaled down to fit the width of the terminal while keeping its
+  # proportions. This can be changed using the `options` parameter.
+  #
+  # @param [Hash] options Adjust some parameters of the image when printed.
+  # @option options [Float] :limit_x A factor of the terminal window's width.
+  #                                  If present, the image will be scaled down
+  #                                  to fit (proportions are kept). Using 0
+  #                                  will disable the scaling. [default: 1.0]
+  # @option options [Float] :limit_y A factor of the terminal window's height.
+  #                                  If present, the image will be scaled down
+  #                                  to fit (proportions are kept). Using 0
+  #                                  will disable the scaling. [default: 0]
+  # @option options [Boolean] :center_x Center the image horizontally in the
+  #                                     terminal window. [default: false]
+  # @option options [Boolean] :center_y Center the image vertically in the
+  #                                     terminal window. [default: false]
+  # @option options [String] :bg Background colour to use in case there are
+  #                              any fully transparent pixels in the image.
+  #                              This can be a RGB value '#c0ffee' or a tco
+  #                              alias 'red' or 'blue'. [default: nil]
+  # @option options [Boolean] :bg_fill Fill the margins around the image with
+  #                                    background colour. [default: false]
+  def self.print_image(path, options={})
+    options = default_options.merge! options
+
+    img = load_image path
+    resize! img, options[:limit_x], options[:limit_y]
+
+    margins = get_margins img, options[:center_x], options[:center_y]
+    margin_colour = options[:bg_fill] ? options[:bg] : nil
+
+    print_vert_margin margins[:top], margin_colour
+
+    # print left margin for the first row
+    print_horiz_margin margins[:left], margin_colour
+
+    # print the image
+    img.each_pixel do |pixel, col, row|
+      if pixel.opacity == 65535
+        print_pixel options[:bg]
+      else
+        print_pixel get_normal_rgb pixel
+      end
+
+      if col >= img.columns - 1
+        print_horiz_margin margins[:right], margin_colour
+        puts
+
+        unless row == img.rows - 1
+          print_horiz_margin margins[:left], margin_colour
+        end
+      end
+    end
+
+    print_vert_margin margins[:bottom], margin_colour
+  end
+end

data/lib/catpix/private.rb

@@ -0,0 +1,107 @@
+
+require "rmagick"
+require "tco"
+require "terminfo"
+
+module Catpix
+  private
+  def self.default_options
+    {
+      :limit_x => 1.0,
+      :limit_y => 0,
+      :center_x => false,
+      :center_y => false,
+      :bg => nil,
+      :bg_fill => false
+    }
+  end
+
+  def self.print_pixel(colour=nil)
+    if colour
+      print "  ".bg colour
+    else
+      print "  "
+    end
+  end
+
+  # Returns normalised size of the terminal window
+  #
+  # Catpix uses two blank characters to approximate pixels in the terminal,
+  # so we need to divide the width of the terminal by 2.
+  def self.get_screen_size
+    th, tw = TermInfo.screen_size
+    [tw / 2, th]
+  end
+
+  def self.load_image(path)
+    Magick::Image::read(path).first
+  end
+
+  def self.resize!(img, limit_x=0, limit_y=0)
+    tw, th = get_screen_size
+    iw = img.columns
+    ih = img.rows
+
+    width = if limit_x > 0
+      (tw * limit_x).to_i
+    else
+      iw
+    end
+
+    height = if limit_y > 0
+      (th * limit_y).to_i
+    else
+      ih
+    end
+
+    # Resize the image if it's bigger than the limited viewport
+    if iw > width or ih > height
+      img.change_geometry "#{width}x#{height}" do |cols, rows, img|
+        img.resize! (cols).to_i, (rows).to_i
+      end
+    end
+  end
+
+  # Returns the normalised RGB of a ImageMagick's pixel
+  def self.get_normal_rgb(pixel)
+    [pixel.red, pixel.green, pixel.blue].map { |v| 255*(v/65535.0) }
+  end
+
+  # Determine the margins based on the centering options
+  def self.get_margins(img, center_x, center_y)
+    margins = {}
+    tw, th = get_screen_size
+
+    x_space = tw - img.columns
+    if center_x
+      margins[:left] = x_space / 2
+      margins[:right] = x_space / 2 + x_space % 2
+    else
+      margins[:left] = 0
+      margins[:right] = x_space
+    end
+
+    y_space = th - img.rows
+    if center_y
+      margins[:top] = y_space / 2
+      margins[:bottom] = y_space / 2 + y_space % 2
+    else
+      margins[:top] = 0
+      margins[:bottom] = 0
+    end
+
+    margins
+  end
+
+  def self.print_vert_margin(size, colour)
+    tw, th = get_screen_size
+    size.times do
+      tw.times { print_pixel colour }
+      puts
+    end
+  end
+
+  def self.print_horiz_margin(size, colour)
+    size.times { print_pixel colour }
+  end
+end

data/lib/catpix/version.rb

@@ -0,0 +1,4 @@
+module Catpix
+  # Version of the gem
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: catpix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Radek Pazdera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tco
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.2
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: |-
+  A library and a script that lets you easily print
+                            images (png, jpg, gif and others) inside the command
+                            line using imagemagick and the extended 256 colour
+                            palette.
+email:
+- me@radek.io
+executables:
+- catpix
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/catpix
+- catpix.gemspec
+- lib/catpix.rb
+- lib/catpix/private.rb
+- lib/catpix/version.rb
+homepage: https://github.com/pazdera/catpix
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Cat images into the terminal.
+test_files: []
+has_rdoc: