octopress-social 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 897b85017a8b777f4c2e525da305201fed073713
-  data.tar.gz: 125b92d5eee580aaf1aa6c901ae68c5c814a4bfe
+  metadata.gz: 5157a05a1fccbd57123bf4552f7970b5b494275e
+  data.tar.gz: 78e06a1c549a635fd4b8a3af32d2f7d9901ed943
 SHA512:
-  metadata.gz: 23ef92ea65bdfd4c49e1663ffc36c0c5c4326dc6917a9d225f249163a1981b6b29efc424efb9d83f0b0c2c0580d712d9473033ec11f896b4fc5a8c9e63b7440a
-  data.tar.gz: c36bd80d6775eb098d9f155d09d501217b3f034f3d0395beb47f70495ad17a57f1ab2474d5d6bb4d7e8bb4dbccca39ec3fd1dd1f8ec21943c66c78c4eb891999
+  metadata.gz: 5e398203937ab5aea38b6255f32548f697582bbdb7a1444c368b91e60fdb5433a4d81c42c7569edd66dc86f2e5c2c3a9cd0de2bee685cf101b0179cf4c2dda7e
+  data.tar.gz: ac1ed24e4847b75aa507a39e7610aeac082b6a7faceb737ffddac5d05a9bf95906dfbca085bd50a846b61bf731bdd6fd8fe0a2e1bc4a14f8c6f76a42fde116de

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### 1.4.0 (2015-03-24)
+- New: Email sharing and contact tags
+- New: GitHub profile link
+- New: All links now have title attribute set.
+
 ### 1.3.0 (2015-03-21)
 - New: Embeddable tweets with {% tweet %} tag.
 - Fixed: Default tweet message (without configured username) removes 'by' credit.

data/README.md

@@ -1,6 +1,6 @@
 # Octopress Social
 
