MIAConverter 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71ab68fda7214edabf7743fe63b25c4cdb14299e
-  data.tar.gz: f573041fab7f2a9eba31d10b04a2948d39d690ee
+  metadata.gz: 22d03d2259857ad14d11debdba20612dedb13222
+  data.tar.gz: 9f00c996c33dd83708e5cb9646dcc186518f4b53
 SHA512:
-  metadata.gz: fda40d8ea927a402af01bd95371eb56387b0c6572d4f478023a75bfb85be75f6cf5056c401cd60b53b95f73c6eb59a1469d39e26366ed4c30819aec8003c1c0c
-  data.tar.gz: 8c66d551a93b5e07c289f4fe002b1797355b62074333d512df5c1b07fdd02f2a98f55e374f2d3ad1ad62319d6e3f523cab2777b8fb740208a7bd4f2a90c20dd3
+  metadata.gz: bd0b7688d3937fc751e76f4aa7a4cbee2a1f3388f2f4e3cf36bd7d1914691d3901e0e08bcddced7c1987863aecdcf43e3ba8ace981cd1cbf0f17de9c15495bad
+  data.tar.gz: cd3d453beebf289c8f6f244d2ce61e791ec8be0fae2f189b9a91b43d6a7a4efbb4b92a44de3eca693484748132fb1d83076ac2c4868113b6f094a698041680a1

data/MIAConverter.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: MIAConverter 0.2.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "MIAConverter"
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Nash"]
+  s.date = "2013-12-11"
+  s.description = "Turns a video file into an animated gif."
+  s.email = "martin.j.nash@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "MIAConverter.gemspec",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "example/1386362824-tt40-gap0.5animated.gif",
+    "example/gem_example.rb",
+    "example/typing.mp4",
+    "lib/MIAConverter.rb",
+    "spec/MIAConverter_spec.rb",
+    "spec/spec_helper.rb",
+    "test/helper.rb",
+    "test/test_MIAConverter.rb"
+  ]
+  s.homepage = "http://github.com/MartinJNash/MIAConverter"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.11"
+  s.summary = "Turns a video file into an animated gif."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<streamio-ffmpeg>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<rmagick>, ["~> 2.13.2"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.14.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+    else
+      s.add_dependency(%q<streamio-ffmpeg>, ["~> 1.0.0"])
+      s.add_dependency(%q<rmagick>, ["~> 2.13.2"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.14.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    end
+  else
+    s.add_dependency(%q<streamio-ffmpeg>, ["~> 1.0.0"])
+    s.add_dependency(%q<rmagick>, ["~> 2.13.2"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.14.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+  end
+end
+

data/README.md

@@ -1,6 +1,7 @@
 = MIAConverter
 
 ![Travis Status](https://api.travis-ci.org/MartinJNash/MIAConverter.png)
+![Gem Version](https://badge.fury.io/rb/MIAConverter.png)
 
 == Contributing to MIAConverter
  

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/MIAConverter.rb

@@ -3,22 +3,25 @@ require 'streamio-ffmpeg'
 
 module MIAConverter
 
-	# LOG TO FILE, NOT CONSOLE
-	# Dir.mkdir("/tmp/MIAConverter/logs") unless Dir.exists?("/tmp/MIAConverter/logs")
-	# FFMPEG.logger = Logger.new('/tmp/MIAConverter/logs/ffmpeglog.txt');
+	# Converts a video to an animated GIF.
+
 
 
 	class Converter
 		
-		# INPUT FILE
+		# Path to original file
 		attr_accessor :original_file
 
-		# VIDEO OPTiONS
+		# Number of seconds into original video to start animated GIF
 		attr_accessor :start_seconds
+
+		# Number of seconds of original video represented in animated GIF
 		attr_accessor :length_seconds
-		attr_accessor :shot_gap # seconds apart to take shots
 
-		# IMAGE OPTIONS
+		# seconds apart to take video screenshots
+		attr_accessor :shot_gap
+
+		# Time between animated GIF frame transitions
 		attr_accessor :transition_time
 
 
@@ -39,12 +42,16 @@ module MIAConverter
 			options.each {|key,value| self.instance_variable_set("@#{key}", value) }
 		end
 
-
+		# Tests if the passed in original file exists
 		def original_file_valid?
 			File.exists? @original_file
 		end
 
-	
+
+		# Processes input video
+		# * extracts relevant parts of original video
+		# * produces screenshots
+		# * turns screenshots into an animated GIF
 		def process
 			extract_relevant_parts_of_video
 			create_still_images
@@ -58,27 +65,31 @@ module MIAConverter
 
 
 
-		# 
-		# FOLDERS
-		# 
+		# Returns path to /tmp/MIAConverter. 
+		# Creates foler if necessary.
 		def base_folder
 			temp_folder_path = "/tmp/MIAConverter"
 			Dir.mkdir(temp_folder_path) unless Dir.exists?(temp_folder_path)
 			temp_folder_path
 		end
 
+		# Returns path to temporary folder for this run of the converter object.
+		# Creates folder if necessary.
 		def get_temp_folder
 			current_tmp_path = "#{base_folder}/#{time_second_string}"
 			Dir.mkdir(current_tmp_path) unless Dir.exists?(current_tmp_path)
 			current_tmp_path
 		end
 
+		# Returns images folder for this run of the converter object.
+		# Creates folder if necessary.
 		def get_images_folder
 			images_folder_path = "#{get_temp_folder}/images"
 			Dir.mkdir(images_folder_path) unless Dir.exists?(images_folder_path)
 			images_folder_path
 		end
 
+		# Returns number string based on time object was created.
 		def time_second_string
 			@init_time.to_f.to_s.sub('.', '-')
 		end
@@ -95,10 +106,12 @@ module MIAConverter
     	"#{get_temp_folder}/#{animated_gif_file_name}"
     end
 
+    # Alias for get_images_folder
     def screenshots_folder_path
     	get_images_folder
     end
 
+    # Array of all .jpg filenames in images folder
     def still_image_paths
     	Dir["#{get_images_folder}/*.jpg"]
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: MIAConverter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Martin Nash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: streamio-ffmpeg
@@ -121,6 +121,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- MIAConverter.gemspec
 - README.md
 - Rakefile
 - VERSION