giffy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d116a571dafe011946543c344742a7aa766d0350
+  data.tar.gz: f4943485eebb74d6b122b7f10052682d3cf761d5
+SHA512:
+  metadata.gz: b8ca4cf95c4c9c94b65b35fafa7a1bf68ac95cc225a6d3c55a702132a21b688e6ec771ea035dcb9272a052e72d909c82ff8574222ebb31938b110da2be7a563f
+  data.tar.gz: 4e8a7d05c42e6cac06a9227e4fca58c0bd66473b42d5eb31baea4e74d6b5b8aede63e8c7c15e4f2bc0cad8fecdf5bd463f4ad9750506ac0a178ade035f31e143

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shopify
+
+MIT License
+
+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,37 @@
+# Giffy
+
+Giffy is a very simple tool to use. The goal was to make it simple to take a screencast/demo
+and convert it into a gif without needing to remember all the incantations required for ffmpeg
+and ImageMagick
+
+## Installation
+
+If you want to use the command line tool simply:
+
+    $ gem install giffy
+
+If you want to use custom extensions or use giffy in
+a project add the following to your applications Gemfile:
+
+    gem 'giffy'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+From your terminal simply type the following:
+
+    $ giffy path_to_your_video path_to_where_gif_should_go
+
+## Contributing
+
+Don't forget to include tests. Contributions without tests may not be
+accepted as quickly.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task default: [:test]
+
+Rake::TestTask.new 'test' do |t|
+  ENV['test'] = '1'
+  t.libs = ['lib', 'test']
+  t.ruby_opts << '-rubygems'
+  t.verbose = true
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/bin/giffy

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+# This allows shopify_them to run easily from a git checkout without install.
+# Hat tip to chriseppstein of Compass fame for the code for this
+def fallback_load_path(path)
+  retried = false
+  begin
+    yield
+  rescue LoadError
+    unless retried
+      $: << path
+      retried = true
+      retry
+    end
+    raise
+  end
+end
+
+fallback_load_path(File.join(File.dirname(__FILE__), '..', 'lib')) do
+  require 'thor'
+  require 'pry'
+  require 'pry-debugger'
+  require 'giffy'
+end
+
+module Giffy
+  class CLI < Thor
+    PROCESSORS = [
+      Processors::VideoExtractionProcessor,
+      Processors::ImageSequenceProcessor,
+      Processors::GifGenerationProcessor
+    ]
+
+    COMMANDS = %w(process)
+
+    desc 'process VIDEO_FILE OUTPUT_GIF', 'Convert provided video into a gif'
+    method_options size: :string, start: :string, length: :string
+    def process(video_file, output_gif)
+      pipeline = Pipeline.new(PROCESSORS)
+      result = pipeline.process(video_file, options.merge(filename: output_gif))
+    end
+  end
+end
+
+ARGV.unshift('process') unless Giffy::CLI::COMMANDS.include?(ARGV.first)
+
+Giffy::CLI.start
+

data/giffy.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'giffy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "giffy"
+  spec.version       = Giffy::VERSION
+  spec.authors       = ["Shopify", "Chris Saunders"]
+  spec.email         = ["chris.saunders@shopify.com"]
+  spec.description   = "A tool that makes it easy to convert videos into gifs"
+  spec.summary       = "Using existing tools such as ffmpeg and ImageMagick easily create gifs"
+  spec.homepage      = "https://github.com/Shopify/giffy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", ">= 5.0.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-debugger"
+end

data/lib/giffy.rb

@@ -0,0 +1,6 @@
+require 'tmpdir'
+require 'giffy/version'
+require 'giffy/pipeline'
+require 'giffy/processors/video_extraction_processor'
+require 'giffy/processors/image_sequence_processor'
+require 'giffy/processors/gif_generation_processor'

data/lib/giffy/pipeline.rb

@@ -0,0 +1,15 @@
+module Giffy
+  class Pipeline
+    attr_reader :processors
+    def initialize(processors)
+      @processors = processors
+    end
+
+    def process(input, options)
+      processors.reduce(input) do |input, processor|
+        instance = processor.new(options)
+        instance.process(input)
+      end
+    end
+  end
+end

