swf_ditty 0.0.2 → 0.0.3

data/README.rdoc

@@ -21,23 +21,32 @@ Drop this line in your app:
 
 == Usage
 
-The following example assumes you're using {haml}[http://haml-lang.com/] and my {ratpack}[http://github.com/zeke/ratpack] helpers.
+The following example assumes you're using {haml}[http://haml-lang.com/] and my {ratpack}[http://github.com/zeke/ratpack] helpers gem 
+(for the `javascript_include_tag` method): 
 
   %html
     %head
-      =javascript_include_tag %w(jquery-1.3.2.min.js jquery.swfobject.1-0-7.min)
+      =javascript_include_tag %w(jquery-1.3.2.min jquery.swfobject.1-0-7.min)
     %body
       = swf 'my_swf.swf'
-      = swf 'subdirectory/of/public/another.swf', :width => 500, :height => 300, :flashvars => {:foo => 'chacha', :bar => 250}
+      = swf 'subdirectory/of/public/another.swf', :width => 500, :height => 300
       = swf 'http://example.com/yet_another.swf', :wmode => 'opaque'
+
+Passing in FlashVars is easy:
+
+  = swf 'swf/foo.swf', :flashvars => {:foo => 'chacha', :bar => 250}
       
+By default, a DOM element is automatically created based on a variation of the swf filename, but you can override it like so:
+
+  = swf 'swf/foo.swf', :dom_id => 'custom_dom_dom_doobie', :create_dom_container => false
+
 See full auto-generated documentation at {rdoc.info/projects/zeke/swf_ditty}[http://rdoc.info/projects/zeke/swf_ditty]
 
 == Colophon
 
 * Thanks to the Sinatra page on {Writing Extensions}[http://www.sinatrarb.com/extensions.html]
-* Tests modified from {http://github.com/wbzyl/sinatra-static-assets/}[wbzyl/sinatra-static-assets]
-* Gem built with {http://github.com/technicalpickles/jeweler/}[Jeweler]
+* Tests modified from {wbzyl/sinatra-static-assets}[http://github.com/wbzyl/sinatra-static-assets]
+* Gem built with {Jeweler}[http://github.com/technicalpickles/jeweler]
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/sinatra/swf_ditty.rb

@@ -3,11 +3,21 @@ require 'sinatra/base'
 module Sinatra
   module SwfDitty
         
-    def render_swf(swf, *args)
+    # Outputs javscript to embed your SWF.
+    # The only required argument is the swf_file path, relative to the public directory.
+    # swf_file can also of course be a full URL.
+    # 
+    #  swf 'foo.swf'
+    #  swf 'foo.swf', :height => 50, :flashvars => {:a => 1, :b => 'two'}
+    #
+    # By default, a DOM container is generated, but if you don't want that just pass in your 
+    # custom `dom_id` and set `create_dom_container` to false
+    #  swf 'swf/foo.swf', :dom_id => 'dombo', :create_dom_container => false)
+    def swf(swf_file, *args)
       options = {
-        :swf => swf,
-        :dom_id => filename_to_dom_id(swf),
-        :name => filename_to_dom_id(swf),
+        :swf => swf_file,
+        :dom_id => filename_to_dom_id(swf_file),
+        :name => filename_to_dom_id(swf_file),
         :width => "100%",
         :height => "100%",
         :wmode => "opaque",
@@ -46,7 +56,7 @@ module Sinatra
       result.downcase
     end
 
-    # Convert a hash to a string of k:v pairs, delimited by commas
+    # Convert a hash to a string of key:value pairs, delimited by commas
     # Wrap in quotes unless numeric or flashvars hash
     def hash_to_key_value_string(hash)
       hash.each_pair.map do |k,v|

data/swf_ditty.gemspec

@@ -0,0 +1,56 @@
+# 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_ditty}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zeke Sikelianos"]
+  s.date = %q{2009-11-02}
+  s.description = %q{A simple and flexible Sinatra helper for embedding SWFs in your views. Depends on jQuery and jQuery SWFObject}
+  s.email = %q{zeke@sikelianos.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sinatra/swf_ditty.rb",
+     "swf_ditty.gemspec",
+     "test/helper.rb",
+     "test/sinatra_app.rb",
+     "test/test_swf_ditty.rb"
+  ]
+  s.homepage = %q{http://github.com/zeke/swf_ditty}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A simple and flexible Sinatra helper for embedding SWFs in your views.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/sinatra_app.rb",
+     "test/test_swf_ditty.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/sinatra_app.rb

@@ -5,24 +5,24 @@ require 'rubygems'
 require 'sinatra'
 require 'sinatra/swf_ditty'
 
-get "/render_swf_plain" do
+get "/swf_plain" do
   content_type "text/plain"
   <<"EOD"
-#{render_swf("swf/foo.swf")}
+#{swf("swf/foo.swf")}
 EOD
 end
 
-get "/render_swf_with_custom_dom_id" do
+get "/swf_with_custom_dom_id" do
   content_type "text/plain"
   <<"EOD"
-#{render_swf("swf/foo.swf", :dom_id => "dombo", :create_dom_container => false)}
+#{swf("swf/foo.swf", :dom_id => "dombo", :create_dom_container => false)}
 EOD
 end
 
-get "/render_swf_with_flashvars" do
+get "/swf_with_flashvars" do
   content_type "text/plain"
   <<"EOD"
-#{render_swf("foo.swf", :height => 50, :flashvars => {:a => 1, :b => 'two'})}
+#{swf("foo.swf", :height => 50, :flashvars => {:a => 1, :b => 'two'})}
 EOD
 end
 

data/test/test_swf_ditty.rb

@@ -12,8 +12,8 @@ class TestSwfDitty < Test::Unit::TestCase
     Sinatra::Application
   end
 
-  def test_render_swf_plain
-    get '/render_swf_plain'
+  def test_swf_plain
+    get '/swf_plain'
     assert last_response.ok?
     assert_equal last_response.body,  <<EOD
 <script type='text/javascript' charset='utf-8'>$(document).ready(function(){$('#foo_swf').flash({allowScriptAccess:'sameDomain', height:'100%', name:'foo_swf', swf:'swf/foo.swf', width:'100%', wmode:'opaque'});});</script>
@@ -21,16 +21,16 @@ class TestSwfDitty < Test::Unit::TestCase
 EOD
   end
 
-  def test_render_swf_with_custom_dom_id
-    get '/render_swf_with_custom_dom_id'
+  def test_swf_with_custom_dom_id
+    get '/swf_with_custom_dom_id'
     assert last_response.ok?
     assert_equal last_response.body,  <<EOD
 <script type='text/javascript' charset='utf-8'>$(document).ready(function(){$('#dombo').flash({allowScriptAccess:'sameDomain', height:'100%', name:'foo_swf', swf:'swf/foo.swf', width:'100%', wmode:'opaque'});});</script>
 EOD
   end
 
-  def test_render_swf_with_flashvars
-    get '/render_swf_with_flashvars'
+  def test_swf_with_flashvars
+    get '/swf_with_flashvars'
     assert last_response.ok?
     assert_equal last_response.body,  <<EOD
 <script type='text/javascript' charset='utf-8'>$(document).ready(function(){$('#foo_swf').flash({allowScriptAccess:'sameDomain', flashvars:{a:1, b:'two'}, height:50, name:'foo_swf', swf:'foo.swf', width:'100%', wmode:'opaque'});});</script>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: swf_ditty
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Zeke Sikelianos
@@ -39,6 +39,7 @@ files:
 - Rakefile
 - VERSION
 - lib/sinatra/swf_ditty.rb
+- swf_ditty.gemspec
 - test/helper.rb
 - test/sinatra_app.rb
 - test/test_swf_ditty.rb