netshade-oembed_links 0.0.4 → 0.0.5

data/lib/oembed_links.rb

@@ -48,6 +48,10 @@ require 'oembed_links/response'
 #    r.from?(:youtube) { |vid| vid["html"] }
 #  end
 #
+#  OEmbed.transform("Some more text from http://en.wikipedia.com/wiki/Dinosaurs!") do |r, url|
+#    r.from?(:wikipedia, :template => "links/wiki_links")
+#  end 
+#
 #  See the OEmbed.transform function for more details.
 #
 #
@@ -225,9 +229,9 @@ class OEmbed
   #   OEmbed.transform(some_string) do |r, url|
   #     r.from?(:provider_name) { |content| content["html"] }
   #     r.matches?(/some_regex_against_the_url/) { |content| content["title"] }
-  #     r.video? { |video| content["html"] }
+  #     r.video?(:template => "videos/oembed_link")
   #     r.audio? { |audio| content["html"] }
-  #     r.hedgehog? { |hog| content["title"] }
+  #     r.hedgehog?(:template => File.join(File.dirname(__FILE__), "templates", "hedgehogs.haml"))
   #     r.photo? { |photo| "<img src='#{photo["url"]}' title='#{photo['title']} />" }
   #     r.any? { |anythingelse| content["title"] }
   #   end
@@ -248,6 +252,19 @@ class OEmbed
   # The value passed to these conditional blocks is a hash representing the data returned
   # by the server.  The keys of all the attributes will be strings.
   #
+  # If you specify the :template option, a template will be found for you based on your current engironment.
+  # Currently there is support for Haml, Erubis and ERB templates.  Each template will have the following
+  # local variables available to it:
+  #
+  #  url      : The URL for which OEmbed data exists
+  #  data     : A hash of the actual OEmbed data for that URL
+  #  response : The OEmbed::Response object for the URL
+  #
+  #
+  # If you are using Rails, you may specify your template relative to your application's
+  # view root (eg "photos/flickr_oembed"), and your template will be found based on your application settings.
+  # For more options regarding template support, see the documentation for OEmbed::TemplateResolver.
+  #
   # NOTE: The type equivalent blocks (.video?, .audio?, .hedgehog?, .photo?, etc.) perform
   # an equality test between the method name and the type returned by the OEmbed provider.
   # You may specify any type name you wish as the method name, and its type will be checked

data/lib/oembed_links/response.rb

@@ -1,5 +1,6 @@
 # The class used to represent data returned by the server.
 #
+require 'oembed_links/template_resolver'
 class OEmbed
   class Response
 
@@ -23,22 +24,22 @@ class OEmbed
 
     # Test if this response has been returned from
     # the given provider_name.
-    def from?(provider_name, &block)
+    def from?(provider_name, *args, &block)
       if @provider.to_s === provider_name.to_s
         if can_render_type?(:provider)
           @rendered_via_provider = true
-          return render_content(&block)
+          return render_content(*args, &block)
         end
       end
     end
 
     # Test if this response came from a URL
     # that matches the given regex.
-    def matches?(regex, &block)
+    def matches?(regex, *args, &block)
       if @url =~ regex
         if can_render_type?(:regex)
           @rendered_via_regex = true
-          render_content(&block)
+          render_content(*args, &block)
         end
       end
     end
@@ -46,9 +47,9 @@ class OEmbed
     # Lowest priority renderer, which will execute
     # a block regardless of conditions so long as
     # no content has yet been rendered for this response.
-    def any?(&block)
+    def any?(*args, &block)
       if can_render_type?
-        return render_content(&block)
+        return render_content(*args, &block)
       end      
     end
 
@@ -63,7 +64,7 @@ class OEmbed
         if @response["type"] == ts
           if can_render_type?(:type)
             @rendered_via_type = true
-            return render_content(&block)
+            return render_content(*args, &block)
           end
         end
       else
@@ -90,8 +91,11 @@ class OEmbed
       !@rendered.nil?
     end
     
