swf_train 0.0.1

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.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 Zeke Sikelianos
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,45 @@
1
+ = SWF Train (swiff train)
2
+
3
+ A simple and flexible Rails helper for embedding SWFs in your views.
4
+ Requires {jQuery}[http://jquery.com/] and {jQuery SWFObject}[http://jquery.thewikies.com/swfobject/].
5
+
6
+ == Installation
7
+
8
+ Install {gemcutter}[http://gemcutter.org] if you haven't already:
9
+
10
+ sudo gem install gemcutter
11
+ gem tumble
12
+
13
+ Get on the swiff train
14
+
15
+ sudo gem install swf_train
16
+
17
+ == Usage
18
+
19
+ The following example assumes you're using {haml}[http://haml-lang.com/]:
20
+
21
+ %html
22
+ %head
23
+ =javascript_include_tag %w(jquery-1.3.2.min jquery.swfobject.1-0-7.min)
24
+ %body
25
+ = swf 'my_swf.swf'
26
+ = swf 'subdirectory/of/public/another.swf', :width => 500, :height => 300
27
+ = swf 'http://example.com/yet_another.swf', :wmode => 'opaque'
28
+
29
+ Passing in FlashVars is easy:
30
+
31
+ = swf 'swf/foo.swf', :flashvars => {:foo => 'chacha', :bar => 250}
32
+
33
+ By default, a DOM element is automatically created based on a variation of the swf filename, but you can override it like so:
34
+
35
+ = swf 'swf/foo.swf', :dom_id => 'custom_dom_dom_doobie', :create_dom_container => false
36
+
37
+ See full auto-generated documentation at {rdoc.info/projects/zeke/swf_train}[http://rdoc.info/projects/zeke/swf_train]
38
+
39
+ == Colophon
40
+
41
+ * Gem built with {Jeweler}[http://github.com/technicalpickles/jeweler]
42
+
43
+ == Copyright
44
+
45
+ Copyright (c) 2010 Zeke Sikelianos. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,45 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "swf_train"
8
+ gem.summary = "A simple and flexible Rails helper for embedding SWFs in your views."
9
+ gem.description = "Requires jQuery and jQuery SWFObject."
10
+ gem.email = "zeke@sikelianos.com"
11
+ gem.homepage = "http://github.com/zeke/swf_train"
12
+ gem.authors = ["Zeke Sikelianos"]
13
+ gem.add_development_dependency "rspec", ">= 1.2.9"
14
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
15
+ end
16
+ Jeweler::GemcutterTasks.new
17
+ rescue LoadError
18
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
19
+ end
20
+
21
+ require 'spec/rake/spectask'
22
+ Spec::Rake::SpecTask.new(:spec) do |spec|
23
+ spec.libs << 'lib' << 'spec'
24
+ spec.spec_files = FileList['spec/**/*_spec.rb']
25
+ end
26
+
27
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
28
+ spec.libs << 'lib' << 'spec'
29
+ spec.pattern = 'spec/**/*_spec.rb'
30
+ spec.rcov = true
31
+ end
32
+
33
+ task :spec => :check_dependencies
34
+
35
+ task :default => :spec
36
+
37
+ require 'rake/rdoctask'
38
+ Rake::RDocTask.new do |rdoc|
39
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
40
+
41
+ rdoc.rdoc_dir = 'rdoc'
42
+ rdoc.title = "swf_train #{version}"
43
+ rdoc.rdoc_files.include('README*')
44
+ rdoc.rdoc_files.include('lib/**/*.rb')
45
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
data/init.rb ADDED
@@ -0,0 +1 @@
1
+ require 'swf_train'
data/lib/swf_train.rb ADDED
@@ -0,0 +1,78 @@
1
+ module SwfTrain
2
+
3
+ # Outputs javscript to embed your SWF.
4
+ # The only required argument is the swf_file path, relative to the public directory.
5
+ # swf_file can also of course be a full URL.
6
+ #
7
+ # swf 'foo.swf'
8
+ # swf 'foo.swf', :height => 50, :flashvars => {:a => 1, :b => 'two'}
9
+ #
10
+ # By default, a DOM container is generated, but if you don't want that just pass in your
11
+ # custom `dom_id` and set `create_dom_container` to false
12
+ # swf 'swf/foo.swf', :dom_id => 'dombo', :create_dom_container => false)
13
+ def swf(swf_file, *args)
14
+ options = {
15
+ :swf => swf_file,
16
+ :dom_id => filename_to_dom_id(swf_file),
17
+ :name => filename_to_dom_id(swf_file),
18
+ :width => "100%",
19
+ :height => "100%",
20
+ :wmode => "opaque",
21
+ :allowScriptAccess => "sameDomain",
22
+ :create_dom_container => true,
23
+ }.merge(args.extract_options!)
24
+
25
+ out = []
26
+
27
+ # Yank dom_id out of the options hash
28
+ dom_id = options.delete(:dom_id)
29
+
30
+ # Yank create_dom_container option out of the hash, if it exists
31
+ # Create DOM container if option is set to something other than false or nil
32
+ if options.delete(:create_dom_container)
33
+ # Set the div's dimensions right away so the page doesn't jolt into
34
+ # the proper dimensions when the swf loads.
35
+ w = options[:width].to_s
36
+ h = options[:height].to_s
37
+ w += "px" unless w.include? "%"
38
+ h += "px" unless h.include? "%"
39
+ style = "width:#{w};height:#{h}"
40
+ out << content_tag(:div, "", :id => dom_id, :style => style)
41
+ end
42
+
43
+ # Turn flashvars hash into a flashvars-style formatted string
44
+ options[:flashvars] = "{" + hash_to_key_value_string(options[:flashvars]) + "}" if options[:flashvars]
45
+
46
+ # Format options hash (excluding flashvars) into a key:value string..
47
+ embed = hash_to_key_value_string(options)
48
+
49
+ # Spit it out!
50
+ out << content_tag(:script, "$(document).ready(function(){$('##{dom_id}').flash({#{embed}});});", :type => "text/javascript", :charset => "utf-8")
51
+ out.reverse.join("\n")
52
+ end
53
+
54
+ # Convert a string to dom-friendly format.
55
+ # Adapted from permalink_fu
56
+ def filename_to_dom_id(str)
57
+ result = str.split("/").last.gsub(".", "_") # e.g. 'foo.swf' -> 'foo_swf'
58
+ result.gsub!(/[^\x00-\x7F]+/, '') # Remove anything non-ASCII entirely (e.g. diacritics).
59
+ result.gsub!(/[^\w \-]+/i, '') # Remove unwanted chars.
60
+ result.gsub!(/[ \-]+/i, '-') # No more than one of the separator in a row.
61
+ result.gsub!(/^\-|\-$/i, '') # Remove leading/trailing separator.
62
+ result.downcase
63
+ end
64
+
65
+ # Convert a hash to a string of key:value pairs, delimited by commas
66
+ # Wrap in quotes unless numeric or flashvars hash
67
+ def hash_to_key_value_string(hash)
68
+ pairs = []
69
+ hash.each_pair do |k,v|
70
+ v = "'#{v}'" unless k.to_s=='flashvars' || !v.to_s.match(/^[0-9]*\.[0-9]+|[0-9]+$/).nil?
71
+ pairs << "#{k}:#{v}"
72
+ end
73
+ pairs.sort.join(", ")
74
+ end
75
+
76
+ end
77
+
78
+ ActionView::Base.send(:include, SwfTrain) if defined? Rails
data/spec/spec.opts ADDED
@@ -0,0 +1 @@
1
+ --color
@@ -0,0 +1,9 @@
1
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
2
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
3
+ require 'swf_train'
4
+ require 'spec'
5
+ require 'spec/autorun'
6
+
7
+ Spec::Runner.configure do |config|
8
+
9
+ end
@@ -0,0 +1,7 @@
1
+ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
2
+
3
+ describe "SwfTrain" do
4
+ it "fails" do
5
+ fail "hey buddy, you should probably rename this file and start specing for real"
6
+ end
7
+ end
data/swf_train.gemspec ADDED
@@ -0,0 +1,56 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{swf_train}
8
+ s.version = "0.0.1"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Zeke Sikelianos"]
12
+ s.date = %q{2010-04-04}
13
+ s.description = %q{Requires jQuery and jQuery SWFObject.}
14
+ s.email = %q{zeke@sikelianos.com}
15
+ s.extra_rdoc_files = [
16
+ "LICENSE",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ ".gitignore",
22
+ "LICENSE",
23
+ "README.rdoc",
24
+ "Rakefile",
25
+ "VERSION",
26
+ "init.rb",
27
+ "lib/swf_train.rb",
28
+ "spec/spec.opts",
29
+ "spec/spec_helper.rb",
30
+ "spec/swf_train_spec.rb",
31
+ "swf_train.gemspec"
32
+ ]
33
+ s.homepage = %q{http://github.com/zeke/swf_train}
34
+ s.rdoc_options = ["--charset=UTF-8"]
35
+ s.require_paths = ["lib"]
36
+ s.rubygems_version = %q{1.3.6}
37
+ s.summary = %q{A simple and flexible Rails helper for embedding SWFs in your views.}
38
+ s.test_files = [
39
+ "spec/spec_helper.rb",
40
+ "spec/swf_train_spec.rb"
41
+ ]
42
+
43
+ if s.respond_to? :specification_version then
44
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
45
+ s.specification_version = 3
46
+
47
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
48
+ s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
49
+ else
50
+ s.add_dependency(%q<rspec>, [">= 1.2.9"])
51
+ end
52
+ else
53
+ s.add_dependency(%q<rspec>, [">= 1.2.9"])
54
+ end
55
+ end
56
+
metadata ADDED
@@ -0,0 +1,88 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: swf_train
3
+ version: !ruby/object:Gem::Version
4
+ prerelease: false
5
+ segments:
6
+ - 0
7
+ - 0
8
+ - 1
9
+ version: 0.0.1
10
+ platform: ruby
11
+ authors:
12
+ - Zeke Sikelianos
13
+ autorequire:
14
+ bindir: bin
15
+ cert_chain: []
16
+
17
+ date: 2010-04-04 00:00:00 -05:00
18
+ default_executable:
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: rspec
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ segments:
28
+ - 1
29
+ - 2
30
+ - 9
31
+ version: 1.2.9
32
+ type: :development
33
+ version_requirements: *id001
34
+ description: Requires jQuery and jQuery SWFObject.
35
+ email: zeke@sikelianos.com
36
+ executables: []
37
+
38
+ extensions: []
39
+
40
+ extra_rdoc_files:
41
+ - LICENSE
42
+ - README.rdoc
43
+ files:
44
+ - .document
45
+ - .gitignore
46
+ - LICENSE
47
+ - README.rdoc
48
+ - Rakefile
49
+ - VERSION
50
+ - init.rb
51
+ - lib/swf_train.rb
52
+ - spec/spec.opts
53
+ - spec/spec_helper.rb
54
+ - spec/swf_train_spec.rb
55
+ - swf_train.gemspec
56
+ has_rdoc: true
57
+ homepage: http://github.com/zeke/swf_train
58
+ licenses: []
59
+
60
+ post_install_message:
61
+ rdoc_options:
62
+ - --charset=UTF-8
63
+ require_paths:
64
+ - lib
65
+ required_ruby_version: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ segments:
70
+ - 0
71
+ version: "0"
72
+ required_rubygems_version: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ segments:
77
+ - 0
78
+ version: "0"
79
+ requirements: []
80
+
81
+ rubyforge_project:
82
+ rubygems_version: 1.3.6
83
+ signing_key:
84
+ specification_version: 3
85
+ summary: A simple and flexible Rails helper for embedding SWFs in your views.
86
+ test_files:
87
+ - spec/spec_helper.rb
88
+ - spec/swf_train_spec.rb