gifr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e5a3422ff309ddf69dac0f25368af0b2ce6afee
+  data.tar.gz: c95586afe2e9f4307f11687cf541212814204d32
+SHA512:
+  metadata.gz: 8ba8006121fbd9fbfecf5009838c914972cf54f1344ced265bb70e05821dfcafed4c77fdd042b08d9e971a6bbe10340d4b70ace0f01533b8a1b26a8267b9c76a
+  data.tar.gz: 6131ef36791326f8d406b16e3d7d703a2d67ad3b2e9e68da51d781205a9ad2826a8b6fb7614a8c10fa219b5af551c30c3fbe058e1eb99f8eaa22d85130458d18

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michał Darda
+
+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,46 @@
+## Gifr
+
+Command line tool to easily create animated gifs from movies.
+
+## Requirements
+
+On Ubuntu (14.04), please install
+
+    $ sudo add-apt-repository ppa:samrog131/ppa
+
+    $ sudo apt-get update
+
+    $ sudo apt-get install ffmpeg-real
+
+## Installation
+
+Type:
+
+    $ gem install gifr
+
+
+## Usage
+
+    $ gifr video.mp4 -s 00:00:00 -t 7 output.gif
+
+Available options
+
+`-s or --start` moment int movie to start in format `hh:mm:ss`
+`-t or --time` how long should animated gif last
+
+You can optionally provide also:
+`-d or --delay` the speed of gif's animation, default is 20
+
+## Contributing
+
+1. Fork it (http://github.com/michaldarda/gifr/fork)
+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
+
+When submiting your PR please make sure you've added tests and they are passing.
+
+## License
+
+Copyright &copy; 2014 Michal Darda <michaldarda@gmail.com>

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty -x"
+  t.fork = false
+end

data/bin/gifr

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/gifr'
+require 'optparse'
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = %q{
+Usage:
+$ gifr video.mp4 -s 00:00:00 -t 7 output.gif
+
+Available options
+
+`-s or --start` moment int movie to start in format `hh:mm:ss`
+`-t or --time` how long should animated gif last
+
+You can optionally provide also:
+`-d or --delay` the speed of gif's animation, default is 20
+  }
+
+  opts.on("-h", "--help", "Show usage informations") do |v|
+    puts opts.banner
+    exit(0)
+  end
+
+  opts.on("-s n", "--start=n", "") do |v|
+    options[:start] = v
+  end
+
+  opts.on("-t n", "--time=n", "") do |v|
+    options[:time] = v
+  end
+
+  opts.on("-d n", "--delay=n", "") do |v|
+    options[:delay] = v
+  end
+end
+
+parser.parse!
+
+filename = ARGV.shift
+output = ARGV.shift || "#{filename}.gif"
+
+options.merge!(filename: filename, output: output)
+
+errors = OptionsValidator.new(options).validate!
+
+if errors.any?
+  puts parser.banner
+  puts errors
+  exit(1)
+end
+
+begin
+  movie = Movie.new(options)
+rescue ArgumentError
+  puts "Given file does not exists"
+  exit(1)
+end
+
+movie_screenshoter = MovieScreenshoter.new(movie, options)
+
+movie_screenshoter.take_screenshots!
+
+gif_creator = GifCreator.new(movie_screenshoter.screenshots, options)
+
+gif_creator.make_gif!

data/features/features.feature

@@ -0,0 +1,30 @@
+Feature: Invoking program with different parameters
+  Scenario: Invoking with correct parameters
+    When I run `gifr ../../spec/fixtures/example1.mp4 -s 00:00:00 -t 7`
+    Then a file named "../../spec/fixtures/example1.mp4.gif" should exist
+    And the exit status should be 0
+
+  Scenario: Invoking with custom output file path
+    When I run `gifr ../../spec/fixtures/example1.mp4 -s 00:00:00 -t 7 output.gif`
+    Then a file named "output.gif" should exist
+    And the exit status should be 0
+
+  Scenario: Invoking with custom output file path and additional delay parameter
+    When I run `gifr ../../spec/fixtures/example1.mp4 -s 00:00:00 -t 7 -d 20 output.gif`
+    Then a file named "output.gif" should exist
+    And the exit status should be 0
+
+  Scenario: Invoking with not existing file 
+    When I run `gifr ../../spec/fixtures/notexistingfile.mp4 -s 00:00:00 -t 7`
+    Then the exit status should be 1
+    And the stdout should contain "Given file does not exists"
+
+  Scenario: Viewing help screen
+    When I successfully run `gifr -h`
+    Then the exit status should be 0
+    And the stdout should contain "Usage:"
+
+  Scenario: Invoking with no parameters at all
+    When I run `gifr`
+    Then the exit status should be 1
+    And the stdout should contain "Usage:"

data/features/support.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'aruba/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 10
+end

data/gifr.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gifr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gifr"
+  spec.version       = Gifr::VERSION
+  spec.authors       = ["Michał Darda"]
+  spec.email         = ["michaldarda@gmail.com"]
+  spec.summary       = %q{Simple solution to create gifs from short movies.}
+  spec.description   = %q{Simple solution to create gifs from short movies.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0beta2"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency "rmagick"
+end

data/lib/gifr.rb

@@ -0,0 +1,5 @@
+require_relative "./gifr/version"
+require_relative "./gifr/options_validator"
+require_relative "./gifr/movie"
+require_relative "./gifr/movie_screenshoter"
+require_relative "./gifr/gif_creator"

data/lib/gifr/gif_creator.rb

@@ -0,0 +1,15 @@
+require 'RMagick'
+include Magick
+
+class GifCreator
+  def initialize(gifs = [], options = {})
+    @gifs = ImageList.new(*gifs)
+    @output = options.fetch(:output)
+    @delay = options.fetch(:delay) { 20 }
+  end
+
+  def make_gif!
+    @gifs.delay = @delay
+    @gifs.write(@output)
+  end
+end

data/lib/gifr/movie.rb

@@ -0,0 +1,23 @@
+class Movie
+  def initialize(options = {})
+    @path = options.fetch(:filename)
+
+    raise ArgumentError unless File.exists?(@path)
+  end
+
+  def length
+    @length ||= Integer(%x{ ffprobe -v quiet -show_entries format=duration #{to_s} | grep duration }.match(/(duration=)(\d+)(.\d+)/)[2])
+  end
+
+  def to_s
+    "#{to_path}"
+  end
+
+  def to_path
+    Pathname.new(@path)
+  end
+
+  def filename
+    to_path.basename
+  end
+end

data/lib/gifr/movie_screenshoter.rb

@@ -0,0 +1,19 @@
+require 'pathname'
+
+class MovieScreenshoter
+  attr_reader :screenshots
+
+  def initialize(movie, options = {})
+    @movie = movie
+    @start = options.fetch(:start)
+    @duration = Integer(options.fetch(:time))
+  end
+
+  def take_screenshots!
+    %x{ ffmpeg -v quiet -ss #{@start} -i #{@movie} -f image2 -vf fps=fps=1 /tmp/gifr_#{@movie.filename}_%d.png }
+
+    @screenshots = @duration.times.map do |i|
+      "/tmp/gifr_#{@movie.filename}_#{i+1}.png"
+    end
+  end
+end

data/lib/gifr/options_validator.rb

@@ -0,0 +1,16 @@
+class OptionsValidator
+  attr_reader :errors
+
+  def initialize(options)
+    @options = options
+    @errors = {}
+  end
+
+  def validate!
+    @options.fetch(:start) { @errors[:start] = "You must provide start" }
+    @options.fetch(:time) { @errors[:time] = "You must provide time" }
+    @options.fetch(:filename) { @errors[:filename] = "You must provide filename" }
+
+    @errors
+  end
+end

data/lib/gifr/version.rb

@@ -0,0 +1,3 @@
+module Gifr
+  VERSION = "1.0.0"
+end

data/spec/lib/gif_creator_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../spec_helper'
+require_relative '../../lib/gifr/gif_creator'
+
+describe GifCreator do
+  it 'makes a gif from selected videos' do
+    movie = Movie.new(filename: "spec/fixtures/example1.mp4")
+    movie_screenshoter = MovieScreenshoter.new(movie, start: "00:00:00", time: "6")
+
+    movie_screenshoter.take_screenshots!
+    screenshots = movie_screenshoter.screenshots
+
+    gif_creator = GifCreator.new(screenshots, { output: "video.gif" })
+    gif_creator.make_gif!
+
+    expect(File.exists?("video.gif")).to eq true
+  end
+
+   it 'makes a gif from selected videos' do
+    movie = Movie.new(filename: "spec/fixtures/example1.mp4")
+    movie_screenshoter = MovieScreenshoter.new(movie, start: "00:00:00", time: "6")
+
+    movie_screenshoter.take_screenshots!
+    screenshots = movie_screenshoter.screenshots
+
+    output = "spec/fixtures/video.gif"
+
+    gif_creator = GifCreator.new(screenshots, { output: output })
+    gif_creator.make_gif!
+
+    expect(File.exists?(output)).to eq true
+  end
+end

data/spec/lib/movie_screenshoter_spec.rb

@@ -0,0 +1,29 @@
+require_relative '../spec_helper'
+require_relative '../../lib/gifr/movie_screenshoter'
+
+describe MovieScreenshoter do
+  it 'takes a screenshots of a movie every 1 second for selected \
+      time period and start time and returns an array of created \
+      screenshots' do
+    movie = Movie.new(filename: 'spec/fixtures/example1.mp4')
+    movie_screenshoter = MovieScreenshoter.new(movie, { start: "00:00:00", time: "6"})
+    movie_screenshoter.take_screenshots!
+
+    expect(movie_screenshoter.screenshots)
+      .to match_array ["/tmp/gifr_example1.mp4_1.png", "/tmp/gifr_example1.mp4_2.png",
+        "/tmp/gifr_example1.mp4_3.png", "/tmp/gifr_example1.mp4_4.png",
+        "/tmp/gifr_example1.mp4_5.png", "/tmp/gifr_example1.mp4_6.png"]
+  end
+
+  it 'takes a screenshots of a movie every 1 second for selected \
+      time period and start time and takes that screenshots' do
+    movie = Movie.new(filename: 'spec/fixtures/example1.mp4')
+    movie_screenshoter = MovieScreenshoter.new(movie, { start: "00:00:00", time: "6"})
+
+    movie_screenshoter.take_screenshots!
+
+    movie_screenshoter.screenshots.each do |screenshot|
+      expect(File.exists?(screenshot)).to eq true
+    end
+  end
+end

data/spec/lib/movie_spec.rb

@@ -0,0 +1,46 @@
+require_relative '../spec_helper'
+require_relative '../../lib/gifr/movie'
+
+describe Movie do
+  describe 'instantiation' do
+    it "should raise ArgumentError if file not exists" do
+      expect{Movie.new({filename: "example.mp4"})}.to raise_error
+    end
+
+    it "should instantiate correctly if file exists" do
+      expect{Movie.new({filename: "spec/fixtures/example1.mp4"})}.to_not raise_error
+    end
+
+    it "should return movie length correctly" do
+      movie = Movie.new(filename: "spec/fixtures/example1.mp4")
+      expect(movie.length).to eq 6
+
+      movie2 = Movie.new(filename: "spec/fixtures/example2.mp4")
+      expect(movie2.length).to eq 6
+
+      movie3 = Movie.new(filename: "spec/fixtures/example3.mp4")
+      expect(movie3.length).to eq 5
+    end
+  end
+
+  describe 'to_path' do
+    it 'should return  path to the image' do
+      movie = Movie.new(filename: "spec/fixtures/example1.mp4")
+      expect(movie.to_path).to eq Pathname.new("spec/fixtures/example1.mp4")
+    end
+  end
+
+  describe 'to_s' do
+    it 'should return string representing the image path' do
+      movie = Movie.new(filename: "spec/fixtures/example1.mp4")
+      expect(movie.to_s).to eq "spec/fixtures/example1.mp4"
+    end
+  end
+
+  describe 'filename' do
+    it 'should return the movie filename' do
+      movie = Movie.new(filename: "spec/fixtures/example1.mp4")
+      expect(movie.filename).to eq Pathname.new("example1.mp4")
+    end
+  end
+end

data/spec/lib/options_validator_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require_relative '../../lib/gifr/options_validator'
+
+describe OptionsValidator do
+  it 'takes an empty hash and returns hash of errors' do
+    validator = OptionsValidator.new({})
+
+    expect(validator.validate!.keys).to match_array([:filename, :start, :time])
+  end
+
+  it 'takes time, returns hash of errors' do
+    options = {
+      start: '00:00:01',
+      time: '1',
+    }
+
+    validator = OptionsValidator.new(options)
+    expect(validator.validate!.keys).to match_array([:filename])
+  end
+
+  it 'takes only filename, returns hash of errors' do
+    options = {
+      filename: 'video.mp4'
+    }
+
+    validator = OptionsValidator.new(options)
+    expect(validator.validate!.keys).to match_array([:start, :time])
+  end
+
+  it 'takes correct options, returns no errors at all' do
+    options = {
+      start: '00:00:01',
+      time: '1',
+      filename: 'video.mp4'
+    }
+
+    validator = OptionsValidator.new(options)
+    expect(validator.validate!.keys).to be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: gifr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michał Darda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0beta2
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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: simplecov
+  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: rmagick
+  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'
+description: Simple solution to create gifs from short movies.
+email:
+- michaldarda@gmail.com
+executables:
+- gifr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gifr
+- features/features.feature
+- features/support.rb
+- gifr.gemspec
+- lib/gifr.rb
+- lib/gifr/gif_creator.rb
+- lib/gifr/movie.rb
+- lib/gifr/movie_screenshoter.rb
+- lib/gifr/options_validator.rb
+- lib/gifr/version.rb
+- spec/fixtures/example1.mp4
+- spec/fixtures/example2.mp4
+- spec/fixtures/example3.mp4
+- spec/lib/gif_creator_spec.rb
+- spec/lib/movie_screenshoter_spec.rb
+- spec/lib/movie_spec.rb
+- spec/lib/options_validator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple solution to create gifs from short movies.
+test_files:
+- features/features.feature
+- features/support.rb
+- spec/fixtures/example1.mp4
+- spec/fixtures/example2.mp4
+- spec/fixtures/example3.mp4
+- spec/lib/gif_creator_spec.rb
+- spec/lib/movie_screenshoter_spec.rb
+- spec/lib/movie_spec.rb
+- spec/lib/options_validator_spec.rb
+- spec/spec_helper.rb