georgedrummond_sinatra_helpers 0.0.7 → 0.0.8

data/lib/georgedrummond_sinatra_helpers.rb

@@ -1,5 +1,6 @@
 require "georgedrummond_sinatra_helpers/version"
 require "digest/md5"
+require "uri"
 
 module GeorgeDrummond
   module Sinatra
@@ -8,17 +9,24 @@ module GeorgeDrummond
       #
       # ==== Examples
       #
-      # With only an email address provided
+      # With only an email address provided:
       #
       #   mail_to("georgedrummond@gmail.com")
       #     # => <a href="mailto:georgedrummond@gmail.com" class="mailto">georgedrummond@gmail.com</a>
       #
-      # With an optional text field provided
+      # With an optional text field provided:
       #
       #   mail_to("georgedrummond@gmail.com", "George Drummond")
       #     # => <a href="mailto:georgedrummond@gmail.com" class="mailto">George Drummond</a>
-      def mail_to(email, text=email)
-        "<a href=\"mailto:#{email}\" class=\"mailto\">#{text}</a>"
+      #
+      # With an options hash:
+      #
+      #   mail_to("georgedrummond@gmail.com", "George Drummond", :class => :email, :title => "How do you do")
+      #     # => <a href="mailto:georgedrummond@gmail.com" class="email" title="How do you do">George Drummond</a>
+      #
+      def mail_to(email, text=email, opts={})
+        options = {:class => :mailto}.merge(opts)
+        link_to text, "mailto:#{email}", options, false
       end
       
       # Creates the gravatar (www.gravatar.com) html from the email address and arguments provided.
@@ -26,93 +34,170 @@ module GeorgeDrummond
       #
       # ==== Examples
       #
-      # With no size specified
+      # With no size specified:
       #
       #   gravatar_image("georgedrummond@gmail.com")
       #     # => <img src="http://www.gravatar.com/avatar/d278a12b969a495ab16fdd942e748fe5?s=50" class="gravatar" />
       #
-      # With a size specified
+      # With a size specified:
       #
       #   gravatar_image("georgedrummond@gmail.com", 150)
       #     # => <img src="http://www.gravatar.com/avatar/d278a12b969a495ab16fdd942e748fe5?s=150" class="gravatar" />
-      def gravatar_image(email, size=50)
+      #
+      # With options:
+      #
+      #   gravatar_image("georgedrummond@gmail.com", 150, :class => :icon)
+      #     # =>  <img src="http://www.gravatar.com/avatar/d278a12b969a495ab16fdd942e748fe5?s=150" class="icon" />
+      #
+      def gravatar_image(email, size=50, opts={})
         hash = Digest::MD5.hexdigest(email)
-        "<img src=\"http://www.gravatar.com/avatar/#{hash}?s=#{size}\" class=\"gravatar\" />"
+        url = "http://www.gravatar.com/avatar/#{hash}?s=#{size}"
+        image_tag url, {:class => :gravatar}.merge(opts)
       end
       
       # Creates html tags for stylesheets from the arguements provided. Dont include the <tt>.css</tt> extension as this
       # will be automatically appended. You can specify one or multiple css files at once. Place your css files in
-      # the <tt>public/css</tt> folder of your app.
+      # the <tt>public/css</tt> folder of your app. URLs will link to external files
       #
       # ==== Examples
       #
-      # With only one CSS file
+      # With only one CSS file:
       # 
       #   stylesheet_link_tag :app
       #    # => <link href="/css/app.css" type="text/css" rel="stylesheet" />
       #
-      # With an array of CSS files we want to show
+      # With an array of CSS files we want to show:
       #
       #    stylesheet_link_tag :app, :header # =>
       #      <link href="/css/app.css" type="text/css" rel="stylesheet" />
       #      <link href="/css/header.css" type="text/css" rel="stylesheet" />
