redcarpet-socialable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7722b1682883781e998aa947c926cb54c3c224d6
+  data.tar.gz: d1e2cdbde51c51061923323166a860f720b86510
+SHA512:
+  metadata.gz: 468aa26ebb86a4b5c95b5782142e337723a62ad15883e3882652c54d0ada73a4980e051ac6edd7e46e77be4a03c81f70cd485fcdf51c910f06005692a384a52e
+  data.tar.gz: ed283cc8cc93ed0f53677ca5fc87603fa20d48964971cf829e6180f0f6eace2cb0c1ced6d31071d1bb4c8688f680b521426b8bd6bb2a5bb3db9e335c75976d6e

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/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rspec"
+
+# Specify your gem's dependencies in tweetable-redcapret.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan Bernacki
+
+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,37 @@
+# @mention and #hashtag for Markdown
+
+This gem provides a HTML renderer for [redcarpet](https://github.com/vmg/redcarpet).
+
+## How to use
+
+```ruby
+gem "tweetable_redcarpet"
+```
+
+```ruby
+# override the following methods for your case
+class MyAwesomeRenderer < Redcarpet::Socialable
+  def highlight_tag?(name)
+    Tag.where(name: name.downcase).first_or_create!
+  end
+  
+  def highlight_username?(name)
+    User.where(username: name).exists?
+  end
+  
+  def tag_template(name)
+    %(<a>##{name}</a>)
+  end
+  
+  def mention_template(name)
+    %(<a>@#{name}</a>)
+  end
+end
+
+# use redcarpet's options https://github.com/vmg/redcarpet
+renderer = MyAwesomeRenderer.new
+# space_after_headers must be true for hashtag feature
+markdown = Redcarpet::Markdown.new(renderer, space_after_headers: true)
+
+markdown.render "#foo\n@bar" # => <p><a>#foo</a><br><a>@bar</a></p>
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redcarpet/socialable.rb

@@ -0,0 +1,76 @@
+require "redcarpet"
+
+module Redcarpet
+  class Socialable < Redcarpet::Render::HTML
+    BASE_REGEXP = '(^|[\s])+%s(\b|\-|\.|,|:|;|\?|!|\(|\)|$){1}'
+  
+    def paragraph(text)
+      "<p>#{safe_replace(text)}</p>"
+    end
+  
+    def list_item(text, list_type)
+      "<li>#{safe_replace(text)}</li>"
+    end
+  
+    def header(text, level)
+      "<h#{level}>#{safe_replace(text)}</h#{level}>"
+    end
+  
+    private
+    def highlight_tag?(name)
+      true
+    end
+  
+    def highlight_username?(name)
+      true
+    end
+  
+    def tag_template(name)
+      %(<a href="#" title="#{name}">##{name}</a>)
+    end
+  
+    def mention_template(name)
+      %(<a href="#" title="#{name}">@#{name}</a>)
+    end
+  
+    def safe_replace(text)
+      replaces = {}
+    
+      # cut all tags
+      text.gsub!(%r{>.*?</}m) do |match|
+        md5 = Digest::MD5.hexdigest(match)
+        replaces[md5] = match
+        "{extraction-#{md5}}"
+      end
+    
+      # highlight tags
+      regexp = Regexp.new(BASE_REGEXP % '#([\w\-]+)')
+      text.gsub!(regexp) do |match|
+        before, raw, after = $1, $2, $3
+        if highlight_tag?(raw)
+          %(#{before}#{tag_template(raw)}#{after})
+        else
+          match
+        end
+      end
+    
+      # highlight users
+      regexp = Regexp.new(BASE_REGEXP % '@([\w-]+)')
+      text.gsub!(regexp) do |match|
+        before, raw, after = $1, $2, $3
+        if highlight_username?(raw)
+          %(#{$1}#{mention_template(raw)}#{$3})
+        else
+          match
+        end
+      end
+    
+      # paste all tags
+      text.gsub!(/\{extraction-([0-9a-f]{32})\}/) do
+        replaces[$1]
+      end
+    
+      text
+    end
+  end
+end

data/redcarpet-socialable.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "redcarpet-socialable"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jan Bernacki"]
+  spec.email         = ["releu@me.com"]
+  spec.description   = %q{@mention and #hashtag features for redcarpet}
+  spec.summary       = %q{@mention and #hashtag features for redcarpet, the Markdown renderer}
+  spec.homepage      = "https://github.com/releu/redcarpet-socialable"
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "redcarpet", "~> 3.0.0"
+end

data/spec/socialable_spec.rb

@@ -0,0 +1,99 @@
+require File.expand_path("../../lib/redcarpet/socialable", __FILE__)
+
+class NoTags < Redcarpet::Socialable
+  def highlight_tag?(name)
+    false
+  end
+end
+
+class NoMentions < Redcarpet::Socialable
+  def highlight_username?(name)
+    false
+  end
+end
+
+class SpanTags < Redcarpet::Socialable
+  def tag_template(name)
+    "<span>#{name}</span>"
+  end
+end
+
+class SpanMentions < Redcarpet::Socialable
+  def mention_template(name)
+    "<span>#{name}</span>"
+  end
+end
+
+describe Redcarpet::Socialable do
+  let(:renderer) { Redcarpet::Socialable.new }
+  let(:markdown) do
+    Redcarpet::Markdown.new(renderer, space_after_headers: true)
+  end
+  
+  it "returns html" do
+    sample = "foo\n\nbar"
+    expect(markdown.render(sample)).to match(/</)
+  end
+  
+  { "@mentions" => "@", "#hashtags" => "#" }.each do |type, char|
+    context "highlighting #{type}" do
+      subject { markdown.render(sample) }
+    
+      context "in paragraphs" do
+        let(:sample) { "#{char}bar" }
+        
+        it { expect(subject).to match(/<a/) }
+      end
+    
+      context "in lists" do
+        let(:sample) { "* foo\n* #{char}bar\n* buz" }
+        
+        it { expect(subject).to match(/<a/) }
+      end
+      
+      context "in blockquote" do
+        let(:sample) { "> foo #{char}bar buz" }
+        
+        it { expect(subject).to match(/<a/) }
+      end
+      
+      context "in headers" do
+        let(:sample) { "# foo #{char}bar buz" }
+        
+        it { expect(subject).to match(/<a/) }
+      end
+    end
+  end
+  
+  describe "override #highlight_tag?" do
+    let(:renderer) { NoTags.new }
+    let(:sample) { "#foo" }
+    subject { markdown.render(sample) }
+    
+    it { expect(subject).not_to match(/<a/) }
+  end
+  
+  describe "override #highlight_mention?" do
+    let(:renderer) { NoMentions.new }
+    let(:sample) { "@foo" }
+    subject { markdown.render(sample) }
+    
+    it { expect(subject).not_to match(/<a/) }
+  end
+  
+  describe "override #tag_template?" do
+    let(:renderer) { SpanTags.new }
+    let(:sample) { "#foo" }
+    subject { markdown.render(sample) }
+    
+    it { expect(subject).to match(/<span/) }
+  end
+  
+  describe "override #mention_template" do
+    let(:renderer) { SpanMentions.new }
+    let(:sample) { "@foo" }
+    subject { markdown.render(sample) }
+    
+    it { expect(subject).to match(/<span/) }
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: redcarpet-socialable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jan Bernacki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: '@mention and #hashtag features for redcarpet'
+email:
+- releu@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redcarpet/socialable.rb
+- redcarpet-socialable.gemspec
+- spec/socialable_spec.rb
+homepage: https://github.com/releu/redcarpet-socialable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: '@mention and #hashtag features for redcarpet, the Markdown renderer'
+test_files:
+- spec/socialable_spec.rb