prick 0.4.0 → 0.5.0

data/lib/prick/version.rb

@@ -4,7 +4,7 @@
 
 # Required by gem
 module Prick
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end
 
 # Project related code starts here
@@ -21,9 +21,12 @@ module Prick
     def zero?() self == Version.zero end
 
     # Return true if `string` is a version
-    def self.version?(string) !(string =~ VERSION_RE).nil? end
+    def self.version?(string) 
+      string.is_a?(String) or raise Internal, "String expected"
+      !(string =~ VERSION_RE).nil? 
+    end
 
-    attr_accessor :custom
+    attr_accessor :fork
     attr_accessor :semver
     attr_accessor :feature
 
@@ -36,8 +39,8 @@ module Prick
     def patch() @semver.patch end
     def patch=(patch) @semver.patch = patch end
 
-    # Return true if this is a custom release
-    def custom?() !@custom.nil? end
+    # Return true if this is a fork release
+    def fork?() !@fork.nil? end
 
     # Return true if this is a feature release
     def feature?() !@feature.nil? end
@@ -47,13 +50,16 @@ module Prick
 
     # Return true if this is a pre-release
     def pre?() !@semver.pre.nil? end
+    def prerelease?() pre? end
 
     # The releases is stored as a String (eg. 'pre.1') in the semantic version
     # but #pre returns only the Integer number
     def pre() @semver.pre =~ PRE_RE ? $1.to_i : nil end
+    def prerelease() pre end
 
     # #pre= expects an integer or nil argument
     def pre=(pre) @semver.pre = (pre ? "#{PRE_LABEL}.#{pre}" : nil) end
+    def prerelease=(pre) self.pre = pre end
 
     def dup() Version.new(self) end
     def clone() Version.new(self) end
@@ -61,19 +67,19 @@ module Prick
     def eql?(other) self == other end
     def hash() @semver.hash end
 
-    def initialize(version, custom: nil, feature: nil)
+    def initialize(version, fork: nil, feature: nil)
       case version
         when String
           version =~ VERSION_RE or raise Version::FormatError, "Expected a version, got #{version.inspect}"
-          @custom = custom || $1
-          @semver = Semantic::Version.new($2)
-          @feature = feature || $3
+          @fork = fork || $1
+          @semver = Semantic::Version.new($3)
+          @feature = feature || $4
         when Semantic::Version
-          @custom = custom
+          @fork = fork
           @semver = version.dup
           @feature = feature
         when Version
-          @custom = custom || version.custom
+          @fork = fork || version.fork
           @semver = version.semver.dup
           @feature = feature || version.feature
       else
@@ -83,9 +89,17 @@ module Prick
 
     # Try converting the string `version` into a Version object. Return nil if unsuccessful
     def self.try(version)
-      version?(version) ? new(version) : nil
+      version.is_a?(Version) ? version : (version?(version) ? new(version) : nil)
     end
 
+    # Parse a branch or tag name into a Version object. Return a [version, tag]
+    # tuple where tag is true if name was a tag
+    def self.parse(name)
+      name =~ VERSION_RE or raise Version::FormatError, "Expected a version, got #{version.inspect}"
+      fork, tag, semver, feature = $1, $2, $3, $4
+      version = Version.new(semver, fork: fork, feature: feature)
+      [version, tag]
+    end
     # `part` can be one of :major, :minor, :patch, or :pre. If pre is undefined, it 
     # is set to `pre_initial_value`
     def increment(part, pre_initial_value = 1) 
@@ -117,20 +131,18 @@ module Prick
       end
     end
 
-    def tag() "v#{to_s}" end
+#   def path
+#     parts = [FEATURE_DIR, truncate(:pre), feature].compact
+#     File.join(*parts)
+#   end
 
-    def path
-      parts = [FEATURE_DIR, truncate(:pre), feature].compact
-      File.join(*parts)
-    end
-
-    def link
-      !feature? or raise Internal, "Version #{to_s} is a feature, not a release"
-      File.join(RELEASE_DIR, to_s)
-    end
+#   def link
+#     !feature? or raise Internal, "Version #{to_s} is a feature, not a release"
+#     File.join(RELEASE_DIR, to_s)
+#   end
 
     def <=>(other)
-      r = (custom || "") <=> (other.custom || "")
+      r = (fork || "") <=> (other.fork || "")
       return r if r != 0
       r = semver <=> other.semver
       return r if r != 0
@@ -138,16 +150,17 @@ module Prick
       return r
     end
 