+      #
+      # With an external stylesheet:
+      #
+      #   stylesheet_link_tag :app, "http://accountsapp.com/styles/common.css"
+      #     <link href="/css/app.css" type="text/css" rel="stylesheet" />
+      #     <link href="http://accountsapp.com/styles/common.css" type="text/css" rel="stylesheet" />
+      #
       def stylesheet_link_tag(*sources)
         html = []
         sources.each do |stylesheet|
-          path = "/css/#{stylesheet}.css"
-          html << "<link href=\"#{ url(path) }\" type=\"text/css\" rel=\"stylesheet\" />"
+          if is_uri?(stylesheet)
+            path = stylesheet
+          else
+            path = url("/css/#{stylesheet}.css")
+          end
+          html << "<link href=\"#{path}\" type=\"text/css\" rel=\"stylesheet\" />"
         end
         return html.join("\n")
       end
       
       # Creates html tags for javascript includes from the arguments provided. Dont include the <tt>.js</tt> extension as this
       # will be automatically appended. You can specify one or multiple javascript files at once. Place your javascript files in
-      # the <tt>public/js</tt> folder of your app.
+      # the <tt>public/js</tt> folder of your app. URLs will link to external files
       #
       # ==== Examples
       #
       # With only one javascript file
       #
-      #    javascript_include_tag :app
-      #    # => <script type="text/javascript" src="/js/app.js"></script>
+      #   javascript_include_tag :app
+      #     # => <script type="text/javascript" src="/js/app.js"></script>
+      #
+      # With an array of javascript files we want to show:
+      #
+      #   javascript_include_tag :jquery, :app # =>
+      #     <script type="text/javascript" src="/js/jquery.js"></script>
+      #     <script type="text/javascript" src="/js/app.js"></script>
       #
-      # With an array of javascript files we want to show
+      # With an external stylesheet:
       #
-      #    javascript_include_tag :jquery, :app # =>
-      #      <script type="text/javascript" src="/js/jquery.js"></script>
-      #      <script type="text/javascript" src="/js/app.js"></script>
+      #   javascript_include_tag :jquery, "http://accountsapp.com/js/app.js"
+      #     <script type="text/javascript" src="/js/jquery.js"></script>
+      #     <script type="text/javascript" src="http://accountsapp.com/js/app.js"></script>
+      #    
       def javascript_include_tag(*sources)
         html = []
         sources.each do |javascript|
-          path = "/js/#{javascript}.js"
-          html << "<script type=\"text/javascript\" src=\"#{ url(path) }\"></script>"
+          if is_uri?(javascript)
+            path = javascript
+          else
+            path = url("/js/#{javascript}.js")
+          end
+          html << "<script type=\"text/javascript\" src=\"#{path}\"></script>"
         end
         return html.join("\n")
       end
       
-      # Creates a html image tag given a file name. File should be located in <tt>public/images</tt>. Will not work with external
-      # files for now however I may add this at a later date if it is needed.
+      # Creates a html image tag given a file name. File should be located in <tt>public/images</tt>.
       #
       # ==== Examples
       #
-      #    image_tag "home.png"
-      #    # => <img src="/images/home.png" />
-      def image_tag(image)
-        path = "/images/#{image}"
-        return "<img src=\"#{url(path)}\" />\n"
+      # With a local image:
+      #
+      #   image_tag "home.png"
+      #     # => <img src="/images/home.png" />
+      #
+      # With options:
+      #
+      #   image_tag "home.png", :title => "home", :class => :icon
+      #     # => <img src="/images/home.png" title="home" class="icon" />
+      #
+      # With a remote image:
+      #
+      #   image_tag "http://accountsapp.com/logo.png", :title => "Online Accounting Software"
+      #     # => <img src="http://accountsapp.com/logo.png" title="Online Accounting Software" />
+      #
+      def image_tag(image, opts={})
+        if is_uri?(image)
+          path = image
+        else
+          path = url("/images/#{image}")
+        end
+        return "<img src=\"#{path}\"#{parse_options(opts)} />"
       end
     
