xamplr 1.2.0 → 1.3.15

data/README.rdoc

@@ -2,7 +2,8 @@
 
 xamplr is a set of software tools that supports development of ruby applications.
 
-Features:
+== Features:
+
   - supports Domain Driven Design in Ruby
   - persistence ignornace
   - clusters, entities, 'regular' objects, and repositories (corresponding approximately to DDD's aggregates, entities, value objects, and repositories)
@@ -12,15 +13,34 @@ Features:
   - fast development, fast execution
   - has been in use in commercial software since 2004, a Java version has been in use since 1998.
 
-Anti-Features:
+== Anti-Features:
+
   - absymal lack of documentation. If you are brave and willing to wade through (old) blog entries, you might try looking at: 
 
     http://recursive.ca/hutch/category/software/tools-i-use/xampl/
 
-License: For the moment it is AGPLv3 (see COPYING). An alternative license
+== Installation:
+
+  The stable release is hosted on rubyforge as a gem, so:
+
+      [sudo] gem install xamplr
+
+  The most recent release is hosted on github, also as a gem, so:
+
+      gem sources -a http://gems.github.com
+      [sudo] gem install hutch-xamplr
+
+  The most recent code is in the repository, so clone the github project and either
+  use it directly (with a little fooling about with load paths), or build it as a gem
+  and install locally.
+
+== License:
+
+For the moment it is AGPLv3 (see COPYING). An alternative license
 may be negotiated, contact me. In the near future this license will be
 relaxed.
 
-== Copyright
+Copyright Info:
 
 Copyright (c) 2009 Bob Hutchison. See LICENSE and COPYING for details.
+

data/Rakefile

@@ -11,8 +11,8 @@ begin
     gem.authors = ["Bob Hutchison"]
     gem.rubyforge_project = 'xampl'
 
-    gem.add_dependency('hutch-xamplr-pp')
-    gem.add_dependency('libxml-ruby', ">=1.1.3")
+    gem.add_dependency('xamplr-pp', '>=1.1.2')
+    gem.add_dependency('libxml-ruby', '>=1.1.3')
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
-:patch: 0
 :major: 1
-:minor: 2
+:minor: 3
+:patch: 15
+:build: 

data/bin/xampl-gen

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+#!/usr/bin/env ruby -w -I..
+
+require 'xamplr-generator'
+require 'xamplr/xampl-cl-gen'
+
+include XamplGenerator
+include Xampl
+
+project_specialisations = File.join(%w{ . project-generator.rb })
+if File.exists?(project_specialisations) then
+  load project_specialisations
+end
+
+generator = ProjectGenerator.new
+generator.generate
+

data/docs/intro/.gitignore

@@ -0,0 +1 @@
+*.yuml

data/docs/intro/example1/example1.rb

@@ -0,0 +1,6 @@
+require 'xampl_generated_code/XamplAdHoc.rb'
+
+Xampl.transaction("example1") do
+  h = HelloWorld.new
+  puts h.to_xml
+end

data/docs/intro/example1/xml/hello.xml

@@ -0,0 +1 @@
+<hello-world/>

data/docs/intro/example2/example2.rb

@@ -0,0 +1,38 @@
+require 'xampl_generated_code/Example2.rb'
+
+include Example2
+
+class Hello
+  def to_s
+    "Hello #{ who ? who : 'hello?' }!"
+  end
+end
+
+Xampl.transaction("example2") do
+  h = Hello.new
+
+  puts "haven't set the who attribute yet..."
+  puts h.to_xml
+  puts h
+
+  h.who = 'world'
+
+  puts "\nhave set the who attribute to 'world'..."
+  puts h.to_xml
+  puts h.pp_xml
+  puts h
+
+  h2 = Hello.new
+  h2.who = 'there'
+
+  all = [ h, h2 ]
+
+  puts "\nthere are two Hello things now..."
+  puts h
+  puts h2
+
+  puts "\nprint an array of the two Hello things..."
+  puts all
+  puts "\ninspect an array of the two Hello things..."
+  puts all.inspect
+end

data/docs/intro/example2/project-generator.rb

@@ -0,0 +1,22 @@
+class ProjectGenerator
+
+  def resolve_namespaces
+    # any array of arrays
+    # each sub-array:
+    #    0: a string or an array of strings, containing xml namespaces found
+    #       in the example xml files an empty string is the default namespace
+    #    1: a ruby Module name (get the character cases right)
+    #    2: a namespace prefix used when writing xml, optional. A generated
+    #       prefix will be used otherwise.
+
+    #[]
+
+    [
+            [ 'com.xampl.intro.example2', 'Example2', 'ex2']
+    ]
+
+
+  end
+
+end
+

data/docs/intro/example2/xml/hello.xml

@@ -0,0 +1,2 @@
+<hello who='world'
+       xmlns='com.xampl.intro.example2'/>

data/docs/intro/example3/example3.rb

@@ -0,0 +1,30 @@
+require 'greeter'
+require 'greeting'
+
+##include Example3 -- nope, not this time
+
+Xampl.transaction("example3") do
+  greeter = Example3::Greeter.new
+
+  greeting1 = Example3::Greeting.new('has-name')
+  greeting1.content = "Hello $$$, how are you?"
+  greeter << greeting1
+
+  greeter.new_who.name = 'world'
+  greeter.new_who.name = 'there'
+
+  greeting2 = greeter.new_greeting('no-name')
+  greeting2.content = "Hello hello? Someone there?"
+
+  greeter.new_who
+
+  puts greeter.to_xml
+  puts greeter.pp_xml
+
+  puts "\nAnd now extend our greetings..."
+
+  greeter.extend_greetings
+
+  puts "\nwriting the xml representation of our greeter..."
+  File.open('greeter.xml', 'w') { |f| f.write greeter.to_xml }
+end

data/docs/intro/example3/example3a.rb

@@ -0,0 +1,16 @@
+require 'greeter'
+require 'greeting'
+
+unless File.exists? "greeter.xml" then
+  puts "run example3 before running this one"
+  exit
+end
+
+xml = File.open("greeter.xml") { | f | f.read }
+
+Xampl.transaction("example3") do
+  greeter = Xampl.from_xml_string(xml)
+
+  puts "\nAnd now extend our greetings..."
+  greeter.extend_greetings
+end

data/docs/intro/example3/grab-yuml.rb

@@ -0,0 +1,10 @@
+
+diagram = ""
+File.open("./generated.yuml") do | f |
+  f.each do | line |
+    diagram << line.chomp
+  end
+end
+wget = "wget 'http://yuml.me/diagram/scruffy/class/#{diagram}' -O 'generated.png'"
+#wget = "wget 'http://yuml.me/diagram/scruffy/class/#{diagram}.pdf' -O 'generated.pdf'"
+`#{wget}`

data/docs/intro/example3/greeter.rb

@@ -0,0 +1,15 @@
+require 'xampl_generated_code/Example3.rb'
+
+module Example3
+  class Greeter
+    def extend_greetings
+      who.each do | who |
+        if who.name then
+          puts greeting['has-name'].extend_greeting(who.name)
+        else
+          puts greeting['no-name'].extend_greeting
+        end
+      end
+    end
+  end
+end

data/docs/intro/example3/greeting.rb

@@ -0,0 +1,9 @@
+require 'xampl_generated_code/Example3.rb'
+
+module Example3
+  class Greeting
+    def extend_greeting(name=nil)
+      content.gsub(/\$\$\$/){ name }
+    end
+  end
+end

data/docs/intro/example3/project-generator.rb

@@ -0,0 +1,25 @@
+class ProjectGenerator
+
+  def print_options
+    # return an array containing any (or none) of:
+    #    :schema    -- a schema-like xml representation of the generated code
+    #    :graphml   -- a graphml file describing the class model (compatible with yEd)
+    #    :yuml      -- a yuml file that represents a simplified class model (compatible with yUML)
+
+    [ :yuml ]
+  end
+
+  def resolve_namespaces
+    # any array of arrays
+    # each sub-array:
+    #    0: a string or an array of strings, containing xml namespaces found
+    #       in the example xml files an empty string is the default namespace
+    #    1: a ruby Module name (get the character cases right)
+    #    2: a namespace prefix used when writing xml, optional. A generated
+    #       prefix will be used otherwise.
+
+    [
+            [ 'com.xampl.intro.example3', 'Example3', 'ex3']
+    ]
+  end
+end

data/docs/intro/example3/xml/greeter.xml

@@ -0,0 +1,6 @@
+<greeter xmlns='com.xampl.intro.example3'>
+    <greeting id='greeting name'>
+        Hello $$$, how are you?
+    </greeting>
+    <who name='world'/>
+</greeter>

data/docs/intro/example4/example4.rb

@@ -0,0 +1,27 @@
+require 'greeter'
+require 'greeting'
+
+##include Example3 -- nope, not this time
+
+Xampl.transaction("example3") do
+  greeter = Example3::Greeter.new
+
+  greeting1 = Example3::Greeting.new('has-name')
+  greeting1.content = "Hello $$$, how are you?"
+  greeter << greeting1
+
+  greeter.new_who.name = 'world'
+  greeter.new_who.name = 'there'
+
+  greeting2 = greeter.new_greeting('no-name')
+  greeting2.content = "Hello hello? Someone there?"
+
+  greeter.new_who
+
+  puts greeter.to_xml
+  puts greeter.pp_xml
+
+  puts "\nAnd now extend our greetings..."
+
+  greeter.extend_greetings
+end

data/docs/intro/example4/example4a.rb

@@ -0,0 +1,19 @@
+require 'greeter'
+require 'greeting'
+
+xml = <<EOX
+<ex3:greeter xmlns:ex3='com.xampl.intro.example3'>
+  <ex3:greeting id='has-name'>Hello $$$, how are you?</ex3:greeting>
+  <ex3:who name='world'/>
+  <ex3:who name='there'/>
+  <ex3:greeting id='no-name'>Hello hello? Someone there?</ex3:greeting>
+  <ex3:who/></ex3:greeter>
+EOX
+
+Xampl.transaction("example3") do
+  greeter = Xampl.from_xml_string(xml)
+  puts greeter.pp_xml
+
+  puts "\nAnd now extend our greetings..."
+  greeter.extend_greetings
+end

data/docs/intro/example4/grab-yuml.rb

@@ -0,0 +1,10 @@
+
+diagram = ""
+File.open("./generated.yuml") do | f |
+  f.each do | line |
+    diagram << line.chomp
+  end
+end
+wget = "wget 'http://yuml.me/diagram/scruffy/class/#{diagram}' -O 'generated.png'"
+#wget = "wget 'http://yuml.me/diagram/scruffy/class/#{diagram}.pdf' -O 'generated.pdf'"
+`#{wget}`

data/docs/intro/example4/greeter.rb

@@ -0,0 +1,15 @@
+require 'xampl_generated_code/Example3.rb'
+
+module Example3
+  class Greeter
+    def extend_greetings
+      who.each do | who |
+        if who.name then
+          puts greeting['has-name'].extend_greeting(who.name)
+        else
+          puts greeting['no-name'].extend_greeting
+        end
+      end
+    end
+  end
+end

data/docs/intro/example4/greeting.rb

@@ -0,0 +1,9 @@
+require 'xampl_generated_code/Example3.rb'
+
+module Example3
+  class Greeting
+    def extend_greeting(name=nil)
+      name ? content.gsub(/\$\$\$/){ name } : ''
+    end
+  end
+end

data/docs/intro/example4/project-generator.rb

@@ -0,0 +1,25 @@
+class ProjectGenerator
+
+  def print_options
+    # return an array containing any (or none) of:
+    #    :schema    -- a schema-like xml representation of the generated code
+    #    :graphml   -- a graphml file describing the class model (compatible with yEd)
+    #    :yuml      -- a yuml file that represents a simplified class model (compatible with yUML)
+
+    [ :yuml ]
+  end
+
+  def resolve_namespaces
+    # any array of arrays
+    # each sub-array:
+    #    0: a string or an array of strings, containing xml namespaces found
+    #       in the example xml files an empty string is the default namespace
+    #    1: a ruby Module name (get the character cases right)
+    #    2: a namespace prefix used when writing xml, optional. A generated
+    #       prefix will be used otherwise.
+
+    [
+            [ 'com.xampl.intro.example3', 'Example3', 'ex3']
+    ]
+  end
+end

data/docs/intro/example4/xml/greeter.xml

@@ -0,0 +1,6 @@
+<greeter xmlns='com.xampl.intro.example3'>
+    <greeting id='greeting name'>
+        Hello $$$, how are you?
+    </greeting>
+    <who name='world'/>
+</greeter>

data/docs/intro/grab-yuml.rb

@@ -0,0 +1,10 @@
+
+diagram = ""
+File.open("./generated-elements.yuml") do | f |
+  f.each do | line |
+    diagram << line.chomp
+  end
+end
+wget = "wget 'http://yuml.me/diagram/scruffy/class/#{diagram}' -O 'generated-elements.png'"
+#wget = "wget 'http://yuml.me/diagram/scruffy/class/#{diagram}.pdf' -O 'generated-elements.pdf'"
+`#{wget}`

data/docs/intro/project-generator.rb

@@ -0,0 +1,51 @@
+class ProjectGenerator
+
+#  def directory
+#    File.join(%w{ . xampl_generated_code })
+#  end
+#
+#  def filenames
+#    Dir.glob("./xml/**/*.xml")
+#  end
+#
+#  def print_base_filename
+#    File.join(%w{ . generated })
+#  end
+#
+#  def print_options
+#    # return an array containing any (or none) of:
+#    #    :schema    -- a schema-like xml representation of the generated code
+#    #    :graphml   -- a graphml file describing the class model (compatible with yEd)
+#    #    :yuml      -- a yuml file that represents a simplified class model (compatible with yUML)
+#
+#    # [:schema, :graphml, :yuml]
+#    []
+#  end
+#
+#  def persisted_attributes
+#    %w{ pid }
+#  end
+#
+#  def indexed_attributes
+#    %w{ id }
+#  end
+
+  def resolve_namespaces
+    # any array of arrays
+    # each sub-array:
+    #    0: a string or an array of strings, containing xml namespaces found in the example xml files
+    #       an empty string is the default namespace
+    #    1: a ruby Module name (get the character cases right)
+    #    2: a namespace prefix used when writing xml, optional. A generated prefix will be used otherwise.
+
+    #[]
+
+    [
+            [ '', 'Example1']
+    ]
+
+
+  end
+
+end
+