ruby-blocky-image-viewer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d17d43d37caf9bae678f673125af0f4acdca1c9
+  data.tar.gz: 421852c56b8eb8d435f2e3fad145b6a23931a2f3
+SHA512:
+  metadata.gz: ba651941adb56651c9f5aac7b28f7ae599688551823e6148f3cdc4f643684e6b5bb2d3c3ec609f0b6b4bbe6ae069f6dfbd2e141352d15ba9e0ff1be36f9a9a52
+  data.tar.gz: ce54e7c2f1362b4a2c304dc8ca3cd3bc45e441aa06736202589dc4da8fd2e28e820ab13e5be8b8dac6019e43acafd5e08fa0bc4e6dd07386dd54b4ebc86fd8a7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gem 'rubocop', require: false
+
+# Specify your gem's dependencies in ruby-blocky-image-viewer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Joseph Hallett
+
+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,73 @@
+# The Ruby Blocky Image Viewer
+
+**tl;dr: terminal image displayer that’s a shameless re-write of [icat](https://github.com/atextor/icat) for Ruby**
+
+![tldr](https://raw.githubusercontent.com/bogwonch/ruby-blocky-image-viewer/master/images/tldr.png)
+
+## Summary
+
+So you want to see an image, but don’t wanna leave your precious command-line?
+
+`jp2a` makes you sad...
+
+![jp2a](https://raw.githubusercontent.com/bogwonch/ruby-blocky-image-viewer/master/images/jp2a.png)
+
+`img2txt` is just weird...
+
+![img2txt](https://raw.githubusercontent.com/bogwonch/ruby-blocky-image-viewer/master/images/img2txt.png)
+
+There is a better way!
+
+![biv](https://raw.githubusercontent.com/bogwonch/ruby-blocky-image-viewer/master/images/biv-cat.png)
+
+![biv](https://raw.githubusercontent.com/bogwonch/ruby-blocky-image-viewer/master/images/biv.png)
+
+## Features
+
+* True color support!
+* Higher definition output (2 pixels per character!)
+* Standard definition output (1 pixel per character!)
+* Width and height controls!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-blocky-image-viewer'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install ruby-blocky-image-viewer
+```
+
+## Usage
+
+If you just wanna view an image checkout:
+
+```sh
+$ biv --help
+```
+
+Otherwise have a look at the source code, especially `Biv::Viewer`:
+
+```ruby
+puts Biv::Viewer.new(“my-image.png”).to_s
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/bogwonch/ruby-blocky-image-viewer/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,4 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new

data/bin/biv

@@ -0,0 +1,39 @@
+#! /usr/bin/env ruby
+
+require 'biv'
+require 'terminfo'
+require 'trollop'
+
+opts = Trollop::options do
+  version "biv #{Biv::VERSION}"
+  banner <<-EOS
+Print images on the commandline.
+
+Usage:
+  biv [options] <filenames>+
+EOS
+
+  opt :width, 'Maximum image width', type: :integer, default: TermInfo.screen_size[1]
+  opt :height, 'Maximum image height', type: :integer
+  opt :fit, 'Fit entire image to terminal'
+  opt :true_color, 'True color'
+  opt :sd, 'Lower definition images'
+  opt :background, 'Background color of the image', type: :string, default: "FFFFFF"
+end
+
+bg = opts[:background].to_i(16)
+bg = [(bg && 0xFF0000) >> 16,
+      (bg && 0x00FF00) >> 8,
+      (bg && 0x0000FF)]
+
+opts[:height] = TermInfo.screen_size[0] if opts[:fit]
+
+ARGV.each do |arg|
+  puts Biv::Image.new(arg,
+                      width: opts[:width],
+                      height: opts[:height],
+                      true_color: opts[:true_color],
+                      hd: ! opts[:sd],
+                      bg: bg).to_s
+
+end

data/lib/biv.rb

@@ -0,0 +1,180 @@
+require 'biv/version'
+require 'RMagick'
+require 'rainbow/ext/string'
+
+# Implements a blocky image viewer
+module Biv
+  # An image to be printed in a blockily
+  class Image
+    # Load a new image for viewing
+    def initialize(file, width: nil, height: nil, true_color: false, hd: true, bg: [0xFF, 0xFF, 0xFF])
+      fail ArgumentError, 'Missing image width' if width.nil?
+
+      begin
+        @original_image = Magick::Image.read(file).first
+      rescue
+        raise ArgumentError, "I don't know how to open '#{file}'"
+      end
+      @width = width
+      @height = height
+      @true_color = true_color
+      @hd = hd
+      @bg = bg
+
+      @height *= 2 if !@height.nil? && @hd
+      preprocess
+
+      fail ArgumentError, 'I failed to load the image' if @image.nil?
+    end
+
+    # Convert an image to an array of printable strings
+    def to_a
+      buffer = []
+
+      for_row_indexes.each do |y|
+        line = ''
+        0.upto(@image.columns - 1).each do |x|
+          p = get_pixel(x, y)
+          block = make_block p
+          line << block
+        end
+        line << "\x1b[0m" # Reset the color at the end of the line
+        buffer << line
+      end
+
+      buffer
+    end
+
+    # Convert an image to a string
+    def to_s
+      to_a.join "\n"
+    end
+
+    private
+
+    # Get the image ready to display
+    def preprocess
+      @image = @original_image
+      @image.scale! @image.columns, @image.rows / 2 unless @hd
+
+      if @height.nil?
+        @image = @image.resize_to_fit(@width)
+      else
+        @height /= 2 unless @hd
+        @image = @image.resize_to_fit(@width, @height)
+      end
+    end
+
+    # Get a pixel at a coordinate
+    def get_pixel(x, y)
+      if @hd
+        get_pixel_hd(x, y)
+      else
+        get_pixel_at(x, y)
+      end
+    end
+
+    # Get two pixels from an HD coordinate
+    def get_pixel_hd(x, y)
+      p0 = get_pixel_at(x, y * 2)
+      p1 = get_pixel_at(x, y * 2 + 1)
+
+      [p0, p1]
+    end
+
+    # Get a pixel at a specific coordinate
+    def get_pixel_at(x, y)
+      begin
+        p = get_rgb(@image.get_pixels(x, y, 1, 1).first)
+      rescue RangeError
+        p = @bg
+      end
+      p
+    end
+
+    # From a pixel get the rgb channels, taking into account transparency
+    def get_rgb(p)
+      r = p.red
+      g = p.green
+      b = p.blue
+      a = p.opacity
+
+      if a > 0
+        r *= (Magick::QuantumRange - a) / Magick::QuantumRange
+        g *= (Magick::QuantumRange - a) / Magick::QuantumRange
+        b *= (Magick::QuantumRange - a) / Magick::QuantumRange
+      end
+
+      [r, g, b]
+    end
+
+    # Convert rgb channels into 8bit color
+    def to_8bit(rgb)
+      rgb = rgb.map do |c|
+        c >>= 8
+        if c < 0x00
+          0
+        elsif c > 0xFF
+          0xFF
+        else
+          c
+        end
+      end
+      rgb
+    end
+
+    # create a color string from a channel array
+    def color_str(str, p)
+      format(str, p[0], p[1], p[2])
+    end
+
+    # A hex color string (for rainbow)
+    def hex(p)
+      color_str('%02x%02x%02x', to_8bit(p))
+    end
+
+    # A truecolor background colorstring
+    def true_bg(p)
+      color_str("\x1b[48;2;%d;%d;%dm", to_8bit(p))
+    end
+
+    # A truecolor foreground colorstring
+    def true_fg(p)
+      color_str("\x1b[38;2;%d;%d;%dm", to_8bit(p))
+    end
+
+    # Get row indexes
+    def for_row_indexes
+      if @hd
+        0.upto((@image.rows - 1) / 2)
+      else
+        0.upto(@image.rows - 1)
+      end
+    end
+
+    def make_block(p)
+      if @hd
+        make_block_hd(p)
+      else
+        if @true_color
+          block = true_bg(p) + ' '
+        else
+          block = ' '.background Rainbow::Color.parse_hex_color(hex(p))
+        end
+        block
+      end
+    end
+
+    def make_block_hd(p)
+      p0, p1 = p
+      if @true_color
+        block = true_bg(p0) + true_fg(p1) + '▄'
+      else
+        block = '▄'
+                .background(Rainbow::Color.parse_hex_color(hex p0))
+                .foreground(Rainbow::Color.parse_hex_color(hex p1))
+      end
+      block
+    end
+  end
+end

data/lib/biv/version.rb

@@ -0,0 +1,4 @@
+# Version number
+module Biv
+  VERSION = '0.0.1'
+end

data/ruby-blocky-image-viewer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'biv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-blocky-image-viewer'
+  spec.version       = Biv::VERSION
+  spec.authors       = ['Joseph Hallett']
+  spec.email         = ['bogwonch@bogwonch.net']
+  spec.summary       = 'Display images on the commandline.  Badly.'
+  spec.description   = 'Display images on the commandline using blocks of color with true color support'
+  spec.homepage      = 'https://github.com/bogwonch/ruby-blocky-image-viewer'
+  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_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'rmagick', '~> 2.15', '>= 2.15.3'
+  spec.add_runtime_dependency 'ruby-terminfo', '~> 0.1.1'
+  spec.add_runtime_dependency 'trollop', '~> 2.1', '>= 2.1.2'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: ruby-blocky-image-viewer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joseph Hallett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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.3
+  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.3
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.1
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+description: Display images on the commandline using blocks of color with true color
+  support
+email:
+- bogwonch@bogwonch.net
+executables:
+- biv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/biv
+- images/biv-cat.png
+- images/biv.png
+- images/img2txt.png
+- images/jp2a.png
+- images/tldr.png
+- lib/biv.rb
+- lib/biv/version.rb
+- ruby-blocky-image-viewer.gemspec
+homepage: https://github.com/bogwonch/ruby-blocky-image-viewer
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Display images on the commandline.  Badly.
+test_files: []