-      # Creates a html link tag given a page <tt>title</tt> and resource <tt>path</tt>. Works similar to the Rails link_to method
-      # however does not accept any other options.
+      # Creates a html link tag given a page <tt>title</tt> and resource <tt>path</tt>.
       #
       # ==== Examples
       #
-      #    link_to "Home", "/"
-      #    # => <a href="/">Home</a>
-      def link_to(title, path)
-        return "<a href=\"#{url(path)}\">#{title}</a>"
+      # With an internal link
+      #
+      #   link_to "Home", "/home"
+      #     # => <a href="/home">Home</a>
+      #
+      # With options:
+      #
+      #   link_to "Home", "/home", :title => "Home Page"
+      #     # => <a href="/home" title="Home Page">Home</a>
+      #
+      # For an external URL:
+      #
+      #   link_to "AccountsApp", "http://accountsapp.com", :title => "Online Invoicing Software"
+      #     # => <a href="http://accountsapp.com" title="Online Invoicing Software">AccountsApp</a>
+      #
+      def link_to(title, path, opts={}, base=true)
+        unless is_uri?(path) || base == false
+          path = url(path)
+        end
+        
+        return "<a href=\"#{path}\"#{parse_options(opts)}>#{title}</a>"
       end
-    
+      
+      private
+        def parse_options(opts)
+          unless opts.empty?
+            html = [""]
+            opts.each do |key, value|
+              final_value = value.is_a?(Array) ? value.join(" ") : value
+              html << "#{key}=\"#{final_value}\""
+              #return attrs.join
+            end
+            return html.join(" ")
+          end
+        end
+        
+        def is_uri?(path)
+          URI.parse(path).class == URI::HTTP
+        end    
     end
   end
 end

data/lib/georgedrummond_sinatra_helpers/version.rb

@@ -1,7 +1,7 @@
 module GeorgeDrummond
   module Sinatra
     module Helpers
-      VERSION = "0.0.7"
+      VERSION = "0.0.8"
     end
   end
 end

data/spec/sinatra_helpers_spec.rb

