spqr 0.1.0 → 0.1.1

data/CHANGES

@@ -1,3 +1,19 @@
+version 0.1.1
+
+*  Other minor Rhubarb fixes.
+
+*  Rhubarb now properly handles persisting classes declared in
+   different modules and supports defining custom table names.
+
+*  spqr-gen now has preliminary support for generating classes that
+   persist via rhubarb.
+
+*  Fixes and cleanups to class- and package-name metadata.  Previously,
+   the app skeleton would fail to find some manageable classes
+   declared in separate Ruby modules.  In addition, the manageable
+   mixin now sets sensible default names for the QMF class and package
+   (when one is not provided within the class declaration).
+
 version 0.1.0 (3a3ca52c4f086d1f20fdf5ed89dda262622c171d)
 
 *  Note that this version breaks backwards compatibility, for reasons

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/bin/spqr-gen.rb

@@ -18,8 +18,8 @@ $: << File.expand_path(File.dirname(__FILE__))
 require 'spqr/spqr'
 
 def main
-  $WRITEMODE
   $OUTDIR = "."
+  $DO_RHUBARB = false
 
   op = OptionParser.new do |opts|
     opts.banner = "Usage spqr.rb [options] schema-file"
@@ -31,6 +31,10 @@ def main
     opts.on("-d", "--output-dir DIR", "directory in which to place generated app and controllers") do |dir|
       $OUTDIR = dir
     end
+
+    opts.on("-r", "--rhubarb", "enable support for rhubarb in generated code") do
+      $DO_RHUBARB = true
+    end
   end
   
   begin

data/lib/rhubarb/rhubarb.rb

@@ -102,10 +102,16 @@ end
 # Methods mixed in to the class object of a persisting class
 module PersistingClassMixins 
   # Returns the name of the database table modeled by this class.
+  # Defaults to the name of the class (sans module names)
   def table_name
-    self.name.downcase  
+    @table_name ||= self.name.split("::").pop.downcase  
   end
   
+  # Enables setting the table name to a custom name
+  def declare_table_name(nm)
+    @table_name = nm
+  end
+
   # Models a foreign-key relationship. +options+ is a hash of options, which include
   # +:column => + _name_::  specifies the name of the column to reference in +klass+ (defaults to row id)
   # +:on_delete => :cascade+:: specifies that deleting the referenced row in +klass+ will delete all rows referencing that row through this reference
@@ -131,7 +137,7 @@ module PersistingClassMixins
     select_criteria = valid_cols.map {|col| "#{col.to_s} = #{col.inspect}"}.join(" AND ")
     arg_hash.each {|k,v| arg_hash[k] = v.row_id if v.respond_to? :row_id}
 
-    Persistence::execute("select * from #{table_name} where #{select_criteria}", arg_hash).map {|tup| self.new(tup) }
+    Persistence::execute("select * from #{table_name} where #{select_criteria} order by row_id", arg_hash).map {|tup| self.new(tup) }
   end
 
   # args contains the following keys
