selfie_formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40373d4d7ab3ef4ab64d87bd40dccdacb111fe37
+  data.tar.gz: 15a59ad88f51a8fa3c0938a7b12aa22c66adc70e
+SHA512:
+  metadata.gz: 05ef8afcc20dda9caaa4b427b861ea0f87f093a53df828a6f9c56bea2bbc7a71d2997f3d851d77b70d05939f669b8f25541c7c8a2354dd74bfa10d3a943c52f1
+  data.tar.gz: 4fba84dc01175dab9f59a7e8f20c174f34065679d9e8e4cb6bab7885d80081590f2de3f0071be5409b2cf131e09de7816ce91184f11e1b8da3ada263b06f1e2a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*#
+*~

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Skye Shaw (sshaw)
+
+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,52 @@
+# The RSpec Selfie Formatter
+
+An RSpec Formatter for the new generation of programmers.
+
+![Selfie Formatter Animation](example.gif)
+
+The Selfie Formatter takes photos of you while your tests run and uses them to track
+progress and format the results.
+
+Currently only works on OS X with iTerm2 >= 3.0. **Warning** see [known issues](#known-issues).
+
+## Installation
+
+ImageMagick is required
+
+```
+brew install imagemagick --with-fontconfig
+```
+
+Then
+
+```
+gem install selfie_formatter
+```
+
+Or, in your `Gemfile`
+
+```ruby
+gem "selfie_formatter", :group => "test"
+```
+
+## Usage
+
+```
+rspec -f SelfieFormatter
+```
+
+## Known Issues
+
+1. Photos are taken via [imagesnap](https://github.com/rharder/imagesnap), which is a fine program but can quickly eat up memory.
+Upwards of 500 MB after 10 or 15 seconds.
+
+1. Photos are taken every 300ms. Unused photos are cleaned up after every test completes but if a single test takes a while to
+complete photos can start to eat up disk space.
+
+1. Spec numbers are added to the top left of each image. They will not show up if the background is dark.
+
+At some point I may write something that does not [fake the `Camera` interface via `fork`](https://github.com/sshaw/selfie_formatter/blob/34f1999391695ce7633d79638a0903e1eb612e9e/lib/selfie/camera.rb). [imagesnap](https://github.com/rharder/imagesnap) and [CaptureCamera](https://github.com/fernyb/CaptureCamera) are good starting points.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/selfie.rb

@@ -0,0 +1,7 @@
+require "selfie/camera"
+require "selfie/cursor"
+require "selfie/iterm2/image"
+
+module Selfie
+  Error = Class.new(StandardError)
+end

data/lib/selfie/camera.rb

@@ -0,0 +1,61 @@
+module Selfie
+  class Camera
+    CAPTURE_COMMAND = File.expand_path("../../imagesnap", __FILE__) << " -qw 0.8 -t 0.3"
+
+    def initialize(outdir, options = {})
+      @outdir = outdir
+      @glob = File.join(@outdir, "snapshot-*.jpg")
+      @captured = []
+      @pid = nil
+    end
+
+    # The camera interface we'd like to have (and may at some point).
+    # Until then, we fake it.
+    def on
+      return false if @pid
+
+      # TODO: signals
+      begin
+        @pid = spawn(CAPTURE_COMMAND, :chdir => @outdir, [:out, :err] => File::NULL)
+      rescue SystemCallError => e
+        raise Error, "cannot spawn photo capture process: #{e}"
+      end
+
+      # Wait for camera to warm up, -w option is not enough :(
+      sleep 2.5
+
+      true
+    end
+
+    def off
+      return false unless @pid
+
+      begin
+        Process.kill("TERM", @pid)
+        Process.wait(@pid)
+      rescue Errno::ESRCH, Errno::ECHILD
+        # kill, wait cannot find pid
+      end
+
+      # final cleanup
+      FileUtils.rm_f(Dir[@glob] - @captured)
+
+      @pid = nil
+      true
+    end
+
+    # Some hacks to make it seem like capture() takes a picture
+    # without accumulating a ton of unused images.
+    def capture
+      sleep 0.2
+
+      images = Dir[@glob]
+      return if images.none? || images.last == @captured.last
+
+      @captured << images.last
+      FileUtils.rm_f(images - @captured)
+
+      @captured.last
+    end
+  end
+end

data/lib/selfie/cursor.rb

@@ -0,0 +1,49 @@
+require "tty-cursor"
+
+module Selfie
+  class Cursor
+    include TTY::Cursor
+
+    def initialize(output)
+      raise ArgumentError, "output must be a terminal" unless output.tty?
+      @output = output
+      @settings = `stty -g 2>/dev/null`
+    end
+
+    %w[up down forward back move_to hide show clear_screen].each do |name|
+      define_method(name) { |*n| @output << super(*n) }
+    end
+
+    # Calculates how many columns and rows the code in the given block moved the cursor
+    def distance
+      raise ArgumentError, "block required" unless block_given?
+
+      beg_pos = position
+      yield
+      end_pos = position
+      return unless end_pos && beg_pos
+
+      # width, height
+      [ end_pos[1] - beg_pos[1], end_pos[0] - beg_pos[0] ]
+    end
+
+    def position
+      # TODO: use terminos instead?
+      `stty -echo -icanon -cread`
+      @output << current
+
+      position = ""
+      while ch = $stdin.getc
+        position << ch
+        break if ch == "R"
+      end
+
+      return unless position =~ %r|\[(\d+)\;(\d+)|
+
+      [ $1.to_i, $2.to_i ]
+    ensure
+      # TODO: restore if killed..?
+      `stty -g #@settings`
+    end
+  end
+end

data/lib/selfie/iterm2/image.rb

@@ -0,0 +1,47 @@
+require "base64"
+
+module Selfie
+  module ITerm2
+    class Image
+      attr :path
+
+      def initialize(path, options = {})
+        @path = path
+        @options = options.dup
+        @options[:inline] = 1
+        @image = Base64.encode64(File.read(path))
+      end
+
+      def to_s(options = {})
+        sprintf("%s1337;File=%s:%s%s", start_esc, format_options(options), @image, end_esc)
+      end
+
+      private
+
+      def screen_tty?
+        $stdout.tty? && ENV.include?("TERM") && ENV["TERM"].start_with?("screen")
+      end
+
+      # From imgls: https://raw.githubusercontent.com/gnachman/iTerm2/master/tests/imgls
+      def start_esc
+        @screen == true ? "\ePtmux;\e\e]" : "\e]"
+      end
+
+      def end_esc
+        @screen == true ? "\a\e\\" : "\a"
+      end
+      # --
+
+      def format_options(options)
+        @options.merge(options).map do |name, value|
+          if name == :preserve_aspect_ratio
+            name  = "preserveAspectRatio"
+            value = value == false ? 0 : 1
+          end
+
+          sprintf "%s=%s", name, value
+        end.join(";")
+      end
+    end
+  end
+end

data/lib/selfie/version.rb

@@ -0,0 +1,3 @@
+module Selfie
+  VERSION = "0.0.1"
+end

data/lib/selfie_formatter.rb

@@ -0,0 +1,193 @@
+require "rspec"
+
+# This is needed by the Reporter. RSpec doesn't require it.
+require "rspec/core/formatters/console_codes"
+
+require "fileutils"
+require "mini_magick"
+
+require "selfie"
+
+class SelfieFormatter
+  include Selfie
+
+  DEFAULT_COLUMNS = 80
+
+  RSpec::Core::Formatters.register self, :dump_summary, :dump_failures, :dump_pending, :close, :example_passed, :example_failed, :example_pending, :start, :stop
+
+  def self.output_directory
+    @output_directory ||= RSpec.configuration.selfie_output_directory || File.join(Dir.pwd, "selfies")
+  end
+
+  def self.output_directory=(path)
+    @output_directory = path
+  end
+
+  def initialize(output, options = {})
+    raise ArgumentError, "can only render to a terminal" unless output.tty?
+
+    @output  = output
+    @options = options
+    @cursor = Cursor.new(@output)
+    @camera = Camera.new(photo_dir)
+
+    @columns = `stty size 2>/dev/null`.split(" ").last.to_i
+    @columns = DEFAULT_COLUMNS if @columns == 0
+
+    @offset  = 1
+    @spec_count = 0
+
+    @failed = {}
+    @pending = {}
+
+    @main_img_height = nil
+    @main_img_width = nil
+  end
+
+  def start(notification)
+    @camera.on
+    @cursor.hide
+    @cursor.clear_screen
+    @cursor.move_to(0, 0)
+  end
+
+  def stop(notification)
+    @camera.off
+
+    # Make sure we move down past the "film strip" before the summary is printed
+    pos = @cursor.position
+    if pos && pos[1] != 1
+      @cursor.down(@main_img_height)
+    end
+
+    @output << "\n\n"
+  end
+
+  def close(n)
+    @cursor.show
+    @output.flush
+  end
+
+  def example_passed(notification)
+    image = capture("green")
+    display_progess(image) if image
+  end
+
+  def example_failed(notification)
+    image = capture("red")
+    return unless image
+
+    @failed[notification.example] = image
+    display_progess(image)
+  end
+
+  def example_pending(notification)
+    image = capture("yellow")
+    return unless image
+
+    @pending[notification.example] = image
+    display_progess(image)
+  end
+
+  def dump_pending(notification)
+    if notification.pending_notifications.any?
+      @output << "\nPending:\n"
+      dump_notifications(notification.pending_notifications, @pending)
+    end
+  end
+
+  def dump_failures(notification)
+    if notification.failure_notifications.any?
+      @output << "\nFailures:\n"
+      dump_notifications(notification.failure_notifications, @failed)
+    end
+  end
+
+  def dump_summary(summary)
+    @output.puts summary.fully_formatted
+  end
+
+  private
+
+  def dump_notifications(notifications, images)
+    notifications.each_with_index do |notification, i|
+      notice = notification.fully_formatted(i + 1)
+      if images[notification.example]
+        # Replace the example's number with its photo
+        notice.sub!(%r|\A\s*\d+\)\s+(.+)$|, "\n%s\\1\n" % images[notification.example].to_s(:width => 12))
+      end
+
+      @output << notice
+    end
+  end
+
+  def photo_dir
+    path = File.join(SelfieFormatter.output_directory, Time.now.strftime("%Y-%m-%d-%H%M%S"))
+    FileUtils.mkdir_p(path)
+    path
+  end
+
+  def capture(color)
+    @spec_count += 1
+
+    path = @camera.capture
+    return unless path
+
+    transform(path, color)
+    ITerm2::Image.new(path)
+  end
+
+  def transform(path, color)
+    # TODO: options
+    # TODO: put number in a white box
+    image = MiniMagick::Image.new(path)
+    image.combine_options do |i|
+      i.resize "250x250>"
+      i.border "4x4"
+      i.bordercolor color
+      i.pointsize '26'
+      i.weight 'Bold'
+      # for 26 point
+      # count isn't available on Notification -of something?!
+      i.annotate "+10+30", @spec_count.to_s
+      # for 32 point
+      #i.annotate "+15+40", "#1000"
+    end
+  rescue MiniMagick::Error => e
+    raise Error, "image transformation failed: #{e}"
+  end
+
+  def display_progess(image)
+    # TODO: subclass?
+    # if SelfieFormatter.film_strip?
+    film_strip_formatter(image)
+  end
+
+  def film_strip_formatter(image)
+    output_image(image)
+    adjust_cursor
+  end
+
+  def output_image(image)
+    str = image.to_s
+    if @main_img_height && @main_img_width
+      @output << str
+    else
+      @main_img_width, @main_img_height = @cursor.distance { @output << str }
+      raise Error, "formatting failed: cannot determine cursor position" unless @main_img_width && @main_img_height
+    end
+  end
+
+  def adjust_cursor
+    # Check if the next image fits on the current row
+    @offset += 1
+    if @offset * @main_img_width <= @columns
+      @cursor.up(@main_img_height)
+    else
+      @offset = 1
+      @output << "\n"
+    end
+  end
+end
+
+RSpec.configuration.add_setting :selfie_output_directory

data/selfie_formatter.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selfie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "selfie_formatter"
+  spec.version       = Selfie::VERSION
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = "RSpec Formatter that takes photos of you while your tests run and uses them to track progress and format the results."
+  spec.description =<<-DESC
+    An RSpec Formatter for the new generation for programmers.
+    Selfie Formatter takes photos of you while your tests run and uses them to track progress and format the results.
+    Currently only works on OS X with iTerm2 >= 3.0.
+  DESC
+
+  spec.homepage      = "https://github.com/sshaw/selfie_formatter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "mini_magick", "~> 4.0"
+  spec.add_dependency "tty-cursor", "~> 0.3"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: selfie_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: |2
+      An RSpec Formatter for the new generation for programmers.
+      Selfie Formatter takes photos of you while your tests run and uses them to track progress and format the results.
+      Currently only works on OS X with iTerm2 >= 3.0.
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- example.gif
+- lib/imagesnap
+- lib/selfie.rb
+- lib/selfie/camera.rb
+- lib/selfie/cursor.rb
+- lib/selfie/iterm2/image.rb
+- lib/selfie/version.rb
+- lib/selfie_formatter.rb
+- selfie_formatter.gemspec
+homepage: https://github.com/sshaw/selfie_formatter
+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.8
+signing_key: 
+specification_version: 4
+summary: RSpec Formatter that takes photos of you while your tests run and uses them
+  to track progress and format the results.
+test_files: []
+has_rdoc: