backbone-soundmanager2-rails 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61c95b2e6aea931960661b5e4b17396e36883ffb
+  data.tar.gz: 8b4e2da9edfa9a82f844b0c9db43ef957a32c668
+SHA512:
+  metadata.gz: 48dc8c9ec157a54c03e9ef6b47cdc10eeda3c0e3dcdb8878e1f914048e078e7752322dcb071a0f9d6c56900956656f3e7fad29ebc3869cb13e5595fe8f7190af
+  data.tar.gz: 8d01b6e6324fcbfc02ed57f0e971f3bc419099b19193307d76ed1295cf2c26d4e1d095d25e6bf9e3740dea4a5bc78996bc690e5057749955d9d84f46d67ae139

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Philipp Bosch
+
+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

@@ -0,0 +1,29 @@
+# Backbone::Soundmanager2::Rails
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'backbone-soundmanager2-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backbone-soundmanager2-rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/backbone-soundmanager2-rails/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/backbone-soundmanager2-rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backbone/soundmanager2/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "backbone-soundmanager2-rails"
+  spec.version       = Backbone::Soundmanager2::Rails::VERSION
+  spec.authors       = ["Philipp Bosch"]
+  spec.email         = ["hello@pb.io"]
+  spec.summary       = "backbone.soundmanager2 for Rails"
+  spec.description   = "backbone.soundmanager2 packaged as a gem for use in Rails' asset pipeline"
+  spec.homepage      = "https://github.com/philippbosch/backbone-soundmanager2-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "railties", ">= 3.0", "< 5.0"
+end

data/lib/backbone/soundmanager2/rails/version.rb

@@ -0,0 +1,7 @@
+module Backbone
+  module Soundmanager2
+    module Rails
+      VERSION = "0.1.2"
+    end
+  end
+end

data/lib/backbone/soundmanager2/rails.rb

@@ -0,0 +1,10 @@
+require "backbone/soundmanager2/rails/version"
+
+module Backbone
+  module Soundmanager2
+    module Rails
+        class Engine < ::Rails::Engine
+        end
+      end
+  end
+end

data/vendor/assets/javascripts/backbone.soundmanager2.coffee

