podlove-web-player-rails 0.2.1 → 0.3.0

data/Rakefile

@@ -1,6 +1 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/lib/podlove-web-player-rails.rb

@@ -1,16 +1,11 @@
 require "podlove-web-player-rails/version"
 require "podlove-web-player-rails/view_helpers"
 
-module Podlove
-  module Web
-    module Player
-      module Rails
-        class Engine < ::Rails::Engine
-          initializer "podlove-web-player-rails.view_helpers" do |app|
-            ActionView::Base.send :include, ViewHelpers
-          end
-        end
-      end
+module PodloveWebPlayerRails
+  # Loads all the needed assets and includes the View Helpers
+  class Engine < ::Rails::Engine
+    initializer "podlove-web-player-rails.view_helpers" do |app|
+      ActionView::Base.send :include, ViewHelpers
     end
   end
 end

data/lib/podlove-web-player-rails/version.rb

@@ -1,9 +1,6 @@
-module Podlove
-  module Web
-    module Player
-      module Rails
-        VERSION = "0.2.1"
-      end
-    end
-  end
+module PodloveWebPlayerRails
+  # version of the gem
+  VERSION = "0.3.0"
+  # version of the podlove web player
+  PODLOVE_WEB_PLAYER_VERSION = "2.0.2"
 end

data/lib/podlove-web-player-rails/view_helpers.rb

@@ -1,39 +1,119 @@
-module Podlove
-  module Web
-    module Player
-      module Rails
-        module ViewHelpers
-          def podloveaudio(options = {})
-            podlove("audio", options)
-          end
-
-          def podlovevideo(options = {})
-            podlove("video", options)
-          end
-
-          private
-
-          def podlove(type, options = {})
-            id = "player_" + SecureRandom.hex(5)
-
-            html = "<#{type} id='#{id}'>"
-            html << "<source src='#{options[:src]}'"\
-                    "" + (options[:type] ? " type='#{options[:type]}'" : "") + "></source>"      if options[:src]
-            html << "<source src='#{options[:mp4]}' type='#{type}/mp4'></source>"                if options[:mp4]
-            html << "<source src='#{options[:mp3]}' type='#{type}/mpeg'></source>"               if options[:mp3]
-            html << "<source src='#{options[:ogg]}' type='#{type}/ogg; codecs=vorbis'></source>" if options[:ogg]
-            html << "<source src='#{options[:opus]}' type='#{type}/ogg; codecs=opus'></source>"  if options[:opus]
-            html << "<source src='#{options[:webm]}' type='#{type}/webm'></source>"              if options[:webm]
-            html << "</#{type}>"
+module PodloveWebPlayerRails
+  # View Helpers that generate the needed HTML and JS needed for the Web Player
+  module ViewHelpers
+    # Generates the HTML markup needed for the podlove audio player and calls the podlovewebplayer
+    # js method with given option parameters.
+    #
+    # @param [Hash] options options for the player
+    # @option options [String]  :src The location of an audio file, local ore remote.
+    # @option options [String]  :type The media type of the resource.
+    # @option options [String]  :mp4 The location of an audio file with the type mp4.
+    # @option options [String]  :mp3 The location of an audio file with the type mp3.
+    # @option options [String]  :ogg The location of an audio file with the type ogg.
+    # @option options [String]  :opus The location of an audio file with the type opus.
+    # @option options [String]  :poster The location of the cover image for the rich audio player.
+    # @option options [integer] :width (auto) The width of the player.
+    # @option options [integer] :height The height of the player.
+    # @option options [boolean] :loop (false) Loops the audio when it ends.
+    # @option options [boolean] :preload (true) Start loading the audio as soon as possible,
+    #                           before the user clicks play. This might not work on all browsers.
+    # @option options [boolean] :autoplay (false) Start playing the audio as soon as it's ready. 
+    #                           This might not work on all (mobile) devices.
+    # @option options [String]  :duration (false) Enables display of duration without having to load the
+    #                           media file. Use seconds or timecode as a unit 
+    #                           (e.g. "3522" or "00:58:42")
+    # @option options [boolean] :alwaysShowHours (true) Displays the time in 00:00:00 instead of 00:00.
+    # @option options [boolean] :alwaysShowControls (true) Defines whether the player control bar is
+    #                           permanently visible.
+    # @option options [boolean] :volume (true) Disables the volume slider.
+    # @option options [boolean] :progress (true) Disables the progress bar.
+    # @option options [String]  :captions URL to a WebVTT captions file.
+    # @option options [boolean] :chapters Takes chapter string in JSON format and builds an interactive
+    #                           chapter table. Chapters must be written in the following format:
+    #                           !{'start':'00:00:00.000', 'title':'Chapter One', 'image':''}
+    # @option options [String]  :chapterlinks (all) Option for the jumplink behaviour in chapter table.
+    #                           Options are: 'all' (all chapter links are clickable), 'buffered' (only
+    #                           buffered chapters are clickable), 'false' (chapters are not linked)
+    # @option options [boolean] :chaptersVisible (false) Defines the default visibility status of
+    #                           toggable chapters module.
+    # @option options [boolean] :timecontrolsVisible (false) Defines the default visibility status of
+    #                           toggable time controls module.
+    # @option options [boolean] :summaryVisible (false) Defines the default visibility status of
+    #                           toggable summary module.
+    # @option options [boolean] :downloadbuttonsVisible (false) Defines the default visibility of the
+    #                           download buttons.
+    # @return [String] HTML markup and JS call.
+    def podloveaudio(options = {})
+      podlove("audio", options)
+    end
 