-    # Render as String
-    def to_s
-      (custom ? "#{custom}-" : "") + semver.to_s + (feature ? "_#{feature}" : "")
+    # Render as branch
+    def to_s(tag: false)
+      (fork ? "#{fork}-" : "") + (tag ? "v" : "") + semver.to_s + (feature ? "_#{feature}" : "")
     end
 
+    # Render as a tag
+    def to_tag() to_s(tag: true) end
+
     # Render as string
     def inspect() to_s end
   end
-
-# ZERO = Version.new("0.0.0")
 end
 
 

data/share/diff/diff.after-tables.sql

@@ -0,0 +1,4 @@
+-- Generated by prick(1) via migra(1). Please don't touch. 
+--
+-- It should not be necessary to change this file as it doesn't contain data changes
+--

data/share/diff/diff.before-tables.sql

@@ -0,0 +1,4 @@
+-- Generated by prick(1) via migra(1). Please don't touch. 
+--
+-- It should not be necessary to change this file as it doesn't contain data changes
+--

data/share/diff/diff.tables.sql

@@ -0,0 +1,8 @@
+-- Generated by prick(1) via migra(1). Please don't touch. 
+--
+-- This file contains changes that can touch existing data in the database that
+-- needs speciel treatment in the migrate.sql
+--
+-- Note that this file is not executed by prick by default and that it is not
+-- added to the Git repo when it changes. You have to do that manually
+--

data/share/migration/diff.tables.sql

@@ -0,0 +1,8 @@
+-- Generated by prick(1) via migra(1). Please don't touch. 
+--
+-- This file contains changes that can touch existing data in the database that
+-- needs speciel treatment in the migrate.sql
+--
+-- Note that this file is not executed by prick by default and that it is not
+-- added to the Git repo when it changes. You have to do that manually
+--

data/share/migration/migrate.sql

@@ -0,0 +1,3 @@
+-- Customize your migrations here but
+--
+

data/share/{release_migration → migration}/migrate.yml

@@ -2,4 +2,7 @@
 #
 ---
 - features
+- diff.before-tables.sql
+- tables
 - migrate.sql
+- diff.after-tables.sql

data/share/migration/tables.sql

@@ -0,0 +1,3 @@
+-- Placeholder for table changes. After you prepared a diff, you should inspect
+-- diff.table.sql and incorporate the changes here
+--

data/share/schema/schema/prick/data.sql

@@ -0,0 +1,7 @@
+-- Auto-generated file. Don't touch
+--
+
+COPY prick.versions (id, fork, major, minor, patch, pre, feature, version) FROM stdin;
+1	\N	0	0	0	\N	\N	0.0.0
+\.
+

data/share/{schemas → schema/schema}/prick/tables.sql

@@ -6,11 +6,11 @@ set search_path to prick;
 
 create table versions (
   id integer generated by default as identity primary key,
-  custom varchar,
+  fork varchar,
   major integer not null,
   minor integer not null,
   patch integer not null,
-  pre varchar,
+  pre integer,
   feature varchar,
   version varchar not null
 );

data/test_refactor

@@ -0,0 +1,34 @@
+#!/usr/bin/bash
+
+function add_table() {
+    local name=$1
+    echo "Creating table $name"
+    echo "create table $name (id integer);" >>schema/public/tables.sql
+    git add schema/public/tables.sql
+    git commit -m "Added table $name" >/dev/null
+}
+
+function add_migration() {
+    echo "Creating migration"
+    cp schema/public/tables.sql migration/diff.sql
+    echo '\i diff.sql' >migration/migrate.sql
+    git commit -am "Added migration"
+}
+
+set -e
+clear
+
+if [ -d dir ]; then
+    find dir -type f -delete
+else
+    mkdir dir
+fi
+
+cd dir
+prick --name prj init "."
+
+prick prepare release
+add_table a
+add_migration
+prick create release 0.1.0
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prick
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shellopts
@@ -78,7 +78,6 @@ files:
 - doc/prick.txt
 - doc/sh.prick
 - exe/prick
-- file
 - lib/ext/algorithm.rb
 - lib/ext/fileutils.rb
 - lib/ext/forward_method.rb
@@ -87,8 +86,8 @@ files:
 - lib/prick.rb
 - lib/prick/archive.rb
 - lib/prick/branch.rb
-- lib/prick/build.rb
 - lib/prick/builder.rb
