turntables 1.0.1

data/lib/turntables/version_history.rb

@@ -0,0 +1,90 @@
+require 'turntables/db_registry'
+require 'turntables/sql_modules/version_history_sql'
+
+module Turntables
+# @author Simon Symeonidis
+# This class is responsiblef for checking what version the current system is
+# that is using this library, and what is the maximum version available in the
+# repository. Naturally it follows that if in the repository the version is 
+# greater than the one on the system currently, The updated must be triggered
+# to be done.
+# For now this is a halfly implemented active record, since this library is 
+# lightweight and small (therefore not too many components are needed yet).
+class VersionHistory
+  include VersionHistorySql
+
+  # Create the version history object by giving version number and comment.
+  # The date can be omitted, and it will be set to the current time of the
+  # local system.
+  # @param version is the version of the transaction that was performed
+  # @param comment was any comments included in the sql file 
+  # @param date is the optional date, set to the local time if unspecified
+  def initialize(version,comment,date=Time.now.to_i)
+    @version = version
+    @comment = comment
+    @date    = date
+  end
+
+  # Check if the required database exists. Check to see if the database has
+  # the version_histories table as well.
+  def self.check
+    if DbRegistry.instance.table_exists? TableName
+      return VersionHistory.find_last
+    else # db does not exist
+      return :fresh
+    end
+  end
+
+  # Get all the stored version histories
+  def self.find_all
+    vhs = Array.new
+    DbRegistry.instance.execute(SelectAll).each do |row|
+      vhs.push VersionHistory.to_version_history(row)
+    end
+    vhs
+  end
+
+  # Find the last version history added by checking the max id
+  # @return VersionHistory object or nil
+  def self.find_last
+    ret = DbRegistry.instance.execute(SelectLast)
+    VersionHistory.to_version_history(ret.first)
+  end
+
+  # Find a version history record by id
+  # @return VersionHistory object or nil
+  def self.find(id)
+    ret = DbRegistry.instance.execute(SelectById, id)
+    VersionHistory.to_version_history(ret.first)
+  end
+
+  # Insert a row into the table for version histories
+  # @return insert result
+  def self.insert(vhistory)
+    DbRegistry.instance.execute(Insert, vhistory.version, 
+                                vhistory.date, vhistory.comment)
+  end
+
+  # Create the table of this model
+  # @return nil
+  def self.pull_up!
+    DbRegistry.instance.execute(Create)
+  end
+
+  # Make an array representing the persisted object, into an object in memory
+  # @param record an array containing the elements to construct a version history
+  # @return a VersionHistory object constructed from the records
+  def self.to_version_history(record)
+    vh = VersionHistory.new(record[1], record[2], record[3])
+    vh.id = record[0]
+    vh
+  end
+
+  attr_accessor :id
+  attr_accessor :version
+  attr_accessor :date
+  attr_accessor :comment
+
+end
+end
+

data/lib/turntables.rb

@@ -0,0 +1,2 @@
+require 'turntables/version'
+require 'turntables/turntable'

data/spec/data/malformed-dir/malformed.txt

@@ -0,0 +1 @@
+malformed dir to make sure safe execution of turntables

data/spec/data/sql-just-monolithic/mono/1.sql

@@ -0,0 +1,6 @@
+--$ Simple account table
+CREATE TABLE accounts (
+  id integer primary key autoincrement, 
+  balance float, 
+  name text
+);

data/spec/data/sql-just-sequential/seq/1.sql

@@ -0,0 +1,6 @@
+--$ first we create the accounts
+create table accounts (
+  id integer primary key autoincrement,
+  balance float, 
+  name text
+);

data/spec/data/sql-just-sequential/seq/2.sql

@@ -0,0 +1,7 @@
+--$ Add users to the system
+create table users (
+  id integer primary key autoincrement, 
+  name text,
+  email text,
+  bio text
+);

data/spec/data/sql-just-sequential/seq/3.sql

