prick 0.3.0 → 0.8.0

data/lib/ext/fileutils.rb

@@ -7,6 +7,7 @@ module FileUtils
     dir = File.dirname(file)
     File.exist?(dir) or FileUtils.mkdir_p(dir)
     touch(file)
+    file
   end
 
   def self.ln_sr(from, to)
@@ -16,4 +17,10 @@ module FileUtils
     relpath = from.relative_path_from(File.dirname(to))
     Dir.chdir(to_dir) { FileUtils.ln_s(relpath, File.basename(to)) }
   end
+
+  def self.empty!(dir)
+    Dir.chdir(dir) {
+      FileUtils.rm_rf(Dir.children("."))
+    }
+  end
 end

data/lib/prick.rb

@@ -1,17 +1,22 @@
-require "semantic" # Defined here instead of in prick/version.rb to avoid having Gem depend on it
+
+#$LOAD_PATH.unshift("/home/clr/prj/shellopts/lib")
+
+# 'semantic' is required here instead of in prick/version.rb to avoid having Gem depend on it
+require "semantic" 
 
 # Needs to go first because it contains class-level methods that is used by other modules
 require "ext/forward_method.rb"
 
-require "prick/branch.rb"
 require "prick/builder.rb"
 require "prick/migration.rb"
+require "prick/cache.rb"
 require "prick/command.rb"
 require "prick/constants.rb"
 require "prick/database.rb"
 require "prick/diff.rb"
 require "prick/exceptions.rb"
 require "prick/git.rb"
+require "prick/head.rb"
 require "prick/project.rb"
 require "prick/rdbms.rb"
 require "prick/schema.rb"
@@ -22,8 +27,5 @@ require "prick/version.rb"
 require "ext/fileutils.rb"
 require "ext/shortest_path.rb"
 
-require "indented_io"
-
 module Prick
 end
-

data/lib/prick/builder.rb

@@ -24,14 +24,19 @@ module Prick
     attr_reader :database
     attr_reader :directory
     attr_reader :default # either "build" or "migrate"
+    attr_reader :lines
 
     def initialize(database, directory, default)
       @database = database
       @directory = directory
       @default = default
+      @execute = true
+      @lines = []
     end
 
-    def build(subject = nil)
+    def build(subject = default, execute: true)
+      @execute = execute
+      @lines = []
 #     puts "Building #{subject.inspect}"
       Dir.chdir(directory) {
         if subject
@@ -40,6 +45,8 @@ module Prick
           build_directory(".")
         end
       }
+      @lines.reject! { |l| l =~ /^\s*--/ || l =~ /^\s*$/ }
+      self
     end
 
     def self.yml_file(directory) raise NotThis end
@@ -52,13 +59,26 @@ module Prick
 
     def do_sql(path)
 #     puts "do_sql(#{path})"
-      do_dir(path) { |file| Rdbms.exec_file(database.name, file, user: database.user) }
+      do_dir(path) { |file| 
+        if @execute
+          Rdbms.exec_file(database.name, file, user: database.user) 
+        else
+          @lines += IO.readlines(file).map(&:chomp)
+        end
+      }
       true
     end
 
     def do_exe(path)
 #     puts "do_exe(#{path})"
-      do_dir(path) { |file| Command.command "#{file} #{database.name} #{database.user}" } # FIXME Security
+      do_dir(path) { |file| 
+        lines = Command.command "#{file} #{database.name} #{database.user}" # FIXME Security
+        if @execute
+          Rdbms.exec_sql(database.name, lines.join("\n"), database.user)
+        else
+          @lines += lines
+        end
+      }
       true
     end
 
@@ -73,9 +93,9 @@ module Prick
     def build_subject(subject)
       if File.file?(subject) && File.executable?(subject)
         do_exe(subject)
-      elsif subject.end_with?(".yml")
+      elsif File.file?(subject) && subject.end_with?(".yml")
         do_yml(subject)
-      elsif subject.end_with?(".sql")
+      elsif File.file?(subject) && subject.end_with?(".sql")
         do_sql(subject)
       elsif File.exist?(yml_file = "#{subject}.yml")
         do_yml(yml_file)
