animated_gif_detector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6617cd4c8a65784f425fd843ddc2fdb4b412d301
+  data.tar.gz: 4382a87a00ffa9a519f527151c9d540f5561dc53
+SHA512:
+  metadata.gz: 1fb8c50418b3e149e6c44c6cf3d4efd322b85150f528b8b757a0289d5abffab62eb4791c44ef6ca63b0cea648306d25b793ca6f36cbbcd0a15874c00483f32b9
+  data.tar.gz: d94c821f84c7462d8342c58df64f63f9ecfcd0e78583bee55d019f3a6da94b8261584e34ebba9fe923dcc8cf094f7da15218d1309e2621474a51428657ddd06d

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,48 @@
+[![Build Status](https://travis-ci.org/bfolkens/ruby-animated-gif-detector.svg?branch=master)](https://travis-ci.org/bfolkens/ruby-animated-gif-detector)
+
+# AnimatedGifDetector
+
+A simple utility to determine if a GIF is animated, and how many frames it contains.  Only 2 frames are needed to determine if the GIF is "animated", so the user has the option to specify an option to return immediately or keep counting frames.  Designed for use on a stream to avoid unnecessary memory usage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'animated_gif_detector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install animated_gif_detector
+
+## Usage
+
+One-liner:
+
+```ruby
+AnimatedGifDetector.new(File.open('your_image.gif', 'rb')).animated?
+```
+
+Customizable:
+
+```ruby
+io = File.open('your_image.gif', 'rb')
+detector = AnimatedGifDetector.new(io, terminate_after: false)
+detector.animated? # true
+detector.frames # 3
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bfolkens/animated_gif_detector.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/animated_gif_detector.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'animated_gif_detector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "animated_gif_detector"
+  spec.version       = AnimatedGifDetector::VERSION
+  spec.authors       = ["Bradford Folkens"]
+  spec.email         = ["bfolkens@gmail.com"]
+
+  spec.summary       = %q{Animated GIF detection in pure ruby}
+  spec.description   = %q{Reads a stream and determines if it's an animated GIF}
+  spec.homepage      = "https://github.com/bfolkens/ruby-animated-gif-detector"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "animated_gif_detector"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/animated_gif_detector.rb

@@ -0,0 +1,55 @@
+require "animated_gif_detector/version"
+
+class AnimatedGifDetector
+  class UnrecognizedFileFormatException < Exception; end
+  class EOFWithoutFrameException < Exception; end
+
+  # http://www.matthewflickinger.com/lab/whatsinagif/animation_and_transparency.asp
+
+  attr_reader :frames
+
+  BLOCK_TERMINATOR = 0x00.chr
+  GRAPHIC_CONTROL_EXTENSION_MAGIC = 0x21.chr + 0xF9.chr
+  BLOCK_SIZE = (BLOCK_TERMINATOR + GRAPHIC_CONTROL_EXTENSION_MAGIC).size
+
+  def initialize(io, options = {})
+    @options = { buffer_size: 1024, terminate_after: true }.merge(options)
+    @stream = io
+    @frames = 0
+  end
+
+  def animated?
+    raise UnrecognizedFileFormatException unless @stream.read(3) == 'GIF'
+
+    lookback = ''
+    animated = false
+    while data = @stream.read(@options[:buffer_size])
+      @frames += count_substring_matches(lookback + data, BLOCK_TERMINATOR + GRAPHIC_CONTROL_EXTENSION_MAGIC)
+      animated = @frames > 1
+
+      return true if @options[:terminate_after] and animated
+
+      lookback = last_characters(data, BLOCK_SIZE - 1)
+    end
+
+    raise EOFWithoutFrameException if @frames == 0
+    return animated
+  end
+
+  private
+
+  def count_substring_matches(str, match)
+    last_pos = 0
+    count = 0
+    while pos = str.index(match, last_pos)
+      count += 1
+      last_pos = pos + match.length
+    end
+
+    count
+  end
+
+  def last_characters(str, n)
+    str[-n..-1] || ''
+  end
+end

data/lib/animated_gif_detector/version.rb

@@ -0,0 +1,3 @@
+class AnimatedGifDetector
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: animated_gif_detector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bradford Folkens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Reads a stream and determines if it's an animated GIF
+email:
+- bfolkens@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- animated_gif_detector.gemspec
+- bin/console
+- bin/setup
+- lib/animated_gif_detector.rb
+- lib/animated_gif_detector/version.rb
+homepage: https://github.com/bfolkens/ruby-animated-gif-detector
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Animated GIF detection in pure ruby
+test_files: []