@@ -0,0 +1,9 @@
+--$ Add randomness
+
+create table randomness (
+  id integer primary key autoincrement, 
+  name text,
+  surname text,
+  weight float,
+  is_superhero boolean
+);

data/spec/data/sql-seq-and-mono/mono/3.sql

@@ -0,0 +1,24 @@
+--$ the other files should be ignored, and this should be the only one that is
+--$ executed
+
+create table accounts (
+  id integer primary key autoincrement,
+  balance float, 
+  name text
+);
+
+create table users (
+  id integer primary key autoincrement, 
+  name text,
+  email text,
+  bio text
+);
+
+create table randomness (
+  id integer primary key autoincrement, 
+  name text,
+  surname text,
+  weight float,
+  is_superhero boolean
+);
+

data/spec/data/sql-seq-and-mono/seq/1.sql

@@ -0,0 +1,6 @@
+--$ first we create the accounts
+create table accounts (
+  id integer primary key autoincrement,
+  balance float, 
+  name text
+);

data/spec/data/sql-seq-and-mono/seq/2.sql

@@ -0,0 +1,7 @@
+--$ Add users to the system
+create table users (
+  id integer primary key autoincrement, 
+  name text,
+  email text,
+  bio text
+);

data/spec/data/sql-seq-and-mono/seq/3.sql

@@ -0,0 +1,9 @@
+--$ Add randomness
+
+create table randomness (
+  id integer primary key autoincrement, 
+  name text,
+  surname text,
+  weight float,
+  is_superhero boolean
+);

data/spec/db_registry_sql_spec.rb

@@ -0,0 +1,9 @@
+require 'turntables/sql_modules/db_registry_sql'
+
+include Turntables
+
+describe DbRegistrySql do
+  it "Should have a constant ExistsSql" do
+    subject.const_get('ExistsSql').should_not be_empty
+  end
+end

data/spec/repository_constants_spec.rb

@@ -0,0 +1,13 @@
+require 'turntables/constants/repository_constants'
+
+include Turntables
+
+describe RepositoryConstants do
+  it "Should have SeqDir constant" do
+    subject.const_get('SeqDir').should_not be_empty
+  end
+
+  it "Should have MonoDir constant" do
+    subject.const_get('MonoDir').should_not be_empty
+  end
+end

data/spec/repository_spec.rb

@@ -0,0 +1,39 @@
+require 'turntables/repository'
+
+include Turntables
+
+describe Repository do 
+
+  before :each do 
+    @repo = Repository.new
+  end
+
+  it "#new should return Repository Object" do 
+    @repo.should be_instance_of Repository
+  end
+
+  it "Should have a method called register" do 
+    @repo.should respond_to(:register)
+  end
+
+  it "Should have a method called make!" do 
+    @repo.should respond_to(:make!)
+  end
+
+  it "Should have an attribute called sequential_dir" do
+    @repo.should respond_to(:sequential_dir)
+  end
+
+  it "Should have an attribute called monolithic_dir" do
+    @repo.should respond_to(:monolithic_dir)
+  end
+
+  it "Should have an attribute called relative_dir" do
+    @repo.should respond_to(:relative_dir)
+  end
+
+  it "should have the transactions in a sorted order (smallest to biggest)" do
+    @repo.register("data/sql-just-sequential")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'turntables/version'
+
+include Turntables

data/spec/turntable_exception_spec.rb

@@ -0,0 +1,16 @@
+require 'turntables/turntable_exception'
+
+describe TurntableException do 
+
+  before(:each) do
+    @te = TurntableException.new
+  end
+
+  it "Should be an instance of runtime error" do
+    @te.should be_a_kind_of(RuntimeError)
+  end
+
+  it "should be an instance of TurntableException" do
+    @te.should be_an_instance_of(TurntableException)
+  end
+end

data/spec/turntable_spec.rb

