wabur 0.4.0d1 → 0.5.0

data/lib/wab/impl/templates/spawn.rb.template

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+$VERBOSE = true
+
+$: << __dir__
+while (index = ARGV.index('-I'))
+  _, path = ARGV.slice!(index, 2)
+  $: << path
+end
+
+require 'optparse'
+require 'wab'
+require 'wab/io'
+
+# This app is expected to be spawned from a WAB runner. This demonstrates one
+# possible mode for running WAB applications. It is the least performant of
+# the WAB run options.
+
+$verbose = false
+$thread_count = 1
+$opts = OptionParser.new("Usage: sample [options]
+
+Acts as a remote Controller in a WAB deployment. Input is from stdin and output
+is on stdout. If verbosity is turned on it is sent to stderr.
+")
+$opts.on('-v', 'verbose output on stderr')                         { $verbose = true }
+$opts.on('-t', '--thread-count Integer', Integer, 'thread count')  { |t| $thread_count = t }
+$opts.on('-h', '--help', 'show this page')                         { $stderr.puts $opts.help; Process.exit!(0) }
+
+$opts.parse(ARGV)
+
+shell = WAB::IO::Shell.new($thread_count, 'kind', 1)
+shell.logger.level = Logger::INFO if $verbose
+
+shell.register_controller('ui', UIController.new(shell))%{controllers}
+
+begin
+  shell.start
+rescue Interrupt
+  # ignore
+end

data/lib/wab/impl/templates/ui_controller.rb.template

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+require 'wab/ui'
+
+class UIController < WAB::UI::MultiFlow
+
+  def initialize(shell)
+    super
+    %{rest_flows}
+  end
+
+end # UIController

data/lib/wab/impl/templates/wabur.conf.template

@@ -0,0 +1,40 @@
+# wabur.conf
+
+# Configuration file for the Pure Ruby WAB Runner.
+
+# The directory to store the runner data (relative to source directory).
+store.dir = wabur/data
+
+# URL path prefix for the data records.
+path_prefix = /v1
+
+# Field to expect the type, class, or kind of record in the stored JSON.
+type_key = kind
+
+# HTTP site directory.
+http.dir =  site
+
+# HTTP port to listen on.
+http.port = 6363
+
+# Logging verbosity. Can be ERROR, WARN, INFO, or DEBUG.
+verbosity = WARN
+
+# The Ruby requires. Generally what ever class in the lib directory that
+# should be imported.
+require = ui_controller
+
+# If export_proxy is true the wab default index.html, CSS, JavaScript, and
+# fonts are loaded from the gem's export directory is they are not found in
+# the site directory.
+export_proxy = true
+
+# The number of spaces to indent the JSON written to disk by the model and the
+# JSON sent as a response to View requests.
+indent = 0
+
+# Handlers for each type of record and for the UI shich are Ruby generated UI
+# configuration records.
+handler.0.type = ui
+handler.0.handler = UIController
+%{handlers}

data/lib/wab/ui.rb

@@ -0,0 +1,19 @@
+
+require 'wab'
+
+module WAB
+  # Web Application Builder reference implemenation UI.
+  module UI
+  end
+end
+
+require 'wab/ui/display'
+require 'wab/ui/flow'
+require 'wab/ui/multi_flow'
+
+# These are the classes needed for the REST displays/flow.
+require 'wab/ui/rest_flow'
+require 'wab/ui/list'
+require 'wab/ui/view'
+require 'wab/ui/create'
+require 'wab/ui/update'

data/lib/wab/ui/create.rb

@@ -0,0 +1,26 @@
+
+module WAB
+  module UI
+
+    # An object create display.
+    class Create < View
+      
+      # Create an instance that will generate the HTML for a display.
+      def initialize(kind, id, template, transitions)
+        super(kind, id, template, transitions, 'ui.Create')
+      end
+
+      # Returns the HTML for a display.
+      def html
+        html = %{<div class="obj-form-frame"><table class="obj-form">}
+        html = append_fields(html, @name, template, false)
+        html << '</table>'
+        html << %{<div class="btn" id="#{@name}.save_button"><span>Save</span></div>}
+        html << %{<div class="btn" style="float:right;" id="#{@name}.cancel_button"><span>Cancel</span></div>}
+        html << '</div>'
+      end
+
+    end # Create
+  end # UI
+end # WAB
+

data/lib/wab/ui/display.rb

@@ -0,0 +1,34 @@
+
+module WAB
+  module UI
+
+    # Base class for other displays.
+    class Display
+
+      attr_reader :name
+      attr_reader :kind
+      attr_accessor :template
+      attr_accessor :display_class
+      attr_accessor :transitions
+
+      def initialize(kind, name, template, transitions, display_class)
+        @kind = kind
+        @name = name
+        @template = template
+        @display_class = display_class
+        @transitions = transitions
+      end
+
+      def spec
+        {
+          name: @name,
+          kind: @kind,
+          display_class: @display_class,
+          transitions: @transitions,
+        }
+      end
+
+    end # Display
+  end # UI
+end # WAB
+

data/lib/wab/ui/flow.rb

@@ -0,0 +1,54 @@
+
+module WAB
+  module UI
+
+    # A controller that provides a description of the UI for the WAB UI
+    # reference implementation.
+    class Flow < WAB::Controller
+
+      attr_accessor :entry
+      attr_reader :displays
+      
+      def initialize(shell)
+        super
+        @displays = {}
+      end
+
+      # Adds a display to the flow.
+      def add_display(display, entry=false)
+        name = display.name
+        raise DuplicateError.new(name) if @displays.has_key?(name)
+        @displays[name] = display
+        @entry = name if entry
+      end
+
+      def get_display(name)
+        @displays[name]
+      end
+
+      # Returns a description of the UI to be used. If a display name is
+      # includd in the path thenn just that display description is returned.
+      #
+      # path:: array of tokens in the path.
+      def read(path, _query)
+        results = []
+        if @shell.path_pos + 2 == path.length
+          # Return the description of the named display.
+          name = path[@shell.path_pos + 1]
+          display = get_display(name)
+          display[:entry] = true if !display.nil? && display.name == @entry
+          results << {id: name, data: display.spec} unless display.nil?
+        else
+          @displays.each_value { |display|
+            spec = display.spec
+            spec[:entry] = true if display.name == @entry
+            results << spec
+          }
+        end
+        @shell.data({code: 0, results: results})
+      end
+      
+    end # Flow
+  end # UI
+end # WAB
+

data/lib/wab/ui/list.rb

@@ -0,0 +1,59 @@
+
+module WAB
+  module UI
+
+    # Represents a list display.
+    class List < Display
+
+      attr_accessor :list_paths
+      
+      def initialize(kind, id, template, list_paths, transitions)
+        super(kind, id, template, transitions, 'ui.List')
+        @list_paths = list_paths
+      end
+
+      def spec
+        ui_spec = super
+        ui_spec[:table] = html_table
+        ui_spec[:row] = html_row
+        ui_spec
+      end
+
+      # Returns an HTML string to be used as the table of a list of
+      # objects. The table must have an +id+ attribute value of the +name+
+      # argument. Generally the column header should include the list_paths or
+      # more friendly alternatives. If a create button is desired then an
+      # element with the name joined with '.create_button' should be the +id+ of
+      # the element.
+      def html_table
+        html = %{<div class="table-wrapper"><h2 style="float: left; margin-top: 2px">#{@kind} List</h2><div class="btn" style="float: left" id="#{@name}.create_button"><span>Create</span></div><table class="obj-list-table" id="#{@name}.table"><tr>}
+        # The column headers.
+        @list_paths.map { |path| html << "<th>#{path.capitalize}</th>" }
+        # Add the view, edit, and delete buttons header.
+        html << %{<th colspan="3">Actions</th>}
+        html << %{</tr></table></div>}
+      end
+
+      # Returns an HTML string to be used as a row in a table of a list of
+      # objects. Each column element should include the list_paths identifier
+      # as a +path+ element attribute.
+      #
+      # Each row can contain the buttons +view_button+, +edit_button+, and
+      # +delete_button+. These will be used to set up the transitions.
+      def html_row
+        html = '<tr>'
+        @list_paths.map { |path| html << %{<td class="obj-list" path="#{path}"></td>} }
+        buttons = [
+                   { title: 'View', icon: 'icon icon-eye', cn: 'actions' },
+                   { title: 'Edit', icon: 'icon icon-pencil', cn: 'actions' },
+                   { title: 'Delete', icon: 'icon icon-trash-o', cn: 'actions delete' }
+                  ].map { |spec|
+          html << %{<td class="#{spec[:cn]}"><span class="#{spec[:icon]}" title="#{spec[:title]}"></span></td>}
+        }
+        html << '</tr>'
+      end
+
+    end # List
+  end # UI
+end # WAB
+

data/lib/wab/ui/multi_flow.rb

@@ -0,0 +1,23 @@
+
+module WAB
+  module UI
+
+    # A Flow controller that merges multiple flows into one single flow.
+    class MultiFlow < Flow
+
+      # Create a new instance that can be used to merge multiple flows into
+      # one single flow.
+      #
+      # shell:: shell containing the instancec
+      def initialize(shell)
+        super(shell)
+      end
+
+      def add_flow(flow)
+        flow.displays.each_pair { |name,display| @displays[name] = display }
+        @entry = flow.entry if @entry.nil?
+      end
+      
+    end # MultiFlow
+  end # UI
+end # WAB

data/lib/wab/ui/rest_flow.rb

@@ -0,0 +1,89 @@
+
+module WAB
+  module UI
+
+    # A Flow controller that builds up a set of displays and provides those display descriptions
+    # when a read is called. The REST UI is built based on the template and
+    # list_paths provided in the initializer.
+    #
+    # The display can be modified or subclassing by changing the View, Create,
+    # and Update classes.
+    class RestFlow < Flow
+
+      # Creae a new instance based on the record template and path for the
+      # list display.
+      #
+      # shell:: shell containing the instancec
+      # template:: and example object with default values
+      # list_paths:: paths to values for the list display
+      def initialize(shell, template, list_paths)
+        super(shell)
+        kind = template[:kind]
+        raise WAB::ParseError.new('kind field missing from object template') if kind.nil?
+        add_list(kind, template, list_paths)
+        add_view(kind, template)
+        add_create(kind, template)
+        add_update(kind, template)
+      end
+
+      # Add a listdisplay to the spec delivered to the UI.
+      #
+      # kind:: the type of record to create the list for
+      # template:: and example object with default values
+      # list_paths:: paths to values for the list display
+      def add_list(kind, template, list_paths)
+        id = "#{kind}.list"
+        transitions = {
+          create: "#{kind}.create",
+          view: "#{kind}.view",
+          edit: "#{kind}.update",
+          delete: id,
+        }
+        add_display(List.new(kind, id, template, list_paths, transitions), true)
+      end
+
+      # Adds an object view specification.
+      #
+      # kind:: the type of record to create the list for
+      # template:: and example object with default values
+      def add_view(kind, template)
+        id = "#{kind}.view"
+        transitions = {
+          edit: "#{kind}.update",
+          list: "#{kind}.list",
+          delete: "#{kind}.list",
+        }
+        add_display(View.new(kind, id, template, transitions))
+      end
+
+      # Adds an object creation specification.
+      #
+      # kind:: the type of record to create the list for
+      # template:: and example object with default values
+      def add_create(kind, template)
+        id = "#{kind}.create"
+        transitions = {
+          save: "#{kind}.view",
+          cancel: "#{kind}.list",
+        }
+        add_display(Create.new(kind, id, template, transitions))
+      end
+
+      # Adds an object update specification.
+      #
+      # kind:: the type of record to create the list for
+      # template:: and example object with default values
+      def add_update(kind, template)
+        id = "#{kind}.update"
+        transitions = {
+          save: "#{kind}.view",
+          cancel: "#{kind}.view",
+          list: "#{kind}.list",
+          delete: "#{kind}.list",
+        }
+        add_display(Update.new(kind, id, template, transitions))
+      end
+
+    end # RestFlow
+  end # UI
+end # WAB

data/lib/wab/ui/update.rb

@@ -0,0 +1,27 @@
+
+module WAB
+  module UI
+
+    # An object update display.
+    class Update < View
+      
+      # TBD pass in fields for the update
+      def initialize(kind, id, template, transitions)
+        super(kind, id, template, transitions, 'ui.Update')
+      end
+
+      def html
+        html = %{<div class="obj-form-frame"><table class="obj-form">}
+        html = append_fields(html, @name, template, false)
+        html << '</table>'
+        html << %{<div class="btn" id="#{@name}.save_button"><span>Save</span></div>}
+        html << %{<div class="btn" id="#{@name}.cancel_button"><span>Cancel</span></div>}
+        html << %{<div class="btn" id="#{@name}.list_button"><span>List</span></div>}
+        html << %{<div class="btn delete-btn" style="float:right;" id="#{@name}.delete_button"><span>Delete</span></div>}
+        html << '</div>'
+      end
+
+    end # Update
+  end # UI
+end # WAB
+

data/lib/wab/ui/view.rb

@@ -0,0 +1,62 @@
+
+module WAB
+  module UI
+
+    # An object view display.
+    class View < Display
+
+      def initialize(kind, id, template, transitions, display_class='ui.View')
+        super(kind, id, template, transitions, display_class)
+      end
+
+      def spec
+        ui_spec = super
+        ui_spec[:html] = html
+        ui_spec
+      end
+
+      def html
+        html = %{<div class="obj-form-frame readonly"><table class="obj-form">}
+        html = append_fields(html, @name, template, true)
+        html << '</table>'
+        html << %{<div class="btn" id="#{@name}.edit_button"><span>Edit</span></div>}
+        html << %{<div class="btn" id="#{@name}.list_button"><span>List</span></div>}
+        html << %{<div class="btn delete-btn" style="float:right;" id="#{@name}.delete_button"><span>Delete</span></div>}
+        html << '</div>'
+      end
+
+      def append_fields(html, path, template, readonly)
+        disabled = readonly ? ' disabled="disabled"' : ''
+        readonly = readonly ? ' readonly' : ''
+        template.each_pair { |id,value|
+          next if :kind == id
+          input = nil
+          input_id = "#{path}.#{id}"
+          text_input = %{<input class="form-field" id="#{input_id}" type="text" value="#{value}" #{readonly}>}
+
+          if value.is_a?(String)
+            count = value.count("\n")
+            if 0 < count # a text area
+              input = %{<textarea class="form-field" id="#{input_id}" rows="#{count}" #{readonly}>#{value.strip}</textarea>}
+            else
+              input = text_input
+            end
+          elsif value.is_a?(TrueClass)
+            input = %{<input class="form-field" id="#{input_id}" type="checkbox"#{disabled} checked>}
+          elsif value.is_a?(FalseClass)
+            input = %{<input class="form-field" id="#{input_id}" type="checkbox"#{disabled}>}
+          elsif value.is_a?(Integer) || WAB::Utils.pre_24_fixnum?(value) || value.is_a?(Number)
+            input = %{<input class="form-field" id="#{input_id}" type="number" value="#{value}" #{readonly}>}
+          elsif value.is_a?(Hash)
+            append_fields(html, input_id, value)
+          else
+            input = text_input
+          end
+          html << %{<tr><td class="field-label">#{id.capitalize}</td><td>#{input}</td></tr>}
+        }
+        html
+      end
+
+    end # View
+  end # UI
+end # WAB