wabur 0.4.0d1 → 0.5.0

data/lib/wab/utils.rb

@@ -1,8 +1,8 @@
 module WAB
   module Utils
     class << self
-      UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
-      TIME_REGEX = /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}\.\d{9}Z$/
+      UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.freeze
+      TIME_REGEX = /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}\.\d{9}Z$/.freeze
 
       def ruby_series
         RbConfig::CONFIG.values_at('MAJOR', 'MINOR').join.to_i
@@ -22,14 +22,14 @@ module WAB
       # "123e4567-e89b-12d3-a456-426655440000"
       def uuid_format?(str)
         return false unless 36 == str.length
-        !UUID_REGEX.match(str).nil?
+        UUID_REGEX === str
       end
 
       # Detect if given string matches a Time format as encoded by WAB components:
       # "2017-09-01T12:45:15.123456789Z"
       def wab_time_format?(str)
         return false unless 30 == str.length
-        !TIME_REGEX.match(str).nil?
+        TIME_REGEX === str
       end
     end
   end

data/lib/wab/version.rb

@@ -1,5 +1,5 @@
 
 module WAB
   # Current version of the module.
-  VERSION = '0.4.0d1'
+  VERSION = '0.5.0'
 end

data/pages/Architecture.md

@@ -1,11 +1,52 @@
 # Architecture
 
+WABuR is a Web Application Builder using Ruby. It strives to be simple to
+use and maintain not only for the trivial case but for more advanced
+applications as well. It utilizes a Mode/View/Controller pattern with well
+defined APIs between each element of the MVC approach.
+
+One of the more interesting benefits of well defined APIs between MVC
+components is that it allows multiple Views without changing any other
+components. A View can be a single page JavaScript application as is used in
+the WABuR reference implementation or it can simply be a `curl` command used
+to send HTTP requests as is used in later lessons in the tutorial.
+
+The architecture provides many options but keeps clean and clear API between
+components. This pluggable design allows for unit test drivers and various levels
+of deployment options from straight Ruby to a high performance C runner that
+handles HTTP and data storage.
+
+Three configuration are available. One uses a Runner that calls to the Ruby
+core controller through pipes on ```$stdin``` and ```$stdout```. A second is
+to implement a runner in Ruby (bin/wabur). The third is to use a C Runner with
+embedded Ruby (OpO-Rub).
+
 The WAB architecture is a Mode View Controller with clear APIs between each
 part of the MVC. The design allows the non-business related tasks such as the
 HTTP server and data store to be treated as service to the Controller which
 contains the business logic.
 
