swf_fu 1.3.3 → 2.0.0

data/CHANGELOG.rdoc

@@ -1,45 +0,0 @@
-= swf_fu --- History
-
-== Version 1.3.2 - February 19, 2010
-* Packaged the plugin as a gem [Marcus Wyatt]
-
-== Version 1.3.1 - February 5, 2010
-
-* Improved compatibility with Rails 3.0: swf_tag now outputs html_safe content.
-
-* Got rid of deprecation warning in Rails 2.2+ when using swf_tag in block form.
-
-== Version 1.3.0 - June 20, 2009
-
-* Updated to swf_object v2.2. Change should not be noticeable to users, except compatibility improvements and better auto install. Added the option +switch_off_auto_hide_show+.
-
-== Version 1.2.0 - January 14, 2009
-
-* flashvars[:id] will now default to the DOM id of the object. I didn't want to have any extra defaults than the very basic ones, but there is no easy way to get this from Flash (see http://www.actionscript.org/forums/showthread.php3?t=136044 ) and no easy way to specify that using +swf_default_options+.
-* If flashvars is a string (e.g. "myVar=myValue") it will be parsed into a hash so that the behaviour for default values apply to strings or hashes. swf_default_options[:flashvars] can also be a string and will also be parsed before being merged.
-* Small bug fix: the options passed as hashes (:flashvars, :parameters and :html_options) were changed if swf_default_options[:flashvars, ...] existed. They are now left unchanged.
-
-== Version 1.1.0 - January 3, 2009
-
-* Improved the way to specify alternate content
-
-== Version 1.0.3 - January 3, 2009
-
-* Improved javascript initialization
-
-  :initialize => [1, 2, 3]  # produces in javascript: obj.initialize(1,2,3) instead of ([1,2,3])
-  # no :initialize produces in javascript: obj.initialize() instead of (null)
-  :initialize => nil        # stil produces obj.initialize(null)
-
-== Version 1.0.2 - January 3, 2009
-
-* Bug fix for flashvars in dynamic method
-
-== Version 1.0.1 - January 2, 2009
-
-* File reorganization
-* Bug fix for default options
-
-== Version 1.0 - X-mas, 2008
-
-=== Initial release.

data/FLASH_OBJECT.rdoc

@@ -1,31 +0,0 @@
-== Compatibility with FlashObject
-
-This document is intended for users of FlashObject, a (much older) swf embedding plugin that inspired swf_fu.
-
-You can choose to:
-
-1) keep both. They won't interfere and +flashobject_tag+ will continue to use the older SWFObject 1.5 library.
-
-2) remove FlashObject:
-
-  script/plugin remove flashobject_helper
-
-You can also manually remove <tt>javascripts/flashobject.js</tt>
-
-+swf_fu+ will take over the +flashobject_tag+ and will use the new SWFObject 2.2 library.
-This should not have impacts as long as:
-* your swf path is absolute (e.g. "/path/to/my_flash.swf"). If it is relative, move your swf file from 'public/' to the new 'public/swfs/' asset folder
-* you include the default javascripts (otherwise you need to include 'swfobject' explicitely and stop including 'flashobject')
-* you don't use the javascript object before the page is loaded. SWFObject 2.2 makes the changes to the web page later
-* you don't rely on the +verify_file_exists+ option (it doesn't do anything anymore)
-
-In either case 1 or 2, you change existing calls to +flashobject_tag+ for +swf_tag+ at your leisure.
-The interface is similar and the main differences are some options name changes:
-  :flash_id  => :id
-  :variables => :flashvars
-  :background_color => options[:parameters][:bgcolor]
-
-Moreover, the following defaults are gone:
-  :flashvars[:lzproxied]
-  :parameters[:scale]
-  :parameters[:bgcolor]

data/VERSION

@@ -1 +0,0 @@
-1.3.3

data/lib/action_view/helpers/asset_tag_helper/swf_asset.rb

