Contents

module Turntables
# @author Simon Symeonidis  
# @date   Wed Jul 10 19:51:42 EDT 2013
# This class takes care of a single transaction
class Transaction

  # Initialize this object with the contents of the sql file
  # @param sql_file_contents are the contents of the given sql file
  # @param filename is the filename of the given sql file. We use the filenames
  #   for the version that it is supposed to upgrade to.
  def initialize(sql_file_contents,filename)
    # Select only the lines that begin with '--$'
    @comment = sql_file_contents.lines.select{|el| el.match(/--\$/)}.join
    @comment.gsub!(/--\$/, '')
    @version = filename.to_i
    @data    = sql_file_contents
  end

  # The version should be obtained from the file name of the respective sql
  # file.
  attr_accessor :version
  
  # The comment should be parsed out from the respective sql file. We want to 
  # keep the comments in the sql file to keep things organized. We do not want
  # to alter the sql language to fit our needs. Therefore we just require the 
  # user to comment lines as '--$ my comment here' in order to parse them out
  # @example How to write comments that are to be parsed
  #   --$ author jon doe
  #   --$ This sql file will update the schema to version 1.2
  #   --$ You should note this and that
  #   -- This commen line would be ignored
  #
  #   CREATE TABLE accounts ( ... ) 
  attr_accessor :comment

  # The sql information to be passed on to the db registry 
  attr_accessor :data
end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
turntables-1.0.3	lib/turntables/transaction.rb
turntables-1.0.1	lib/turntables/transaction.rb