RubyGems - jekyll-swfobject - Versions diffs - 1.0.0 - Mend

jekyll-swfobject 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 (14) hide show

checksums.yaml +15 -0
data/.gitignore +6 -0
data/Gemfile +4 -0
data/History.md +9 -0
data/LICENSE.txt +22 -0
data/README.md +160 -0
data/Rakefile +12 -0
data/jekyll-swfobject.gemspec +29 -0
data/lib/jekyll-swfobject.rb +175 -0
data/lib/jekyll-swfobject/version.rb +5 -0
data/test/test_helper.rb +72 -0
data/test/test_swfobject_tag_attributes.rb +604 -0
data/test/test_swfobject_tag_config.rb +503 -0
metadata +144 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDYwOWMyNjFhMzZmZmQ2Njc5NDg5MTljMDA0ZGZjYjkzMjllZmY2NA==
+  data.tar.gz: !binary |-
+    MmQ2NmQ0MDA5MjIyMGNiNDIxN2MxMGY1MjY0MDM1MDVkMjczODQ0MQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjdlNTdmYjVlMGY3NjJmNGU2NzRkZmI5MGFlYjBiMDI1YzIyNDQxOTQ0MTVl
+    ZWNmYTAzZWU2YWU0ZWJlMGVmMjdkNzIyZmYxMDc3OWE1OWMzNWY5YWNiMjE3
+    MzBkNGEyNDA3ZWJjYTI4ZTY4ZDgzNzE0YjYzNTIwNDMzMGE0YjI=
+  data.tar.gz: !binary |-
+    NDZmNzc5ZDlkOWJmOWRhN2FlMmE1ODBkOWRmZTg1OTM4YmViYzYzNjgxMjMz
+    OGM4OWYwNTI5MDYzMzUyODI0MDEwZWIyNjI4NTg1OTAxZTMxZDk2MzUzZDIx
+    ODlkYTYzZDc3OTQ0OTA1ZWJkNmVmMGU3YmUzMGEwYmY0MWM1MjQ=

data/.gitignore ADDED Viewed

