prick 0.29.2 → 0.31.0

data/idea.txt

@@ -0,0 +1,38 @@
+
+Build spec
+  Custom variables
+    variables VAR...
+
+  Variables
+    graph # old 'standard'
+    schema
+    rebuild
+    refresh
+    require 
+
+  Code
+    build
+    rebuild
+    refresh
+    import
+    export
+
+  Special code functions
+    super
+    build file-or-directory       # makes sure not to load a file twice
+    sql "sql statement"
+    use sql-file                  # makes sure not to load a file twice
+    load dump-files               # makes sure not to load a file twice
+
+    build_ENVIRONMENT   # eg. 'build_app_registry_backend'
+    rebuild_ENVIRONMENT
+    refresh_ENVIRONMENT
+
+  Environment variables
+    PRICK_ENVIRONMENTS # all environments included in the current environment
+
+  Helper functions
+    # Consults PRICK_ENVIRONMENTS to check if the given environment is include
+    # in the current environment
+    has_environment ENVIRONMENT
+

data/lib/prick/builder/batch.rb

@@ -1,7 +1,7 @@
 module Prick
   module Build
     class BuildBatch
-      include ::Timer
+      include Timer
 
       attr_reader :builder
       forward_to :builder, :conn
@@ -144,9 +144,6 @@ module Prick
           delete = builder.clean ? :none : :touched
           begin
             conn.execute fox.to_sql(format: :exec, delete: delete)
-
-            # FIXME: Why only in FoxBatch - should be set higher up in the system
-            conn.execute "update prick.versions set built_at = now() at time zone 'UTC'"
           rescue PG::SyntaxError, PG::Error => ex 
             raise PostgresError.new(ex.message)
           end

data/lib/prick/builder/builder.rb

@@ -1,4 +1,4 @@
-require_relative '../local/command'
+require_relative '../local/command.rb'
 
 require_relative './node.rb'
 require_relative './node_pool.rb'
@@ -103,18 +103,24 @@ module Prick
       end
 
       def execute(conn, create_schemas: schemas)
+        # Group batches
         group if batches.nil?
+
+        # Register build in database
+        Prick.state.save_build_begin
+
+        # Create schemas
         conn.exec create_schemas.map { |schema| "create schema #{schema}" }
-        for batch in batches
-          batch.execute
-        end
-      end
 
-#     def setup
-#     end
+        # Execute batch groups
+        t0 = Time.now
+        batches.each(&:execute)
+        t1 = Time.now
 
-#     def teardown
-#     end
+        # Register build result in database
+        dt = t1 - t0
+        Prick.state.save_build_end(true, dt)
+      end
 
       def dump
         batches ? batches.each(&:dump) : pool.dump

data/lib/prick/builder/node.rb

@@ -140,7 +140,7 @@ module Prick
           Command.command(Prick.state.bash_environment, command)
         rescue Command::Error => ex
           message = "Error executing '#{command}'\n" + ex.stderr.map { |l| "   #{l}" }.join("\n")
-          raise Prick::Error.new(message)
+          Prick.error message
         end
       end
     end