@@ -0,0 +1,71 @@
+require 'turntables'
+require 'turntables/db_registry'
+
+# This test to see if simple operations work with the application (so that the
+# minimal guarantee of the gem is respected - to at least create the schema
+# specified).
+describe Turntable do
+
+  def delete_db
+    if File.exists? "default.db"
+      File.delete("default.db")
+    end
+  end
+
+  before(:each) do
+    @turntable = Turntable.new
+    @relpath   = File.expand_path(File.dirname(__FILE__))
+    @datapath  = "#{@relpath}/data"
+   
+    # datapath/ and 
+    #   malformed-dir
+    #   sql-just-monolithic
+    #   sql-just-sequential
+    #   sql-seq-and-mono
+  end
+
+  after(:each) do 
+    DbRegistry.instance.close!
+    delete_db
+    DbRegistry.instance.open!
+  end
+
+  after(:all) do
+    delete_db
+  end
+
+  it "should raise no errors on a pure sequential repo" do
+    @turntable.register("#{@datapath}/sql-just-sequential")
+    expect{@turntable.make!}.to_not raise_error
+  end
+
+  it "should raise no errors on a pure monolithic repo" do
+    @turntable.register("#{@datapath}/sql-just-monolithic")
+    expect{@turntable.make!}.to_not raise_error
+  end
+
+  it "should raise no errors on a mixed repo" do
+    @turntable.register("#{@datapath}/sql-seq-and-mono")
+    expect{@turntable.make!}.to_not raise_error
+  end
+
+  it "should raise an error on a malformed dir" do
+    @turntable.register("#{@datapath}/malformed-dir")
+    expect{@turntable.make!}.to raise_error
+  end
+
+  it "should raise an error on non existant path" do
+    @turntable.register("WARGABLLGABHLGABL")
+    expect{@turntable.make!}.to raise_error
+  end
+
+  it "should create the database at a *specified* location" do
+    db_location = "#{@datapath}/locations/herp.db"
+    @turntable.register("#{@datapath}/sql-seq-and-mono")
+    @turntable.make_at!(db_location)
+    (File.exists? db_location).should be_true
+    File.delete(db_location)
+  end
+
+end
+

data/spec/turntables_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'turntables'
+
+describe Turntables do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+end

data/spec/version_history_spec.rb

@@ -0,0 +1,55 @@
+require 'turntables/version_history'
+
+describe VersionHistory do 
+  context "<<AR>> pattern specification" do
+    it "should respond to class method check" do
+      VersionHistory.should respond_to(:check)
+    end
+
+    it "should respond to class method find_all" do
+      VersionHistory.should respond_to(:find_all)
+    end
+
+    it "should respond to class method find_last" do
+      VersionHistory.should respond_to(:find_last)
+    end
+
+    it "should respond to class method find" do
+      VersionHistory.should respond_to(:find)
+    end
+
+    it "should respond to class method insert" do
+      VersionHistory.should respond_to(:insert)
+    end
+
+    it "should respond to class method pull_up!" do
+      VersionHistory.should respond_to(:pull_up!)
+    end
+    
+    it "should respond to class method to_version_history" do
+      VersionHistory.should respond_to(:to_version_history)
+    end
+  end
+
+  context "Attributes" do
+    before(:each) do
+      @version_history = VersionHistory.new(1,"asdf")
+    end
+
+    it "should have an id" do 
+      @version_history.should respond_to(:id)
+    end
+
+    it "should have a version" do
+      @version_history.should respond_to(:version)
+    end
+
+    it "should have a date" do 
+      @version_history.should respond_to(:date)
+    end
+
+    it "should have a comment" do
+      @version_history.should respond_to(:comment)
+    end
+  end
+end

data/spec/version_history_sql_spec.rb

@@ -0,0 +1,31 @@
+require 'turntables/sql_modules/version_history_sql'
+
+include Turntables
+
+describe VersionHistorySql do
+
+  it "should have a table name constant" do
+    subject.const_get('TableName').should_not be_empty
+  end
+
+  it "should have a create sql constant" do
+    subject.const_get('Create').should_not be_empty
+  end
+
+  it "should have a select last sql constant" do
+    subject.const_get('SelectLast').should_not be_empty
+  end 
+
+  it "should have a select by id sql constant" do
+    subject.const_get('SelectById').should_not be_empty
+  end
+
+  it "should have a select all sql constant" do
+    subject.const_get('SelectAll').should_not be_empty
+  end
+
+  it "should have an insert sql constant" do
+    subject.const_get('Insert').should_not be_empty
+  end
+end
+

