mdspec 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzU5ZDc5YTcwNTY5OWI2ODFjMWMxNzVhNDIyNDEyZTBiYTYwYzhmMQ==
+  data.tar.gz: !binary |-
+    ZWJhYTk2MDJiYThjZmRiNmVhZjEyOThkZjc5ZjAzNWZjYmU4MGRmMg==
+SHA512:
+  metadata.gz: !binary |-
+    YTRlMDY5ZWRjNWI1NGYwYzM1NjVhZWIwYjUzNzY4ODA4ZjhjNWEzYzZhOTc1
+    M2E2YmZlZWNlY2Y3NTkyZjg4NmJmYmNiODY0YzI1ZTgzOTQ4ZTczNzg1MWJl
+    NmQ5OWJmNTM5ZDUyMzE2NTYwOGM2ZDI3YWYwMGJjOGMyNDFkNTM=
+  data.tar.gz: !binary |-
+    MzE4Yjg4MzZiMWUyODY3MzUwZDcxMmJhMzY5NWVjMmEwZTk4MDBmOWIzNDFj
+    ODk4Yzg2YTFlMWY2ZDExNWE3MzI0NjdhNWZiOWQwOTZlNWI2YTY4YWY1Nzk4
+    ZjAzNjVjMGEwZjQ2ZjcyZmVkYTJhZjYyMGQwN2ExMTNiNGVkN2E=

data/.gitignore

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

data/.mdspec.yml

@@ -0,0 +1,16 @@
+# global rules
+rules:
+  # pre-defined rule to run each command
+  shell: bash-repl
+
+  # it is able to define a custom command
+  yml:
+    type: command
+    command: yaml-lint
+
+# rules for specified files
+README.md:
+  # match pattern
+  /Config/:
+    type: diff
+    diff: .mdspec.yml

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+
+rvm:
+  - "2.3.0"
+  - "2.2"
+  - "2.1"
+  - "2.0"
+  - "1.9"
+
+cache:
+  bundler: true
+
+script:
+  - bundle exec rake
+  - bundle exec mdspec README.md
+
+deploy:
+  provider: rubygems
+  api_key:
+    master:
+      secure: "Q26pMTrS3l/JHFbo/Qk/rhmLhYz6oMJppENKwiaBuR1TjzOpavgUAaFJpgUUgl0P+iHy0Oja3YBoSUm4TEacYjiZfH3FFD8TYsGCuQbN4dvmH9xhn7yycS3zTICTWi6iY0GY1h/k6kjre6gxpDOTQt/O0PBrBN4aa3hjBfbZSXCRMI2aAhJm82mU5q14QIfmJYepXnO5XJ9sZleK7RDDddm/ey3a3XKkR3Tx6kQwrU8u6GJWJRXBVC3dMHYD2BVgWk8AawttSZPJezgPoUrp53p4Ha15fJA+KEWf64azPvqsY4FrofYVh3+mjuHi/BVXJC0NAaI6ijHEkZsFnpA8ERZ6M5XjQ3nsrICqc8lwJwHBAY+sHlZc1W2NrFbg3HDokca/efl+5MHkr9YHOnQdINGAH48CXdMX98bOonhaNwhe1NLADTzDklUI/nzj17t4RsgoB5qZcJ6q6blmKeJql6Q6PsW4xLpTmMGY5aDPulPFJRPqJYy9UXwT82MkBWrMc7B3QpkQ8Fb0FWaxNGa3+dCteUAU5iU7eqFZscgJyPJlpF5R/ELbSHx+bO/pWDASd5iRHQ+97ca6taW7eSdloPJEP1YKMYo2X0I5kfzMdmjxO1EW632yQq1oqVywE1yDM1FtuMwMTbg1VWenn6Ql6U0pFvx1WHCEg3mlj9mZmM4="
+  gem:
+    master: mdspec
+  on:
+    repo: mdspec/mdspec
+    ruby: "2.3.0"

data/Gemfile

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

data/README.md

@@ -0,0 +1,59 @@
+# MdSpec: Testable Markdown for Documentation Testing :memo:
+
+**MdSpec** is a testing tool for example codes of your markdown files like ***README.md***.
+
+## Usage
+
+```shell
+$ mdspec --version
+MdSpec version ***
+$ mdspec README.md
+
+README.md
+  Usage
+    should pass `$ mdspec --version`
+    should pass `$ mdspec README.md`
+  Example of Configurations
+    should be .mdspec.yml
+    should pass yaml-lint
+
+Finished in *** seconds
+4 examples, 0 failures
+
+```
+
+## Example of Configurations
+
+```yml
+# global rules
+rules:
+  # pre-defined rule to run each command
+  shell: bash-repl
+  # it is able to define a custom command
+  yml:
+    type: command
+    command: yaml-lint
+
+# rules for specified files
+README.md:
+  # match pattern
+  /Config/:
+    type: diff
+    diff: .mdspec.yml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mdspec/mdspec.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["--format doc", "--color"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mdspec"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mdspec

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "mdspec"
+MdSpec::CLI.new(ARGV.clone)

data/lib/mdspec.rb

@@ -0,0 +1,12 @@
+require "optparse"
+require "yaml"
+require "kramdown"
+require "colorize"
+require "mdspec/version"
+require "mdspec/parser"
+require "mdspec/runner"
+require "mdspec/runner/base_runner"
+require "mdspec/runner/diff"
+require "mdspec/runner/bash_repl"
+require "mdspec/runner/command"
+require "mdspec/cli"

data/lib/mdspec/cli.rb

@@ -0,0 +1,124 @@
+module MdSpec
+  class CLI
+    def initialize(argv)
+      parse_options(argv)
+      exit 0 if within_mdspec?
+      @config = ::YAML.parse(::File.read(".mdspec.yml")).to_ruby
+      @global_rules = config.fetch("rules", [])
+      normalize! global_rules
+      @rules = global_rules
+
+      # load and run markdown
+      render argv.map(&load_and_run)
+    end
+
+    private
+      attr_reader :config
+      attr_reader :global_rules
+      attr_reader :rules
+
+      def parse_options(argv)
+        opts = ::OptionParser.new
+
+        opts.on_tail("--version", "Show version") do
+          puts "MdSpec version #{VERSION}"
+          exit
+        end
+
+        opts.parse!(argv)
+      end
+
+      def render(results, level = 0)
+        puts ""
+        @num = 0
+        @ok = 0
+        render_results results
+        puts ""
+        puts "Finished in 1 seconds"
+        puts "#{@num} examples, #{@num - @ok} failures"
+        puts ""
+      end
+
+      def render_results(results, level = 0)
+        results.each do |result|
+          unless result[:flat]
+            print "  " * level
+            if result[:childs].nil?
+              @num += 1
+              @ok += 1 if result[:result]
+              if result[:result]
+                puts result[:name].colorize(:green)
+              else
+                puts result[:name].colorize(:red)
+              end
+            else
+              puts result[:name]
+            end
+          end
+          next_level = result[:flat] ? level : level + 1
+          render_results result[:childs], next_level unless result[:childs].nil?
+        end
+      end
+
+      def within_mdspec?
+        ENV["MDSPEC_WITHIN_MDSPEC"].to_i >= 2
+      end
+
+      def normalize!(rules)
+        rules.each do |k, v|
+          rules[k] = symbolize({ :pattern => pattern_for(k) }.merge!(v.is_a?(Hash) ? v : { :type => v }))
+        end
+      end
+
+      def symbolize(hash)
+        hash.reduce({}) do |nxt, (k, v)|
+          nxt[k.to_sym] = v
+          nxt
+        end
+      end
+
+      def pattern_for(k)
+        ::Regexp.compile(k.match(/^\/.*\/$/) ? k[1..-2] : "^#{k}$")
+      end
+
+      def load_and_run
+        lambda do |path|
+          markdown = ::File.read(path)
+          local_rules = config.fetch(path, {})
+          normalize! local_rules
+          @rules = global_rules.merge!(local_rules)
+
+          root = { :name => path, :result => true, :childs => [] }
+          Parser.new(markdown).codeblocks.select(&match?).each do |cb|
+            block_root = { :name => cb.name, :childs => [] }
+            [cb.name, cb.lang].each do |key|
+              block_root[:childs].push(run(key, cb)) if match_pattern?(key)
+            end
+            root[:childs].push(block_root)
+          end
+
+          root
+        end
+      end
+
+      def run(key, codeblock)
+        if opts = ruleopts(key)
+          Runner.for(opts[1]).run(codeblock)
+        end
+      end
+
+      def ruleopts(key)
+        rules.find {|_, v| v[:pattern] === key }
+      end
+
+      def match?
+        lambda do |cb|
+          match_pattern?(cb.lang) or match_pattern?(cb.name)
+        end
+      end
+
+      def match_pattern?(item)
+        rules.any? {|_, v| v[:pattern] === item }
+      end
+  end
+end

data/lib/mdspec/parser.rb

@@ -0,0 +1,48 @@
+module MdSpec
+  class Parser
+    attr_reader :codeblocks
+
+    def initialize(text)
+      @codeblocks = []
+      parse text
+    end
+
+    private
+      attr_reader :last_header
+
+      def parse(text)
+        @last_header = nil
+        walk ::Kramdown::Document.new(text, :input => "GFM").root
+      end
+
+      def walk(node)
+        codeblocks.push(codeblock(node)) if node.type == :codeblock
+        @last_header = header(node)
+        node.children.each {|child| walk child }
+      end
+
+      def header(node)
+        if node.type == :header
+          node.children.first.value
+        elsif node.type == :text && node.value.match(/^#/)
+          node.value.match(/^#+(.*)/)[1].strip
+        elsif node.type == :codeblock
+          nil
+        else
+          last_header
+        end
+      end
+
+      def codeblock(node)
+        ::Struct.new(:src, :name, :lang).new(node.value, last_header, lang(node))
+      end
+
+      def lang(node)
+        if name = node.attr["class"]
+          name.match(/^language-(.*)/)[1]
+        else
+          "text"
+        end
+      end
+  end
+end

data/lib/mdspec/runner.rb

@@ -0,0 +1,14 @@
+module MdSpec
+  module Runner
+    class << self
+      def for(opts)
+        const_get(classname(opts[:type])).new(opts)
+      end
+
+      def classname(type)
+        raise "illegal type" unless /^[a-zA-Z0-9\-]+$/ === type
+        type.capitalize.gsub(/-[a-z]/) {|m| m[1..-1].capitalize }
+      end
+    end
+  end
+end

data/lib/mdspec/runner/base_runner.rb

@@ -0,0 +1,21 @@
+module MdSpec::Runner
+  class BaseRunner
+    def initialize(opts)
+      @opts = opts
+    end
+
+    protected
+      attr_reader :opts
+
+      def sh(cmd, output, opts = {})
+        ::IO.popen(cmd, "r+") do |io|
+          io.puts opts[:input] unless opts[:input].nil?
+          io.close_write
+          while line = io.gets
+            output.puts line
+          end
+        end
+        $?.to_i # exit status
+      end
+  end
+end

data/lib/mdspec/runner/bash_repl.rb

@@ -0,0 +1,59 @@
+module MdSpec::Runner
+  class BashRepl < BaseRunner
+    WITHIN_KEY = "MDSPEC_WITHIN_MDSPEC"
+
+    def initialize(_)
+      super
+      @prompt = opts.fetch(:prompt, "$ ")
+    end
+
+    def run(codeblock)
+      root = { :name => "repl", :childs => [], :flat => true }
+      each_with_counter(examples_for(codeblock)) do |example|
+        output = ::StringIO.new
+        status = sh(example[:cmd], output)
+        root[:childs].push(
+          :name => "should pass \`$ #{example[:cmd]}\`",
+          :result => status === 0 && same?(example[:expected], output.string.split("\n")),
+          :output => output.string,
+        )
+      end
+      root
+    end
+
+    private
+      attr_reader :prompt
+
+      def each_with_counter(items, &b)
+        ENV[WITHIN_KEY] = (ENV.fetch(WITHIN_KEY, 0).to_i + 1).to_s
+        items.each(&b)
+        ENV[WITHIN_KEY] = (ENV[WITHIN_KEY].to_i - 1).to_s
+      end
+
+      def examples_for(codeblock)
+        codeblock.src.split($/).reduce([]) do |examples, line|
+          if line.start_with?(prompt)
+            examples.push(:cmd => line[prompt.length..-1], :expected => [])
+          else
+            examples.last[:expected].push(line) unless examples.empty?
+          end
+          examples
+        end
+      end
+
+      def same?(a, b)
+        # return false if a.length < b.length
+        b.map! {|s| s.uncolorize }
+        while not b.empty?
+          la = a.shift.split
+          lb = b.shift.split
+          la.each_with_index {|_, k| return false unless same_word?(la[k], lb[k]) }
+        end
+        return true
+      end
+
+      def same_word?(a, b)
+        /^\*{3,}/ === a || a === b
+      end
+  end
+end

data/lib/mdspec/runner/command.rb

@@ -0,0 +1,9 @@
+module MdSpec::Runner
+  class Command < BaseRunner
+    def run(codeblock)
+      output = ::StringIO.new
+      status = sh(opts[:command], output)
+      { :name => "should pass #{opts[:command]}", :result => status === 0 }
+    end
+  end
+end

data/lib/mdspec/runner/diff.rb

@@ -0,0 +1,18 @@
+module MdSpec::Runner
+  class Diff < BaseRunner
+    def run(codeblock)
+      out = ::StringIO.new
+      status = sh(command, out, :input => codeblock.src)
+      { :name => "should be #{opts[:diff]}", :result => status === 0 }
+    end
+
+    def command
+      cmd = []
+      cmd << "diff"
+      cmd << "--ignore-blank-lines"
+      cmd << opts[:diff]
+      cmd << "-"
+      cmd.join(" ")
+    end
+  end
+end

data/lib/mdspec/version.rb

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

data/mdspec.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mdspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mdspec"
+  spec.version       = MdSpec::VERSION
+  spec.authors       = ["Hiroyuki Sano"]
+  spec.email         = ["sh19910711@gmail.com"]
+
+  spec.summary       = %q{Markdown as testable document.}
+  spec.homepage      = "https://github.com/mdspec/mdspec"
+
+  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_runtime_dependency "colorize", "~> 0.7"
+  spec.add_runtime_dependency "kramdown", "~> 1.10"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "yaml-lint", "~> 0.0.7"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: mdspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiroyuki Sano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yaml-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+description: 
+email:
+- sh19910711@gmail.com
+executables:
+- mdspec
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .mdspec.yml
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mdspec
+- lib/mdspec.rb
+- lib/mdspec/cli.rb
+- lib/mdspec/parser.rb
+- lib/mdspec/runner.rb
+- lib/mdspec/runner/base_runner.rb
+- lib/mdspec/runner/bash_repl.rb
+- lib/mdspec/runner/command.rb
+- lib/mdspec/runner/diff.rb
+- lib/mdspec/version.rb
+- mdspec.gemspec
+homepage: https://github.com/mdspec/mdspec
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Markdown as testable document.
+test_files: []