cauldron 0.1.2 → 0.1.3

data/lib/cauldron/terminal.rb

@@ -9,6 +9,14 @@ module Cauldron
     
     def initialize(output,auto=true)
       @output, @cases, @auto = output, [], auto
+      
+      # Create a logger for the user inputs
+      #file = File.open('user-input.log', File::WRONLY | File::APPEND)
+      file = File.open('user-input.log', 'w+')
+      # To create new (and to remove old) logfile, add File::CREAT like;
+      #   file = open('foo.log', File::WRONLY | File::APPEND | File::CREAT)
+      @user_logger = Logger.new(file)      
+      
     end
     
     def start
@@ -26,21 +34,29 @@ module Cauldron
       @output.puts "input,input,output"
       @output.puts "For example "
       @output.puts "'fish','animal'"
-      @output.puts "'cat','animal'"
       @output.puts "'carrot','vegtable'"
       @output.puts "and when you're done just type RUN"
-      
+
       # Wait for the user's inputs
       unless @auto
         loop do 
           submit gets
         end      
       end
+      
     end
     
     def submit(input)
+      
+      @user_logger.info input
+      
       if input =~ /^RUN$/
-         @output.puts @pot.brew(@cases).reset_ids!.basic_write
+        @output.puts @pot.brew(@cases).reset_ids!.basic_write
+      elsif input =~ /^QUIT$/
+        # => TODO Include 'bye' output too
+        #Process.exit!(true)
+        at_exit {0}
+        exit
       else
         @cases << convert_to_example(separate_values(input))
       end

data/lib/cauldron/util/home.rb

@@ -0,0 +1,21 @@
+module Cauldron
+  
+  module Util
+  
+    module Home
+      
+      private 
+      
+        # Check that the home directory exists
+        def home
+          realHome = ["HOME", "HOMEPATH"].detect {|h| ENV[h] != nil}
+          if not realHome
+            StandardLogger.instance.warning "Couldn't detect a home directory"
+          end
+          return ENV[realHome]  
+        end      
+      
+    end
+  
+  end
+end

data/lib/cauldron/util/saver.rb

@@ -0,0 +1,45 @@
+module Cauldron::Util::Saver
+  
+  def self.save(obj)
+    dir_path = FileUtils.mkdir(next_directory).first
+   begin 
+      dump_file_path = File.join(dir_path,'dump')
+      dump_file = File.open(dump_file_path,'w+')
+      data = Marshal.dump(obj)
+      dump_file << data
+      return dump_file_path
+    ensure 
+      dump_file.close
+    end
+  end
+  
+  def self.debug_directory
+    # the home directory code is duplicated
+    realHome = ["HOME", "HOMEPATH"].detect {|h| ENV[h] != nil}
+    if not realHome
+      StandardLogger.instance.warning "Couldn't detect a home directory"
+    end
+    return File.join(ENV[realHome],'cauldron','debug')    
+  end   
+  
+  def self.next_directory
+    FileUtils.mkdir(debug_directory) unless File.exists?(debug_directory)
+    highest_integer = 0
+    Dir.glob(File.join(debug_directory,'*')).each do |filename|
+      if filename.match(/(\d+)/)
+        highest_integer = $1.to_i if $1.to_i > highest_integer     
+      end
+    end
+    return File.join(debug_directory,(highest_integer + 1).to_s)
+  end
+  
+  def self.load(id)
+    Dir.glob(File.join(debug_directory,'*')).each do |filename|
+      if m = filename.match(/(\d+)/) and m[0].to_i == id
+        dump_file = File.open(File.join(filename,'dump'),'r')
+        return Marshal.load(dump_file.read)        
+      end
+    end
+  end
+  
+end

data/lib/core/Container.rb

@@ -30,7 +30,7 @@ class Container
 
   def write(tab=0)
     line = '('
-    tab.times {line += "\t" }
+    tab.times {line += "  " }
     @tokens.each do |code|
       line += code.write
       break if code.object_id == @tokens.last.object_id

data/lib/core/runtime_method/ActsAsRuntimeMethod.rb

@@ -91,15 +91,15 @@ module ActsAsRuntimeMethod
     raise StandardError.new('Incorrect use of write ') if params.kind_of?(Fixnum)
       
     line = "\n"    
