akui 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd251f0e99f3f1dd669ea8d500f30f32a71a886e
+  data.tar.gz: 72ef2a7389575d1b2f3624540c685060a64c2495
+SHA512:
+  metadata.gz: ac1f3f89695f6a27abbc79d11cdbc556f9e80e60b114ca82cac36758eee2a8ee3e5f6d8f9f2e740065cba67cae994ebbc1fee2ba6a55916e27cf1def4170b8a9
+  data.tar.gz: dd8d327f496c56a04be1cc14d73fd5ee334d8c8678edb9e07a52e942137739850294315b83143252aa2934bae3ee8f42a41b97f5ad0327be4c35a1c082439c52

data/.bowerrc

@@ -0,0 +1,5 @@
+{
+  "directory": "Public/bower_components",
+  "timeout": 5000,
+  "strict-ssl": true
+}

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/Public
+node_modules/
+
+bin/bower

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,23 @@
+
+Copyright (c) 2015 da99
+
+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,43 @@
+
+Intro:
+=====
+
+A Ruby gem that helps me automate testing JS code on the browser.
+It uses a Rack middleware to include JS testing code files
+into the rendered HTML.
+
+This is not useful to you. Instead, use the following for testing
+stuff in the browser:
+
+  * [Bromine.js](http://cheggeng.github.io/Bromine/)
+  * [Karma (aka Testacular)](http://karma-runner.github.io/)
+  * [Casper.js](http://casperjs.org/)
+  * [Buster.js](http://busterjs.org/)
+  * [Watir](http://watir.com)  <--- my favorite
+  * ... and a million other alternatives.
+
+Dependencies
+============
+
+  * jQuery >= 1.9.1+
+  * Underscore >= 1.4.3
+  * [Fermata](https://github.com/natevw/fermata) > 0.0.0
+
+Install:
+========
+
+```ruby
+  gem install akui
+```
+
+NOTE:
+=====
+
+This was originally a npm module.
+That code is still available in the
+[nodejs branch](https://github.com/da99/akui/tree/nodejs).
+
+
+
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/akui.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "akui"
+  spec.version       = `cat VERSION`
+  spec.authors       = ["da99"]
+  spec.email         = ["i-hate-spam-1234567@mailinator.com"]
+  spec.summary       = %q{My way of testing browser/client-side code.}
+  spec.description   = %q{
+    Automate testing code on the browser by using Rack
+    middleware to include JS testing code files
+    into your rendered HTML.
+  }
+  spec.homepage      = "https://github.com/da99/akui"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |file|
+    file.index('bin/') == 0 && file != "bin/#{File.basename Dir.pwd}"
+  }
+  spec.executables   = spec.files.grep("bin/#{spec.name}") { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_dependency "cuba", "> 3.3"
+  spec.add_dependency "escape_escape_escape", "> 1.4"
+
+  spec.add_development_dependency "pry"           , "~> 0.9"
+  spec.add_development_dependency "www_app"       , "> 2.0"
+  spec.add_development_dependency "bundler"       , "~> 1.5"
+  spec.add_development_dependency "bacon"         , "~> 1.0"
+  spec.add_development_dependency "Bacon_Colored" , "~> 0.1"
+  spec.add_development_dependency "thin" , "> 1.6"
+  spec.add_development_dependency "rack-contrib" , "> 0.1"
+end

data/bin/akui

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+#
+#
+dir = File.dirname(__FILE__)
+exec('bash', "#{dir}/akui.sh", *ARGV)
+
+
+
+

data/lib/akui.rb

@@ -0,0 +1,241 @@
+
+require 'cuba'
+require 'escape_escape_escape'
+
+class Akui
+
+  VERSION = `cat #{File.dirname __FILE__}/../VERSION`.strip
+  MOVED_TEMP    = 302
+
+  class Middleware < Cuba
+
+    define {
+      on get do
+        on(root) {
+          res.write <<-EOF
+          <html>
+            <head>
+              <title>Akui v#{::Akui::VERSION}</title>
+              <style type="text/css">
+                body, pre {
+                  background: #F2F2F2;
+                  font-family: Ubuntu Mono, monospace;
+                }
+                a:link {
+                  padding: 4px;
+                }
+                a:hover {
+                  background: green;
+                  color: #fff;
+                }
+              </style>
+            </head>
+            <body>
+              <a href="#{File.join req.env['REQUEST_PATH'], '/run'}">Run all</a>
+              <pre>#{::Akui.print}</pre>
+            </body>
+          </html>
+          EOF
+        }
+
+        on('results') {
+          Akui.stop
+          res.write <<-EOF
+            <html>
+              <head>
+                <title>Akui Results</title>
+                <style type="text/css">
+                  body, pre {
+                    background: #F2F2F2;
+                    font-family: Ubuntu Mono, monospace;
+                  }
+                  a:link {
+                    padding: 4px;
+                  }
+                  a:hover {
+                    background: green;
+                    color: #fff;
+                  }
+                </style>
+              </head>
+              <body>
+                <p>All tests appear to have passed:</p>
+              <a href="#{File.expand_path(File.join req.env['REQUEST_PATH'], '../run')}">Run all</a>
+                <pre>#{::Akui.print}</pre>
+              </body>
+            </html>
+          EOF
+        }
+
+        on('inspect') {
+          res['Content-Type'] = 'application/json'
+          res.write Escape_Escape_Escape.json_encode({tests: ::Akui.tests})
+        }
+
+        on('run') {
+          Akui.reset
+          Akui.shift
+          res.redirect Akui.current[:parent][:path].to_s, ::Akui::MOVED_TEMP
+        }
+      end # === on get
+
+
+      on post do
+        on('result', param('result')) { |result|
+          past[:result] = result
+          res['Content-Type'] = 'application/json'
+          res.write Escape_Escape_Escape.json_encode({:result=>result})
+        }
+
+        on('run') {
+          pathname = URI.parse(req.env['HTTP_REFERER']).path
+          res['Content-Type'] = 'application/json'
+
+          case
+          when Akui.running? && !Akui.done?
+            test = Akui.shift
+            if pathname != test[:parent][:path].to_s
+              res.write Escape_Escape_Escape.json_encode({:test=>nil, :error=>"Wrong path name: expected: #{test[:parent][:path]}  actual: #{pathname}"})
+            else
+              res.write Escape_Escape_Escape.json_encode({:test=>test})
+            end
+
+          when Akui.running? && Akui.done?
+            res.write Escape_Escape_Escape.json_encode({:test=>nil, :redirect=>File.expand_path(File.join(req.env['REQUEST_PATH'], '../results'))})
+
+          else
+            Akui.reset
+            Akui.shift
+
+            while (test = Akui.shift) && test[:parent][:path] != pathname
+            end
+
+            if test
+              res.write Escape_Escape_Escape.json_encode({:test=>test})
+            else
+              res.write Escape_Escape_Escape.json_encode({:test=>nil, :error=>'No test found.'})
+            end
+          end
+        }
+      end # === on pot
+    }
+
+  end # === class Middleware
+
+  class << self
+
+    def stop
+      @current_tests = nil
+    end
+
+    def reset
+      @current_tests = tests.map { |d|
+        d[:its].map { |i|
+          i = i.dup
+          i[:parent] = d
+          i
+        }
+      }.flatten
+      @current_tests.unshift false
+      @results = []
+      @past    = []
+    end
+
+    def shift
+      t = @current_tests.shift
+      if @current_tests.empty?
+      end
+      @past.push t
+      t
+    end
+
+    def past
+      past.last
+    end
+
+    def current
+      @current_tests.first
+    end
+
+    def done?
+      running? && @current_tests.empty?
+    end
+
+    def running?
+      return false if !@current_tests
+      true
+    end
+
+    def print *args
+      type, o = args
+      case type
+
+      when nil, :all
+        tests.map { |desc|
+          print :desc, desc
+        }.join "\n".freeze
+
+      when :describe, :desc
+        %^DESC <a href="#{Escape_Escape_Escape.relative_href o[:path].to_s}">#{Escape_Escape_Escape.html o[:path].to_s}</a> #{o[:name] && o[:name].inspect}\n^ +
+          %^#{o[:its].map { |it| print :it, it }.join "\n"}^
+
+      when :it
+        %^  it #{o[:name].inspect}\n#{o[:script]}^
+
+      else
+        fail ArgumentError, "Unknown args: #{args.inspect}"
+      end
+    end
+
+    def define
+      instance_eval(&Proc.new)
+    end
+
+    def tests
+      @tests ||= []
+    end
+
+    def describe path, name = nil
+      if @current
+        fail <<-EOF.strip
+         NOTE:
+         Do not use DESCRIBE in nested fashion.
+         You can try, but it was not designed
+         to work like this, in order to make
+         my life easier w/ a simple implementation.
+
+         Use it like this:
+           describe {
+           }
+
+           describe {
+           }
+
+           describe {
+           }
+        EOF
+      end
+
+      tests.<<(
+        @current = {
+          :path => path,
+          :name => name,
+          :its  => []
+        }
+      )
+      yield
+      @current = nil
+    end
+
+    def it name, script_str
+      if @current
+        @current[:its] << {
+          :name => name,
+          :script => script_str
+        }
+      end
+    end
+
+  end # === class << self
+
+end # === class Akui ===

data/lib/browser/_index.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Tests for...</title>
+    <meta charset="UTF-8" />
+    <link rel="stylesheet" type="text/css" href="./akui_tests/style.css" />
+  </head>
+  <body>
+
+    <div id="stage"></div>
+
+    <div id="results" onclick="window.location.reload();"></div>
+
+    <script type="text/_csrf" id="_csrf">{{_csrf}}</script>
+    <script type="text/javascript" src="./akui_tests/jquery.js"></script>
+    <script type="text/javascript" src="./akui_tests/underscore.js"></script>
+    <script type="text/javascript" src="./akui_tests/promise.js"></script>
+    <script type="text/javascript" src="./akui_tests/fermata.js"></script>
+    <script type="text/javascript" src="./akui_tests/akui.js"></script>
+
+    <!-- ...................... -->
+    <!-- ...................... -->
+
+  </body>
+</html>
+

data/lib/browser/akui/akui.js

@@ -0,0 +1,53 @@
+"use strict";
+/* jshint undef: true, unused: true */
+/* global _, fermata */
+/* exported _, fermata */
+
+// === SCOPE
+(function () {
+  var results = [];
+
+  var should = {
+    equal: function (one, two) {
+      if (_.isEqual(one,two)) {
+        results.push(true);
+      } else {
+        throw new Error('Failed: !_.isEqual: ' + one +  ' !== ' + two);
+      }
+    }
+  }; // var should
+
+  var log = function () {
+    console['log'].apply(console, arguments);
+  }; // === func
+
+  fermata.json('/akui/run').post(function (err, data, headers) {
+    log(headers);
+    log(data);
+    if (err) {
+      log(err);
+      return false;
+    }
+
+    if (!data.test && data.redirect) {
+      window.location.href = data.redirect;
+      return false;
+    }
+
+    if (data.error)
+      throw new Error(data.error);
+
+    log(data.test.script);
+    var test_result = (new Function('should', data.test.script))(should);
+
+    if (_.isEmpty(results))
+      throw new Error("Empty specifications: \n" + data.test.script);
+
+    if (_.isFunction(test_result))
+      test_result();
+    else {
+      log(results);
+      log('Done running tests.');
+    }
+  });
+})();

data/lib/browser/style.css

@@ -0,0 +1,6 @@
+body { background: #F0F0F0; padding-bottom: 50px; }
+#results div { padding: 10px ; margin-right: 5px; margin-bottom: 5px; }
+#results span { font-size: 90%; font-family: monospace; font-weight: bold; }
+div.passed { background: #CFDB00; float: left; }
+div.failed { background: #DB0013; float: left; }
+

data/lib/browser/window.onerror.js

@@ -0,0 +1,7 @@
+window.akui_window_errs = [];
+
+if (!window.onerror) {
+  window.onerror = function (msg) {
+    window.akui_window_errs.push(msg);
+  };
+}

data/specs/0000-it-runs/spec.rb

@@ -0,0 +1,88 @@
+
+SCRIPTS = <<-EOF
+<script src="/bower_components/jquery/dist/jquery.min.js"></script>
+<script src="/bower_components/lodash/lodash.min.js"></script>
+<script src="/bower_components/fermata/fermata.js"></script>
+<script src="/akui/akui.js"></script>
+EOF
+
+Cuba.define do
+
+  on 'akui' do
+    run Akui::Middleware
+  end
+
+  on 'finished' do
+    `touch Public/finished.txt`
+    res.redirect '/akui/results', Akui::MOVED_TEMP
+  end
+
+  on get do
+    on root do
+      res.write <<-EOF.strip
+      <html>
+        <head><title>Root</title></head>
+        <body>
+          <div>Root</div>
+          <a href="/1">one</a>
+          #{ Akui.running? ? SCRIPTS : '<!-- Akui is not running -->'}
+       </body>
+      </html>
+      EOF
+    end
+
+    vals = {1=>:one, 2=>:two, 3=>:three, 4=>:root}
+    vals.each do |n, k|
+      on "#{n}" do
+        res.write <<-EOF.strip
+        <html>
+          <head><title>#{k}</title></head>
+          <body>
+            <a href="/#{n + 1 == 4 ? '' : n + 1}">#{vals[n+1]}</a>
+            #{SCRIPTS}
+          </body>
+        </html>
+        EOF
+      end
+    end
+  end
+
+end # === Cuba.define
+
+Akui.define {
+
+  describe :/, 'Root' do
+
+    it 'has link to: /1', <<-EOF
+      var link = $('a[href="/1"]');
+      should.equal( link.text(), 'one' );
+      link[0].click();
+    EOF
+
+  end # === describe
+
+  describe '/1' do
+    it 'has link to: /2', <<-EOF
+      var link = $('a[href="/2"]');
+      should.equal( link.text(), 'two' );
+      link[0].click();
+    EOF
+  end
+
+  describe '/2' do
+    it 'has link to: /3', <<-EOF
+      var link = $('a[href="/3"]');
+      should.equal( link.text(), 'three' );
+      link[0].click();
+    EOF
+  end
+
+  describe '/3' do
+    it 'has link to: /', <<-EOF
+      var link = $('a[href="/"]');
+      should.equal( link.text(), 'root' );
+      window.location.href = "/finished";
+    EOF
+  end
+
+} # === Akui.define

data/specs/config.ru

@@ -0,0 +1,36 @@
+
+require 'cuba'
+require 'rack/contrib'
+require 'akui'
+
+Cuba.use Rack::CommonLogger
+
+# === From:
+# https://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/try_static.rb
+class Custom_Try_Static
+
+  def initialize(app, options)
+    @app = app
+    @try = ['', *options[:try]]
+    @static = ::Rack::Static.new(
+      lambda { |_| [404, {}, []] },
+      options)
+  end
+
+  def call(env)
+    return @app.call(env) unless %w[GET HEAD].include?(env['REQUEST_METHOD'])
+    orig_path = env['PATH_INFO']
+    found = nil
+    @try.each do |path|
+      resp = @static.call(env.merge!({'PATH_INFO' => orig_path + path}))
+      break if !(403..405).include?(resp[0]) && found = resp
+    end
+    found or @app.call(env.merge!('PATH_INFO' => orig_path))
+  end
+
+end # === class Custom_Try_Static
+
+Cuba.use Custom_Try_Static, :root => "Public", :urls=>%w[/]
+
+require "./specs/#{ENV['SPEC_FILE']}/spec"
+run Cuba

data/specs/helpers.rb

@@ -0,0 +1,4 @@
+
+require 'Bacon_Colored'
+require 'akui'
+require 'pry'

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: akui
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- da99
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: escape_escape_escape
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: www_app
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.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: bacon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: Bacon_Colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: "\n    Automate testing code on the browser by using Rack\n    middleware
+  to include JS testing code files\n    into your rendered HTML.\n  "
+email:
+- i-hate-spam-1234567@mailinator.com
+executables:
+- akui
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bowerrc"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- VERSION
+- akui
+- akui.gemspec
+- bin/akui
+- lib/akui.rb
+- lib/browser/_index.html
+- lib/browser/akui/akui.js
+- lib/browser/favicon.ico
+- lib/browser/style.css
+- lib/browser/window.onerror.js
+- specs/0000-it-runs/spec.rb
+- specs/config.ru
+- specs/helpers.rb
+homepage: https://github.com/da99/akui
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.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: My way of testing browser/client-side code.
+test_files: []