Merge pull request #14 from jekyll/mention-from-twitter

Author: parkr

README.md

@@ -27,3 +27,22 @@ Hey @benbalter, what do you think of this?
 ```
 
 **Note**: Jekyll Mentions simply turns the @mentions into links, it does not notify the mentioned user.
+
+## Configuration
+
+Have your own social network? No problem. We allow you to configure the base URL of all the mentions.
+
+To change it, add the following to your Jekyll configuration:
+
+```yaml
+jekyll-mentions:
+  base_url: https://twitter.com
+```
+
+If you're lazy like me, you can use this shorthand:
+
+```yaml
+jekyll-mentions: https://twitter.com
+```
+
+Et voilà! Your mentions will now use that base URL instead of the default of `https://github.com`.

lib/jekyll-mentions.rb

@@ -3,13 +3,12 @@
 
 module Jekyll
   class Mentions < Jekyll::Generator
-
     safe true
 
-    URL = "https://github.com"
+    DEFAULT_URL = "https://github.com"
 
-    def initialize(site)
-      @filter = HTML::Pipeline::MentionFilter.new(nil, {:base_url => URL })
+    def initialize(config = Hash.new)
+      @filter = HTML::Pipeline::MentionFilter.new(nil, {:base_url => base_url(config['jekyll-mentions']) })
     end
 
     def generate(site)
@@ -25,5 +24,18 @@ def mentionify(page)
     def html_page?(page)
       page.html? || page.url.end_with?('/')
     end
+
+    def base_url(configs)
+      case configs
+      when nil, NilClass
+        DEFAULT_URL
+      when String
+        configs.to_s
+      when Hash
+        configs.fetch('base_url', DEFAULT_URL)
+      else
+        raise ArgumentError.new("Your jekyll-mentions config has to either be a string or a hash! It's a #{configs.class} right now.")
+      end
+    end
   end
 end

test/test_jekyll_mentions.rb

@@ -6,7 +6,7 @@ class TestJekyllMentions < Minitest::Test
   def setup
     @site = fixture_site
     @site.read
-    @mentions = Jekyll::Mentions.new(@site)
+    @mentions = Jekyll::Mentions.new(@site.config)
     @mention = "test <a href='https://github.com/test' class='user-mention'>@test</a> test"
   end
 
@@ -55,4 +55,39 @@ def setup
     assert_equal "Parker \"<a href='https://github.com/parkr' class='user-mention'>@parkr</a>\" Moore", page.content
   end
 
+  context "with special base URL specified" do
+    def setup
+      @site = fixture_site
+      @site.read
+      @site.config['jekyll-mentions'] = {"base_url" => "https://twitter.com"}
+      @mentions = Jekyll::Mentions.new(@site.config)
+      @mention = "test <a href='https://twitter.com/test' class='user-mention'>@test</a> test"
+    end
+
+    should "convert when hash setting" do
+      page = page_with_name(@site, "index.md")
+
+      @mentions.mentionify page
+      assert_equal @mention, page.content
+    end
+  end
+
+  context "reading custom base urls" do
+    def setup
+      @mentions = Jekyll::Mentions.new(Hash.new)
+    end
+
+    should "handle a raw string" do
+      assert_equal "https://twitter.com", @mentions.base_url("https://twitter.com")
+    end
+
+    should "handle a hash config" do
+      assert_equal "https://twitter.com", @mentions.base_url({"base_url" => "https://twitter.com"})
+    end
+
+    should "default to github.com if not there" do
+      assert_equal "https://github.com", @mentions.base_url(nil)
+    end
+  end
+
 end