-    tab.times {|x| line += "\t" }
+    tab.times {|x| line += "  " }
     line += "#\n"
 
     if params.nil?
 
       @usage.each_with_index do |var,i|
       
-        tab.times {|x| line += "\t" }
-        line += "#\t@param\t"
+        tab.times {|x| line += "  " }
+        line += "#  @param  "
         
         # Get a description of the requirements (this can multiple lines)
         line_prefix = ''  
@@ -108,8 +108,8 @@ module ActsAsRuntimeMethod
           line += line_prefix+l
           
           # Assides the first line pre-fix a "#      " to the start
-          (tab-1).times {|x| line += "\t" }
-          line_prefix = "#\t\t\t"
+          (tab-1).times {|x| line += "  " }
+          line_prefix = "#      "
           
         end
         
@@ -118,8 +118,8 @@ module ActsAsRuntimeMethod
     else
       
       params.each_with_index do |var,i|       
-        tab.times {|x| line += "\t" }
-        line += "#\t@param\t"
+        tab.times {|x| line += "  " }
+        line += "#  @param  "
 
         # Get a description of the requirements (this can multiple lines)
         line_prefix = ''
@@ -129,8 +129,8 @@ module ActsAsRuntimeMethod
           line += line_prefix+l
           
           # Assides the first line pre-fix a "#      " to the start
-          (tab-1).times {|x| line += "\t" }
-          line_prefix = "#\t\t\t"
+          (tab-1).times {|x| line += "  " }
+          line_prefix = "#      "
           
         end
         
@@ -140,16 +140,16 @@ module ActsAsRuntimeMethod
     
     # Add some some additional comment if supplied
     unless additional_comments.nil?
-      tab.times {|x| line += "\t" }
+      tab.times {|x| line += "  " }
       line += "#"
-      tab.times {|x| line += "\t" }
+      tab.times {|x| line += "  " }
       line += additional_comments+"\n"
     end    
     
-    tab.times {|x| line += "\t" }
+    tab.times {|x| line += "  " }
     line += "#\n"               
     
-    tab.times {|x| line += "\t"}
+    tab.times {|x| line += "  "}
     line += basic_write(tab)
 
   end
@@ -168,7 +168,7 @@ module ActsAsRuntimeMethod
     end
     
     # Close the method
-    tab.times {|x| line += "\t" }
+    tab.times {|x| line += "  " }
     line += "end"+"\n"
     
     return line    
@@ -185,15 +185,15 @@ module ActsAsRuntimeMethod
     raise StandardError.new('Incorrect use of write ') if params.kind_of?(Fixnum)
       
     line = "\n"    
-    tab.times {|x| line += "\t" }
+    tab.times {|x| line += "  " }
     line += "#\n"
 
     if params.nil?
 
       @usage.each_with_index do |var,i|
       
-        tab.times {|x| line += "\t" }
-        line += "#\t@param\t"
+        tab.times {|x| line += "  " }
+        line += "#  @param  "
         
         # Get a description of the requirements (this can multiple lines)
         line_prefix = ''  
@@ -202,8 +202,8 @@ module ActsAsRuntimeMethod
           line += line_prefix+l
           
           # Assides the first line pre-fix a "#      " to the start
-          (tab-1).times {|x| line += "\t" }
-          line_prefix = "#\t\t\t"
+          (tab-1).times {|x| line += "  " }
+          line_prefix = "#      "
           
         end
         
@@ -212,8 +212,8 @@ module ActsAsRuntimeMethod
     else
       
       params.each_with_index do |var,i|       
-        tab.times {|x| line += "\t" }
-        line += "#\t@param\t"
+        tab.times {|x| line += "  " }
+        line += "#  @param  "
 
         # Get a description of the requirements (this can multiple lines)
         line_prefix = ''
@@ -223,8 +223,8 @@ module ActsAsRuntimeMethod
           line += line_prefix+l
           
           # Assides the first line pre-fix a "#      " to the start
-          (tab-1).times {|x| line += "\t" }
-          line_prefix = "#\t\t\t"
+          (tab-1).times {|x| line += "  " }
+          line_prefix = "#      "
           
         end
         
@@ -234,16 +234,16 @@ module ActsAsRuntimeMethod
     
     # Add some some additional comment if supplied
     unless additional_comments.nil?
