flashman 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b94d9d651e8f28e1e4cd1862feeb4f137212eb65
+  data.tar.gz: e13be36a1a331b9c354c0cbadd2be230541df8c3
+SHA512:
+  metadata.gz: 27cdaa2c80d0852a0e3c06549b8be416beac6d79b154fed22e997f0adbfb5bee1a77936dff43c7a728f3fd2e62113782d5540c271ffb13a9517d3566c821df90
+  data.tar.gz: 315ecfa2e34712fa083631128af054a63d156f22beb8a4836474d3f2bc03dc7cad0e6faa6a48ff220bd1b16ec9820e16e55769836ca769f795d4e9369680e4b9

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,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Shinichi Tokunaga
+
+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,54 @@
+# Flashman 
+
+This is a gem for recording your terminal activity on a gif file.  
+You can also record any other window of your application.  
+**The gem works only for MacOS X!**
+
+![out](https://github.com/deepneko/flashman/blob/master/img/flashman.gif "out")
+
+## Installation
+
+You need to install [gifsicle](https://www.lcdf.org/gifsicle/ "gifsicle") at first.
+
+    $ brew install gifsicle
+
+Then, please install flashman from rubygems.
+
+    $ gem install flashman
+
+## Usage
+
+Start to record your Terminal.
+
+    $ flashman
+
+Stop the recording. It could take a while.
+
+    $ flashstop
+
+The output file 'out.gif' is placed at the directory where flashman was executed.
+
+    $ open out.gif
+
+## Options
+
+Specify other terminal or application with -w.
+
+    $ flashman -w iTerm
+
+flashman records the window every second by default. You can change the interval with -i.
+
+    $ flashman -i 0.5
+
+You can change the playback speed of the output file with -s. 2 means the speed will be doubled.
+
+    $ flashman -s 2
+
+See the detailed description with -h.
+
+    $ flashman -h
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deepneko/flashman.
+

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,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flashman"
+
+# 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,6 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+

data/exe/flashman

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'flashman'
+require 'slop'
+
+opts = Slop.parse do |o|
+  o.string '-w', '--window', default: 'Terminal'
+  o.float '-i', '--interval', default: 1
+  o.string '-o', '--output', default: 'out.gif'
+  o.integer '-s', '--speed', default: 1
+  o.integer '-t', '--times', default: 0
+  o.bool '-h', '--help', ''
+end
+
+if opts[:h]
+  Flashman.usage
+  exit 0
+end
+
+flashman = Flashman.init(opts[:window], opts[:output], opts[:interval], opts[:speed], opts[:times])
+flashman.run

data/exe/flashstop

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+pid_file = File.join(Dir.home, '.flashman/flashman.pid')
+unless File.exist?(pid_file)
+  puts "flashman isn't running."
+  exit 1
+end
+pid = File.open(pid_file).first.to_i
+
+stop_pid = File.join(Dir.home, '.flashman/flashstop.pid')
+open(stop_pid, 'w') {|f| f << Process.pid}
+
+finish_trap = false
+Signal.trap(:TERM) {finish_trap = true}
+
+Process.kill("TERM", pid)
+
+puts "Waiting for flashman to be done..."
+loop do
+  break if finish_trap 
+  sleep 1
+end
+
+File.unlink stop_pid
+puts "Done."

data/flashman.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flashman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flashman"
+  spec.version       = Flashman::VERSION
+  spec.authors       = ["deepneko"]
+  spec.email         = ["deep.inu@gmail.com"]
+
+  spec.summary       = %q{Record your live console/terminal log in a gif file.}
+  spec.homepage      = "https://github.com/deepneko/flashman"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">=1.9"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", ">= 0"
+  spec.add_runtime_dependency "sys-proctable", ">= 0.9.9"
+  spec.add_runtime_dependency "slop", ">= 4.2.0"
+end

data/lib/flashman.rb

@@ -0,0 +1,133 @@
+require "flashman/version"
+require "sys/proctable"
+include Sys
+
+module Flashman
+  def self.init(window, output, interval, speed, times)
+    Flashman.new(window, output, interval, speed, times)
+  end
+
+  def self.usage
+    puts "flashman [-w appname] [-o output-file] [-i interval] [-s speed]"
+    puts
+    puts "Options are as follows:"
+    puts "  -w  Specify an application name which you want to record. The default is 'Terminal'."
+    puts "  -o  Specify the output file. The default is to put 'out.gif' in the directory where flashman was executed."
+    puts "  -i  Specify the interval in seconds. The screen of the application is recorded every 'interval' seconds."
+    puts "  -s  Specify the number of the speed. If you specify '2', the playback speed will be doubled."
+    puts "  -t  Specify how many times the output gif loops. The default is '0' which means infinite."
+  end
+
+  class Flashman
+    def initialize(window, output, interval, speed, times)
+      @work_dir = File.join(Dir.home, '.flashman')
+      begin
+        Dir.mkdir(@work_dir, 0755)
+      rescue Errno::EEXIST
+        # Do nothing
+      end
+      @pid_file = "#{@work_dir}/flashman.pid"
+      @stop_pid = "#{@work_dir}/flashstop.pid"
+
+      check_macosx
+      check_multirun
+      optcheck(output, interval, speed, times)
+
+      @windowid = `osascript -e 'tell app \"#{window}\" to id of window 1' 2>/dev/null`.strip
+      unless @windowid =~ /^\d+$/
+        puts "#{window} isn't the actual application name running on your mac."
+        exit 1
+      end
+
+      @output = output
+      @interval = interval
+      @delay = (100 * @interval / speed).to_i
+      @times = times.to_i
+      @finish_trap = false
+    end
+
+    def run
+      begin
+        Process.daemon(true, true)
+        set_trap
+        open(@pid_file, 'w') {|f| f << Process.pid}
+
+        i = 0
+        loop do
+          break if @finish_trap
+          file = "#{@work_dir}/#{i.to_s.rjust(6, "0")}"
+          `screencapture -t gif -o -l #{@windowid} #{file}.gif 2>&1 >/dev/null`
+          sleep(@interval)
+          i += 1
+        end
+      rescue => e
+        STDERR.puts "[ERROR][#{self.class.name}.run] #{e}"
+        exit 1
+      end
+
+      `gifsicle -O2 --delay=#{@delay} --loopcount=#{@times} #{@work_dir}/*.gif > #{@output} 2>/dev/null`
+      File.unlink *Dir.glob("#{@work_dir}/*.png")
+      File.unlink *Dir.glob("#{@work_dir}/*.gif")
+      File.unlink @pid_file
+
+      if File.exist?(@stop_pid)
+        pid = File.open(@stop_pid).first.to_i
+        Process.kill("TERM", pid)
+      end
+    end
+
+    def usage
+      puts "flashman [-w appname] [-o output-file] [-i interval] [-s speed] [-t loop-times]"
+    end
+
+    def set_trap
+      Signal.trap(:TERM) {@finish_trap = true}
+    end
+
+    def check_macosx
+      os = `uname`
+      unless os =~ /^Darwin/
+        puts "flashman is only for MacOSX."
+        exit 1
+      end
+    end
+
+    # TODO: There must be any good way to check multirunning.
+    def check_multirun
+      if File.exist?(@pid_file)
+        pid = File.open(@pid_file).first.to_i
+        ps = ProcTable.ps(pid)
+        if ps.cmdline =~ /flashman\s+/
+          puts "flashman has already been running."
+          exit 1
+        end
+      end
+    end
+
+    def optcheck(output, interval, speed, times)
+      unless output
+        usage
+        exit 1
+      end
+
+      if interval < 0.1 or interval > 10
+        usage
+        puts "-i option has to be the range between 0.1 and 10."
+        exit 1
+      end
+
+      if speed < 1 or speed > 10
+        usage
+        puts "-s option has to be the range between 1 and 10."
+        exit 1
+      end
+
+      if times < 0
+        usage
+        puts "-t option has to be 0 or more."
+        exit 1
+      end
+    end
+  end
+end
+

data/lib/flashman/version.rb

@@ -0,0 +1,3 @@
+module Flashman
+  VERSION = "0.1.5"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: flashman
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- deepneko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-20 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: 
+email:
+- deep.inu@gmail.com
+executables:
+- flashman
+- flashstop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/flashman
+- exe/flashstop
+- flashman.gemspec
+- lib/flashman.rb
+- lib/flashman/version.rb
+homepage: https://github.com/deepneko/flashman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+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: Record your live console/terminal log in a gif file.
+test_files: []