flash_tool 0.5.0 → 0.6.0

data/.gitignore

@@ -6,3 +6,4 @@ coverage
 pkg
 .loadpath
 .project
+rdoc

data/README.rdoc

@@ -1,10 +1,15 @@
 = Flash Tool
 
-A ruby wrapper for swftool command line tool. http://www.swftools.org/
+A ruby wrapper for swftool command line tool. http://www.swftools.org
 
 Flash tool is small and mini tool for creating swf files from pdfs, pictures and
 fonts and parsing data from flash files.
 
+
+== Install
+
+ gem install flash_tool
+
 == Use
 
 With this wrapper you commands from swftools program.
@@ -14,13 +19,15 @@ With Flash tool you can easely creates and manipulates flash files.
 
 == Creating flash files
 
+=== Creataing flash files from documents
+
 With Flash tool you can create swf file from pdf, jpeg (jpeg and jpg extension),
 png, gif, fonts (ttf, afm,  pfa, pfb formats) and wav(this funcionality is untested
 and you can often have problems with SWFTools installation with command wav2swf)
 
 Simple creating flash object from pdf file
 
- swfile = FlashObject.new('path_to_file.pdf')
+ swfile = FlashTool::FlashObject.new('path_to_file.pdf')
  swfile.pages('1-10')
  swfile.jpegquality('80')
  swfile.save('outputfile_path.swf') # no need to declare ouptutfile_path in save if you used swfile.output() method before
@@ -29,7 +36,7 @@ Creating file from other format is very similar
 
 Example for jpg
 
- swfile = FlashObject.new('path_to_file.jpg')
+ swfile = FlashTool::FlashObject.new('path_to_file.jpg')
  swfile.output('outputfile_path.swf')
  swfile.save()
 
@@ -37,55 +44,96 @@ Flash tool automaticly recognize extension of file and call propriete SWFTool pr
 If you use files without extension you just simply add string of extension when
 initialize FlashObject
 
- swfile = FlashObject.new('path_to_file','jpg')
+ swfile = FlashTool::FlashObject.new('path_to_file','jpg')
 
 You can use tempfile
 
- swfile = FlashOject.from_blob('path_to_file','jpg')
+ swfile = FlashTool::FlashOject.from_blob('path_to_file','jpg')
 
 Creating flash with viewer
 
- swfile = FlashObject.new('path_to_file.pdf')
+ swfile = FlashTool::FlashObject.new('path_to_file.pdf')
  swfile.pages('1-10')
  swfile.viewer('path_to_viewer_file')
  swfile.save('outputfile_path.swf')
 
+You can use with the block
+
+ swfile = FlashTool::FlashObject.new('path_to_file.pdf') do |f|
+  f.pages('1-10')
+  f.viewer('path_to_viewer_file')
+  f.save('outputfile_path.swf')
+ end
+
 SWFTool command will be called when you save object.
 
+=== Creating flash from scritps
+
+With SWFTool you can use scripts for creating flash files. More on http://wiki.swftools.org/index.php/Swfc
+
+ flash_object = FlashTool::FlashScript.new("path_to_script")
+ flash_object.save(output_file)
+
+Other way
+ FlashTool::FlashScript.create("path_to_script","output_path")
+
+It is possible to push flash data in variable
+ flash = FlashScript.flash_data("path_to_script")
+
+or
+
+ flash_object = FlashTool::FlashScript.new("path_to_script")
+ flash = flash_object.cgi
+
+
 ==Parsing text from file
 
 It is very simple
 
- FlashTool.parse_text('path_to_file.swf')
+ FlashTool::FlashTool.parse_text('path_to_file.swf')
 
 ==Geting data from flash files
 
 You can get data from flash files with swfdump tool
 
- FlashTool.swfdump('path_to_file.swf', 'command') #use swfdump options http://www.swftools.org/swfdump.html
+ FlashTool::FlashTool.swfdump('path_to_file.swf', 'command') #use swfdump options http://www.swftools.org/swfdump.html
 
-Don't use option text it is buggy, instead use method FlashTool.parse_text
+Don't use option text it is buggy, instead that use method FlashTool.parse_text
 With method swfdump output is string
 
 Better way
 
- FlashTool.(command) List of command can get from http://www.swftools.org/swfdump.html
+ FlashTool::FlashTool.(command) List of command can get from http://www.swftools.org/swfdump.html
 
 Examples
