swf_file 0.1.0 → 1.0.0

data/{README → README.rdoc}

@@ -1,4 +1,4 @@
-==Introduction
+=swf_file
   Based on the swfutil lib, by Dennis Zhuang, the SWF File is lightweight gem to read swf file headers from within a Ruby application.
 
 ==Ruby compatibility
@@ -14,7 +14,23 @@
   Please refer to the LICENSE file.
 
 ==Example
-  TODO
+  swf = SwfFile.header 'clicktag.swf' # load the file
+  
+  # Access the various header options. Please check the unit tests for more usage examples.
+  puts swf.size
+  puts swf.compressed?
+  puts swf.version
+  puts swf.bit_count
+  puts swf.xmax
+  puts swf.ymax
+  puts swf.width # In pixels
+  puts swf.height # In pixels
+  puts swf.frame_rate
+  puts swf.frame_count
+  puts swf.duration # In milliseconds
+  puts swf.avm_version
+  puts swf.signature
+  
 
 ==Issues, improvements, feedback an suggestions
   To report issues, please use GitHub's issue manager (http://github.com/DBA/swf_file/issues). Meanwhile, feel free to fork the project and submit your modifications.
@@ -23,5 +39,5 @@
   
 ==Pending
   * Cleanup the class PackedBitObject, which still suffers from the pure import from SwfUtil
-  * Modularize SwfHeader a bit more
-  * Docs
+  * Docs
+  * Modularize SwfHeader a bit more

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/lib/swf_file/assertions.rb

@@ -0,0 +1,10 @@
+module Assertions
+  def compressed?(memoize_result = true)
+    buffer_compressed?(memoize_result)
+  end
+  
+  private
+    def swf?
+      @buffer[0,3] == 'FWS' || @buffer[0,3] == 'CWS'
+    end
+end

data/lib/swf_file/compression.rb

@@ -4,7 +4,7 @@ module Compression
       if memoize_result
         @compressed ||= @buffer[0].ord == ?C.ord
       else
-        @buffer[0].ord == ?C.ord
+        @compressed = @buffer[0].ord == ?C.ord
       end
     end
 

data/lib/swf_file/conversions.rb

@@ -1,4 +1,23 @@
 module Conversions
+  def to_s
+    "#{@file} #{@width}x#{@height} #{@frame_rate}fps"
+  end
+  
+  def to_hash
+    { :file         => @file,
+      :signature    => @signature,
+      :version      => @version,
+      :avm_version  => @avm_version,
+      :size         => @size,
+      :bit_count    => @bit_count,
+      :xmax         => @xmax,
+      :ymax         => @ymax,
+      :width        => @width,
+      :height       => @height,
+      :frame_rate   => @frame_rate,
+      :frame_count  => @frame_count }
+  end
+  
   module Twips
     def self.from_pixels(pixels)
       pixels * 20
@@ -10,21 +29,4 @@ module Conversions
       twips / 20
     end
   end
-  
-  module Hash
-    def self.from_swf_header(header)
-      { file: header.file,
-        signature:    header.signature,
-        version:      header.version,
-        avm_version:  header.avm_version,
-        size:         header.size,
-        bit_count:    header.bit_count,
-        xmax:         header.xmax,
-        ymax:         header.ymax,
-        width:        header.width,
-        height:       header.height,
-        frame_rate:   header.frame_rate,
-        frame_count:  header.frame_count }
-    end
-  end
 end

data/lib/swf_file/packed_bit_object.rb

@@ -1,54 +1,47 @@
-# TODO: Needs refactoring & cleanup
-
 class PackedBitObject
   attr_accessor :bitIndex, :byteIndex, :value, :nextBitIndex, :nextByteIndex, :nextByteBoundary
   
-  def initialize(bitMarker,byteMarker,decimalValue)
-    @bitIndex = bitMarker;
-    @byteIndex = byteMarker;
-    @value = decimalValue;
-    @nextBitIndex = bitMarker;
-    if ( bitMarker <= 7 )
-      @nextBitIndex+=1
-      @nextByteIndex =byteMarker
-      @nextByteBoundary = (byteMarker+=1)
+  def initialize(bitMarker, byteMarker, decimalValue)
+    @nextBitIndex = @bitIndex = bitMarker
+    @byteIndex    = byteMarker
+    @value        = decimalValue
+    
+    if bitMarker <= 7
+      @nextBitIndex     += 1
+      @nextByteIndex    = byteMarker
+      @nextByteBoundary = byteMarker += 1
     else
