swfobject-rails 1.1.1 → 2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c217d21362a88a01ed03eea57ac21bb03a72792d
+  data.tar.gz: 7b03000f5439a775db520f8d47134d23efb8a9fe
+SHA512:
+  metadata.gz: 45c5663d74f961aa0e43ccc4e34a042549c6ba5533baede562f98e6eb6708a92ebf7b0c50a282f650201f3235d25a1d806dc07d644c94fe415f1555c8c9ac6d9
+  data.tar.gz: 9401f04d007417534a887e8810f6b3f168d7f5699bfe174523d1cd55d82e7528a44578158236c87cd5023507c8b9fc2dffa9f1ca37390eef938749e31d3f0c34

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/dummy/tmp
+spec/dummy/log

data/.rspec

@@ -0,0 +1 @@
+--format d --color

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2010 - 2013 Corin Langosch
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,32 +1,84 @@
-Rails 3.x Integration for swfobject
+Rails Integration for SWFObject
 ==
 
-This gem integrates [swfobject](http://code.google.com/p/swfobject/) with the Rails 3.x asset pipeline. It has been tested with Rails 3.1 and 3.2.
+This gem integrates [SWFObject](http://code.google.com/p/swfobject/) with the Rails asset pipeline. It has been tested with Rails 3.1, 3.2 and 4.0.
 
 
-Install
---
+Installation
+------------
 
-Just add it got your Gemfile:
+Just add it to your `Gemfile`:
 
-  gem swfobject-rails
+``` ruby
+gem "swfobject-rails"
+```
 
 
 Quick Start
---
+-----------
 
-Add to your application.js:
+Add to your `application.js`:
 
-    //= require swfobject
+``` javascript
+//= require swfobject
+```
 
 Place your SWFs you want to incude somewhere in the rails assets directories (ex. app/assets/swfs/...).
 
-In your view you can now do:
+swfobject-rails includes a helper for generating static embed code, `#swf_tag`:
 
-    <%= swf_tag "video" %>
+``` erb
+<%= swf_tag "video", :id => "my_video", :params => {:loop => true}, :flashvars => {:debug => true} do %>
+  <p>You should download the latest Flash player!</p>
+<% end %>
+```
+
+This would generate the following HTML:
+
+``` html
+<object id="my_video" name="my_video" width="100%" height="100%" classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000">
+  <param name="movie" value="/assets/video.swf" />
+  <param name="wmode" value="transparent" />
+  <param name="loop" value="true" />
+  <param name="allowfullscreen" value="true" />
+  <param name="allowscriptaccess" value="always" />
+  <param name="flashvars" value="debug=true" />
+  <!--[if !IE]>-->
+    <object data="/assets/video.swf" width="100%" height="100%">
+      <param name="wmode" value="transparent" />
+      <param name="loop" value="true" />
+      <param name="allowfullscreen" value="true" />
+      <param name="allowscriptaccess" value="always" />
+      <param name="flashvars" value="debug=true" />
+      <!--<![endif]-->
+        <p>You should download the latest Flash player!</p>
+      <!--[if !IE]>-->
+    </object>
+  <!--<![endif]-->
+</object>
+<script type="text/javascript">
+  swfobject.registerObject("my_video", "9.0.0", "/assets/expressInstall.swf");
+</script>
+```
 
 
 Updating
---
+--------
+
 When new versions swfobject are released, simply update the gem to the latest version.
 
+
+Contributing
+--------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+Copyright
+--------
+
+Copyright (c) 2010 - 2013 [Corin Langosch](http://www.corinlangosch.com) and contributors. Released unter the MIT license.

data/app/helpers/swfobject_helper.rb

@@ -1,47 +1,88 @@
-# encoding: utf-8
 module SwfobjectHelper
-  def swf_path(source)
-    asset_path(source)
-  end
+  # Default options for the #swfobject helper.
+  DEFAULT_OPTIONS = {
+    :width   => "100%",
+    :height  => "100%",
+    :version => "9.0.0",
+    :partial => "shared/swfobject"
+  }
 
-  def swf_tag(name, options = {})
-    width = height = nil
-    if options[:size]
-      width, height = options[:size].split("x")
-    else
-      width = options.delete(:width)
-      height = options.delete(:height)
-    end
+  # Default <param> tags.
+  DEFAULT_PARAMS = {
+    :allowfullscreen   => true,
+    :allowscriptaccess => "always",
+    :wmode             => "transparent"
+  }
+
+  # Generates static embed HTML using the method recommend here:
+  # http://code.google.com/p/swfobject/wiki/documentation
+  #
+  # +file+ is the path to the SWF. Alternate content can be used
+  # by passing a +block+
+  #
+  # Other Options:
+  #
+  #   * <tt>:id</tt>        - The ID on the outer <object> tag. Defaults to
+  #                           an underscored version of the filename.
+  #   * <tt>:width</tt>     - The width of the SWF. Defaults to "100%".
+  #   * <tt>:height</tt>    - The height of the SWF. Defaults to "100%".
+  #   * <tt>:version</tt>   - The minimum version of the Flash player required.
+  #                           Defaults to "9.0.0".
+  #   * <tt>:params</tt>    - A hash of parameters to configure the SWF. Will be used
+  #                           to generate <param> tags. Defaults to DEFAULT_PARAMS.
+  #   * <tt>:flashvars</tt> - A hash of variables to send to the flash file. Will
+  #                           be sent using an encoded value in a <param> tag.
+  #
+  def swf_tag(file, options = {}, &block)
+    options = options.reverse_merge(DEFAULT_OPTIONS)
+
+    # Get path to asset
+    file = swf_path(file)
 
-    if options[:flashvars]
-      # we need to urlencode flashvars, see question 9 at
-      # http://code.google.com/p/swfobject/wiki/faq
-      flashvars = {}
-      options[:flashvars].each_pair do |k, v|
-        flashvars[CGI.escape(k.to_s)] = CGI.escape(v.to_s)
-      end
-    else
-      flashvars = options[:flashvars]
+    # Extract params from options
+    params = options.delete(:params) || {}
+    params.reverse_merge!(DEFAULT_PARAMS)
+
+    # Extract flashvars and add to params
+    if flashvars = options.delete(:flashvars)
+      params[:flashvars] = flashvars.to_query
     end
 
-    code = "swfobject.embedSWF('%s', '%s', '%s', '%s', '%s', '%s', %s, %s, %s, %s);" % [
-      swf_path("#{name}.swf"),
-      options[:dom_id] || name,
-      width,
-      height,
-      options[:version] || "9.0.0",
-      swf_path("expressInstall.swf"),
-      flashvars.to_json,
-      options[:params].to_json,
-      options[:attributes].to_json,
-      options[:callback] ? options[:callback] : "null",
-    ]
-
-    javascript_tag(code)
+    # Generate ID from file if necessary
+    id = options.delete(:id) || File.basename(file, File.extname(file)).underscore
+
+    # Extract other specific options
+    version     = options.delete(:version)
+    partial     = options.delete(:partial)
+    alt_content = options.delete(:alternate_content)
+    alt_content = capture(&block) if block_given?
+
+    # And finally, render the partial
+    render partial,
+      :file              => file,
+      :id                => id,
+      :version           => version,
+      :params            => params,
+      :attributes        => options,
+      :alternate_content => alt_content
   end
+  alias :swfobject :swf_tag
 
-  def swfoject(*args)
-    swf_tag(*args)
+  # Computes the path to a SWF file in the assets pipeline.
+  # If the +source+ filename has no extension, .swf will be appended (except for explicit URIs)
+  # Full paths from the document root will be passed through.
+  # Used internally by #swf_tag to build the path to the SWF file.
+  #
+  # ==== Examples
+  #
+  #   swf_path "file"                            # => /assets/file.swf
+  #   swf_path "dir/file.swf"                    # => /assets/dir/file.swf
+  #   swf_path "/dir/file.swf"                   # => /dir/file.swf
+  #   swf_path "http://www.example.com/file"     # => http://www.example.com/file
+  #   swf_path "http://www.example.com/file.swf" # => http://www.example.com/file.swf
+  #
+  def swf_path(source)
+    source = source + ".swf" if source !~ /^http/ && File.extname(source) == ""
+    asset_path(source)
   end
 end
-

data/app/views/shared/_swfobject.html.erb

@@ -0,0 +1,21 @@
+<%= content_tag :object, attributes.merge(:id => id, :name => id, :classid => "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000") do %>
+  <%= tag :param, :name => "movie", :value => file %>
+  <% params.each do |name, value| %>
+    <%= tag :param, :name => name, :value => value %>
+  <% end %>
+  <!--[if !IE]>-->
+    <%= content_tag :object, attributes.merge(:data => file) do %>
+      <% params.each do |name, value| %>
+        <%= tag :param, :name => name, :value => value %>
+      <% end %>
+      <% if alternate_content %>
+        <!--<![endif]-->
+          <%= raw alternate_content.to_s %>
+        <!--[if !IE]>-->
+      <% end %>
+    <% end %>
+  <!--<![endif]-->
+<% end %>
+<script type="text/javascript">
+  swfobject.registerObject("<%= id %>", "<%= version %>", "<%= swf_path 'expressInstall' %>");
+</script>

data/lib/swfobject/rails/version.rb

@@ -2,7 +2,6 @@ module Swfobject
   VERSION = "2.2"
 
   module Rails
-    VERSION = "1.1.1"
+    VERSION = "2.0"
   end
 end
-

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/swfobject-full.js

@@ -0,0 +1 @@
+//= require swfobject

data/spec/dummy/app/assets/javascripts/swfobject-min.js

@@ -0,0 +1 @@
+//= require swfobject.min

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "rails/all"
+Bundler.require
+require "swfobject-rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!