- FlashTool.rate(file)   #return Float
- FlashTool.width(file)  #return Integer
- FlashTool.height(file) #return Integer
- FlashTool.frames(file) #return Integer
+ FlashTool::FlashTool.rate(file)   #return Float
+ FlashTool::FlashTool.width(file)  #return Integer
+ FlashTool::FlashTool.height(file) #return Integer
+ FlashTool::FlashTool.frames(file) #return Integer
 
 Other methods returns String
 
 All this methods call commands swfdump, every time you call method. If you want
 to do it in one pass use
 
- FlashTool.flash_info(file)
+ FlashTool::FlashTool.flash_info(file)
 
 Returns hash with keys 'width', 'rate', 'height', 'frames', and all values are strings
 
+== Flash combine
+
+This is advance technique for combining flash files. It is possible to combine two or more flash files
+More about this on http://www.swftools.org/swfcombine.html
+For simple adding viewer use FlashObject and creating vith view method
+
+ flash = FlashCombine.new() do |f|
+  f.master(inputs)
+  f.slave("viewport",TEST_SWF)
+  f.rate(25)
+  f.output(output_file)
+  f.save()
+ end
+
 
 
 

data/Rakefile

@@ -12,7 +12,7 @@ fonts and parsing data from flash files."
     gem.email = "milboj@gmail.com"
     gem.homepage = "http://github.com/milboj/flash_tool"
     gem.authors = ["Bojan Milosavljevic"]
-    gem.rubyforge_project = 'flashtool'
+    gem.rubyforge_project = 'flash_tool'
 
 
 #   gem.add_development_dependency "", ">= 0"

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/flash_tool.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flash_tool}
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bojan Milosavljevic"]
-  s.date = %q{2010-03-20}
+  s.date = %q{2010-03-23}
   s.description = %q{A ruby wrapper for swftool command line tool. http://www.swftools.org/ 
 Flash tool is small and mini tool for creating swf files from pdfs, pictures and
 fonts and parsing data from flash files.}
@@ -27,29 +27,39 @@ fonts and parsing data from flash files.}
      "VERSION",
      "flash_tool.gemspec",
      "lib/flash_tool.rb",