@@ -0,0 +1,325 @@
+if require?
+  Backbone = require "backbone"
+else
+  Backbone = window.Backbone
+
+# A player model for use with SoundManager2 API.  Requires soundmanager2 (duh).
+
+class BackboneSoundManager2
+
+  _.extend this.prototype, Backbone.Events
+
+  # Create a new Player instance. There will probably only ever be one
+  # of these in the app. If `options.bus` is provided, rebroadcast all events
+  # to it with a `player:` prefix.  Can also accept an 'autoPlay' option if
+  # you want the sound to start playing automatically on load.
+  #
+  # Also rebroadcast messages on the playable, if possible.
+  #
+  # Examples
+  #
+  #   track = new Track()
+  #   track.on "player:heyo", myFunction
+  #
+  #   player = new Player()
+  #   player.playable = track
+  #   player.trigger "heyo"
+  #    # => Will execute track.myFunction()
+  #
+  # Returns self.
+
+  constructor: (options = {}) ->
+    @options = options
+
+    if @options.bus?
+      @on "all", (event, args...) ->
+        @options.bus.trigger "player:#{event}", args...
+
+    @on "all", (event, args...) ->
+      return unless @playable?.trigger?
+
+      @playable.trigger "player:#{event}", args...
+  
+    this
+
+
+  # Release the current sound, clear the current playable, and trigger
+  # a `released` event.
+  #
+  # Examples
+  #
+  #   App.player.release() # => Playable is removed from player.
+  #
+  # Returns newly changed self.
+
+  release: ->
+    if @sound
+      @fadeout =>
+        @sound.destruct()
+
+    @sound = null
+
+    @trigger "releasing"
+
+    @playable.release() if @playable?.release?
+    @playable = null
+
+    @trigger "released"
+
+    this
+
+  # Fade out the current sound's volume to 0 and run any callbacks.
+  #
+  # Examples
+  #
+  #   player.fadeout() # => volume smoothly goes to zero.
+  #
+  # Returns self
+
+  fadeout: (callback) ->
+
+    # Fade out started causing issues when the track sharing went in.
+    # Removing this ability for now until we can circle back.
+
+    callback()
+    this
+
+    # Original fade out. Can't get here now.
+
+    s = @sound
+    vol = @volume * 100
+
+    fnc = =>
+      vol -= 2
+      s.setVolume vol
+      if vol > 0
+        _.delay fnc, 10
+      else
+        callback()
+
+    fnc()
+
+    this
+
+
+  # Determine if the state of the player is `paused`, or `playing`.
+  #
+  # Examples
+  #
+  #   player.toggle track
+  #   player.getState() # => "playing"
+  #
+  # Returns String indicating `paused` or `playing` state.
+  # Returns null if nothing is currently playing.
+
+  getState: ->
+    return unless @playable?
+
+    return "loading" unless @sound?
+
+    return "stopped" if @sound.playState == 0
+
+    if @sound.paused then "paused" else "playing"
+
+
+  # Determine if current playable is equal to playable passed in.
+  #
+  # Examples
+  #
+  #   player.load track
+  #   player.isAlreadyPlaying track # => true
+  #
+  # Returns boolean.
+
+  isAlreadyPlaying: (playable) ->
+    @playable? and @playable.id == playable.id
+
+
+  # Determine if a sound has already been already loaded.
+  #
+  # Examples
+  #
+  #   player.load track
+  #   player.hasSoundLoaded() # => true
+  #
+  # Returns boolean.
+
+  hasSoundLoaded: ->
+    @sound?
+
+
+  # Test if a `playable` has getAudioURL() method.
+  #
+  # playable - A model that fulfills the contract of having getAudioURL()
+  #
+  # Examples
+  #
+  #   track = new Track();
+  #   track.isPlayable() # => true
+  #
+  # Returns boolean.
+
+  isPlayable: (playable) ->
+    playable.id? and playable.getAudioURL?
+
+
+  ok: ->
+    soundManager.ok()
+
+  # Load a `playable` and create an SM2 sound instance (@sound) to represent it.
+  # Triggers `loading` and `loaded` events.  Will also automatically play
+  # it's `playable` model.
+  #
+  # playable - A model that fulfills the contract of having getAudioURL()
+  #
+  # Examples
+  #
+  #   track = new Track();
+  #   player.load track
+
+  load: (playable) ->
+    # No need to load the same playable track
+    return if playable is @playable
+
+    unless soundManager.ok()
+      return @trigger "error", "SoundManager2 isn't ready."
+
+    unless @isPlayable playable
+      return @trigger "error",
+        "Playable doesn't satisfy the contract.", playable
+
+    @release()
+
+    @playable = playable
+    @playable.retain() if @playable.retain?
+
+    @trigger "loading"
+
+    playable.getAudioURL (url) =>
+      # It may happen that the playable has
+      # changed while fetching url..
+      return unless @playable == playable
+
+      @sound = soundManager.createSound
+        autoPlay     : false # Trick: we want the "played" event
+                             # to be emitted after the "loaded"
+                             # event, so we call `@sound.play()`
+                             # manually below..
+        id           : playable.id
+        url          : url
+        volume       : Math.round @volume*100
+        onfinish     : => @trigger "finished",    @sound
+        onplay       : => @trigger "played",      @sound
+        onpause      : => @trigger "paused",      @sound
+        onresume     : => @trigger "resumed",     @sound
+        onstop       : => @trigger "stopped",     @sound
+        whileplaying : => @trigger "playing",     @sound
+        whileloading : => @trigger "bytesLoaded", @sound
+
+      @trigger "loaded", @sound
+
+      @sound.play() if @options.autoPlay is true
+
+  # Initial volume
+
+  volume: 1
+
+  # Set sound to be a particular volume, accepts values
+  # between 0. and 1.
+  #
+  # volume - a float between 0 and 1.
+  #
+  # Examples
+  #
+  #   player.sound.volume # => 80
+  #   player.setVolume 1
+  #   player.sound.volume # => 100
+  #
+  # Returns SoundManager2 sound.
+
+  setVolume: (volume) ->
+    return unless @sound?
+    return if volume > 1 || volume < 0
+
+    @volume = volume
+    @sound.setVolume Math.round(@volume * 100)
+    @sound
+
+
+
+  # Move to a specific position in the current sound. `position` is a
+  # percentage, expressed as a number between 0 and 1.
+  #
+  # position - a float between 0 and 1.
+  #
+  # Examples
+  #
+  #   # for a track with a duration of 5000 milliseconds
+  #   player.sound.position # => 1000
+  #   player.setPosition 0.5
+  #   player.sound.position # => 2500
+  #
+  # Returns SoundManager2 sound.
+
+  setPosition: (position) ->
+    return unless @sound?
+    return if @sound.bytesLoaded / @sound.bytesTotal < position
+    @sound.setPosition position * @sound.durationEstimate
+    @sound
+
+  # Move to a position relative to current position, in milliseconds
+  #
+  # position - a integer..
+  #
+  # Examples
+  #
+  #   # For a track with a duration of 5000 milliseconds
+  #   player.sound.position # => 1000
+  #   player.setRelativePosition -500
+  #   player.sound.position # => 500
+
+  setRelativePosition: (position) ->
+    return unless @sound?
+
+    @sound.setPosition @sound.position + position
+
+
+  # Toggle play/pause for the current sound or load a new `playable`.
+  #
+  # playable - A model that fulfills the contract of having getAudioURL()
+  #
+  # Examples
+  #
+  #   player.toggle track # => track will load and start playing
+
+  toggle: (playable = @playable) ->
+    if @sound? and @isAlreadyPlaying playable
+      @sound.togglePause()
+    else if playable?
+      @stop()
+      @load playable
+
+
+  # Stop for the current sound.
+  #
+  # Examples
+  #
+  #   player.stop() # => track will stop completely
+
+  stop: ->
+    return unless @sound?
+    @sound.stop()
+
+  pause: ->
+    return unless @sound
+    @fadeout =>
+      @sound.pause()
+      @sound.setVolume 100
+
+# If we are in Node environment — export our constructor function in a module,
+# else — add it to Backbone object as a property
+
+if module? and module.exports?
+  module.exports = BackboneSoundManager2
+else
+  Backbone.SoundManager2 = BackboneSoundManager2

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: backbone-soundmanager2-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Philipp Bosch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: backbone.soundmanager2 packaged as a gem for use in Rails' asset pipeline
+email:
+- hello@pb.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backbone-soundmanager2-rails.gemspec
+- lib/backbone/soundmanager2/rails.rb
+- lib/backbone/soundmanager2/rails/version.rb
+- vendor/assets/javascripts/backbone.soundmanager2.coffee
+homepage: https://github.com/philippbosch/backbone-soundmanager2-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: backbone.soundmanager2 for Rails
+test_files: []