wabur 0.1.0d2 → 0.2.0d1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4ae2c00f65bf680b3432bd10ec6135aeed7e6bc
-  data.tar.gz: 01f5f822d40665b8f314d3744ccdcf7bf35c071c
+  metadata.gz: 86b81a950a3090451b79d8d4841b4acaa340f208
+  data.tar.gz: 2ac14502f2dabdd7f294be9eeae7c16f068ffadb
 SHA512:
-  metadata.gz: 48320600e036669b67ba89b0b241440891af68ca7f59c287e632a96e3df1512cc1b917c0bb8425d9d4e7040d4c145ccb5ed28d0d3f62b228aceecc40e58f3ad2
-  data.tar.gz: 7f83da64ecc5ed24f2bc2e225204f757873fda7f2843634bae74afb7be3dcf497098aa3d2754aa2be7f8ade8535b3096e25b3a7c9429723ead367cc1ed42bcd9
+  metadata.gz: 16411e53df75d17339ecdf1efe6b6afc84945c01a71ce2ff2f34a83a3a8e965ba73177286afaf273543711cc5a4646b9742c166699e2f01e80cb813cfa20a32f
+  data.tar.gz: 8f9ca7584c9395e39ccabaab4e0229b0f4e306651adaea727efdf4460dac1ed45e21df33073b54cdd09a3992c4ba35a0f6adf10fe496ce5a82b85cf9c9bf703e

data/README.md

@@ -1,31 +1,34 @@
 # WABuR (Web Application Builder using Ruby)
 