-      @nextBitIndex = 0
-      @nextByteIndex+=1
+      @nextBitIndex     = 0
+      @nextByteIndex    +=1
       @nextByteBoundary = @nextByteIndex;
     end
   end
   
   def self.from_packed_bits(bytes, byte_marker, bit_marker, length)
-    total = 0
-    shift = 7 - bit_marker 
-    counter = 0 
-    bit_index = bit_marker 
-    byte_index = byte_marker 
+    counter     = total = 0
+    shift       = 7 - bit_marker
+    bit_index   = bit_marker
+    byte_index  = byte_marker
 
-    while counter<length
+    while counter < length
       (bit_marker...8).each do |i|
-        bit =((bytes[byte_marker].ord & 0xff ) >> shift ) & 1
-        total = ( total << 1 ) + bit
+        bit       = ((bytes[byte_marker].ord & 0xff ) >> shift) & 1
+        total     = (total << 1) + bit
         bit_index = i
-        shift-=1
-        counter+=1
+        shift     -= 1
+        counter   += 1
 
-        if counter==length
-          break
-        end
+        break if counter == length
       end
 
-      byte_index = byte_marker
-      byte_marker+=1
-      bit_marker = 0
-      shift = 7
+      byte_index  = byte_marker
+      byte_marker +=1
+      bit_marker  = 0
+      shift       = 7
     end
 
     pbo = PackedBitObject.new(bit_index, byte_index, total)
-    
     yield pbo if block_given?
-    
     pbo
   end
 end

data/lib/swf_file/parser.rb

@@ -1,2 +1,48 @@
 module Parser
+  private
+    def parse_header
+      @buffer, @size = get_swf_buffer_and_size
+      raise RuntimeError, "The provided file does not appear to be an SWF", caller unless swf?
+      
+      @signature  = @buffer[0,3]
+      @version    = @buffer[3].ord
+      
+      decompress_buffer! if compressed?
+
+      @bit_count  = ((@buffer[8].ord & 0xff) >> 3)
+    end
+    
+    def parse_packed_bits
+      PackedBitObject.from_packed_bits(@buffer, 8, 5, @bit_count) do |pbo|
+        
+        PackedBitObject.from_packed_bits(@buffer, pbo.nextByteIndex, pbo.nextBitIndex, @bit_count) do |pbo2|
+          @xmax = pbo2.value
+          
+          PackedBitObject.from_packed_bits(@buffer, pbo2.nextByteIndex, pbo2.nextBitIndex, @bit_count) do |pbo3|
+            
+            PackedBitObject.from_packed_bits(@buffer, pbo3.nextByteIndex, pbo3.nextBitIndex, @bit_count) do |pbo4|
+              @ymax   = pbo4.value
+              @width  = Conversions::Pixels.from_twips @xmax
+              @height = Conversions::Pixels.from_twips @ymax
+                            
+              byte_pointer = pbo4.nextByteIndex + 2
+              
+              @frame_rate = @buffer[byte_pointer].ord
+              byte_pointer += 1
+              
+              fc1 = @buffer[byte_pointer].ord & 0xFF
+              byte_pointer += 1
+              
+              fc2 = @buffer[byte_pointer].ord & 0xFF
+              byte_pointer += 1
+              
+              @frame_count = (fc2 << 8) + fc1
+              byte_pointer+=2
+              
+              @avm_version = ((@buffer[byte_pointer].ord & 0x08) == 0) ? "AVM1" : "AVM2"
+            end #pbo4
+          end #pbo3
+        end #pbo2
+      end #pbo
+    end
 end

data/lib/swf_file/swf_header.rb

@@ -1,5 +1,8 @@
 class SwfHeader
+  include Parser
   include Compression
+  include Conversions
+  include Assertions
   
   attr_reader :file, :signature, :version, :avm_version, :size, :bit_count,
               :xmax, :ymax, :width, :height,