-            [:src, :type, :mp4, :mp3, :ogg, :opus, :webm].each{ |key| options.delete(key) }
+    # Generates the HTML markup needed for the podlove video player and calls the podlovewebplayer
+    # js method with given option parameters.
+    #
+    # @param [Hash] options options for the player
+    # @option options [String]  :src This location of an video file, local ore remote.
+    # @option options [String]  :type The media type of the resource.
+    # @option options [String]  :mp4 The location of an audio file with the type mp4.
+    # @option options [String]  :webm The location of an audio file with the type webm.
+    # @option options [String]  :ogg The location of an audio file with the type ogg.
+    # @option options [String]  :poster The location of the poster frame for the video.
+    # @option options [integer] :width (auto) The width of the player.
+    # @option options [integer] :height The height of the player.
+    # @option options [boolean] :loop (false) Loops the video when it ends.
+    # @option options [boolean] :preload (true) Start loading the video as soon as possible,
+    #                           before the user clicks play. This might not work on all browsers.
+    # @option options [boolean] :autoplay (false) Start playing the video as soon as it's ready.
+    #                           This might not work on all (mobile) devices.
+    # @option options [boolean] :fullscreen (true) Disables the fullscreen button for video.
+    # @option options [string]  :duration (false) Enables display of duration without having to load the
+    #                           media file. Use seconds or timecode as a unit
+    #                           (e.g. "3522" or "00:58:42")
+    # @option options [boolean] :alwaysShowHours (true) Displays the time in 00:00:00 instead of 00:00.
+    # @option options [boolean] :alwaysShowControls (true) Defines whether the player control bar is
+    #                           permanently visible. It might be suitable to fade the
+    #                           controls out when not hovering the video.
+    # @option options [boolean] :volume (true) Disables the volume slider.
+    # @option options [boolean] :progress (true) Disables the progress bar.
+    # @option options [String]  :captions URL to a WebVTT captions file.
+    # @option options [boolean] :chapters Takes chapter string in JSON format and builds an interactive
+    #                           chapter table. Chapters must be written in the following format:
+    #                           !{'start':'00:00:00.000', 'title':'Chapter One', 'image':''}
+    # @option options [String]  :chapterlinks (all) Option for the jumplink behaviour in chapter table.
+    #                           Options are: 'all' (all chapter links are clickable), 'buffered' (only
+    #                           buffered chapters are clickable), 'false' (chapters are not linked)
+    # @option options [boolean] :chaptersVisible (false) Defines the default visibility status of
+    #                           toggable chapters module.
+    # @option options [boolean] :timecontrolsVisible (false) Defines the default visibility status of
+    #                           toggable time controls module.
+    # @option options [boolean] :summaryVisible (false) Defines the default visibility status of
+    #                           toggable summary module.
+    # @option options [boolean] :downloadbuttonsVisible (false) Defines the default visibility of the
+    #                           download buttons.
+    # @return [String] HTML markup and JS call.
+    def podlovevideo(options = {})
+      podlove("video", options)
+    end
 
