ruby-imagespec 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/LICENSE

@@ -0,0 +1,28 @@
+# Copyright (c) 2008, Brandon Anderson (anderson.brandon@gmail.com)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 
+# Neither the name of the original author nor the names of contributors
+# may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#

data/README

@@ -0,0 +1,30 @@
+ImageSpec
+=========
+
+ImageSpec is a lightweight module designed to extract width/height dimensions from most standard image formats, as well as SWFs.
+
+This is a work in progress.  I intend on expanding this to include other details (EXIF, various metadata, etc.) as well.
+
+
+Example
+=======
+
+# From a file in your file system
+instance = ImageSpec.new('/path/to/your/file')
+
+# From a URL
+instance = ImageSpec.new('http://example.com/image.png')
+
+# From an IO stream
+file = File.new('/path/to/your/file', 'rb')
+instance = ImageSpec.new(file)
+
+instance.width
+instance.height
+instance.content_type
+
+Pretty simple, huh?
+
+Copyright (c) 2008 Brandon Anderson, released under the MIT license
+
+Contributions by Michael Sheakoski and Mike Boone

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the image_spec plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the image_spec plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ImageSpec'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ruby-imagespec"
+    gemspec.summary = "Image/Flash extract width/height dimensions extractor"
+    gemspec.description = "A lightweight module designed to extract the width/height dimensions of various image types. Also supports SWFs."
+    gemspec.email = "dimitrij@blacksquaremedia.com"
+    gemspec.homepage = "http://github.com/dim/ruby-imagespec"
+    gemspec.authors = [
+      "Brandon Anderson",
+      "Michael Sheakoski",
+      "Mike Boone",
+      "Dimitrij Denissenko"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'image_spec')

data/lib/image_spec.rb

