jaap3-addthis 0.2.1 → 0.5.0

data/README.rdoc

@@ -5,16 +5,21 @@ and subscribing to feeds easy for your visitors. It supports a broad range of
 social network sites and web applications.
 
 This plugin makes it easy to add plain or customized Addthis.com widgets to
-your Rails application.
+your Rails application. As a matter of fact, the code is framework agnostic
+and should be usable in other Ruby projects as well.
 
 = Installation
 
-As a Gem in environment.rb:
+If you want to use the Rails 2.1 dependency manager add this environment.rb:
 
   config.gem 'jaap3-addthis', :lib => 'addthis',
     :source => 'http://gems.github.com'
 
-As a plugin:
+Then run the following command in your Rails application root:
+
+  rake gems:install
+
+Or use it as a plain plugin:
 
   script/plugin install git://github.com/jaap3/addthis.git
 
@@ -28,29 +33,29 @@ The most basic use is simply providing no arguments:
 The code generated by Addthis will then try to figure out the url and title by
 itself. This is not possible for addthis_feed_button.
 
-You can set a custom url, this is required for addthis_feed_button:
+You can set a custom url, a required argument addthis_feed_button:
 
   addthis_bookmark_button("http://www.example.com/")
   addthis_email_button("http://www.example.com/")
   addthis_feed_button("http://www.example.com/")
 
-Setting a title is possible when adding a bookmark or email button:
+Setting a title is also possible when adding a bookmark or email button:
 
   addthis_bookmark_button("http://www.example.com/", "Example website")
   addthis_email_button("http://www.example.com/", "Example website")
 
 To only set a custom title you can use to options hash:
 
-  addthis_bookmark_button(:title => "Example title")
-  addthis_email_button(:title => "Example title")
+  addthis_bookmark_button(:page_title => "Example title")
+  addthis_email_button(:page_title => "Example title")
 
-The options hash can be used to customize the widget to a great extend. Each of
+The options hash can be used to customize the widget to a great extent. Each of
 the shown examples can take the options hash as an optional extra argument.
 
 = Usage
 
 If you wish to track analytics for your button, you must create an account at
-http://addthis.com/. Joining is free!
+http://Addthis.com. Joining is free!
 
 After signing up create a new ruby file in config/initializers called
 addthis.rb. You can use this file to configure your publisher name (your
@@ -74,13 +79,65 @@ Besides overriding the default settings using the initializer, each helper
 method takes an options hash that can be used to override any setting for
 a specific button.
 
-So calling
+= Secure pages
+
+Calling one of the addthis_button methods with the secure option set to true
+like this:
 
   addthis_bookmark_button(:publisher => "example", :secure => true)
 
-Will output a button usable on https pages with the publisher variable set
+will output a button usable on https pages with the publisher variable set
 to "example" regardless of any configuration changes.
 
+The default value of the secure option is false, this default can be changed by
+setting
+
+  Jaap3::Addthis::DEFAULT_OPTIONS[:secure] = true
+
+in your initializer.
+
+= Custom images / text
+
+Using a different image or link text is achieved by using the methods with a
+block:
+
+  addthis_bookmark_button { "Click here to AddThis!" }
+
+This will output a textlink that behaves exactly like a normal bookmark_button
+but withouth the image.
+
+You can offcourse use the block to call the Rails image_tag helper to embed your
+own images.
+
+You can change the default image of each button by modifying the following
+constants in you initializer:
+
+  Jaap3::Addthis::BOOKMARK_BUTTON_DEFAULTS[:button_html] = "Click here to AddThis"
+  Jaap3::Addthis::FEED_BUTTON_DEFAULTS[:button_html] = "Click here to AddThis"
+  Jaap3::Addthis::EMAIL_BUTTON_DEFAULTS[:button_html] = "Click here to AddThis"
+
+= Script options
+
+Addthis.com allows for a few variables to be set to change the appearance of the
+widget. These can either be given during a method call:
+
+  addthis_bookmark_button({
+    :brand => "Example brand",
+    :header_color => "white",
+    :header_background => "black",
+    :offset_top => -100,
+    :offset_left => 125,
+    :hover_delay => 200
+  })
+
+Or by having your initializer change the defaults stored in:
+
+  Jaap3::Addthis::DEFAULT_OPTIONS
+
+Note that you cannot customize individual buttons on a page. Custom settings
+will be applied to all the buttons on a page. This is a limitation of the
+Addthis.com widget.
+
 = Contributing
 
 If you would like to contribute to the Addthis plugin, just fork the code

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
+:patch: 0
 :major: 0
-:minor: 2
-:patch: 1
+:minor: 5

data/lib/addthis.rb

@@ -5,66 +5,84 @@ module Jaap3
     }
     DEFAULT_OPTIONS = {
       :script_src => "http://s7.addthis.com/js/200/addthis_widget.js",
-      :secure => false
+      :secure => false,
+      :brand => nil, :header_color => nil, :header_background => nil,
+      :offset_top => nil, :offset_left => nil, :hover_delay => nil
     }
     BOOKMARK_BUTTON_DEFAULTS = {
       :title => "",
-      :alt => "Bookmark and Share"
+      :alt => "Bookmark and Share",
+      :button_html => '<img src="http://s7.addthis.com/static/btn/lg-share-en.gif"
+        width="125" height="16" border="0" alt="#{options[:alt]}" />'
     }
     FEED_BUTTON_DEFAULTS = {
       :title => "Subscribe using any feed reader!",
-      :alt => "Subscribe"
+      :alt => "Subscribe",
+      :button_html => '<img src="http://s7.addthis.com/static/btn/lg-feed-en.gif"
+        width="125" height="16" border="0" alt="#{options[:alt]}" />'
     }
     EMAIL_BUTTON_DEFAULTS = {
       :title => "",
-      :alt => "Email"
+      :alt => "Email",
+      :button_html => '<img src="http://s7.addthis.com/button1-email.gif"
+        width="54" height="16" border="0" alt="#{options[:alt]}" />'
     }
 
     module Helper
       def addthis_bookmark_button(*args)
         url, options = extract_addthis_url_and_options(args)