@@ -188,12 +188,13 @@ module Prick
         puts "BuildNode #{path}"
         indent {
           puts "schema: #{schema}" if schema
+          puts "refresh: #{refresh_schema.to_s}"
           puts "pg_graph_ignore_schema: #{pg_graph_ignore_schema}"
           decl_nodes.each(&:dump)
           for kind in [:init, :term, :seed]
             kind_nodes = self.send("#{kind}_nodes".to_sym)
             if !kind_nodes.empty?
-              puts "#{kind.upcase}:"
+              puts "#{kind}:"
               indent { kind_nodes.each(&:dump) } 
             end
           end

data/lib/prick/builder/node_pool.rb

@@ -25,7 +25,7 @@ module Prick
       def build_nodes() nodes.select { |node| node.is_a?(BuildNode) } end
 
       # List of schemas to ignore when building PgGraph objects. This is used
-      # to exclude foreign schemes that doesn't follow the PgGraph naming
+      # to exclude foreign schemas that doesn't follow the PgGraph naming
       # conventions
       def pg_graph_ignore_schemas()
         all_nodes.select { |node|
@@ -33,6 +33,8 @@ module Prick
         }.map(&:schema).uniq
       end
 
+      # List of schemas that should be rebuilt. #refresh_schemas is not cached
+      # and can be manipulated by removing build nodes from the pool
       def refresh_schemas() 
         build_nodes.select(&:refresh_schema).map(&:schema).uniq
       end

data/lib/prick/builder/parser.rb

@@ -130,7 +130,8 @@ module Prick
           rest = $3
           args = expand_string(rest || '').split
           path = expand_filename(dir, command)
-          path || optional or raise Error, "Can't find '#{entry}' in #{dir}/ from #{unit}"
+          path || optional or 
+              raise Error, "Can't find file\n   #{command}\n   #{path}\n   in #{dir}/\n   from #{unit}"
           !path.nil? or return nil
         else
           raise Error, "Not a file name: '#{entry}'"

data/lib/prick/constants.rb

@@ -7,8 +7,8 @@ module Prick
   ### DIRECTORIES AND FILE NAMES
 
   # Shared files (part of the installation)
-  SHARE_PATH = "#{File.dirname(File.dirname(__dir__))}/lib/share"
-  LIBEXEC_PATH = "#{File.dirname(File.dirname(__dir__))}/lib/libexec"
+  SHARE_PATH = "#{File.dirname(File.dirname(__dir__))}/lib/prick/share"
+  LIBEXEC_PATH = "#{File.dirname(File.dirname(__dir__))}/lib/prick/libexec"
 
   # Project directories
   DIRS = [
@@ -30,19 +30,19 @@ module Prick
   PRICK_DIR = Dir.getwd
 
   # Search path for executables
-  PRICK_PATH = "#{ENV['PATH']}:#{PRICK_DIR}/#{BIN_DIR}:#{PRICK_DIR}/#{LIBEXEC_DIR}"
+# PRICK_PATH = "#{ENV['PATH']}:#{PRICK_DIR}/#{BIN_DIR}:#{PRICK_DIR}/#{LIBEXEC_DIR}"
 
-  # Project specification file
+  # Project file
   PRICK_PROJECT_FILE = "prick.yml"
   PRICK_PROJECT_PATH = PRICK_PROJECT_FILE
 
-# # Environment specification file
-# PRICK_ENVIRONMENT_FILE = "prick.environment.yml"
-# PRICK_ENVIRONMENTS_PATH = PRICK_ENVIRONMENT_FILE
+  # Environment file
+  PRICK_ENVIRONMENT_FILE = "prick.environment.yml"
+  PRICK_ENVIRONMENT_PATH = PRICK_ENVIRONMENT_FILE
 
-  # Context file
-  PRICK_CONTEXT_FILE = ".prick-context"
-  PRICK_CONTEXT_PATH = PRICK_CONTEXT_FILE
+  # State file
+  PRICK_STATE_FILE = ".prick.state.yml"
+  PRICK_STATE_PATH = PRICK_STATE_FILE
 
   # Fox state file (contains anchors and table sizes)
   FOX_STATE_FILE = ".fox-state.yml"
@@ -69,8 +69,8 @@ module Prick
     AFTER_TABLES_DIFF_FILE = "diff.after-tables.sql"
   ]
 
-
-
+  # Default environment
+  DEFAULT_ENVIRONMENT = "default"
 
   # Not in use:
 

data/lib/prick/diff.rb

@@ -34,7 +34,7 @@ module Prick
         file2 = file3 = file1
         mark = mark.nil? ? true : mark
       elsif file2.nil? != file3.nil?
-        raise Prick::Fail, "Either none or both of `file2` and `file3` should be nil"
+        Prick.failure "Either none or both of `file2` and `file3` should be nil"
       else
         mark = mark.nil? ? false : mark
       end
@@ -48,7 +48,7 @@ module Prick
       command = "migra --unsafe --with-privileges postgres:///#{@db1} postgres:///#{@db2}"
       @diff = Command.command(command, fail: false)
       [0,2].include?(Command.status) or
-        raise Prick::Fail, "migrate command failed with status #{Command.status}: #{command}"
+        Prick.failure "migrate command failed with status #{Command.status}: #{command}"
     end
 
     # Initialize table change variables

data/lib/prick/environment.rb

@@ -1,11 +1,21 @@
 require 'yaml'
 require 'dsort'
 
+# TODO: 
+#   o Check :parent vs. :inherit (or explain the difference). Also check
+#     handling of :comment 
+
 module Prick
+  # An environment as defined in the prick.environment file. The environment is
+  # constant across all instances of State so we ensure that it is loaded only
+  # once
   class Environment
     # Environments name
     attr_reader :name
 
+    # Environment comment. If not nil, this environment is considered a user-environment
+    attr_accessor :comment
+
     # Names of parent environments
     def parents = @values[:parents]
 
@@ -18,7 +28,7 @@ module Prick
     def variables = @@VARIABLES
 
     # List of user defined variables
-    def user_variables = @@VARIABLES - [:parent]
+    def user_variables = @@VARIABLES - [:parents, :comment]
 
     # Hash from variable to value
     attr_accessor :values
@@ -34,14 +44,15 @@ module Prick
 
     def initialize(name)
       @name = name
+      @comment = nil
       @values = variables.map { |key| [key, []] }.to_h
       @effective_values = variables.map { |key| [key, []] }.to_h
       @@ENVIRONMENTS[name] = self
     end
 
-    def self.load_environments(hash) # hash can be nil
+    def self.load_environments(yaml) # hash maps from environment name to object
       if hash
-        parse(hash)
+        parse(yaml)
         analyze
       end
     end
@@ -79,23 +90,30 @@ module Prick
     @@SORTED_ENVIRONMENTS = []
 
     def self.yaml_to_array(value)
-      !value.nil? && Array(value).flatten.compact.map(&:to_s).map(&:split).flatten
+      case value
+        when /\n/; [value.split("\n")]
+        when nil ; []
+        when String; value.split
+        else [value.to_s]
+      end
+#     !value.nil? && Array(value).flatten.compact.map(&:to_s).map(&:split).flatten
     end
 
     def self.parse(hash)
       hash = hash.dup
-      @@VARIABLES = [:parents] + (yaml_to_array(hash.delete("variables")).map(&:to_sym) || [])
-
+      @@VARIABLES = [:parents, :comment] + yaml_to_array(hash.delete("variables") || "").map(&:to_sym)
       for environment, settings in hash
         env = Environment.new(environment)
+        settings ||= {}
         if settings.is_a? Hash
           for variable, value in settings
-            variable = (variable == "inherit" ? :parents : variable.to_sym)
-            value = yaml_to_array(value)
-            if variables.include?(variable)
-              env.values[variable] = value 
-            else 
-              raise ArgumentError, "Illegal variable: '#{variable}'"
+            if variable == "comment"
+              env.comment = value
+            else
+              variable = (variable == "inherit" ? :parents : variable.to_sym)
+              value = yaml_to_array(value)
+              variables.include?(variable) or raise ArgumentError, "Illegal variable: '#{variable}'"
+              env.values[variable] = value
             end
           end
         else

data/lib/prick/local/command.rb

@@ -128,8 +128,14 @@ module Command
       STDERR.reopen(pe[1])
       pe[1].close
 
-      env
-      exec(env.map { |k,v| [k.to_s, v.to_s] }.to_h, cmd)
+      # Clean bundler environment so that prick can be run in development mode.
+      # The problem is that the bundler environment is inherited by
+      # subprocesses and interferes with loading ruby commands. FIXME This is
+      # only relevant when running prick in development mode
+      ENV.delete_if { |k,v| %w(RUBYOPT RUBYLIB _).include?(k) || k =~ /^BUNDLER?_/ }
+      env = env.map { |k,v| [k.to_s, v.to_s] }.to_h # Convert array values to strings
+      env.each { |k,v| ENV[k] = v }
+      Kernel.exec(env, cmd)
     }
 
     pw[0].close