-    def render_content(&block)
-      if block_given?
+    def render_content(*args, &block)
+      options = (args.last.is_a?(Hash)) ? args.last : { }
+      if options[:template]
+        @rendered = TemplateResolver.eval_template_for_path(options[:template], @url, @response, self)
+      elsif block_given?
         @rendered = yield(@response)
       else
         @rendered = self.to_s

data/oembed_links.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name       = "oembed_links"
-    s.version    = "0.0.4"
+    s.version    = "0.0.5"
     s.author     = "Indianapolis Star"
     s.email      = "bugs at indystar dot com"
     s.homepage   = "http://www.indystar.com"

data/spec/oembed_links_spec.rb

@@ -74,6 +74,8 @@ describe OEmbed, "transforming functions" do
      "type" => "video"
     }.to_json)
     OEmbed.register_yaml_file(File.join(File.dirname(__FILE__), "oembed_links_test.yml"))
+    @current_path = File.dirname(__FILE__)
+    @template_path = File.join(@current_path, "templates")
   end
 
   it "should always give priority to provider conditional blocks" do
@@ -121,8 +123,124 @@ describe OEmbed, "transforming functions" do
       r.matches?(/baz/) { |m| "regex" }
     end.should == "foo" 
   end
+
+  it "should allow templates to be used to process the output" do
+    url_provides({
+     "url" => "template!"
+                 }.to_json)
+    
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => File.join(@template_path, "test.rhtml"))
+    end.should == "template! rhtml"
+  end
+
+
+  it "should allow a template root to be set programmatically to process the output" do
+    url_provides({
+                   "url" => "template!"
+                 }.to_json)
+    OEmbed::TemplateResolver.template_root = @template_path
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "test.html.erb")
+    end.should == "template! erb\n"
+  end
+
+  it "should allow for selection of different template renderers" do
+    url_provides({
+                   "url" => "template!"
+                 }.to_json)
+    defined?(Erubis).should_not == true
+    defined?(Haml).should_not == true
+    OEmbed::TemplateResolver.template_root = @template_path    
+    OEmbed::TemplateResolver.template_processor = :erubis
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "test.html.erb")
+    end.should == "template! erb\n"    
+    defined?(Erubis).should == "constant"
+    OEmbed::TemplateResolver.template_processor = :haml
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "test.haml")
+    end.should == "template! haml\n"
+    defined?(Haml).should == "constant"
+  end
+
+  it "should throw an exception if a path to a template specified does not exist" do
+    url_provides({
+                   "url" => "template!"
+                 }.to_json)
+    lambda { OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "does.not.exist")
+      end }.should raise_error
+  end
   
   
 end
 
 
+describe OEmbed, "Rails template resolving functions" do
+  include SpecHelper
+  before(:each) do
+    OEmbed.clear_registrations
+    clear_urls
+    url_provides({
+     "html" => "foo",
+                   "type" => "video",
+                   "url" => "rails"
+    }.to_json)
+    OEmbed.register_yaml_file(File.join(File.dirname(__FILE__), "oembed_links_test.yml"))
+    OEmbed::TemplateResolver.template_processor = nil
+    @current_path = File.dirname(__FILE__)
+    @template_path = File.join(@current_path, "templates")
+
+    class ::ActionView
+      class Template
+        @@template_handlers = { }
+
+        def self.support_haml!
+          @@template_handlers = {"haml" => "nothing"}
+        end
+
+        def self.do_not_support_haml!
+          @@template_handlers = { }
+        end
+        
+      end
+    end
+
+    class ::ApplicationController
+      def self.view_paths
+        [File.dirname(__FILE__)]
+      end
+    end
+    
+  end
+
+  it "should support Rails-like template paths for template selection" do
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "templates/test")
+    end.should == "rails erb\n"
+  end
+
+  it "should support Rails-like template paths with extension specified" do
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "templates/test.rhtml")
+    end.should == "rails rhtml"
+  end
+
+  it "should allow haml support in the Rails app" do
+    ActionView::Template.support_haml!
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "templates/test")
+    end.should == "rails haml\n"
+    ActionView::Template.do_not_support_haml!
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "templates/test")
+    end.should == "rails erb\n"    
+  end
+  
+end
+
+
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netshade-oembed_links
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Indianapolis Star