facebook_share 0.0.4 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    facebook_share (0.0.4)
+    facebook_share (0.0.5)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -6,10 +6,14 @@ Any public method will return just JavaScript code and nothing else.
 
 ## How to install
 
-This gem relies on jQuery, be sure to have it installed in your project. It does not depend on jquery-rails gem, because some projects use jQuery without it.
-
     gem install facebook_share
 
+This gem supports jQuery and Dojo, be sure to have it installed in your project.
+
+In case of jQuery, the gem does not depend on jquery-rails, because some projects use jQuery without it or expose jQuery function to another global variable or use [jQuery.noConflict](http://api.jquery.com/jQuery.noConflict).
+
+Further information about choosing framework are described in next section.
+
 ## Code changes
 
 If you don't have a Facebook Application for your project yet, [create one](http://www.facebook.com/developers/createapp.php).
@@ -20,10 +24,13 @@ Then add this to your ApplicationHelper
       include FacebookShare
 
       FacebookShare.default_facebook_share_options = {
+        :framework => :jquery,
+        :jquery_function => "$",
+      
         :app_id => "YOUR_APP_ID",
-        :status => false,
-        :cookie => false,
-        :xfbml => false,
+        :status => "false",
+        :cookie => "false",
+        :xfbml => "false",
 
         :selector => '.fb_share',
         :locale => "en_US"
@@ -34,10 +41,12 @@ You can ommit *app_id* parameter, if you already have a Facebook Application ini
 
 Be sure you have <div id="fb-root"></div> in your application layout before you load the Facebook Connect JS
 
-Default facebook Share options can be changed with the above code snippet
+Default facebook Share options can be changed with the above code snippet. The options can be also passed to any public method, so you don't have to rely on defaults at any given time.
 
-* *appid* - your Facebook application ID that will connect your site to Facebook
-* *status*. *cookie* and *xfbml* - as described at [FB.init JS SDK](http://developers.facebook.com/docs/reference/javascript/fb.init/)
+* *framework* - choose a JavaScript framework to work with. For now just **:dojo** and **:jquery** are supported.
+** *jquery_function* - If you are using jQuery and mapped the jQuery function to a different variable, you can use that to pass a correct jQuery variable name, for example **$j**, **jQuery**, etc.
+* *app_id* - your Facebook application ID that will connect your site to Facebook - as described at [FB.init JS SDK](http://developers.facebook.com/docs/reference/javascript/fb.init/)
+* *status*, *cookie* and *xfbml* - as described at [FB.init JS SDK](http://developers.facebook.com/docs/reference/javascript/fb.init/)
 * *locale* - Facebook locale code representations, ie. en_US, de_DE, pl_PL, etc. The full list of Facebook supported languages is available in http://www.facebook.com/translations/FacebookLocales.xml or at [Facebook Developer Wiki](http://fbdevwiki.com/wiki/Locales). If your locale has both parts of the string the same, for example "de_DE", "pl_PL", since version 0.0.4 you can put just "de" or "pl", etc. The script **does not** check for validity of given locale.
 * *selector* - a selector to target Facebook share binding, ".fb_share" by default
 * any other parameter will be passed to Facebook's **[FB.ui](http://developers.facebook.com/docs/reference/javascript/fb.ui/)** function, so you can use whichever parameters you need, except for *method*, which defaults always to *publish.stream*
@@ -49,10 +58,14 @@ The simplest usage (given you specified your project's Facebook Application ID)
     <%= link_to 'Share on Facebook', '#', :class => "fb_share"  %>
     <%= facebook_share_once %>
 
-That will produce a link "Share on Facebook" with a class of "fb_share" and a corresponding JavaScript script tags initializing Facebook app and sharing method bind to click on that link. By default gem passes ".fb_share" selector to jQuery.
+That will produce a link "Share on Facebook" with a class of "fb_share" and a corresponding JavaScript script tags initializing Facebook app and sharing method bind to click on that link. By default gem passes ".fb_share" selector to the Javascript framework of your choice.
 
 ## Changelog
 
+v0.0.5
+
+* Added support for [Dojo framework](http://dojotoolkit.org/)
+
 v0.0.4
 
 * Locale guessing, if necessary

data/lib/facebook_share/version.rb

@@ -1,3 +1,3 @@
 module FacebookShare
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/facebook_share.rb

@@ -1,7 +1,7 @@
 module FacebookShare
   INIT_PARAMS = %w(status cookie xfbml)
-  REMOVE_PARAMS = %w(app_id selector status cookie xfbml locale)
-
+  REMOVE_PARAMS = %w(app_id selector status cookie xfbml locale framework jquery_function)
+  
   class << self
     attr_accessor :default_facebook_share_options
   end
@@ -15,6 +15,10 @@ module FacebookShare
     end
     {
       :app_id => "0",
+      
+      :framework => :jquery,
+      :jquery_function => "$",
+
       :selector => ".fb_share",
       :link => link,
       :locale => "en_US",
@@ -26,14 +30,31 @@ module FacebookShare
     facebook_script_tags options, facebook_share( options )
   end
 
-  def facebook_share(options = {})
+  def facebook_share_code(options = {})
     options = default_facebook_share_options.merge(options)
-    script = <<-JS
-$("#{options[:selector]}").unbind("click.facebook_share").bind("click.facebook_share",function () {
-  FB.ui({method: \'stream.publish\'#{build_params(options)}});
+    <<-JS
+  FB.ui({method: 'stream.publish'#{build_params(options)}});
   return false;
+JS
+  end
+
+  def facebook_share(options = {})
+    options = default_facebook_share_options.merge(options)
+    script = ""
+    case options[:framework]
+    when :dojo
+      script << <<-JS
+dojo.query("#{options[:selector]}").onclick(function(evt){
+#{facebook_share_code(options)}
+});
+JS
+    else # default to jquery
+      script << <<-JS
+#{options[:jquery_function]}("#{options[:selector]}").unbind("click.facebook_share").bind("click.facebook_share",function () {
+#{facebook_share_code(options)}
 });
 JS
+    end
     script
   end
 
@@ -63,23 +84,24 @@ JS
     html_safe_string("FB.init({appId:\"#{options[:app_id]}\"#{params}});")
   end
 
-  def build_params(options, for_init = false)
-    script = ""
-    options.each do |key, value|
-      # if it's for init script, include only status, cookie and xfbml
-      # if it's for stream.publish, include all except for initial
-      param_check = ( for_init ) ? FacebookShare::INIT_PARAMS.include?(key.to_s) : !(FacebookShare::REMOVE_PARAMS.include?(key.to_s))
+  private
+    def build_params(options, for_init = false)
+      script = ""
+      options.each do |key, value|
+        # if it's for init script, include only status, cookie and xfbml
+        # if it's for stream.publish, include all except for initial
+        param_check = ( for_init ) ? FacebookShare::INIT_PARAMS.include?(key.to_s) : !(FacebookShare::REMOVE_PARAMS.include?(key.to_s))
 
-      if value && param_check
-        value_sanitized = value.to_s.gsub(/"/, '\"')
-        script << ", #{key}: \"#{value_sanitized}\""
+        if value && param_check
+          value_sanitized = value.to_s.gsub(/"/, '\"')
+          script << ", #{key}: \"#{value_sanitized}\""
+        end
       end
+      script
     end
-    script
-  end
 
-  def html_safe_string(str)
-    @use_html_safe ||= "".respond_to?(:html_safe)
-    @use_html_safe ? str.html_safe : str
-  end
+    def html_safe_string(str)
+      @use_html_safe ||= "".respond_to?(:html_safe)
+      @use_html_safe ? str.html_safe : str
+    end
 end

data/spec/facebook_share/facebook_share_spec.rb

@@ -50,23 +50,47 @@ describe FacebookShare do
   describe "creating init script" do
     context "when vanilla locale" do
       subject { facebook_connect_js_tag( :locale => "en_US" ) }
-      
+
       it { should match(/\/en_US\/all\.js/) }
       it { should_not match(/\/en\/all\.js/) }
     end
 
     context "when shortened locale" do
       subject { facebook_connect_js_tag( :locale => "en" ) }
-      
+
       it { should match(/\/en_EN\/all\.js/) }
       it { should_not match(/\/en\/all\.js/) }
     end
 
     context "when shortened locale 2" do
       subject { facebook_connect_js_tag( :locale => "pl" ) }
-      
+
       it { should match(/\/pl_PL\/all\.js/) }
       it { should_not match(/\/pl\/all\.js/) }
     end
   end
+
+  describe "using this JavaScript framework: " do
+    context "Dojo" do
+      subject { facebook_share_once( :selector => ".fb_share", :framework => :dojo ) }
+
+      it { should match(/dojo\.query\(".fb_share"\)/) }
+      it { should_not match(/\$\(".fb_share"\)/) }
+    end
+
+    context "jQuery" do
+      subject { facebook_share_once( :selector => ".fb_share", :framework => :jquery ) }
+
+      it { should match(/\$\(".fb_share"\)/) }
+      it { should_not match(/dojo\.query\(".fb_share"\)/) }
+    end
+
+    context "jQuery with a defined function" do
+      subject { facebook_share_once( :selector => ".fb_share", :framework => :jquery, :jquery_function => "$j" ) } # $j is used on Wikimedia projects      
+ 
+      it { should match(/\$j\(".fb_share"\)/) }
+      it { should_not match(/\$\(".fb_share"\)/) }
+      it { should_not match(/dojo\.query\(".fb_share"\)/) }
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: facebook_share
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - "Mike Po\xC5\x82tyn"