RubyGems - swf_train - Versions diffs - 0.0.2 → 1.0.0 - Mend

swf_train 0.0.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

data/.rspec ADDED

	@@ -0,0 +1 @@
1	+ --colour

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in swf_train.gemspec
+gemspec

data/Gemfile.lock ADDED

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    swf_train (0.0.3)
+      rails
+      rake
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    abstract (1.0.0)
+    actionmailer (3.0.9)
+      actionpack (= 3.0.9)
+      mail (~> 2.2.19)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.5)
+      sys-uname
+    autotest-growl (0.2.9)
+    autotest-rails-pure (4.1.2)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.9)
+      actionmailer (= 3.0.9)
+      actionpack (= 3.0.9)
+      activerecord (= 3.0.9)
+      activeresource (= 3.0.9)
+      activesupport (= 3.0.9)
+      bundler (~> 1.0)
+      railties (= 3.0.9)
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rdoc (3.8)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sys-uname (0.8.5)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  autotest
+  autotest-fsevent
+  autotest-growl
+  autotest-rails-pure
+  rspec
+  swf_train!

data/README.md ADDED

@@ -0,0 +1,62 @@
+SWF Train (swiff train)
+=======================
+SWF Train is a simple and flexible Rails helper for embedding SWFs in your views.
+It requires [jQuery](http://jquery.com/) and [jQuery SWFObject](http://jquery.thewikies.com/swfobject/).
+Installation
+------------
+  gem install swf_train
+Usage
+-----
+``` ruby
+# <head>
+javascript_include_tag %w(jquery-1.3.2.min jquery.swfobject.1-1-1.min)
+# <body>
+swf 'my_swf.swf'
+swf 'subdirectory/of/public/another.swf', :width => 500, :height => 300
+swf 'http://example.com/yet_another.swf', :wmode => 'opaque'
+```
+Passing in FlashVars is easy:
+``` ruby
+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:
+``` ruby
+swf 'swf/foo.swf', :dom_id => 'custom_dom_dom_doobie', :create_dom_container => false
+```
+SWF Train provides built-in support for the awesome non-blocking [head.js](http://headjs.com/) library,
+so you can use jQuery on the body of the page even though it is not included yet:
+``` ruby
+swf 'swf/foo.swf', :use_headjs => true
+```
+See full auto-generated documentation at [rdoc.info/projects/zeke/swf_train](http://rdoc.info/projects/zeke/swf_train)
+Compatibility
+-------------
+- v1.0+ requires Rails 3
+- v0.0.2 is compatible with Rails 2
+Tests
+-----
+    bundle exec rake spec
+Copyright
+---------
+Copyright (c) 2010-2011 Zeke Sikelianos. See LICENSE for details.

data/Rakefile CHANGED

@@ -1,45 +1,6 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "swf_train"
-    gem.summary = "A simple and flexible Rails helper for embedding SWFs in your views."
-    gem.description = "A simple and flexible Rails helper for embedding SWFs in your views."
-    gem.email = "zeke@sikelianos.com"
-    gem.homepage = "http://github.com/zeke/swf_train"
-    gem.authors = ["Zeke Sikelianos"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-task :spec => :check_dependencies
-task :default => :spec
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "swf_train #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/lib/swf_train.rb CHANGED

@@ -6,11 +6,12 @@ module SwfTrain
   #
   #  swf 'foo.swf'
   #  swf 'foo.swf', :height => 50, :flashvars => {:a => 1, :b => 'two'}
+  #  swf 'foo.swf', :use_headjs => true # If you're using head.js (http://headjs.com)
   #
   # 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)
+  def swf(swf_file, options={})
     options = {
       :swf => swf_file,
       :dom_id => filename_to_dom_id(swf_file),
@@ -20,10 +21,15 @@ module SwfTrain
       :wmode => "opaque",
       :allowScriptAccess => "sameDomain",
       :create_dom_container => true,
-    }.merge(args.extract_options!)
+    }.merge!(options)
     out = []
+    # Yank use_headjs boolean out of the options hash
+    # See http://headjs.com/
+    use_headjs = options.delete(:use_headjs)
+    ready_wrapper = use_headjs ? "head" : "$(document)"
     # Yank dom_id out of the options hash
     dom_id = options.delete(:dom_id)
@@ -47,8 +53,9 @@ module SwfTrain
     embed = hash_to_key_value_string(options)
     # Spit it out!
-    out << content_tag(:script, "$(document).ready(function(){$('##{dom_id}').flash({#{embed}});});", :type => "text/javascript", :charset => "utf-8")
-    out.reverse.join("\n")
+    out << content_tag(:script, "#{ready_wrapper}.ready(function(){$('##{dom_id}').flash({#{embed}});});".html_safe, :type => "text/javascript", :charset => "utf-8")
+    out.reverse.join("\n").html_safe
   end
   # Convert a string to dom-friendly format.
@@ -67,10 +74,10 @@ module SwfTrain
   def hash_to_key_value_string(hash)
     pairs = []
     hash.each_pair do |k,v|
-      v = "'#{v}'" unless k.to_s=='flashvars' || !v.to_s.match(/^[0-9]*\.[0-9]+|[0-9]+$/).nil?
+      v = "\"#{v}\"" unless k.to_s=='flashvars' || !v.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/).nil?
       pairs << "#{k}:#{v}"
     end
-    pairs.sort.join(", ")
+    pairs.sort.join(", ").html_safe
   end
 end

data/lib/swf_train/version.rb ADDED

@@ -0,0 +1,3 @@
+module SwfTrain
+  VERSION = "1.0.0"
+end

data/spec/spec.opts CHANGED

@@ -1 +1,4 @@
---color
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb CHANGED

@@ -1,9 +1,13 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'swf_train'
-require 'spec'
-require 'spec/autorun'
+require 'rubygems'
+require 'bundler/setup'
+require 'active_support/all' # to get methods like blank? and starts_with?
+require 'action_view'
+require 'swf_train' # and any other gems you need
-Spec::Runner.configure do |config|
-end
+include ActionView::Helpers
+include ActiveSupport
+include SwfTrain
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/swf_train_spec.rb CHANGED

@@ -1,7 +1,33 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 describe "SwfTrain" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  describe "DOM container" do
+    it "gets created by default" do
+      swf('foo.swf').should =~ /<div id=\"foo_swf\"/
+    end
+    it "is not created if :create_dom_container option is false" do
+      swf('foo.swf', :create_dom_container => false).should_not =~ /<div id=\"foo_swf\"/
+    end
+    it "takes a custom name" do
+      swf('foo.swf', :dom_id => 'binkle_dinkle').should =~ /<div id=\"binkle_dinkle\"/
+    end
+  end
+  describe "ready_wrapper" do
+    it "wraps the output in jQuery-style ready statement by default" do
+      swf('foo.swf').should =~ /\$\(document\)\.ready/
+    end
+    it "wraps the output in a head.js read statement if :use_headjs option is present" do
+      swf('foo.swf', :use_headjs => true).should =~ /head\.ready/
+    end
   end
 end

data/swf_train.gemspec CHANGED

@@ -1,56 +1,31 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "swf_train/version"
 Gem::Specification.new do |s|
-  s.name = %q{swf_train}
-  s.version = "0.0.2"
+  s.name        = "swf_train"
+  s.version     = SwfTrain::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Zeke Sikelianos"]
+  s.email       = ["zeke@sikelianos.com"]
+  s.homepage    = "https://github.com/zeke/swf_train"
+  s.summary     = %q{A simple and flexible Rails helper for embedding SWFs in your views.}
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Zeke Sikelianos"]
-  s.date = %q{2010-04-04}
-  s.description = %q{A simple and flexible Rails helper for embedding SWFs in your views.}
-  s.email = %q{zeke@sikelianos.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lib/swf_train.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "spec/swf_train_spec.rb",
-     "swf_train.gemspec"
-  ]
-  s.homepage = %q{http://github.com/zeke/swf_train}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A simple and flexible Rails helper for embedding SWFs in your views.}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/swf_train_spec.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<rspec>, [">= 1.2.9"])
-    else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-  end
-end
+  s.rubyforge_project = "swf_train"
+  s.add_dependency 'rails'
+  s.add_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  # Optional..
+  s.add_development_dependency 'autotest'
+  s.add_development_dependency 'autotest-rails-pure'
+  s.add_development_dependency 'autotest-growl'
+  s.add_development_dependency 'autotest-fsevent'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata CHANGED

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: swf_train
 version: !ruby/object:Gem::Version
-  prerelease: false
-  segments:
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  prerelease:
+  version: 1.0.0
 platform: ruby
 authors:
 - Zeke Sikelianos
@@ -14,75 +10,137 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-04-04 00:00:00 -05:00
-default_executable:
+date: 2011-07-26 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rails
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        segments:
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
-  type: :development
+        version: "0"
+  type: :runtime
   version_requirements: *id001
-description: A simple and flexible Rails helper for embedding SWFs in your views.
-email: zeke@sikelianos.com
+- !ruby/object:Gem::Dependency
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: autotest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency
+  name: autotest-rails-pure
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency
+  name: autotest-fsevent
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description:
+email:
+- zeke@sikelianos.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
 files:
 - .document
 - .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
-- init.rb
 - lib/swf_train.rb
+- lib/swf_train/version.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/swf_train_spec.rb
 - swf_train.gemspec
-has_rdoc: true
-homepage: http://github.com/zeke/swf_train
+homepage: https://github.com/zeke/swf_train
 licenses: []
 post_install_message:
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
       version: "0"
 requirements: []
-rubyforge_project:
-rubygems_version: 1.3.6
+rubyforge_project: swf_train
+rubygems_version: 1.8.5
 signing_key:
 specification_version: 3
 summary: A simple and flexible Rails helper for embedding SWFs in your views.
 test_files:
+- spec/spec.opts
 - spec/spec_helper.rb
 - spec/swf_train_spec.rb

data/README.rdoc DELETED

@@ -1,45 +0,0 @@
-= SWF Train (swiff train)
-A simple and flexible Rails helper for embedding SWFs in your views.
-Requires {jQuery}[http://jquery.com/] and {jQuery SWFObject}[http://jquery.thewikies.com/swfobject/].
-== Installation
-Install {gemcutter}[http://gemcutter.org] if you haven't already:
-  sudo gem install gemcutter
-  gem tumble
-Get on the swiff train
-  sudo gem install swf_train
-== Usage
-The following example assumes you're using {haml}[http://haml-lang.com/]:
-  %html
-    %head
-      =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
-      = 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_train}[http://rdoc.info/projects/zeke/swf_train]
-== Colophon
-* Gem built with {Jeweler}[http://github.com/technicalpickles/jeweler]
-== Copyright
-Copyright (c) 2010 Zeke Sikelianos. See LICENSE for details.

data/VERSION DELETED

	@@ -1 +0,0 @@
1	- 0.0.2

data/init.rb DELETED

	@@ -1 +0,0 @@
1	- require 'swf_train'