putqr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 894df85665fbab9c06ad27bff808f806ff9e552915ad0ad0776d078bee5581d4
-  data.tar.gz: '006614608e3afd5b73943854e8811fd05fe08a49c60b8cdbb4dce5ac30536c0e'
+  metadata.gz: 1d3b1f8aa611f02bcf99143d51829ad21604efafaec1ff0c56a5e4e1e2501ebe
+  data.tar.gz: 7761362ac607108d1c937b2bdc033f373e190a4acd1f99754f14007d2b818974
 SHA512:
-  metadata.gz: 24045838704daf36f8ad32221e4477a85a1818890619a45f475e5392184e7c502af475b436218e1911e6526980f1a03c60b6450c068812ab04422fdcd2db0095
-  data.tar.gz: e4bae898597198756aad237d9f831f092eacf977ed6207008e5e45faee5ece117ce5361a1430674815f31267185d49a6250a71bafb74f0d4c8fc907ccd8c0ebc
+  metadata.gz: 9aff03258b067beefd1eba58e7112561aa3bf8f56ba50eeb80118db0b5deb5993fa1442a4121dd906a38ec1648d101dbdc22dce649c27ca06a9bb861563ec812
+  data.tar.gz: e1df7bb54e98649158d11511b1feb344494df646b667f322e9f0a8e6052311ef16aaaf2459db69d36818e62d0405a39f2cf8b603c06b31b14b0a519714681f6c

data/README.md

@@ -1,10 +1,14 @@
 # putqr
 
+[![Gem Version](https://badge.fury.io/rb/putqr.svg)](https://rubygems.org/gems/putqr)
+
 Display a QR code in your terminal.
 
 If you're using [iTerm2](https://iterm2.com) on macOS,
 the QR code will be displayed as an image.
 
+![Example: putqr https://example.com](images/example.png)
+
 ## Install
 
 Install `putqr` from [RubyGems](https://rubygems.org/):

data/bin/putqr

@@ -1,15 +1,56 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'optparse'
 require 'putqr'
 
-if ARGV.any?
-  content = ARGV.first
-  STDERR.puts 'warning: only encoding first argument' if ARGV.size > 1
-else
-  content = STDIN.read
+def print_version
+  puts "putqr #{PutQR::VERSION} (#{PutQR::DATE})"
 end
 
-output = PutQR::QRCode.new(content).render
+# rubocop:disable Metrics/MethodLength
+def parse_options
+  {}.tap do |options|
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: putqr [options] [message]'
+
+      opts.on('--[no-]image',
+              'display as an image (on by default if supported)') do |image|
+        options[:image] = image
+      end
+
+      opts.on('--version',
+              'print the version') do
+        print_version
+        exit
+      end
+    end.parse!
+  end
+end
+# rubocop:enable Metrics/MethodLength
+
+def parse_arguments
+  if ARGV.any?
+    STDERR.puts 'warning: only encoding first message argument' if ARGV.size > 1
+    ARGV.first
+  else
+    STDIN.read.chomp
+  end
+end
+
+def render(message, options)
+  qrcode = PutQR::QRCode.new(message)
+
+  case options[:image]
+  when true then qrcode.render_image
+  when false then qrcode.render_ansi
+  else qrcode.render
+  end
+end
+
+options = parse_options
+message = parse_arguments
+output = render(message, options)
+
 exit(1) if output.nil?
 puts output

data/lib/putqr.rb

@@ -20,7 +20,7 @@ module PutQR
       !qrcode.nil?
     end
 
-    # Render the QR code for display in the terminal.
+    # Render the QR code using the best method available for the terminal.
     # Returns a string.
     def render
       if ENV['TERM_PROGRAM'].start_with? 'iTerm'
@@ -36,15 +36,30 @@ module PutQR
       qrcode.as_ansi if valid?
     end
 
+    # Render the QR code as an inline image.
+    # Returns a string.
+    def render_image
+      render_image_iterm2
+    end
+
     # Render the QR code as an inline image for iTerm2.
     # Returns a string.
     def render_image_iterm2
       return nil unless valid?
 
+      # References:
+      # https://iterm2.com/documentation-images.html
+      # https://iterm2.com/utilities/imgcat
+
+      # tmux requires some extra work for unrecognised escape code sequences
+      screen = ENV['TERM'].start_with? 'screen'
+      prefix = screen ? "\ePtmux;\e\e]" : "\e]"
+      suffix = screen ? "\a\e\\" : "\a"
+
       png = qrcode.as_png(size: 600)
       png_base64 = Base64.encode64(png.to_s).chomp
       options = 'inline=1'
-      "\033]1337;File=#{options}:#{png_base64}\007"
+      "#{prefix}1337;File=#{options}:#{png_base64}#{suffix}"
     end
 
     def self.generate_qrcode(content)

data/lib/putqr/version.rb

@@ -1,3 +1,4 @@
 module PutQR
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
+  DATE = '2018-11-04'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putqr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Liam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-03 00:00:00.000000000 Z
+date: 2018-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rqrcode
@@ -36,10 +36,15 @@ files:
 - bin/putqr
 - lib/putqr.rb
 - lib/putqr/version.rb
-homepage: https://github.com/ljcooke/putqr
+homepage: https://liamcooke.com/code/putqr/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/ljcooke/putqr/issues
+  changelog_uri: https://github.com/ljcooke/putqr/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/putqr
+  homepage_uri: https://liamcooke.com/code/putqr/
+  source_code_uri: https://github.com/ljcooke/putqr
 post_install_message: 
 rdoc_options: []
 require_paths: