giftrim 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzFkZDExNDVjYTA0YTFlYzYxZGNmZGJiODIwYWRjYjBkYTJhMjcwMg==
+  data.tar.gz: !binary |-
+    YzNmYTA0NGU5ZTVkNTY1N2ZjYmVjY2IwZWI5NjQ4NThhYTU1MWRjMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NWYwNzAyYjc1ZWEyZTcyYTNmMDZkM2Q0ZTlkYzcwYTNkNGM3NGYyMGMwNDQx
+    ZDk1ODE2NjZkZDY4MzQxM2JmYmE1MmQ4MWU2ZjY5N2NlZTEwNTk4NWZjYjc5
+    ZjVmMTk4MTY4MjRkOTg2MjY4NzY5Mjk4YTQ4NGMzYjIwNDA4M2I=
+  data.tar.gz: !binary |-
+    N2EyMTRhZmU4YTQxOTU4M2QyZWI4MDk2YzgwZTIzZWU0MDkyZGM1ZWNkY2Qw
+    MDJkNjA1ZjllYzljMTkyYTgwZmZjZTVjNjFkMzk1MWI1MjI1Y2I1OWUzNmQ0
+    NTYwMjBkZDQ1YzMyMDQ4YjBkMmYzNTMwYmJiYjJjMDFmM2U3M2I=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Leo Lou
+
+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/LICENSE_MiniMagick.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2005-2013 Corey Johnson probablycorey@gmail.com
+
+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,43 @@
+# Giftrim
+
+Provide convenient methods for GIF optimizations using gifsicle
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "giftrim"
+
+## Usage
+
+### Resize to 300x300, and trim to 10 frames
+```
+image = Giftrim::Image.open "input.gif"
+image.trim
+image.write "output.gif"
+```
+
+## Contributing
+
+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
+
+## License
+
+See LICENSE.txt and LICENSE_MiniMagick.txt
+
+The Testing GIF was retrieved from
+http://commons.wikimedia.org/wiki/File:Lightnings_sequence_2_animation.gif
+licensed under [Creative Commons Attribution-Share Alike 2.5 Generic](http://creativecommons.org/licenses/by-sa/2.5/deed.en) license
+
+## Alternatives
+
+The first version was at the branch *minimagick*. It adds frames trimming
+methods to MiniMagick::Image. However, from my tests mogrify is not accepting
+`-delete ranges`, such as `-delete 1-2,4,6`.
+
+This version uses gifsicle instead of ImageMagick which allows selecting frames
+to be included.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/giftrim.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'giftrim/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "giftrim"
+  spec.version       = Giftrim::VERSION
+  spec.authors       = ["Leo Lou"]
+  spec.email         = ["louyuhong@gmail.com"]
+  spec.description   = "GIF optimizations using gifsicle"
+  spec.summary       = "GIF optimizations using gifsicle "
+  spec.homepage      = "https://github.com/l4u/giftrim"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency("simplecov", "~> 0.7")
+  spec.add_development_dependency("simplecov-gem-adapter", "~> 1.0.1")
+  spec.add_runtime_dependency("subexec", ["~> 0.2.2"])
+
+
+end

data/lib/core_ext/array.rb

@@ -0,0 +1,7 @@
+# From http://stackoverflow.com/questions/11903839/algorithm-to-spread-selection-over-a-fixed-size-array
+class Array
+  def spread(n)
+    step = self.length.to_f / n
+    array = (0..(n - 1)).to_a.collect{|i| self[(i * step)]}.uniq
+  end
+end

data/lib/giftrim/version.rb

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

data/lib/giftrim.rb

@@ -0,0 +1,190 @@
+require 'tempfile'
+require 'subexec'
+require 'stringio'
+require 'pathname'
+require_relative "giftrim/version"
+require_relative "core_ext/array"
+module Giftrim
+  class << self
+    attr_accessor :timeout
+
+    def frame_number_wanted total_number, target_number
+      (0..(total_number-2)).to_a.spread(target_number)
+    end
+  end
+
+  class Image
+    # @return [String] The location of the current working file
+    attr_accessor :path
+
+    class << self
+
+      # Modified from MiniMagick, see License_MiniMagick
+      # This is the primary loading method used by all of the other class methods.
+      #
+      # Use this to pass in a stream object. Must respond to Object#read(size) or be a binary string object (BLOBBBB)
+      #
+      # As a change from the old API, please try and use IOStream objects. They are much, much better and more efficient!
+      #
+      # Probably easier to use the #open method if you want to open a file or a URL.
+      #
+      # @param stream [IOStream, String] Some kind of stream object that needs to be read or is a binary String blob!
+      # @param ext [String] A manual extension to use for reading the file. Not required, but if you are having issues, give this a try.
+      # @return [Image]
+      def read(stream, ext = nil)
+        if stream.is_a?(String)
+          stream = StringIO.new(stream)
+        elsif stream.is_a?(StringIO)
+          # Do nothing, we want a StringIO-object
+        elsif stream.respond_to? :path
+          if File.respond_to?(:binread)
+            stream = StringIO.new File.binread(stream.path.to_s)
+          else
+            stream = StringIO.new File.open(stream.path.to_s,"rb") { |f| f.read }
+          end
+        end
+
+        create(ext) do |f|
+          while chunk = stream.read(8192)
+            f.write(chunk)
+          end
+        end
+      end
+
+      # Modified from MiniMagick, see License_MiniMagick
+      # Opens a specific image file either on the local file system or at a URI.
+      #
+      # Use this if you don't want to overwrite the image file.
+      #
+      # Extension is either guessed from the path or you can specify it as a second parameter.
+      #
+      # If you pass in what looks like a URL, we require 'open-uri' before opening it.
+      #
+      # @param file_or_url [String] Either a local file path or a URL that open-uri can read
+      # @param ext [String] Specify the extension you want to read it as
+      # @return [Image] The loaded image
+      def open(file_or_url, ext = nil)
+        file_or_url = file_or_url.to_s # Force it to be a String... hell or highwater
+        if file_or_url.include?("://")
+          require 'open-uri'
+          ext ||= File.extname(URI.parse(file_or_url).path)
+          self.read(Kernel::open(file_or_url), ext)
+        else
+          ext ||= File.extname(file_or_url)
+          File.open(file_or_url, "rb") do |f|
+            self.read(f, ext)
+          end
+        end
+      end
+
+      # Modified from MiniMagick, see License_MiniMagick
+      # Used to create a new Image object data-copy. Not used to "paint" or that kind of thing.
+      #
+      # Takes an extension in a block and can be used to build a new Image object. Used
+      # by both #open and #read to create a new object! Ensures we have a good tempfile!
+      #
+      # @param ext [String] Specify the extension you want to read it as
+      # @param validate [Boolean] If false, skips validation of the created image. Defaults to true.
+      # @yield [IOStream] You can #write bits to this object to create the new Image
+      # @return [Image] The created image
+      def create(ext = nil, validate = true, &block)
+        begin
+          tempfile = Tempfile.new(['giftrim_', ext.to_s.downcase])
+          tempfile.binmode
+          block.call(tempfile)
+          tempfile.close
+
+          image = self.new(tempfile.path, tempfile)
+
+          if validate and !image.valid?
+            raise Giftrim::Invalid
+          end
+          return image
+        ensure
+          tempfile.close if tempfile
+        end
+      end
+
+    end
+
+    # Modified from MiniMagick, see License_MiniMagick
+    # Create a new MiniMagick::Image object
+    #
+    # _DANGER_: The file location passed in here is the *working copy*. That is, it gets *modified*.
+    # you can either copy it yourself or use the MiniMagick::Image.open(path) method which creates a
+    # temporary file for you and protects your original!
+    #
+    # @param input_path [String] The location of an image file
+    # @todo Allow this to accept a block that can pass off to Image#combine_options
+    def initialize(input_path, tempfile = nil)
+      @path = input_path
+      @tempfile = tempfile # ensures that the tempfile will stick around until this image is garbage collected.
+    end
+
+    # @return [Boolean]
+    def valid?
+      # TODO
+      true
+    end
+
+    def run_command command
+      sub = Subexec.run(command, :timeout => Giftrim.timeout)
+      if sub.exitstatus == 0
+        sub.output
+      else
+        raise Error, "Command (#{command.inspect.gsub("\\", "")}) failed: #{{:status_code => sub.exitstatus, :output => sub.output}.inspect}"
+      end
+    end
+
+    # Modified from MiniMagick, see License_MiniMagick
+    # Writes the temporary file out to either a file location (by passing in a String) or by
+    # passing in a Stream that you can #write(chunk) to repeatedly
+    #
+    # @param output_to [IOStream, String] Some kind of stream object that needs to be read or a file path as a String
+    # @return [IOStream, Boolean] If you pass in a file location [String] then you get a success boolean. If its a stream, you get it back.
+    # Writes the temporary image that we are using for processing to the output path
+    def write(output_to)
+      if output_to.kind_of?(String) || !output_to.respond_to?(:write)
+        FileUtils.copy_file @path, output_to
+        run_command "identify #{output_to}" # Verify that we have a good image
+      else # stream
+        File.open(@path, "rb") do |f|
+          f.binmode
+          while chunk = f.read(8192)
+            output_to.write(chunk)
+          end
+        end
+        output_to
+      end
+    end
+
+    def number_of_frames
+      command = "gifsicle --info #{@path}"
+      output = run_command command
+      if output
+        first_line = output.lines.first
+        number_of_frames = first_line.scan(/\d+[ \t]*images/).first.to_i
+      end
+      number_of_frames
+    end
+
+    def trim
+      # --batch to modify the GIF file in place (not working for frames)
+      frames = Giftrim::frame_number_wanted self.number_of_frames, 10
+      frames_formatted = frames.map{|frame| "\"##{frame}\""}.join " "
+
+      @outfile = Tempfile.new('giftrim_')
+      @outfile.binmode
+      @outfile.close
+
+      command = "gifsicle --resize-fit '300x300' #{@path} #{frames_formatted} > #{@outfile.path}"
+      output = run_command command
+      if output
+        @tempfile = @outfile
+        @path = @tempfile.path
+        @outfile = nil
+      end
+      output
+    end
+  end
+end

data/test/giftrim_test.rb

@@ -0,0 +1,40 @@
+require_relative "test_helper"
+require File.expand_path('../../lib/giftrim.rb', __FILE__)
+
+describe Giftrim do
+  it "must return frames wanted" do
+    frames = Giftrim::frame_number_wanted 30, 20
+    frames.length.must_equal 20
+    frames.must_equal [0, 1, 2, 4, 5, 7, 8, 10, 11, 13, 14, 15, 17, 18, 20, 21, 23, 24, 26, 27]
+
+    target_number = 20
+    (20..40).to_a.each do |i|
+      frames = Giftrim::frame_number_wanted i, target_number
+      frames.length.must_be :<=, target_number
+    end
+  end
+
+  describe "when number of frames is smaller than the target number" do
+    it "must return frames to be removed" do
+      frames = Giftrim::frame_number_wanted 10, 20
+      frames.must_equal [0, 1, 2, 3, 4, 5, 6, 7, 8]
+    end
+  end
+
+  it "must get the number of frames" do
+    image = Giftrim::Image.open "test/gifs/0.gif"
+    image.number_of_frames.must_equal 10
+  end
+
+  it "should trim a gif" do
+    Giftrim.timeout = 10
+
+    Dir.glob("test/gifs/*.gif").each do |file|
+      image = Giftrim::Image.open file
+      image.trim
+      image.number_of_frames.must_be :<=, 10
+      image.number_of_frames.must_be :>=, 1
+      image.write "test/gifs/output/#{File.basename(file)}"
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+require 'simplecov-gem-adapter'
+SimpleCov.start 'gem'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: giftrim
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leo Lou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-04 00:00:00.000000000 Z
+dependencies:
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov-gem-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: subexec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: GIF optimizations using gifsicle
+email:
+- louyuhong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- LICENSE_MiniMagick.txt
+- README.md
+- Rakefile
+- giftrim.gemspec
+- lib/core_ext/array.rb
+- lib/giftrim.rb
+- lib/giftrim/version.rb
+- test/gifs/0.gif
+- test/giftrim_test.rb
+- test/test_helper.rb
+homepage: https://github.com/l4u/giftrim
+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: GIF optimizations using gifsicle
+test_files:
+- test/gifs/0.gif
+- test/giftrim_test.rb
+- test/test_helper.rb