embeddable 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18f2ab466c6cadbd615d9773926ea34341000a99
-  data.tar.gz: 9d213d00bafe3d515137494967076727b85236c6
+  metadata.gz: 729da179e882d3556c3e2d47fab535508ddc72a8
+  data.tar.gz: 923d598b514adbe8b52d0e49594d618b579729ef
 SHA512:
-  metadata.gz: 78354feb478b54c646977720ec78feb9090afc5b0aac146a619c753bf526c6770f693a93442899506dcf6a9d53810c3566ede6ed82ab5a1b7427d9aee5f83fe6
-  data.tar.gz: 6da0f5c692782ad05a7c7e55dd0795b5f410401f913aace349d2f77380293ff0da9fa6c1dbdabaddfadb162305e811ea4576c79256b944478a57fd1ef89c0e42
+  metadata.gz: d80487840799dfe6dd9b005398769137777a70e18da8dc0e98e5be2af1ebbf004fac05f2c03b7632fc031a6358a0b2949c13bd8ac349ab0734e20845e5fbd938
+  data.tar.gz: c536bdf7cd58acbca954f75db6eb025da177160c1036f2cb5d39db8630eab44fab82e298d62875b045c5d2112c51d8f6408c5af34db9926cb171297c8388adb3

data/README.md