@@ -297,10 +303,17 @@ SELECT __freshest.* FROM (
       # Note that we do not support update triggers, since the API does 
       # not expose the capacity to change row IDs.
       
-      self.creation_callbacks << Proc.new do 
-        Persistence::db.execute_batch("CREATE TRIGGER refint_insert_#{self.table_name}_#{rf.referent.table_name}_#{self.creation_callbacks.size} BEFORE INSERT ON \"#{self.table_name}\" WHEN new.\"#{cname}\" IS NOT NULL AND NOT EXISTS (SELECT 1 FROM \"#{rf.referent.table_name}\" WHERE new.\"#{cname}\" == \"#{rf.column}\") BEGIN SELECT RAISE(ABORT, 'constraint failed'); END;")
+      self.creation_callbacks << Proc.new do   
+        @ccount ||= 0
+
+        insert_trigger_name = "ri_insert_#{self.table_name}_#{@ccount}_#{rf.referent.table_name}"
+        delete_trigger_name = "ri_delete_#{self.table_name}_#{@ccount}_#{rf.referent.table_name}"
         
-        Persistence::db.execute_batch("CREATE TRIGGER refint_delete_#{self.table_name}_#{rf.referent.table_name}_#{self.creation_callbacks.size} BEFORE DELETE ON \"#{rf.referent.table_name}\" WHEN EXISTS (SELECT 1 FROM \"#{self.table_name}\" WHERE old.\"#{rf.column}\" == \"#{cname}\") BEGIN DELETE FROM \"#{self.table_name}\" WHERE \"#{cname}\" = old.\"#{rf.column}\"; END;") if rf.options[:on_delete] == :cascade
+        Persistence::db.execute_batch("CREATE TRIGGER #{insert_trigger_name} BEFORE INSERT ON \"#{self.table_name}\" WHEN new.\"#{cname}\" IS NOT NULL AND NOT EXISTS (SELECT 1 FROM \"#{rf.referent.table_name}\" WHERE new.\"#{cname}\" == \"#{rf.column}\") BEGIN SELECT RAISE(ABORT, 'constraint #{insert_trigger_name} (#{rf.referent.table_name} missing foreign key row) failed'); END;")
+
+        Persistence::db.execute_batch("CREATE TRIGGER #{delete_trigger_name} BEFORE DELETE ON \"#{rf.referent.table_name}\" WHEN EXISTS (SELECT 1 FROM \"#{self.table_name}\" WHERE old.\"#{rf.column}\" == \"#{cname}\") BEGIN DELETE FROM \"#{self.table_name}\" WHERE \"#{cname}\" = old.\"#{rf.column}\"; END;") if rf.options[:on_delete] == :cascade
+
+        @ccount = @ccount + 1
       end
     end
   end

data/lib/spqr/app.rb

@@ -52,14 +52,14 @@ module SPQR
       manageable_ks = ks.select {|kl| manageable? kl}
       unmanageable_ks = ks.select {|kl| not manageable? kl}
       manageable_ks.each do |klass|
-        @log.info("SPQR will manage registered class #{klass} (#{klass.name})...")
+        @log.info("SPQR will manage registered class #{klass} (#{klass.spqr_meta.classname})...")
         
         schemaclass = schematize(klass)
 
         klass.log = @log
 
         @classes_by_id[klass.class_id] = klass
-        @classes_by_name[klass.name] = ClassMeta.new(klass, schemaclass)
+        @classes_by_name[klass.spqr_meta.classname.to_s] = ClassMeta.new(klass, schemaclass)
       end
       
       unmanageable_ks.each do |klass|
@@ -125,6 +125,8 @@ module SPQR
     def get_query(context, query, user_id)
       @log.debug "query: user=#{user_id} context=#{context} class=#{query.class_name} object_num=#{query.object_id.object_num_low if query.object_id} details=#{query} haveSelect=#{query.impl and query.impl.haveSelect} getSelect=#{query.impl and query.impl.getSelect} (#{query.impl and query.impl.getSelect and query.impl.getSelect.methods.inspect})"
 
+      @log.debug "classes_by_name is #{@classes_by_name.inspect}"
+
       cmeta = @classes_by_name[query.class_name]
       objs = []
       
@@ -204,7 +206,7 @@ module SPQR
     end
     
     def schematize(klass)
-      @log.info("Making a QMF schema for #{klass}")
+      @log.info("Making a QMF schema for #{klass.spqr_meta.classname}")
 
       meta = klass.spqr_meta
       package = meta.package.to_s
@@ -290,7 +292,7 @@ module SPQR
     # turns an instance of a managed object into a QmfObject
     def qmfify(obj)
       @log.debug("trying to qmfify #{obj}:  qmf_oid is #{obj.qmf_oid} and class_id is #{obj.class.class_id}")
-      cm = @classes_by_name[obj.class.name]
+      cm = @classes_by_name[obj.class.spqr_meta.classname.to_s]
       return nil unless cm
 
       qmfobj = Qmf::AgentObject.new(cm.schema_class)

data/lib/spqr/codegen.rb

@@ -168,6 +168,7 @@ module SPQR
     private
     def gen_class
       pp "require 'spqr/spqr'"
+      pp "require 'rhubarb/rhubarb'" if $DO_RHUBARB
       pp ""
       
       @package_list.map {|pkg| pkg.capitalize}.each do |modname|
@@ -179,22 +180,25 @@ module SPQR
         pkgname = (@package_list.map {|pkg| pkg.capitalize}).join("::")
         fqcn = ("#{pkgname}::#{@sc.name}" if pkgname) or @sc.name
 
-        pp "include ::SPQR::Manageable"
-        pp ""
-
+        pp "include ::Rhubarb::Persisting" if $DO_RHUBARB
+        pp "include ::SPQR::Manageable\n"
+        
         pp "qmf_package_name '#{@package_list.join(".")}'"
         pp "qmf_class_name '#{@sc.name.split("::")[-1]}'"
 
-        pp '# Find method (NB:  you must implement this)'
-        pp_decl :def, "#{@sc.name}.find_by_id", "(objid)" do
-          pp "#{@sc.name}.new"
-        end
-
-        pp ""
+        unless $DO_RHUBARB
+        
+          pp '# Find method (NB:  you must implement this)'
+          pp_decl :def, "#{@sc.name}.find_by_id", "(objid)" do
+            pp "#{@sc.name}.new"
+          end
 
-        pp '# Find-all method (NB:  you must implement this)'
-        pp_decl :def, "#{@sc.name}.find_all" do
-          pp "[#{@sc.name}.new]"
+          pp ""
+          
+          pp '# Find-all method (NB:  you must implement this)'
+          pp_decl :def, "#{@sc.name}.find_all" do
+            pp "[#{@sc.name}.new]"
+          end
         end
 
         ModelClassGenerator.id_registry[fqcn.hash] = fqcn
@@ -223,19 +227,28 @@ module SPQR
     end
 
     def gen_property(property)
-      pp ""
-      pp "\# property #{property.name} #{property.kind} #{property.desc}"
-      pp_decl :def, "#{property.name}" do
-        pp "log.debug 'Requested property #{property.name}'"
-        pp "nil"
-      end
+      pp "\# property #{property.name} #{property.kind} #{property.desc}\n"
+      
+      rhubarb_kind = qmf_to_rhubarb(property.kind)
 
-      pp ""
-      pp_decl :def, "#{property.name}=", "(val)" do
-        pp "log.debug 'Set property #{property.name} to \#\{val\}'"
-        pp "nil"
+      if $DO_RHUBARB and rhubarb_kind
+        notnull = (", :not_null" if property.options[:index])
+        pp "declare_column :#{property.name}, #{rhubarb_kind}#{notnull}"
+        pp "declare_index_on :#{property.name}" if notnull
+      else
+        pp ""
+        pp_decl :def, "#{property.name}" do
+          pp "log.debug 'Requested property #{property.name}'"
+          pp "nil"
+        end
+        
+        pp ""
+        pp_decl :def, "#{property.name}=", "(val)" do
+          pp "log.debug 'Set property #{property.name} to \#\{val\}'"
+          pp "nil"
+        end
       end
-      
+
       property.options[:desc] = property.desc if property.desc
 
       pp ""
@@ -261,14 +274,10 @@ module SPQR
       pp "\# #{method.name} #{method.desc}"
       method.args.each do |arg|
         pp "\# * #{arg.name} (#{arg.kind}/#{arg.dir})"
-        pp "\# #{arg.desc}"
+        pp "\#   #{arg.desc}" if arg.desc
       end
       
-      in_params = method.args.select {|arg| ['in', 'i', 'qmf::dir_in'].include? arg.dir.to_s.downcase }
-      out_params = method.args.select {|arg| ['out', 'o', 'qmf::dir_out'].include? arg.dir.to_s.downcase }
-      inout_params = method.args.select {|arg| ['inout', 'io', 'qmf::dir_inout'].include? arg.dir.to_s.downcase }
-
-      formals_in = method.args.select {|arg| ['in','i','qmf::dir_in','io','inout','qmf::dir_inout'].include? arg.dir.to_s.downcase}.map{|arg| arg.name}.join(",")
+      formals_in = method.args.select {|arg| ['in','i','qmf::dir_in','io','inout','qmf::dir_inout'].include? arg.dir.to_s.downcase}.map{|arg| arg.name}
       formals_out = method.args.select {|arg| ['out','o','qmf::dir_out','io','inout','qmf::dir_inout'].include? arg.dir.to_s.downcase}.map{|arg| arg.name}
 
       actuals_out = case formals_out.size
@@ -282,40 +291,24 @@ module SPQR
         acc
       end
 
-      pp_decl :def, method.name, "(#{formals_in})" do
+      pp_decl :def, method.name, "(#{formals_in.join(",")})" do
         
-        if in_params.size + inout_params.size > 0  
-          what = "in"
-          
-          if in_params.size > 0 and inout_params.size > 0
-            what << " and in/out"
-          elsif inout_params.size > 0
-            what << "/out"
-          end
-          
-          pp "\# Print values of #{what} parameters"
-          (in_params + inout_params).each do |arg|
-            argdisplay = arg.name.to_s
-            pp('log.debug "' + "#{method.name}: #{arg.name} => " + '#{' + "#{argdisplay}" + '}"')
+        if formals_in.size > 0  
+
+          pp "\# Print values of input parameters"
+          formals_in.each do |arg|
+            pp('log.debug "' + "#{method.name}: #{arg} => " + '#{' + "#{arg}" + '}"')
           end
         end
 
-        if out_params.size + inout_params.size > 0
-          what = "out"
-
-          if out_params.size > 0 and inout_params.size > 0
-            what << " and in/out"
-          elsif inout_params.size > 0
-            what = "in/out"
-          end
+        if formals_out.size > 0
 
-          pp "\# Assign values to #{what} parameters"
+          pp "\# Assign values to output parameters"
 
-          (out_params + inout_params).each do |arg|
-            argdisplay = arg.name.to_s
-            argtype = param_types[argdisplay]
-            raise RuntimeError.new("Can't find type for #{argdisplay} in #{param_types.inspect}") unless argtype
-            pp "#{argdisplay} ||= #{default_val(argtype)}"
+          formals_out.each do |arg|
+            argtype = param_types[arg]
+            raise RuntimeError.new("Can't find type for #{arg} in #{param_types.inspect}") unless argtype
+            pp "#{arg} ||= #{default_val(argtype)}"
           end
 
           pp "\# Return value"
@@ -324,9 +317,12 @@ module SPQR
         end
       end
 
-
       pp ""
       pp_decl :expose, "#{method.name.to_sym.inspect} do |args|" do
+        in_params = method.args.select {|arg| ['in', 'i', 'qmf::dir_in'].include? arg.dir.to_s.downcase }
+        out_params = method.args.select {|arg| ['out', 'o', 'qmf::dir_out'].include? arg.dir.to_s.downcase }
+        inout_params = method.args.select {|arg| ['inout', 'io', 'qmf::dir_inout'].include? arg.dir.to_s.downcase }
+
         {:in => in_params, :inout => inout_params, :out => out_params}.each do |dir,coll|
           coll.each do |arg|
             arg_nm = arg.name
@@ -350,6 +346,17 @@ module SPQR
       else raise RuntimeError.new("Unknown type #{ty.inspect}")
       end
     end
+
+    def qmf_to_rhubarb(ty)
+      case ty.downcase
+        when 'bool' then ':boolean'
+        when 'double', 'float' then ':double'
+        when 'absTime', 'deltaTime' then ':timestamp'
+        when 'int16', 'int32', 'int64', 'int', 'int8', 'uint16', 'uint32', 'uint64', 'uint', 'uint8' then ':integer'
+        when 'lstr', 'string', 'sstr' then ':string'
+      else false
+      end
+    end
   end
 
   class AppBoilerplateGenerator

data/lib/spqr/manageable.rb

@@ -247,7 +247,9 @@ module SPQR
         end
       end
 
-      other.qmf_class_name other.name.to_sym
+      name_components = other.name.to_s.split("::")
+      other.qmf_class_name name_components.pop
+      other.qmf_package_name name_components.join(".").downcase
     end
   end
 end

data/test/helper.rb

@@ -12,7 +12,7 @@ require 'spqr/app'
 require 'rhubarb/rhubarb'
 
 module QmfTestHelpers
-  DEBUG = false
+  DEBUG = (::ENV["SPQR_TESTS_DEBUG"] and ::ENV["SPQR_TESTS_DEBUG"].downcase == "yes")
   
   class AgentNotifyHandler < Qmf::ConsoleHandler
     def initialize

data/test/test_rhubarb.rb

@@ -11,7 +11,6 @@
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0
 
-require 'rubygems'
 require 'rhubarb/rhubarb'
 require 'test/unit'
 
@@ -21,6 +20,21 @@ class TestClass
   declare_column :bar, :string
 end
 
+module RhubarbNamespace
+  class NMTC
+    include Rhubarb::Persisting  
+    declare_column :foo, :integer
+    declare_column :bar, :string
+  end
+
+  class NMTC2
+    include Rhubarb::Persisting  
+    declare_column :foo, :integer
+    declare_column :bar, :string
+    declare_table_name('namespacetestcase')
+  end
+end
+
 class TestClass2 
   include Rhubarb::Persisting  
   declare_column :fred, :integer
@@ -87,6 +101,8 @@ class BackendBasicTests < Test::Unit::TestCase
     klasses << ToRef
     klasses << FromRef
     klasses << FreshTestTable
+    klasses << RhubarbNamespace::NMTC
+    klasses << RhubarbNamespace::NMTC2
 
     klasses.each { |klass| klass.create_table }
 
@@ -110,6 +126,14 @@ class BackendBasicTests < Test::Unit::TestCase
     assert(r.managed_ref?, "managed reference should return true for managed_ref?")
   end
 
+  def test_namespace_table_name
+    assert_equal "nmtc", RhubarbNamespace::NMTC.table_name
+  end
+
+  def test_set_table_name
+    assert_equal "namespacetestcase", RhubarbNamespace::NMTC2.table_name
+  end
+
   def test_reference_ctor_string
     r = Rhubarb::Reference.new("TestClass")
     assert(r.referent == "TestClass", "Referent of string-backed reference instance incorrect")

data/test/test_spqr_integerprop.rb

@@ -18,7 +18,6 @@ class TestSpqrIntegerProp < Test::Unit::TestCase
       expected = objs[(x + 1) % QmfIntegerProp::SIZE]
       o = objs[x]
       next_o = o.next.result
-      puts ("next_o: #{next_o}")
       actual = $console.object(:object_id=>next_o)
       assert_equal expected.int_id, actual.int_id
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spqr
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - William Benton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-08 00:00:00 -06:00
+date: 2009-12-16 00:00:00 -06:00
 default_executable: spqr-gen.rb
 dependencies: 
 - !ruby/object:Gem::Dependency