hutch-xamplr 1.2.0 → 1.3.0

data/examples/employees/twist/xampl-gen.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby -w -I..
+
+if $0 == __FILE__ then
+
+  class File
+    def File.sjoin(*args)
+      File.join(args.select{ | o | o })
+    end
+  end
+
+  $LOAD_PATH.unshift('../../lib/')
+
+  require 'xamplr-generator'
+
+  include XamplGenerator
+  include Xampl
+
+  Xampl.transaction("setup", :in_memory) do
+    directory = File.sjoin(".", "xampl_generated_code")
+
+    options = Xampl.make(Options) do |options|
+      options.new_index_attribute("pid").persisted = true
+      options.new_index_attribute("id")
+
+      options.resolve("http://example.com/employees", "Employees", "emp")
+    end
+
+    filenames = Dir.glob("./xml/**/*.xml")
+
+    generator = Generator.new
+    generator.go(:options => options,
+                 :filenames => filenames,
+                 :directory => directory)
+
+    puts generator.print_elements("./generated-elements.xml")
+    exit!
+  end
+end

data/examples/employees/twist/xml/twist.xml

@@ -0,0 +1,90 @@
+<!--
+[RetirementPlan] ^[DefinedContribution],
+[RetirementPlan] ^[DefinedBenefit],
+[Payroll]^[HourlyPayroll],
+[Payroll]^[SalariedPayroll],
+[EmployeeType]->*[RetirementPlan],
+[EmployeeType]->*[Payroll],
+[Employee]*->[EmployeeType],
+[Department]-*[Employee]
+-->
+<company pid=''
+         xmlns="http://example.com/employees">
+
+    <hourly-payroll pid='singleton'>
+        <__payroll__/>
+    </hourly-payroll>
+    <salaried-payroll pid='singleton'>
+        <__payroll__/>
+    </salaried-payroll>
+
+    <defined-contribution pid="singleton">
+        <retirement-plan/>
+    </defined-contribution>
+    <defined-benefit pid="singleton">
+        <retirement-plan/>
+    </defined-benefit>
+
+    <employee-type pid="">
+      <__payroll__ />
+    </employee-type>
+
+    <employee-type pid=''
+                   title='janitor'>
+        <hourly-payroll pid='singleton'/>
+        <defined-contribution pid="singleton"/>
+    </employee-type>
+    <employee-type pid=''
+                   title='receptionist'>
+        <hourly-payroll pid='singleton'/>
+        <defined-contribution pid="singleton"/>
+    </employee-type>
+    <employee-type pid=''
+                   title='office-admin'>
+        <hourly-payroll pid='singleton'/>
+        <defined-benefit pid="singleton"/>
+    </employee-type>
+    <employee-type pid=''
+                   title='engineer'>
+        <salaried-payroll pid='singleton'/>
+        <defined-benefit pid="singleton"/>
+    </employee-type>
+    <employee-type pid=''
+                   title='manager'>
+        <salaried-payroll pid='singleton'/>
+        <defined-benefit pid="singleton"/>
+    </employee-type>
+
+
+    <department pid=''
+                name='widget design'>
+        <employee pid=''
+                  name='tom'>
+            <employee-type pid=''
+                           title='janitor'/>
+        </employee>
+        <employee pid=''
+                  name='mary'
+                  title='receptionist'>
+            <employee-type pid=''
+                           title='receptionist'/>
+        </employee>
+        <employee pid=''
+                  name='bob'
+                  title='office-admin'>
+            <employee-type pid=''
+                           title='office-admin'/>
+        </employee>
+
+        <employee pid=''
+                  name='jack'>
+            <employee-type pid=''
+                           title='engineer'/>
+        </employee>
+        <employee pid=''
+                  name='jill'>
+            <employee-type pid=''
+                           title='manager'/>
+        </employee>
+    </department>
+</company>

data/examples/employees/xamplr-twist.xml

@@ -0,0 +1,2 @@
+<company pid='' xmlns="http://xampl.com/employees-twisted">
+</company>

data/examples/employees/yuml-diagrams/ddd-final.yuml