data/lib/prick/local/fmt.rb

@@ -0,0 +1,56 @@
+
+module Fmt
+  # Print table
+  def self.puts_table(headers, table)
+    widths = headers.map(&:size)
+    signs = []
+    types = []
+    for i in (0...headers.size)
+      widths[i] = 
+          ( 
+            [widths[i]] +
+            table.map { |row|
+              case value = row[i]
+                when TrueClass, FalseClass
+                  types[i] = 's'
+                  signs[i] = '-'
+                  5
+                when NilClass
+                  types[i] = 's'
+                  signs[i] = '-'
+                  4
+                when String
+                  types[i] = 's'
+                  signs[i] = '-'
+                  value.size
+                when Integer
+                  types[i] = 'i'
+                  signs[i] = ''
+                  Math.log10(value) + 1
+              else
+                raise ArgumentError, value
+              end
+            }
+          ).max
+    end
+
+    widths = widths.map { _1 }
+
+    for width, value in widths.zip(headers)
+      printf "%-#{width}s ", value
+    end
+    puts
+    widths.each.with_index { |width, index|
+      char = (headers[index] =~ /^\s*$/ ? " " : "-")
+      printf "%#{width}s ", char * width
+    }
+    puts
+    for row in table
+      for sign, width, type, value in signs.zip(widths, types, row)
+        value = (value.nil? ? "-" : value)
+        printf "%#{sign}#{width}#{type} ", value
+      end
+      puts
+    end
+  end
+end

