prick 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c38cab1d940acbbaf8c36dadfddd5ce8a003e45fd881c0af033ee16b9b1bcb9b
-  data.tar.gz: c9c67dd1b746adf191a2193c536a7c2a97a962f5a7b70c371ecf42bb60621cec
+  metadata.gz: 872c793b29eae6754796a66c93808a58507b5eac112ddadcf2260d7ed01f3435
+  data.tar.gz: 702ee64d93801ddc488664eeae903dc7a34b935585fd87d5c29299295c2e6a7d
 SHA512:
-  metadata.gz: 7f81c8872d37f1b2f772c013c3fd1dad4f5936552aa8a6fa32b1b594d6da5ed20e06725590fd2a5317a8c9cda41b591845c6a68ec7ab4c2b82842b3fd2599c9c
-  data.tar.gz: 17c08c190070820e63facc09a7411c8f90b43f7994a8a5eefc04baa2c7f0a9647ec562ce000d0677289d922f56c5eae410f68d0b323e8f177df122c1167b9fec
+  metadata.gz: 2524d9c7bbc4f73e5ecb343b5e6ef3caf47a9ed9541d18a96d458dd7024da9915d95b66a90e30dbdcc8e451b7d42cb19b1ae3682d001031ff8d5c09bedfcf354
+  data.tar.gz: a7359ccb249584edd6752509eaa90063d09029c7aa54f879e558644bb2ad2fa261975571f7945e9ea2726eacbdba8a85b7afb3ec8a46c57a0d0f1ec919e5b66f

data/TODO

@@ -1,3 +1,4 @@
+o make it possible to build only one scheme
 o cleanup connection
 o make environment optional
 o eval vs exit

data/exe/prick