-[![Build Status](https://img.shields.io/travis/ohler55/wabur/develop.svg)](http://travis-ci.org/ohler55/wabur?branch=develop) ![Gem](https://img.shields.io/gem/v/wabur.svg) ![Gem](https://img.shields.io/gem/dt/wabur.svg)
+[![Build Status](https://img.shields.io/travis/ohler55/wabur/develop.svg)](http://travis-ci.org/ohler55/wabur?branch=develop)
+[![Windows Build status](https://img.shields.io/appveyor/ci/ohler55/wabur/develop.svg?label=Windows%20build)](https://ci.appveyor.com/project/ohler55/wabur/branch/develop)
+[![Gem Version](https://badge.fury.io/rb/wabur.svg)](https://rubygems.org/gems/wabur)
+[![Gem](https://img.shields.io/gem/dt/wabur.svg)](https://rubygems.org/gems/wabur)
 
-Ruby is a great language but for performance C is a better alternative. It is
+Ruby is a great language but for performance C is the better alternative. It is
 possible to get the best of both as evident with [Oj](http://www.ohler.com/oj)
 and [Ox](http://www.ohler.com/ox). C by itself allowed
-[Piper](http://piperpushcache.com), a fast push web server to be developed and
+[Piper](http://piperpushcache.com), a fast push web server to be developed, and
 is being used to develop [OpO](http://opo.technology) a high performance graph
-and JSON database. This project takes from all of those projects for a hight
+and JSON database. This project takes from all of those projects for a high
 performance Ruby web framework.
 
-Ruby on Rails has made Ruby main stream. While RoR is fine for some
+Ruby on Rails has made Ruby mainstream. While RoR is fine for some
 applications there are others that might be better served with an alternative.
 This project was started as an alternative to Ruby on Rails with a focus on
-performance and easy of use.
+performance and ease of use.
 
-Why develop an alternative to Rails? Rails popularity has been waning. It is
-still huge but not as popular as it used to be. RoR is not going away any time
-soon but for some applications alternatives are needed.
+Why develop an alternative to Rails? The popularity of Rails has been waning.
+It is still huge but not as popular as it used to be. RoR is not going away
+any time soon but for some applications, alternatives are needed.
 
 ## Goals
 
-Lets start with the assumption that we want to continue to use Ruby. The goal
-of this project is to provide a high performance, easy to use, and fully
+Lets start with the assumption that we want to continue using Ruby. The goal
+of this project is to provide a high performance, easy to use, and a fully
 featured web framework with Ruby at the core. By keeping the core, the
-business logic in Ruby but allowing options for other parts to be in different
-languages the best use of each can be utilized.
+business logic, in Ruby but allowing options for other parts to be in different
+languages, the best of each can be utilized.
 
 Targets are a throughput of 100K page fetches per second at a latency of no
 more than 1 millisecond on a desktop machine. That is more than an order of
@@ -47,13 +50,13 @@ C shell that handles HTTP and data storage.
 
 ## Participate and Contribute
 
-If you like the idea and want to help out or become a core developer on the
-project send me an [email](mailto:peter@ohler.com). Get in on the ground floor
+If you like the idea and want to help out, or become a core developer on the
+project, send me an [email](mailto:peter@ohler.com). Get in on the ground floor
 and lets make something awesome together.
 
 ### Guidelines
 
-These are the simple guidelines for contrinuting.
+These are the simple guidelines for contributing.
 
 1. Coordinate with me first before getting started to avoid duplication of
    effort or implementing something in conflict with the plans.

data/lib/wab/controller.rb

@@ -7,29 +7,22 @@ module WAB
   #
   # A description of the available methods is included as private methods.
   class Controller # :doc: all
-    attribute_accessor :shell
-    attribute_accessor :view
-    attribute_accessor :model
+    attr_accessor :shell
 
     # Create a instance.
-    def initialize()
-      @shell = nil
-      @view = shell.view
-      @model = shell.model
-      # TBD
+    def initialize(shell, async=false)
+      @shell = shell
+      # TBD handle async
     end
 
-    # Handler for paths that do not match the REST pattern. Only called on the
-    # default controller.
+    # Handler for paths that do not match the REST pattern or for unregistered
+    # types. Only called on the default controller.
     #
     # Processing result are passed back to the view which forward the result
-    # on to the requester. The result, is not nil, should be a Data instance.
+    # on to the requester. The result, if not nil, should be a Data instance.
     #
-    # path:: identifies operation and additional data in a / delimited
-    #        format. It is up to the controller to decide how to process the
-    #        request.
     # data:: data to be processed
-    def handle(path, data)
+    def handle(data)
       nil
     end
 
@@ -38,63 +31,89 @@ module WAB
     # they will not be called.
     private
 
-    # Should create a new data object.
+    # Create a new data object. If a query is provided it is treated as a
+    # check against an existing object with the same key/value pairs.
     #
-    # The return should be the identifier for the object created or if
-    # +with_data+ is true a Data object with an +id+ attribute and a +data+
-    # attribute that contains the full object details.
+    # The reference to the object created is returned on success.
     #
     # On error an Exception should be raised.
     #
+    # path:: array of tokens in the path.
+    # query:: query parameters from a URL.
     # data:: the data to use as a new object.
-    # with_data:: flag indicating the response should include the new object
-    def create(data, with_data=false) # :doc:
-      # TBD implement the default behavior as an example or starting point
-    end
-
-    # Should return the object with the +id+ provided.
-    #
-    # The function should return the result of a fetch on the model with the
-    # provided +id+. The result should be a Data instance which is either the
-    # object data or a wrapper that include the object id in an +id+ attribute
-    # and the object data itself in a +data+ attribute depending on the value
-    # of the +with_id+ argument.
-    #
-    # id:: identifier of the object
-    # with_id:: if true wrap the object data with an envelope that includes
-    #           the id as well as the object data.
-    def read(id, with_id=false) # :doc:
-      # TBD implement the default behavior as an example or starting point
+    def create(path, query, data) # :doc:
+      tql = { }
+      kind = path[@shell.path_pos]
+      if query.is_a?(Hash) && 0 < query.size
+        where = ['AND']
+        where << form_where_eq(@shell.type_key, kind)
+        query.each_pair { |k,v| where << form_where_eq(k, v) }
+        tql[:where] = where
+      end
+      tql[:insert] = data.native
+      shell_query(tql, kind, 'create')
     end
 
-    # Should return the objects with attributes matching the +attrs+ argument.
-    #
-    # The return should be a Hash where the keys are the matching object
-    # identifiers and the value are the object data. An empty Hash or nil
-    # indicates there were no matches.
-    #
-    # attrs:: a Hash with keys matching paths into the target objects and value
-    #         equal to the target attribute values. A path can be an array of
-    #         keys used to walk a path to the target or a +.+ delimited set of
-    #         keys.
-    def read_by_attrs(attrs) # :doc:
-      # TBD implement the default behavior as an example or starting point
+    # Return the objects according to the path and query arguments.
+    #
+    # If the path includes an object reference then that object is returned as
+    # the only member of the results list of a WAB::Data returned.
+    #
+    # If there is no object reference in the path then the attributes are used
+    # to find matching objects. The objects that have the same key/value pairs
+    # are returned.
+    #
+    # path:: array of tokens in the path.
+    # query:: query parameters from a URL as a Hash with keys matching paths
+    #         into the target objects and value equal to the target attribute
+    #         values. A path can be an array of keys used to walk a path to
+    #         the target or a +.+ delimited set of keys.
+    def read(path, query) # :doc:
+      if @shell.path_pos + 2 == path.length # has an object reference in the path
+        ref = path[@shell.path_pos + 1].to_i
+        obj = @shell.get(ref)
+        obj = obj.native if obj.is_a?(::WAB::Data)
+        return @shell.data({ code: 0, results: [ { id: ref, data: obj } ]})
+      end
+      tql = { }
+      kind = path[@shell.path_pos]
+      # No id so must be either a simple query by attribute or a list.
+      if query.is_a?(Hash) && 0 < query.size
+        where = ['AND']
+        where << form_where_eq(@shell.type_key, kind)
+        query.each_pair { |k,v| where << form_where_eq(k, v) }
+      else
+        where = form_where_eq(@shell.type_key, kind)
+      end
+      tql[:where] = where
+      tql[:select] = { id: '$ref', data: '$' }
+      shell_query(tql, kind, 'read')
     end
 
     # Replaces the object data for the identified object.
     #
-    # The return should be the identifier for the object updated or if
-    # +with_data+ is true a Data object with an +id+ attribute and a +data+
-    # attribute that contains the full object details. Note that depending on
-    # the implemenation the identifier may change as a result of an update.
+    # The return should be the identifiers for the object updated.
     #
     # On error an Exception should be raised.
     #
-    # id:: identifier of the object to be replaced
+    # path:: array of tokens in the path.
+    # query:: query parameters from a URL.
     # data:: the data to use as a new object.
-    # with_data:: flag indicating the response should include the new object
-    def update(id, data, with_data=false) # :doc:
-      # TBD implement the default behavior as an example or starting point
+    def update(path, query, data) # :doc:
+      tql = { }
+      kind = path[@shell.path_pos]
+      if @shell.path_pos + 2 == path.length # has an object reference in the path
+        tql[:where] = path[@shell.path_pos + 1].to_i
+      elsif query.is_a?(Hash) && 0 < query.size
+        where = ['AND']
+        where << form_where_eq(@shell.type_key, kind)
+        query.each_pair { |k,v| where << form_where_eq(k, v) }
+        tql[:where] = where
+      else
+        raise ::WAB::Error.new("update on all #{kind} not allowed.")
+      end
+      tql[:update] = data.native
+      shell_query(tql, kind, 'update')
     end
 
     # Delete the identified object.
@@ -102,54 +121,30 @@ module WAB
     # On success the deleted object identifier is returned. If the object is
     # not found then nil is returned. On error an Exception should be raised.
     #
-    # id:: identifier of the object to be deleted
-    def delete(id) # :doc:
-      # TBD implement the default behavior as an example or starting point
-    end
-
-    # Delete all object that match the set of provided attribute values.
-    #
-    # An array of deleted object identifiers should be returned.
-    #
-    # attrs:: a Hash with keys matching paths into the target objects and value
-    #         equal to the target attribute values. A path can be an array of
-    #         keys used to walk a path to the target or a +.+ delimited set of
-    #         keys.
-    def delete_by_attrs(attrs) # :doc:
-      # TBD implement the default behavior as an example or starting point
-    end
-
-    # Return a Hash of all the objects of the type associated with the
-    # controller.
-    #
-    # The return hash keys should be the identifiers of the objects and the
-    # the values should be either nil or the object data if the +with_data+
-    # flag is true. If the response will be larger than supported one of the
-    # keys should be the empty string which indicated additional instance
-    # exists and were not provided.
-    #
-    # Note that this could return a very large set of data. If the number of
-    # instances in the type is large the +search()+ might be more appropriate
-    # as it allows for paging of results and sorting.
-    #
-    # with_data:: flag indicating the return should include object data
-    def list(with_data=false) # :doc:
-      # TBD implement the default behavior as an example or starting point
-    end
-
-    # Search using a TQL SELECT.
-    #
-    # The provided TQL[http://opo.technology/pages/doc/tql/index.html] can be
-    # either the JSON syntax or the friendly syntax. The call exists on the
-    # controller to allow filtering and permission checking before
-    # execution. Only the default controller is expected to provide a public
-    # version of this method.
-    #
-    # query:: query
-    # format:: can be one of :TQL or :TQL_JSON. The :GraphQL option is
-    #          reserved for the future.
-    def search(query, format=:TQL) # :doc:
-      # TBD implement the default behavior as an example or starting point
+    # If no +id+ is present in the path then the return should be a Hash where
+    # the keys are the matching object identifiers and the value are the
+    # object data. An empty Hash or nil indicates there were no matches.
+    #
+    # path:: identifier of the object to be deleted
+    # query:: query parameters from a URL as a Hash with keys matching paths
+    #         into the target objects and value equal to the target attribute
+    #         values. A path can be an array of keys used to walk a path to
+    #         the target or a +.+ delimited set of keys.
+    def delete(path, query) # :doc:
+      tql = { }
+      kind = path[@shell.path_pos]
+      if @shell.path_pos + 2 == path.length # has an object reference in the path
+        tql[:where] = path[@shell.path_pos + 1].to_i
+      elsif query.is_a?(Hash) && 0 < query.size
+        where = ['AND']
+        where << form_where_eq(@shell.type_key, kind)
+        query.each_pair { |k,v| where << form_where_eq(k, v) }
+        tql[:where] = where
+      else
+        tql[:where] = form_where_eq(@shell.type_key, kind)
+      end
+      tql[:delete] = nil
+      shell_query(tql, kind, 'delete')
     end
 
     # Subscribe to changes in data pushed from the model that will be passed
@@ -168,7 +163,61 @@ module WAB
     #
     # data:: the data that has changed
     def changed(data) # :doc:
-      # TBD implement the default behavior as an example or starting point
+      # TBD filter accoding to subscriptions
+      @shell.changed(data)
+    end
+
+    # Form a EQ expression for a TQL where clause. Used as a helper to the
+    # primary API calls.
+    #
+    # key:: key in the expression
+    # value:: value portion converted to the correct format if necessary
+    def form_where_eq(key, value)
+      value_class = value.class
+      x = ['EQ', key.to_s]
+      if value.is_a?(String)
+        x << "'" + value
+      elsif Time == value_class
+        x << value.utc.iso8601(9)
+      elsif value.nil? ||
+          TrueClass == value_class ||
+          FalseClass == value_class ||
+          Integer == value_class ||
+          Float == value_class
+        x << value
+      elsif String == value_class
+        if 0 < value.length && '\'' == value[0] 
+          x << value[1..-1]
+        elsif /^-?\d+$/.match?(value)
+          x << value.to_i
+        elsif /^-?\d*\.?\d+([eE][-+]?\d+)?$/.match?(value)
+          x << value.to_f
+        end
+        # TBD detect other types UUID, HTTP, Time
+        
+      elsif '2' == RbConfig::CONFIG['MAJOR'] && '4' > RbConfig::CONFIG['MINOR'] && Fixnum == value_class
+        x << value
+      else
+        x << value.to_s
+      end
+      x
+    end
+
+    # Helper to send TQL requests to the shell either synchronously or
+    # asynchronously depending on the controller type.
+    def shell_query(tql, kind, op)
+
+      # TBD check for async or not
+
+      result = @shell.query(tql, nil) # synchronous call
+      if result.nil? || 0 != result[:code]
+        if result.nil?
+          raise ::WAB::Error.new("nil result on #{kind} #{op}.")
+        else
+          raise ::WAB::Error.new("error on #{kind} #{op}. #{result[:error]}")
+        end
+      end
+      result
     end
 
   end # Controller

data/lib/wab/data.rb

@@ -85,6 +85,14 @@ module WAB
       raise NotImplementedError.new
     end
 
+    # Detects and converts strings to Ruby objects following the rules:
+    # Time:: "2017-01-05T15:04:33.123456789Z", zulu only
+    # UUID:: "b0ca922d-372e-41f4-8fea-47d880188ba3"
+    # URI:: "http://opo.technology/sample", HTTP only
+    def detect()
+      raise NotImplementedError.new
+    end
+
     private
 
     # This method is included only to raise an error if an attempt is made to

data/lib/wab/errors.rb

@@ -0,0 +1,13 @@
+
+module WAB
+
+  # Base for WAB errors and exceptions.
+  class Error < StandardError
+  end # Error
+
+  # An Exception that is raised as a result of a parse error while parsing a
+  # JSON document.
+  class ParseError < Error
+  end # ParseError
+
+end # Oj

data/lib/wab/impl/data.rb

@@ -21,10 +21,10 @@ module WAB
       #
       # value:: initial value
       # repair:: flag indicating invalid value should be repaired if possible
-      def initialize(value, repair)
+      def initialize(value, repair, check=true)
         if repair
           value = fix(value)
-        else
+        elsif check
           validate(value)
         end
         @root = value
@@ -35,23 +35,28 @@ module WAB
       # array of path node identifiers. For example, child.grandchild is the
       # same as ['child', 'grandchild'].
       def get(path)
-        path = path.to_s.split('.') unless path.is_a?(Array)
-        node = @root
-        path.each { |key|
-          if node.is_a?(Hash)
-            node = node[key.to_sym]
-          elsif node.is_a?(Array)
-            i = key.to_i
-            if 0 == i && '0' != key && 0 != key
+        if path.is_a?(Symbol)
+          node = @root[path] 
+        else
+          path = path.to_s.split('.') unless path.is_a?(Array)
+          node = @root
+          path.each { |key|
+            if node.is_a?(Hash)
+              node = node[key.to_sym]
+            elsif node.is_a?(Array)
+              i = key.to_i
+              if 0 == i && '0' != key && 0 != key
+                node = nil
+                break
+              end
+              node = node[i]
+            else
               node = nil
               break
             end
-            node = node[i]
-          else
-            node = nil
-            break
-          end
-        }
+          }
+        end
+        return Data.new(node, false, false) if node.is_a?(Hash) || node.is_a?(Array)
         node
       end
       
@@ -70,7 +75,9 @@ module WAB
       # repair:: flag indicating invalid value should be repaired if possible
       def set(path, value, repair=false)
         raise StandardError.new("path can not be empty.") if path.empty?
-        if repair
+        if value.is_a?(::WAB::Data)
+          value = value.native
+        elsif repair
           value = fix_value(value)
         else
           validate_value(value)
@@ -177,6 +184,14 @@ module WAB
         Oj.dump(@root, mode: :wab, indent: indent)
       end
 
+      # Detects and converts strings to Ruby objects following the rules:
+      # Time:: "2017-01-05T15:04:33.123456789Z", zulu only
+      # UUID:: "b0ca922d-372e-41f4-8fea-47d880188ba3"
+      # URI:: "http://opo.technology/sample", HTTP only
+      def detect()
+        # TBD
+      end
+
       private
 
       # Raise an exception if the value is not a suitable data element. If the
@@ -223,6 +238,8 @@ module WAB
           value.each { |v|
             validate_value(v)
           }
+        elsif '2' == RbConfig::CONFIG['MAJOR'] && '4' > RbConfig::CONFIG['MINOR'] && Fixnum == value_class
+          # valid value
         else
           raise StandardError.new("#{value_class.to_s} is not a valid Data value.")
         end
@@ -281,6 +298,8 @@ module WAB
           old.each { |v|
             value << fix_value(v)
           }
+        elsif '2' == RbConfig::CONFIG['MAJOR'] && '4' > RbConfig::CONFIG['MINOR'] && Fixnum == value_class
+          # valid value
         elsif value.respond_to?(:to_h) && 0 == value.method(:to_h).arity
           value = value.to_h
           raise StandardError.new("Data values must be either a Hash or an Array") unless value.is_a?(Hash)
@@ -361,7 +380,19 @@ module WAB
           c = []
           value.each { |v| c << clone_value(v) }
         else
-          c = value.clone
+          value_class = value.class
+          if value.nil? ||
+            TrueClass == value_class ||
+            FalseClass == value_class ||
+            Integer == value_class ||
+            Float == value_class ||
+            String == value_class
+            c = value
+          elsif '2' == RbConfig::CONFIG['MAJOR'] && '4' > RbConfig::CONFIG['MINOR'] && Fixnum == value_class
+            c = value
+          else
+            c = value.clone
+          end
         end
         c
       end

data/lib/wab/impl/shell.rb

@@ -9,7 +9,7 @@ module WAB
     class Shell < ::WAB::Shell
 
       # Sets up the shell with a view, model, and type_key.
-      def initialize(view, model, type_key='kind')
+      def initialize(type_key='kind', path_pos=0)
         super
       end
 

data/lib/wab/io/call.rb

@@ -0,0 +1,23 @@
+
+require 'wab'
+
+module WAB
+
+  module IO
+
+    class Call
+
+      attr_accessor :rid
+      attr_accessor :result
+      attr_accessor :thread
+
+      def initialize(timeout=2.0)
+        @rid = nil
+        @result = nil
+        @thread = Thread.current
+        @giveup = Time.now + timeout
+      end
+
+    end # Call
+  end # IO
+end # WAB