kramdown-metadata-parsers 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfbcd236202b415d4e114eeb06ae1a097bcaf47d
+  data.tar.gz: 6d8158fdc5b62d9c54e194ee834b0178a3eb08b2
+SHA512:
+  metadata.gz: 6d0f72f39cd2741d6183d8093d3b493de3e007cfb561a5b7bd189246bbbe680edb8f23a466638bc55620d0b843db2610ef21969badf57fc2e6dbf065a727ca06
+  data.tar.gz: 7d04ce25f809a9bdedbb5a638eaaab6c0dfe6537b254a21f2c11cc625c8e7b73706b0a0ea6bc2bf21e9775a1ac2f32fc2af6f00d3f0107474e498df6c7b55676

data/README.md

@@ -0,0 +1,22 @@
+# Kramdown Metadata Parsers
+
+Kramdown extension for parsing Markdown with a YAML preamble, for example
+
+``` md
+---
+title: Now With Fresh Metadata
+date: 2014-10-11
+---
+
+## Good stuff
+
+*right*?
+```
+
+Adds four new parsers, analogous with the ones included with Kramdown: `MetadataKramdown`, `MetadataMarkdown`, `MetadataGFM`, `MetadataHTML`. Use as you would use built-in formats, just make sure this gem is in your load path (i.e. add it to your Gemfile)
+
+``` ruby
+doc = Kramdown::Document.new(markdown, input: 'MetadataKramdown')
+doc.root.metadata # => {:title => 'Now With Fresh Metadata', :date => '2014-10-11'}
+doc.to_html
+```

data/kramdown-metadata-parsers.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name        = 'kramdown-metadata-parsers'
+  gem.version     = "0.9.0"
+  gem.authors     = [ 'Arne Brasseur' ]
+  gem.email       = [ 'arne@arnebrasseur.net' ]
+  gem.description = 'Parse Markdown/Kramdown with YAML metadata'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/plexus/kramdown-metadata-parsers'
+  gem.license     = 'MIT'
+
+  gem.require_paths    = %w[lib]
+  gem.files            = `git ls-files`.split($/)
+  gem.test_files       = `git ls-files -- spec`.split($/)
+  gem.extra_rdoc_files = %w[README.md]
+
+  gem.add_runtime_dependency 'kramdown', '>= 1.4'
+end

data/lib/kramdown-metadata-parsers.rb

@@ -0,0 +1,23 @@
+require 'delegate'
+require 'yaml'
+
+require 'kramdown'
+
+module KramdownMetadataParsers
+  class MetadataElement < DelegateClass(::Kramdown::Element)
+    attr_accessor :metadata
+  end
+
+  module MetadataParser
+    def initialize(source, options)
+      if source =~ /\A---/
+        preamble = source[/\A---.*?^---/m]
+        source   = source[preamble.size..-1]
+        metadata = YAML.load(preamble)
+      end
+      super(source, options)
+      @root = MetadataElement.new(@root)
+      @root.metadata = metadata || {}
+    end
+  end
+end

data/lib/kramdown/parser/metadata_gfm.rb

@@ -0,0 +1,10 @@
+require 'kramdown-metadata-parsers'
+require 'kramdown/parser/gfm'
+
+module Kramdown
+  module Parser
+    class MetadataGFM < GFM
+      include KramdownMetadataParsers::MetadataParser
+    end
+  end
+end

data/lib/kramdown/parser/metadata_html.rb

@@ -0,0 +1,10 @@
+require 'kramdown-metadata-parsers'
+require 'kramdown/parser/html'
+
+module Kramdown
+  module Parser
+    class MetadataHTML < HTML
+      include KramdownMetadataParsers::MetadataParser
+    end
+  end
+end

data/lib/kramdown/parser/metadata_kramdown.rb

@@ -0,0 +1,10 @@
+require 'kramdown-metadata-parsers'
+require 'kramdown/parser/kramdown'
+
+module Kramdown
+  module Parser
+    class MetadataKramdown < Kramdown
+      include KramdownMetadataParsers::MetadataParser
+    end
+  end
+end

data/lib/kramdown/parser/metadata_markdown.rb

@@ -0,0 +1,10 @@
+require 'kramdown-metadata-parsers'
+require 'kramdown/parser/markdown'
+
+module Kramdown
+  module Parser
+    class MetadataMarkdown < Markdown
+      include KramdownMetadataParsers::MetadataParser
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-metadata-parsers
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Arne Brasseur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Parse Markdown/Kramdown with YAML metadata
+email:
+- arne@arnebrasseur.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- kramdown-metadata-parsers.gemspec
+- lib/kramdown-metadata-parsers.rb
+- lib/kramdown/parser/metadata_gfm.rb
+- lib/kramdown/parser/metadata_html.rb
+- lib/kramdown/parser/metadata_kramdown.rb
+- lib/kramdown/parser/metadata_markdown.rb
+homepage: https://github.com/plexus/kramdown-metadata-parsers
+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: Parse Markdown/Kramdown with YAML metadata
+test_files: []