@@ -0,0 +1,6 @@
+.idea/*
+*.iml
+.DS_Store
+*.rvmc
+Gemfile.lock

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in jekyll-swfobject.gemspec
+gemspec

data/History.md ADDED Viewed

@@ -0,0 +1,9 @@
+## Revision history of jekyll-swfobject
+### 1.0.0 / 2013-07-04
+  * Unit tests added
+  * Ruby code improvements
+  * Deployed to http://rubygems.org/
+### 0.9.0 / 2013-01-10
+  * First release

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2013 "sectore" Jens Krause // [WEBSECTOR.DE](http://websector.de)
+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 ADDED Viewed

@@ -0,0 +1,160 @@
+# Jekyll Plugin: SWFObject Tag
+SWFObject Tag is a [Liquid](http://www.liquidmarkup.org/) plugin for [Jekyll](http://jekyllrb.com/) to embed Flash files (*.swf) using [SWFObject](http://code.google.com/p/swfobject/)
+## Installation
+1 Add this line to your application's Gemfile:
+    gem 'jekyll-swfobject'
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install jekyll-swfobject
+2. Link SWFObject in your layout template or page within `<head>` or before `{% swfobject %}` :
+    `<script src="//ajax.googleapis.com/ajax/libs/swfobject/2.2/swfobject.js"></script>`
+## Usage
+### Tag
+    {% swfobject swf_url %}{% endswfobject %}
+Note: Because SWFObject Tag is a `Liquid::Block`, you have to close any `{% swfobject %}` with `{% endswfobject %}` in your templates.
+#### Optional parameters
+All optional parameters are defined using `key:value` pairs.
+    {% swfobject swf_url id:myFlash content_id:flashcontent width:500 height:600  %}{% endswfobject %}
+Note: Don't use whitespaces between `:` to avoid issues rendering templates.
+For all optional parameters check section [Parameters](#parameters) below.
+#### Alternative HTML content
+    {% swfobject swf_url %}
+    <p>Latest <a href='http://www.adobe.com/go/getflashplayer'>Flash Player Plugin</a> is required.</p>
+    {% endswfobject %}
+#### Optional parameters defined in `_config.yml`
+    swfobject:
+      height: 350
+      width: 200
+      express_install_url: expressInstall.swf
+      alternative_content: <p>Please install latest <a href='http://www.adobe.com/go/getflashplayer'>Flash Player Plugin</a>.</p>
+For all optional parameters check section [Parameters](#parameters) below.
+## Parameters
+### Required parameter
+`swf_url` - Path to SWF, which has to be embedded
+### Optional parameters
+All optional parameters can be defined within `{% swfobject %}` and / or using `_config.yml`.
+Parameters defined in `_config.yml` will be overridden by tag parameters.
+`content_id` - Id of the div container, which will be replaced by SWFObject to embed SWF
+`height` - Height (`px`, `%`, `em` or `rem`) of the embedded SWF and of the surrounded `<div>` (default: 100%)
+`width` - Width (`px`, `%`, `em` or `rem`) of the embedded SWF and of the surrounded `<div>`  (default: 100%).
+Note: For a better support of fluid and responsive layouts using `em`, `rem` etc. the plugin creates an extra `div`,
+which wrappes the generated `<object>` tag. This wrapper `div` will be sized using values of `height` and `width`.
+The wrapper can be addressed by using the `content_id` + `-wrapper`, e.g. `flashcontent-wrapper`.
+`version` - Version of the Flash Player Plugin (default: 10.0)
+`flashvars` - String of flashvars using `key=value` pairs combinend with `&`, e.g. `name1=hello&name2=world`
+`express_install_url` - URL of the expressInstall.swf
+`callback_function` - Callback function to check success or failure of creating a Flash plug-in `<object>`
+#### Optional Attributes of the `<object>` element
+`id`
+`align`
+`name`
+`styleclass`
+For detailed information check SWF Object documentation: http://code.google.com/p/swfobject/wiki/documentation
+#### Optional Flash specific parameters
+`play`
+`loop`
+`menu`
+`quality`
+`scale`
+`salign`
+`wmode`
+`bgcolor`
+`base`
+`swliveconnect`
+`devicefont`
+`allowscriptaccess`
+`seamlesstabbing`
+`allowfullscreen`
+`allownetworking`
+For detailed information check SWF Object documentation: http://code.google.com/p/swfobject/wiki/documentation
+## Live example
+SWFObject Tag is used by the Jekyll generated website [WEBSECTOR.DE](http://websector.de). You will find the [source](https://github.com/sectore/websector.de) of WEBSECTOR.DE [here](https://github.com/sectore/websector.de) at GitHub.
+## Test
+The plugin is well tested using [Test::Unit](http://www.ruby-doc.org/core/classes/Test/Unit.html) with [Shoulda](https://github.com/thoughtbot/shoulda) and [Mocha](http://gofreerange.com/mocha/). To start tests just run
+    rake test
+## 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
+## License
+Copyright (c) 2013 "sectore" Jens Krause // [WEBSECTOR.DE](http://websector.de)
+SWFObject Tag is free software and it may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile ADDED Viewed

@@ -0,0 +1,12 @@
+# test tasks
+# ---------------------------------------------
+require "bundler/gem_tasks"
+require 'rake/testtask'
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/test_*.rb'
+end

data/jekyll-swfobject.gemspec ADDED Viewed

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-swfobject/version"
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-swfobject"
+  spec.version       = Jekyll::SWFObject::VERSION
+  spec.authors       = ["Jens Krause"]
+  spec.email         = ["info@websector.de"]
+  spec.description   = %q{Liquid plugin for using SWFObject with Jekyll}
+  spec.summary       = %q{SWFObject Tag is a Liquid plugin for Jekyll to embed Flash files (*.swf) using SWFObject}
+  spec.homepage      = "https://github.com/sectore/jekyll-swfobject"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "jekyll", "~> 1.0.3"
+  spec.add_development_dependency("bundler", "~> 1.3")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("shoulda", "~> 3.5")
+  spec.add_development_dependency("shoulda-context", "~> 1.0")
+  spec.add_development_dependency("mocha", ">= 0.14")
+end

data/lib/jekyll-swfobject.rb ADDED Viewed

@@ -0,0 +1,175 @@
+# SWFObject Tag
+# is a Jekyll plugin to embed Flash files (*.swf) using SWFObject http://code.google.com/p/swfobject/
+#
+# Example:
+#
+#   {% swfobject swf_url %}{% endswfobject %}
+# or
+#   {% swfobject  swf_url id:swfID content_id:flashcontent width:500px height:600px  %}{% endswfobject %}
+# or
+#   {% swfobject swf_url %}
+#   <p>Alternative HTML content, e.g. Latest <a href='http://www.adobe.com/go/getflashplayer'>Flash Player Plugin</a> is required.</p>
+#   {% endswfobject %}
+#
+# Full documentation:
+# https://github.com/sectore/jekyll-swfobject/blob/master/README.md
+#
+# Author: Jens Krause http://websector.de
+# Source: https://github.com/sectore/jekyll-swfobject
+# License: MIT
+module Jekyll
+  module SWFObject
+    class SWFObjectTag < Liquid::Block
+      #
+      # constants
+      #
+      @@ATTRIBUTES = %w(
+        id align name styleclass
+      )
+      @@PARAMETERS = %w(
+        play loop menu quality scale salign wmode bgcolor base
+        swliveconnect devicefont allowscriptaccess seamlesstabbing allowfullscreen allownetworking
+      )
+      @@DEFAULTS = {
+        :content_id => 'flashcontent',
+        :width => '100%',
+        :height => '100%',
+        :version => '10.0',
+        :flashvars => '',
+        :alternative_content => "<p>Please install latest <a href='http://www.adobe.com/go/getflashplayer'>Flash Player Plugin</a>.</p>"
+      }
+      def self.DEFAULTS
+        return @@DEFAULTS
+      end
+      def initialize(tag_name, text, tokens)
+        super
+        @config = {}
+        # set defaults
+        override_config(@@DEFAULTS)
+        # override configuration with values defined within _config.yml
+        if Jekyll.configuration({}).has_key?('swfobject')
+          config = Jekyll.configuration({})['swfobject']
+          override_config(config)
+        end
+        params = text.split
+        # first argument (required) is url of swf
+        @swf_url = params.shift.strip
+        if params.size > 0
+          # override configuration with parameters defined within {% swfobject pathToSWF %}
+          config = {} # reset local config
+          params.each do |param|
+            param = param.gsub /\s+/, '' # remove whitespaces
+            key, value = param.split(':',2) # split first occurrence of ':' only
+            config[key.to_sym] = value
+          end
+          override_config(config)
+        end
+      end
+      def override_config(config)
+        config.each{ |key,value| @config[key] = value }
+      end
+      def render(context)
+        output = super
+        <<-HTML.gsub /^\s+/, '' # remove whitespaces from heredocs
+        <div id="#{@config[:content_id]}-wrapper" style="width: #{@config[:width]}; height: #{@config[:height]}">
+          <div id="#{@config[:content_id]}" style="width: 100%; height:100%">#{render_alternative_content(output)}</div>
+        </div>
+        <script type="text/javascript">
+          //  <![CDATA[
+          #{render_flashvars()}
+          #{render_params()}
+          #{render_attributes()}
+          swfobject.embedSWF(
+            '#{@swf_url}',
+            '#{@config[:content_id]}',
+            '100%',
+            '100%',
+            '#{@config[:version]}',
+            #{render_express_install_url()},
+            flashvars,
+            params,
+            attributes,
+            #{render_callback_function()}
+          );
+          // ]]>
+        </script>
+        HTML
+      end
+      def render_alternative_content(output)
+        unless output.strip.size > 0
+          output = @config[:alternative_content]
+        end
+        output
+      end
+      def render_params
+        result = 'var params = {'
+        @config.each do |key, value|
+          if @@PARAMETERS.include?(key.to_s)
+            result += "#{key}:'#{value}',"
+          end
+        end
+        result = remove_last_comma(result)
+        result += '};'
+      end
+      def render_attributes
+        result = 'var attributes = {'
+        @config.each do |key, value|
+          if @@ATTRIBUTES.include?(key.to_s)
+            result += "#{key}:'#{value}',"
+          end
+        end
+        result = remove_last_comma(result)
+        result += '};'
+      end
+      def render_flashvars
+        result = 'var flashvars = {'
+        if !@config[:flashvars].nil?
+          vars = @config[:flashvars].split('&')
+          vars.each do |var|
+            key_value = var.split('=',2) # split first occurrence of '=' only
+            key = key_value.first
+            value = key_value.last
+            result += "#{key}:'#{value}',"
+          end
+          result = remove_last_comma(result)
+        end
+        result += '};'
+      end
+      def render_express_install_url
+        @config[:express_install_url] ? "'#{@config[:express_install_url]}'" : 'null'
+      end
+      def render_callback_function
+        @config[:callback_function] ? "#{@config[:callback_function]}" : 'null'
+      end
+      def remove_last_comma(content)
+        content.gsub(/,?$/, '')
+      end
+    end
+  end
+end
+Liquid::Template.register_tag('swfobject', Jekyll::SWFObject::SWFObjectTag)

data/lib/jekyll-swfobject/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Jekyll
+  module SWFObject
+    VERSION = "1.0.0"
+  end
+end