+- lib/prick/cache.rb
 - lib/prick/command.rb
 - lib/prick/constants.rb
 - lib/prick/database.rb
@@ -97,7 +96,7 @@ files:
 - lib/prick/ensure.rb
 - lib/prick/exceptions.rb
 - lib/prick/git.rb
-- lib/prick/migra.rb
+- lib/prick/head.rb
 - lib/prick/migration.rb
 - lib/prick/program.rb
 - lib/prick/project.rb
@@ -110,8 +109,9 @@ files:
 - make_releases
 - make_schema
 - prick.gemspec
-- share/feature_migration/diff.sql
-- share/feature_migration/migrate.sql
+- share/diff/diff.after-tables.sql
+- share/diff/diff.before-tables.sql
+- share/diff/diff.tables.sql
 - share/features/diff.sql
 - share/features/feature/diff.sql
 - share/features/feature/migrate.sql
@@ -119,22 +119,24 @@ files:
 - share/features/features.yml
 - share/features/migrations.sql
 - share/gitignore
-- share/release_migration/diff.sql
-- share/release_migration/features.yml
-- share/release_migration/migrate.sql
-- share/release_migration/migrate.yml
+- share/migration/diff.tables.sql
+- share/migration/features.yml
+- share/migration/migrate.sql
+- share/migration/migrate.yml
+- share/migration/tables.sql
 - share/schema/build.yml
 - share/schema/schema.sql
-- share/schemas/build.yml
-- share/schemas/prick/build.yml
-- share/schemas/prick/data.sql
-- share/schemas/prick/schema.sql
-- share/schemas/prick/tables.sql
-- share/schemas/public/.keep
-- share/schemas/public/build.yml
-- share/schemas/public/schema.sql
+- share/schema/schema/build.yml
+- share/schema/schema/prick/build.yml
+- share/schema/schema/prick/data.sql
+- share/schema/schema/prick/schema.sql
+- share/schema/schema/prick/tables.sql
+- share/schema/schema/public/.keep
+- share/schema/schema/public/build.yml
+- share/schema/schema/public/schema.sql
 - test_assorted
 - test_feature
+- test_refactor
 - test_single_dev
 homepage: http://www.nowhere.com/
 licenses: []
@@ -154,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A release control and management system for postgresql

data/lib/prick/build.rb