@@ -1,61 +0,0 @@
-module ActionView #:nodoc:
-
-  # <tt>ActionView::Base.swf_default_options</tt> is a hash that
-  # will be used to specify defaults in priority to the standard
-  # defaults.
-  class Base
-    @@swf_default_options = {}
-    cattr_accessor :swf_default_options
-  end
-
-  module Helpers # :nodoc:
-    module AssetTagHelper
-      
-      # Computes the path to an swf asset in the public 'swfs' directory.
-      # Full paths from the document root will be passed through.
-      # Used internally by +swf_tag+ to build the swf path.
-      #
-      # ==== Examples
-      #     swf_path("example")                            # => /swfs/example.swf
-      #     swf_path("example.swf")                        # => /swfs/example.swf
-      #     swf_path("fonts/optima")                       # => /swfs/fonts/optima.swf
-      #     swf_path("/fonts/optima")                      # => /fonts/optima.swf
-      #     swf_path("http://www.example.com/game.swf")    # => http://www.example.com/game.swf
-      #   
-      # It takes into account the global setting +asset_host+, like any other asset:
-      #   
-      #     ActionController::Base.asset_host = "http://assets.example.com"
-      #     image_path("logo.jpg")                         # => http://assets.example.com/images/logo.jpg
-      #     swf_path("fonts/optima")                       # => http://assets.example.com/swfs/fonts/optima.swf
-      #
-      def swf_path(source)
-        if defined? SwfTag
-          SwfTag.new(self, @controller, source).public_path
-        else
-          compute_public_path(source, SwfAsset::DIRECTORY, SwfAsset::EXTENSION)
-        end
-      end
-      alias_method :path_to_swf, :swf_path # aliased to avoid conflicts with a swf_path named route
-
-  private
-      module SwfAsset # :nodoc:
-        DIRECTORY = 'swfs'.freeze
-        EXTENSION = 'swf'.freeze
-
-        def directory
-          DIRECTORY
-        end
-
-        def extension
-          EXTENSION
-        end
-      end
-      
-      # AssetTag is available since 2.1.1 (http://github.com/rails/rails/commit/900fd6eca9dd97d2341e89bcb27d7a82d62965bf )
-      class SwfTag < AssetTag # :nodoc:
-        include SwfAsset
-      end if defined? AssetTag 
-    end
-  end
-end
-        

data/lib/action_view/helpers/swf_fu_helper.rb