@@ -10,73 +13,17 @@ class SwfHeader
     parse_header
     parse_packed_bits
   end
-  
-  def compressed?(memoize_result = true)
-    buffer_compressed?(memoize_result)
-  end
-  
+
   # Returns the duration in milliseconds
+  # The formula used in this method used to be +((@frame_count / @frame_rate.to_f).round(5) * 1000).round+.
+  # This however, was not compatible with ruby 1.8, thus reverted to its current form.
   def duration
-    ((@frame_count / @frame_rate.to_f).round(5) * 1000).round
-  end
-  
-  def to_s
-    "#{@file} #{@width}x#{@height} #{@frame_rate}fps"
-  end
-  
-  def to_hash
-    Conversions::Hash.from_swf_header self
+    ((@frame_count / @frame_rate.to_f * 10**5).round.to_f / 10**5 * 1000).round
   end
   
   alias :inspect :to_hash
   
   private
-    def parse_header
-      @buffer, @size = get_swf_buffer_and_size
-      raise RuntimeError, "The provided file does not appear to be an SWF", caller unless swf?
-      
-      @signature  = @buffer[0,3]
-      @version    = @buffer[3].ord
-      
-      decompress_buffer! if compressed?
-
-      @bit_count  = ((@buffer[8].ord & 0xff) >> 3)
-    end
-    
-    def parse_packed_bits
-      PackedBitObject.from_packed_bits(@buffer, 8, 5, @bit_count) do |pbo|
-        
-        PackedBitObject.from_packed_bits(@buffer, pbo.nextByteIndex, pbo.nextBitIndex, @bit_count) do |pbo2|
-          @xmax = pbo2.value
-          
-          PackedBitObject.from_packed_bits(@buffer, pbo2.nextByteIndex, pbo2.nextBitIndex, @bit_count) do |pbo3|
-            
-            PackedBitObject.from_packed_bits(@buffer, pbo3.nextByteIndex, pbo3.nextBitIndex, @bit_count) do |pbo4|
-              @ymax   = pbo4.value
-              @width  = Conversions::Pixels.from_twips @xmax
-              @height = Conversions::Pixels.from_twips @ymax
-                            
-              byte_pointer = pbo4.nextByteIndex + 2
-              
-              @frame_rate = @buffer[byte_pointer].ord
-              byte_pointer += 1
-              
-              fc1 = @buffer[byte_pointer].ord & 0xFF
-              byte_pointer += 1
-              
-              fc2 = @buffer[byte_pointer].ord & 0xFF
-              byte_pointer += 1
-              
-              @frame_count = (fc2 << 8) + fc1
-              byte_pointer+=2
-              
-              @avm_version = ((@buffer[byte_pointer].ord & 0x08) == 0) ? "AVM1" : "AVM2"
-            end #pbo4
-          end #pbo3
-        end #pbo2
-      end #pbo
-    end
-    
     def get_swf_buffer_and_size
       size = 0
       
@@ -90,8 +37,4 @@ class SwfHeader
       
       [buffer, size]
     end
-    
-    def swf?
-      @buffer[0,3] == 'FWS' || @buffer[0,3] == 'CWS'
-    end
 end

data/lib/swf_file.rb

@@ -4,17 +4,33 @@ require 'zlib'
 require 'parser'
 require 'compression'
 require 'conversions'
+require 'assertions'
 require 'packed_bit_object'
 require 'swf_header'
 
 class SwfFile
-  def initialize(swf_path)
+  # Class methods
+  def self.header(swf_path)
     raise RuntimeError, "SWF file not found.", caller unless File.exists?(swf_path)
+    
+    header = SwfHeader.new(swf_path)
+    yield(header) if block_given?
+    header
   end
   
-  def self.header(swf_path)
+  # Instance methods
+  def initialize(swf_path)
     raise RuntimeError, "SWF file not found.", caller unless File.exists?(swf_path)
     
-    SwfHeader.new(swf_path)
+    @header = SwfHeader.new(swf_path)
+  end
+  
+  def header
+    yield(@header) if block_given?
+    @header
+  end
+  
+  def compressed?
+    @header.compressed?
   end
 end

data/swf_file.gemspec

