iterm2-protocol 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f68add32491bd9b05616013a4f4577f7442ff20
+  data.tar.gz: 71b87bc1064f370df81ea6eecf05cf9f66a0159c
+SHA512:
+  metadata.gz: 43d03d1fbe9238d24a2cd433cf0892b8fb1e48e9eb3bd13feb7e8dff3a25d9185c184a7ead36de176a9f2cd71fe1cd74a59f68ce56d2273fc7f1bae995fdd6da
+  data.tar.gz: aca4e5074d4dc3c7fcf87045adc2440d393752693bd3c95d863e31ed6f68560a2d24d56840db2763fb3b74ac516bf7a80c51805434f8f41406286695ae460b99

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.4

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -0,0 +1,36 @@
+# ITerm2::Protocol
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/iterm2/protocol`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iterm2-protocol'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iterm2-protocol
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/iterm2-protocol.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO.md

@@ -0,0 +1,3 @@
+# TODO
+
+* Specs!

data/bin/console

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

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/exe/imgcat

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "iterm2/protocol"
+
+ARGV.each { |path| puts ITerm2::Protocol.image(path: path) }

data/iterm2-protocol.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iterm2/protocol/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iterm2-protocol"
+  spec.version       = ITerm2::Protocol::VERSION
+  spec.authors       = ["Ryan Scott Lewis"]
+  spec.email         = ["ryan@rynet.us"]
+
+  spec.summary       = %q{A wrapper for the iTerm2 xterm protocol extensions.}
+  spec.description   = %q{Allows for easier generation of iTerm2 escape sequences.}
+  spec.homepage      = "https://github.com/RyanScottLewis/iterm2-protocol"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aspect", "~> 0.0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.7.2"
+end

data/lib/iterm2/protocol/file_sequence.rb

@@ -0,0 +1,88 @@
+require "aspect/has_attributes"
+
+require "iterm2/protocol/formatter"
+
+module ITerm2
+  module Protocol
+
+    # Escape sequence for use file downloads.
+    class FileSequence
+
+      class << self
+
+        def format(attributes={})
+          new(attributes).to_s
+        end
+
+      end
+
+      include Aspect::HasAttributes
+
+      def initialize(attributes={})
+        @inline = false
+
+        update_attributes(attributes)
+
+        raise ArgumentError, "path must be given" if @path.nil?
+      end
+
+      # @method path
+      # Get the path.
+      #
+      # @return [String]
+
+      # @method path=
+      # Set the path.
+      #
+      # @param [#to_s] value
+      # @return [String]
+      attribute(:path) { |value| value.is_a?(Pathname) ? value : Pathname.new(value.to_s) }
+
+      # @method inline
+      # Get whether the file will be displayed inline.
+      #
+      # @return [Boolean]
+
+      # @method inline=
+      # Set whether the file will be displayed inline.
+      #
+      # @param [Boolean] value
+      # @return [Boolean]
+      attribute(:inline, query: true)
+
+      # Return the arguments to this escape sequence.
+      #
+      # @param [nil, Symbol] output
+      #   The output format to return the Hash for.
+      #
+      #   Set to `:terminal` to format for an escape sequence.
+      # @return [Hash]
+      def to_h(output=nil)
+        result = {
+          name: Base64.encode64(@path.to_s),
+          size: @path.size
+        }
+
+        result[:inline] = output == :terminal ? (@inline ? 1 : 0) : @inline
+
+        result
+      end
+
+      # Get the escape sequence.
+      #
+      # @param [#to_h] attributes The attributes to pass to the `Formatter`.
+      # @return [String]
+      def to_s(attributes={})
+        attributes = {
+          key: "File",
+          value: to_h(:terminal),
+          content: Base64.encode64(@path.read)
+        }.merge(attributes)
+
+        Formatter.format(attributes)
+      end
+
+    end
+
+  end
+end

data/lib/iterm2/protocol/formatter.rb

@@ -0,0 +1,109 @@
+require "aspect/has_attributes"
+
+module ITerm2
+  module Protocol
+
+    class Formatter
+
+      class << self
+
+        def format(attributes={})
+          new(attributes).to_s
+        end
+
+      end
+
+      include Aspect::HasAttributes
+
+      def initialize(attributes={})
+        @tmux = ENV["TERM"] =~ /^screen/
+
+        update_attributes(attributes)
+      end
+
+      # @method key
+      # Get the key.
+      #
+      # @return [String]
+
+      # @method key=
+      # Set the key.
+      #
+      # @param [#to_s] value
+      # @return [String]
+      attribute(:key) { |value| value.to_s }
+
+      # @method value
+      # Get the value.
+      #
+      # @return [Hash, String]
+
+      # @method value=
+      # Set the value.
+      #
+      # @param [#to_h, #to_s] value
+      # @return [Hash, String]
+      attribute(:value) { |value| value.respond_to?(:to_h) ? value.to_h : value.to_s }
+
+      # @method content
+      # Get the content.
+      #
+      # @return [nil, String]
+
+      # @method content=
+      # Set the content.
+      #
+      # @param [nil, #to_s] value
+      # @return [nil, String]
+      attribute(:content) { |value| value.nil? ? nil : value.to_s }
+
+      # @method tmux
+      # Get whether to format for tmux output.
+      #
+      # @return [Boolean]
+
+      # @method tmux=
+      # Set whether to format for tmux output.
+      #
+      # @param [Boolean] value
+      # @return [Boolean]
+      attribute(:tmux, query: true)
+
+      # Get the key-value pair formatted as an iTerm2 escape sequence.
+      #
+      # If the value is a Hash, it will be formatted as `key=value` with each pair being delimited
+      # by a semicolon (`;`).
+      #
+      # @return [String]
+      def to_s
+        [].tap do |segments|
+          segments << escape_sequence
+          segments << "1337;"
+          segments << @key
+          segments << "="
+          segments << format_value(@value)
+          segments << ":#{@content}" unless @content.nil?
+          segments << st_sequence
+        end.join
+      end
+
+      protected
+
+      def escape_sequence
+        @tmux ? "\033Ptmux;\033\033]" : "\033]"
+      end
+
+      def st_sequence
+        @tmux ? "\a\033\\" : "\a"
+      end
+
+      def format_value(value)
+        return value unless value.is_a?(Hash)
+
+        value.collect { |k,v| "#{k}=#{v}" }.join(";")
+      end
+
+    end
+
+  end
+end

data/lib/iterm2/protocol/image_sequence.rb

@@ -0,0 +1,94 @@
+require "iterm2/protocol/file_sequence"
+
+module ITerm2
+  module Protocol
+
+    # Escape sequence for use with inline images.
+    class ImageSequence < FileSequence
+
+      def initialize(attributes={})
+        @width = "auto"
+        @height = "auto"
+        @preserve_aspect_ratio = true
+
+        super
+
+        @inline = true
+      end
+
+      # @method width
+      # Get the width.
+      #
+      # @return [String]
+
+      # @method width=
+      # Set the width.
+      #
+      # Given as a number followed by a unit, or the word "auto":
+      #
+      #   N: N character cells.
+      #   Npx: N pixels.
+      #   N%: N percent of the session's width or height.
+      #   auto: The image's inherent size will be used to determine an appropriate dimension.
+      #
+      # @param [#to_s] value
+      # @return [String]
+      attribute(:width) { |value| value.to_s }
+
+      # @method height
+      # Get the height.
+      #
+      # @return [String]
+
+      # @method height=
+      # Set the height.
+      #
+      # Given as a number followed by a unit, or the word "auto":
+      #
+      #   N: N character cells.
+      #   Npx: N pixels.
+      #   N%: N percent of the session's width or height.
+      #   auto: The image's inherent size will be used to determine an appropriate dimension.
+      #
+      # @param [#to_s] value
+      # @return [String]
+      attribute(:height) { |value| value.to_s }
+
+      # @method preserve_aspect_ratio
+      # Get whether to preserve the aspect ratio.
+      #
+      # @return [Boolean]
+
+      # @method preserve_aspect_ratio=
+      # Set whether to preserve the aspect ratio.
+      #
+      # @param [Boolean] value
+      # @return [Boolean]
+      attribute(:preserve_aspect_ratio, query: true)
+
+      # Return the arguments to this escape sequence.
+      #
+      # @param [nil, Symbol] output
+      #   The output format to return the Hash for.
+      #
+      #   Set to `:terminal` to format for an escape sequence.
+      # @return [Hash]
+      def to_h(output=nil)
+        result = {
+          width: @width,
+          height: @height
+        }
+
+        if output == :terminal
+          result[:preserveAspectRatio] = @preserve_aspect_ratio ? 1 : 0
+        else
+          result[:preserve_aspect_ratio] = @preserve_aspect_ratio
+        end
+
+        super(output).merge(result)
+      end
+
+    end
+
+  end
+end

data/lib/iterm2/protocol/version.rb

@@ -0,0 +1,5 @@
+module ITerm2
+  module Protocol
+    VERSION = "0.1.0"
+  end
+end

data/lib/iterm2/protocol.rb

@@ -0,0 +1,26 @@
+require "base64"
+
+require "iterm2/protocol/version"
+require "iterm2/protocol/formatter"
+require "iterm2/protocol/file_sequence"
+require "iterm2/protocol/image_sequence"
+
+module ITerm2
+  module Protocol
+    class << self
+
+      def format(attributes={})
+        Formatter.format(attributes)
+      end
+
+      def file(attributes={})
+        FileSequence.format(attributes)
+      end
+
+      def image(attributes={})
+        ImageSequence.format(attributes)
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: iterm2-protocol
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aspect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  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: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.2
+description: Allows for easier generation of iTerm2 escape sequences.
+email:
+- ryan@rynet.us
+executables:
+- imgcat
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- exe/imgcat
+- iterm2-protocol.gemspec
+- lib/iterm2/protocol.rb
+- lib/iterm2/protocol/file_sequence.rb
+- lib/iterm2/protocol/formatter.rb
+- lib/iterm2/protocol/image_sequence.rb
+- lib/iterm2/protocol/version.rb
+homepage: https://github.com/RyanScottLewis/iterm2-protocol
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A wrapper for the iTerm2 xterm protocol extensions.
+test_files: []