-     "test/25-1.gif",
-     "test/bad_ext.txt",
-     "test/bad_swf.swf",
-     "test/jpeg.swf",
-     "test/liberationserif_bold.ttf",
-     "test/rfxview.swf",
-     "test/test.jpg",
-     "test/test.pdf",
-     "test/test.png",
-     "test/test_flash_data.rb",
-     "test/test_flash_tool.rb",
-     "test/test_with_password.pdf",
-     "test/tester.swf"
+     "lib/flash_tool/flash.rb",
+     "lib/flash_tool/flash_combine.rb",
+     "lib/flash_tool/flash_object.rb",
+     "lib/flash_tool/flash_script.rb",
+     "test/test_files/25-1.gif",
+     "test/test_files/bad.sc",
+     "test/test_files/bad_ext.txt",
+     "test/test_files/bad_swf.swf",
+     "test/test_files/jpeg.swf",
+     "test/test_files/liberationserif_bold.ttf",
+     "test/test_files/rfxview.swf",
+     "test/test_files/script.sc",
+     "test/test_files/test.jpg",
+     "test/test_files/test.pdf",
+     "test/test_files/test.png",
+     "test/test_files/test_with_password.pdf",
+     "test/test_files/tester.swf",
+     "test/test_flash_combine.rb",
+     "test/test_flash_object.rb",
+     "test/test_flash_script.rb",
+     "test/test_flash_tool.rb"
   ]
   s.homepage = %q{http://github.com/milboj/flash_tool}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{flashtool}
+  s.rubyforge_project = %q{flash_tool}
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Simple and mini tool for creating swf (flash) files from pdf, jpg, png and gif with swftools}
   s.test_files = [
-    "test/test_flash_tool.rb",
-     "test/test_flash_data.rb"
+    "test/test_flash_script.rb",
+     "test/test_flash_combine.rb",
+     "test/test_flash_tool.rb",
+     "test/test_flash_object.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/flash_tool.rb

@@ -1,195 +1,101 @@
 require 'tempfile'
+require File.dirname(__FILE__) + '/flash_tool/flash_script.rb'
+require File.dirname(__FILE__) + '/flash_tool/flash_object.rb'
+require File.dirname(__FILE__) + '/flash_tool/flash.rb'
+require File.dirname(__FILE__) + '/flash_tool/flash_combine.rb'
 
 module FlashTool
   class FlashToolError < RuntimeError
   end
 
-  # Creating flash swf files from pdf, jpg, png, gif and fonts file
-  class FlashObject
-    attr :input
-    attr :type
-    attr :args
-
-    # Input is path file with good extesnion
-    # Approved formats are :
-    # *pdf,
-    # *jpeg (jpeg and jpg extension),
-    # *png,
-    # *gif,
-    # *fonts (ttf, afm,  pfa, pfb formats) and
-    # *wav (wav funcionality is untested and you can often have problems with SWFTools installation with command wav2swf)
-    #
-    # type - is extension name string if your input file have other extension
-    #
-    # == Example
-    #  flash = FlashOjbect.new('path_to_file', 'png')
-    #
-    # Raise exceptions
-    def initialize(input,type = nil, tempfile = nil)
-      @args = []
-      @tempfile = tempfile
-      @input = input
-      @type = type || input.split('.').last
-      @command = type_parser(@type)
-
-      raise FlashToolError, "File not found" unless File.exist?(input)
-    end
-
-
-    def self.from_blob(blob, ext)
-      begin
-        tempfile = Tempfile.new(['swf_tool', ext.to_s])
-        tempfile.binmode
-        tempfile.write(blob)
-      ensure
-        tempfile.close if tempfile
-      end
-
-      return self.new(tempfile.path, ext ,tempfile)
-    end
-
-    #
-    def save(output_path=nil)
-      if output_path
-        @args << "--output"
-        @args << output_path
+  # This class provides usefull utilities for getting informations from flash files
+  # ===<b>Important</b>
+  # Method FlashTool.text and options FlashTool.method_missing("text", "file") and
+  # swfdump("file","text") on same system don't work appropriate instead use method <b>parse_text</b>
+  #
+  class FlashTool
+    class <<self
+      # This method parse text from swf file.
+      # File must have extension swf
+      def parse_text(file)
+        # something is bad with this program don't send errors, and we must check for errors
+        # we must check file first
+        # by documetation swfdump --text need to do this but
+        raise FlashToolError, "File missing path: #{file}" unless File.exist?(file)
+        raise FlashToolError, "Wrong file type SWF path: #{file} "  unless file =~ /(.swf)$/i
+        command = "swfstrings #{file}"
+        output = `#{command} 2>&1`
+        # if file have appropiate name but is something is wrong with him
+        raise FlashToolError, output if output =~/(errors.)$/
+        return output
       end
-      run_command(@command,*@args << @input)
-    end
-
-    
-
-
-    def method_missing(symbol, *args)
-      @args << ("--#{symbol}")
-      @args +=(args)
-    end
 
-    private
 
-    def type_parser input
-      case input.downcase
-      when "pdf"
-        command = "pdf2swf"
-      when "jpg", "jpeg"
-        command = "jpeg2swf"
-      when "png"
-        command = "png2swf"
-      when "gif"
-        command = "gif2swf"
-      when "ttf", "afm",  "pfa", "pfb"
-        command = "font2swf"
-      when "wav"
-        command = "wav2swf"
-      else
-        raise FlashToolError, "Invalid type"
-      end
-      return command
-    end
 
-    def +(value)
-      @args << "+#{value}"
-    end
-
-    
-    def run_command(command ,*args)
-      args.collect! do |arg|
-        # args can contain characters like '>' so we must escape them, but don't quote switches
-        if arg !~ /^[\+\-]/
-          "\"#{arg}\""
+      # Call swfdump commands in shorter way
+      # Can be used any option from  swfdump command
+      # in casess: width, heihght and frames returns Integer
+      # in case rate returns Float
+      # in all other casess retruns String
+      #
+      def method_missing(option, file)
+        text = self.swfdump(file, option)
+        option = option.to_s
+        if option == "width" || option == 'height' || option == 'frames'
+          return text.split(' ').last.to_i
+        elsif option == 'rate'
+          return text.split(' ').last.to_f
         else
-          arg.to_s
+          return text
         end
       end
-      command = "#{command} #{args.join(" ")}"
-      output = `#{command} 2>&1`
-
-      if $?.exitstatus != 0
-        raise FlashToolError, "SWF command (#{command.inspect}) failed: #{{:status_code => $?, :output => output}.inspect}"
-      else
-        output
-      end
-    end
-    
-  
-  end
-
-
-
-
-  # This method parse text from swf file.
-  # File must have extension swf
-  def FlashTool.parse_text(file)
-    # something is bad with this program don't send errors, and ther is no need to check for errors
-    # we must check file first
-    # by documetation swfdump --text need to do this but
-    raise FlashToolError, "File missing path: #{file}" unless File.exist?(file)
-    raise FlashToolError, "Wrong file type SWF path: #{file} "  unless file =~ /(.swf)$/i
-    command = "swfstrings #{file}"
-    output = `#{command} 2>&1`
-    # if file have appropiate name but is something is wrong with him
-    raise FlashToolError, output if output =~/(errors.)$/
-    return output
-  end
-
-  def FlashTool.method_missing(option, file)
-    text = self.swfdump(file, option)
-    option = option.to_s
-    if option == "width" || option == 'height' || option == 'frames'
-      return text.split(' ').last.to_i
-    elsif option == 'rate'
-      return text.split(' ').last.to_f
-    else
-      return text
-    end
-  end
 
-  ###
-  # Returns hash value with basic flash parameters
-  # Keys are [width, rate, height, frames] and
-  # values are kind of string
-  def FlashTool.flash_info(file)
-    args = ['width', 'rate', 'height', 'frames']
-    data = swfdump(file, args)
-    data.gsub!(/(-X)/, "width ")
-    data.gsub!(/(-Y)/, "height ")
-    data.gsub!(/(-r)/, "rate ")
-    data.gsub!(/(-f)/, "frames ")
+      ###
+      # Returns hash value with basic flash parameters
+      # Keys are [width, rate, height, frames] and
+      # values are kind of string
+      def flash_info(file)
+        args = ['width', 'rate', 'height', 'frames']
+        data = swfdump(file, args)
+        data.gsub!(/(-X)/, "width ")
+        data.gsub!(/(-Y)/, "height ")
+        data.gsub!(/(-r)/, "rate ")
+        data.gsub!(/(-f)/, "frames ")
 
-    return Hash[*data.split(' ')]
+        return Hash[*data.split(' ')]
 
-  end
+      end
 
 
-  ###
-  # This  method is very similar to swfdump command http://www.swftools.org/swfdump.html
-  # Use longer options for this commands without --
-  # DON'T use option text that option don't work
-  # ==Examples
-  #  FlashTool.swfdump('test.swf', 'rate')
-  #
-  #  FlashTool.swfdump('test.swf', ['rate','width','height']
-  def FlashTool.swfdump(file, option=nil)
-    command = 'swfdump'
-    if option
-      if option.kind_of? Array
-        option.collect! { |a|   "--#{a}" }
-        option = option.join(' ')
-      else
-        option = "--#{option}"
+      ###
+      # This  method is very similar to swfdump command http://www.swftools.org/swfdump.html
+      # Use longer options for this commands without --
+      # DON'T use option text that option don't work
+      # ===Examples
+      #  FlashTool.swfdump('test.swf', 'rate')
+      #
+      #  FlashTool.swfdump('test.swf', ['rate','width','height'])
+      def swfdump(file, option=nil)
+        command = 'swfdump'
+        if option
+          if option.kind_of? Array
+            option.collect! { |a|   "--#{a}" }
+            option = option.join(' ')
+          else
+            option = "--#{option}"
+          end
+        end
+        command = "#{command} #{option} #{file}"
+        output = `#{command} 2>&1`
+        if $?.exitstatus != 0
+          raise FlashToolError, "SWF command : #{command.inspect} failed : #{{:status_code => $?, :output => output}.inspect}"
+        else
+          return output
+        end
       end
     end
 
-    command = "#{command} #{option} #{file}"
-
-    output = `#{command} 2>&1`
-    if $?.exitstatus != 0
-      raise FlashToolError, "SWF command : #{command.inspect} failed : #{{:status_code => $?, :output => output}.inspect}"
-    else
-      return output
-    end
   end
 end
 
 
-