data/turntables.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/turntables/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "turntables"
+  gem.version       = Turntables::VERSION
+  gem.summary       = %q{A dumb experimental, lightweight db version control system for SQLite3}
+  gem.description   = %q{A dumb experimental, lightweight db version control system for SQLite3}
+  gem.license       = "MIT"
+  gem.authors       = ["psyomn"]
+  gem.email         = "lethaljellybean@gmail.com"
+  gem.homepage      = "https://rubygems.org/gems/turntables"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'yard', '~> 0.8'
+
+  gem.add_runtime_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: turntables
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- psyomn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A dumb experimental, lightweight db version control system for SQLite3
+email: lethaljellybean@gmail.com
+executables:
+- turntables
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- ChangeLog.rdoc
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/turntables
+- lib/turntables.rb
+- lib/turntables/constants/repository_constants.rb
+- lib/turntables/db_registry.rb
+- lib/turntables/repository.rb
+- lib/turntables/sql_modules/db_registry_sql.rb
+- lib/turntables/sql_modules/version_history_sql.rb
+- lib/turntables/transaction.rb
+- lib/turntables/turntable.rb
+- lib/turntables/turntable_exception.rb
+- lib/turntables/version.rb
+- lib/turntables/version_history.rb
+- spec/data/locations/.gitkeep
+- spec/data/locations/herp.db
+- spec/data/locations/loc1/.gitkeep
+- spec/data/malformed-dir/malformed.txt
+- spec/data/sql-just-monolithic/mono/1.sql
+- spec/data/sql-just-monolithic/seq/.gitkeep
+- spec/data/sql-just-sequential/mono/.gitkeep
+- spec/data/sql-just-sequential/seq/1.sql
+- spec/data/sql-just-sequential/seq/2.sql
+- spec/data/sql-just-sequential/seq/3.sql
+- spec/data/sql-seq-and-mono/mono/3.sql
+- spec/data/sql-seq-and-mono/seq/1.sql
+- spec/data/sql-seq-and-mono/seq/2.sql
+- spec/data/sql-seq-and-mono/seq/3.sql
+- spec/db_registry_sql_spec.rb
+- spec/repository_constants_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb
+- spec/turntable_exception_spec.rb
+- spec/turntable_spec.rb
+- spec/turntables_spec.rb
+- spec/version_history_spec.rb
+- spec/version_history_sql_spec.rb
+- turntables.gemspec
+homepage: https://rubygems.org/gems/turntables
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A dumb experimental, lightweight db version control system for SQLite3
+test_files:
+- spec/data/locations/.gitkeep
+- spec/data/locations/herp.db
+- spec/data/locations/loc1/.gitkeep
+- spec/data/malformed-dir/malformed.txt
+- spec/data/sql-just-monolithic/mono/1.sql
+- spec/data/sql-just-monolithic/seq/.gitkeep
+- spec/data/sql-just-sequential/mono/.gitkeep
+- spec/data/sql-just-sequential/seq/1.sql
+- spec/data/sql-just-sequential/seq/2.sql
+- spec/data/sql-just-sequential/seq/3.sql
+- spec/data/sql-seq-and-mono/mono/3.sql
+- spec/data/sql-seq-and-mono/seq/1.sql
+- spec/data/sql-seq-and-mono/seq/2.sql
+- spec/data/sql-seq-and-mono/seq/3.sql
+- spec/db_registry_sql_spec.rb
+- spec/repository_constants_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb
+- spec/turntable_exception_spec.rb
+- spec/turntable_spec.rb
+- spec/turntables_spec.rb
+- spec/version_history_spec.rb
+- spec/version_history_sql_spec.rb
+has_rdoc: