graphdown 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b329ba5609ea9ef8ce2ac37f20d4281f03da537
+  data.tar.gz: ef617d20ca0ccac07840e32b55d15544b6a0eba2
+SHA512:
+  metadata.gz: fbc79e190bde04380d98dd47db187e384c88ac38dc9d656f440283dfb3c09b74cca17dd7e3f4e2c4c7d42a6a07856e0e4a7a7b06b891815b136a3ce2e04a47fd
+  data.tar.gz: 1fee7608cea1f178ec37a8cf6f592d3846be1718b1e26abba75d468acdb095401b17098ce1ec2f2ff51ab0e9f5f3e282c98011812f9ec713fae76ca4923d1146

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rspec
+.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 graphdown.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Naoto Kaneko
+
+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,53 @@
+# Graphdown
+
+Markdown extension for embedding graphs.
+
+## Installation
+
+```sh
+$ gem install graphdown
+```
+
+## Requirements
+
+- [Graphviz](http://www.graphviz.org/)
+
+## Usage
+
+```rb
+require "redcarpet"
+require "graphdown"
+
+class BaseRenderer < Redcarpet::Render::HTML
+  include Graphdown::Renderable
+  # include other extensions
+end
+
+markdown = Redcarpet::Markdown.new(BaseRenderer, fenced_code_blocks: true)
+markdown.render(content)
+```
+
+## Example
+
+```md
+# Views transition
+
+\```dot
+digraph sample {
+    A [label = "index.html"];
+    B [label = "show.html"];
+    C [label = "new.html"];
+
+    A -> B [dir = both];
+    A -> C;
+    C -> A [label = "redirect"];
+}
+\```
+
+- Users visit show.html from index.html.
+- Users visit index.html from show.html.
+- Users visit new.html from index.html.
+- Users are redirected to index.html from new.html.
+```
+
+Graphdown parses block codes which language is 'dot' into img tags, which load graph PNG image. The image is generated by Graphviz.

data/Rakefile

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

data/examples/parser.rb

@@ -0,0 +1,13 @@
+require "redcarpet"
+require "graphdown"
+
+class BaseRenderer < Redcarpet::Render::HTML
+  include Graphdown::Renderable
+end
+
+markdown = Redcarpet::Markdown.new(BaseRenderer, fenced_code_blocks: true)
+File.open("sample.md", "rb") do |file|
+  content = file.read
+  html = markdown.render(content)
+  File.open("sample.html", "wb") { |file| file.write(html) }
+end

data/examples/sample.html

@@ -0,0 +1,8 @@
+<h1>Views transition</h1>
+<img src="/Users/naoty/workspace/ruby/graphdown/examples/sample.png"/>
+<ul>
+<li>Users visit show.html from index.html.</li>
+<li>Users visit index.html from show.html.</li>
+<li>Users visit new.html from index.html.</li>
+<li>Users are redirected to index.html from new.html.</li>
+</ul>

data/examples/sample.md

@@ -0,0 +1,18 @@
+# Views transition
+
+```dot
+digraph sample {
+    A [label = "index.html"];
+    B [label = "show.html"];
+    C [label = "new.html"];
+
+    A -> B [dir = both];
+    A -> C;
+    C -> A [label = "redirect"];
+}
+```
+
+- Users visit show.html from index.html.
+- Users visit index.html from show.html.
+- Users visit new.html from index.html.
+- Users are redirected to index.html from new.html.

data/graphdown.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphdown"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Naoto Kaneko"]
+  spec.email         = ["naoty.k@gmail.com"]
+  spec.summary       = %q{Markdown extension for embedding graphs.}
+  spec.homepage      = "https://github.com/naoty/graphdown"
+  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_dependency "redcarpet", "~> 3.0.0"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+end

data/lib/graphdown/renderable.rb

