xamplr-gen 1.9.0 → 1.9.2

data/README.md

@@ -2,17 +2,19 @@
 
 xamplr-gen is part of a set of software tools that supports development of ruby applications.
 
-It consists of three gems hosted on gem cutter, source code on
-github.
+It consists of three gems hosted on gemcutter, source code on github.
 
-* xamplr-pp -- this is a pure ruby pull parser
-* xamplr -- this is the xampl runtime
-* xamplr-gen -- this is the code generator
+* [xamplr-pp](http://github.com/hutch/xamplr-pp) -- this is a pure ruby pull parser
+* [xamplr](http://github.com/hutch/xamplr) -- this is the xampl runtime
+* [xamplr-gen](http://github.com/hutch/xamplr-gen) -- this is the code generator
 
 There is an additional fourth github repository containing
 examples and documentation that will be coming soon.
 
-Yes, that means that there's no documentation. And no examples. I agree, this is a very bad situation.
+Yes, that means that there's no documentation. And no examples. I agree,
+this is a very bad situation.
+
+For more information, see [the xampl page on xampl.com](http://xampl.com/so/xampl/), and/or [the weblog 'So.'](http://xampl.com/so/)
 
 ## Installation:
 
@@ -20,6 +22,12 @@ Yes, that means that there's no documentation. And no examples. I agree, this is
 
 This will install all three gems.
 
+NOTE: if you have installed hutch-xamplr or hutch-xamplr-pp then
+you should uninstall them. For some reason, in certain circumstances,
+these might be loaded or partially loaded when trying to use xampl.
+If you don't you'll experience strange exceptions with hutch-xamplr
+or hutch-xamplr-pp on the stack trace.
+
 
 ## License:
 

data/Rakefile

@@ -13,7 +13,7 @@ begin
     gem.add_development_dependency "cucumber", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
 
-    gem.add_dependency('xamplr', '>=1.9.0')
+    gem.add_dependency('xamplr', '>=1.9.1')
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.9.0
+1.9.2

data/bin/xampl-gen

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

data/lib/xamplr-gen/xampl-cl-gen.rb

@@ -1,13 +1,16 @@
-
-#require 'xampl-generator'
+require 'optparse'
 
 include XamplGenerator
 include Xampl
 
 class ProjectGenerator
 
+  def initialize(specialised=true)
+    @specialised = specialised
+  end
+
   def directory
-    File.join(%w{ . xampl_generated_code })
+    File.join(%w{ . xampl-generated-code })
   end
 
   def filenames
@@ -50,14 +53,97 @@ class ProjectGenerator
     []
   end
 
+  @@specialisation_file_content = <<_EOF_
+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 directory
+    # return the path name to the generator's output directory
+    File.join(%w{ . xampl-generated-code })
+  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.
+
+    [
+{{MAPPING}}
+    ]
+  end
+end
+_EOF_
+
+  def write_specialisation_file(element_map)
+    filename = './project-generator.rb'
+    return if File.exists? filename
+
+    mappings = []
+    count = 0
+    element_map.each do | ns, elements |
+      module_name = elements.element.first.package || 'XamplAdHoc'
+      count += 1
+      mappings << [ ns, module_name, "ns#{ count }" ]
+    end
+
+    text =  @@specialisation_file_content.gsub(/{{MAPPING}}/) do 
+      insert = []
+      mappings.each do | ns, module_name, prefix |
+        insert << "            ['#{ ns }', '#{ module_name }', '#{ prefix }'],"
+      end
+      insert.join("\n")
+    end
+
+    File.open(filename, 'w') do | out |
+      out.write text
+    end
+  end
+
   def generate
 
+    cl_options = {}
+    OptionParser.new do |opts|
+      opts.banner = "Usage: junk.rb [options]"
+
+      opts.on("--download-yuml-png [FILENAME]", "Download the yuml png file if possible.") do | filename |
+        cl_options[:download_yuml_png] = filename || true
+      end
+      opts.on("--download-yuml-pdf [FILENAME]", "Download the yuml pdf file if possible.") do | filename |
+        cl_options[:download_yuml_pdf] = filename || true
+      end
+    end.parse!
+
 #      Xampl.set_default_persister_kind(:simple)
     Xampl.set_default_persister_kind(:in_memory)
 #      Xampl.set_default_persister_kind(:filesystem)
 #      Xampl.set_default_persister_kind(:tokyo_cabinet)
 #      Xampl.set_default_persister_format(:xml_format)
 
+    dirname = self.directory
+    if File.directory? dirname then
+      begin
+      FileUtils.rm_rf([ dirname ])
+      rescue => e
+        puts "could not clean up #{ dirname } -- #{ e }"
+        return
+      end
+    elsif File.exists? dirname then
+      puts "please move #{ dirname } out of the way of xampl-gen"
+      return
+    end
+
     Xampl.transaction("project-generation") do
 
       options = Options.new do | opts |
@@ -81,6 +167,72 @@ class ProjectGenerator
                    :directory => directory)
 
       puts generator.print_elements(print_base_filename, print_options)
+      self.write_specialisation_file(generator.elements_map)
+
+      generated_files = Dir.glob("#{ self.directory }/*.rb")
+      if 0 < generated_files.size then
+        all = []
+        abs = []
+        generated_files.each do | filename |
+          all << "require '#{ File.dirname(filename)[2..-1] }/#{  File.basename(filename, '.rb') }'"
+          abs_filename = File.expand_path(filename)
+          abs << "require '#{ File.dirname(abs_filename) }/#{  File.basename(abs_filename, '.rb') }'"
+        end
+
+        out_filename = "#{ self.directory }/all.rb"
+        File.open(out_filename, 'w') do | out |
+          out.puts all.join("\n")
+        end
+        puts "WRITE TO FILE: #{ out_filename }"
+
+        out_filename = "#{ self.directory }/all-absolute.rb"
+        File.open(out_filename, 'w') do | out |
+          out.puts abs.join("\n")
+        end
+        puts "WRITE TO FILE: #{ out_filename }"
+
+        if File.exists?('./generated.yuml') && (cl_options[:download_yuml_png] || cl_options[:download_yuml_pdf]) then
+          diagram = ""
+          File.open("./generated.yuml") do | f |
+            f.each do | line |
+                diagram << line.chomp
+            end
+          end
+
+
+          okay = false
+          if cl_options[:download_yuml_png] then
+            begin
+              filename = (true == cl_options[:download_yuml_png]) ?  'generated.png' : cl_options[:download_yuml_png]
+              wget = "wget 'http://yuml.me/diagram/scruffy/class/#{diagram}' -O '#{filename}'"
+              okay = system(wget)
+              if okay then
+                puts "downloaded yuml png"
+              else
+                puts "could not get the yuml png file -- #{ $? }"
+              end
+            rescue => e
+              puts "could not get the yuml png file -- #{ e }"
+            end
+          end
+
+          if cl_options[:download_yuml_pdf] then
+            begin
+              filename = (true == cl_options[:download_yuml_png]) ?  'generated.png' : cl_options[:download_yuml_png]
+              wget = "wget 'http://yuml.me/diagram/scruffy/class/#{diagram}.pdf' -O '#{filename}'"
+              okay = system(wget)
+              puts "downloaded yuml pdf"
+              if okay then
+                puts "downloaded yuml pdf"
+              else
+                puts "could not get the yuml pdf file -- #{ $? }"
+              end
+            rescue => e
+              puts "could not get the yuml pdf file -- #{ e }"
+            end
+          end
+        end
+      end
 
       Xampl.rollback
     end

data/lib/xamplr-gen/xampl-generator.rb

@@ -278,7 +278,6 @@ module XamplGenerator
         if directory_name then
           output_filename = File.join(directory_name, "#{package_name}.rb")
           puts "WRITE TO FILE: #{output_filename}"
-          #puts package_definition
           File.open(output_filename, "w") do |file|
             file.puts package_definition
           end

data/xamplr-gen.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xamplr-gen}
-  s.version = "1.9.0"
+  s.version = "1.9.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bob Hutchison"]
-  s.date = %q{2009-12-27}
+  s.date = %q{2010-01-13}
   s.default_executable = %q{xampl-gen}
   s.description = %q{This is the xampl code generator for Ruby.}
   s.email = %q{hutch@xampl.com}
@@ -85,14 +85,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<cucumber>, [">= 0"])
-      s.add_runtime_dependency(%q<xamplr>, [">= 1.9.0"])
+      s.add_runtime_dependency(%q<xamplr>, [">= 1.9.1"])
     else
       s.add_dependency(%q<cucumber>, [">= 0"])
-      s.add_dependency(%q<xamplr>, [">= 1.9.0"])
+      s.add_dependency(%q<xamplr>, [">= 1.9.1"])
     end
   else
     s.add_dependency(%q<cucumber>, [">= 0"])
-    s.add_dependency(%q<xamplr>, [">= 1.9.0"])
+    s.add_dependency(%q<xamplr>, [">= 1.9.1"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xamplr-gen
 version: !ruby/object:Gem::Version 
-  version: 1.9.0
+  version: 1.9.2
 platform: ruby
 authors: 
 - Bob Hutchison
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-27 00:00:00 -05:00
+date: 2010-01-13 00:00:00 -05:00
 default_executable: xampl-gen
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.9.0
+        version: 1.9.1
     version: 
 description: This is the xampl code generator for Ruby.
 email: hutch@xampl.com