data/lib/giffy/processors/gif_generation_processor.rb

@@ -0,0 +1,55 @@
+module Giffy
+  module Processors
+    class GifGenerationProcessor
+      COMMANDS = {
+        "delay" => '-delay',
+        "other" => '-coalesce -layers OptimizeTransparency'
+      }
+      OPTIMIZE = '-fuzz 1%'
+      DEFAULTS = {
+        "filename" => 'animation.gif',
+        "delay" => '1x10'
+      }
+
+      def initialize(options={})
+        @optimize = options.delete("optimize")
+        @opts = DEFAULTS.merge(options)
+      end
+
+      def command(filenames)
+        result = %w(convert)
+        result << OPTIMIZE if optimize?
+        result << build_options(opts.merge("sequence" => filenames))
+        result << opts["filename"]
+        result.flatten.join(' ')
+      end
+
+      def process(filenames)
+        Open3.popen3(command(filenames)) do |stdin, stdout, stderr, wait_thread|
+          while line = stderr.gets
+            puts line
+          end
+        end
+        "Created #{opts["filename"]}"
+      end
+
+      private
+      attr_reader :opts
+      def build_options(options)
+        COMMANDS.sort.map do |key, command|
+          value = options[key]
+          value = send(key, value, options) if respond_to?(key, true)
+          value ? [command, value] : [command]
+        end
+      end
+
+      def optimize?
+        @optimize
+      end
+
+      def delay(amount, options)
+        "#{amount} #{options["sequence"]}"
+      end
+    end
+  end
+end

data/lib/giffy/processors/image_sequence_processor.rb

@@ -0,0 +1,20 @@
+module Giffy
+  module Processors
+    class ImageSequenceProcessor
+      DEFAULT_INCREMENT = 5
+      attr_reader :increment
+      def initialize(options={})
+        @increment = options["increment"] || DEFAULT_INCREMENT
+      end
+
+      def process(dir)
+        accumulator = []
+        entries = Dir.entries(dir).reject { |entry| (entry =~ /\.png\z/) == nil }
+        entries.each_with_index do |entry, index|
+          accumulator << "#{dir}/#{entry}" if index % increment == 0
+        end
+        accumulator.join(' ')
+      end
+    end
+  end
+end

data/lib/giffy/processors/video_extraction_processor.rb

@@ -0,0 +1,54 @@
+require 'open3'
+
+module Giffy
+  module Processors
+    class VideoExtractionProcessor
+      COMMANDS = {
+        "format" => '-f',
+        "input" => '-i',
+        "length" => '-t',
+        "size" => '-s',
+        "start" => '-ss'
+      }
+
+      DEFAULTS = {
+        "size" => '1024x768'
+      }
+
+      attr_reader :dir
+      def initialize(options={})
+        @dir = options.fetch("dir") { |key| Dir.mktmpdir }
+        @opts = DEFAULTS.merge(options)
+      end
+
+      def command(input)
+        result = %w(ffmpeg) + build_options(opts.merge("input" => input))
+        result.flatten.join(' ')
+      end
+
+      def process(input)
+        Open3.popen3(command(input)) do |stdin, stdout, stderr, wait_thread|
+          while line = stderr.gets
+            puts line
+          end
+        end
+        dir
+      end
+
+      private
+      attr_reader :opts
+      def build_options(options)
+        COMMANDS.sort.map do |key, command|
+          value = options[key]
+          value = send(key, value) if respond_to?(key, true)
+          value ? [command, value] : []
+        end
+      end
+
+      def format(value=nil)
+        "image2 #{dir}/%03d.png"
+      end
+
+    end
+  end
+end

data/lib/giffy/version.rb

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