-![](http://www.opo.technology/wab/wab_arch.svg)
+A Runner that spawns (forks) and runs a Ruby Controller makes use of the
+```::WAB::IO::Shell```.
+
+![](wab_remote_arch.svg)
+
+The Ruby Runner and C Runner with embedded ruby follow the same architecture.
+
+![](wab_embedded_arch.svg)
+
+Access to data can follow two paths. A direct access to the data is possible
+as portrayed by the red line that flows from HTTP server to the runner and
+onto the Model. The other path is to dive down into the Ruby Controller and
+allow the Controller to modify and control what is returned by a request. The
+Benchmark results in the (benchmarks/README.md)[benchmarks/README.md] includes
+the latest results.
+
+![](wab_access_paths.svg)
+
+Simplified the logical view is:
+
+![](wab_parts.svg)
 
 ## MVC
 
@@ -198,3 +239,65 @@ Outside of this project WAB C or other language shells can be written. The
 first is expected to be a derivative of [OpO](http://opo.technology) as it
 takes shape. This WAB Shell will also draw on the libraries use by [Piper
 Push Cache](http://piperpushcache.com) to provide WebSocket and SSE support.
+
+## WABuR Repository layout
+
+Knowing what the concepts involved in the WABuR architecture and design does
+not make it obvious where all the parts described reside in the
+repository. The following directory overlay attempts to provide some of that
+mapping.
+
+```
+wabur
+├── bench
+|       Benchmark results and code.  
+├── bin
+|       Scripts available from the gem such as the wabur app.
+├── export
+|       Files exported by the gem. This is used as an alternate file system
+|       for the web servers if a filer has not been added by the developer.
+├── lib
+|   └── wab
+|       |   The core module that provides duck-types for Shell and Data. It
+|       |   also contains the default Controller bahavior and some utilities
+|       |   and helpers.
+|       ├── impl
+|       |       The Impl module provides an implementation of the duck-type
+|       |       found in the wab directory. The wabur pure Ruby runner is
+|       |       implemented in this directory.
+|       ├── io
+|       |       Implements a stdio shell that is used with a runner that forks
+|       |       a WAB::IO::Shell that then acts as a mechanism for exchanging
+|       |       messages between the Controller and the Runner which
+|       |       implements the Model and provides an HTTP API for Views.
+|       └── ui
+|               The reference UI makes use of configuration data to define
+|               displays and transitions between displays. Displays are
+|               described mostly by HTML generated by the Ruby code in this
+|               directory. There is also a Controller class that provides the
+|               UI configuration just as anu other Controller does for data
+|               from the model or database.
+├── pages
+|       Additional documentation.
+├── script
+|       Scripts for building and tools for developers.
+├── test
+|       Unit and compatibility tests.
+├── tutorial
+|       Tutorial for building a WABuR application from the ground up.
+└── view
+    |   Source code for JavaScript, CSS, fonts, and other View related
+    |   components. This is where the reference UI implemenation sources
+    |   reside or at least the non-configuration defining portions.
+    ├── ui
+    |   ├── js
+    |   |       JavaScript sources for the UI reference implementation.
+    |   ├── styles
+    |   |       Sass sources for generating the wab.css file.
+    |   └── wabfont
+    |           A font used to provide the icons in the list view.
+    └── wab
+        └── wab.js
+                JavaScript file that implements API wrappers for calls to the
+                Controllers
+```

data/test/test_configuration.rb

@@ -16,7 +16,7 @@ class TestConfiguration < TestImpl
   end
 
   def test_initialization
-    assert_equal({:environment=>"test"}, @config.map )
+    assert_equal({environment:'test', mode:'run'}, @config.map )
   end
 
   def test_parse_config_file

data/test/test_impl.rb

@@ -35,4 +35,5 @@ end # TestImpl
 require 'test_configuration'
 require 'test_data'
 require 'test_expr'
+require 'test_init'
 require 'test_model'

data/test/test_init.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require_relative 'helper'
+require 'wab/impl'
+
+class TestImplInit < TestImpl
+
+  def setup
+    @config = {
+      base: File.join(__dir__, 'tmp'),
+      rest: ['Entry', 'Article']
+    }
+    @dir = @config[:base]
+    FileUtils.remove_dir @dir if Dir.exist?(@dir)
+  end
+
+  def test_setup
+    WAB::Impl::Init.setup(File.expand_path(@dir), @config)
+
+    controller = File.read("#{@dir}/lib/ui_controller.rb")
+    assert_match /kind: 'Entry',\n/, controller
+    assert_match /kind: 'Article',\n/, controller
+
+    wabur_config = File.read("#{@dir}/config/wabur.conf")
+    assert_match /handler.1.type = Entry\nhandler.1.handler = WAB::OpenController/, wabur_config
+    assert_match /handler.2.type = Article\nhandler.2.handler = WAB::OpenController/, wabur_config
+
+    opo_rub_config = File.read("#{@dir}/config/opo-rub.conf")
+    assert_match /handler.entry.path = \/v1\/Entry\/\*\*\nhandler.entry.class = WAB::OpenController/, opo_rub_config
+    assert_match /handler.article.path = \/v1\/Article\/\*\*\nhandler.article.class = WAB::OpenController/, opo_rub_config
+  end
+
+end # TestImplInit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wabur
 version: !ruby/object:Gem::Version
-  version: 0.4.0d1
+  version: 0.5.0
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-23 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -78,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: sass
+  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'
 description: 'Web Application Builder '
 email: peter@ohler.com
 executables:
@@ -87,11 +101,67 @@ extra_rdoc_files:
 - README.md
 - pages/Architecture.md
 - pages/Goals.md
-- pages/Plan.md
 files:
 - LICENSE
 - README.md
 - bin/wabur
+- export/assets/css/wab.css
+- export/assets/css/wab.css.map
+- export/assets/fonts/wabfont/README
+- export/assets/fonts/wabfont/fonts/WAB.eot
+- export/assets/fonts/wabfont/fonts/WAB.svg
+- export/assets/fonts/wabfont/fonts/WAB.ttf
+- export/assets/fonts/wabfont/fonts/WAB.woff
+- export/assets/fonts/wabfont/selection.json
+- export/assets/fonts/wabfont/style.css
+- export/assets/js/transpile.js
+- export/assets/js/ui.js
+- export/assets/js/vendor/plugin-babel/babel-helpers.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/asyncGenerator.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/asyncGeneratorDelegate.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/asyncIterator.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/asyncToGenerator.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/classCallCheck.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/createClass.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/defaults.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/defineEnumerableProperties.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/defineProperty.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/extends.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/get.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/inherits.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/instanceof.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/interopRequireDefault.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/interopRequireWildcard.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/jsx.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/newArrowCheck.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/objectDestructuringEmpty.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/objectWithoutProperties.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/possibleConstructorReturn.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/selfGlobal.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/set.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/slicedToArray.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/slicedToArrayLoose.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/taggedTemplateLiteral.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/taggedTemplateLiteralLoose.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/temporalRef.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/temporalUndefined.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/toArray.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/toConsumableArray.js
+- export/assets/js/vendor/plugin-babel/babel-helpers/typeof.js
+- export/assets/js/vendor/plugin-babel/plugin-babel.js
+- export/assets/js/vendor/plugin-babel/regenerator-runtime.js
+- export/assets/js/vendor/plugin-babel/systemjs-babel-browser.js
+- export/assets/js/vendor/plugin-babel/systemjs-babel-node.js
+- export/assets/js/vendor/systemjs/system-production.js
+- export/assets/js/vendor/systemjs/system-production.js.map
+- export/assets/js/vendor/systemjs/system-production.src.js
+- export/assets/js/vendor/systemjs/system-production.src.js.map
+- export/assets/js/vendor/systemjs/system.js
+- export/assets/js/vendor/systemjs/system.js.map
+- export/assets/js/vendor/systemjs/system.src.js
+- export/assets/js/vendor/systemjs/system.src.js.map
+- export/assets/js/wab.js
+- export/index.html
 - lib/wab.rb
 - lib/wab/controller.rb
 - lib/wab/data.rb
@@ -100,6 +170,7 @@ files:
 - lib/wab/impl/bool_expr.rb
 - lib/wab/impl/configuration.rb
 - lib/wab/impl/data.rb
+- lib/wab/impl/export_proxy.rb
 - lib/wab/impl/expr.rb
 - lib/wab/impl/expr_parser.rb
 - lib/wab/impl/exprs/and.rb
@@ -115,9 +186,15 @@ files:
 - lib/wab/impl/exprs/or.rb
 - lib/wab/impl/exprs/regex.rb
 - lib/wab/impl/handler.rb
+- lib/wab/impl/init.rb
 - lib/wab/impl/model.rb
 - lib/wab/impl/path_expr.rb
 - lib/wab/impl/shell.rb
+- lib/wab/impl/templates/opo-rub.conf.template
+- lib/wab/impl/templates/opo.conf.template
+- lib/wab/impl/templates/spawn.rb.template
+- lib/wab/impl/templates/ui_controller.rb.template
+- lib/wab/impl/templates/wabur.conf.template
 - lib/wab/impl/utils.rb
 - lib/wab/io.rb
 - lib/wab/io/call.rb
@@ -126,12 +203,20 @@ files:
 - lib/wab/open_controller.rb
 - lib/wab/shell.rb
 - lib/wab/shell_logger.rb
+- lib/wab/ui.rb
+- lib/wab/ui/create.rb
+- lib/wab/ui/display.rb
+- lib/wab/ui/flow.rb
+- lib/wab/ui/list.rb
+- lib/wab/ui/multi_flow.rb
+- lib/wab/ui/rest_flow.rb
+- lib/wab/ui/update.rb
+- lib/wab/ui/view.rb
 - lib/wab/utils.rb
 - lib/wab/uuid.rb
 - lib/wab/version.rb
 - pages/Architecture.md
 - pages/Goals.md
-- pages/Plan.md
 - test/bench_io_shell.rb
 - test/helper.rb
 - test/mirror_controller.rb
@@ -151,6 +236,7 @@ files:
 - test/test_expr_or.rb
 - test/test_expr_regex.rb
 - test/test_impl.rb
+- test/test_init.rb
 - test/test_io_shell.rb
 - test/test_model.rb
 - test/test_runner.rb
@@ -175,12 +261,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: wabur
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Web Application Builder
@@ -204,6 +290,7 @@ test_files:
 - test/test_expr_or.rb
 - test/test_expr_regex.rb
 - test/test_impl.rb
+- test/test_init.rb
 - test/test_io_shell.rb
 - test/test_model.rb
 - test/test_runner.rb

data/pages/Plan.md

@@ -1,27 +0,0 @@
-# Plan
-
-More details will be added here as progress continues. For now the high level plan is:
-
-### Completed
-
-- _Define APIs - initial complete_
-- _WAB::IO::Shell - complete_
-- _stdio sample - complete_
-
-### Pending
-
-- Benchmarks - started
-  - Overall as a black box
-  - WAB::IO::Shell alone
-- Spec driven Javascript libraries
-  - Define spec format
-  - implement and test generic Javascript app
-- Ruby Runner
-  - Runner framework
-  - HTTP server
-  - Model
-    - In memory object management
-    - Data store
-- Embedded Ruby Runner (separate project)
-- End to end examples
-- Advanced Javascript displays