data/lib/prick/prick_version.rb

@@ -77,7 +77,7 @@ module Prick
           @semver = version.semver.dup
           @feature = feature || version.feature
       else
-        raise Internal, "Expected a String, PrickVersion, or Semantic::Version, got #{version.class}"
+        raise ArgumentError, "Expected a String, PrickVersion, or Semantic::Version, got #{version.class}"
       end
     end
 

data/lib/prick/share/init/{.gitignore → dot.gitignore}

@@ -1,6 +1,6 @@
 
 # Local database and environment
-/.prick-context
+/.prick-state.yml
 
 # Fox state file
 /.fox-state.yml

data/lib/prick/share/init/prick.environment.yml

@@ -0,0 +1,16 @@
+
+variables:
+
+all:
+
+production:
+  inherit: all
+
+development:
+  inherit: all
+
+test:
+  inherit: all
+
+default:
+  inherit: all

data/lib/prick/share/init/prick.yml

@@ -1,6 +1,6 @@
+---
+# Initial project configuration file
 name: 
-title:
-database: 
-username: 
+title: 
 version: 
 prick: 

data/lib/prick/share/init/schema/prick/build.yml

@@ -1,5 +1,14 @@
+# Controlled by the prick command. Don't change
+#
+# Note the SQL scripts are also called directly from 'prick setup' when the
+# database is created because we don't want to parse the whole build
+# environment just to create the prick schema.  After the initial setup, the
+# scripts are only run by 'prick build' with the --force option 
+#
+# This is hardcoded an should be fixed somehow
+#
 ---
 - schema: prick
+  refresh: false # Because the build process takes care of this
 - tables.sql
-- seed: 
-  - data.sql
+- views.sql

data/lib/prick/share/init/schema/prick/tables.sql

@@ -1,16 +1,37 @@
 -- Controlled by prick(1). Don't touch
 --
+-- TODO
+--  o Replace view with a function to return the current build
 
 set search_path to prick;
 
-create table versions (
+create table builds (
   id integer generated by default as identity primary key,
-  fork varchar,
-  major integer not null,
-  minor integer not null,
-  patch integer not null,
-  pre integer,
-  feature varchar,
-  version varchar not null,
-  built_at timestamp without time zone not null default (now() at time zone 'UTC')
+
+  -- Project name
+  name varchar not null,
+
+  -- Version
+  version varchar not null, -- Project version
+  prick varchar not null,-- Prick version
+
+  -- Git
+  branch varchar not null,
+  rev varchar not null, -- commit ID
+  clean boolean not null default true, -- True if git repository is clean
+
+  -- Environment
+  environment varchar not null default 'default',
+  
+  -- Build timestamp. This is the time of the start of the build
+  built_at timestamp without time zone default (now() at time zone 'UTC'),
+
+  -- Build status
+  success boolean default false,-- True if the database built successfully
+
+  -- Durations
+  duration float,-- Duration of database build. Null if success is false
+  prick_duration float, -- Duration of the full prick command
+  make_duration float -- Duration of enclosing make script
 );
+

data/lib/prick/share/init/schema/prick/views.sql

@@ -0,0 +1,6 @@
+create view versions as 
+  select * 
+  from builds 
+  where (select count(*) from builds) = 1
+  or built_at = (select max(built_at) from builds)
+