@@ -0,0 +1,8 @@
+[RetirementPlan]^[DefinedContribution],
+[RetirementPlan]^[DefinedBenefit],
+[Payroll]^[HourlyPayroll],
+[Payroll]^[SalariedPayroll],
+[EmployeeType]->*[RetirementPlan],
+[EmployeeType]->*[Payroll],
+[Employee]*->[EmployeeType],
+[Department]-*[Employee]

data/examples/employees/yuml-diagrams/ddd-first.yuml

@@ -0,0 +1,7 @@
+[RetirementPlan]^[DefinedContribution],
+[RetirementPlan]^[DefinedBenefit],
+[Employee]^[HourlyEmployee],
+[Employee]^[SalariedEmployee],
+[HourlyEmployee]->[DefinedContribution],
+[SalariedEmployee]->[DefinedBenefit],
+[Department]-*[Employee]

data/examples/employees/yuml-diagrams/twist.yuml

@@ -0,0 +1,12 @@
+[RetirementPlan::Mixin]^[DefinedContribution],
+[RetirementPlan::Mixin]^[DefinedBenefit],
+[Payroll::Mixin]^[HourlyPayroll],
+[Payroll::Mixin]^[SalariedPayroll],
+[EmployeeType]->*[RetirementPlan::Mixin],
+[EmployeeType]->*[Payroll::Mixin],
+[Employee]*->[EmployeeType],
+[Department]<->*[Employee],
+[SalariedPayroll]->[Payroll],
+[HourlyPayroll]->[Payroll],
+[DefinedBenefit]->[RetirementPlan],
+[DefinedContribution]->[RetirementPlan]

data/examples/employees/yuml-diagrams/yuml-simplified.txt

@@ -0,0 +1,19 @@
+[Employees::HourlyPayroll{bg:red}],
+[Employees::Payrole{bg:blue}],
+[Employees::SalariedPayroll{bg:red}],
+[Employees::DefinedContribution{bg:red}],
+[Employees::RetirementPlan{bg:blue}],
+[Employees::DefinedBenefit{bg:red}],
+[Employees::EmployeeType{bg:red}],
+[Employees::Department{bg:red}],
+[Employees::Employee{bg:red}],
+[Employees::HourlyPayroll]->[Employees::Payrole],
+[Employees::SalariedPayroll]->[Employees::Payrole],
+[Employees::DefinedContribution]->[Employees::RetirementPlan],
+[Employees::DefinedBenefit]->[Employees::RetirementPlan],
+[Employees::EmployeeType]->[Employees::DefinedContribution],
+[Employees::EmployeeType]->[Employees::HourlyPayroll],
+[Employees::EmployeeType]->[Employees::SalariedPayroll],
+[Employees::EmployeeType]->[Employees::DefinedBenefit],
+[Employees::Department]->[Employees::Employee],
+[Employees::Employee]->[Employees::EmployeeType]

data/examples/employees/yuml-diagrams/yuml-with-mixins.txt