@@ -120,11 +120,9 @@ SPEC = %(
       TODO
 
   build! -f,force -t,time --dump=KIND? -- [SCHEMA]
-      Build the project. If SCHEMA is defined, later schemas are excluded.
-      KIND can be 'nodes', 'allnodes' or 'batches' (the default). 
-
-      Schemas marked with 'no refresh' is not built unless the --force is
-      present
+      Build the project. If SCHEMA is defined, later schemas are excluded. KIND
+      can be 'nodes', 'allnodes' or 'batches' (the default). Schemas marked
+      with 'no refresh' is not built unless the --force is present
 
   make! -t,time --dump=KIND? -- [SCHEMA]
       @ Only rebuild changed files
@@ -133,6 +131,15 @@ SPEC = %(
       rebuild affected parts of the project. KIND can be 'nodes', 'allnodes' or
       'batches' (the default)
 
+  run! -t,time --dump=KIND? --schema=SCHEMA -- PATH
+      @ Execute path in Prick environment
+
+      Execute a single directory or file within the Prick environment. If given
+      a directory argument, the directory is searched for a build.yml file. If
+      given a file argument, the file should be a .sql, .fox, or build file
+
+      The --schema option sets the current schema before executing the PATH
+
   bash! --main
       Emit a bash script to build the database. The script is constructed from
       the build attributes in the environment file
@@ -361,6 +368,13 @@ begin
       dump = cmd.dump? ? cmd.dump("batches")&.to_sym || :batches : nil
       Prick::SubCommand.make(database, username, args.expect(0..1), timer: cmd.time?, dump: dump)
 
+    when :run!
+      require_db
+      dump = cmd.dump? ? cmd.dump("batches")&.to_sym || :batches : nil
+      Prick::SubCommand.run(
+          database, username, args.expect(1), 
+          timer: cmd.time?, dump: dump, schema: cmd.schema)
+
     when :bash!
       Prick::SubCommand.bash(main: cmd.main?)
 

data/lib/prick/builder/builder.rb

@@ -27,9 +27,12 @@ module Prick
       # PgConn object
       attr_reader :conn
 
-      # Root schema directory
+      # Schema directory
       attr_reader :dir
 
+      # Path to file or directory
+      attr_reader :path
+
       # Reflections YAML file
       attr_reader :reflections_file
 
@@ -39,6 +42,9 @@ module Prick
       # Root build node
       attr_reader :root
 
+      # True if this is a single-file build
+      attr_reader :single
+
       # Pool of nodes. Initialized by #load_pool
       attr_reader :pool
 
@@ -51,13 +57,17 @@ module Prick
 
       def batches() @batches ||= group end
 
-      def initialize(conn, dir, clean = true, touched: false)
+      def initialize(conn, path, clean = true, single: false, touched: false)
+        File.exist?(path) or raise Error, "Can't find #{path}"
+        single || File.directory?(path) or raise Error, "Can't find directory #{path}"
+
         @conn = conn
-        @dir = dir
+        @path = path
         @reflections_file = REFLECTIONS_PATH
         @clean = clean
+        @single = single
         @pool = NodePool.new
-        @root = Parser.parse(conn, dir)
+        @root = Parser.parse(conn, path, single: single)
         load_pool(@root) # Collect nodes into pool
         @batches = nil # Initialized by #group
       end
@@ -110,7 +120,7 @@ module Prick
         Prick.state.save_build_begin
 
         # Create schemas
-        conn.exec create_schemas.map { |schema| "create schema #{schema}" }
+        conn.exec create_schemas.map { |schema| "create schema #{schema}" } if !single
 
         # Execute batch groups
         t0 = Time.now

data/lib/prick/builder/node.rb

@@ -10,6 +10,8 @@ module Prick
 
       def name() @name = File.basename(path) end
 
+      # Note that schema defaults to 'public' which may not be what you want in
+      # all cases
       def schema() @schema ||= parent&.schema || "public" end
       def schema=(s) @schema = s end
 
@@ -36,6 +38,7 @@ module Prick
         constrain path, String, NilClass
         @parent, @phase, @kind, @path = parent, phase, kind, path
         @args = args&.empty? ? nil : args
+        @has_schema = false
         @schema = nil
         @source = nil
         @source_lines = nil
@@ -162,6 +165,9 @@ module Prick
 
     # A build.yml file node
     class BuildNode < Node
+      # True if the build file contains a 'schema' attribute
+      attr_accessor :has_schema
+
       def nodes() @nodes ||= init_nodes + decl_nodes + seed_nodes + term_nodes end
 
       attr_reader :decl_nodes
@@ -187,6 +193,7 @@ module Prick
       def dump
         puts "BuildNode #{path}"
         indent {
+          puts "has_schema: #{has_schema}"
           puts "schema: #{schema}" if schema
           puts "refresh: #{refresh_schema.to_s}"
           puts "pg_graph_ignore_schema: #{pg_graph_ignore_schema}"

data/lib/prick/builder/parser.rb

@@ -1,25 +1,26 @@
 module Prick
   module Build
     class Parser
-      def self.parse(conn, dir)
-        Parser.new(conn).parse(dir).unit
-#       [parser.unit, parser.schemas]
+      def self.parse(conn, path, single: true)
+        Parser.new(conn).parse(path, single: single).unit
       end
 
       attr_reader :conn
-      attr_reader :dir
       attr_reader :unit # The singular RootBuildNode object
-#     attr_reader :schemas
 
       def initialize(conn)
         @conn = conn
         @unit = nil
       end
 
-      def parse(dir)
-        @dir = dir
-#       @schemas = {}
-        parse_directory(nil, dir)
+      # Return a RootBuildNode object. #path can be a file or a directory
+      def parse(path, single: false)
+        File.exist?(path) or raise Error, "Can't find #{path}"
+        if single
+          parse_path(path)
+        else
+          parse_directory(nil, path)
+        end
         self
       end
 
@@ -35,36 +36,43 @@ module Prick
       end
 
       # Search for an executable in path. Return nil if not found
+      #
+      # Note that "." is ignored in the search path 
       def find_executable(filename) # ChatGPT
         Prick.state.executable_search_path.split(File::PATH_SEPARATOR).each do |directory|
+          next if directory == "."
           path = File.join(directory, filename)
-          return path if File.executable?(path)
+          return path if File.file?(path) && File.executable?(path)
         end
         nil
       end
 
-      # Expand environments variables file name. Iterates through inherited
-      # environments if the file name contain the $ENVIRONMENT variable. Return
-      # nil if not found
+      # Expand environment variables in the given file name
+      #
+      # #expend_filename substitute '$<variable>' expressions in the filename
+      # with the corresponding value in the current environment. If the file
+      # was not found, inherited environments are processed hierarchly with the
+      # special environment variable ENVIRONMENT set to each PRICK_ENVIRONMENT
+      # value in the inherited environments
       #
-      # The hierarchy of environments is defined in the PRICK_ENVIRONMENT_FILE
+      # Return the resulting path to the file and nil if not found
       #
       def expand_filename(dir, filename)
         envs = Prick.state.environments
         env = envs[Prick.state.environment]
-        bash_vars = Prick.state.bash_environment
+        bash_vars = Prick.state.bash_environment.dup
 
         last = nil
         for env in [env] + env.ancestors.reverse
           bash_vars["ENVIRONMENT"] = env.name
           file = expand_variables(filename, bash_vars)
-          last ||= (file != last and file) or return nil # return if no ENVIRONMENT substitution
+#         last ||= (file != last and file) or return nil # return if no ENVIRONMENT substitution
           path = (file.start_with?("/") ? file : File.join(dir, file))
 
           # Check for file (may be executable)
           return path if File.exist?(path)
 
-          # Check for executable in search path
+          # Check for executable in search path if file doesn't contain a '/'
           path = find_executable(file) and return path if file !~ /\//
         end
 
@@ -77,12 +85,21 @@ module Prick
         expand_variables(string, Prick.state.bash_environment)
       end
 
+      def parse_path(path)
+        File.exist?(path) or raise Error, "Can't find #{file}"
+        dir = File.dirname(path)
+        file = File.basename(path)
+        unit = make_build_unit(nil, nil)
+        parse_build_entry(unit, dir, file)
+        unit
+      end
+
       def parse_directory(parent, dir)
         build_file = "#{dir}/build.yml".sub(/\/\//, "/")
         if File.exist? build_file
           parse_build_file(parent, dir, build_file)
         else
-          raise Error, "Can't find build.yml in #{dir}"
+          raise Error, "Can't find build.yml in #{dir} while parsing #{parent}"
         end
       end
 
@@ -94,6 +111,7 @@ module Prick
             entry.each { |key, value|
               if key == "schema"
                 unit.schema = value
+                unit.has_schema = true
               elsif key == "standard"
                 unit.pg_graph_ignore_schema = !value
               elsif key == "refresh"
@@ -109,17 +127,22 @@ module Prick
               end
             }
           else
-            node = parse_entry(unit, :decl, dir, entry) or next
-            if node.kind == :fox
-              unit.seed_nodes << node
-            else
-              unit.decl_nodes << node
-            end
+            parse_build_entry(unit, dir, entry)
           end
         }
         unit
       end
 
+      def parse_build_entry(unit, dir, file)
+        node = parse_entry(unit, :decl, dir, file) or return nil
+        if node.kind == :fox
+          unit.seed_nodes << node
+        else
+          unit.decl_nodes << node
+        end
+        node
+      end
+
       # Returns path, filename, and an array of arguments. It is an error if
       # the file can't be found unless #optional is true. In that case a nil
       # value is returned
@@ -132,7 +155,7 @@ module Prick
           args = expand_string(rest || '').split
           path = expand_filename(dir, command)
           path || optional or 
-              raise Error, "Can't find file\n   #{command}\n   #{path}\n   in #{dir}/\n   from #{unit}"
+              raise Error, "Can't find file #{command} #{path} in #{dir}/ from #{unit}"
           !path.nil? or return nil
         else
           raise Error, "Not a file name: '#{entry}'"
@@ -141,6 +164,7 @@ module Prick
       end
 
       def parse_entry(unit, phase, dir, entry)
+#       puts "#parse_entry(#{unit.inspect}, #{phase.inspect}, #{dir.inspect}, #{entry.inspect})"
         if entry.is_a?(Hash)
           entry.size == 1 or raise Error, "sql and module are single-line values"
           key, value = entry.first
@@ -175,7 +199,9 @@ module Prick
                 SqlNode.new(unit, phase, path)
               when /\.fox$/
                 FoxNode.new(unit, :seed, path)
-              when /build-.*\.yml$/
+              when /(?:^|\/)build-.*\.yml$/
+                parse_build_file(unit, dir, path)
+              when /(?:^|\/)build.yml$/ # Only used when building a single file
                 parse_build_file(unit, dir, path)
             else
               raise Error, "Expected executable, fox, or sql file: #{File.basename(path)} in #{dir}"

data/lib/prick/environment.rb

@@ -245,13 +245,12 @@ module Prick
           case types[ident]
             when "BOOLEAN"
               [TrueClass, FalseClass].include?(value.class) or raise "Illegal value for #{ident}: #{value}"
-              ;
             when "STRING"
               ; # nop
             when "LIST"
               value = value&.split || []
             when "TEXT"
-              value = value.chomp
+              value = (value == false ? "false" : value.chomp)
             when nil
               ShellOpts.error "Unknown variable '#{ident}'"
           else

data/lib/prick/state.rb

@@ -14,6 +14,9 @@ module Prick
     # directory through the -C option or the 'init' command
     def prick_dir() @prick_dir ||= Dir.getwd end
 
+    # Prick schema dir
+    def schema_dir() @schema_dir ||= File.join(prick_dir, SCHEMA_DIR) end
+
     # Project file. Default 'prick.yml'
     attr_reader :project_file
 
@@ -186,7 +189,7 @@ module Prick
         hash.merge!({
           "DATABASE" =>  Prick.state.database, # FIXME: Yt
           "USERNAME" =>  Prick.state.username, # FIXME: Yt
-          "ENVIRONMENT" =>  Prick.state.environment.to_s, # FIXME: Yt
+          "ENVIRONMENT" =>  Prick.state.environment.to_s, # FIXME: Yt except in build.yml parser
           "PRICK_NAME" => Prick.state.name,
           "PRICK_TITLE" => Prick.state.title,
           "PRICK_VERSION" => Prick.state.version,

data/lib/prick/subcommand/prick-build.rb

@@ -5,7 +5,8 @@ require_relative '../builder/builder.rb'
 module Prick::SubCommand
   def self.build(
       database, username, schema, 
-      builddir: "schema", force: false, 
+      builddir: Prick.state.schema_dir, 
+      force: false, # Build all schemas
       timer: nil, dump: nil)
 
     Timer.on! if timer
@@ -49,8 +50,8 @@ module Prick::SubCommand
               # Remove keep-schemas from list of schemas
               refresh_schemas -= keep_schemas
 
-              # Also remove keep-schemas from the build pool. Why don't we use
-              # the pool tracker's list of keep schemas?
+              # Also remove keep-schemas from the build pool. TODO Why don't we
+              # use the pool tracker's list of keep schemas?
               builder.pool.delete_schema(keep_schemas)
 
               # Drop refresh schemes

data/lib/prick/subcommand/prick-make.rb

@@ -5,7 +5,7 @@ require_relative '../builder/builder.rb'
 module Prick::SubCommand
   def self.make(database, username, schema, timer: nil, dump: nil)
     Timer.on! if timer
-    time "Prick::Command#make" do
+    Timer.time "Prick::Command#make" do
       begin
         super_conn = State.connection
         conn = nil
@@ -14,7 +14,7 @@ module Prick::SubCommand
         clean = false
         create_schemas = []
 
-        time "Load build object" do
+        Timer.time "Load build object" do
           if super_conn.rdbms.exist? database
             conn = Prick.state.connection
             if conn.schema.exist_relation?("prick", "versions") && !conn.empty?("prick.versions")
@@ -43,7 +43,7 @@ module Prick::SubCommand
             after_schemas.each { |delete_schema| builder.pool.delete_schema(delete_schema) }
           end
 
-          touched_nodes = builder.nodes.select { |node| File.mtime(node.path) > last_built_at }
+          touched_nodes = builder.nodes.select { |node| last_built_at.nil? || File.mtime(node.path) > last_built_at }
           touched_phases = touched_nodes.map(&:phase).uniq.compact
           touched_kinds = touched_nodes.map(&:kind).uniq.compact
           touched_schema = touched_nodes.first&.schema
@@ -78,7 +78,7 @@ module Prick::SubCommand
         end
         exit if dump
 
-        time "Execute build object" do
+        Timer.time "Execute build object" do
           builder.execute(conn, create_schemas: create_schemas)
         end
 

data/lib/prick/subcommand/prick-run.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+
+require_relative '../builder/builder.rb'
+
+module Prick::SubCommand
+  def self.run(database, username, path, timer: nil, dump: nil, schema: nil)
+
+    Timer.on! if timer
+
+    Timer.time "Prick::Command#build" do
+      begin
+        super_conn = State.connection # Used to create new databases (doesn't make a
+                                      # difference right now as the database user is
+                                      # a superuser anyway
+        conn = nil
+        builder = nil
+
+        constrain super_conn.rdbms.exist?(database), true # FIXME Same problem as below. Also in other commands
+
+        Timer.time "Load build object" do
+          if super_conn.rdbms.exist? database # FIXME Why create database? Setup should have done this
+            exist = true
+          else
+            super_conn.rdbms.create database, owner: username
+            exist = false
+          end
+          conn = Prick.state.connection
+
+          # Parse
+          builder = Prick::Build::Builder.new(conn, path, single: true)
+
+          # Register if a build file is referenced and normalize path to
+          # include build.yml of directories
+          if File.directory?(path)
+            path = File.join(path, "build.yml")
+            is_build_file = true
+          elsif File.basename(path) == "build.yml"
+            is_build_file = true
+          else
+            is_build_file = false
+          end
+        
+          # Read schema from build file if possible and decide if schema should
+          # be dropped beforehand
+          if is_build_file
+            pool = builder.pool
+            build_node = pool.all_nodes.first
+            if build_node.has_schema
+              !schema or Prick.error "Can't use --schema when doing a schema build"
+              is_schema_rebuild = true
+              schema = build_node.schema
+            else
+              is_schema_rebuild = false
+            end
+          else
+            is_schema_rebuild = false
+          end
+
+          # Infer schema from path
+          if !schema
+            abspath = File.realpath(path)
+            schemapath = File.realpath(Prick.state.schema_dir)
+            if abspath =~ /^#{schemapath}\/([^\/]+)(?:\/.*)$/
+              schema = $1
+            else
+              Prick.error "Can't find schema" # No default schema to avoid unintended runs
+            end
+          end
+
+          # Drop schema if needed
+          if is_schema_rebuild
+            conn.schema.drop schema, cascade: true 
+          end
+
+          # Create schema if absent
+          if !conn.schema.exist?(schema)
+            conn.schema.create(schema)
+          end
+        end
+
+        case dump
+          when :nodes; builder.nodes.reject { |node| node.is_a?(Build::BuildNode) }.map &:dump
+          when :allnodes; builder.nodes.map &:dump
+          when :batches; builder.dump
+          when nil;
+        else
+          Prick.error "Illegal dump type: #{dump.inspect}"
+        end && exit
+
+        Timer.time "Execute build object" do
+          builder.execute conn
+        end
+
+      rescue Prick::Error => ex
+        $stderr.puts ex.message
+        exit 1
+
+      rescue ::Command::Error => ex
+        $stderr.puts ex.message
+        exit 1
+
+      ensure
+        super_conn&.terminate
+        conn&.terminate
+      end
+    end
+  end
+end
+

data/lib/prick/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prick
-  VERSION = "0.33.0"
+  VERSION = "0.34.0"
 end

data/lib/prick.rb

@@ -50,6 +50,7 @@ require_relative 'prick/subcommand/prick-list.rb'
 require_relative 'prick/subcommand/prick-make.rb'
 require_relative 'prick/subcommand/prick-migrate.rb'
 require_relative 'prick/subcommand/prick-release.rb'
+require_relative 'prick/subcommand/prick-run.rb'
 require_relative 'prick/subcommand/prick-set.rb'
 require_relative 'prick/subcommand/prick-setup.rb'
 require_relative 'prick/subcommand/prick-teardown.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prick
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic
@@ -230,6 +230,7 @@ files:
 - lib/prick/subcommand/prick-make.rb
 - lib/prick/subcommand/prick-migrate.rb
 - lib/prick/subcommand/prick-release.rb
+- lib/prick/subcommand/prick-run.rb
 - lib/prick/subcommand/prick-set.rb
 - lib/prick/subcommand/prick-setup.rb
 - lib/prick/subcommand/prick-teardown.rb