christiank-turntable 0.3.2 → 0.4

data/turntable.rb

@@ -1,14 +1,27 @@
 #
-# turntable v0.3.2
+# turntable v0.4
 # Christian Koch < ckoch002@student.ucr.edu >
 #
 # This is free software. You are permitted to modify, implement, and otherwise
 # use this source code freely (as in beer and freedom).
-# 
+#
+
+class Array
+  # Exchanges two elements' positions within an array.
+  def switch index1, index2
+    old_array = self.dup
+    self[index1] = old_array[index2]
+    self[index2] = old_array[index1]
+  end
+end
 
 class Turntable
+
+  @@version = '0.4'
+  
+  # Creates a new Turntable object and database file.
+  # Requires a filename and at least one column name.
   def initialize filename, *args
-    # there must be at least one column
     raise "Turntable.new requires at least two arguments" if args.empty?
     
     @columns = []
@@ -22,7 +35,7 @@ class Turntable
     self.save_to @filename
   end
   
-  # Turntable.load: loads the file and Marshals back the data
+  # Loads an external database file and returns the Turntable object.
   def Turntable.load filename
     raise "#{filename}: file does not exist" unless File.exists?(filename)
     
@@ -32,9 +45,17 @@ class Turntable
     f.close
   end
   
+  # Returns the version number.
+  def Turntable.version
+    @@version
+  end
+  
+  # Reader methods for the object's columns and filename.
   attr_reader :columns
   attr_reader :filename
   
+  # Deletes a row as dictated by a hash {:id => some_value}.
+  # TODO: make sure it returns the deleted row(s).
   def delete hash
     raise 'delete() requires :id => some_value' unless hash.has_key?(:id)
     
@@ -42,16 +63,16 @@ class Turntable
     self.save_to @filename
   end
   
+  # Inserts a new row in the database. It requires that the number of arguments
+  # passed in equal the number of columns, just like any SQL INSERT.
+  # Columns named :id function like AUTOINCREMENT fields.
   def insert *args
-    # the number of arguments must match the number of columns
     unless args.length == @columns.length
       raise "wrong number of arguments (#{args.length} for #{@columns.length})"
     end
     
     row = {}
     
-    # columns named :id are like AUTOINCREMENT fields,
-    # every other column is type-independent
     @columns.each do |column_name|
       if column_name == :id
         if @table.empty?
@@ -66,19 +87,18 @@ class Turntable
       end
     end
     
-    # insert the data here:
     @table.push row
     self.save_to @filename
-    
     return row
   end
   
-  # inspect: this makes dealing with Turntable in IRB much easier
+  # Customize inspect() so dealing with Turntable in IRB is much cleaner.
   def inspect
     self.to_s
   end
   
-  # puts_formatted: prints a "plain text" table
+  # Print a "plain text" table to STDOUT
+  # TODO: create a table.each.columns.each protected method, or something
   def puts_formatted
     @table.each do |row|
       @columns.each do |column|
@@ -90,7 +110,8 @@ class Turntable
     return nil
   end
   
-  # select: equivalent to SELECT * WHERE statements
+  # Returns a subset of the table which satisfies given conditions.
+  # TODO: make sure it actually works 
   def select hash
     result_set = []
     
@@ -105,12 +126,12 @@ class Turntable
     return result_set
   end
 
+  # Returns the entire table, an array of hashes.
   def select_all
     return @table
   end
   
-  # update: replace many columns at a time, 
-  # but only on one row at a time
+  # Replaces many columns at a time, but currently only on one row at a time.
   def update hash
     raise 'update() requires at least :id => some_value' unless hash.has_key?(:id)
     
@@ -125,8 +146,47 @@ class Turntable
     return @table[id]
   end
   
+  # Rearranges the entire database by a specified column
+  def order_by column_name
+    unless @columns.include?(column_name)
+      raise "column \"#{column_name}\" is not declared in this Turntable"
+    end
+    
+    # convert all row-hashes into arrays
+    rearranged_table = @table.collect { |row| row.to_a }
+    
+    # convert all column-name-symbols into strings
+    rearranged_table.each do |row|
+      row.each do |column| 
+        column[0] = column[0].to_s if (column[0].class == Symbol)
+      end
+    end
+    
+    # switch the first element of each row with the desired order_by column
+    # (the first element is where sort() looks)
+    rearranged_table.each do |row|
+      row.switch 0, ( row.index(row.assoc(column_name.to_s)) )
+    end
+    
+    # properly arrange the table
+    rearranged_table.sort!
+    
+    # convert everything back to hashes and symbols
+    rearranged_table.collect do |row|
+      this_row_hash = {}
+      this_column_hash = {}
+          
+      row.each do |column|
+        column[0] = column[0].to_sym
+        this_column_hash[ column[0] ] = column[1]
+      end
+      
+      this_row_hash.update this_column_hash
+    end
+  end
+  
   protected
-    # save_to: marshals in the Turntable object
+    # Marshals the database object to an external file. 
     def save_to filename
       if File.exists? filename
         f = File.open filename, 'w'
@@ -137,4 +197,4 @@ class Turntable
       Marshal.dump self, f
       f.close
     end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: christiank-turntable
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: "0.4"
 platform: ruby
 authors: 
 - Christian Koch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-21 00:00:00 -07:00
+date: 2009-05-22 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -48,6 +48,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Turntable is an alternative to relational databases for Ruby applications.
+summary: Turntable is an alternative to relational databases for Ruby.
 test_files: []