@@ -0,0 +1,53 @@
+,
+[Employees::Company{bg:red}],
+[Employees::CompanyMixin],
+[Employees::HourlyPayroll{bg:red}],
+[Employees::HourlyPayrollMixin],
+[Employees::Payrole{bg:blue}],
+[Employees::PayroleMixin],
+[Employees::SalariedPayroll{bg:red}],
+[Employees::SalariedPayrollMixin],
+[Employees::DefinedContribution{bg:red}],
+[Employees::DefinedContributionMixin],
+[Employees::RetirementPlan{bg:blue}],
+[Employees::RetirementPlanMixin],
+[Employees::DefinedBenefit{bg:red}],
+[Employees::DefinedBenefitMixin],
+[Employees::EmployeeType{bg:red}],
+[Employees::EmployeeTypeMixin],
+[Employees::Department{bg:red}],
+[Employees::DepartmentMixin],
+[Employees::Employee{bg:red}],
+[Employees::EmployeeMixin],
+[Employees::Company]->[Employees::HourlyPayroll],
+[Employees::HourlyPayrollMixin]^[Employees::Company],
+[Employees::Company]->[Employees::SalariedPayroll],
+[Employees::SalariedPayrollMixin]^[Employees::Company],
+[Employees::Company]->[Employees::DefinedContribution],
+[Employees::DefinedContributionMixin]^[Employees::Company],
+[Employees::Company]->[Employees::DefinedBenefit],
+[Employees::DefinedBenefitMixin]^[Employees::Company],
+[Employees::Company]->[Employees::EmployeeType],
+[Employees::EmployeeTypeMixin]^[Employees::Company],
+[Employees::Company]->[Employees::Department],
+[Employees::DepartmentMixin]^[Employees::Company],
+[Employees::HourlyPayroll]->[Employees::Payrole],
+[Employees::PayroleMixin]^[Employees::HourlyPayroll],
+[Employees::SalariedPayroll]->[Employees::Payrole],
+[Employees::PayroleMixin]^[Employees::SalariedPayroll],
+[Employees::DefinedContribution]->[Employees::RetirementPlan],
+[Employees::RetirementPlanMixin]^[Employees::DefinedContribution],
+[Employees::DefinedBenefit]->[Employees::RetirementPlan],
+[Employees::RetirementPlanMixin]^[Employees::DefinedBenefit],
+[Employees::EmployeeType]->[Employees::DefinedContribution],
+[Employees::DefinedContributionMixin]^[Employees::EmployeeType],
+[Employees::EmployeeType]->[Employees::HourlyPayroll],
+[Employees::HourlyPayrollMixin]^[Employees::EmployeeType],
+[Employees::EmployeeType]->[Employees::SalariedPayroll],
+[Employees::SalariedPayrollMixin]^[Employees::EmployeeType],
+[Employees::EmployeeType]->[Employees::DefinedBenefit],
+[Employees::DefinedBenefitMixin]^[Employees::EmployeeType],
+[Employees::Department]->[Employees::Employee],
+[Employees::EmployeeMixin]^[Employees::Department],
+[Employees::Employee]->[Employees::EmployeeType],
+[Employees::EmployeeTypeMixin]^[Employees::Employee]

data/examples/employees/yuml-diagrams/yuml.txt

@@ -0,0 +1,27 @@
+,
+[Employees::Company{bg:red}],
+[Employees::HourlyPayroll{bg:red}],
+[Employees::Payrole{bg:blue}],
+[Employees::SalariedPayroll{bg:red}],
+[Employees::DefinedContribution{bg:red}],
+[Employees::RetirementPlan{bg:blue}],
+[Employees::DefinedBenefit{bg:red}],
+[Employees::EmployeeType{bg:red}],
+[Employees::Department{bg:red}],
+[Employees::Employee{bg:red}],
+[Employees::Company]->[Employees::HourlyPayroll],
+[Employees::Company]->[Employees::SalariedPayroll],
+[Employees::Company]->[Employees::DefinedContribution],
+[Employees::Company]->[Employees::DefinedBenefit],
+[Employees::Company]->[Employees::EmployeeType],
+[Employees::Company]->[Employees::Department],
+[Employees::HourlyPayroll]->[Employees::Payrole],
+[Employees::SalariedPayroll]->[Employees::Payrole],
+[Employees::DefinedContribution]->[Employees::RetirementPlan],
+[Employees::DefinedBenefit]->[Employees::RetirementPlan],
+[Employees::EmployeeType]->[Employees::DefinedContribution],
+[Employees::EmployeeType]->[Employees::HourlyPayroll],
+[Employees::EmployeeType]->[Employees::SalariedPayroll],
+[Employees::EmployeeType]->[Employees::DefinedBenefit],
+[Employees::Department]->[Employees::Employee],
+[Employees::Employee]->[Employees::EmployeeType]

data/examples/random-people-shared-addresses/xampl-gen.rb

@@ -8,6 +8,8 @@ if $0 == __FILE__ then
     end
   end
 
+  $LOAD_PATH.unshift('../../lib/')  
+
   require 'xamplr-generator'
 
   include XamplGenerator

data/examples/random-people/xampl-gen.rb

@@ -8,6 +8,8 @@ if $0 == __FILE__ then
     end
   end
 
+  $LOAD_PATH.unshift('../../lib/')
+
   require 'xamplr-generator'
 
   include XamplGenerator