@@ -0,0 +1,59 @@
+# 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{swf_file}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["DBA"]
+  s.date = %q{2010-05-08}
+  s.description = %q{Based on the swfutil lib, by Dennis Zhuang, the SWF File is lightweight gem to read swf file headers from within a Ruby application. This gem is fully written in Ruby and is compatible with Ruby v1.9.x}
+  s.email = %q{dba@gnomeslab.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "fixtures/clicktag-decompressed.swf",
+     "fixtures/clicktag.swf",
+     "fixtures/smallgoat.jpg",
+     "lib/swf_file.rb",
+     "lib/swf_file/assertions.rb",
+     "lib/swf_file/compression.rb",
+     "lib/swf_file/conversions.rb",
+     "lib/swf_file/packed_bit_object.rb",
+     "lib/swf_file/parser.rb",
+     "lib/swf_file/swf_header.rb",
+     "swf_file.gemspec",
+     "test/test_helper.rb",
+     "test/unit/swf_file_test.rb"
+  ]
+  s.homepage = %q{http://github.com/DBA/swf_file}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{SWF File is lightweight gem to read swf file headers from within a Ruby application}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/unit/swf_file_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/test/test_helper.rb

@@ -1,8 +1,8 @@
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+require 'rubygems' if RUBY_VERSION =~ /1\.8.+/
 require 'test/unit'
 require 'shoulda'
-#require 'swfheader'
 require 'ruby-debug'
 require 'swf_file'
 

data/test/unit/swf_file_test.rb

@@ -1,9 +1,11 @@
-require_relative '../test_helper'
+$:.unshift(File.join(File.dirname(__FILE__), '../', '../', 'test'))
+
+require 'test_helper'
 
 class SwfFileTest < Test::Unit::TestCase
 
   context "SwfFile" do
-    context "Initialization" do
+    context "instance methods" do
       should "not be initializable without an SWF file path" do
         assert_raise(ArgumentError) { SwfFile.new }
       end
@@ -11,7 +13,14 @@ class SwfFileTest < Test::Unit::TestCase
       should "raise an error if an invalid path is provided" do
         assert_raise(RuntimeError) { SwfFile.new "/path_to_imaginary_file" }
       end
-    end # Initialization context
+      
+      should "return a header with the regular properties" do
+        swf = SwfFile.new fixture_path('clicktag.swf')
+        assert_equal SwfHeader, swf.header.class
+        assert_equal 4156, swf.header.size
+        assert_equal swf.compressed?, swf.header.compressed?
+      end
+    end # instance methods
     
     context "class method header" do      
       should "raise an error when not provided with an SWF" do
@@ -32,18 +41,18 @@ class SwfFileTest < Test::Unit::TestCase
       
       should "state if the swf was originally compressed" do
         assert @header.compressed?
-        refute SwfFile.header(fixture_path('clicktag-decompressed.swf')).compressed?
+        assert !SwfFile.header(fixture_path('clicktag-decompressed.swf')).compressed?
       end
       
       should "not make available private compression module methods" do
         %w{ :buffer_compressed? :strip_buffer_header :decompress_buffer! }.each do |method|
-          refute @header.respond_to?(method)
+          assert !@header.respond_to?(method)
         end
       end
       
       should "state if its buffer is currently compressed" do
         assert @header.compressed?
-        refute @header.compressed?(false)
+        assert !@header.compressed?(false)
       end
       
       should "have the version" do

metadata

@@ -3,10 +3,10 @@ name: swf_file
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - DBA
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-06 00:00:00 +01:00
+date: 2010-05-08 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -26,22 +26,24 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.rdoc
 files: 
 - .gitignore
 - LICENSE
-- README
+- README.rdoc
 - Rakefile
 - VERSION
 - fixtures/clicktag-decompressed.swf
 - fixtures/clicktag.swf
 - fixtures/smallgoat.jpg
 - lib/swf_file.rb
+- lib/swf_file/assertions.rb
 - lib/swf_file/compression.rb
 - lib/swf_file/conversions.rb
 - lib/swf_file/packed_bit_object.rb
 - lib/swf_file/parser.rb
 - lib/swf_file/swf_header.rb
+- swf_file.gemspec
 - test/test_helper.rb
 - test/unit/swf_file_test.rb
 has_rdoc: true