-            script = "$('##{id}').podlovewebplayer(#{options.to_json});"
+    private
 
-            return raw html + "\n" + javascript_tag(script)
-          end
-        end
-      end
+    def podlove(type, options = {})
+      id = "player_" + SecureRandom.hex(5)
+  
+      html = "<#{type} id='#{id}'>"
+      html << "<source src='#{options[:src]}'"\
+              "" + (options[:type] ? " type='#{options[:type]}'" : "") + "></source>"      if options[:src]
+      html << "<source src='#{options[:mp4]}' type='#{type}/mp4'></source>"                if options[:mp4]
+      html << "<source src='#{options[:mp3]}' type='#{type}/mpeg'></source>"               if options[:mp3]
+      html << "<source src='#{options[:ogg]}' type='#{type}/ogg; codecs=vorbis'></source>" if options[:ogg]
+      html << "<source src='#{options[:opus]}' type='#{type}/ogg; codecs=opus'></source>"  if options[:opus]
+      html << "<source src='#{options[:webm]}' type='#{type}/webm'></source>"              if options[:webm]
+      html << "</#{type}>"
+  
+      [:src, :type, :mp4, :mp3, :ogg, :opus, :webm].each{ |key| options.delete(key) }
+  
+      script = "$('##{id}').podlovewebplayer(#{options.to_json});"
+  
+      return raw html + "\n" + javascript_tag(script)
     end
   end
 end

data/podlove-web-player-rails.gemspec

@@ -5,7 +5,7 @@ require 'podlove-web-player-rails/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "podlove-web-player-rails"
-  gem.version       = Podlove::Web::Player::Rails::VERSION
+  gem.version       = PodloveWebPlayerRails::VERSION
   gem.authors       = ["Bastian Bartmann"]
   gem.email         = ["xarfai27@gmail.com"]
   gem.description   = %q{Podlove Web Player for Rails 3.}
@@ -17,7 +17,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "coveralls"
   gem.add_dependency "railties", "~> 3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: podlove-web-player-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,38 +11,6 @@ bindir: bin
 cert_chain: []
 date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +35,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -77,8 +44,6 @@ files:
 - lib/podlove-web-player-rails/version.rb
 - lib/podlove-web-player-rails/view_helpers.rb
 - podlove-web-player-rails.gemspec
-- spec/podlove-web-player-rails/view_helpers_spec.rb
-- spec/spec_helper.rb
 - vendor/assets/fonts/podlovefont.eot
 - vendor/assets/fonts/podlovefont.otf
 - vendor/assets/fonts/podlovefont.pfa
@@ -111,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -423875662606043562
+      hash: 2864029755991511410
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -423875662606043562
+      hash: 2864029755991511410
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -128,6 +93,4 @@ signing_key:
 specification_version: 3
 summary: Integrates the needed javascript and css in the asset pipeline and provides
   a handy helper method to integrate the player in the view.
-test_files:
-- spec/podlove-web-player-rails/view_helpers_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.rspec

@@ -1 +0,0 @@
---color

data/spec/podlove-web-player-rails/view_helpers_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-describe Podlove::Web::Player::Rails::ViewHelpers do
-  
-end

data/spec/spec_helper.rb

@@ -1,6 +0,0 @@
-require 'coveralls'
-Coveralls.wear!
-
-require 'action_controller/railtie'
-require 'rails/test_unit/railtie'
-require 'podlove-web-player-rails'