@@ -0,0 +1,30 @@
+require 'open-uri'
+require File.join(File.dirname(__FILE__), 'parser')
+
+class ImageSpec
+
+  def initialize(file)
+    @attributes = Parser.parse(stream_for(file))
+
+    @attributes.each do |key, value|
+      instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{key}
+          @attributes[:#{key}]
+        end
+      RUBY
+    end
+  end
+
+  private
+
+  def stream_for(file)
+    if file.respond_to?(:read)
+      file
+    elsif file.is_a?(String)
+      open(file, 'rb')
+    else
+      raise "Unable to get stream for #{file.inspect}"
+    end
+  end
+
+end

data/lib/parser.rb

@@ -0,0 +1,20 @@
+Dir[File.join(File.dirname(__FILE__), 'parser/*.rb')].each { |parser| require parser }
+
+class ImageSpec
+
+  module Parser
+
+    def self.formats
+      @@formats ||= constants.collect { |format| const_get(format) }
+    end
+
+    def self.parse(stream)
+      formats.each do |format|
+        return format.attributes(stream) if format.detected?(stream)
+      end
+      raise "#{stream.inspect} is not a supported image format. Sorry bub :("
+    end
+
+  end
+
+end

data/lib/parser/gif.rb

@@ -0,0 +1,28 @@
+class ImageSpec
+
+  module Parser
+
+    class GIF
+
+      CONTENT_TYPE = 'image/gif'
+
+      def self.attributes(stream)
+        width, height = dimensions(stream)
+        {:width => width, :height => height, :content_type => CONTENT_TYPE}
+      end
+
+      def self.detected?(stream)
+        stream.rewind
+        stream.read(4) == 'GIF8'
+      end
+
+      def self.dimensions(stream)
+        stream.seek(6)
+        stream.read(4).unpack('SS')
+      end
+
+    end
+
+  end
+
+end

data/lib/parser/jpeg.rb

@@ -0,0 +1,69 @@
+class ImageSpec
+
+  module Parser
+
+    class JPEG
+
+      CONTENT_TYPE = 'image/jpeg'
+
+      def self.attributes(stream)
+        width, height = dimensions(stream)
+        {:width => width, :height => height, :content_type => CONTENT_TYPE}
+      end
+
+      def self.detected?(stream)
+        stream.rewind
+        case stream.read(10)
+          when /^\xff\xd8\xff\xe0\x00\x10JFIF/ then true
+          when /^\xff\xd8\xff\xe1(.*){2}Exif/  then true
+          else false
+        end
+      end
+
+      def self.dimensions(stream)
+        stream.rewind
+        raise 'malformed JPEG' unless stream.getc == 0xFF && stream.getc == 0xD8 # SOI
+
+        class << stream
+          def readint
+            (readchar << 8) + readchar
+          end
+
+          def readframe
+            read(readint - 2)
+          end
+
+          def readsof
+            [readint, readchar, readint, readint, readchar]
+          end
+
+          def next
+            c = readchar while c != 0xFF
+            c = readchar while c == 0xFF
+            c
+          end
+        end
+
+        while marker = stream.next
+          case marker
+          when 0xC0..0xC3, 0xC5..0xC7, 0xC9..0xCB, 0xCD..0xCF
+            length, bits, height, width, components = stream.readsof
+            raise 'malformed JPEG' unless length == 8 + components * 3
+            return [width, height]
+          when 0xD9, 0xDA
+            break
+          when 0xFE
+            @comment = stream.readframe
+          when 0xE1
+            stream.readframe
+          else
+            stream.readframe
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/parser/png.rb

@@ -0,0 +1,28 @@
+class ImageSpec
+
+  module Parser
+
+    class PNG
+
+      CONTENT_TYPE = 'image/png'
+
+      def self.attributes(stream)
+        width, height = dimensions(stream)
+        {:width => width, :height => height, :content_type => CONTENT_TYPE}
+      end
+
+      def self.detected?(stream)
+        stream.rewind
+        stream.read(4) == "\x89PNG"
+      end
+
+      def self.dimensions(stream)
+        stream.seek(0x10)
+        stream.read(8).unpack('NN')
+      end
+
+    end
+
+  end
+
+end

data/lib/parser/swf.rb

@@ -0,0 +1,77 @@
+require 'zlib'
+
+class ImageSpec
+
+  module Parser
+
+    class SWF
+
+      CONTENT_TYPE = 'application/x-shockwave-flash'
+
+      def self.attributes(stream)
+        width, height = dimensions(stream)
+        {:width => width, :height => height, :content_type => CONTENT_TYPE}
+      end
+
+      def self.detected?(stream)
+        stream.rewind
+        stream.read(3) =~ /(F|C)WS/ ? true : false
+      end
+
+      def self.dimensions(stream)
+        # Read the entire stream into memory because the
+        # dimensions aren't stored in a standard location
+        stream.rewind
+        contents = stream.read
+
+        # Our 'signature' is the first 3 bytes
+        # Either FWS or CWS.  CWS indicates compression
+        signature = contents[0..2]
+
+        # Determine the length of the uncompressed stream
+        length = contents[4..7].unpack('V').join.to_i
+        
+        # If we do, in fact, have compression
+        if signature == 'CWS'
+          # Decompress the body of the SWF
+          body = Zlib::Inflate.inflate( contents[8..length] )
+          
+          # And reconstruct the stream contents to the first 8 bytes (header)
+          # Plus our decompressed body
+          contents = contents[0..7] + body
+        end
+
+        # Determine the nbits of our dimensions rectangle
+        nbits =contents.unpack('c'*contents.length)[8] >> 3
+
+        # Determine how many bits long this entire RECT structure is
+        rectbits = 5 + nbits * 4    # 5 bits for nbits, as well as nbits * number of fields (4)
+
+        # Determine how many bytes rectbits composes (ceil(rectbits/8))
+        rectbytes = (rectbits.to_f / 8).ceil
+
+        # Unpack the RECT structure from the stream in little-endian bit order, then join it into a string
+        rect = contents[8..(8 + rectbytes)].unpack("#{'B8' * rectbytes}").join()
+
+        # Read in nbits incremenets starting from 5
+        dimensions = Array.new
+        4.times do |n|
+          s = 5 + (n * nbits)     # Calculate our start index
+          e = s + (nbits - 1)     # Calculate our end index
+          dimensions[n] = rect[s..e].to_i(2)    # Read that range (binary) and convert it to an integer
+        end
+
+        # The values we have here are in "twips"
+        # 20 twips to a pixel (that's why SWFs are fuzzy sometimes!)
+        width   = (dimensions[1] - dimensions[0]) / 20
+        height  = (dimensions[3] - dimensions[2]) / 20
+
+        # If you can't figure this one out, you probably shouldn't have read this far
+        return [width, height]
+      end
+
+    end
+
+  end
+
+end

data/ruby-imagespec.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-imagespec}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brandon Anderson", "Michael Sheakoski", "Mike Boone", "Dimitrij Denissenko"]
+  s.date = %q{2010-08-16}
+  s.description = %q{A lightweight module designed to extract the width/height dimensions of various image types. Also supports SWFs.}
+  s.email = %q{dimitrij@blacksquaremedia.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/image_spec.rb",
+     "lib/parser.rb",
+     "lib/parser/gif.rb",
+     "lib/parser/jpeg.rb",
+     "lib/parser/png.rb",
+     "lib/parser/swf.rb",
+     "ruby-imagespec.gemspec",
+     "tasks/image_spec_tasks.rake",
+     "test/image_spec_test.rb"
+  ]
+  s.homepage = %q{http://github.com/dim/ruby-imagespec}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Image/Flash extract width/height dimensions extractor}
+  s.test_files = [
+    "test/image_spec_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/tasks/image_spec_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :image_spec do
+#   # Task goes here
+# end

data/test/image_spec_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class ImageSpecTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-imagespec
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brandon Anderson
+- Michael Sheakoski
+- Mike Boone
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-16 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A lightweight module designed to extract the width/height dimensions of various image types. Also supports SWFs.
+email: dimitrij@blacksquaremedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/image_spec.rb
+- lib/parser.rb
+- lib/parser/gif.rb
+- lib/parser/jpeg.rb
+- lib/parser/png.rb
+- lib/parser/swf.rb
+- ruby-imagespec.gemspec
+- tasks/image_spec_tasks.rake
+- test/image_spec_test.rb
+has_rdoc: true
+homepage: http://github.com/dim/ruby-imagespec
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Image/Flash extract width/height dimensions extractor
+test_files: 
+- test/image_spec_test.rb