jaap3-addthis 0.5.0 → 0.7.0

data/README.rdoc

@@ -4,11 +4,10 @@ Addthis.com provides widgets that make sharing, bookmarking and emailing pages,
 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. As a matter of fact, the code is framework agnostic
-and should be usable in other Ruby projects as well.
+This helper makes it easy to add plain or customized Addthis.com widgets to
+your Ruby (on Rails) application.
 
-= Installation
+== Installation
 
 If you want to use the Rails 2.1 dependency manager add this environment.rb:
 
@@ -23,7 +22,7 @@ Or use it as a plain plugin:
 
   script/plugin install git://github.com/jaap3/addthis.git
 
-= Quick Start
+== Quick Start
 
 The most basic use is simply providing no arguments:
 
@@ -33,7 +32,7 @@ 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, a required argument addthis_feed_button:
+You can set a custom url, a required argument for addthis_feed_button:
 
   addthis_bookmark_button("http://www.example.com/")
   addthis_email_button("http://www.example.com/")
@@ -52,7 +51,7 @@ To only set a custom title you can use to options hash:
 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
+== Usage
 
 If you wish to track analytics for your button, you must create an account at
 http://Addthis.com. Joining is free!
@@ -79,24 +78,20 @@ 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.
 
-= Secure pages
+=== Custom services
 
-Calling one of the addthis_button methods with the secure option set to true
-like this:
+To change the initial list of services shown when opening the bookmark menu
+pass the options hash a list of services you wish to see.
 
-  addthis_bookmark_button(:publisher => "example", :secure => true)
+  addthis_bookmark_button(:options => "facebook, email, twitter, more")
 
-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
+For a list of available services see http://addthis.com/help/customize/services.
+By modifying the defaults in the initializer you can avoid having to set your
+preferred set of services every call.
 
-in your initializer.
+  Jaap3::Addthis::DEFAULT_OPTIONS[:options] = "facebook, email, twitter, more"
 
-= Custom images / text
+=== Custom images / text
 
 Using a different image or link text is achieved by using the methods with a
 block:
@@ -106,17 +101,17 @@ block:
 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
+You can also 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:
+You can permanently 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
+=== 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:
@@ -138,7 +133,43 @@ 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
+Read more about these options on the the addthis.com website:
+* http://addthis.com/help/customize/branding
+* http://addthis.com/help/customize/menu-offset
+* http://addthis.com/help/customize/hover-delay
+
+=== Secure pages
+
+Calling one of the addthis_button methods with the secure option set to true
+like this:
+
+  addthis_bookmark_button(:secure => true)
+
+will output a button usable on https pages.
+
+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 language
+
+The Addthis widget language will automatically choose a language based on
+the user's browser settings. To override this behaviour you can set a custom
+language.
+
+  addthis_bookmark_button(:language => "nl")
+
+or
+
+  Jaap3::Addthis::DEFAULT_OPTIONS[:language] = "nl"
+
+For a list of supported language codes see the bottom of
+http://addthis.com/help/localization/translations
+
+== Contributing
 
 If you would like to contribute to the Addthis plugin, just fork the code
 and send me a pull request after you are done fiddling.

data/VERSION.yml

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

data/lib/addthis.rb

@@ -1,31 +1,23 @@
 module Jaap3
   module Addthis
-    CONFIG = {
-      :publisher => ""
-    }
+    CONFIG = {:publisher => ""}
     DEFAULT_OPTIONS = {
       :script_src => "http://s7.addthis.com/js/200/addthis_widget.js",
-      :secure => false,
       :brand => nil, :header_color => nil, :header_background => nil,
-      :offset_top => nil, :offset_left => nil, :hover_delay => nil
+      :offset_top => nil, :offset_left => nil, :hover_delay => nil,
+      :options => nil, :language => nil, :secure => false
     }
     BOOKMARK_BUTTON_DEFAULTS = {
       :title => "",
-      :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]}" />'
+      :button_html => '<img src="http://s7.addthis.com/static/btn/lg-share-en.gif" width="125" height="16" border="0" alt="Bookmark and Share" />'
     }
     FEED_BUTTON_DEFAULTS = {
       :title => "Subscribe using any feed reader!",
-      :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]}" />'
+      :button_html => '<img src="http://s7.addthis.com/static/btn/lg-feed-en.gif" width="125" height="16" border="0" alt="Subscribe" />'
     }
     EMAIL_BUTTON_DEFAULTS = {
       :title => "",
-      :alt => "Email",
-      :button_html => '<img src="http://s7.addthis.com/button1-email.gif"
-        width="54" height="16" border="0" alt="#{options[:alt]}" />'
+      :button_html => '<img src="http://s7.addthis.com/button1-email.gif" width="54" height="16" border="0" alt="Email" />'
     }
 
     module Helper