data/examples/read-testing/xampl-gen.rb

@@ -8,6 +8,8 @@ if $0 == __FILE__ then
     end
   end
 
+  $LOAD_PATH.unshift('../../lib/')
+  
   require 'xamplr-generator'
 
   include XamplGenerator

data/examples/tokyo-cabinet-experimental/xampl-gen.rb

@@ -8,6 +8,8 @@ if $0 == __FILE__ then
     end
   end
 
+  $LOAD_PATH.unshift('../../lib/')
+  
   require 'xamplr-generator'
 
   include XamplGenerator

data/lib/xamplr-generator.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 
 module Xampl
 

data/lib/xamplr.rb

@@ -1,7 +1,7 @@
-#!/usr/bin/env ruby
 
 module Xampl
 
+  require 'rubygems'
   require "yaml"
   require "logger"
 

data/lib/xamplr/graphml-out.rb

@@ -83,19 +83,7 @@ module XamplGenerator
       return false
     end
 
-#    def ignore_package(package)
-#      puts "#{File.basename(__FILE__)}:#{__LINE__} pkg: [#{ package }], exclude: #{ @excluded_packages.inspect }, include: #{ @included_packages.inspect }"
-#      r = ignore_package_work(package)
-#      puts "#{File.basename(__FILE__)}:#{__LINE__}      ignore? #{ r }"
-#      r
-#    end
-
-    #def write_graph_ml(filename, excluded_packages=[ 'C2', 'NavRelationships', 'App' ], included_packages=nil, include_mixins=false)
     def write_graph_ml(filename, excluded_packages=[ ], included_packages=nil, include_mixins=true)
-
-      #puts "#{File.basename(__FILE__)}:#{__LINE__} no graphml yet"
-      #return
-
       filename = devise_filename(filename)
 
       @excluded_packages = Set.new(excluded_packages)

data/lib/xamplr/persisters/tokyo-cabinet.rb

@@ -264,7 +264,7 @@ module Xampl
         next unless result
 
         mentioner = result['xampl_from']
-        class_name = result['class']
+        class_name = result['mentioned_class']
         result_class = class_cache[class_name]
         unless result_class then
           class_name.split("::").each do | chunk |
@@ -316,6 +316,10 @@ module Xampl
         msg = note_errors("TC[[#{ @filename }]]:: trancommit error: %s\n") do
           @tc_db.tranabort
         end
+        puts "------------------------------------------------------------------------"
+        puts "TokyoCabinetPersister Error:: #{ msg }/#{ e }"
+        puts e.backtrace.join("\n")
+        puts "------------------------------------------------------------------------"
         raise "TokyoCabinetPersister Error:: #{ msg }/#{ e }"
       else
         note_errors("TC[[#{ @filename }]]:: trancommit error: %s\n") do
@@ -327,6 +331,12 @@ module Xampl
         #        end
       end
 #      puts "               num records: #{ @tc_db.rnum() }"
+#      puts "#{ __FILE__ }:#{ __LINE__ } keys..."
+#      @tc_db.keys.each do | key |
+#        meta = @tc_db[key]
+#        meta['xampl'] = (meta['xampl'] || "no rep")[0..25]
+#        puts "         key: [#{ key }] -- #{ meta.inspect }"
+#      end
     end
 
     def write(xampl)
@@ -349,7 +359,7 @@ module Xampl
         pk = @tc_db.genuid
         mention_hash = {
                 'xampl_from' => place,
-                'class' => xampl.class.name,
+                'mentioned_class' => xampl.class.name,
                 'pid' => xampl.get_the_index,
                 'xampl_to' => mention_place
         }

data/lib/xamplr/xampl-generator.rb

@@ -7,6 +7,7 @@ module XamplGenerator
   require "xamplr/xampl-hand-generated"
   require "xamplr/simpleTemplate/simple-template"
   require "xamplr/graphml-out.rb"
+  require "xamplr/yuml-out.rb"
 
   class Attribute
     attr_accessor :tag_name
@@ -307,6 +308,9 @@ module XamplGenerator
       graphml_out = GraphMLOut.new(@elements_map)
       graphml_out.write_graph_ml(filename)
 
