cli_pix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e54d55ea153abfef0d9d3539c52da6e645bc89c418036396a717bfdcd8483008
+  data.tar.gz: 073eac82290bebb0ca48d29b65bc6500d6033151f5a06e42a422691560957293
+SHA512:
+  metadata.gz: 150b4e897881168a54ef351362e1ac2595dc3c3e16f2020fc06f065b38a996b4ce17412fa8adad6cad6aa925c6d3dd93481c36753d536e96a6207c7a4e3d479b
+  data.tar.gz: d25743adeada14fd4aa91fd4a501f5385aab4de7190c60a4cf9fa236a9cc483bca3c4166b059213b1760fcb8e394d1106e01599a9e510afc3ea166e06a832532

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/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ianholla@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cli_pix.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    cli_pix (0.1.0)
+      mini_magick (~> 4.10)
+      paint (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    mini_magick (4.10.1)
+    paint (2.2.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cli_pix!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ihollander
+
+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,113 @@
+# CliPix
+
+A Ruby library to display and animate images in your terminal.
+
+## Requirements
+
+This library uses the MiniMagick gem, which requires ImageMagick or GraphicsMagick to be installed on your system.
+
+You can install it for OS X with homebrew:
+
+```
+brew install imagemagick
+```
+
+See the [requirements](https://github.com/minimagick/minimagick#requirements) from MiniMagick for more installation info.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'cli_pix'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cli_pix
+
+## Usage
+
+Display an image from a file:
+
+```rb
+file_path = "demos/image.png"
+image = CliPix::Image.from_file(file_path)
+image.display
+```
+
+Display an image from a URL:
+
+```rb
+url = "https://f0.pngfuel.com/png/980/847/ruby-on-rails-logo-programming-language-rubygems-ruby-png-clip-art.png"
+image = CliPix::Image.from_url(url)
+image.display
+```
+
+Display animated gifs:
+
+```rb
+url = "https://media3.giphy.com/media/dXLnSpMDt7CvzRwMa9/giphy.gif?cid=ecf05e47nkii9rn5xq6uc0tsoyc53rowe8zjnwrcydkfbw6w&rid=giphy.gif"
+image = CliPix::Image.from_url(url)
+image.animate
+```
+
+Display data from a blob (to capture a webcam image, for example):
+
+```rb
+require "av_capture"
+
+# uses av_capture gem to access webcam (OSX only)
+session = AVCapture::Session.new
+device = AVCapture.devices.find(&:video?)
+
+session.run_with(device) do |connection|
+  # give a little time for the camera to warm up...
+  sleep 1
+  
+  # run a loop continuously
+  loop do
+    # connection.capture returns a blob
+    image = CliPix::Image.from_blob(connection.capture, flop: true)
+    image.display
+    # wait for next capture
+    sleep 0.2
+  end
+end
+```
+
+The `CliPix::Image#display` and `CliPix::Image#animate` methods will both output the image directly to your terminal. If you want more control, you can also use the `CliPix::Image#read` method to return a string representation of the image a block:
+
+```rb
+url = "https://media3.giphy.com/media/dXLnSpMDt7CvzRwMa9/giphy.gif?cid=ecf05e47nkii9rn5xq6uc0tsoyc53rowe8zjnwrcydkfbw6w&rid=giphy.gif"
+image = CliPix::Image.from_url(url, preprocess: true)
+# read will yield an image_string of each frame of the image to the block
+image.read do |image_string|
+  print `clear`
+  puts image_string
+  sleep 0.5
+end
+```
+
+### Options
+
+When creating an image, you can pass an options hash as a second argument. It takes the following options:
+
+```rb
+{
+autoscale:  true,         # default: true. resize the image to fit the console window.
+size:       nil,          # default: nil. you can provide an array of width and height [50, 30] or a string "50x30" to resize the image
+flip:        false,        # default: false. if true, flip the image vertically
+flop:        false,        # default: false. if true, flip the image horizontally
+mode:       :color,       # default: :color. you can also use :ascii to display the image in ASCII mode.
+preprocess: false         # default: false. if true, process all frames of the image before displaying. useful for animated gifs.
+}
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/console

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

@@ -0,0 +1,31 @@
+require_relative 'lib/cli_pix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli_pix"
+  spec.version       = CliPix::VERSION
+  spec.authors       = ["ihollander"]
+  spec.email         = ["ianholla@gmail.com"]
+
+  spec.summary       = %q{A gem to help display images and animation in your terminal.}
+  spec.homepage      = "https://github.com/ihollander/cli_pix"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ihollander/cli_pix"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # dependencies
+  spec.add_development_dependency "rspec", "~> 3.9"
+
+  spec.add_dependency "paint", "~> 2.2"
+  spec.add_dependency "mini_magick", "~> 4.10"
+end

data/demos/gif.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/cli_pix"
+
+url = "https://media3.giphy.com/media/dXLnSpMDt7CvzRwMa9/giphy.gif?cid=ecf05e47nkii9rn5xq6uc0tsoyc53rowe8zjnwrcydkfbw6w&rid=giphy.gif"
+image = CliPix::Image.from_url(url, preprocess: true)
+image.animate

data/demos/image.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/cli_pix"
+
+file_path = "demos/image.png"
+image = CliPix::Image.from_file(file_path)
+image.display

data/demos/webcam.rb

@@ -0,0 +1,20 @@
+# NOTE
+# You'll need to install the av_capture gem to run this demo!
+require "av_capture"
+require_relative "../lib/cli_pix"
+
+# uses av_capture gem to access webcam (OSX only)
+session = AVCapture::Session.new
+device = AVCapture.devices.find(&:video?)
+
+session.run_with(device) do |connection|
+  # give a little time for the camera to warm up...
+  sleep 1
+  
+  # run a loop continuously
+  loop do
+    CliPix::Image.from_blob(connection.capture, flop: true).display
+    # wait for next capture
+    sleep 0.2
+  end
+end

data/lib/cli_pix.rb

@@ -0,0 +1,7 @@
+require_relative "cli_pix/version"
+
+module CliPix
+  class Error < RuntimeError; end
+end
+
+require_relative "cli_pix/image"

data/lib/cli_pix/image.rb

@@ -0,0 +1,158 @@
+require "io/console"
+require "mini_magick"
+require "paint"
+
+module CliPix
+  class Image
+  
+    DEFAULT_OPTIONS = {
+      autoscale: true,
+      size: nil,
+      flop: false,
+      flip: false,
+      mode: :color,
+      preprocess: false
+    }
+
+    class << self  
+
+      def read(blob, options = {})
+        image = MiniMagick::Image.read(blob)
+        self.new(image, options)
+      end
+      alias :from_blob :read
+
+      def open(url, options = {})
+        image = MiniMagick::Image.open(url)
+        self.new(image, options)
+      end
+      alias :from_url :open
+      alias :from_file :open
+
+    end
+
+    attr_reader :image, :options
+
+    def initialize(image, options = {})
+      @image = image
+      @options = DEFAULT_OPTIONS.merge options
+    end
+
+    def display
+      self.read do |text|
+        # clear terminal
+        clear_screen!
+        puts text
+      end
+    end
+
+    def animate(framerate = 0.2)
+      self.read do |text|
+        # clear terminal
+        clear_screen! 
+        puts text
+        # wait
+        sleep framerate
+      end
+    end
+
+    # yields each text frame to the block
+    def read
+      process_image!
+      if options[:preprocess]
+        # | / - \  
+        spinner = "|/-\\"
+        text_frames = image.frames.map.with_index do |frame, index|
+          print "Loading frame #{index + 1}/#{image.frames.length}... #{spinner[index % 4]} \r"
+          if options[:mode] == :color
+            convert_to_color(frame.get_pixels)
+          else
+            convert_to_ascii(frame.get_pixels)
+          end
+        end
+
+        text_frames.each do |text_frame|
+          yield text_frame
+        end
+      else
+        image.frames.each do |frame|
+          if options[:mode] == :color
+            yield convert_to_color(frame.get_pixels)
+          else
+            yield convert_to_ascii(frame.get_pixels)
+          end
+        end
+      end
+    end
+
+    private
+
+    def clear_screen!
+      print "\e[2J\e[f" 
+    end
+
+    def process_image!
+      if options[:autoscale]
+        width, height = get_scaled_dimensions
+        image.resize "#{width}x#{height}"
+      elsif options[:size]
+        if options[:size].is_a? Array
+          width, height = options[:size]
+          image.resize "#{width}x#{height}"
+        else
+          image.resize "#{options[:size]}"
+        end
+      end
+      
+      image.colorspace "Gray" if options[:mode] == :ascii
+
+      image.flip if options[:flip]
+      image.flop if options[:flop]    
+    end
+
+    def convert_to_ascii(pixels)
+      ascii_chars = " .:oO8@"
+
+      text_image = ""
+
+      pixels.each do |row|
+        row.each do |rgb|
+          char_index = ((rgb.first.to_f / 255) * ascii_chars.length).to_i
+          text_image += (ascii_chars[char_index] || " ") * 2
+        end
+        text_image += "\n"
+      end
+
+      text_image
+    end
+
+    def convert_to_color(pixels)
+      text_image = ""
+
+      pixels.each do |row|
+        row.each do |rgb|
+          text_image += Paint["  ", nil, rgb]
+        end
+        text_image += "\n"
+      end
+
+      text_image
+    end
+    
+    def get_scaled_dimensions
+      # image width & height
+      image_aspect_ratio = image.width.to_f / image.height
+
+      # terminal width & height
+      terminal_height, terminal_width = IO.console.winsize
+      terminal_aspect_ratio = terminal_width.to_f / terminal_height
+
+      # constrain (max width)
+      photo_width = terminal_width > 50 ? 50 : terminal_width
+      photo_height = photo_width / image_aspect_ratio
+      # return [width, height]
+      [ photo_width.to_i, photo_height.to_i ]
+    end
+  
+  end
+end

data/lib/cli_pix/version.rb

@@ -0,0 +1,3 @@
+module CliPix
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: cli_pix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ihollander
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !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: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+description:
+email:
+- ianholla@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cli_pix.gemspec
+- demos/gif.rb
+- demos/image.png
+- demos/image.rb
+- demos/webcam.rb
+- lib/cli_pix.rb
+- lib/cli_pix/image.rb
+- lib/cli_pix/version.rb
+homepage: https://github.com/ihollander/cli_pix
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ihollander/cli_pix
+  source_code_uri: https://github.com/ihollander/cli_pix
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: A gem to help display images and animation in your terminal.
+test_files: []