velvet_rope 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redcarpet_pygments.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sean Gaffney
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# VelvetRope
+
+VelvetRope is a renderer to complement and enhance Redcarpet's default HTML
+renderer. For now, it adds support for emoji and syntax-highlighting.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'velvet_rope'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install velvet_rope
+
+## Usage
+
+### Syntax Highlighting
+
+VelvetRope uses [pygments.rb](https://github.com/tmm1/pygments.rb) to provide
+syntax highlighting support. In order to turn this on, just pass the
+`highlight_syntax` option into VelvetRope on instantiation.
+
+```ruby
+Redcarpet::Render::VelvetRope.new(:highlight_syntax => true)
+```
+
+You will need to generate the CSS for the Pygments theme that you would like to
+use for highlighting. You can find instructions on how to do that in the
+[pygments.rb documentation](https://github.com/tmm1/pygments.rb#usag://github.com/tmm1/pygments.rb#usage).
+
+### Emoji
+
+VelvetRope uses [gemoji](https://github.com/github/gemoji) to provide emoji
+support. In order to turn this on, just pass the `emoji` option into VelvetRope
+on instantiation.
+
+```ruby
+Redcarpet::Render::VelvetRope.new(:emoji => true)
+```
+
+You will need to add the emoji images to your app. There are instructions on how
+to do so in the [gemoji documentation](https://github.com/github/gemoji#installation).
+
+Also, the default template for emoji images is:
+
+
+```ruby
+'<img alt="' + name + '" src="' + "/images/emoji/#{name}.png" + '" style="vertical-align:middle" width="20" height="20" />'
+```
+
+If you would like to define your own template, you could do something like the 
+following in an initializer:
+
+```ruby
+module Redcarpet
+  module Render
+    class VelvetRope < HTML
+      def emoji_template(name)
+        '<img class="emoji" src="' + "/images/emoji/#{name}.png" + '" width="20" height="20" />'
+      end
+    end
+  end
+end
+```
+
+### HTML? But what about XHTML?!
+
+Fear not, my friend. Just pass the `xhtml` option into the VelvetRope renderer on
+instantiation.
+
+  ```ruby
+  Redcarpet::Render::VelvetRope.new(:xhtml => true)
+  ```
+
+Redcarpet's XHTML renderer is just a shortcut for this very option.
+
+## TODO
+
+Create rake tasks to simplify setup and installation of Pygments themes and emoji
+image files.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Licensing
+
+VelvetRope is written by [Sean Gaffney](http://seangaffney.cc) and is under the
+MIT License.
+
+The MIT License (MIT)
+
+Copyright (c) Ted Nyman and Aman Gupta, 2012-2013
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in the
+Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/velvet_rope.rb

@@ -0,0 +1,45 @@
+require "redcarpet"
+require "pygments.rb"
+require "gemoji"
+
+module Redcarpet
+  module Render
+    class VelvetRope < HTML
+
+      def initialize(extensions={})
+        @extensions ||= {}
+        @extensions[:highlight_syntax] = extensions.delete(:highlight_syntax) || false
+        @extensions[:emoji] = extensions.delete(:emoji) || false
+
+        # This is ugly, but is a workaround for Redcarpet not handling `super`
+        # as it is a wrapper for the implementation written in C
+        if @extensions[:highlight_syntax]
+          self.class.send(:define_method, :block_code) do |code, language|
+            Pygments.highlight(code, :lexer => language)
+          end
+        end
+
+        # `super` however DOES work in this intializer...
+        super(extensions)
+      end
+
+      def postprocess(document)
+        if @extensions[:emoji]
+          document.gsub!(/:([a-z0-9\+\-_]+):/) do |match|
+            if Emoji.names.include?($1)
+              emoji_template($1)
+            else
+              match
+            end
+          end
+        end
+        document
+      end
+
+      def emoji_template(name)
+        '<img alt="' + name + '" src="' + "/images/emoji/#{name}.png" + '" style="vertical-align:middle" width="20" height="20" />'
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'velvet_rope'

data/spec/velvet_rope_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Redcarpet::Render::VelvetRope do
+
+  context 'with emoji option set to true' do
+    let(:markdown) { Redcarpet::Markdown.new(Redcarpet::Render::VelvetRope.new(:emoji => true)) }
+
+    it 'renders emoji characters' do
+      content = 'This should be a :smiley: face.'
+
+      expected = '<p>This should be a <img alt="smiley" src="/images/emoji/smiley.png" style="vertical-align:middle" width="20" height="20" /> face.</p>' + "\n"
+      markdown.render(content).should eq(expected)
+    end
+  end
+
+  context 'with highlight_syntax option set to true' do
+    let(:markdown) { Redcarpet::Markdown.new(Redcarpet::Render::VelvetRope.new(:highlight_syntax => true)) }
+
+    it 'renders highlighted syntax for normal code blocks' do
+      content = <<-EOS
+This is an example of some Ruby code:
+
+    def my_method
+      'my string'.uppercase
+    end
+      EOS
+
+      expected = %{<p>This is an example of some Ruby code:</p>\n<div class=\"highlight\"><pre><span class=\"n\">def</span> <span class=\"n\">my_method</span>\n  <span class=\"s\">&#39;my string&#39;</span><span class=\"p\">.</span><span class=\"n\">uppercase</span>\n<span class=\"k\">end</span>\n</pre></div>}
+      markdown.render(content).should eq(expected)
+    end
+  end
+
+  context 'with highlight_syntax option set to true and with fenced_code_blocks turned on' do
+    let(:markdown) { Redcarpet::Markdown.new(Redcarpet::Render::VelvetRope.new(:highlight_syntax => true), :fenced_code_blocks => true) }
+
+    it 'renders highlighted syntax for fenced code blocks' do
+      content = <<-EOS
+This is an example of some Ruby code in a fenced code block:
+
+```ruby
+def my_method
+  'my string'.uppercase
+end
+```
+      EOS
+
+      expected = %{<p>This is an example of some Ruby code in a fenced code block:</p>\n<div class=\"highlight\"><pre><span class=\"k\">def</span> <span class=\"nf\">my_method</span>\n  <span class=\"s1\">&#39;my string&#39;</span><span class=\"o\">.</span><span class=\"n\">uppercase</span>\n<span class=\"k\">end</span>\n</pre></div>}
+      markdown.render(content).should eq(expected)
+    end
+  end
+
+end

data/velvet_rope.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "velvet_rope"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Sean Gaffney"]
+  gem.email         = ["sean@seangaffney.cc"]
+  gem.description   = %q{VelvetRope is a renderer to complement and enhance Redcarpet's default HTML renderer. It adds support for emoji and syntax-highlighting.}
+  gem.summary       = %q{Provides out-of-the-box syntax-highlighting and emoji support for the Redcarpet markdown library.}
+  gem.homepage      = "http://github.com/seangaffney/velvet_rope"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+
+  gem.add_runtime_dependency "redcarpet"
+  gem.add_runtime_dependency "pygments.rb"
+  gem.add_runtime_dependency "gemoji"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: velvet_rope
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sean Gaffney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: VelvetRope is a renderer to complement and enhance Redcarpet's default
+  HTML renderer. It adds support for emoji and syntax-highlighting.
+email:
+- sean@seangaffney.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/velvet_rope.rb
+- spec/spec_helper.rb
+- spec/velvet_rope_spec.rb
+- velvet_rope.gemspec
+homepage: http://github.com/seangaffney/velvet_rope
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides out-of-the-box syntax-highlighting and emoji support for the Redcarpet
+  markdown library.
+test_files:
+- spec/spec_helper.rb
+- spec/velvet_rope_spec.rb