@@ -1,376 +0,0 @@
-
-require "prick/ensure.rb"
-require "prick/dsort.rb"
-require "ext/fileutils.rb" # for ::touch_p
-
-module Prick
-  class Build
-    include Ensure
-
-    # The associated project object
-    attr_reader :project
-
-    # Version
-    attr_reader :version
-
-    # Build name. Same as `version.to_s`
-    def name() version.to_s end
-
-    # Associated database object
-    attr_reader :database
-
-    # Schema object. Only defined when the build has been checked out
-    attr_reader :schema
-
-    # Migration object. Running the migration on a base release database will
-    # mutate it into the current release
-    attr_reader :migration
-
-    # Path to a filesystem node that represents the build on disk. Used to
-    # detect if a build is present in the current release's tree. It is
-    # possible to infer the base release from the node - either by a naming
-    # convention or by reading the file. Build::deref_node_file does that
-    def node() raise AbstractMethod end
-
-    # Base release. Returns nil if version is 0.0.0. Raises an exception if
-    # branch is not represented on disk and it can't be inferred from the
-    # version (only features)
-    def base_release()
-      return nil if version.zero?
-      @base_release.present? or raise Internal, "Release #{name} is not present"
-      @base_release
-    end
-
-    # List of features in this build. This requires the build to be present on disk
-    def features() 
-      present? or raise "Build #{name} is not present"
-      version.zero? ? [] : migration.feature_versions.map { |version| project[version] }
-    end
-
-    # Return the build's history as a hash from release to list of features
-    def history()
-      h = {}
-      Algorithm.follow(self, :base_release).each { |release|
-        h[release] = []
-        indent {
-          release.features.each { |feature| h[release] << feature }
-        }
-      }
-      h
-    end
-
-    def initialize(project, base_release, version, migration, database: nil, schema: nil)
-      base_release.nil? || base_release.is_a?(Release) or 
-          raise Internal, "Expected a Release object, got #{base_release.class}"
-      version.is_a?(Version) or raise Internal, "Expected a Version object, got #{version.class}"
-      @project = project
-      @base_release = base_release
-      @version = version
-      @migration = migration
-      @schema = Schema.new(project)
-      @database = database || Database.new("#{project.name}-#{name}", project.user)
-      project[name] = self
-    end
-
-    # Return true if the build exists as a branch in git
-    def exist?() Git.branch?(name) end
-
-    # Create and checkout the branch
-    def create()
-      !present? or raise Fail, "Build #{name} is already present on disk"
-      !exist? or raise Fail, "Build #{name} is already present in git"
-      Git.create_branch(name)
-      Git.checkout_branch(name)
-    end
-
-    # FIXME: Kills the current branch under the feets of the application. Also doesn't update
-    # internal structures in Project
-    def destroy()
-      project.release != self or raise Error, "Can't destroy current branch - #{self.version}"
-      Git.delete_branch(name)
-    end
-
-    # True if the release is present in this git branch
-    def present?() File.exist?(node) end
-
-    # True if the release is the active branch
-    def active?() Git.current_branch == name end
-
-    def checkout()
-      Git.checkout(name) 
-    end
-
-    def checkback() # Doubtfull - creates strange results on Release and Prerelease branches
-      base_release.checkout 
-    end
-    
-    def built?()
-      active? && @schema.built?(@database) 
-    end
-
-    def build()
-      active? or raise Error, "Can't build: Not active"
-      @schema.build(@database) 
-    end
-
-    def rebuild() 
-      active? or raise Error, "Can't rebuild: Not active"
-      @database.recreate
-      build 
-    end
-
-    def include_feature(feature)
-      migration.include_feature(feature.migration)
-    end
-
-    def remove_feature(feature)
-      raise NotYet
-    end
-
-    # Create a copy of the project in tmp/ and checkout the branch. Used to build
-    # releases. Returns the path to the copy
-    def snapshot() end
-
-    # Sorting
-    def <=>(other) version <=> other.version end
-
-    # Use #name for String conversion
-    def to_s() name end
-
-    # Reads the name of the base release from a node (see Build#node)
-    def self.deref_node_file(node)
-      if File.basename(node) == "0.0.0"
-        nil
-      elsif File.symlink?(node) # Releases and prereleases
-        symlink = Command.command("readlink -v #{node}").first
-        value = File.basename(symlink.sub(/\/$/, ""))
-        value == "/dev/null" ? nil : value
-      elsif File.directory?(node) # Migrations
-        name = File.basename(node)
-        name =~ MIGRATION_RE or raise "Illegal migration name: #{name}"
-        $1
-      end
-    end
-
-  private
-    @states = {
-      exist: [:create, :destroy],
-      initialized: [:exist, :initialize, false], # ???
-      active: [:exist, :checkout, :checkback],
-#     built: [:active, :build, lambda { |this| this.database.recreate } ],
-    }
-  end
-
-  class AbstractRelease < Build
-    # Tag
-    def tag() [version.custom, "v#{version.semver}"].compact.join("-") end
-
-    # Cache object
-    attr_reader :archive
-
-    # Redefine Build#node
-    attr_reader :node
-
-    # The directory representing this release. It is initially empty. It is the
-    # same as the next release's migration directory and contains features that
-    # require this release
-    def release_dir() raise AbstractMethod end
-
-    def initialize(project, base_release, version, migration, **opts)
-      super
-      @node = File.join(RELEASE_DIR, name)
-      @archive = DumpFile.new(project, version.to_s)
-    end
-
-    def cached?() archive.exist? end
-    def cache() database.save(archive.path) end
-    def uncache() FileUtils.rm_f(archive.path) end
-
-    def loaded?() schema.loaded?(database) end
-    def load() database.ensure(:loaded, archive.file) end
-    def unload() database.ensure(:loaded, expect: false) end
-
-    def prepare(commit: true)
-      migration.prepare
-      Git.commit("Prepared next release") if commit
-    end
-
-    def <=>(other) version <=> other.version end
-
-    # Create the release in Git and on the disk
-    def create(create_release_link_file: true)
-      super()
-
-      # Create release link file (eg. releases/0.1.0)
-      if create_release_link_file
-        base_release_dir = (version.zero? ? "/dev/null" : "../#{migration.path}")
-        Dir.chdir(RELEASE_DIR) { 
-          FileUtils.ln_s(base_release_dir, File.basename(node))
-        }
-        Git.add(node)
-      end
-
-      # Set schema version
-      project.schema.version = version
-      Git.add(project.schema.path)
-    end
-
-    def dump
-      return self
-      $stderr.puts "#{self.class} #{version}"
-      $stderr.indent { |f|
-        f.puts "node        : #{node.inspect}"
-        f.puts "base_release: #{base_release&.version.inspect}"
-        f.puts "migration   : #{migration&.path.inspect}"
-        f.puts "release_dir : #{release_dir.inspect}"
-      }
-      self
-    end
-
-  private 
-      @ensure_states = {
-#     cached: [:built, :cache, :uncache],
-      loaded: [:cached, :load, :unload]
-    }
-  end
-
-  class Release < AbstractRelease
-    def release_dir() File.join(FEATURE_DIR, name) end
-
-    def initialize(project, base_release, version)
-      migration = base_release && ReleaseMigration.new(base_release.release_dir)
-      super(project, base_release, version, migration)
-    end
-
-    # Create the release in Git and on the disk. We assume that the migration exists
-    def create
-      super
-
-      # Create migration link file
-      if !version.zero?
-        migration_version = "#{base_release.version}_#{version}"
-        features = "../#{migration.path}"
-        Dir.chdir(MIGRATION_DIR) {
-          FileUtils.ln_s(features, migration_version)
-          Git.add(migration_version)
-        }
-      end
-
-      # Create new empty feature directory
-      ReleaseMigration.new(release_dir).create
-
-      Git.commit("Release #{version}")
-      Git.create_tag(version)
-      dump
-      migration.dump if migration
-      self
-    end
-  end
-
-  # TODO: Rename to PreRelease
-  class Prerelease < AbstractRelease
-    attr_reader :target_release
-
-    def release_dir() base_release.release_dir end
-
-    def initialize(project, base_release, version, target_version = version.truncate(:pre))
-      @target_release = Release.new(project, base_release, target_version)
-      migration = ReleaseMigration.new(target_release.migration.path)
-      super(project, base_release, version, migration)
-    end
-
-    # Create the pre-release in Git and on disk
-    def create
-      super
-      migration.prepare
-      Git.commit("Pre-release #{version}")
-      dump
-      self
-    end
-
-    # Create a migration for this release
-    def prepare_migration
-      base_release.built? or raise "Base release #{base_release} is not built"
-      puts "Prerelease#generate_migration"
-    end
-  end
-
-  class MigrationPrerelease < Prerelease
-    def initialize(project, base_release, version, target_version = version.truncate(:pre))
-      release_dir = "/migrations/..."
-    end
-  end
-
-  class MigrationRelease < AbstractRelease
-    def create
-      # does not call super because migrations belong to the release they migrate to
-      #
-      # code, code, code
-    end
-
-    def include_feature
-      raise NotYet
-    end
-  end
-
-  class Feature < Build
-    # Name of feature
-    def feature() version.feature end
-
-    # A feature's node is the feature directory
-    def node() release_dir end
-
-    def release_dir() migration.path end
-
-    def initialize(project, base_release, name)
-      base_release.is_a?(Release) || base_release.is_a?(Prerelease) or 
-          raise Internal, "Expected a Release object, got #{base_release.class}"
-      version = Version.new(base_release.version, feature: name)
-      migration = FeatureMigration.new(Migration.path(version))
-      super(project, base_release, version, migration)
-    end
-
-    def checkout() 
-      super
-#     FileUtils.ln_sf(feature, "feature")
-    end
-
-    def create
-      super
-      migration.create
-      migration.prepare
-      Git.commit("Created feature #{feature}")
-      migration.dump
-      self
-    end
-
-    # features/
-    #   0.0.0/
-    #     feature_a
-    #     feature_b/
-    #       base_release.prick
-    #       name.yml <- 0.2.0/feature_b
-    #       rebased.yml <- reads base_release here
-    #
-    #   0.2.0/
-    #     feature_a -> 0.0.0/feature_a <- not rebased
-    #     feature_b -> 0.0.0/feature_b <- rebased
-
-
-    def rebase(new_base_release)
-      # Checkout new_base_release
-      # Merge feature
-      # Establish symlinks
-      # Create as branch
-
-#     new_base > base_release or 
-#         raise Error, "Can't rebase from #{base_release.version} to #{new_base.version}"
-#     new_feature = Feature.new(project, base_release, base.version, base: base)
-#     new_feature.ensure(:active)
-#     schema.version = version
-#     FileUtils.ln_sf("../#{feature.release_dir}", new_feature.release_dir)
-#     Git.add(new_feature.release_dir)
-#     new_feature
-    end
-  end
-end