-Easy social integrations with Twitter, Facebook, and Google+ with fancy buttons or plain-old links.
+Easy social integrations with Twitter, Facebook, Google+, Email and GitHub on any Jekyll site.
 
 [![Build Status](http://img.shields.io/travis/octopress/social.svg)](https://travis-ci.org/octopress/social)
 [![Gem Version](http://img.shields.io/gem/v/octopress-social.svg)](https://rubygems.org/gems/octopress-social)
@@ -29,16 +29,15 @@ Then add the gem to your Jekyll configuration.
 
 ## Basics
 
-To integrate these social services, you'll need to add some minimal configurations;
-usually just a username or user id.
+All configuration for this plugin is optional. Some features, like follow buttons or comment tags require username. Other than that all configurations are only necessary if you want to modify the output of the tags.
 
-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.
+Configurations are set in your site's `_config.yml`. If for some reason these configurations conflict with another plugin, you can set them under the `octopress_social` key.
+
+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`. You really only need to configure
-`username`, but these are the defaults
+Configure this plugin in your site's `_config.yml`. No configurations are required, just add your username if you want to use follow buttons or be mentioned in tweets. Here are the configuration defaults.
 
 ```yaml
 twitter:
@@ -50,7 +49,8 @@ twitter:
   embedded_link_color:           # Set link color for embedded tweets
 
   follow_count:        false     # Show number of followers
-  profile_link_text:   "Follow :username"
+  profile_link_text:   Follow :username
+  profile_link_title:  Follow :username on Twitter  # profile link title text
 ```
 
 To include hashtags, in your tweet message add them in the YAML front matter of your post or page, like this:
@@ -123,8 +123,7 @@ If you include the twitter widget.js in your site, this will automatically be re
 
 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`.
+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]`.
 
@@ -141,8 +140,10 @@ facebook:
   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"
+  share_link_text:     Facebook            # Text for plain-old link
+  share_link_title:    Share on Facebook   # Share link title text
+  profile_link_text:   Friend on Facebook
+  profile_link_title:  Friend on Facebook  # profile link title text
 
   comment_count:       5             # Number of facebook comments to show by default
   comments_link_text:     Comments
@@ -192,17 +193,19 @@ Embed Facebook comments widget:
 
 ## Google+
 
-Configure this plugin in your site's `_config.yml`.
+Configure this plugin in your site's `_config.yml`. The only required configuration is your user id. Here are the defaults.
 
 ```yaml
 gplus:
-  id:                             # Your Google+ userid (for follow button or profile link)
-  size:              medium       # choices: small, medium, standard, large
-  width:                          # Specify width of button
-  share_count:       false        # Show number of shares or +1s
-  follow_count:      false        # Show numer of followers
-  share_link_text:   Google+      # Text for plain-old link
-  profile_link_text: "Follow on Google+"
+  id:                              # Your Google+ userid (for follow button or profile link)
+  size:               medium       # choices: small, medium, standard, large
+  width:                           # Specify width of button
+  share_count:        false        # Show number of shares or +1s
+  follow_count:       false        # Show numer of followers
+  share_link_text:    Google+      # Text for plain-old link
+  share_link_title:   Share on Google+   # Share link title
+  profile_link_text:  Follow on Google+
+  profile_link_title: Follow on Google+  # Profile link title
 ```
 
 These configurations are based on Google's [web sharing widgets](https://developers.google.com/+/web/+1button/).
@@ -230,9 +233,51 @@ Follow tags:
 {% gplus_profile_link %}
 ```
 
+## Email sharing
+
+Add convenient `mail:to` links which which helps readers
+contact you, or share your articles over email.
+
+```yaml
+author:                # Your name
+
+email:
+  address:             # Your contact email
+  share_subject:       :title by :author
+  share_message:       :title by :author - :url
+  share_link_text:     Email
+  contact_link_text:   Email :author
+  contact_link_title:  Email :author
+```
+
+The `share_subject` and `share_message` configurations are
+used to generate a subject and body for a sharing email link.
+
+### Email Tags
+
+```
+{% email_share_link %}    # Share a post or page over email
+{% email_contact_link %}  # Contac the site's author
+```
+
+If you want, you may customize an email subject or message on
+any page or post by setting the `email_share_subject` and
+`email_share_message` variables in the YAML front-matter.
+
+## GitHub
+
+For now, this will just generate a GitHub profile link for you. Perhaps eventually I'll do some cool stuff with the API and project listing. Configure this plugin in your site's `_config.yml`.
+
+```yaml
+github:
+  username:                                  # Your GitHub username
+  profile_link_text:  :username on GitHub
+  profile_link_title: :username on GitHub    # profile link title text
+```
+
 ## Disqus Comments
 
-Configure this plugin in your site's `_config.yml` and optionally on each page or post.
+Configure this plugin in your site's `_config.yml`. The only required configuration is your Disqus shortname. Here are the defaults.
 
 ```yaml
 disqus:

data/lib/octopress-social/disqus.rb

@@ -6,12 +6,16 @@ module Octopress
       attr_accessor :url, :config
 
       DEFAULTS = {
-        'comments_link_text' => 'Comments',
+        'comments_link_text'     => 'Comments',
+        'comments_link_title'    => 'View comments',
         'disabled_comments_text' => 'Comments disabled'
       }
 
       def set_config(site)
-        @config ||= DEFAULTS.merge(site['disqus'] || {})
+        @config ||= begin
+          config = site['octopress_social'] || site
+          DEFAULTS.merge(config['disqus'] || {})
+        end
       end
 
       def set_url(site, item)
@@ -53,7 +57,7 @@ module Octopress
         if item['comments'] != false
           link = (item['context'] == 'page' ? '' : url)
           link << '#disqus_thread'
-          %Q{<a class="disqus-comments-link" href="#{link}">Comments</a>}
+          %Q{<a class="disqus-comments-link" title="#{config['comments_link_title']}" href="#{link}">Comments</a>}
         elsif !config['disabled_comments_text'].empty?
           %Q{<span class="disqus-comments-disabled">#{config['disabled_comments_text']}</span>}
         else

data/lib/octopress-social/email.rb

@@ -0,0 +1,89 @@
+module Octopress
+  module Social
+    module Email
+      extend self
+
+      attr_accessor :url, :config
+
+      DEFAULTS = {
+        'share_subject'       => ':title by :author',
+        'share_message'       => ':title by :author - :url',
+        'share_link_text'     => 'Email',
+        'contact_link_text'   => 'Email :author',
+        'contact_link_title'  => 'Email :author',
+        'address'             => nil
+      }
+
+      def set_config(site)
+        @config ||= begin
+          config = site['octopress_social'] || site
+          DEFAULTS.merge(config['email'] || {})
+        end
+      end
+
+      def contact_link_text(item)
+        config['contact_link_text'].sub(':author', author(item))
+      end
+
+      def contact_link_title(item)
+        config['contact_link_title'].sub(':author', author(item))
+      end
+
+      def set_url(site, item)
+        @url = Social.full_url(site, item)
+      end
+
+      def author(item={})
+        item['author'] || item['site']['author'] || ''
+      end
+
+      def subject(site, item)
+        name = author(item)
+        author_var = (name.empty? ? 'by :author' : ':author')
+        ERB::Util.url_encode (item['email_share_subject'] || config['share_subject'])
+          .sub(':title', item['title'] || '')
+          .sub(author_var, name)
+          .strip
+      end
+
+      def message(site, item)
+        name = author(item)
+        author_var = (name.empty? ? 'by :author' : ':author')
+        ERB::Util.url_encode (item['email_share_message'] || config['share_message'])
+          .sub(':title', item['title'] || '')
+          .sub(author_var, name)
+          .sub(':url', url)
+          .strip
+      end
+
+      def email_share_link(site, item)
+        %Q{<a class="email-share-link" href="mailto:?subject=#{subject(site, item)}&body=#{message(site, item)}">#{config['share_link_text']}</a>}
+      end
+
+      def email_contact_link(site, item)
+        %Q{<a
+          class="email-contact-link"
+          href="mailto:#{config['address']}"
+          title="#{contact_link_title(item)}">#{contact_link_text(item)}</a>}
+      end
+
+      class Tag < Liquid::Tag
+        def initialize(tag, input, tokens)
+          @tag = tag.strip
+          @input = input.strip
+        end
+
+        def render(context)
+          site = context['site']
+          item = Octopress::Social.item(context, @input)
+          item['site'] = site
+
+          Octopress::Social::Email.set_config(site)
+          Octopress::Social::Email.set_url(site, item)
+          Octopress::Social::Email.send(@tag, site, item).gsub(/(\s{2,}|\n)/, ' ').strip
+        end
+      end
+
+    end
+  end
+end

data/lib/octopress-social/facebook.rb

@@ -6,23 +6,28 @@ module Octopress
       attr_accessor :url, :config
 
       DEFAULTS = {
-        'profile_id'        => nil,
-        'app_id'            => nil,
-        'layout'            => 'button',
-        'action'            => 'like',
-        'show_faces'        => false,
-        'share'             => false,
-        'colorscheme'       => 'light',
-        'kid_directed_site' => false,
-        'comment_count'     => 5,
-        'share_link_text'   => 'Facebook',
-        'profile_link_text' => 'Friend me on Facebook',
-        'comments_link_text' => 'Comments',
+        'profile_id'           => nil,
+        'app_id'               => nil,
+        'layout'               => 'button',
+        'action'               => 'like',
+        'show_faces'           => false,
+        'share'                => false,
+        'colorscheme'          => 'light',
+        'kid_directed_site'    => false,
+        'comment_count'        => 5,
+        'share_link_text'      => 'Facebook',
+        'share_link_title'     => 'Share on Facebook',
+        'profile_link_text'    => 'Friend on Facebook',
+        'profile_link_title'   => 'Friend on Facebook',
+        'comments_link_text'   => 'Comments',
         'disabled_comments_text' => 'Comments disabled'
       }
 
       def set_config(site)
-        @config ||= DEFAULTS.merge(site['facebook'] || {})
+        @config ||= begin
+          config = site['octopress_social'] || site
+          DEFAULTS.merge(config['facebook'] || {})
+        end
       end
 
       def set_url(site, item)
@@ -34,12 +39,12 @@ module Octopress
           %Q{<a class="facebook-share-link" href="https://www.facebook.com/dialog/share?
           app_id=#{config['app_id']}
           &href=#{url}&redirect_uri=#{url}"
-          target="_blank">#{config['share_link_text']}</a>
+          title="#{config['share_link_title']}">#{config['share_link_text']}</a>
           }
         else
           %Q{<a class="facebook-share-link" 
           href="https://www.facebook.com/sharer/sharer.php?u=#{url}" 
-          target="_blank">#{config['share_link_text']}</a>}
+          title="#{config['share_link_title']}">#{config['share_link_text']}</a>}
         end
       end
 
@@ -57,7 +62,11 @@ module Octopress
       end
 
       def facebook_profile_link(*args)
-        %Q{<a class="facebook-profile-link" href="https://www.facebook.com/#{config['profile_id']}">#{config['profile_link_text']}</a>}
+        %Q{<a
+          class="facebook-profile-link"
+          href="https://www.facebook.com/#{config['profile_id']}"
+          title="#{config['profile_link_title']}"
+          >#{config['profile_link_text']}</a>}
       end
 
       def facebook_follow_button(*args)

data/lib/octopress-social/github.rb

@@ -0,0 +1,63 @@
+module Octopress
+  module Social
+    module GitHub
+
+      attr_accessor :config
+
+      extend self
+
+      DEFAULTS = {
+        'username'            => nil,
+        'profile_link_text'   => ':username on GitHub',
+        'profile_link_title'  => ':username on GitHub',
+      }
+
+      def set_config(site)
+        @config ||= begin
+          config = site['octopress_social'] || site
+          DEFAULTS.merge(config['github'] || {})
+        end
+      end
+
+      def username(item={})
+        config['username'] || ''
+      end
+
+      def profile_link_text
+        config['profile_link_text'].sub(':username', username)
+      end
+
+      def profile_link_title
+        config['profile_link_title'].sub(':username', username)
+      end
+
+      def github_profile_link
+        %Q{<a
+          class="github-profile-link"
+          href="https://github.com/#{username.sub('@', '')}"
+          title="#{profile_link_title}">#{profile_link_text}</a>}
+      end
+
+      def username(item={})
+        if username = item['github_username'] || config['username']
+          "@#{username.sub('@', '')}" # ensure @ mark, but not two.
+        else
+          ''
+        end
+      end
+
+      class Tag < Liquid::Tag
+        def initialize(tag, input, tokens)
+          @tag = tag.strip
+          @input = input.strip
+        end
+
+        def render(context)
+          Octopress::Social::GitHub.set_config(context['site'])
+          Octopress::Social::GitHub.send(@tag).gsub(/(\s{2,}|\n)/, ' ').strip
+        end
+      end
+
+    end
+  end
+end

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

@@ -3,12 +3,16 @@ module Octopress
     module GooglePlus
       extend self
 
+      attr_accessor :url, :config
+
       DEFAULTS = {
-        'size'              => 'medium',
-        'count_bubble'      => false,
-        'share_link_text'   => 'Google+',
-        'profile_link_text' => 'Follow on Google+',
-        'width'             => ''
+        'size'                => 'medium',
+        'count_bubble'        => false,
+        'share_link_text'     => 'Google+',
+        'share_link_title'    => 'Share on Google+',
+        'profile_link_text'   => 'Follow on Google+',
+        'profile_link_title'  => 'Follow on Google+',
+        'width'               => ''
       }
 
       HEIGHT = {
@@ -18,11 +22,17 @@ module Octopress
       }
 
       def config(site=nil)
-        @config ||= DEFAULTS.merge(site['gplus'] || {})
+        @config ||= begin
+          config = site['octopress_social'] || site
+          DEFAULTS.merge(config['gplus'] || {})
+        end
       end
 
       def gplus_share_link(site, item)
-        %Q{<a class="g-plus-share-link" href="https://plus.google.com/share?url=#{Social.full_url(site, item)}" target="_blank">#{config['share_link_text']}</a>}
+        %Q{<a 
+          class="g-plus-share-link"
+          href="https://plus.google.com/share?url=#{Social.full_url(site, item)}"
+          title="#{config['share_link_title']}">#{config['share_link_text']}</a>}
       end
 
       def gplus_one_button(site, item)
@@ -38,7 +48,11 @@ module Octopress
       end
 
       def gplus_profile_link(*args)
-        %Q{<a class="g-plus-profile-link" href="//plus.google.com/u/0/#{config['userid']}">#{config['profile_link_text']}</a>}
+        %Q{<a
+          class="g-plus-profile-link"
+          href="//plus.google.com/u/0/#{config['userid']}"
+          title="#{config['profile_link_title']}"
+          >#{config['profile_link_text']}</a>}
       end
 
       def count(type)

data/lib/octopress-social/twitter.rb

@@ -6,16 +6,21 @@ module Octopress
       attr_accessor :url, :config
 
       DEFAULTS = {
-        'tweet_message'     => ":title by :username :hashtags - :url",
-        'size'              => 'normal',
-        'tweet_count'       => false,
-        'follow_count'      => false,
-        'tweet_link_text'   => "Twitter",
-        'profile_link_text' => "Follow :username"
+        'tweet_message'       => ":title by :username :hashtags - :url",
+        'size'                => 'normal',
+        'tweet_count'         => false,
+        'follow_count'        => false,
+        'tweet_link_text'     => "Twitter",
+        'tweet_link_title'    => "Share on Twitter",
+        'profile_link_text'   => "Follow :username",
+        'profile_link_title'  => "Follow :username on Twitter",
       }
 
       def set_config(site)
-        @config = DEFAULTS.merge(site['twitter'] || {})
+        @config ||= begin
+          config = site['octopress_social'] || site
+          DEFAULTS.merge(config['twitter'] || {})
+        end
       end
 
       def set_url(site, item)
@@ -23,7 +28,10 @@ module Octopress
       end
 
       def tweet_link(site, item)
-        %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>}
+        %Q{<a 
+          class="twitter-share-link"
+          href="https://twitter.com/intent/tweet?&text=#{ERB::Util.url_encode(message(site, item)).strip}"
+          title="#{config['tweet_link_title']}">#{config['tweet_link_text']}</a>}
       end
 
       def tweet_button(site, item)
@@ -51,6 +59,10 @@ module Octopress
           .join(' ')
       end
 
+      def profile_link_title(item={})
+        config['profile_link_title'].sub(':username', username)
+      end
+
       def message(site, item)
         username_var = (username(item).empty? ? 'by :username' : ':username')
         (item['tweet_message'] || config['tweet_message'])
@@ -70,7 +82,10 @@ module Octopress
       end
 
       def twitter_profile_link(*args)
-        %Q{<a href="https://twitter.com/#{username.sub('@', '')}" class="twitter-follow-link">#{profile_link_text}</a>}
+        %Q{<a
+          class="twitter-profile-link"
+          href="https://twitter.com/#{username.sub('@', '')}"
+          title="#{profile_link_title}">#{profile_link_text}</a>}
       end
 
       def twitter_follow_button(*args)

data/lib/octopress-social/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Social
-    VERSION = "1.3.0"
+    VERSION = "1.4.0"
   end
 end

data/lib/octopress-social.rb

@@ -1,5 +1,6 @@
-require "octopress-social/version"
-require "liquid"
+require 'octopress-social/version'
+require 'liquid'
+require 'erb'
 
 module Octopress
   module Social
@@ -9,6 +10,8 @@ module Octopress
     autoload :Facebook,       'octopress-social/facebook'
     autoload :GooglePlus,     'octopress-social/google-plus'
     autoload :Disqus,         'octopress-social/disqus'
+    autoload :Email,          'octopress-social/email'
+    autoload :GitHub,         'octopress-social/github'
     
     def full_url(site, item)
       unless root = site['url']
@@ -55,6 +58,9 @@ Liquid::Template.register_tag('facebook_comments_link', Octopress::Social::Faceb
 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_comments_link', Octopress::Social::Disqus::Tag)
+Liquid::Template.register_tag('email_share_link', Octopress::Social::Email::Tag)
+Liquid::Template.register_tag('email_contact_link', Octopress::Social::Email::Tag)
+Liquid::Template.register_tag('github_profile_link', Octopress::Social::GitHub::Tag)
 
 if defined? Octopress::Docs
   Octopress::Docs.add({

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-social
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -91,7 +91,9 @@ files:
 - README.md
 - lib/octopress-social.rb
 - lib/octopress-social/disqus.rb
+- lib/octopress-social/email.rb
 - lib/octopress-social/facebook.rb
+- lib/octopress-social/github.rb
 - lib/octopress-social/google-plus.rb
 - lib/octopress-social/twitter.rb
 - lib/octopress-social/version.rb