@@ -0,0 +1,94 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'georgedrummond_sinatra_helpers.rb')
+
+include GeorgeDrummond::Sinatra::Helpers
+
+def url(url)
+  return File.join("/path", url)
+end
+
+describe GeorgeDrummond::Sinatra::Helpers do
+  
+  describe "mail_to" do
+    it "with only an email address provided" do
+      mail_to("georgedrummond@gmail.com").should == "<a href=\"mailto:georgedrummond@gmail.com\" class=\"mailto\">georgedrummond@gmail.com</a>"
+    end
+    
+    it "with an optional text field provided" do
+      mail_to("georgedrummond@gmail.com", "George Drummond").should == "<a href=\"mailto:georgedrummond@gmail.com\" class=\"mailto\">George Drummond</a>"
+    end
+    
+    it "wth an options hash" do
+      mail_to("georgedrummond@gmail.com", "George Drummond", :class => :email, :title => "How do you do").should == "<a href=\"mailto:georgedrummond@gmail.com\" class=\"email\" title=\"How do you do\">George Drummond</a>"
+    end
+  end
+  
+  describe "gravatar_image" do
+    it "with no size specified" do
+      gravatar_image("georgedrummond@gmail.com").should == "<img src=\"http://www.gravatar.com/avatar/d278a12b969a495ab16fdd942e748fe5?s=50\" class=\"gravatar\" />"
+    end
+    
+    it "with a size specified" do
+      gravatar_image("georgedrummond@gmail.com", 150).should == "<img src=\"http://www.gravatar.com/avatar/d278a12b969a495ab16fdd942e748fe5?s=150\" class=\"gravatar\" />"
+    end
+    
+    it "with options" do
+      gravatar_image("georgedrummond@gmail.com", 150, :class => :icon).should == "<img src=\"http://www.gravatar.com/avatar/d278a12b969a495ab16fdd942e748fe5?s=150\" class=\"icon\" />"
+    end
+  end
+  
+  
+  describe "link_to" do
+    it "with an internal link" do
+      link_to("Home", "/home").should == '<a href="/path/home">Home</a>'
+    end
+    
+    it "with options" do
+      link_to("Home", "/home", :title => "Home Page").should == '<a href="/path/home" title="Home Page">Home</a>'
+    end
+    
+    it "for an external URL" do
+      link_to("AccountsApp", "http://accountsapp.com", :title => "Online Invoicing Software").should == '<a href="http://accountsapp.com" title="Online Invoicing Software">AccountsApp</a>'
+    end
+  end
+
+  describe "image_tag" do
+    it "with a local image" do
+      image_tag("home.png").should == '<img src="/path/images/home.png" />'
+    end
+    
+    it "with options" do
+      image_tag("home.png", :title => "home", :class => :icon).should == '<img src="/path/images/home.png" title="home" class="icon" />'
+    end
+    
+    it "with an external image" do
+      image_tag("http://accountsapp.com/logo.png", :title => "Online Accounting Software").should == '<img src="http://accountsapp.com/logo.png" title="Online Accounting Software" />'
+    end
+  end
+  
+  describe "stylesheet_link_tag" do
+    it "with a single stylesheet" do
+      stylesheet_link_tag(:app).should == "<link href=\"/path/css/app.css\" type=\"text/css\" rel=\"stylesheet\" />"
+    end
+    
+    it "with an array of stylesheets" do
+      stylesheet_link_tag(:app, :header).should == "<link href=\"/path/css/app.css\" type=\"text/css\" rel=\"stylesheet\" />\n<link href=\"/path/css/header.css\" type=\"text/css\" rel=\"stylesheet\" />"
+    end
+    
+    it "with an external stylesheet" do
+      stylesheet_link_tag(:app, "http://accountsapp.com/styles/common.css").should == "<link href=\"/path/css/app.css\" type=\"text/css\" rel=\"stylesheet\" />\n<link href=\"http://accountsapp.com/styles/common.css\" type=\"text/css\" rel=\"stylesheet\" />"
+    end
+  end
+  
+  describe "javascript_include_tag" do
+    it "with a single js file" do
+      javascript_include_tag(:app).should == "<script type=\"text/javascript\" src=\"/path/js/app.js\"></script>"
+    end
+    
+    it "with an array of js files" do
+      javascript_include_tag(:jquery, :app).should == "<script type=\"text/javascript\" src=\"/path/js/jquery.js\"></script>\n<script type=\"text/javascript\" src=\"/path/js/app.js\"></script>"
+    end
+    it "with an external js file" do
+      javascript_include_tag(:jquery, "http://accountsapp.com/js/app.js").should == "<script type=\"text/javascript\" src=\"/path/js/jquery.js\"></script>\n<script type=\"text/javascript\" src=\"http://accountsapp.com/js/app.js\"></script>"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: georgedrummond_sinatra_helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-21 00:00:00.000000000Z
+date: 2011-10-30 00:00:00.000000000Z
 dependencies: []
 description: This is a collection of common helper methods that I use within my Sinatra
   apps. They have a rails like feel and they mainly fill in for helpers you would
@@ -31,6 +31,7 @@ files:
 - georgedrummond_sinatra_helpers.gemspec
 - lib/georgedrummond_sinatra_helpers.rb
 - lib/georgedrummond_sinatra_helpers/version.rb
+- spec/sinatra_helpers_spec.rb
 homepage: https://github.com/georgedrummond/georgedrummond_sinatra_helpers
 licenses: []
 post_install_message: 
@@ -64,4 +65,5 @@ summary: This is a collection of common helper methods that I use within my Sina
   apps. They have a rails like feel and they mainly fill in for helpers you would
   find in Rails. They do not behave exactly like their rails counterparts so please
   be careful to read the RDOC.
-test_files: []
+test_files:
+- spec/sinatra_helpers_spec.rb