@@ -90,7 +110,7 @@ module Prick
 
     def build_directory(path)
       Dir.chdir(path) {
-        build_subject(File.join(path, "build")) || begin
+        build_subject(File.join(path, @default)) || begin
           if Dir["#{path}/#{default}", "#{path}/#{default}.yml", "#{path}/#{default}.sql"]
             subjects = [default]
           else
@@ -119,8 +139,10 @@ module Prick
       super(database, directory, "build")
     end
 
-    def build(subject = nil)
+    def build(subject = nil, execute: true)
       if subject
+        @execute = execute
+        @lines = []
         Dir.chdir(directory) {
           if File.executable?(subject)
             do_exe(subject)
@@ -131,8 +153,9 @@ module Prick
           end
         }
       else
-        super()
+        super(execute: execute)
       end
+      self
     end
 
     def self.yml_file(directory) File.join(directory, "build") + ".yml" end

data/lib/prick/cache.rb

@@ -0,0 +1,34 @@
+
+module Prick
+  class Cache
+    def initialize
+    end
+
+    def exist?(version)
+      File.exist?(file(version))
+    end
+
+    def list
+      Dir.glob(File.join(CACHE_DIR, "*.sql.gz"))
+    end
+
+    def load(database, version)
+      Rdbms.load(database, file(version))
+    end
+
+    def save(database, version = database.version)
+      Rdbms.save(database, file(version))
+    end
+
+    # Returns list of removed files
+    def clean
+      l = list
+      FileUtils.rm(l)
+      l
+    end
+
+    def file(version)
+      File.join(CACHE_DIR, "#{version}.sql.gz")
+    end
+  end
+end

data/lib/prick/constants.rb

@@ -2,31 +2,16 @@
 module Prick
   ### DIRECTORIES AND FILE NAMES
 
-  # Path to the .prick-version file
-  PRICK_VERSION_FILE = ".prick-version"
-
-  # State files
-  PROJECT_STATE_FILE = ".prick-project"
-  FEATURES_STATE_FILE = ".prick-features"
-  MIGRATION_STATE_FILE = ".prick-migration"
-  MIGRATIONS_FILE = "migrations.sql"
-
-  # Diff file
-  DIFF_FILE = "diff.sql"
-
   # Shared files (part of the installation)
   SHARE_PATH = "#{File.dirname(File.dirname(__dir__))}/share"
   LIBEXEC_PATH = "#{File.dirname(File.dirname(__dir__))}/libexec"
 
-  STRIP_COMMENTS_COMMAND = File.join(LIBEXEC_PATH, "strip-comments")
-
   # Project directories
   DIRS = [
-    MIGRATIONS_DIR = "migrations",
-    RELEASES_DIR = "releases",
-    SCHEMAS_DIR = "schemas",
-    PRICK_DIR = "#{SCHEMAS_DIR}/prick",
-    PUBLIC_DIR = "#{SCHEMAS_DIR}/public",
+    MIGRATION_DIR = "migration",
+    SCHEMA_DIR = "schema",
+    PRICK_DIR = "#{SCHEMA_DIR}/prick",
+    PUBLIC_DIR = "#{SCHEMA_DIR}/public",
     VAR_DIR = "var",
     CACHE_DIR = "#{VAR_DIR}/cache",
     SPOOL_DIR = "#{VAR_DIR}/spool",
@@ -35,9 +20,42 @@ module Prick
     SPEC_DIR = "spec"
   ]
 
-  # Path to prick data file
-# PRICK_DATA_PATH = File.join(SCHEMAS_DIR, "prick", "data.sql")
-  SCHEMA_VERSION_PATH = File.join(SCHEMAS_DIR, "prick", "data.sql")
+  # The project state file
+  PROJECT_STATE_FILE = ".prick-project"
+  PROJECT_STATE_PATH = PROJECT_STATE_FILE
+
+  # The .prick-version file
+  PRICK_VERSION_FILE = ".prick-version"
+  PRICK_VERSION_PATH = PRICK_VERSION_FILE
+
+  # The prick.versions data file. This is where the Schema saves its version
+  SCHEMA_VERSION_FILE = "data.sql"
+  SCHEMA_VERSION_PATH = File.join(PRICK_DIR, SCHEMA_VERSION_FILE)
+
+  # The the .prick-migration file
+  PRICK_MIGRATION_FILE = ".prick-migration"
+  PRICK_MIGRATION_PATH = File.join(MIGRATION_DIR, PRICK_MIGRATION_FILE)
+
+  # The the .prick-feature file
+  PRICK_FEATURE_FILE = ".prick-feature"
+  PRICK_FEATURE_PATH = File.join(MIGRATION_DIR, PRICK_FEATURE_FILE)
+
+  # The strip-comments executable
+  STRIP_COMMENTS_NAME = "strip-comments"
+  STRIP_COMMENTS_PATH = File.join(LIBEXEC_PATH, "strip-comments")
+
+  # Diff files
+  DIFF_FILE = "diff.sql"
+  BEFORE_TABLES_DIFF_NAME = "diff.before-tables.sql"
+  TABLES_DIFF_NAME = "diff.tables.sql"
+  AFTER_TABLES_DIFF_NAME = "diff.after-tables.sql"
+
+  BEFORE_TABLES_DIFF_PATH = File.join(MIGRATION_DIR, BEFORE_TABLES_DIFF_NAME)
+  TABLES_DIFF_PATH = File.join(MIGRATION_DIR, TABLES_DIFF_NAME)
+  AFTER_TABLES_DIFF_PATH = File.join(MIGRATION_DIR, AFTER_TABLES_DIFF_NAME)
+
+  TABLES_DIFF_SHARE_PATH = File.join(SHARE_PATH, "diff", TABLES_DIFF_NAME)
+
 
   # Dump files
   DUMP_EXT = "dump.gz"
@@ -46,33 +64,27 @@ module Prick
 
   ### REGULAR EXPRESSIONS
 
+  # Matches a system name. System names are used for objects that are external to prick
+  # (like usernames)
+  NAME_SUB_RE = /[a-z][a-z0-9_-]*/
+  NAME_RE = /^#{NAME_SUB_RE}$/
+
   # Matches an identifier. Identifiers consist of lower case letters, digits
   # and underscores but not dashes because they're used as separators
   IDENT_SUB_RE = /[a-z][a-z0-9_]*/
   IDENT_RE = /^#{IDENT_SUB_RE}$/
 
-  # Matches an uppercase identifier
-# UPCASE_IDENT_SUB_RE = /[A-Z][A-Z0-9_]*/
-# UPCASE_IDENT_RE = /#{UPCASE_IDENT_SUB_RE}/
-
-  # A (system) name. Names are used for projects and usernames that are
-  # external to prick and can include both dashes and underscores but dashes
-  # have to be followed by a character and not a digit so 'ident-1234' is not
-  # allowed but 'ident_1234' and 'ident1234' are
-  NAME_SUB_RE = /#{IDENT_SUB_RE}/
-  NAME_RE = /^#{NAME_SUB_RE}$/
-
   # Matches a project name
-  PROJECT_NAME_SUB_RE = NAME_SUB_RE
-  PROJECT_NAME_RE = NAME_RE
+  PROJECT_NAME_SUB_RE = IDENT_SUB_RE
+  PROJECT_NAME_RE = IDENT_RE
 
   # Matches a custom name
-  CUSTOM_NAME_SUB_RE = NAME_SUB_RE
-  CUSTOM_NAME_RE = NAME_RE
+  CUSTOM_NAME_SUB_RE = IDENT_SUB_RE
+  CUSTOM_NAME_RE = IDENT_RE
 
   # Matches a feature name
-  FEATURE_NAME_SUB_RE = NAME_SUB_RE
-  FEATURE_NAME_RE = NAME_RE
+  FEATURE_NAME_SUB_RE = /(?!initial)#{IDENT_SUB_RE}/
+  FEATURE_NAME_RE = /^#{FEATURE_NAME_SUB_RE}$/
 
   # Matches a postgres user name
   USER_NAME_SUB_RE = NAME_SUB_RE
@@ -103,15 +115,48 @@ module Prick
   SEMVER_SUB_RE = /#{MMP_SEMVER_SUB_RE}(?:-#{PRE_SEMVER_SUB_RE})?/
   SEMVER_RE = /^#{SEMVER_SUB_RE}$/
 
-  # Version RE. The general syntax for a version is '<custom>-<version>_<feature>'
+  # Tag RE.  The general syntax for a tag is '<custom>-v<version>_<feature>'
+  #
+  # The RE defines the following captures:
+  #   $1 - custom name, can be nil
+  #   $2 - semantic version
+  #   $3 - feature name, can be nil
+  #
+  TAG_SUB_RE = /
+      (?:(#{CUSTOM_NAME_SUB_RE})-)?
+      v
+      (#{SEMVER_SUB_RE})
+      (?:_(#{FEATURE_NAME_SUB_RE}))?
+  /x
+  TAG_RE = /^#{TAG_SUB_RE}$/
+
+  # TODO: Handle initial branches (0.0.0-initial)
+
+  # Branch RE. The general syntax for a branch is '<custom>-<version>_<feature>'
   #
   # The RE defines the following captures:
   #   $1 - custom name, can be nil
   #   $2 - semantic version
   #   $3 - feature name, can be nil
   #
+  BRANCH_SUB_RE = /
+      (?:(#{CUSTOM_NAME_SUB_RE})-)?
+      (#{SEMVER_SUB_RE})
+      (?:_(#{FEATURE_NAME_SUB_RE}))?
+  /x
+  BRANCH_RE = /^#{BRANCH_SUB_RE}$/
+
+  # Tag or branch RE. The general syntax for a branch is '<custom>-v?<version>_<feature>'
+  #
+  # The RE defines the following captures:
+  #   $1 - custom name, can be nil
+  #   $2 - tag, nil or 'v'
+  #   $3 - semantic version
+  #   $4 - feature name, can be nil
+  #
   VERSION_SUB_RE = /
       (?:(#{CUSTOM_NAME_SUB_RE})-)?
+      (v)?
       (#{SEMVER_SUB_RE})
       (?:_(#{FEATURE_NAME_SUB_RE}))?
   /x
@@ -135,11 +180,11 @@ module Prick
   #   $1 - custom name, can be nil
   #   $2 - semantic version
   #
-  RELEASE_SUB_RE = /
-      (?:(#{CUSTOM_NAME_SUB_RE})-)?
-      (#{MMP_SEMVER_SUB_RE})
-  /x
-  RELEASE_RE = /^#{RELEASE_SUB_RE}$/
+# RELEASE_SUB_RE = /
+#     (?:(#{CUSTOM_NAME_SUB_RE})-)?
+#     (#{MMP_SEMVER_SUB_RE})
+# /x
+# RELEASE_RE = /^#{RELEASE_SUB_RE}$/
 
   # Matches a prerelease branch
   #
@@ -147,11 +192,11 @@ module Prick
   #   $1 - custom name, can be nil
   #   $2 - semantic version
   #
-  PRERELEASE_SUB_RE = /
-      (?:(#{CUSTOM_NAME_SUB_RE})-)?
-      (#{MMP_SEMVER_SUB_RE}-#{PRE_SEMVER_SUB_RE})
-  /x
-  PRERELEASE_RE = /^#{PRERELEASE_SUB_RE}$/
+# PRERELEASE_SUB_RE = /
+#     (?:(#{CUSTOM_NAME_SUB_RE})-)?
+#     (#{MMP_SEMVER_SUB_RE}-#{PRE_SEMVER_SUB_RE})
+# /x
+# PRERELEASE_RE = /^#{PRERELEASE_SUB_RE}$/
 
   # Matches a feature branch
   #
@@ -160,8 +205,8 @@ module Prick
   #   $2 - semantic version
   #   $3 - feature name
   #
-  FEATURE_SUB_RE = /#{ABSTRACT_RELEASE_SUB_RE}_(#{FEATURE_NAME_SUB_RE})/
-  FEATURE_RE = /^#{FEATURE_SUB_RE}$/
+# FEATURE_SUB_RE = /#{ABSTRACT_RELEASE_SUB_RE}_(#{FEATURE_NAME_SUB_RE})/
+# FEATURE_RE = /^#{FEATURE_SUB_RE}$/
 
   # Migration RE. The syntax is <version>_<version>
   #
@@ -173,8 +218,8 @@ module Prick
   #   $5 - to custom name, can be nil
   #   $6 - to semantic version
   #
-  MIGRATION_SUB_RE = /(#{RELEASE_SUB_RE})_(#{RELEASE_SUB_RE})/
-  MIGRATION_RE = /^#{MIGRATION_SUB_RE}$/
+# MIGRATION_SUB_RE = /(#{RELEASE_SUB_RE})_(#{RELEASE_SUB_RE})/
+# MIGRATION_RE = /^#{MIGRATION_SUB_RE}$/
 
   # Project release RE. The general syntax is '<project>-<custom>-<version>'
   #
@@ -217,5 +262,12 @@ module Prick
   ALL_DATABASES_RE = /^#{ALL_DATABASES_SUB_RE}$/
   def self.all_databases_sub_re(project_name) /(#{project_name})(?:-(#{ABSTRACT_RELEASE_SUB_RE}))?/ end
   def self.all_databases_re(project_name) /^#{all_databases_sub_re(project_name)}$/ end
+
+  # Matches temporary databases. Mostly useful when debugging because temporary databases
+  # should be deleted on exit
+  TMP_DATABASES_SUB_RE = /#{PROJECT_NAME_SUB_RE}-(?:base|next)/
+  TMP_DATABASES_RE = /^#{TMP_DATABASES_SUB_RE}$/
+  def self.tmp_databases_sub_re(project_name) /#{project_name}-(?:base|next)/ end
+  def self.tmp_databases_re(project_name) /^#{tmp_databases_sub_re(project_name)}$/ end
 end
 

data/lib/prick/database.rb

@@ -1,26 +1,29 @@
 
-#require "prick/ensure.rb"
-
 module Prick
   class Database
     attr_reader :name
     attr_reader :user
 
     def initialize(name, user)
+      name != "" or raise "Illegal database name" 
       @name = name
       @user = user
       @version = nil
     end
 
-    def version
-      @version ||= begin
-          version = 
-              if exist? && Rdbms.exist_table?(name, "prick", "versions")
-                Rdbms.select(name, "select version from prick.versions")&.first&.first
-              else
-                nil
-              end
-          version && Version.new(version)
+    def version(cache: true)
+      if cache && @version
+        @version
+      else
+        @version = begin
+            version = 
+                if exist? && Rdbms.exist_table?(name, "prick", "versions")
+                  Rdbms.select(name, "select version from prick.versions")&.first&.first
+                else
+                  nil
+                end
+            version && Version.new(version)
+        end
       end
     end
 
@@ -43,18 +46,21 @@ module Prick
     def drop() Rdbms.drop_database(name, fail: false); @version = nil end
 
     def loaded?() !version.nil? end
-    def load(file) Rdbms.load(name, file, user: user); @version = nil end
 
-    def save(file) Rdbms.save(name, file); @version = nil end
+    def load(file) 
+      !loaded? or raise Internal, "Database #{name} is already loaded"
+      Rdbms.load(name, file, user: user)
+      version # Provoke load of version
+    end
 
-    def to_s() name end
+    def save(file) 
+      loaded? or raise Internal, "Database #{name} is not loaded"
+      Rdbms.save(name, file)
+      @version = nil 
+    end
 
-#   include Ensure
+    def clean() recreate end # TODO: Find solution that doesn't involve dropping the database
 
-  private
-    @states = {
-      exist: [:create, :drop],
-      loaded: [:exist, :load, :recreate]
-    }
+    def to_s() name end
   end
 end