agreement-design-prototype 0.0.4 → 0.0.5

data/out/test/doc/doctest.md

@@ -1,17 +1,23 @@
-### complextype  
+# Model: TESTMODEL 
+## complextype
+### ComplexType - complextype 
    - string ID1
-#### things  
+#### ArrayParam - things 
      - thingname thing1
-#### things  
+#### ArrayParam - things 
      - thingname thing2
-### anothertype  
+## anothertype
+### AnotherType - anothertype 
    - string Anotherthing
-### table  
+## table
+### Table - table 
    - vals 1
    - vals 2
-### referencingtype owner 
+## referencingtype
+### ReferencingType - referencingtype 
    - id owner
-#### mate content 
+#### BasicType - mate 
      - id content
-### kindly  
+## kindly
+### Kindly - kindly 
    - kind Framework

data/src/data.rb

@@ -15,64 +15,31 @@ class DataFile < Output
     self.fmt = fmt
   end
 
-  def output *models
+  # @param [object] index - if included, and using :jsonlines, will call index on each item (as a hash) and prepend the line.
+  # @param [string] select - if given this will select out the type, eg agreements, and discard the rest
+  def output *models, index: nil, select: nil
+
+    map = models_to_data(models)
 
-    map = Hash.new
-    stack = [map]
-    transform_datamodel(
-        {
-            :before_group => lambda do |name:, depth:|
-              last = stack.last
-              n = Array.new
-              last[name] = n
-              stack.push(n) # add a new container to the stack to use next
-            end,
-            :before_type => lambda do |type:, depth:, index:, total:|
-              last = stack.last
-              n = Hash.new
-              stack.push(n) # add a new container to the stack to use next
-              if last.class <= Hash
-                last[type.name] = n
-              elsif last.class <= Array
-                last.push(n)
-              end
-            end,
-            :before_array => lambda do |name:, decl:, depth:, total:|
-              last = stack.last
-              n = Array.new
-              last[name] = n
-              stack.push(n) # add a new container to the stack to use next
-            end,
-            :attribute => lambda do |id:, val:, depth:, type:, index:, total:|
-              last = stack.last
-              if last.class <= Hash
-                last[id] = val
-              elsif last.class <= Array
-                last.push val
-              end
-            end,
-            :after_group => lambda do |name:, depth:, before:|
-              stack.pop
-            end,
-            :after_type => lambda do |type:, depth:, before:|
-              stack.pop
-            end,
-            :after_array => lambda do |index:, decl:, depth:, before: nil|
-              stack.pop
-            end,
-        }, *models)
 
     file do |file|
       if fmt == :jsonlines
-        for type in map.keys
+        select ? selection = [select] : selection = map.keys
+        for type in selection
           for decl in map[type]
+            if (index)
+              file.print (JSON.generate(index.call(decl)))
+              file.print("\n")
+            end
             file.print(JSON.generate(decl))
             file.print("\n")
           end
         end
       elsif fmt == :json
+        select ? map = map[select] : map
         file.print(JSON.generate(map))
       elsif fmt == :yaml
+        select ? map = map[select] : map
         file.print(map.to_yaml)
       else
         raise "unknown data file format"
@@ -82,6 +49,24 @@ class DataFile < Output
 
 end
 
+# given an offer object return an index object
+# Maybe: turn this into a datatype map, not an object map, so we can access type metadata
+
+def index_offering_for_elasticsearch
+  return lambda do |offer|
+    var = offer[:name].gsub(/(\s+)/, '_')
+    return {"index": {"_id": "#{var}"}}
+  end
+end
+
+def index_agreement_for_elasticsearch
+  return lambda do |id|
+    var = id[:name].gsub(/(\s+)/, '_')
+    return {"index": {"_id": "#{var}"}}
+  end
+end
+
+
 private
 
 def indent(depth)

data/src/data_model.rb

@@ -2,6 +2,7 @@ require 'date'
 
 module DataModel
 
+
   SINGLE = 1..1
   ZERO_OR_ONE = 0..1
   ONE_TO_MANY = 1..-1
@@ -84,13 +85,25 @@ module DataModel
             end
             return @attributes[k]
           end
