md_emoji 0.0.1 → 0.0.2

data/README.markdown

@@ -2,9 +2,13 @@
 
 Want to include [emoji](http://www.emoji-cheat-sheet.com/) in your rails app? Well now you can!
 
-:balloon: :smile: :balloon:
+![:balloon:](https://github.com/mendicant-university/md_emoji/raw/master/vendor/assets/images/emojis/balloon.png)
+![:smile:](https://github.com/mendicant-university/md_emoji/raw/master/vendor/assets/images/emojis/smile.png)
+![:balloon:](https://github.com/mendicant-university/md_emoji/raw/master/vendor/assets/images/emojis/balloon.png)
 
-This plugin requires `redcarpet` and `rails` >= 3.1 with the asset pipeline enabled.
+Markdown Emoji was designed to work with the [Redcarpet](https://github.com/tanoku/redcarpet) markdown processor and [Rails 3.1](https://github.com/rails/rails) with the asset pipeline enabled.
+
+**Warning** This gem is very new and under heavy development. Use at your own risk :)
 
 ## Installation
 
@@ -24,6 +28,12 @@ markdown = Redcarpet::Markdown.new(MdEmoji::Render)
 markdown.render("Hello :smile: world!")
 ```
 
+Emoji assets will automatically be picked up by the asset pipeline and made available to your app at:
+
+`/assets/emojis/<EMOJI_NAME>.png`
+
+For a full list of supported emoji, just run `MdEmoji::EMOJI` in your console.
+
 ## Contributing
 
 Features and bugs are tracked through [Github Issues](https://github.com/mendicant-university/md_emoji/issues).
@@ -48,6 +58,10 @@ Contact Jordan through [GitHub (@jordanbyron)](https://github.com/jordanbyron) o
 9. Commit and push your changes.
 10. Submit a pull request.
 
+## Authorship
+
+Emoji images are from [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com)'s [github project](https://github.com/arvida/emoji-cheat-sheet.com). This project was inspired by [GitHub's emoji implementation](https://github.com/blog/816-emoji) and hacked together by [Jordan Byron](http://jordanbyron.com).
+
 ## License
 
 Copyright (c) 2011 Jordan Byron

data/lib/md_emoji/render.rb

@@ -1,8 +1,17 @@
 module MdEmoji
   class Render < Redcarpet::Render::HTML
-    def normal_text(text)
-      return if text.nil?
+    def preprocess(text)
+      if include_emoji?(text)
+        emoji(text)
+      else
+        text
+      end
+    end
 
+    # Replaces valid emoji characters, ie :smile:, with img tags
+    #
+    # Valid emoji charaters are listed in +MdEmoji::EMOJI+
+    def emoji(text)
       text.gsub(/:(\S+):/) do |emoji|
         if MdEmoji::EMOJI.include?($1)
           file_name    = "#{$1.gsub('+', 'plus')}.png"
@@ -15,5 +24,12 @@ module MdEmoji
         end
       end
     end
+
+    private
+
+    # Returns +true+ if emoji are present in +text+, otherwise returns +false+
+    def include_emoji?(text)
+      text && text[/:\S+:/]
+    end
   end
 end

data/lib/md_emoji/version.rb

@@ -1,3 +1,3 @@
 module MdEmoji
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/md_emoji_test.rb

@@ -31,4 +31,16 @@ class MdEmojiTest < ActiveSupport::TestCase
 
     assert_equal %{<p>Hello :jordan_byron: world!</p>\n}, parsed_text
   end
+
+  test "works with autolink enabled" do
+    @markdown = Redcarpet::Markdown.new(MdEmoji::Render, :autolink => true)
+
+    text        = ":wink2: http://www.jordanbyron.com"
+    parsed_text = @markdown.render(text)
+
+    assert parsed_text.include?(%{<img src="/assets/emojis/wink2.png"}),
+           "Emoji not present in parsed text: #{parsed_text}"
+    assert parsed_text.include?(%{<a href="http://www.jordanbyron.com"}),
+           "Hyperlink not present in parsed text: #{parsed_text}"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: md_emoji
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-19 00:00:00.000000000Z
+date: 2012-01-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2157933900 !ruby/object:Gem::Requirement
+  requirement: &2164942240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2157933900
+  version_requirements: *2164942240
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2157933040 !ruby/object:Gem::Requirement
+  requirement: &2164941620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,8 +32,8 @@ dependencies:
         version: 2.0.0b3
   type: :runtime
   prerelease: false
-  version_requirements: *2157933040
-description: Rails plugin which adds emoji to markdown
+  version_requirements: *2164941620
+description: Rails gem which adds emoji parsing to markdown
 email:
 - jordan@ducksoupsoftware.com
 executables: []
@@ -587,7 +587,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1626333553585938101
+      hash: 1364931473961737296
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -596,10 +596,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1626333553585938101
+      hash: 1364931473961737296
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Markdown emoji for Rails