@@ -0,0 +1,38 @@
+require "pathname"
+require "pry"
+
+module Graphdown
+  module Renderable
+    if defined?(block_code)
+      alias block_code_without_graphdown block_code
+    else
+      def block_code_without_graphdown(code, language)
+        %(<p><code>#{code}</code></p>)
+      end
+    end
+
+    def block_code_with_graphdown(code, language)
+      if language == "dot"
+        if code =~ /digraph\s+(\w+)\s+{/
+          dot_path = Pathname.pwd.join("#{$1}.dot")
+          dot_path.open("wb") { |f| f.write(code) }
+          graph_path = Pathname.pwd.join("#{$1}.png")
+          generate_graph(dot_path.to_s, graph_path.to_s)
+          dot_path.delete
+          %(<img src="#{graph_path.to_s}"/>)
+        else
+          %(<img src="#"/>)
+        end
+      else
+        block_code_without_graphdown(code, language)
+      end
+    end
+    alias block_code block_code_with_graphdown
+
+    private
+
+    def generate_graph(source, output)
+      system %(dot -Tpng -o #{output} #{source})
+    end
+  end
+end

data/lib/graphdown.rb

@@ -0,0 +1,5 @@
+lib = File.dirname(__FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "redcarpet"
+require "graphdown/renderable"

data/spec/fixtures/sample.md

@@ -0,0 +1,18 @@
+# Views transition
+
+```dot
+digraph sample {
+    A [label = "index.html"];
+    B [label = "show.html"];
+    C [label = "new.html"];
+
+    A -> B [dir = both];
+    A -> C;
+    C -> A [label = "redirect"];
+}
+```
+
+- Users visit show.html from index.html.
+- Users visit index.html from show.html.
+- Users visit new.html from index.html.
+- Users are redirected to index.html from new.html.

data/spec/fixtures/sample_without_graph.md

@@ -0,0 +1,7 @@
+# Routing
+
+```rb
+SampleApp::Application.routes.draw do
+  resources :contents
+end
+```

data/spec/graphdown/renderable_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+class BaseRenderer < Redcarpet::Render::HTML
+  include Graphdown::Renderable
+end
+
+describe Graphdown::Renderable do
+  let(:markdown) { Redcarpet::Markdown.new(BaseRenderer, fenced_code_blocks: true) }
+  let(:fixtures_path) { Pathname.new("spec/fixtures") }
+  let(:dot_path)      { Pathname.pwd.join("sample.dot") }
+  let(:graph_path)    { Pathname.pwd.join("sample.png") }
+
+  context "when the language of block code is dot" do
+    let(:content) { fixtures_path.join("sample.md").read }
+    after do
+      graph_path.delete if graph_path.exist?
+    end
+
+    it "generates img tag" do
+      html = markdown.render(content)
+      expect(html).to match /<img src="#{graph_path.to_s}"\/>/
+    end
+
+    it "generates graph image file" do
+      markdown.render(content)
+      expect(graph_path).to be_exist
+    end
+  end
+
+  context "when the language of block code isn't dot" do
+    let(:content) { fixtures_path.join("sample_without_graph.md").read }
+
+    it "generates code tag" do
+      html = markdown.render(content)
+      expect(html).to match /<code>.+<\/code>/m
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require File.expand_path("../lib/graphdown", File.dirname(__FILE__))
+require "pathname"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.order = "random"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: graphdown
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naoto Kaneko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: 
+email:
+- naoty.k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/parser.rb
+- examples/sample.html
+- examples/sample.md
+- examples/sample.png
+- graphdown.gemspec
+- lib/graphdown.rb
+- lib/graphdown/renderable.rb
+- spec/fixtures/sample.md
+- spec/fixtures/sample_without_graph.md
+- spec/graphdown/renderable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/naoty/graphdown
+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.14
+signing_key: 
+specification_version: 4
+summary: Markdown extension for embedding graphs.
+test_files:
+- spec/fixtures/sample.md
+- spec/fixtures/sample_without_graph.md
+- spec/graphdown/renderable_spec.rb
+- spec/spec_helper.rb