+      yuml_out = YUMLOut.new(@elements_map)
+      yuml_out.write_yuml(filename)
+
     end
 
     def go(args, &eval_context)

data/lib/xamplr/yuml-out.rb

@@ -0,0 +1,136 @@
+require 'fileutils'
+require 'set'
+
+module XamplGenerator
+
+  class YUMLOut
+
+    def initialize(elements_map)
+      @elements_map = elements_map
+    end
+
+    def devise_filename(filename)
+      bn = File.basename(filename)
+      ext = File.extname(bn)
+      bn = bn[0..(bn.size - ext.size - 1)]
+      fn = "#{bn}.yuml"
+    end
+
+    def generate_class_nodes(element, include_mixins)
+      return if ignore_package(element.package)
+
+      class_name = "#{ element.package }::#{ element.class_name }"
+      mixin_name = "#{ element.package }::#{ element.class_name }"
+
+      @class_by_nstag[element.nstag] = element
+      @class_names_by_nstag[element.nstag] = class_name
+
+      if element.persisted then
+        write_entity_node(class_name, element.kind)
+      else
+        write_internal_node(class_name, element.kind)
+      end
+
+      if include_mixins then
+        write_mixin_node(class_name)
+      end
+    end
+
+    def generate_edges(element, include_mixins)
+      return if ignore_package(element.package)
+
+      element_name = @class_names_by_nstag[ element.nstag ]
+
+      element.child_element_child.each do | celement |
+        next if ignore_package(celement.package)
+
+        celement_name = @class_names_by_nstag[ celement.name ]
+        referenced_element = @class_by_nstag[ celement.name ]
+
+        if referenced_element.persisted then
+          write_entity_ref_edge(element_name, celement_name)
+        else
+          write_internal_ref_edge(element_name, celement_name)
+        end
+        if include_mixins then
+          write_mixin_ref_edge(element_name, celement_name)
+        end
+      end
+    end
+
+    def ignore_package(package)
+      return true if @excluded_packages.member?(package)
+      return false if @included_packages.nil?
+      return true unless @included_packages.member?(package)
+      return false
+    end
+
+    def write_yuml(base_filename, excluded_packages=[ ], included_packages=nil, include_mixins=false)
+      filename = devise_filename(base_filename)
+
+      @excluded_packages = Set.new(excluded_packages)
+      @included_packages = included_packages ? Set.new(included_packages) : nil
+
+      @class_names_by_nstag = {} # NOTE -- this is used by yuml!!
+      @class_by_nstag = {} # NOTE -- this is used by yuml!!
+
+      @initialise_output = true
+
+      File.open(filename, "w") do | out |
+        @out = out
+
+        @elements_map.each_value do |elements|
+          elements.element_child.each do |element|
+            generate_class_nodes(element, include_mixins)
+          end
+        end
+
+        @elements_map.each_value do |elements|
+          elements.element_child.each do |element|
+            generate_edges(element, include_mixins)
+          end
+        end
+      end
+
+      return nil
+    end
+
+    def new_statement
+      if @initialise_output then
+        @initialise_output = false
+      else
+        @out << ",\n"
+      end
+    end
+
+    def write_entity_node(class_name, kind)
+      new_statement
+      @out << "[#{ class_name }{bg:red}]"
+    end
+
+    def write_internal_node(class_name, kind)
+      new_statement
+      @out << "[#{ class_name }{bg:blue}]"
+    end
+
+    def write_mixin_node(class_name)
+      new_statement
+      @out << "[#{ class_name }Mixin]"
+    end
+
+    def write_entity_ref_edge(class_node, external_node)
+      new_statement
+      @out << "[#{ class_node }]->[#{ external_node }]"
+    end
+
+    def write_internal_ref_edge(class_node, internal_node)
+      new_statement
+      @out << "[#{ class_node }]->[#{ internal_node }]"
+    end
+
+    def write_mixin_ref_edge(class_node, mixin_node)
+      new_statement
+      @out << "[#{ mixin_node }Mixin]^[#{ class_node }]"
+    end
+  end
+end