@@ -1,5 +1,11 @@ = swf_fu --- History +== 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 CHANGELOG.rdoc @@ -44,12 +44,12 @@ You can specify alternate content either with the options :alt => "Get Flash!" o * <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>:flashvars</tt> - a Hash of variables that are passed to the swf. Can also be a string like <tt>"foo=bar&hello=world"</tt>. Defaults to <tt>{:id => the DOM id}</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. This can also be specified as a block (see embedding section) * <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>:javascript_class</tt> - specify a javascript class (e.g. "MyFlash") for your flash object. If it exists, the initialize method will be called. * <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> README.rdoc @@ -17,6 +17,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_dir = 'rdoc' rdoc.title = 'Swf Fu' rdoc.options << '--line-numbers' << '--inline-source' << '-m README.rdoc' - rdoc.rdoc_files.include('README.rdoc') + rdoc.rdoc_files.include('*.rdoc') rdoc.rdoc_files.include('lib/**/*.rb') end Rakefile @@ -39,42 +39,36 @@ module ActionView #:nodoc: 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" + <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) + options = ActionView::Base.swf_default_options.merge(options) [:html_options, :parameters, :flashvars].each do |k| - @options[k].merge! ActionView::Base.swf_default_options[k] rescue "merge won't work for string or nil, ignore error" - end - @options.reverse_merge!( - :id => source.gsub(/^.*\//, '').gsub(/\.swf$/,''), - :width => "100%", - :height => "100%", - :flash_version => 7, - :parameters => {}, - :flashvars => {}, - :html_options => {}, - :mode => :dynamic, - :auto_install => "expressInstall", - :alt => <<-"EOS" - <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 - ) - @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]) - # For some strange reason, SWFObject will only accept a string as parameters[:flashvars] and a hash as a direct argument (dynamic method) - # To allow both string and hash forms, we simply do our own conversion to string... - if @options[:flashvars].is_a?(Hash) - @options[:flashvars] = @options[:flashvars].map do |key_value| - key_value.map{|val| CGI::escape(val.to_s)}.join("=") - end.join("&") + options[k] = convert_to_hash(options[k]).reverse_merge convert_to_hash(ActionView::Base.swf_default_options[k]) end - @mode = @options.delete(:mode) + 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 @@ -90,9 +84,32 @@ module ActionView #:nodoc: end private + 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="#{@options[:flashvars]}"/>) unless @options[:flashvars].empty? + 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});)) + <<-"EOS" @@ -116,7 +133,6 @@ module ActionView #:nodoc: def dynamic @options[:html_options] = @options[:html_options].merge(:id => @options[:id]) @options[:parameters] = @options[:parameters].dup # don't modify the original parameters - @options[:parameters][:flashvars] = @options.delete :flashvars 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(",") lib/action_view/helpers/swf_fu_helper.rb @@ -1,7 +1,7 @@ -DYNAMIC_RESULT = <<"EOS" +DYNAMIC_RESULT = <<'EOS' <script type="text/javascript"> //<![CDATA[ -swfobject.embedSWF("/swfs/mySwf.swf","mySwf_div","456","123","7","/swfs/expressInstall.swf",null,{"play": true, "flashvars": "myVar=value+1+%3E+2"},{"id": "mySwf"}) +swfobject.embedSWF("/swfs/mySwf.swf","mySwf_div","456","123","7","/swfs/expressInstall.swf",{"myVar": "value 1 \u003E 2", "id": "mySwf"},{"play": true},{"id": "mySwf"}) //]]> </script> <div id="mySwf_div"> @@ -17,7 +17,7 @@ swfobject.addDomLoadEvent(function(){Object.extend($('mySwf'), SomeClass.prototy </script> EOS -STATIC_RESULT = <<"EOS" +STATIC_RESULT = <<'EOS' <script type="text/javascript"> //<![CDATA[ swfobject.registerObject("mySwf_container", "7", "/swfs/expressInstall.swf"); @@ -26,11 +26,11 @@ swfobject.registerObject("mySwf_container", "7", "/swfs/expressInstall.swf"); <div id="mySwf_div"><object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width="456" height="123" id="mySwf_container" class="lots"> <param name="movie" value="/swfs/mySwf.swf" /> <param name="play" value="true"/> -<param name="flashvars" value="myVar=value+1+%3E+2"/> +<param name="flashvars" value="myVar=value+1+%3E+2&id=mySwf"/> <!--[if !IE]>--> <object type="application/x-shockwave-flash" data="/swfs/mySwf.swf" width="456" height="123" id="mySwf"> <param name="play" value="true"/> -<param name="flashvars" value="myVar=value+1+%3E+2"/> +<param name="flashvars" value="myVar=value+1+%3E+2&id=mySwf"/> <!--<![endif]--> <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" /> test/results.rb @@ -63,9 +63,9 @@ class SwfFuTest < ActionView::TestCase context "with custom defaults" do setup do - test = {:flashvars=> {:xyz => "abc"}, :mode => :static, :size => "400x300"} + 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 => "world"}, :mode => :static, :size => "400x300") + @expect_with_hello = swf_tag("test", :flashvars => {:xyz => "abc", :hello => "my friend"}, :mode => :static, :size => "400x300") ActionView::Base.swf_default_options = test end @@ -74,7 +74,7 @@ class SwfFuTest < ActionView::TestCase end should "merge suboptions" do - assert_equal @expect_with_hello, swf_tag("test", :flashvars => {:hello => "world"}) + assert_equal @expect_with_hello, swf_tag("test", :flashvars => {:hello => "my friend"}.freeze) end teardown { ActionView::Base.swf_default_options = {} } test/swf_fu_test.rb bd9413b786d1d98c1362bd3507ed3b01168a93de Marc-Andre Lafortune github@marc-andre.ca http://github.com/marcandre/swf_fu/commit/526dd7f6e5bde8674d31c4e2517645fccf443bcf 526dd7f6e5bde8674d31c4e2517645fccf443bcf 2009-01-14T18:47:54-08:00 2009-01-14T18:47:54-08:00 v1.2.0, with better handling of flashvars (see CHANGELOG) 61bacc08201a6dfbcf19bf8b47292658164698ee Marc-Andre Lafortune github@marc-andre.ca