data/test/giffy/pipeline_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+require 'giffy/pipeline'
+
+module Giffy
+  class PipelineTest < Minitest::Test
+    class Processor
+      def initialize(*args)
+      end
+    end
+
+    class Yeller < Processor
+      def process(input)
+        input.upcase
+      end
+    end
+
+    class Reverser < Processor
+      def process(input)
+        input.reverse
+      end
+    end
+
+    attr_reader :pipeline
+    def setup
+      @pipeline = Pipeline.new([Yeller, Reverser])
+    end
+
+    test "running something through the pipeline" do
+      assert_equal "DLROW OLLEH", pipeline.process("hello world", {})
+    end
+  end
+end

data/test/giffy/processors/gif_generation_processor_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+require 'giffy/processors/gif_generation_processor'
+
+module Giffy
+  module Processors
+    class GifGenerationProcessorTest < Minitest::Test
+      include Giffy::Fixtures
+      attr_reader :sequence, :dir
+
+      def setup
+        @sequence = images_sequence
+        @dir = Dir.mktmpdir
+        @stdout = $stdout
+      end
+
+      def teardown
+        FileUtils.remove_entry_secure(dir)
+        $stdout = @stdout
+      end
+
+      test "it should be able to generate the correct command" do
+        processor = GifGenerationProcessor.new("filename" => 'result.gif')
+        expected_command = "convert -delay 1x10 #{sequence} -coalesce -layers OptimizeTransparency result.gif"
+        assert_equal expected_command, processor.command(sequence)
+      end
+
+      test "when the optimized option is passed in for the command generation" do
+        processor = GifGenerationProcessor.new("optimize" => true, "delay" => '1x8')
+        expected_command = "convert -fuzz 1% -delay 1x8 #{sequence} -coalesce -layers OptimizeTransparency animation.gif"
+        assert_equal expected_command, processor.command(sequence)
+      end
+
+      test "it should be able to create a gif" do
+        slow_test('convert', __method__)
+        filename = "#{dir}/example.gif"
+        processor = GifGenerationProcessor.new("filename" => filename)
+        processor.process(sequence)
+        assert File.exist?(filename), "#{filename} does not exist after the image processing"
+      end
+    end
+  end
+end

data/test/giffy/processors/image_sequence_processor_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+require 'giffy/processors/image_sequence_processor'
+
+module Giffy
+  module Processors
+    class ImageSequenceProcessorTest < Minitest::Test
+      include Giffy::Fixtures
+
+      attr_reader :dir
+      def setup
+        @dir = images_directory_path
+      end
+
+      test "it collects the sequence based on the provided increment" do
+        processor = ImageSequenceProcessor.new("increment" => 3)
+        results = processor.process(dir)
+        expected = %w(001.png 004.png 007.png).map { |e| "#{dir}/#{e}" }
+        assert_equal expected.join(' '), results
+      end
+
+      test "it collects the sequence based on the default increment" do
+        processor = ImageSequenceProcessor.new
+        results = processor.process(dir)
+        expected = %w(001.png 006.png).map { |e| "#{dir}/#{e}" }
+        assert_equal expected.join(' '), results
+      end
+    end
+  end
+end