@@ -33,56 +25,48 @@ module Jaap3
         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="return addthis_open(this, '', '#{url}', '#{options[:page_title]}')"
-            title="#{options[:title]}" onmouseout="addthis_close()"
-            onclick="return addthis_sendto()">}
+        s = %Q{<a href="http://www.addthis.com/bookmark.php?v=20" onmouseover="#{addthis_open("", url, options[:page_title])}" onmouseout="addthis_close()" onclick="return addthis_sendto()" title="#{options[:title]}">}
         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))
+      def addthis_email_button(*args)
+        url, options = extract_addthis_url_and_options(args)
         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">}
+        options = EMAIL_BUTTON_DEFAULTS.merge(options)
+        s = %Q{<a href="http://www.addthis.com/bookmark.php" onclick="#{addthis_open("email", url, options[:page_title])}" title="#{options[:title]}">}
         addthis_tag(s, options)
       end
 
-      def addthis_email_button(*args)
-        url, options = extract_addthis_url_and_options(args)
+      def addthis_feed_button(url, *args)
+        options = FEED_BUTTON_DEFAULTS.merge(extract_addthis_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"
-            onclick="return addthis_open(this, 'email', '#{url}', '#{options[:page_title]}')"
-            title="#{options[:title]}">}
+        s = %Q{<a href="http://www.addthis.com/feed.php?pub=#{options[:publisher]}&h1=#{url.gsub(/[^a-zA-Z0-9_\.\-]/n) {|c| sprintf('%%%02x', c[0]) }}&t1=" onclick="#{addthis_open("feed", url)}" title="#{options[:title]}" target="_blank">}
         addthis_tag(s, options)
       end
 
       protected
       def addthis_tag(str, options = {})
-        s = [%Q{<!-- AddThis Button BEGIN -->}]
+        s = ["<!-- AddThis Button BEGIN -->"]
         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 << "#{str}#{options[:button_html]}</a><script type=\"text/javascript\" src=\"#{options[:script_src]}\"></script>"
+        s << "<!-- 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?
+        s = "<script type=\"text/javascript\">var addthis_pub = '#{options[:publisher]}';"
+        [:brand, :header_color, :header_background, :offset_top, :offset_left, :hover_delay, :options, :language].each do |custom|
+          s << "var addthis_#{custom} = #{options[custom].is_a?(Integer) ? options[custom] : "'#{options[custom]}'"};" unless options[custom].nil?
         end
         s << "</script>"
       end
 
+      def addthis_open(type, url, title = nil)
+        "addthis_open(this, '#{type}', '#{url}'#{ title.nil? ? "" : ", '#{title.gsub("'", "\\u0027").gsub("\"", "\\u0022")}'"})"
+      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)
@@ -91,8 +75,8 @@ module Jaap3
       def extract_addthis_options(args, options = {})
         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.symbolize_keys! if options.respond_to?(:symbolize_keys!)
+        options[:page_title] = page_title
         options = CONFIG.merge(DEFAULT_OPTIONS).merge(options)
         return options
       end

data/test/addthis_test.rb

@@ -18,7 +18,7 @@ class AddthisTest < Test::Unit::TestCase
   should "provide addthis_email_button" do
     assert respond_to?(:addthis_email_button)
   end
