facebook_share 0.0.5 → 0.0.6

data/README.md

@@ -22,21 +22,24 @@ Then add this to your ApplicationHelper
 
     module ApplicationHelper
       include FacebookShare
-
-      FacebookShare.default_facebook_share_options = {
-        :framework => :jquery,
-        :jquery_function => "$",
       
-        :app_id => "YOUR_APP_ID",
-        :status => "false",
-        :cookie => "false",
-        :xfbml => "false",
-
-        :selector => '.fb_share',
-        :locale => "en_US"
-      }
     end
 
+Global configuration (config/initializers/facebook_share.rb ): 
+
+    FacebookShare.default_facebook_share_options = {
+      :framework => :jquery,
+      :jquery_function => "$",
+
+      :app_id => "YOUR_APP_ID",
+      :status => "false",
+      :cookie => "false",
+      :xfbml => "false",
+
+      :selector => '.fb_share',
+      :locale => "en_US"
+    }
+
 You can ommit *app_id* parameter, if you already have a Facebook Application initialized in your project.
 
 Be sure you have <div id="fb-root"></div> in your application layout before you load the Facebook Connect JS
@@ -44,13 +47,15 @@ Be sure you have <div id="fb-root"></div> in your application layout before you
 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.
 
 * *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.
+* *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*
 
+*app_id*, *status*, *cookie*, *xfbml*, *locale*, *selector*, and the various FB.ui parameters also have \_js variants which insert Javascript to calculate the value at runtime.  These Javascript snippets must be expressions, not full statements.  If a \_js option is present, the non-\_js version of the option is ignored.
+
 ## Usage
 
 The simplest usage (given you specified your project's Facebook Application ID) is as follows:
@@ -60,8 +65,14 @@ The simplest usage (given you specified your project's Facebook Application ID)
 
 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.
 
+You can find more usage examples at [Railslove blogpost](http://railslove.com/weblog/2011/02/22/introducing-simple-facebook-share-gem/) about this gem.
+
 ## Changelog
 
+v0.0.6
+
+* [[Brent Royal-Gordon](https://github.com/brentdax)] - Added \_js keys
+
 v0.0.5
 
 * Added support for [Dojo framework](http://dojotoolkit.org/)

data/lib/facebook_share.rb

@@ -44,7 +44,9 @@ JS
     case options[:framework]
     when :dojo
       script << <<-JS
-dojo.query("#{options[:selector]}").onclick(function(evt){
+if (typeof ___facebook_share_evt != "undefined") dojo.disconnect(___facebook_share_evt);
+var ___facebook_share_obj = dojo.query("#{options[:selector]}")
+  , ___facebook_share_evt = dojo.connect(___facebook_share_obj, 'onclick', null, function(evt) {
 #{facebook_share_code(options)}
 });
 JS
@@ -90,11 +92,24 @@ JS
       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))
+        should_add_param = ( for_init ) ? FacebookShare::INIT_PARAMS.include?(key.to_s) : !(FacebookShare::REMOVE_PARAMS.include?(key.to_s))
+        
+        if key.to_s !~ /_js$/ and options[(key.to_s + "_js").to_sym]
+          should_add_param = false
+        end
 
-        if value && param_check
-          value_sanitized = value.to_s.gsub(/"/, '\"')
-          script << ", #{key}: \"#{value_sanitized}\""
+        if value && should_add_param
+          inserted_key = key.to_s
+          inserted_value = value
+          
+          if inserted_key =~ /_js$/
+            inserted_key = inserted_key[0, inserted_key.length - 3]
+          else
+            value_sanitized = inserted_value.to_s.gsub(/"/, '\"')
+            inserted_value = %Q("#{value_sanitized}")
+          end
+          
+          script << %Q(, #{inserted_key}: #{inserted_value})
         end
       end
       script

data/lib/facebook_share/version.rb

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

data/spec/facebook_share/facebook_share_spec.rb

@@ -47,6 +47,51 @@ describe FacebookShare do
     end
   end
 
+  describe "building params with _js" do
+    before(:all) do
+      @options = {
+        :app_id => "123123123",
+
+        :selector => "#some_fancy > .selector",
+        :display => "popup",
+        :link => "http://railslove.com/",
+        :link_js => "some_js_url",
+        :caption_js => %Q("Railslove " + is_the + " best"),
+        
+        :status => "true",
+        :xfbml => "true",
+        :cookie => "false"
+      }
+    end
+    context "when not for_init" do
+      subject { build_params(@options) }
+
+      it { should_not match(/app_id/) }
+      it { should_not match(/cookies/) }
+      it { should_not match(/xfbml/) }
+
+      it { should match(/display: "popup"/) }
+      it { should match(/link: some_js_url/) }
+      it { should match(/caption: "Railslove " \+ is_the \+ " best"/) }
+
+      it { should_not match(/selector: "/) }
+    end
+
+    context "when for_init" do
+      subject { build_params(@options, true) }
+
+      it { should_not match(/app_id/) }
+      it { should match(/cookie: "false"/) }
+      it { should match(/xfbml: "true"/) }
+
+      it { should_not match(/display: "popup"/) }
+      it { should_not match(/link: some_js_url/) }
+      it { should_not match(/caption: "Railslove " \+ is_the \+ " best"/) }
+
+      it { should_not match(/selector: "/) }
+    end
+  end
+
   describe "creating init script" do
     context "when vanilla locale" do
       subject { facebook_connect_js_tag( :locale => "en_US" ) }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: facebook_share
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - "Mike Po\xC5\x82tyn"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 +01:00
+date: 2011-08-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency