tavola 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72034f39a54a46e120a0355a0faa5b4f9fbbba54
+  data.tar.gz: fe450e1fecb760cdf35ea59ffaec7f641dd29d94
+SHA512:
+  metadata.gz: 2e1b8af9758ad18a2c58f80c592eeca916fdc9bbbb59e7ea0d8a60b439a1790a416c07541f463aa10d44103ea75e8a49038bff2b9e90461ca87b8162b01d8370
+  data.tar.gz: 8c7728e207bf3a3378c2782b76668f438617f559b15e65d38a359fdb8b3cb0bc358c851bee8db552bb5acf30a6cbbdbba266eea751c8680d03e80eb5d42a0203

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-sass'
+
+  # Use this to have interactive test feedback
+  gem 'guard-livereload'
+
+  gem 'rspec'
+  gem 'flexmock'
+end

data/Guardfile

@@ -0,0 +1,18 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+require './spec/support/unicorn_hunter'
+guard 'unicorn_hunter' do
+  watch %r(lib/tavola/(.+)\.rb$)
+  watch %r(lib/tavola/(.+)\.slim$)
+end
+
+guard 'sass', :input => 'lib/tavola/public/stylesheets'
+
+guard 'livereload', grace_period: 0.1 do
+  watch %r(qed/.*)
+  watch %r(lib/.*)
+end

data/LICENSE

@@ -0,0 +1,23 @@
+
+ Copyright (c) 2014 Kaspar Schiess
+
+ 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

@@ -0,0 +1,10 @@
+
+SYNOPSIS
+
+To use this, run 
+
+  bin/tavola run
+
+in a directory of your choice. Then navigate to localhost:8080 and follow 
+the on-screen instructions.
+

data/bin/tavola

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+binary = Pathname.new(__FILE__)
+$:.unshift binary.dirname.dirname.join('lib')
+
+require 'tavola/cli'
+
+Tavola::CLI.run

data/lib/tavola/cli.rb

@@ -0,0 +1,39 @@
+
+require 'clamp'
+require 'rack'
+require 'unicorn'
+require 'pathname'
+
+module Tavola
+
+  class CLI < Clamp::Command
+    subcommand 'run', <<-DESC.strip do
+        runs tavola on either the current directory or the given directory.
+      DESC
+
+      def execute
+        app = lambda do || 
+          require 'tavola/configuration'
+          require 'tavola/web'
+          
+          Tavola::Web.set :tavola_config, 
+            Tavola::Configuration.new(
+              base_dir: Pathname.new(Dir.pwd))
+        
+          Rack::Builder.new do
+            use Rack::ContentLength
+            use Rack::Chunked
+            use Rack::CommonLogger, $stderr
+            use Rack::ShowExceptions
+            use Rack::Lint
+
+            run Tavola::Web
+          end.to_app
+        end
+
+        Unicorn::HttpServer.new(app).start.join
+      end
+    end
+  end
+
+end

data/lib/tavola/configuration.rb

@@ -0,0 +1,10 @@
+
+module Tavola
+  class Configuration
+    attr_reader :base_dir
+
+    def initialize opts={}
+      @base_dir = opts[:base_dir]
+    end
+  end
+end

data/lib/tavola/demonstrations.rb

@@ -0,0 +1,81 @@
+
+require 'stringio'
+
+require 'qed/settings'
+require 'qed/session'
+require 'tavola/qed/reporter'
+
+module Tavola
+  class Demonstrations
+    def initialize config
+      @config = config
+    end
+
+    def root
+      root = @config.base_dir
+    end      
+
+    def all
+      Dir[root.join('**/*.md')].map { |path|
+        Demonstration.new(@config, path) }
+    end
+
+    def find path
+      Demonstration.new(@config, root.join(path))
+    end
+
+  end
+
+  class Demonstration
+    attr_reader :path
+
+    def initialize config, path
+      @config = config
+      @path = path
+    end
+
+    def root
+      root = @config.base_dir
+    end      
+    attr_reader :path
+
+    def relative_path
+      remove_root(path)
+    end
+
+    def render
+      qed_augment(path)
+      # File.read(path)
+    end
+
+    def qed_augment path
+      # Mostly a copy from Session#run in QED.
+      settings = ::QED::Settings.new()
+      session  = ::QED::Session.new(settings)
+
+      io = StringIO.new
+      reporter = QED::Reporter.new(io: io)
+      
+      session.prepare_loadpath
+      session.require_libraries
+
+      demo = ::QED::Demo.new(path, at: root)
+      demo.steps
+
+      ::QED::Evaluator.run(demo, observers: [reporter], settings: settings)
+
+      p io
+      io.string
+    end
+
+  private
+    def remove_root path
+      root_len = root.to_s.size
+
+      stripped = path[root_len..-1]
+      return stripped[1..-1] if stripped.start_with? '/'
+        
+      stripped
+    end
+  end
+end

data/lib/tavola/kramdown_rouge.rb

@@ -0,0 +1,30 @@
+require 'rouge'
+
+# This little hack here plugs the rouge syntax highlighter into the kramdown
+# markdown converter. 
+Kramdown::Converter::Html.class_eval do
+  def convert_codeblock(el, indent)
+    attr = el.attr.dup
+    language = extract_code_language!(attr)
+    highlight(el.value, language)
+  end
+
+  def highlight(code, language=nil, opts={})
+    lexer = Rouge::Lexer.find_fancy(language, code) || Rouge::Lexers::PlainText
+
+    options = {
+      line_numbers: false, 
+      css_class: 'highlight', 
+      inline_theme: nil, 
+      wrap: true, 
+      lexer_options: {}
+    }
+
+    highlighter_options = options.to_h.merge(opts)
+    highlighter_options[:css_class] = [ highlighter_options[:css_class], lexer.tag ].join(' ')
+    lexer_options = highlighter_options.delete(:lexer_options)
+
+    formatter = Rouge::Formatters::HTML.new(highlighter_options)
+    formatter.format(lexer.lex(code, lexer_options))
+  end
+end

data/lib/tavola/public/stylesheets/tavola.css

@@ -0,0 +1,4 @@
+.example.green pre {
+  border: 1px solid green; }
+.example.red pre {
+  border: 1px solid red; }

data/lib/tavola/public/stylesheets/tavola.sass

@@ -0,0 +1,9 @@
+
+.example
+  &.green
+    pre 
+      border: 1px solid green
+
+  &.red
+    pre 
+      border: 1px solid red

data/lib/tavola/qed/reporter.rb

@@ -0,0 +1,163 @@
+
+require 'qed/reporter/abstract'
+
+module Tavola
+module QED
+  class Reporter < ::QED::Reporter::Abstract
+
+    #
+    def before_session(session)
+      @start_time = Time.now
+    end
+
+    def step(step)
+      @_explain = step.explain.dup
+    end
+
+    #
+    def match(step, md)
+      unless md[0].empty?
+        @_explain.sub!(md[0], md[0])
+      end
+    end
+
+    #
+    def applique(step)
+      io.print "#{@_explain}"
+      io.print "#{step.example}" #
+    end
+
+    #
+    def pass(step)
+      super(step)
+      print_step_heading(step)
+
+      if step.has_example? 
+        wrap_example 'green' do
+          print_step_example(step)
+        end
+      end
+    end
+
+    #
+    def fail(step, error)
+      super(step, error)
+
+      tab = step.text.index(/\S/)
+
+      print_step_heading(step)
+
+      if step.has_example? 
+        wrap_example('red') do
+          print_step_example(step)
+        end
+      end
+
+      msg = []
+      msg << "FAIL: " + error.message.to_s #to_str
+      msg << sane_backtrace(error).join("\n")
+      msg = msg.join("\n")
+
+      wrap_failure(msg)
+    end
+
+    #
+    def error(step, error)
+      super(step, error)
+
+      raise error if $DEBUG   # TODO: Should this be here?
+
+      tab = step.text.index(/\S/)
+
+      print_step_heading(step)
+
+      if step.has_example? 
+        wrap_example('red') do
+          print_step_example(step)
+        end
+      end
+
+      msg = []
+      msg << "ERROR: #{error.class} " + error.message #.sub(/for QED::Context.*?$/,'')
+      msg << sane_backtrace(error).join("\n")
+      msg = msg.join("\n") #
+
+      wrap_failure(msg)
+    end
+
+    def after_session(session)
+      trap 'INFO', 'DEFAULT' if INFO_SIGNAL
+      print_time
+      print_tally
+    end
+
+  private
+
+    def wrap_failure text
+      text = text.
+        gsub(%r(^FAIL: (.*)$)) { md = $~ 
+          %Q(<span class="text-danger">FAIL</span>: <span class="text-warning">#{md[1]}</span>)}.
+        gsub(%r(^ERROR: (\w+) (.*)$)) { md = $~ 
+          %Q(<span class="text-danger">ERROR</span>: (<span class="text-primary">#{md[1]}</span>) <span class="text-warning">#{md[2]}</span>) }
+      io.puts '<pre>'
+      io.puts text
+      io.puts '</pre>'
+      io.puts
+    end
+    def wrap_code_block language=nil
+      io.puts '~~~' + language.to_s
+      yield
+      io.puts '~~~'
+      io.puts
+    end
+    def clean_whitespace example
+      indent = nil
+      lines = example.lines.
+        map { |l| 
+          md = l.match(/^( +)/)
+          indent = md[1].size unless indent
+
+          l[indent..-1] }.join
+    end
+    def print_step_example step
+      if step.data?
+        wrap_code_block do
+          io.print "#{clean_whitespace(step.example)}"
+        end
+      else
+        wrap_code_block 'ruby' do
+          io.print "#{clean_whitespace(step.example)}"
+        end
+      end
+    end
+    def print_step_heading step
+      if step.heading?
+        if step.code?
+          io.print "#{@_explain}"
+        else
+          io.print "#{@_explain}"
+        end
+      else
+        io.print "#{@_explain}"
+      end
+    end
+    def wrap_example color
+      io.puts %Q({::options parse_block_html="true" /})
+      io.puts %Q(<div class="example #{color}">)
+      
+      yield
+
+      io.puts %Q(</div>)
+      io.puts
+    end
+
+
+  end
+
+end # module QED
+end # module Tavola
+
+# Install the reporter below QED::Reporter - it was kind of obvious we'd have
+# to do this.
+QED::Reporter::Enhance = Tavola::QED::Reporter
+

data/lib/tavola/views/index.slim

@@ -0,0 +1,7 @@
+
+p 
+  h1 
+    | Tavola 
+    small the table where QEDs display
+
+  | Please select a demonstration on the left.

data/lib/tavola/views/layout.slim

@@ -0,0 +1,25 @@
+doctype html
+html
+  head
+    title La Tavola
+
+    link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"
+    script src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"
+
+    link rel="stylesheet" href="/stylesheets/rouge.css"
+    link rel="stylesheet" href="/stylesheets/tavola.css"
+
+  body
+    .container
+      .row
+        / X-file Navigation
+        .col-md-3
+          h1 Other QEDs
+          ul.nav
+            - for demonstration in @all
+              li
+                a href="/#{demonstration.relative_path}"= demonstration.relative_path
+
+        / Content
+        .col-md-9
+          == yield

data/lib/tavola/views/stylesheets/rouge.css.erb

@@ -0,0 +1 @@
+<%= Rouge::Themes::Github.render(:scope => '.highlight') %>

data/lib/tavola/web.rb

@@ -0,0 +1,40 @@
+
+require 'sinatra/base'
+
+require 'slim'
+require 'kramdown'
+Tilt.prefer Tilt::KramdownTemplate
+require 'tavola/kramdown_rouge'
+
+require 'tavola/demonstrations'
+
+module Tavola
+  class Web < Sinatra::Base
+    before do
+      @all = demonstrations.all
+    end
+
+    get '/' do
+      slim :'index'
+    end
+
+    get '/stylesheets/rouge.css' do
+      content_type 'text/css'
+      erb :'stylesheets/rouge.css' 
+    end
+
+    get '*' do
+      return pass unless params[:splat].first.match(/.*\.md$/)
+
+      path = params[:splat].first[1..-1] # relative path
+      demonstration = demonstrations.find(path)
+
+      markdown demonstration.render, layout_engine: :slim, layout: :layout
+    end
+
+  private
+    def demonstrations
+      Demonstrations.new(settings.tavola_config)
+    end
+  end
+end

data/qed/example.md

@@ -0,0 +1,27 @@
+
+# When all is good
+
+then the example will be highlighted in green. 
+
+    1.assert == 1
+
+# When the assertion fails
+
+the example will be highlighted in red. The assertion failure is printed right after the example. 
+
+    1.assert == 3
+
+# When an exception is raised
+
+the example will be red as well. Exception backtrace is printed below. 
+
+    fail "Some error has occurred."
+
+# Installation Tips
+
+Use [`guard-livereload`](https://github.com/guard/guard-livereload) and the Chrome LiveReload extension to get immediate test feedback upon saving. Your `Guardfile` would look like this: 
+
+    guard 'livereload', grace_period: 0.1 do
+      watch %r(qed/.*)
+    end
+

data/spec/support/unicorn_hunter.rb

@@ -0,0 +1,14 @@
+require 'guard/guard'
+
+module Guard
+  class UnicornHunter < Guard
+    # Called on file(s) modifications that the Guard watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    def run_on_change(paths)
+      if system("killall -m 'tavola worker'")
+        puts "Unicorn hunter has found a unicorn..."
+      end
+    end
+  end
+end

data/tavola.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name     = "tavola"
+  s.version  = '0.1.0'
+  s.summary  = "Interactive runner for qed tests"
+  # s.homepage = "http://todo.project.com/"
+  s.authors  = ['Kaspar Schiess']
+  s.email    = ["kaspar.schiess@absurd.li"]
+    
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency 'ae', '>= 1.8'
+  s.add_runtime_dependency 'qed', '>= 2.9'
+
+  s.add_runtime_dependency 'sinatra', '> 1.2', '< 1.5'  
+  s.add_runtime_dependency 'padrino-helpers'
+
+  s.add_runtime_dependency 'clamp'  
+
+  s.add_runtime_dependency 'kramdown'  
+  s.add_runtime_dependency 'rouge'  
+  s.add_runtime_dependency 'slim'  
+
+  s.add_runtime_dependency 'unicorn'  
+  s.add_runtime_dependency 'rack'  
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: tavola
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kaspar Schiess
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ae
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: padrino-helpers
+  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: clamp
+  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: 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: rouge
+  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: slim
+  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: unicorn
+  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: rack
+  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'
+description: 
+email:
+- kaspar.schiess@absurd.li
+executables:
+- tavola
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Guardfile
+- LICENSE
+- README
+- bin/tavola
+- lib/tavola/cli.rb
+- lib/tavola/configuration.rb
+- lib/tavola/demonstrations.rb
+- lib/tavola/kramdown_rouge.rb
+- lib/tavola/public/stylesheets/tavola.css
+- lib/tavola/public/stylesheets/tavola.sass
+- lib/tavola/qed/reporter.rb
+- lib/tavola/views/index.slim
+- lib/tavola/views/layout.slim
+- lib/tavola/views/stylesheets/rouge.css.erb
+- lib/tavola/web.rb
+- qed/example.md
+- spec/support/unicorn_hunter.rb
+- tavola.gemspec
+homepage: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Interactive runner for qed tests
+test_files:
+- spec/support/unicorn_hunter.rb