-  
+
   [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
     context "the output of #{m}" do
       setup do
@@ -43,10 +43,19 @@ class AddthisTest < Test::Unit::TestCase
     end
   end
 
+  [:addthis_bookmark_button, :addthis_email_button].each do |m|
+    context "the output of #{m} with url and title set" do
+      setup { @output = method(m).call("http://example.com", "It's an \"example\"") }
+
+      should "include title" do
+        assert_match "'It\\u0027s an \\u0022example\\u0022'", @output
+      end
+    end
+  end
+
   context "a bookmark/share button" do
     setup { @output = addthis_bookmark_button }
 
-    should_set_alt_to Jaap3::Addthis::BOOKMARK_BUTTON_DEFAULTS[:alt]
     should_set_title_to Jaap3::Addthis::BOOKMARK_BUTTON_DEFAULTS[:title]
     should_set_href_to "http://www.addthis.com/bookmark.php?v=20"
 
@@ -62,9 +71,8 @@ class AddthisTest < Test::Unit::TestCase
   context "a feed button" do
     setup { @output = addthis_feed_button("http://example.com") }
 
-    should_set_alt_to Jaap3::Addthis::FEED_BUTTON_DEFAULTS[:alt]
     should_set_title_to Jaap3::Addthis::FEED_BUTTON_DEFAULTS[:title]
-    should_set_href_to "http://www.addthis.com/feed.php?pub=&h1=http://example.com&t1="
+    should_set_href_to "http://www.addthis.com/feed.php?pub=&h1=http%3a%2f%2fexample.com&t1="
 
     should "set url to example.com" do
       assert_match "'http://example.com')", @output
@@ -74,7 +82,6 @@ class AddthisTest < Test::Unit::TestCase
   context "an email button" do
     setup { @output = addthis_email_button }
 
-    should_set_alt_to Jaap3::Addthis::EMAIL_BUTTON_DEFAULTS[:alt]
     should_set_title_to Jaap3::Addthis::EMAIL_BUTTON_DEFAULTS[:title]
     should_set_href_to "http://www.addthis.com/bookmark.php"
   end
@@ -93,7 +100,7 @@ class AddthisTest < Test::Unit::TestCase
     context "a feed button" do
       setup { @output = addthis_feed_button("http://example.com") }
 
-      should_set_href_to "http://www.addthis.com/feed.php?pub=test_publisher&h1=http://example.com&t1="
+      should_set_href_to "http://www.addthis.com/feed.php?pub=test_publisher&h1=http%3a%2f%2fexample.com&t1="
     end
 
     context "in turn overwritten by options hash" do
@@ -108,7 +115,7 @@ class AddthisTest < Test::Unit::TestCase
       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="
+        should_set_href_to "http://www.addthis.com/feed.php?pub=another_publisher&h1=http%3a%2f%2fexample.com&t1="
       end
     end
   end
@@ -135,13 +142,12 @@ class AddthisTest < Test::Unit::TestCase
     end
   end
 
-  context "when overwriting alt and title" do
+  context "when overwriting 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") }
+        setup { @output = method(m).call("http://example.com", :title => "Example title") }
 
         should_set_title_to "Example title"
-        should_set_alt_to "Example"
       end
     end
   end
@@ -212,9 +218,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", options)
-        end
+        setup { @output = method(m).call("http://example.com", options) }
 
         options.each_pair do |attribute, value|
           should_customize attribute, value
@@ -228,7 +232,7 @@ class AddthisTest < Test::Unit::TestCase
           options.each_pair do |attribute, value|
             Jaap3::Addthis::DEFAULT_OPTIONS[attribute] = value
           end
-          @output = method(m).call("http://example.com", options)
+          @output = method(m).call("http://example.com")
         end
 
         options.each_pair do |attribute, value|
@@ -238,4 +242,27 @@ class AddthisTest < Test::Unit::TestCase
     end
   end
 
+  context "with a custom list of services" do
+    context "the output of addthis_bookmark_button" do
+      setup { @output = addthis_bookmark_button(:options => "facebook, email, twitter, more") }
+
+      should_customize :options, "facebook, email, twitter, more"
+    end
+
+    context "by changing the defaults the output of addthis_bookmark_button" do
+      setup do
+        Jaap3::Addthis::DEFAULT_OPTIONS[:options] = "facebook, email, twitter, more"
+        @output = addthis_bookmark_button
+      end
+
+      should_customize :options, "facebook, email, twitter, more"
+    end
+  end
+
+  context "with a custom language set" do
+    setup { @output = addthis_bookmark_button(:language => "nl") }
+    
+    should_customize :language, "nl"
+  end
+
 end

data/test/test_helper.rb

@@ -29,13 +29,13 @@ class Test::Unit::TestCase
 
     def should_not_customize(attribute)
       should "not set addthis_#{attribute}" do
-        assert_no_match(/var addthis_#{attribute} = "[\"]+";/, @output)
+        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)
+        assert_match(/var addthis_#{attribute} = [']?#{value}[']?;/, @output)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jaap3-addthis
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Jaap Roes