google_plus_helper 0.0.2 → 0.0.3

data/google_plus_helper.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/google_plus_helper/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["chitsaou"]
-  gem.email         = ["chitsaou@techbang.com.tw"]
+  gem.authors       = ["chitsaou", "v1nc3ntlaw"]
+  gem.email         = ["chitsaou@techbang.com.tw", "v1nc3ntlaw@techbang.com.tw"]
   gem.description   = %q{Google+ Social Plugins Helpers for Rails}
   gem.summary       = %q{Easily generate Google+ Social Plugins in Rails application}
   gem.homepage      = "https://github.com/techbang/google_plus_helper"

data/lib/google_plus_helper.rb

@@ -1,10 +1,10 @@
 require 'google_plus_helper/settings'
 
-module GooglePlusHelper
+module GooglePlusHelper #:nodoc: all
   class << self
     def settings
-      _settings ||= Settings.new
-      _settings
+      @_settings ||= Settings.new
+      @_settings
     end
   end
 

data/lib/google_plus_helper/engine.rb

@@ -1,6 +1,6 @@
 require "google_plus_helper/helper"
 
-module GooglePlusHelper
+module GooglePlusHelper #:nodoc: all
   class Engine < ::Rails::Engine
     initializer "google_plus_helper.view_helpers" do
       ActionView::Base.send :include, GooglePlusHelper

data/lib/google_plus_helper/helper.rb

@@ -1,8 +1,26 @@
-# https://developers.google.com/+/
-# Currently there is no support for generating Schema.org meta tags.
-# Please use Open Graph tags.
+# GooglePlusHelper helps you generate Google Plus Social Plugins in your Rails application.
+#
+# See README.md for usage.
+#
+# By default it renders HTML5 version. To switch to XML version, specify the version explicitly in initializer:
+#
+#   # config/initializers/google_plus_helper.rb
+#   GooglePlusHelper.config do |config|
+#     config.social_plugin_version = :xml
+#   end
 module GooglePlusHelper
-  # load google plusone javascript
+  # Generates a <tt><script></tt> tag to load Google Plusone JavaScript file.
+  #
+  # The trivial usage is to load synchonously:
+  #   <%= google_plusone_javascript_include_tag %> #=> <script src="..."></script>
+  #
+  # To load the script asynchronously, use:
+  #   <%= google_plusone_javascript_include_tag(:async => true)
+  #
+  # By default it takes "en-US" as display language. Add <tt>:lang</tt> option to change,
+  # e.g. <tt> :lang => "zh-TW"</tt>
+  #
+  # To load in explicit mode, add <tt>:explicit => true</tt> option.
   def google_plusone_javascript_include_tag(*args)
     options = {
       :async => false,
@@ -32,7 +50,9 @@ module GooglePlusHelper
     end
   end
 
-  def google_social_plugin(plugin_name, options, html_options={})
+  # Generates Google+ Social Plugin html structure.
+  #
+  def google_social_plugin(plugin_name, options, html_options={}) #:nodoc:
     case GooglePlusHelper.settings.social_plugin_version
     when :html5
       html_options.merge! :class => "g-#{plugin_name.to_s}", :data => options
@@ -45,11 +65,16 @@ module GooglePlusHelper
     end
   end
 
-  # google_plusone_button generates plusone button for specific URL
+  # Generates the +1 button for specific URL.
+  #
+  # Arguments:
   #
-  # default arguments: (implicitly assigned according to +1 button document)
-  #   size: standard
-  #   annotation: bubble
+  # * <tt>url</tt>: the URL to +1.
+  # * <tt>options</tt>: (optional) a hash that is identical to the +1 Button attributes listed here[https://developers.google.com/+/plugins/+1button/#plusonetag-parameters].
+  #
+  # Example - A +1 button in medium size and without annotation:
+  #
+  #   <%= google_plusone_button("http://example.com", :size => :medium, :annotation => :none)
   def google_plusone_button(url, *args)
     options = args.extract_options!
     options[:href] = url
@@ -58,6 +83,16 @@ module GooglePlusHelper
     google_social_plugin(:plusone, options, html_options)
   end
 
+  # Generates the "Share on Google+" button for specific URL.
+  #
+  # Arguments:
+  #
+  # * <tt>url</tt>: the URL to +1.
+  # * <tt>options</tt>: (optional) a hash that is identical to the Share Button attributes listed here[https://developers.google.com/+/plugins/share/#sharetag-parameters].
+  #
+  # Example - A Share button aligned to right and with vertical-bubble annotation:
+  #
+  #   <%= google_share_button("http://example.com", :align => :right, :annotation => "vertical-bubble")
   def google_share_button(url, *args)
     options = args.extract_options!
     options.merge! :href => url, :action => :share

data/lib/google_plus_helper/railtie.rb

@@ -1,6 +1,6 @@
 require "google_plus_helper/helper"
 
-module GooglePlusHelper
+module GooglePlusHelper #:nodoc: all
   class Railtie < Rails::Railtie
     initializer "google_plus_helper.view_helpers" do
       ActionView::Base.send :include, GooglePlusHelper

data/lib/google_plus_helper/settings.rb

@@ -1,4 +1,4 @@
-module GooglePlusHelper
+module GooglePlusHelper #:nodoc: all
   class Settings
     attr_accessor :social_plugin_version
 

data/lib/google_plus_helper/version.rb

@@ -1,3 +1,3 @@
-module GooglePlusHelper
-  VERSION = "0.0.2"
+module GooglePlusHelper #:nodoc: all
+  VERSION = "0.0.3"
 end

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: google_plus_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
 - chitsaou
+- v1nc3ntlaw
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -13,7 +14,7 @@ date: 2012-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2160571500 !ruby/object:Gem::Requirement
+  requirement: &2156424520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,11 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160571500
+  version_requirements: *2156424520
 description: Google+ Social Plugins Helpers for Rails
 email:
 - chitsaou@techbang.com.tw
+- v1nc3ntlaw@techbang.com.tw
 executables: []
 extensions: []
 extra_rdoc_files: []