-      tab.times {|x| line += "\t" }
+      tab.times {|x| line += "  " }
       line += "#"
-      tab.times {|x| line += "\t" }
+      tab.times {|x| line += "  " }
       line += additional_comments+"\n"
     end    
     
-    tab.times {|x| line += "\t" }
+    tab.times {|x| line += "  " }
     line += "#\n"               
     
-    tab.times {|x| line += "\t"}
+    tab.times {|x| line += "  "}
     line += 'def '+method_name 
     
     #line += write_params(@parameters)
@@ -257,7 +257,7 @@ module ActsAsRuntimeMethod
     line += "\n" if self.empty?
     
     # Close the method
-    tab.times {|x| line += "\t" }
+    tab.times {|x| line += "  " }
     line += "end"+"\n"
     
     return line    

data/lib/core/runtime_method/RuntimeMethod.rb

@@ -1,4 +1,3 @@
-require "set"
 # This class represents the code of a method generated at runitme
 # 
 # This a variation on code set that contains usage and a return 
@@ -68,21 +67,6 @@ class RuntimeMethod < StatementGroup
     @method_id = id
   end
   
-  # Returns a declaration instance for this particular runtime
-  # method.  The declaration doesn't contain any of the internally
-  # generated statements.
-  #
-  # TODO  Write tests on this with more variables and statements
-  #
-  def to_declaration
-    return VariableDeclaration.new(
-      self.class.to_s,
-      @usage.to_declaration,
-      @method_return.to_declaration,
-      *self.collect {|x| x.to_declaration}
-    )  
-  end
-  
   def reset_ids!
     copied_method = copy
     copied_method.method_id = '0'
@@ -391,8 +375,6 @@ class RuntimeMethod < StatementGroup
   # Returns a describtion of the method and the variables
   # within it.
   # 
-  # TODO  Write test for this method
-  #   
   def describe
     line = write+"\n"
     available_variables.each do |var|
@@ -661,7 +643,8 @@ class RuntimeMethod < StatementGroup
       if x.kind_of?(Statement)
         
         # Update the ids of the variables used in the statement to use the ids of the method usage