+          if block
+            value = valueof(k, *args, &block)
+          else
+            value = args[0]
+          end
           if self.class.attributes[k][:multiplicity].end != 1
             @attributes[k] = [] unless @attributes[k]
-            @attributes[k] << valueof(k, *args, &block)
+            @attributes[k] << value
           else
-            @attributes[k] = valueof(k, *args, &block)
+            @attributes[k] = value
           end
-          return @attributes[k]
+          return value
+        end
+        self.define_singleton_method("#{k}=".to_sym) do |val|
+          @attributes[k] = val
+          val
+        end
+        self.define_singleton_method :include do |&block|
+          self.instance_exec &block
         end
       end
 
@@ -155,8 +168,8 @@ module DataModel
         end
       end
 
-      def code( *context,
-                 description: nil, title: nil, uri: nil)
+      def code(*context,
+               description: nil, title: nil, uri: nil)
         unless instance_variable_defined? :@codes
           @codes = {}
           self.define_singleton_method(:codes) {@codes}
@@ -207,7 +220,9 @@ module DataModel
 
   def domain(name, &block)
     dom = Object.const_set name, Class.new(Domain)
-    dom.instance_exec &block
+    if block_given?
+      dom.instance_exec &block
+    end
     return dom
   end
 
@@ -226,4 +241,5 @@ module DataModel
     return selclass
   end
 
+
 end # DataModel

data/src/doc.rb

@@ -4,15 +4,21 @@ include Transform
 class Document < Output
 
   def initialize dir, name
-    super File.join( dir, "doc"), name, "md"
+    super File.join(dir, "doc"), name, "md"
   end
 
   def document *models
     file do |file|
       transform_datamodel(
           {
-              :before_type => lambda do |type:, depth: 0, index:,total:|
-                file.print %Q!####{'#' * depth} #{type.name} #{type.attributes[:id] || ""} \n!
+              :before_model => lambda do |model: |
+                file.print %Q!# Model: #{model.name} \n!
+              end,
+              :before_group => lambda do |name: |
+                file.print %Q!## #{name}\n!
+              end,
+              :before_type => lambda do |type:, depth: 0, index:, total:|
+                file.print %Q!####{'#' * depth} #{type.class.typename} - #{type.name} \n!
               end,
               :attribute => lambda do |id:, val:, depth: 0, type: nil, index:, total:|
                 file.print %Q!#{"  " * depth} - #{id} #{val}\n!
@@ -29,9 +35,9 @@ class Document < Output
                 file.print %Q!\# Data model: #{model}\n!
               end,
               before_group: lambda do |group|
-                file.print %Q!\# #{cat.class}: #{cat.name}\n!
-                if (cat.respond_to?(:description))
-                  file.print %Q! #{cat.description}\n!
+                file.print %Q!\# #{group.class}: #{group.name}\n!
+                if (group.respond_to?(:description))
+                  file.print %Q! #{group.description}\n!
                 end
               end,
               before_type: lambda do |type:, depth:, index:, total:|

data/src/transform.rb

@@ -38,8 +38,8 @@ module Transform
     return [model: model, code: code]
   end
 
-  def before_group_lambda name: nil, depth: 0
-    return [name: name, depth: depth]
+  def before_group_lambda name: nil
+    return [name: name]
   end
 
   def after_group_lambda name: nil, before: nil, depth: 0
@@ -77,7 +77,7 @@ module Transform
         t = 0
         # there will be more than one of each type
         for type in model.contents[typename]
-          transform_type(lambdas, decl: type, name: typename, depth: 0, index: 0, total: 1)
+          transform_entry(lambdas, decl: type, name: typename, depth: 0, index: 0, total: 1)
           t = t + 1
         end
         grp = cond_call(lambdas, :after_group, *after_group_lambda(name: typename, before: grp))
@@ -90,7 +90,7 @@ module Transform
     for model in models
       dom = cond_call(lambdas, :before_model, *before_model_lambda(model: model))
       for type in model.types.values
-        before = cond_call(lambdas, :before_type, *before_type_lambda(type: type, index:0, total:1))
+        before = cond_call(lambdas, :before_type, *before_type_lambda(type: type, index: 0, total: 1))
         i = 0
         for ak in type.attributes.keys
           av = type.attributes[ak]
@@ -116,13 +116,13 @@ module Transform
     return 0
   end
 
-  def transform_type(lambdas, index:, name:, decl:, depth:, total:)
+  def transform_entry(lambdas, index:, name:, decl:, depth:, total:)
 
     if decl.class <= Array
       arrctx = cond_call(lambdas, :before_array, *before_array_lambda(name: name, decl: decl, depth: depth, total: decl.length))
       j = 0
       for aa in decl
-        transform_type(lambdas, index: j, decl: aa, name: name, depth: depth, total: decl.length)
+        transform_entry(lambdas, index: j, decl: aa, name: name, depth: depth, total: decl.length)
         j = j + 1
       end
       cond_call(lambdas, :after_array, *after_array_lambda(index: index, decl: decl, depth: depth, before: arrctx))
@@ -131,7 +131,7 @@ module Transform
       i = 0
       for ak in decl.attributes.keys
         av = decl.attributes[ak]
-        transform_type(lambdas, name: ak, decl: av, depth: depth + 1, index: i, total: decl.attributes.keys.length)
+        transform_entry(lambdas, name: ak, decl: av, depth: depth + 1, index: i, total: decl.attributes.keys.length)
         i = i + 1
       end
       cond_call(lambdas, :after_type, *after_type_lambda(type: decl, depth: depth, before: before))
@@ -141,4 +141,62 @@ module Transform
     self
   end
 
+  def models_to_data(models)
+    map = Hash.new
+    stack = [map]
+    transform_datamodel(
+        {
+            :before_group => lambda do |name:|
+              # group all instances of the same type name into the same array in the top level map
+              if map[name]
+                stack.push(map[name])
+              else
+                n = Array.new
+                map[name] = n
+                stack.push(map[name]) # add a new container to the stack to use next
+              end
+            end,
+            :before_type => lambda do |type:, depth:, index:, total:|
+              last = stack.last
+              n = Hash.new
+              stack.push(n) # add a new container to the stack to use next
+              if last.class <= Hash
+                last[type.name] = n
+              elsif last.class <= Array
+                last.push(n)
+              end
+            end,
+            :before_array => lambda do |name:, decl:, depth:, total:|
+              last = stack.last
+              n = Array.new
+              if last.class <= Array
+                last << n
+              else
+                last[name] = n
+              end
+              stack.push(n) # add a new container to the stack to use next
+            end,
+            :attribute => lambda do |id:, val:, depth:, type:, index:, total:|
+              last = stack.last
+              if last.class <= Hash
+                last[id] = val
+              elsif last.class <= Array
+                last.push val
+              end
+            end,
+            :after_group => lambda do |name:, depth:, before:|
+              stack.pop
+            end,
+            :after_type => lambda do |type:, depth:, before:|
+              stack.pop
+            end,
+            :after_array => lambda do |index:, decl:, depth:, before: nil|
+              stack.pop
+            end,
+        }, *models)
+    map
+  end
+
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agreement-design-prototype
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - CCS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -34,19 +34,28 @@ files:
 - "./README.md"
 - "./Rakefile"
 - "./agreement-design.gemspec"
-- "./build/build_models.rb"
-- "./gen/data/data.json"
-- "./gen/data/data.yaml"
-- "./gen/data/fm_agreements.jsonlines"
+- "./data/README.md"
+- "./data/teacher-management-test.csv"
+- "./data/teacher-recruitment-test.csv"
+- "./gen/README.md"
+- "./gen/data/ELETE"
+- "./gen/data/agreements.json"
+- "./gen/data/agreements.jsonlines"
+- "./gen/data/agreements.yaml"
 - "./gen/data/fm_catalogue.jsonlines"
+- "./gen/data/teacher-management-test-offers.jsonlines"
+- "./gen/data/teacher-recruitment-test-offers.jsonlines"
 - "./gen/diagrams/metamodel.dot"
-- "./gen/doc/data.md"
 - "./gen/doc/metamodel.md"
+- "./gen/doc/supply_teachers.md"
 - "./gen/images/metamodel.jpg"
+- "./generate.rb"
+- "./model/README.md"
 - "./model/agreement.rb"
 - "./model/fm.rb"
 - "./model/geographic.rb"
 - "./model/party.rb"
+- "./model/supply_teachers.rb"
 - "./out/test/data/datatest.json"
 - "./out/test/diagrams/d.dot"
 - "./out/test/doc/doctest.md"

data/build/build_models.rb

@@ -1,31 +0,0 @@
-require_relative "../src/diagram"
-require_relative "../src/doc"
-require_relative "../src/data"
-require_relative "../model/agreement"
-require_relative "../model/fm"
-require_relative '../model/geographic'
-
-path = File.join(File.dirname(__FILE__), '../', "gen")
-
-metamodels = [Agreements, Parties, Geographic, FM]
-models = [Agreements::FM_Agreements, FM::FM_Catalogue, Geographic::NUTS]
-
-diagram = Diagram.new(path, "metamodel")
-diagram.describe *metamodels
-
-doc = Document.new(path, "metamodel")
-doc.document_metamodel *metamodels
-
-doc = Document.new(path, "data")
-doc.document *models
-
-data= DataFile.new( path, "data", fmt: :json)
-data.output *models
-data= DataFile.new( path, "data", fmt: :yaml)
-data.output *models
-
-data= DataFile.new( path, "fm_agreements", fmt: :jsonlines)
-data.output Agreements::FM_Agreements
-
-data= DataFile.new( path, "fm_catalogue", fmt: :jsonlines)
-data.output FM::FM_Catalogue

data/gen/data/data.json

@@ -1 +0,0 @@
-{"agreement":[{"kind":"Framework","id":"FM","fwk_number":"RM8330","version":"0.1.0","description":"This agreement is for the provision of Facilities Management","start_date":"2018-10-01"},{"kind":"Lot","id":"FM lot 1","name":"low-to-mid value Facilities Management Lot","part_of_id":"FM","min_value":0,"max_value":70000000,"version":"0.1.0","item_type":[{"id":"FM.1a-C.3","scheme_id":"CCS","unit":"Currency","code":"CCS-building-area-method","keyword":["cleaning","washing","janitor"]}]}],"fm_offering":[{"supplier_id":"XYZ corp","name":"XYZ's nifty school cleaning service","agreement_id":"FM","location_id":["UK"],"sector":["Education"],"sc_cleared":"TRUE","item":[{"type":"FM.1a-C.3","value":3000}]}],"areacode":[{"name":"UK","subcode":[{"name":"UKC","description":"North East","subcode":[{"name":"UKC1","description":"Tees Valley and County Durham"}]},{"name":"UKL","description":"London"}]}]}

data/gen/data/data.yaml

@@ -1,46 +0,0 @@
----
-:agreement:
-- :kind: :Framework
-  :id: FM
-  :fwk_number: RM8330
-  :version: 0.1.0
-  :description: This agreement is for the provision of Facilities Management
-  :start_date: 2018-10-01
-- :kind: :Lot
-  :id: FM lot 1
-  :name: low-to-mid value Facilities Management Lot
-  :part_of_id: FM
-  :min_value: 0
-  :max_value: 70000000
-  :version: 0.1.0
-  :item_type:
-  - :id: FM.1a-C.3
-    :scheme_id: :CCS
-    :unit: :Currency
-    :code: CCS-building-area-method
-    :keyword:
-    - cleaning
-    - washing
-    - janitor
-:fm_offering:
-- :supplier_id: XYZ corp
-  :name: XYZ's nifty school cleaning service
-  :agreement_id: FM
-  :location_id:
-  - :UK
-  :sector:
-  - :Education
-  :sc_cleared: 'TRUE'
-  :item:
-  - :type: FM.1a-C.3
-    :value: 3000
-:areacode:
-- :name: :UK
-  :subcode:
-  - :name: :UKC
-    :description: North East
-    :subcode:
-    - :name: :UKC1
-      :description: Tees Valley and County Durham
-  - :name: :UKL
-    :description: London