+        options[:button_html] = yield if block_given?
         options = BOOKMARK_BUTTON_DEFAULTS.merge(options)
-        s = %Q{<a href="http://www.addthis.com/bookmark.php?v=20" onmouseover="}
-        s << %Q{return addthis_open(this, '', '#{url}', '#{options[:page_title]}')"}
-        s << %Q{ title="#{options[:title]}"}
-        s << %Q{ onmouseout="addthis_close()" onclick="return addthis_sendto()">}
-        s << %Q{<img src="http://s7.addthis.com/static/btn/lg-share-en.gif"}
-        s << %Q{ width="125" height="16" alt="#{options[:alt]}" style="border:0"/></a>}
+        s = %Q{
+          <a href="http://www.addthis.com/bookmark.php?v=20"
+            onmouseover="return addthis_open(this, '', '#{url}', '#{options[:page_title]}')"
+            title="#{options[:title]}" onmouseout="addthis_close()"
+            onclick="return addthis_sendto()">}
         addthis_tag(s, options)
       end
       alias addthis_share_button addthis_bookmark_button
 
       def addthis_feed_button(url, *args)
         options = FEED_BUTTON_DEFAULTS.merge(extract_addthis_options(args))
-        s = %Q{<a href="http://www.addthis.com/feed.php?pub=#{options[:publisher]}&h1=#{url}&t1="}
-        s << %Q{ onclick="return addthis_open(this, 'feed', '#{url}')"}
-        s << %Q{ title="#{options[:title]}" target="_blank">}
-        s << %Q{<img src="http://s7.addthis.com/static/btn/lg-feed-en.gif"}
-        s << %Q{width="125" height="16" alt="#{options[:alt]}" style="border:0"/></a>}
+        options[:button_html] = yield if block_given?
+        s = %Q{
+          <a href="http://www.addthis.com/feed.php?pub=#{options[:publisher]}&h1=#{url}&t1="
+            onclick="return addthis_open(this, 'feed', '#{url}')"
+            title="#{options[:title]}" target="_blank">}
         addthis_tag(s, options)
       end
 
       def addthis_email_button(*args)
         url, options = extract_addthis_url_and_options(args)
+        options[:button_html] = yield if block_given?
         options = EMAIL_BUTTON_DEFAULTS.merge(options)
-        s = %Q{<a href="http://www.addthis.com/bookmark.php"}
-        s << %Q{ style="text-decoration:none;" title="#{options[:title]}"}
-        s << %Q{ onclick="return addthis_open(this, 'email', '#{url}', '#{options[:page_title]}');">}
-        s << %Q{<img src="http://s7.addthis.com/button1-email.gif" width="54" height="16" border="0" alt="#{options[:alt]}" /></a>}
+        s = %Q{
+          <a href="http://www.addthis.com/bookmark.php"
+            onclick="return addthis_open(this, 'email', '#{url}', '#{options[:page_title]}')"
+            title="#{options[:title]}">}
         addthis_tag(s, options)
       end
 
       protected
       def addthis_tag(str, options = {})
         s = [%Q{<!-- AddThis Button BEGIN -->}]
-        s << %Q{<script type="text/javascript">var addthis_pub="#{options[:publisher]}";</script>}
-        s << str
+        s << addthis_custom_script(options)
+        s << %Q{#{str}#{options[:button_html].gsub(/#\{options\[:alt\]\}/, options[:alt])}</a>}
         s << %Q{<script type="text/javascript" src="#{options[:script_src]}"></script>}
         s << %Q{<!-- AddThis Button END -->}
         s = s * "\n"
         options[:secure] ? s.gsub(/http:\/\/s[57]\.addthis\.com/, "https://secure.addthis.com") : s
       end
 
+      def addthis_custom_script(options = {})
+        s = %Q{<script type="text/javascript">
+          var addthis_pub = "#{options[:publisher]}";}
+        [:brand, :header_color, :header_background, :offset_top, :offset_left, :hover_delay].each do |custom|
+          s << %Q{var addthis_#{custom} = #{options[custom].is_a?(Integer) ? options[custom] : %Q("#{options[custom]}")};} unless options[custom].nil?
+        end
+        s << "</script>"
+      end
+
       def extract_addthis_url_and_options(args, options = {:page_title => "[TITLE]"})
         url = args[0].is_a?(String) ? args.shift : "[URL]"
         return url, options = extract_addthis_options(args, options)
@@ -74,8 +92,8 @@ module Jaap3
         page_title = args[0].is_a?(String) ? args.shift : options[:page_title]
         options = args[0].is_a?(Hash) ? args.shift : options
         options[:page_title] = page_title
-        options = CONFIG.merge(DEFAULT_OPTIONS).merge(options)
         options.symbolize_keys! if options.respond_to?(:symbolize_keys!)
+        options = CONFIG.merge(DEFAULT_OPTIONS).merge(options)
         return options
       end
     end

data/test/addthis_test.rb

@@ -27,6 +27,11 @@ class AddthisTest < Test::Unit::TestCase
       end
 
       should_set_script_src_to Jaap3::Addthis::DEFAULT_OPTIONS[:script_src]
+      
+      [:brand, :header_color, :header_background,
+       :offset_top, :offset_left, :hover_delay].each do |attribute|
+        should_not_customize attribute
+      end
 
       should "start with an html comment" do
         assert_equal "<!-- AddThis Button BEGIN -->", @output_lines.first
@@ -81,9 +86,7 @@ class AddthisTest < Test::Unit::TestCase
       context "the output of #{m}" do
         setup { @output = method(m).call("http://example.com") }
 
-        should "set addthis_pub to test_publisher" do
-          assert_match 'var addthis_pub="test_publisher";', @output
-        end
+        should_customize :pub, "test_publisher"
       end
     end
 
@@ -92,6 +95,22 @@ class AddthisTest < Test::Unit::TestCase
 
       should_set_href_to "http://www.addthis.com/feed.php?pub=test_publisher&h1=http://example.com&t1="
     end
+
+    context "in turn overwritten by options hash" do
+      [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+        context "the output of #{m}" do
+          setup { @output = method(m).call("http://example.com", :publisher => "another_publisher") }
+
+          should_customize :pub, "another_publisher"
+        end
+      end
+
+      context "a feed button" do
+        setup { @output = addthis_feed_button("http://example.com", :publisher => "another_publisher") }
+
+        should_set_href_to "http://www.addthis.com/feed.php?pub=another_publisher&h1=http://example.com&t1="
+      end
+    end
   end
 
   context "with altered script_src" do
@@ -99,10 +118,7 @@ class AddthisTest < Test::Unit::TestCase
 
     [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
       context "the output of #{m}" do
-        setup do
-          @output = method(m).call("http://example.com")
-          @output_lines = @output.split("\n")
-        end
+        setup { @output = method(m).call("http://example.com") }
 
         should_set_script_src_to "http://example.com/example.js"
       end
@@ -111,10 +127,7 @@ class AddthisTest < Test::Unit::TestCase
     context "in turn overwritten by options hash" do
       [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
         context "the output of #{m}" do
-          setup do
-            @output = method(m).call("http://example.com", :script_src => "http://www.example.com/example.js")
-            @output_lines = @output.split("\n")
-          end
+          setup { @output = method(m).call("http://example.com", :script_src => "http://www.example.com/example.js") }
 
           should_set_script_src_to "http://www.example.com/example.js"
         end
@@ -122,13 +135,21 @@ class AddthisTest < Test::Unit::TestCase
     end
   end
 
+  context "when overwriting alt and title" do
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "the output of #{m}" do
+        setup { @output = method(m).call("http://example.com", :alt => "Example", :title => "Example title") }
+
+        should_set_title_to "Example title"
+        should_set_alt_to "Example"
+      end
+    end
+  end
+
   context "when setting secure to true" do
     [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
       context "by using the options hash the output of #{m}" do
-        setup do
-          @output = method(m).call("http://example.com", :secure => true)
-          @output_lines = @output.split("\n")
-        end
+        setup { @output = method(m).call("http://example.com", :secure => true) }
 
         should_set_script_src_to "https://secure.addthis.com/js/200/addthis_widget.js"
       end
@@ -139,7 +160,6 @@ class AddthisTest < Test::Unit::TestCase
         setup do
           Jaap3::Addthis::DEFAULT_OPTIONS[:secure] = true
           @output = method(m).call("http://example.com")
-          @output_lines = @output.split("\n")
         end
 
         should_set_script_src_to "https://secure.addthis.com/js/200/addthis_widget.js"
@@ -147,4 +167,75 @@ class AddthisTest < Test::Unit::TestCase
     end
   end
 
+  context "with a block" do
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "the output of #{m}" do
+        setup do
+          @output = method(m).call("http://example.com") do
+            "Click here to AddThis"
+          end
+        end
+
+        should "contain the custom text" do
+          assert_match(/<a[^>]+>Click here to AddThis<\/a>/, @output)
+        end
+      end
+    end
+  end
+
+  context "with changed default html" do
+    setup do
+      Jaap3::Addthis::BOOKMARK_BUTTON_DEFAULTS[:button_html] = "Click here to AddThis"
+      Jaap3::Addthis::FEED_BUTTON_DEFAULTS[:button_html] = "Click here to AddThis"
+      Jaap3::Addthis::EMAIL_BUTTON_DEFAULTS[:button_html] = "Click here to AddThis"
+    end
+
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "the output of #{m}" do
+        setup { @output = method(m).call("http://example.com") }
+
+        should "contain the custom text" do
+          assert_match(/<a[^>]+>Click here to AddThis<\/a>/, @output)
+        end
+      end
+    end
+  end
+
+  context "tricked out with options" do
+    options = {
+      :brand => "Example brand",
+      :header_color => "white",
+      :header_background => "black",
+      :offset_top => 40,
+      :offset_left => 60,
+      :hover_delay => 200
+    }
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "the output of #{m}" do
+        setup do
+          @output = method(m).call("http://example.com", options)
+        end
+
+        options.each_pair do |attribute, value|
+          should_customize attribute, value
+        end
+      end
+    end
+
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "by changing the defaults the output of #{m}" do
+        setup do
+          options.each_pair do |attribute, value|
+            Jaap3::Addthis::DEFAULT_OPTIONS[attribute] = value
+          end
+          @output = method(m).call("http://example.com", options)
+        end
+
+        options.each_pair do |attribute, value|
+          should_customize attribute, value
+        end
+      end
+    end
+  end
+
 end

data/test/test_helper.rb

@@ -26,6 +26,18 @@ class Test::Unit::TestCase
         should_set_src_to expected
       end
     end
+
+    def should_not_customize(attribute)
+      should "not set addthis_#{attribute}" do
+        assert_no_match(/var addthis_#{attribute} = "[\"]+";/, @output)
+      end
+    end
+
+    def should_customize(attribute, value)
+      should "set addthis_#{attribute} to '#{value}" do
+        assert_match(/var addthis_#{attribute} = ["]?#{value}["]?;/, @output)
+      end
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jaap3-addthis
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - Jaap Roes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-23 00:00:00 -07:00
+date: 2009-04-24 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -55,7 +55,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: TODO
 test_files: 
 - test/test_helper.rb