-        duplicated_statement = x.exchange_variables(id_conversion)
+        #duplicated_statement = x.exchange_variables(id_conversion)
+        duplicated_statement = x.copy
         variable_values = abstract_variables_for_tracking(duplicated_statement)
         copied.push(duplicated_statement)
         copied.push(
@@ -738,13 +721,12 @@ class RuntimeMethod < StatementGroup
   #       array of literal values.
   # 
   def realise2(params,additional_methods=[])
-    
+
     # TEMP
     if(params.any? {|x| x.kind_of?(Variable)})
       raise StandardError.new('Currently only literal values can be realised')
     end
     
-    # TODO  Is KnownVariable a better name than LiteralVariable
     # Convert the passed paramters into literal variables with the appropriate ids
     unless usage.length == params.length  
       raise StandardError.new('This method expects '+usage.length.to_s+' param(s) but '+params.length.to_s+' were passed')
@@ -772,13 +754,14 @@ class RuntimeMethod < StatementGroup
     # Go through each statement and substitue any of the variables
     # for those in the history object
     self.each do |x|
+
       if x.realised?
         realised_runtime_method.push(x)
         next
       end
 
       # Handle nested and single statements differently      
-      if(x.kind_of?(Statement))        
+      if(x.kind_of?(Statement))
         realised_statement = x.realise2(past)
         realised_runtime_method.push(realised_statement)
       elsif(x.kind_of?(BlockStatement))
@@ -811,7 +794,7 @@ class RuntimeMethod < StatementGroup
     
     realised_runtime_method.close
     return realised_runtime_method
-    
+
   end
   
   def cauldron_method_calls

data/lib/core/statement/ActsAsStatement.rb

@@ -3,16 +3,6 @@
 #
 module ActsAsStatement
   
-  # TODO  I think I should start to fade out statement_type - I should start by finding calls where it
-  #       is needed.
-  def statement_type
-    if @statement_type.nil?
-      @statement_type = identify_statement_type
-    end
-    raise UnknownStatementType.new('No statement type has been defined for this statement "'+self.write+'" ['+self.class.to_s+']') if @statement_type.nil?
-    return @statement_type
-  end
-  
   # Returns true if the statement (treated as an array) has all the
   # same classes as the array supplied.
   # 
@@ -25,92 +15,6 @@ module ActsAsStatement
       return false unless x.instance_of?(y)
     end
     return true
-  end    
-  
-protected
-  
-  # Attempts to identify the type of statement this is by its contents.
-  #
-  def identify_statement_type
-    case self.length
-      when 0
-        return StatementStructure::BLANK_STATEMENT     
-      when 1
-        return StatementStructure::IF_STATEMENT if first.kind_of?(If)
-        #return StatementStructure::USAGE_STATEMENT if self.classes_match?(InstanceCallContainer)
-        if self.classes_match?(InstanceCallContainer)
-          if first.method_call.destructive?
-            return StatementStructure::MODIFYING_STATEMENT
-          else
-            return StatementStructure::USAGE_STATEMENT 
-          end
-        end
-        # TODO  Not sure if this should be a usage_statement
-        return StatementStructure::USAGE_STATEMENT if self.classes_match?(DefCall) 
-        
-      when 2
-        return StatementStructure::RETURN_STATEMENT if first.kind_of?(Return)
-      when 3
-        # TODO  This should distinguish between modifying statements e.g. chop! and push
-        # var = var.chop
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,InstanceCallContainer) 
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,ClassMethodCallContainer)         
-        # TODO  Is there a difference between a Literal and a LiteralDeclaration
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,Literal) 
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,StringVariable)         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,ArrayVariable)                 
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,FixnumVariable)         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,StatementVariable)         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,RuntimeMethodParameter)        
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,LiteralDeclaration)
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,NilVariable)
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,DefCall)        
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,Fixnum)        
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,UnknownVariable)                
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(StringVariable,Equal,Literal) 
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(StringVariable,Equal,LiteralDeclaration)         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(StringVariable,Equal,DefCall)                 
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(StringVariable,Equal,ArrayAccess)                         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(FixnumVariable,Equal,InstanceCallContainer)                 
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(FixnumVariable,Equal,Literal)                         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(FixnumVariable,Equal,DefCall)                                 
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(ArrayVariable,Equal,Literal)                                 
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(ArrayVariable,Equal,DefCall)                                         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(StatementVariable,Equal,DefCall)                                         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(VariableContainer,Equal,Literal)            
-        # TODO  I don't know if this should be possible/allowed
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,Unknown)                
-        # TODO  I'm not sure whether ArrayAccess should be USAGE_STATEMENT
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,ArrayAccess)                         
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(StringVariable,Equal,InstanceCallContainer)
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(MethodUsageVariable,Equal,ClassMethodCallContainer)
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(StatementVariable,Equal,ClassMethodCallContainer)        
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(RuntimeMethodParameter,Equal,DefCall)        
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(UnknownVariable,Equal,InstanceCallContainer)        
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(RuntimeMethodParameter,Equal,ClassMethodCallContainer)                
-      when 5
-        if self.classes_match?(Unknown,Equal,Unknown,Addition,Unknown)
-          return StatementStructure::DECLARATION_STATEMENT 
-        end        
-        if self.classes_match?(Unknown,Equal,Unknown,Subtract,Unknown)
-          return StatementStructure::DECLARATION_STATEMENT 
-        end
-        if self.classes_match?(Unknown,Equal,FixnumVariable,Addition,FixnumVariable)
-          return StatementStructure::DECLARATION_STATEMENT 
-        end
-        if self.classes_match?(Unknown,Equal,InstanceCallContainer,Addition,InstanceCallContainer )
-          return StatementStructure::DECLARATION_STATEMENT 
-        end       
-        if self.classes_match?(Unknown,Equal,MethodParameter,Addition,MethodParameter )
-          return StatementStructure::DECLARATION_STATEMENT 
-        end        
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(Unknown,Equal,StringVariable,Addition,StringVariable)        
-        # TODO  I don't know if I want this classed as a declaration statement since it might be replacing the
-        #       value of a variable.
-        return StatementStructure::DECLARATION_STATEMENT if self.classes_match?(FixnumVariable,Equal,FixnumVariable,Addition,FixnumVariable)        
-    end 
-
-    raise StandardError.new('Unable to determine statement type for "'+self.write+'"'+self.inject('') {|x,y| x += y.class.to_s+' : ' })
   end
   
 end