redcarpet-abbreviations 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4882809ef4ce82e8cad61c1089ff79d9b31b321
+  data.tar.gz: 535244a1de7a5dde8c6ec838c794270e30e6d164
+SHA512:
+  metadata.gz: 90dc5b65b3d4304df9e257077738659ce607fde6dce5e0de294e4d03accb3ea3209915d5d87104313a709c7559a0a01c12152ef5fd5162df0b3e812bf79f10f2
+  data.tar.gz: 4a97381b9f53c8a2f1d8f6fa5e2e8fc81fceb3725ca7a0b2dd1bbe79a301957fda9ecaa10c64a98ea45f4d5b4dcba18e55d5bb7a820215675f543d723ebf6775

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brandon Weiss
+
+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,69 @@
+# Redcarpet::Abbreviations
+
+An extension for Redcarpet that supports abbreviations. So this:
+
+```
+I'm pretty sure I'm not using this acronym right but hey YOLO.
+
+*[YOLO]: You Only Live Once
+```
+
+Becomes this:
+
+```
+I'm pretty sure I'm not using this acronym right but hey <abbr title="You Only Live Once">YOLO</abbr>.
+```
+
+If you're thinking this would be better in Redcarpet, [yes I totally agree](https://github.com/vmg/redcarpet/issues/197), but I don't know C.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "redcarpet-abbreviations"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redcarpet-abbreviations
+
+## Usage
+
+Just include it in your renderer.
+
+```ruby
+class HTMLWithAbbreviations < Redcarpet::Render::HTML
+
+  include Redcarpet::Render::HTMLAbbreviations
+
+end
+```
+
+Remember to call `super` if your renderer has its own `preprocess` method, otherwise it will override the included `preprocess` method.
+
+```ruby
+class HTMLWithAbbreviations < Redcarpet::Render::HTML
+
+  include Redcarpet::Render::HTMLAbbreviations
+
+  def preprocess(document)
+    document = super(document)
+
+    # ...
+  end
+
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/brandonweiss/redcarpet-abbreviations/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/lib/redcarpet/abbreviations/version.rb

@@ -0,0 +1,5 @@
+module Redcarpet
+  module Abbreviations
+    VERSION = "0.0.1"
+  end
+end

data/lib/redcarpet/render/html_abbreviations.rb

@@ -0,0 +1,31 @@
+module Redcarpet
+  module Render
+    module HTMLAbbreviations
+
+      def preprocess(document)
+        abbreviations = document.scan(/^\*\[([A-Z]+)\]: (.+)$/)
+        abbreviations = Hash[*abbreviations.flatten]
+
+        if abbreviations.any?
+          document.gsub!(/^\*\[([A-Z]+)\]: (.+)$/, "")
+          document.rstrip!
+
+          abbreviations.each do |key, value|
+            html = <<-EOS.strip
+              <abbr title="#{value}">#{key}</abbr>
+            EOS
+
+            document.gsub!(acronym_regexp(key), html)
+          end
+        end
+
+        document
+      end
+
+      def acronym_regexp(acronym)
+        /\b#{acronym}\b/
+      end
+
+    end
+  end
+end

data/lib/redcarpet-abbreviations.rb

@@ -0,0 +1,2 @@
+require "redcarpet/abbreviations/version"
+require "redcarpet/render/html_abbreviations"

data/redcarpet-abbreviations.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redcarpet/abbreviations/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redcarpet-abbreviations"
+  spec.version       = Redcarpet::Abbreviations::VERSION
+  spec.authors       = ["Brandon Weiss"]
+  spec.email         = ["brandon@anti-pattern.com"]
+  spec.summary       = %q{An extension for Redcarpet that supports abbreviations.}
+  spec.description   = %q{An extension for Redcarpet that supports abbreviations.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake",    "~> 10.0"
+end

data/test/redcarpet/render/html_abbreviations_test.rb

@@ -0,0 +1,46 @@
+require File.expand_path("../../../test_helper", __FILE__)
+
+describe Redcarpet::Render::HTMLAbbreviations do
+
+  before do
+    @renderer = Class.new do
+      include Redcarpet::Render::HTMLAbbreviations
+    end
+  end
+
+  describe "#preprocess" do
+
+    it "converts markdown abbrevations to HTML" do
+      markdown = <<-EOS.strip_heredoc
+        YOLO
+
+        *[YOLO]: You Only Live Once
+      EOS
+
+      @renderer.new.preprocess(markdown).must_equal <<-EOS.strip_heredoc.chomp
+        <abbr title=\"You Only Live Once\">YOLO</abbr>
+      EOS
+    end
+
+  end
+
+  describe "#acronym_regexp" do
+
+    it "matches an acronym at the beginning of a line" do
+      "FOO bar".must_match @renderer.new.acronym_regexp("FOO")
+    end
+
+    it "matches an acronym at the end of a line" do
+      "bar FOO".must_match @renderer.new.acronym_regexp("FOO")
+    end
+
+    it "matches an acronym next to punctuation" do
+      ".FOO.".must_match @renderer.new.acronym_regexp("FOO")
+    end
+
+    it "doesn't match an acronym in the middle of a word" do
+      "YOLOFOOYOLO".wont_match @renderer.new.acronym_regexp("FOO")
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "redcarpet-abbreviations"
+
+require 'minitest/autorun'
+
+class Object
+
+  def try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      public_send(*a, &b) if respond_to?(a.first)
+    end
+  end
+
+end
+
+class String
+
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.try(:size) || 0
+    gsub(/^[ \t]{#{indent}}/, '')
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: redcarpet-abbreviations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: An extension for Redcarpet that supports abbreviations.
+email:
+- brandon@anti-pattern.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redcarpet-abbreviations.rb
+- lib/redcarpet/abbreviations/version.rb
+- lib/redcarpet/render/html_abbreviations.rb
+- redcarpet-abbreviations.gemspec
+- test/redcarpet/render/html_abbreviations_test.rb
+- test/test_helper.rb
+homepage: ''
+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.4.2
+signing_key: 
+specification_version: 4
+summary: An extension for Redcarpet that supports abbreviations.
+test_files:
+- test/redcarpet/render/html_abbreviations_test.rb
+- test/test_helper.rb