@@ -1,184 +0,0 @@
-module ActionView #:nodoc:
-  module Helpers # :nodoc:
-    module SwfFuHelper
-      # Returns a set of tags that display a Flash object within an
-      # HTML page.
-      #
-      # Options:
-      # * <tt>:id</tt> - the DOM +id+ of the flash +object+ element that is used to contain the Flash object; defaults to the name of the swf in +source+
-      # * <tt>:width, :height</tt> - the width & height of the Flash object. Defaults to "100%". These could also specified using :size
-      # * <tt>:size</tt> - the size of the Flash object, in the form "400x300".
-      # * <tt>:mode</tt> - Either :dynamic (default) or :static. Refer to SWFObject's doc[http://code.google.com/p/swfobject/wiki/documentation#Should_I_use_the_static_or_dynamic_publishing_method?]
-      # * <tt>:flashvars</tt> - a Hash of variables that are passed to the swf. Can also be a string like <tt>"foo=bar&hello=world"</tt>
-      # * <tt>:parameters</tt> - a Hash of configuration parameters for the swf. See Adobe's doc[http://kb.adobe.com/selfservice/viewContent.do?externalId=tn_12701#optional]
-      # * <tt>:alt</tt> - HTML text that is displayed when the Flash player is not available. Defaults to a "Get Flash" image pointing to Adobe Flash's installation page.
-      # * <tt>:flash_version</tt> - the version of the Flash player that is required (e.g. "7" (default) or "8.1.0")
-      # * <tt>:auto_install</tt> - a swf file that will upgrade flash player if needed (defaults to "expressInstall" which was installed by swf_fu)
-      # * <tt>:javascript_class</tt> - specify a javascript class (e.g. "MyFlash") for your flash object. The initialize method will be called when the flash object is ready.
-      # * <tt>:initialize</tt> - arguments to pass to the initialization method of your javascript class.
-      # * <tt>:div_id</tt> - the DOM +id+ of the containing div itself. Defaults to <tt>"#{option[:id]}"_div</tt>
-      #
-      def swf_tag(source, options={}, &block)
-        Generator.new(source, options, self).generate(&block)
-      end
-
-      # For compatibility with the older FlashObject.
-      # It modifies the given options before calling +swf_tag+.
-      # See FLASH_OBJECT.rdoc
-      def flashobject_tag_for_compatibility(source, options={})
-        options = options.reverse_merge(
-          :auto_install     => nil,
-          :parameters       => {:scale => "noscale"},
-          :variables        => {:lzproxied => false},
-          :flash_id         => "flashcontent_#{rand(1_100)}",
-          :background_color => "#ffffff"
-        )
-        { :variables => :flashvars, :flash_id => :id }.each{|from, to| options[to] ||= options.delete(from) }
-        options[:parameters][:bgcolor] ||= options.delete(:background_color)
-        swf_tag(source, options)
-      end
-    
-      alias_method :flashobject_tag, :flashobject_tag_for_compatibility unless defined? flashobject_tag
-    
-  private
-      DEFAULTS = {
-        :width            => "100%",
-        :height           => "100%",
-        :flash_version    => 7,
-        :mode             => :dynamic,
-        :auto_install     => "expressInstall",
-        :alt    => <<-"EOS".squeeze(" ").strip.freeze
-          <a href="http://www.adobe.com/go/getflashplayer">
-        	  <img src="http://www.adobe.com/images/shared/download_buttons/get_flash_player.gif" alt="Get Adobe Flash player" />
-          </a>
-        EOS
-      }.freeze
-      
-      class Generator # :nodoc:
-        VALID_MODES = [:static, :dynamic]
-        def initialize(source, options, view)
-          @view = view
-          @source = view.swf_path(source)
-          options = ActionView::Base.swf_default_options.merge(options)
-          [:html_options, :parameters, :flashvars].each do |k|
-            options[k] = convert_to_hash(options[k]).reverse_merge convert_to_hash(ActionView::Base.swf_default_options[k])
-          end
-          options.reverse_merge!(DEFAULTS)
-          options[:id] ||= source.gsub(/^.*\//, '').gsub(/\.swf$/,'')
-          options[:div_id] ||= options[:id]+"_div"
-          options[:width], options[:height] = options[:size].scan(/^(\d*%?)x(\d*%?)$/).first if options[:size]
-          options[:auto_install] &&= @view.swf_path(options[:auto_install])
-          options[:flashvars][:id] ||= options[:id]
-          @mode = options.delete(:mode)
-          @options = options
-          unless VALID_MODES.include? @mode
-            raise ArgumentError, "options[:mode] should be either #{VALID_MODES.join(' or ')}"
-          end
-        end
-
-        def generate(&block)
-          if block_given?
-            @options[:alt] = @view.capture(&block)
-            if Rails::VERSION::STRING < "2.2"
-              @view.concat(send(@mode), block.binding)
-            else
-              @view.concat(send(@mode))
-            end
-          else
-            send(@mode)
-          end
-        end
-        
-      private
-        CONCAT = ActiveSupport.const_defined?(:SafeBuffer) ? :safe_concat : :concat
-        def convert_to_hash(s)
-          case s
-            when Hash
-              s
-            when nil
-              {}
-            when String
-              s.split("&").inject({}) do |h, kvp|
-                key, value = kvp.split("=")
-                h[key.to_sym] = CGI::unescape(value)
-                h
-              end
-            else
-              raise ArgumentError, "#{s} should be a Hash, a String or nil"
-          end
-        end
-      
-        def convert_to_string(h)
-          h.map do |key_value|
-            key_value.map{|val| CGI::escape(val.to_s)}.join("=")
-          end.join("&")
-        end
-        
-        def static
-          param_list = @options[:parameters].map{|k,v| %(<param name="#{k}" value="#{v}"/>) }.join("\n")
-          param_list += %(\n<param name="flashvars" value="#{convert_to_string(@options[:flashvars])}"/>) unless @options[:flashvars].empty?
-          html_options = @options[:html_options].map{|k,v| %(#{k}="#{v}")}.join(" ")
-          r = @view.javascript_tag(
-            %(swfobject.registerObject("#{@options[:id]}_container", "#{@options[:flash_version]}", #{@options[:auto_install].to_json});)
-          )
-          r.send CONCAT, <<-"EOS".strip
-            <div id="#{@options[:div_id]}"><object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width="#{@options[:width]}" height="#{@options[:height]}" id="#{@options[:id]}_container" #{html_options}>
-              <param name="movie" value="#{@source}" />
-              #{param_list}
-              <!--[if !IE]>-->
-              <object type="application/x-shockwave-flash" data="#{@source}" width="#{@options[:width]}" height="#{@options[:height]}" id="#{@options[:id]}">
-              #{param_list}
-              <!--<![endif]-->
-                #{@options[:alt]}
-              <!--[if !IE]>-->
-              </object>
-              <!--<![endif]-->
-            </object></div>
-          EOS
-          r << @view.javascript_tag(extend_js) if @options[:javascript_class]
-          r.send CONCAT, library_check
-          r
-        end
-      
-        def dynamic
-          @options[:html_options] = @options[:html_options].merge(:id => @options[:id])
-          @options[:parameters] = @options[:parameters].dup # don't modify the original parameters
-          args = (([@source] + @options.values_at(:div_id,:width,:height,:flash_version)).map(&:to_s) + 
-                  @options.values_at(:auto_install,:flashvars,:parameters,:html_options)
-                 ).map(&:to_json).join(",")
-          preambule = @options[:switch_off_auto_hide_show] ? "swfobject.switchOffAutoHideShow();" : ""
-          r = @view.javascript_tag(preambule + "swfobject.embedSWF(#{args})") 
-          r.send CONCAT, <<-"EOS".strip
-            <div id="#{@options[:div_id]}">
-              #{@options[:alt]}
-            </div>
-          EOS
-          r << @view.javascript_tag("swfobject.addDomLoadEvent(function(){#{extend_js}})") if @options[:javascript_class]
-          r.send CONCAT, library_check
-          r
-        end
-      
-        def extend_js
-          arglist = case
-          when @options[:initialize].instance_of?(Array) 
-            @options[:initialize].map(&:to_json).join(",")
-          when @options.has_key?(:initialize)
-            @options[:initialize].to_json
-          else
-            ""
-          end
-          "Object.extend($('#{@options[:id]}'), #{@options[:javascript_class]}.prototype).initialize(#{arglist})"
-        end
-      
-        def library_check
-          return "" unless 'development' == ENV['RAILS_ENV']
-          @view.javascript_tag(<<-"EOS")
-            if (typeof swfobject == 'undefined') {
-              document.getElementById('#{@options[:div_id]}').innerHTML = '<strong>Warning:</strong> SWFObject.js was not loaded properly. Make sure you <tt>&lt;%= javascript_include_tag :defaults %&gt;</tt> or <tt>&lt;%= javascript_include_tag :swfobject %&gt;</tt>';
-            }
-          EOS
-        end
-      end #class Generator
-    end
-  end
-end

data/lib/swf_fu/tasks.rb

@@ -1,72 +0,0 @@
-require 'fileutils'
-
-namespace :swf do
-  
-  task :app_env do
-    if defined?(RAILS_ROOT)
-      Rake::Task[:environment].invoke
-    end
-  end
-  
-  desc "Install swf_fu assets into your rails application"
-  task :install => :app_env do
-    if defined?(RAILS_ROOT)
-      # Some paths
-      src = File.dirname(__FILE__) + "/../../assets"
-      dest = RAILS_ROOT + "/public"
-
-      unless File.exist?("#{dest}/javascripts/swfobject.js")
-        FileUtils.cp "#{src}/javascripts/swfobject.js", "#{dest}/javascripts/swfobject.js"
-        puts "Copying 'swfobject.js'"
-      end
-
-      unless File.exist?("#{dest}/swfs/")
-        FileUtils.mkdir "#{dest}/swfs/" 
-        puts "Creating new 'swfs' directory for swf assets"
-      end
-
-      unless File.exist?("#{dest}/swfs/expressInstall.swf")
-        FileUtils.cp "#{src}/swfs/expressInstall.swf", "#{dest}/swfs/expressInstall.swf"
-        puts "Copying 'expressInstall.swf', the default flash auto-installer."
-      end
-
-      puts "Installation done."
-    else
-      puts "Unable to do installation. We need to be in the root of a Rails Application."
-    end
-  end
-  
-  task :rm_swfobject do
-    if defined?(RAILS_ROOT)
-      begin
-        FileUtils.rm  "#{RAILS_ROOT}/public/javascripts/swfobject.js"
-      rescue Exception => e
-        puts "Warning: swfobject.js could not be deleted"
-      end
-    end
-  end
-
-  task :rm_express_install do
-    if defined?(RAILS_ROOT)
-      begin
-        FileUtils.rm  "#{RAILS_ROOT}/public/swfs/expressInstall.swf"
-      rescue Exception => e
-        puts "Warning: expressInstall.swf could not be deleted"
-      end
-    end
-  end
-  
-  task :rm_swf_dir do
-    if defined?(RAILS_ROOT)
-      begin
-        Dir.rmdir "#{RAILS_ROOT}/public/swfs/"
-      rescue Exception => e
-        puts "Don't remove swf directory if directory is not empty"
-      end
-    end
-  end
-  
-  desc "Uninstall swf_fu assets from your rails application"
-  task :uninstall => [:app_env, :rm_swfobject, :rm_express_install, :rm_swf_dir]
-  
-end

data/rails/init.rb

@@ -1,11 +0,0 @@
-require 'action_view/helpers/asset_tag_helper'
-
-require 'swf_fu'
-
-# ActionView::Helpers is for recent rails version, ActionView::Base for older ones 
-# (in which case ActionView::Helpers::AssetTagHelper is also needed for tests...)
-ActionView::Helpers.class_eval  { include ActionView::Helpers::SwfFuHelper } # For recent rails version...
-ActionView::Base.class_eval     { include ActionView::Helpers::SwfFuHelper } # ...and for older ones
-ActionView::TestCase.class_eval { include ActionView::Helpers::SwfFuHelper } if defined? ActionView::TestCase # ...for tests in older versions
-
-ActionView::Helpers::AssetTagHelper.register_javascript_include_default 'swfobject'

data/tasks/rails.rake

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

data/test/swf_fu_test.rb

@@ -1,131 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-require File.dirname(__FILE__) + '/results'
-
-class SwfFuTest < ActionView::TestCase
-  
-  def assert_same_stripped(expect, test)
-    expect, test = [expect, test].map{|s| s.split("\n").map(&:strip)}
-    same = expect & test
-    delta_expect, delta_test = [expect, test].map{|a| a-same}
-    STDOUT << "\n\n---- Actual result: ----\n" << test.join("\n") << "\n---------\n" unless delta_expect == delta_test
-    assert_equal delta_expect, delta_test
-  end
-
-  context "swf_path" do   
-    context "with no special asset host" do
-      should "deduce the extension" do
-        assert_equal swf_path("example.swf"), swf_path("example")
-        assert_starts_with "/swfs/example.swf", swf_path("example.swf")
-      end
-      
-      should "accept relative paths" do
-        assert_starts_with "/swfs/whatever/example.swf", swf_path("whatever/example.swf")
-      end
-      
-      should "leave full paths alone" do
-        ["/full/path.swf", "http://www.example.com/whatever.swf"].each do |p|
-          assert_starts_with p, swf_path(p)
-        end
-      end
-    end
-    
-    context "with custom asset host" do
-      HOST = "http://assets.example.com"
-      setup do
-        ActionController::Base.asset_host = HOST
-      end
-      
-      teardown do
-        ActionController::Base.asset_host = nil
-      end
-      
-      should "take it into account" do
-        assert_equal "#{HOST}/swfs/whatever.swf", swf_path("whatever")
-      end
-    end
-  end
-      
-  context "swf_tag" do
-    COMPLEX_OPTIONS = { :width => "456", :height => 123,
-                        :flashvars => {:myVar => "value 1 > 2"}.freeze,
-                        :javascript_class => "SomeClass",
-                        :initialize => {:be => "good"}.freeze,
-                        :parameters => {:play => true}.freeze
-                      }.freeze
-      
-    should "understand size" do
-      assert_equal  swf_tag("hello", :size => "123x456"),
-                    swf_tag("hello", :width => 123, :height => "456")
-    end
-  
-    should "only accept valid modes" do
-      assert_raise(ArgumentError) { swf_tag("xyz", :mode => :xyz)  }
-    end
-
-    context "with custom defaults" do
-      setup do
-        test = {:flashvars=> {:xyz => "abc", :hello => "world"}.freeze, :mode => :static, :size => "400x300"}.freeze
-        @expect = swf_tag("test", test)
-        @expect_with_hello = swf_tag("test", :flashvars => {:xyz => "abc", :hello => "my friend"}, :mode => :static, :size => "400x300")
-        ActionView::Base.swf_default_options = test
-      end
-      
-      should "respect them" do
-        assert_equal @expect, swf_tag("test")
-      end
-      
-      should "merge suboptions" do
-        assert_equal @expect_with_hello, swf_tag("test", :flashvars => {:hello => "my friend"}.freeze)
-      end
-
-      teardown { ActionView::Base.swf_default_options = {} }        
-    end
-
-    context "with static mode" do
-      setup { ActionView::Base.swf_default_options = {:mode => :static} }
-
-      should "deal with string flashvars" do
-        assert_equal  swf_tag("hello", :flashvars => "xyz=abc", :mode => :static),
-                      swf_tag("hello", :flashvars => {:xyz => "abc"}, :mode => :static)
-      end
-
-      should "produce the expected code" do
-        assert_same_stripped STATIC_RESULT, swf_tag("mySwf", COMPLEX_OPTIONS.merge(:html_options => {:class => "lots"}.freeze).freeze)
-      end
-      
-      teardown { ActionView::Base.swf_default_options = {} }
-    end
-    
-    context "with dynamic mode" do
-      should "produce the expected code" do
-        assert_same_stripped DYNAMIC_RESULT, swf_tag("mySwf", COMPLEX_OPTIONS)
-      end
-      
-    end
-    
-    should "treat initialize arrays as list of parameters" do
-      assert_match 'initialize("hello","world")', swf_tag("mySwf", :initialize => ["hello", "world"], :javascript_class => "SomeClass")
-    end
-  end
-
-  context "flashobject_tag" do
-    should "be the same as swf_tag with different defaults" do
-      assert_same_stripped swf_tag("mySwf",
-        :auto_install     => nil,
-        :parameters       => {:scale => "noscale", :bgcolor => "#ffffff"},
-        :flashvars        => {:lzproxied => false},
-        :id               => "myFlash"
-      ), flashobject_tag("mySwf", :flash_id => "myFlash")
-    end
-  
-    should "be the same with custom settings" do
-      assert_same_stripped swf_tag("mySwf",
-        :auto_install     => nil,
-        :parameters       => {:scale => "noborder", :bgcolor => "#ffffff"},
-        :flashvars        => {:answer_is => 42},
-        :id               => "myFlash"
-      ), flashobject_tag("mySwf", :flash_id => "myFlash", :parameters => {:scale => "noborder"}, :variables => {:answer_is => 42})
-    end
-  end
-end
-