octopress-social 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ad8a7ece7e30fbc6fce89ea3753d9eaf13355c8
-  data.tar.gz: b4f122dce2d3e6ea8648372350925946a809dcd2
+  metadata.gz: fc69b51e6a1d4ccc410094fede2aee2d4d6af2a7
+  data.tar.gz: 909c4cb057c933360f3e35781217685f8e976b66
 SHA512:
-  metadata.gz: 984ee78928c0d0c68bda2eb965364fdc0e27c4b6ba38413ee6cfd3e047cd5dfb27755dac7d0145ddf57b0fc3327d242b4303dd084287c88b9304c0495f5a50ea
-  data.tar.gz: 9f7234ac4585cfbecffc5a8ce6ceb0b8b7125e6b08393a6c28e9a0215c9b3bba222cac7e8a4c2fabd9f83aa7d072a8c995c92849c894b630fbabdd7333214762
+  metadata.gz: 6715d8246cc3b68020c5b9697625515a112317d71d0ff74826996596884778286b7c4b0d61f8e2c6593ff86caf876584841370333793ae4b09153d6d68886a06
+  data.tar.gz: 59df88675057d14007087997e82dcfeccd22530a94559a26c58f6a65b5a2bab41a070812ade795c91d357ad5d9a16c0df3f3d4f99f266afd69da68c1694d3f8a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 1.2.0 (2015-03-18)
+- New: Added Disqus comments link tag.
+- New: Facebook comments link tag.
+- New: Tags auto-detect context (sharing a post or the current page).
+- Fixed: Hashtags are added on tweet link.
+
 ### 1.1.0 (2015-03-17)
 - New: Added support Disqus comments.
 - New: Disable Facebook comments on any page or post with `comments: false`.

data/README.md

@@ -27,19 +27,28 @@ Then add the gem to your Jekyll configuration.
     gems:
       - octopress-social
 
+## Basics
+
+To integrate these social services, you'll need to add some minimal configurations;
+usually just a username or user id.
+
+All tags respond to context. For example, in a post loop, `{% tweet_button %}` will
+automatically point to the current post. Used outside of a post loop, tags will refer to the current page.
+
 ## Twitter
 
-Configure this plugin in your site's `_config.yml`.
+Configure this plugin in your site's `_config.yml`. You really only need to configure
+`username`, but these are the defaults
 
 ```yaml
 twitter:
   username:                      # Add your Twitter handle
-  tweet_count:         false     # show number of shares on Twitter
-  size:                normal    # or large
+  tweet_count:         false     # Show number of shares on Twitter
+  size:                normal    # Or large
   tweet_link_text:     Twitter   # Configure the link text
-  tweet_message:       ":title by :username - :url :hashtags"
+  tweet_message:       ":title by :username :hashtags - :url" # With Tweet button Twitter add the URL last
 
-  follow_count:        false     # show number of followers
+  follow_count:        false     # Show number of followers
   profile_link_text:   "Follow :username"
 ```
 
@@ -80,11 +89,10 @@ To use Twitter's fancy buttons you'll need to add this tag to your site's layout
 Sharing tags:
 ```
 {% tweet_button %}
-{% tweet_button post %}
-{% tweet_link %}          # tweet with a (no js) link
+{% tweet_link %}          # Tweet with a (no js) link
 ```
 
-The tweet button and tweet link will open a new page with a composed tweet in the format in your Twitter configuration, `:title by :username - :url :hashtags`. If you want tweet buttons to show up on post index or archive pages, add the `post` argument to the tweet button tag.
+The tweet button and tweet link will open a new page with a composed tweet in the format in your Twitter configuration, `:title by :username - :url :hashtags`. 
 
 Follow tags:
 
@@ -97,6 +105,13 @@ Follow tags:
 
 Configure this plugin in your site's `_config.yml`.
 