@@ -39,7 +39,38 @@ post.video_on_youtube? # => true
 post.video_id          # => 'bEvNRmPzq9s'
 ```
 
-### Brightcove
+### Views
+You can use a simple view helper to render the respective video players. `embed_video(embeddable, width, height)`
+
+```erb
+<div class="video-wrapper">
+  <%= embed_video(embeddable, '100%', '100%') %>
+</div>
+```
+
+#### Multiple embeddables in one model
+If you have multiple columns using embeddable in one model, you will need to specify which one you want to embed unless it's the first one specified in the model. Add an extra parameter to the view helper: `embed_video(embeddable, width, height, name: :your_embeddable_name)`.
+
+If you have this in your model:
+```ruby
+embeddable :video, from: :video_url
+embeddable :another_video, from: :another_url
+```
+
+And you want to embed `:another_video` - you will use the helper like this:
+```erb
+<%= embed_video(embeddable, '100%', '100%', name: :another_video) %>
+```
+
+#### Overriding
+The view helper uses partials to render the embed snippets for all of the video players. You can override them by creating a partial here: `app/views/embeddable/`. The file should be named after the player. See example below.
+
+```erb
+<!-- app/views/embeddable/partials/_youtube.html.erb -->
+<iframe width="<%= width %>" height="<%= height %>" src="//www.youtube.com/embed/<%= id %>" frameborder="0" allowfullscreen webkitallowfullscreen mozillowfullscreen></iframe>
+```
+
+#### Brightcove
 If you want to support brightcove, you'll need to add
 your own brightcove player by overriding the brightcove partial.
 

data/embeddable.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
 end

data/lib/embeddable.rb

@@ -31,7 +31,13 @@ module Embeddable
     ]
   }
 
+  included do
+    @embeddables = []
+  end
+
   module ClassMethods
+    attr_reader :embeddables
+
     def embeddable(name, options = {})
       source = options.fetch :from
 
@@ -53,6 +59,10 @@ module Embeddable
         end.flatten.compact.first
       end
 
+      define_method "#{name}?" do
+        send("#{name}_id") ? true : false
+      end
+
       SERVICES.each do |service, pattern|
 
         define_method "#{name}_on_#{service}?" do
@@ -60,6 +70,12 @@ module Embeddable
         end
 
       end
+
+      define_method "#{name}_source" do
+        source
+      end
+
+      @embeddables << name
     end
   end
 end

data/lib/embeddable/railtie.rb

@@ -3,7 +3,7 @@ require 'embeddable/view_helpers'
 module Embeddable
   class Railtie < Rails::Railtie
     initializer "embeddable.view_helpers" do
-      ActionView::Base.send :include, ViewHelpers
+      ActionView::Base.send :include, Embeddable::ViewHelpers
     end
 
     initializer 'embeddable.add_view_paths', :after => :add_view_paths do |app|

data/lib/embeddable/version.rb

@@ -1,3 +1,3 @@
 module Embeddable
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/embeddable/view_helpers.rb

@@ -1,24 +1,32 @@
-module ViewHelpers
-  def embed_video(embeddable, width, height)
-    attributes = { id: embeddable.video_id, width: width, height: height }
+module Embeddable::ViewHelpers
+  def embed_video(embeddable, width, height, options = {})
+    if options[:name] && !embeddable.respond_to?("#{options[:name]}_id")
+      raise "Can't find embeddable name. Did you mean: \"#{embeddable.class.embeddables.last.inspect}\"?"
+    end
+    name = options[:name] || embeddable.class.embeddables.first
+    source = embeddable.send("#{name}_source")
+    render_embeddable_partial(embeddable, name, source, width, height)
+  end
 
-    if embeddable.video_on_youtube?
+  def render_embeddable_partial(embeddable, name, source, width, height)
+    attributes = { id: embeddable.send("#{name}_id"), width: width, height: height }
+    if embeddable.send("#{name}_on_youtube?")
       render 'embeddable/partials/youtube', attributes
-    elsif embeddable.video_on_vimeo?
+    elsif embeddable.send("#{name}_on_vimeo?")
       render 'embeddable/partials/vimeo', attributes
-    elsif embeddable.video_on_dailymotion?
+    elsif embeddable.send("#{name}_on_dailymotion?")
       render 'embeddable/partials/dailymotion', attributes
-    elsif embeddable.video_on_veoh?
+    elsif embeddable.send("#{name}_on_veoh?")
       render 'embeddable/partials/veoh', attributes
-    elsif embeddable.video_on_vippy?
+    elsif embeddable.send("#{name}_on_vippy?")
       render 'embeddable/partials/vippy', attributes
-    elsif embeddable.video_on_liveleak?
+    elsif embeddable.send("#{name}_on_liveleak?")
       # not supported
-      link_to embeddable.url, embeddable.url
-    elsif embeddable.video_on_brightcove?
+      link_to embeddable.send(source), embeddable.send(source)
+    elsif embeddable.send("#{name}_on_brightcove?")
       render 'embeddable/partials/brightcove', attributes
     else
-      link_to embeddable.url, embeddable.url
+      link_to embeddable.send(source), embeddable.send(source)
     end
   end
 end

data/spec/lib/embeddable/view_helpers_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'embeddable/view_helpers'
+
+describe Embeddable::ViewHelpers do
+  subject { Dummy.new }
+
+  class HelperDummy
+    include Embeddable::ViewHelpers
+
+    def link_to(*args)
+      true
+    end
+  end
+
+  before do
+    @helper = HelperDummy.new
+  end
+
+  describe 'embed_video' do
+    context 'specifying embeddable name' do
+      it 'should use the name provided' do
+        expect(@helper).to receive(:link_to)
+        @helper.embed_video(subject, '100%', '100%', name: :super_video)
+      end
+
+      it 'should raise error if the provided name is wrong' do
+        expect do
+          @helper.embed_video(subject, '100%', '100%', name: :wrong_name)
+        end.to raise_error
+      end
+    end
+
+    context 'not specifying embeddable name' do
+      it 'should choose the first embeddable name' do
+        expect(@helper).to receive(:render_embeddable_partial).
+          with(subject, :video, :video_url, '100%', '100%')
+        @helper.embed_video(subject, '100%', '100%')
+      end
+    end
+  end
+end

data/spec/lib/embeddable_spec.rb

@@ -7,8 +7,9 @@ describe Embeddable do
     include Embeddable
 
     embeddable :video, from: :video_url
+    embeddable :super_video, from: :another_url
 
-    attr_accessor :video_url
+    attr_accessor :video_url, :another_url
   end
 
   describe '.embeddable' do
@@ -19,10 +20,26 @@ describe Embeddable do
     end
   end
 
+  describe 'predicate' do
+    context ':video_url is a supported url' do
+      it 'should be true' do
+        subject.video_url = 'http://youtube.com/watch?v=1&feature=foo'
+        expect(subject.video?).to be_truthy
+      end
+    end
+
+    context ':video_url is an unsupported url' do
+      it 'should be false' do
+        subject.video_url = 'http://foo.bar'
+        expect(subject.video?).to be_falsey
+      end
+    end
+  end
+
   describe 'Liveleak' do
     context 'with http://liveleak.com/...' do
-      before { 
-        subject.video_url = 'http://www.liveleak.com/view?i=290_1392029603' 
+      before {
+        subject.video_url = 'http://www.liveleak.com/view?i=290_1392029603'
       }
 
       its(:video_type) { should eq :liveleak }
@@ -32,8 +49,8 @@ describe Embeddable do
 
   describe 'Dailymotion' do
     context 'with http://dailymotion.com/video/<id>...' do
-      before { 
-        subject.video_url = 'http://www.dailymotion.com/video/xu4q8m' 
+      before {
+        subject.video_url = 'http://www.dailymotion.com/video/xu4q8m'
       }
 
       its(:video_type) { should eq :dailymotion }
@@ -41,8 +58,8 @@ describe Embeddable do
     end
 
     context 'with http://dailymotion.com/video/<id>_<blargablarga>...' do
-      before { 
-        subject.video_url = 'http://www.dailymotion.com/video/xu4q8m_apprendre-le-deltaplane-a-millau-hang-gliding-in-france-creative-motion_sport' 
+      before {
+        subject.video_url = 'http://www.dailymotion.com/video/xu4q8m_apprendre-le-deltaplane-a-millau-hang-gliding-in-france-creative-motion_sport'
       }
 
       its(:video_type) { should eq :dailymotion }
@@ -52,8 +69,8 @@ describe Embeddable do
 
   describe 'Veoh' do
     context 'with http://veoh.com/watch/<id>...' do
-      before { 
-        subject.video_url = 'http://www.veoh.com/watch/v36298453QmtnSAza' 
+      before {
+        subject.video_url = 'http://www.veoh.com/watch/v36298453QmtnSAza'
       }
 
       its(:video_type) { should eq :veoh }
@@ -61,8 +78,8 @@ describe Embeddable do
     end
 
     context 'with http://veoh.com/watch/<id>/<blargablarga>...' do
-      before { 
-        subject.video_url = 'http://www.veoh.com/watch/v36298453QmtnSAza/CBS-SciTech-News' 
+      before {
+        subject.video_url = 'http://www.veoh.com/watch/v36298453QmtnSAza/CBS-SciTech-News'
       }
 
       its(:video_type) { should eq :veoh }
@@ -81,7 +98,7 @@ describe Embeddable do
 
   describe 'Vippy' do
     context 'with http://liveleak.com/...' do
-      before { 
+      before {
         subject.video_url = <<SUCH_EMBED_CODE
 <!-- Start Vippy video -->
 <div itemscope itemtype="http://schema.org/VideoObject" class="vippy-video" style="width: 640px; height: 360px; position: relative;">
@@ -181,6 +198,24 @@ SUCH_EMBED_CODE
 
   end
 
+  describe '.video_source' do
+    it 'should return the source of video' do
+      expect(subject.video_source).to eql(:video_url)
+    end
+  end
+
+  describe '.super_video_source' do
+    it 'should return the source of super_video' do
+      expect(subject.super_video_source).to eql(:another_url)
+    end
+  end
+
+  context 'multiple embeddable columns' do
+    it 'should store an array of names on the class' do
+      expect(Dummy.embeddables).to eql([:video, :super_video])
+    end
+  end
+
   describe 'unsupported scenarios' do
 
     context 'unknown service' do

data/spec/spec_helper.rb

@@ -1 +1,2 @@
 require 'embeddable'
+require 'rspec/its'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embeddable
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Johannes Gorset
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -55,6 +55,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -86,6 +100,7 @@ files:
 - lib/embeddable/railtie.rb
 - lib/embeddable/version.rb
 - lib/embeddable/view_helpers.rb
+- spec/lib/embeddable/view_helpers_spec.rb
 - spec/lib/embeddable_spec.rb
 - spec/spec_helper.rb
 - views/embeddable/partials/_brightcove.html.erb
@@ -119,5 +134,6 @@ signing_key:
 specification_version: 4
 summary: Embeddable makes it easier to embed videos.
 test_files:
+- spec/lib/embeddable/view_helpers_spec.rb
 - spec/lib/embeddable_spec.rb
 - spec/spec_helper.rb