beckett 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7148156b64407c8fef7638ada09657342bce3ec
+  data.tar.gz: 566418a2020fc159e1c1c0625ddd3c696e2a0ee8
+SHA512:
+  metadata.gz: 1a06cae48be39a93d807636a8ed4200ae46bdcc72994f3609be66d9cead6635372ccd259dacd2bc7cd3cf28a1577eec3394c2f2d5a409c2d819598a609bad083
+  data.tar.gz: c504afffa363d350e7f1a34d2bfa3612961da40f1d734e0dd485f2a517d2c6d5c627b0cd705c8d11de843203b1ac0b6c7a7672cd0be28b795cc136ca48cea3ee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Corey Innis
+
+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 @@
+# Beckett
+
+A Markdown renderer, using Kramdown, to convert to JSON, HTML5 or a Ruby Hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beckett'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install beckett
+
+## Usage
+
+`beckett help`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec beckett` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/coreyti/beckett. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/beckett.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'beckett/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "beckett"
+  spec.version       = Beckett::VERSION
+  spec.authors       = ["Corey Innis"]
+  spec.email         = ["corey@coolerator.net"]
+
+  spec.summary       = "A Markdown-to-JSON/HTML5/Ruby-Hash Renderer."
+  spec.description   = "A Markdown renderer, using Kramdown, to convert to JSON, HTML5 or a Ruby Hash."
+  spec.homepage      = "https://github.com/coreyti/beckett"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "kramdown"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "beckett"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/beckett.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'kramdown'
+
+require 'beckett/renderer'
+require 'beckett/node'
+require 'beckett/node/root'
+
+require 'beckett/node/element'
+require 'beckett/node/article'
+require 'beckett/node/section'
+require 'beckett/node/header'
+require 'beckett/node/codeblock'
+
+require 'beckett/node/text'
+require 'beckett/node/codespan'
+require 'beckett/node/br'
+
+
+module Beckett
+  class Document
+    def initialize(content)
+      @content = content
+    end
+
+    def to_hash
+      document = Kramdown::Document.new(@content, input: 'GFM')
+      renderer = Renderer.send(:new, document.root)
+      renderer.convert(document.root)
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+  end
+end

data/lib/beckett/node.rb

@@ -0,0 +1,47 @@
+module Beckett
+  module Node
+    def self.find(node)
+      type = node.type.capitalize
+
+      if self.const_defined?(type)
+        const_get(type)
+      else
+        Element
+      end
+    end
+
+    class Base
+      $position = 0
+      attr_reader :node, :children, :position
+
+      def initialize(node)
+        @node     = node
+        @children = []
+        @position = $position
+        $position += 1
+      end
+
+      def inspect
+        "<#{node_name} position=#{position}>"
+      end
+
+      def to_s
+        inspect
+      end
+
+      def to_h
+        raise NotImplementedError
+      end
+
+      def <<(nodes)
+        @children += ([nodes].flatten)
+      end
+
+      private
+
+      def node_name
+        @node_name ||= node.type.upcase
+      end
+    end
+  end
+end

data/lib/beckett/node/article.rb

@@ -0,0 +1,10 @@
+module Beckett
+  class Node::Article < Node::Element
+
+    private
+
+    def node_name
+      'ARTICLE'
+    end
+  end
+end

data/lib/beckett/node/br.rb

@@ -0,0 +1,10 @@
+module Beckett
+  class Node::Br < Node::Element
+    def to_h
+      {}.tap do |element|
+        element[:node_name] = node_name
+        element[:node_type] = node_type
+      end
+    end
+  end
+end

data/lib/beckett/node/codeblock.rb

@@ -0,0 +1,17 @@
+module Beckett
+  class Node::Codeblock < Node::Element
+    def to_h
+      {}.tap do |element|
+        element[:node_name] = node_name
+        element[:node_type] = node_type
+        element[:node_text] = node_text
+      end
+    end
+
+    private
+
+    def node_text
+      node.value.strip
+    end
+  end
+end

data/lib/beckett/node/codespan.rb

@@ -0,0 +1,13 @@
+module Beckett
+  class Node::Codespan < Node::Text
+    private
+
+    def node_name
+      'CODESPAN'
+    end
+
+    def node_type
+      1
+    end
+  end
+end

data/lib/beckett/node/element.rb

@@ -0,0 +1,31 @@
+module Beckett
+  class Node::Element < Node::Base
+    def to_h
+      {}.tap do |element|
+        element[:node_name]  = node_name
+        element[:node_type]  = node_type
+        # NOTE: might add attributes as `nil` or empty Hash at a later date...
+        element[:attributes] = node_attributes if node_attributes
+        element[:children]   = children.map(&:to_h)
+      end
+    end
+
+    private
+
+    def node_attributes
+      unless defined?(@node_attributes)
+        @node_attributes = node.attr
+        @node_attributes = nil if @node_attributes.empty?
+      end
+      @node_attributes
+    end
+
+    def node_name
+      @node_name ||= node.type.upcase
+    end
+
+    def node_type
+      1
+    end
+  end
+end

data/lib/beckett/node/header.rb

@@ -0,0 +1,10 @@
+module Beckett
+  class Node::Header < Node::Element
+
+    private
+
+    def node_name
+      'HEADER'
+    end
+  end
+end

data/lib/beckett/node/root.rb

@@ -0,0 +1,11 @@
+module Beckett
+  class Node::Root < Node::Base
+    def to_h
+      {
+        root: {}.tap do |root|
+          root[:children] = children.map(&:to_h)
+        end
+      }
+    end
+  end
+end

data/lib/beckett/node/section.rb

@@ -0,0 +1,10 @@
+module Beckett
+  class Node::Section < Node::Element
+
+    private
+
+    def node_name
+      'SECTION'
+    end
+  end
+end

data/lib/beckett/node/text.rb

@@ -0,0 +1,30 @@
+module Beckett
+  class Node::Text < Node::Base
+    def to_h
+      {}.tap do |element|
+        element[:node_name] = node_name
+        element[:node_type] = node_type
+        element[:node_text] = node_text
+      end
+    end
+
+    def nil?
+      # improves list rendering.
+      node_text.strip.empty?
+    end
+
+    private
+
+    def node_name
+      '#text'
+    end
+
+    def node_text
+      node.value
+    end
+
+    def node_type
+      3
+    end
+  end
+end

data/lib/beckett/renderer.rb

@@ -0,0 +1,108 @@
+module Beckett
+  class Renderer < Kramdown::Converter::Base
+    DISPATCHER = Hash.new { |h, k|
+      method = :"convert_#{k}"
+      h[k] = Renderer.method_defined?(method) ? method : :convert_node
+    }
+
+    def initialize(root, options = {})
+      super
+      @stack = []
+    end
+
+    def convert(node)
+      send(DISPATCHER[node.type], node)
+    end
+
+    protected
+
+    def convert_root(node)
+      build(node).to_h
+    end
+
+    def convert_node(node)
+      build(node)
+    end
+
+    # ---
+
+    def convert_blank(node)
+      nil
+    end
+
+    def convert_text(node)
+      Node.find(node).new(node)
+    end
+
+    # ---
+
+    def build(node)
+      Node.find(node).new(node).tap do |result|
+        push(result)
+        inner(node)
+        pop
+      end
+    end
+
+    def build_section(node)
+      level = node.options[:level]
+
+      while @stack.length > level
+        pop
+      end
+
+      if level == 1
+        Node::Article.new(node)
+      else
+        Node::Section.new(node)
+      end
+    end
+
+    def context
+      @stack.last
+    end
+
+    def inner(node)
+      node.children.each do |child|
+        if child.type == :header
+          build_section(child).tap do |result|
+            context << result
+            push(result)
+          end
+        end
+
+        convert(child).tap do |result|
+          context << result unless result.nil?
+        end
+      end
+    end
+
+    def push(context)
+      if debug?
+        @indent ||= 0
+        puts "#{' ' * @indent}#{context}"
+        @indent += 2
+      end
+
+      @stack.push(context)
+    end
+
+    def pop
+      context = @stack.pop
+
+      if debug?
+        @indent -= 2
+        puts "#{' ' * @indent}#{context}".sub(/^(\s*)<([A-Z]+).*/, '\1</\2>')
+      end
+    end
+
+    # ---
+
+    def debug?
+      if @debug == nil
+        @debug = (ENV['DEBUG'] == 'true')
+      end
+      @debug
+    end
+  end
+end

data/lib/beckett/version.rb

@@ -0,0 +1,3 @@
+module Beckett
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: beckett
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Corey Innis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: A Markdown renderer, using Kramdown, to convert to JSON, HTML5 or a Ruby
+  Hash.
+email:
+- corey@coolerator.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- beckett.gemspec
+- bin/console
+- bin/setup
+- lib/beckett.rb
+- lib/beckett/node.rb
+- lib/beckett/node/article.rb
+- lib/beckett/node/br.rb
+- lib/beckett/node/codeblock.rb
+- lib/beckett/node/codespan.rb
+- lib/beckett/node/element.rb
+- lib/beckett/node/header.rb
+- lib/beckett/node/root.rb
+- lib/beckett/node/section.rb
+- lib/beckett/node/text.rb
+- lib/beckett/renderer.rb
+- lib/beckett/version.rb
+homepage: https://github.com/coreyti/beckett
+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.2.3
+signing_key: 
+specification_version: 4
+summary: A Markdown-to-JSON/HTML5/Ruby-Hash Renderer.
+test_files: []