tla-sbuilder 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4731a435e4630bf464dd4d183d3a40df97e1e38
-  data.tar.gz: 8c4e8a335e829e7df768069dfb3b276e199f2913
+  metadata.gz: a2598df840dc392c2decb758b1dbc7f057cd6e6a
+  data.tar.gz: c58a5b8370bb4571dd7d4b33f6f5acb9c8049115
 SHA512:
-  metadata.gz: 7135b56dc4e078cc4f950402b3245e5bf239ea5718da7fd86c20f48fbdec39d00e06cc93f34fc2a8dfd90e727a5e6e6b9ddb41f212c510c9f604f28cc9a6954c
-  data.tar.gz: ad58191062c7e450f97f2e8f51c6deddf1eed8a39378c1775a44770be3dae2708b185340ce7022e194d04edadaac308a4b289999383568381f9ed3895bcfd89a
+  metadata.gz: d64be8f51018a61900294b67cf884b19db0e752b98b935fde5c8c9565e9c93765afd1277896f57470153b587a44c0bb08fed3cbbf57e085dff7b68c78a58c114
+  data.tar.gz: 16637b1375dc71c8a281b04f42373c0e89d13805529baff758ed8e9bddf92163e697f6f2c1a3bd5824b300f3737b9843213f5f40da55122888c573ec4cb82ae0

data/README.md

@@ -1,7 +1,7 @@
 <link href="../site.css" rel="stylesheet"></link>
 [Readme](README.md) [Releases](RELEASES.md)
 
