yard-redcarpet-ext 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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Akzhan Abdulin
+
+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,35 @@
+# YARD::Redcarpet::Ext
+
+Enables Redcarpet extensions for YARD.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yard-redcarpet-ext'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-redcarpet-ext
+
+## Usage
+
+Add `--plugin redcarpet-ext` option to your `.yardopts` or call `yard` with this option.
+
+Create new file named `.yard_redcarpet_ext` with all needed Redcarpet extensions like tables separated by comma or newline.
+
+Another way to specify extensions is setting of YARD_REDCARPET_EXTS environment variable. Extensions should be separated by comma.
+
+You must have `gem 'yard-redcarpet-ext'` string in your Gemfile or development dependency in gemspec if it exists.
+
+## 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

data/Rakefile

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

data/lib/yard-redcarpet-ext.rb

@@ -0,0 +1,2 @@
+# YARD too lazy to use directory structure.
+require 'yard/redcarpet/ext'

data/lib/yard/redcarpet/ext.rb

@@ -0,0 +1,62 @@
+require "yard/redcarpet/ext/version"
+
+require 'yard'
+
+module YARD
+  module Redcarpet
+    module Ext
+      CONFIG_FILE = '.yard_redcarpet_ext'.freeze
+      ENV_VAR     = 'YARD_REDCARPET_EXTS'.freeze
+
+      DEFAULT_REDCARPET_EXTS = %w[
+        no_intraemphasis
+        gh_blockcode
+        fenced_code
+        autolink
+      ].freeze
+
+      def self.exts_from_config
+        return []  unless File.readable?(CONFIG_FILE)
+        IO.read(CONFIG_FILE).split(/(?:\s*,\s*)|\n/).select { |ext| !ext.empty? }
+      end
+
+      def self.exts_from_env
+        val = ENV[ENV_VAR]
+        return []  unless val
+        val.split(/\s*,\s*/).select { |ext| !ext.empty? }
+      end
+
+      def self.redcarpet_exts
+        @redcarpet_exts ||= begin
+          exts = []
+          exts += DEFAULT_REDCARPET_EXTS
+          exts += exts_from_config
+          exts += exts_from_env
+          exts.uniq.map { |ext| ext.to_sym }
+        end
+      end
+
+      def self.install
+        YARD::Templates::Helpers::HtmlHelper.module_eval do
+          alias :html_markup_markdown_noredcarpet :html_markup_markdown
+
+          # Converts Markdown to HTML
+          # @param [String] text input Markdown text
+          # @return [String] output HTML
+          # @since 0.6.0
+          def html_markup_markdown(text)
+            provider = markup_class(:markdown)
+            if provider.to_s == 'RedcarpetCompat'
+              redcarpet_exts = YARD::Redcarpet::Ext.redcarpet_exts
+              provider.new(text, *redcarpet_exts).to_html
+            else
+              html_markup_markdown_noredcarpet(text)
+            end
+          end
+        end
+      end
+
+      install
+    end
+  end
+end

data/lib/yard/redcarpet/ext/version.rb

@@ -0,0 +1,7 @@
+module YARD
+  module Redcarpet
+    module Ext
+      VERSION = "0.0.1".freeze
+    end
+  end
+end

data/yard-redcarpet-ext.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yard/redcarpet/ext/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yard-redcarpet-ext"
+  spec.version       = YARD::Redcarpet::Ext::VERSION.dup
+  spec.authors       = ["Akzhan Abdulin"]
+  spec.email         = ["akzhan.abdulin@gmail.com"]
+  spec.description   = %q{Redcarpet extensions for YARD}
+  spec.summary       = %q{Enable Redcarpet extensions for YARD projects}
+  spec.homepage      = ""
+  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.has_rdoc      = 'yard'
+
+  spec.add_runtime_dependency "yard", "~> 0.8.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: yard-redcarpet-ext
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Akzhan Abdulin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Redcarpet extensions for YARD
+email:
+- akzhan.abdulin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yard-redcarpet-ext.rb
+- lib/yard/redcarpet/ext.rb
+- lib/yard/redcarpet/ext/version.rb
+- yard-redcarpet-ext.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2659873418656328463
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2659873418656328463
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Enable Redcarpet extensions for YARD projects
+test_files: []
+has_rdoc: yard