data/test/giffy/processors/video_extraction_processor_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+require 'giffy'
+require 'giffy/processors/video_extraction_processor'
+
+module Giffy
+  module Processors
+    class VideoExtractionProcessorTest < Minitest::Test
+      include Giffy::Fixtures
+
+      attr_reader :dir, :processor
+      attr_accessor :args
+      def setup
+        @dir = Dir.mktmpdir
+        @args = {"size" => '320x240', "dir" => dir}
+        @processor = VideoExtractionProcessor.new(args)
+        @stdout = $stdout
+      end
+
+      def teardown
+        FileUtils.remove_entry_secure(dir)
+        $stdout = @stdout
+      end
+
+      test "it takes in a provided video path and generates the correct ffmpeg command" do
+        expected_command = "ffmpeg -f image2 #{dir}/%03d.png -i #{video_path} -s #{args["size"]}"
+        assert_equal expected_command, processor.command(video_path)
+      end
+
+      test "it can have additional options passed in for start location and video length to generate the ffmpeg command" do
+        self.args = args.merge("start" => '0:0:0.4', "length" => '0:0:0.5')
+        processor = VideoExtractionProcessor.new(args)
+        expected_command = "ffmpeg -f image2 #{dir}/%03d.png -i #{video_path} -t #{args["length"]} -s #{args["size"]} -ss #{args["start"]}"
+        assert_equal expected_command, processor.command(video_path)
+      end
+
+      test "it can be queried for the directory it will be writing processed files to" do
+        assert_equal dir, processor.dir
+      end
+
+      test "running the processor generates png files in the directory" do
+        slow_test('ffmpeg', __method__)
+        stdout = StringIO.new
+        $stdout = stdout
+        dir = processor.process(video_path)
+        files = Dir.entries(dir).reject {|file| file =~ /\A\./}
+        assert stdout.length > 0, "The mocked stdout should've been written to"
+        assert_equal 31, files.length
+        files.each do |file|
+          assert file =~ /\.png\z/, "#{file} is not a PNG"
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+require 'pry'
+require 'pry-debugger'
+
+class Minitest::Test
+  def self.test(name, &blk)
+    define_method("test_#{name.gsub(/\s+/, '_')}", blk)
+  end
+
+  def slow_test(program_name, test_name)
+    unless ENV['FULL_SUITE']
+      puts "Processing via #{program_name} is slow, set FULL_SUITE to include #{test_name} in the test run" unless ENV['NO_WARN']
+      skip ''
+    end
+  end
+end
+
+module Giffy
+  module Fixtures
+    def fixture_path(name)
+      File.expand_path(File.join(File.dirname(__FILE__), "fixtures/#{name}"))
+    end
+
+    def video_path
+      fixture_path('test_video.mov')
+    end
+
+    def images_directory_path
+      fixture_path('test_video_images/')
+    end
+
+    def images_sequence
+      Dir.entries(images_directory_path).reject{|e| (e =~ /\.png\z/) == nil}.map{|e| "#{images_directory_path}/#{e}"}.join(' ')
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: giffy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shopify
+- Chris Saunders
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-debugger
+  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'
+description: A tool that makes it easy to convert videos into gifs
+email:
+- chris.saunders@shopify.com
+executables:
+- giffy
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/giffy
+- giffy.gemspec
+- lib/giffy.rb
+- lib/giffy/pipeline.rb
+- lib/giffy/processors/gif_generation_processor.rb
+- lib/giffy/processors/image_sequence_processor.rb
+- lib/giffy/processors/video_extraction_processor.rb
+- lib/giffy/version.rb
+- test/fixtures/test_video.mov
+- test/fixtures/test_video_images/001.png
+- test/fixtures/test_video_images/002.png
+- test/fixtures/test_video_images/003.png
+- test/fixtures/test_video_images/004.png
+- test/fixtures/test_video_images/005.png
+- test/fixtures/test_video_images/006.png
+- test/fixtures/test_video_images/007.png
+- test/fixtures/test_video_images/008.png
+- test/fixtures/test_video_images/009.png
+- test/giffy/pipeline_test.rb
+- test/giffy/processors/gif_generation_processor_test.rb
+- test/giffy/processors/image_sequence_processor_test.rb
+- test/giffy/processors/video_extraction_processor_test.rb
+- test/test_helper.rb
+homepage: https://github.com/Shopify/giffy
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Using existing tools such as ffmpeg and ImageMagick easily create gifs
+test_files:
+- test/fixtures/test_video.mov
+- test/fixtures/test_video_images/001.png
+- test/fixtures/test_video_images/002.png
+- test/fixtures/test_video_images/003.png
+- test/fixtures/test_video_images/004.png
+- test/fixtures/test_video_images/005.png
+- test/fixtures/test_video_images/006.png
+- test/fixtures/test_video_images/007.png
+- test/fixtures/test_video_images/008.png
+- test/fixtures/test_video_images/009.png
+- test/giffy/pipeline_test.rb
+- test/giffy/processors/gif_generation_processor_test.rb
+- test/giffy/processors/image_sequence_processor_test.rb
+- test/giffy/processors/video_extraction_processor_test.rb
+- test/test_helper.rb