+You don't need to configure anything to start using this plugin but if you want to
+use the follow button or profile link, you'll need to add your `profile_id`.
+
+To get your `profile_id`, take a section from the url to your profile page `https://www.facebook.com/[profile_id]`.
+
+Here are the defaults:
+
 ```yaml
 facebook:
   app_id:                            # For a nicer (no js) sharing experience
@@ -107,16 +122,22 @@ facebook:
   show_faces:          false
   colorscheme:         light         # Or dark
   kid_directed_site:   false         # Is your site directed at kids under 13?
+
   share_link_text:     Facebook      # Text for plain-old link
   profile_link_text:   "Find me on Facebook"
+
   comment_count:       5             # Number of facebook comments to show by default
+  comments_link_text:     Comments
+  disabled_comments_text: Comments disabled  # Set to '' to output nothing when comments are disabled
 ```
 
 These configurations are all based on [Facebook's widget configuration spec](https://developers.facebook.com/docs/plugins/), visit that site for more info.
 
-To get your `profile_id`, take a section from the url to your profile page `https://www.facebook.com/[profile_id]`.
 
-To get an `app_id` you'll need to [register](https://developers.facebook.com/apps) as a developer and go through the process to create an
+### Facebook APP ID
+
+If you want to use the fancy share link (lets you set default content for the share),
+you'll need to get an `app_id`. For that you'll have to [register](https://developers.facebook.com/apps) as a developer and go through the process to create an
 'app'. This is free and it doesn't mean you're developing software or anything, it's just how Facebook wants to do this. Once you've
 created an app, go to the "Basic settings page" by clicking settings, and then finding the "Basic" link. There you should be able to find
 your App ID.
@@ -148,6 +169,7 @@ Embed Facebook comments widget:
 
 ```
 {% facebook_comments %}
+{% facebook_comments_link %}   # Add a link that jumps right to your comments section.
 ```
 
 ## Google+
@@ -180,7 +202,7 @@ Sharing tags:
 ```
 {% gplus_one_button %}
 {% gplus_share_button %}
-{% gplus_share_link %}   # share with a (no js) link
+{% gplus_share_link %}   # Share with a (no js) link
 ```
 
 Follow tags:
@@ -195,7 +217,10 @@ Follow tags:
 Configure this plugin in your site's `_config.yml` and optionally on each page or post.
 
 ```yaml
-disqus_shortname:          # Your site's disqus identifier
+disqus:
+  shortname:                                       # Your site's disqus identifier
+  comments_link_text: Comments                     # Text label for comments link
+  comments_disabled_link_text: Comments disabled   # Set to '' to not output a comments link when disabled
 ```
 
 In any page or post, you can add these configurations to the YAML front-matter.
@@ -206,32 +231,16 @@ disqus_title:          # Custom title for comments metadata (defaults to page/po
 comments: false        # Disable comments for this page or post
 ```
 
-### Tags
+### Disqus Tags
 
 These tags will help you integrate Disqus comments into your site.
 
 ```
-{% disqus_comments %}      # Embed comments on a page
-```
-
-If you want to link directly to the comments section of a post or page, create a link like this:
-
-```
-{% disqus_comments_link %}        # link to the comments section on the current page
-{% disqus_comments_link post %}   # link to the comments section on a post (in the posts loop)
+{% disqus_comments %}       # Embed comments on a page
+{% disqus_comments_link %}  # Add a link that jumps right to your comments section.
 ```
 
-This will generate a link to the page or post with the on page anchor `#disqus_thread` added, linking you directly to the comments
-section.
-
-If you want to show the number of comments in the link, add the following tag to your page layout, somewhere before `</body>`.
-
-```
-{% disqus_count_script %}  # Add script for adding counts to comment links
-```
-
-This tag will find all comments links on the current page and add the comment count. You can configure this link text from your the admin panel on Disqus's site.
-
+Disqus has a script that lets you add comment count to the link, but it's so buggy, I'm not including it because I don't want to deal with the support. You can still add it to your site manually.
 
 ## Contributing
 

data/lib/octopress-social/disqus.rb

@@ -3,49 +3,64 @@ module Octopress
     module Disqus
       extend self
 
-      def config(site=nil)
-        @config ||= site['disqus_shortname']
+      attr_accessor :url, :config
+
+      DEFAULTS = {
+        'comments_link_text' => 'Comments',
+        'disabled_comments_text' => 'Comments disabled'
+      }
+
+      def set_config(site)
+        @config ||= DEFAULTS.merge(site['disqus'] || {})
       end
 
-      def url(site, item)
-        Social.full_url(site, item)
+      def set_url(site, item)
+        @url = Social.full_url(site, item)
       end
 
       def identifier(site, item)
-        item['disqus_identifier'] || url(site, item)
+        item['disqus_identifier'] || url
       end
 
       def disqus_comments(site, item)
-        %Q{<div id="disqus_thread"></div>
-          <script type="text/javascript">
-            var disqus_shortname = '#{config}';
-            var disqus_url = '#{url(site, item)}';
-            var disqus_identifier = '#{identifier(site, item)}';
-            var disqus_title = '#{item['title']}';
-            #{embed_script('embed')}
-          </script>
-          <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
-        }
-      end
-
-      def disqus_count_script(site, item)
-        %Q{<script type="text/javascript">
-        var disqus_shortname = '#{config}';
-        #{embed_script('count')}
-        </script>  
-        }
+        if item['comments'] != false
+          %Q{<div id="disqus_thread"></div>
+            <script type="text/javascript">
+              var disqus_shortname = '#{config['shortname']}';
+              var disqus_url = '#{url}';
+              var disqus_identifier = '#{identifier(site, item)}';
+              var disqus_title = '#{item['title']}';
+              #{embed_script('embed')}
+            </script>
+            <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
+          }
+        else
+          ''
+        end
       end
 
       def embed_script(script)
         %Q{(function () {
             var s = document.createElement('script'); s.async = true;
             s.type = 'text/javascript';
-            s.src = '//#{config}.disqus.com/#{script}.js';
+            s.src = '//#{config['shortname']}.disqus.com/#{script}.js';
             (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
           }());
         }
       end
 
+      def disqus_comments_link(site, item)
+        if item['comments'] != false
+          link = (item['context'] == 'page' ? '' : url)
+          link << '#disqus_thread'
+          %Q{<a class="disqus-comments-link" href="#{link}">Comments</a>}
+        elsif !config['disabled_comments_text'].empty?
+          %Q{<span class="disqus-comments-disabled">#{config['disabled_comments_text']}</span>}
+        else
+          ''
+        end
+      end
+
       class Tag < Liquid::Tag
         def initialize(tag, input, tokens)
           @tag = tag.strip
@@ -53,13 +68,12 @@ module Octopress
         end
 
         def render(context)
-          item = context[@input] || context['page']
-          site = context['site']
+          site   = context['site']
+          item   = Octopress::Social.item(context, @input)
 
-          config = Octopress::Social::Disqus.config(site)
-          if config && item['comments'] != false
-            Octopress::Social::Disqus.send(@tag, site, item).gsub(/(\s{2,}|\n)/, ' ').strip
-          end
+          Octopress::Social::Disqus.set_config(site)
+          Octopress::Social::Disqus.set_url(site, item)
+          Octopress::Social::Disqus.send(@tag, site, item).gsub(/(\s{2,}|\n)/, ' ').strip
         end
       end
     end

data/lib/octopress-social/facebook.rb

@@ -3,6 +3,8 @@ module Octopress
     module Facebook
       extend self
 
+      attr_accessor :url, :config
+
       DEFAULTS = {
         'profile_id'        => nil,
         'app_id'            => nil,
@@ -14,15 +16,20 @@ module Octopress
         'kid_directed_site' => false,
         'comment_count'     => 5,
         'share_link_text'   => 'Facebook',
-        'profile_link_text' => 'Friend me on Facebook'
+        'profile_link_text' => 'Friend me on Facebook',
+        'comments_link_text' => 'Comments',
+        'disabled_comments_text' => 'Comments disabled'
       }
 
-      def config(site=nil)
+      def set_config(site)
         @config ||= DEFAULTS.merge(site['facebook'] || {})
       end
 
+      def set_url(site, item)
+        @url = Social.full_url(site, item)
+      end
+
       def facebook_share_link(site, item)
-        url = Social.full_url(site, item)
         if config['app_id']
           %Q{<a class="facebook-share-link" href="https://www.facebook.com/dialog/share?
           app_id=#{config['app_id']}
@@ -38,7 +45,7 @@ module Octopress
 
       def facebook_like_button(site, item)
         %Q{<div class="fb-like"
-          data-href="#{Social.full_url(site, item)}"
+          data-href="#{url}"
           #{width}
           data-layout="#{config['layout']}"
           data-action="#{config['action']}"
@@ -66,7 +73,7 @@ module Octopress
 
       def facebook_send_button(site, item)
         %Q{<div class="fb-send" 
-          data-href="#{Social.full_url(site, item)}"
+          data-href="#{url}"
           #{width}
           data-colorscheme="#{config['colorscheme']}"
           data-kid-directed-site="#{config['kid_directed_site']}"></div>
@@ -96,8 +103,8 @@ module Octopress
 
       def facebook_comments(site, item)
         if item['comments'] != false
-          %Q{<div class="fb-comments" 
-          data-href="#{Social.full_url(site, item)}" 
+          %Q{<div class="fb-comments" id="facebook_comments"
+          data-href="#{url}" 
           data-numposts="#{config['comment_count']}" 
           data-colorscheme="#{config['colorscheme']}"
           ></div>}
@@ -106,6 +113,18 @@ module Octopress
         end
       end
 
+      def facebook_comments_link(site, item)
+        if item['comments'] != false
+          link = (item['context'] == 'page' ? '' : url)
+          link << '#facebook_comments'
+          %Q{<a class="facebook-comments-link" href="#{link}">Comments</a>}
+        elsif !config['disabled_comments_text'].empty?
+          %Q{<span class="facebook-comments-disabled">#{config['disabled_comments_text']}</span>}
+        else
+          ''
+        end
+      end
+
       class Tag < Liquid::Tag
         def initialize(tag, input, tokens)
           @tag = tag.strip
@@ -113,10 +132,11 @@ module Octopress
         end
 
         def render(context)
-          item = context[@input] || context['page']
+          item = Octopress::Social.item(context, @input)
           site = context['site']
 
-          Octopress::Social::Facebook.config(site)
+          Octopress::Social::Facebook.set_url(site, item)
+          Octopress::Social::Facebook.set_config(site)
           Octopress::Social::Facebook.send(@tag, site, item).gsub(/(\s{2,}|\n)/, ' ').strip
         end
       end

data/lib/octopress-social/google-plus.rb

@@ -89,7 +89,7 @@ module Octopress
         end
 
         def render(context)
-          item = context[@input] || context['page']
+          item = Octopress::Social.item(context, @input)
           site = context['site']
 
           Octopress::Social::GooglePlus.config(site)

data/lib/octopress-social/twitter.rb

@@ -3,8 +3,10 @@ module Octopress
     module Twitter
       extend self
 
+      attr_accessor :url, :config
+
       DEFAULTS = {
-        'tweet_message'     => ":title by :username - :url :hashtags",
+        'tweet_message'     => ":title by :username :hashtags - :url",
         'size'              => 'normal',
         'tweet_count'       => false,
         'follow_count'      => false,
@@ -12,12 +14,16 @@ module Octopress
         'profile_link_text' => "Follow :username"
       }
 
-      def config(site=nil)
-        @config ||= DEFAULTS.merge(site['twitter'] || {})
+      def set_config(site)
+        @config = DEFAULTS.merge(site['twitter'] || {})
+      end
+
+      def set_url(site, item)
+        @url = Social.full_url(site, item)
       end
 
       def tweet_link(site, item)
-        %Q{<a class="twitter-share-link" href="https://twitter.com/intent/tweet?&text=#{message(site, item).strip}" target="_blank">#{config['tweet_link_text']}</a>}
+        %Q{<a class="twitter-share-link" href="https://twitter.com/intent/tweet?&text=#{message(site, item).strip.gsub('#', '%23')}" target="_blank">#{config['tweet_link_text']}</a>}
       end
 
       def tweet_button(site, item)
@@ -25,7 +31,7 @@ module Octopress
           <a href="https://twitter.com/share" class="twitter-share-button" 
           #{'data-size="large"' if config['size'] == 'large'}
           #{'data-count="none"' if !config['tweet_count']}
-          #{button_message(site, item)}
+          #{button_message(site, item).sub(/\s?#{url}/, '')}
           data-dnt="true">#{config['tweet_link_text']}</a>
         }
       end
@@ -48,7 +54,7 @@ module Octopress
         (item['tweet_message'] || config['tweet_message'])
           .sub(':title', item['title'] || '')
           .sub(':username', username(item))
-          .sub(':url', Social.full_url(site, item))
+          .sub(':url', url)
           .sub(':hashtags', hashtags(item))
           .strip
       end
@@ -83,10 +89,11 @@ module Octopress
         end
 
         def render(context)
-          item = context[@input] || context['page']
+          item = Octopress::Social.item(context, @input)
           site = context['site']
 
-          Octopress::Social::Twitter.config(site)
+          Octopress::Social::Twitter.set_config(site)
+          Octopress::Social::Twitter.set_url(site, item)
           Octopress::Social::Twitter.send(@tag, site, item).gsub(/(\s{2,}|\n)/, ' ').strip
         end
       end

data/lib/octopress-social/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Social
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/octopress-social.rb

@@ -17,6 +17,19 @@ module Octopress
 
       File.join(root, site['baseurl'], item['url'].sub('index.html', ''))
     end
+
+    def item(context, input)
+      if item = context[input]
+        item['context'] = input
+      elsif item = context['post']
+        item['context'] = 'post'
+      else
+        item = context['page']
+        item['context'] = 'page'
+      end
+
+      item
+    end
   end
 end
 
@@ -37,9 +50,9 @@ Liquid::Template.register_tag('facebook_send_button', Octopress::Social::Faceboo
 Liquid::Template.register_tag('facebook_follow_button', Octopress::Social::Facebook::Tag)
 Liquid::Template.register_tag('facebook_profile_link', Octopress::Social::Facebook::Tag)
 Liquid::Template.register_tag('facebook_comments', Octopress::Social::Facebook::Tag)
+Liquid::Template.register_tag('facebook_comments_link', Octopress::Social::Facebook::Tag)
 Liquid::Template.register_tag('facebook_script_tag', Octopress::Social::Facebook::Tag)
 Liquid::Template.register_tag('disqus_comments', Octopress::Social::Disqus::Tag)
-Liquid::Template.register_tag('disqus_count_script', Octopress::Social::Disqus::Tag)
 Liquid::Template.register_tag('disqus_comments_link', Octopress::Social::Disqus::Tag)
 
 if defined? Octopress::Docs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopress-social
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Brandon Mathis