-# Sbuilder - A Specification Builder for TLA+ Tools - $Release:0.2.1$
+# Sbuilder - A Specification Builder for TLA+ Tools - $Release:0.2.2$
 
 A tool to generate runnable specification models in
 [TLA+ language](http://research.microsoft.com/en-us/um/people/lamport/tla/book.html)
@@ -12,23 +12,14 @@ and parts of it can be presented as
 [implementation blueprints](#BLUEPRINT) to developers.
 
 See
-[live documentation](http://jarjuk.github.io/tla-sbuilder/0.1.1.pre/features.html)
-for more details on configuring Sbuilder, and on features implemented
-by Sbuilder
 
-Blog posts giving background information on Sbuilder:
+* [documentation](https://jarjuk.wordpress.com/sbuilder/) for
+  backgroun information, User's Guide and Developer's Guide
 
-* [Read an article "How Amazon uses formal methods"](https://jarjuk.wordpress.com/2016/03/03/sbuilder-1-problem):
-  summarizes experiences Amazon has gained, when using TLA+ tools,
-  what kind of benefits we should expect, when using formal methods to
-  model business IT
+* [live documentation](http://jarjuk.github.io/tla-sbuilder/0.2.2/features.html)
+  (Cucumber tests) for more details on configuring Sbuilder, and on
+  features implemented by Sbuilder
 
-* [Sbuilder introduction](https://jarjuk.wordpress.com/2016/03/03/sbuilder-2-intro/):
-  mostly the same information as in this README
-
-* [Using Sbuilder to Model Business IT Systems](https://jarjuk.wordpress.com/2016/03/03/sbuilder-3-case/):
-  a very loooong post demonstrating, how business IT system modeling
-  can be done using Sbuilder
 
 ## <a id="TARGET-SYSTEM">Target Systems</a>
 
@@ -50,7 +41,7 @@ architecture identifies
 ## <a id="ELEMENTS-OF">Runnable Specification Code</a>
 
 Sbuilder combines three main elements to create runnable TLA+
-specification code:
+Specification Code:
 
 1. **Interface specification**: Natively Sbuilder accepts
   [RESTfull](https://en.wikipedia.org/wiki/Representational_state_transfer)
@@ -281,7 +272,7 @@ and observing **Error: Evaluating invariant** `possible_tag_with_invalid_address
 
 ### Create Own Model
 
-See [live documentation](http://jarjuk.github.io/tla-sbuilder/0.1.1.pre/features.html) for more details.
+See [cucumber test](http://jarjuk.github.io/tla-sbuilder/0.2.2/features.html) for more details.
 
 Create default directories used by `sbuilder` in current working directory
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/sbuilder.rb

@@ -38,8 +38,6 @@ require_relative "sbuilder/resolver_loader.rb"
 require_relative "sbuilder/resolver_loader_yaml.rb"
 
 
-require_relative "sbuilder/param_set_loader_swagger.rb"
-
 require_relative "sbuilder/model.rb"
 
 require_relative "sbuilder/extension_loader.rb"
@@ -47,8 +45,11 @@ require_relative "sbuilder/extension_loader.rb"
 require_relative "sbuilder/factory.rb"
 require_relative "sbuilder/controller.rb"
 
+require_relative "sbuilder/facade/api_loader_plugin.rb"
 require_relative "sbuilder/facade/api_loader.rb"
 
+require_relative "sbuilder/param_set_loader_swagger.rb"
+
 require_relative "sbuilder/mustache/template_reader"
 require_relative "sbuilder/mustache/template_reader_context"
 require_relative "sbuilder/mustache/template"

data/lib/sbuilder/exception.rb

@@ -12,6 +12,9 @@ module Sbuilder
 
   class ExtensionException < SbuilderException
   end
+
+  class PluginException < SbuilderException
+  end
   
   
   class DomainException < SbuilderException

data/lib/sbuilder/facade/api_loader_plugin.rb

@@ -0,0 +1,67 @@
+module Sbuilder
+
+  # Abstract Parent class for Sbuilder for API loaders.
+  #
+  # Class implements following service groups
+  #
+  # - Constructor and Object Initialize
+  # - Framework Services for API loader
+  # - configure plugin  
+  #
+  
+  class ApiLoaderPlugin
+
+    
+    include Sbuilder::Utils::MyLogger    # mix logger
+
+    # ------------------------------------------------------------------
+    # @!group Constructor and Object Initialize
+
+    def initialize( factory, options = {} )
+    end
+
+    # Sbuilder controller calls 'setFacade' when new API loader object
+    # is contstructed. Sets instance variable '@facade' and '@logger'.
+    #
+    # @param [Sbuilder::ApiLoader] facace to Sbuilder  services
+    
+    def setFacade( facade )
+      @facade = facade
+      @logger = facade.createLogger( self.class.name.split('::').last )
+    end
+
+
+    # @!endgroup
+
+    # ------------------------------------------------------------------
+    # @!group Framework Services
+
+    # @return [Sbuilder::ApiLoader] facade to access Sbuilder servivices ( set in 'setFacade')
+    def facade
+      @facade
+    end
+    
+    # @return [Logger] logger logging to Sbuiler log
+    def logger
+      # return STDERR logger - if logger not yet ready
+      Logger.new( STDERR ) unless @logger
+      @logger
+    end
+    
+    # ------------------------------------------------------------------
+    # @!group Configure services - MUST be implement by  plugin class
+
+    # Configure API loader - MUST be implemented by plugin class
+    # @param configuration [Hash] properties to configure
+    
+    def self.configure( configuration )
+      raise PluginException.new <<-EOS
+      Plugin classes should implement method #{__method__}.
+      EOS
+    end
+
+    # @!endgroup
+    
+  end # class  ApiLoaderPlugin
+end
+

data/lib/sbuilder/param_set_loader_swagger.rb

@@ -9,36 +9,14 @@ module Sbuilder
 
   
 
-  class ParamSetLoaderSwagger
+  class ParamSetLoaderSwagger < Sbuilder::ApiLoaderPlugin
 
-    attr_reader :facade                  # [Sbuilder::ParamSetLoader]
-                                         # facade to Sbuilder
-
-    # ------------------------------------------------------------------
-    # mixer
-    PROGNAME = "LoadSwagger"                  # progname for logger
-    include Sbuilder::Utils::MyLogger         # mix logger
 
     # ------------------------------------------------------------------
     # constrcutore
     def initialize( options = {} )
-      # @logger = getLogger( PROGNAME, options )
-      # @logger.info( "#{__method__} initialized" )
-
-      @facade = nil
-      
     end
 
-    # Facade gets injected, and used immediately to create logger
-    # object.
-    #
-    # @param [Sbuilder::ApiLoader] facace to Sbuilder  services
-    #
-    def setFacade( facade )
-      @facade = facade
-      # 
-      @logger = facade.createLogger( PROGNAME )
-    end
 
     # ------------------------------------------------------------------
     # class method configure
@@ -46,15 +24,9 @@ module Sbuilder
     # @param configuration [Hash] properties to configure
     def self.configure( configuration )
     end
-    
 
-    # # extract 'intfractureServices' property from 'paramsetLoaderDef'
-    # #
-    # # @param paramsetLoaderDef [Hash] configuration in 'sbuilder.yaml'
-    # #
-    # def doConfigure( paramsetLoaderDef )
-    #   @infrastructureServices = true if paramsetLoaderDef['infrastructureServices']
-    # end
+    # ------------------------------------------------------------------
+    # Loader methods
 
     # @param yamlFileUri [String] path or url to YAML file to process
     def readLines( yamlFileUri )
@@ -68,7 +40,7 @@ module Sbuilder
     # @param yamlFileUri [String] path or url to YAML file to process
     
     def load( yamlFileUri )
-      @logger.info( "#{__method__} yamlFileUri=#{yamlFileUri}" )
+      logger.info( "#{__method__} yamlFileUri=#{yamlFileUri}" )
 
       begin
 
@@ -117,7 +89,7 @@ module Sbuilder
     def doLoadInterfaces( swagger_hash )
 
       interface_paramsSets = parseInterfaces( swagger_hash )
-      @logger.info( "#{__method__} loaded=#{interface_paramsSets.length} interface_paramsSets" )      
+      logger.info( "#{__method__} loaded=#{interface_paramsSets.length} interface_paramsSets" )      
 
       interface_paramsSets.each do |interface|
         facade.modelInterface( interface )
@@ -185,7 +157,7 @@ module Sbuilder
           expandedDocs.each do |expandedDoc|
             # puts "#----->{op}-expandedDoc->#{expandedDoc}"
             expandedDoc.each do  |parameterName,parameterProps|
-              @logger.debug( "#{__method__} {op}-parameterName->#{parameterName}, parameterProps=>#{parameterProps}" )
+              logger.debug( "#{__method__} {op}-parameterName->#{parameterName}, parameterProps=>#{parameterProps}" )
               if hasRef( parameterProps ) then
                 reference_parameter( paramSet, parameterName, getRefDocumentName( parameterProps ), parameterProps['type'] )                
               else
@@ -206,7 +178,7 @@ module Sbuilder
     #
     def parseInterfaces( swagger_hash )
       
-      @logger.info( "#{__method__} starting" )
+      logger.info( "#{__method__} starting" )
 
       # collect all interface paramsets together
       interfaces = []
@@ -220,8 +192,8 @@ module Sbuilder
           interfaceParamSet = facade.newInterface( path, op )
           paramSetResponse  = interfaceParamSet.response
           
-          @logger.info( "#{__method__} created interfaceParamSet=#{interfaceParamSet.getId}" )
-          @logger.debug( "#{__method__} created interfaceParamSet.getId=#{interfaceParamSet.getId}, opdef=#{opdef}" )
+          logger.info( "#{__method__} created interfaceParamSet=#{interfaceParamSet.getId}" )
+          logger.debug( "#{__method__} created interfaceParamSet.getId=#{interfaceParamSet.getId}, opdef=#{opdef}" )
 
           # collect
           interfaces << interfaceParamSet
@@ -230,7 +202,7 @@ module Sbuilder
           # input paramters: 'paths'/<path>/<op>/'parameters'
 
           opdef['parameters'] && opdef['parameters'].map do |parameter|
-            @logger.debug( "#{__method__} path/op #{path}/#{op} - parameter #{parameter}" )            
+            logger.debug( "#{__method__} path/op #{path}/#{op} - parameter #{parameter}" )            
             if parameter['schema'] then
               # in='body' => schema defined
               defintionReferenceName =  getReferencedDefinitionName( parameter['schema'], swagger_hash )
@@ -239,7 +211,7 @@ module Sbuilder
               simple_parameter( interfaceParamSet, parameter['name'], parameter['type'] ) if parameter['name']
             else
               msg = "Empty parameter definition on #{path}/#{op} "
-              @logger.error( "#{__method__} #{msg}" )
+              logger.error( "#{__method__} #{msg}" )
               warn msg
             end
             
@@ -253,11 +225,11 @@ module Sbuilder
             
             if response['schema'] then
               defintionReferenceName =  getReferencedDefinitionName( response['schema'], swagger_hash )
-              @logger.debug( "#{__method__} defintionReferenceName=#{defintionReferenceName}, op=#{op}, status_code=#{status_code}, response=#{response}" )
+              logger.debug( "#{__method__} defintionReferenceName=#{defintionReferenceName}, op=#{op}, status_code=#{status_code}, response=#{response}" )
               reference_parameter( paramSetResponse, "status_#{status_code}", defintionReferenceName, response['schema']['type']  )
 
             else
-              @logger.debug( "#{path}-#{op}-#{status_code}: no response data for response #{response}" )
+              logger.debug( "#{path}-#{op}-#{status_code}: no response data for response #{response}" )
               # response object
             end
           end # responses
@@ -284,7 +256,7 @@ module Sbuilder
       
       swagger_parameter = facade.newParameterReference( name, defintionReferenceName, parameterType == 'array' )
       
-      @logger.info( "#{__method__} param set =#{paramSet.getId}, parameter=#{swagger_parameter.getName}, parameter=#{swagger_parameter.reference}" )
+      logger.info( "#{__method__} param set =#{paramSet.getId}, parameter=#{swagger_parameter.getName}, parameter=#{swagger_parameter.reference}" )
 
       # add to parameter set
       paramSet.addParameter( swagger_parameter )
@@ -393,7 +365,7 @@ module Sbuilder
 
     # get document pointed by 'ref' in 'swagger_hash'
     def getDefinitionDoc( ref, swagger_hash )
-      @logger.info( "#{__method__} ref=#{ref}" )
+      logger.info( "#{__method__} ref=#{ref}" )
 
       # currently supports only local references
       raise "Not valid local ref #{ref} in #{schemaObject}" unless valid_local_ref( ref )
@@ -403,7 +375,7 @@ module Sbuilder
       
       # puts "pathElements=#{pathElements} for ref=#{ref} in #{refs}"
       defininedDoc = swagger_hash.traverse( *pathElements )
-      @logger.debug( "#{__method__} ref=#{ref} --> defininedDoc=#{defininedDoc}" )
+      logger.debug( "#{__method__} ref=#{ref} --> defininedDoc=#{defininedDoc}" )
       raise "Could not resolve definition reference '#{ref}'" if defininedDoc.nil?
       defininedDoc
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tla-sbuilder
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - jarjuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -135,6 +135,7 @@ files:
 - lib/sbuilder/exception.rb
 - lib/sbuilder/extension_loader.rb
 - lib/sbuilder/facade/api_loader.rb
+- lib/sbuilder/facade/api_loader_plugin.rb
 - lib/sbuilder/factory.rb
 - lib/sbuilder/model.rb
 - lib/sbuilder/mustache/template.rb