prick 0.18.0 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22580f7a2f37e4ad59c6354e3b6ac1d7bb6f5eb7fe8f44eddb941ba715f8fa39
-  data.tar.gz: b0b5bf43389a0e35c6a739b92b4e50b043cb75ab1e215aa109a9a68e4f17e1e3
+  metadata.gz: d2e1267bf396eabebb1624b55e9e56c187aa687cd8946a5b40a2ab131a1325ab
+  data.tar.gz: 574a439204413e074b1a21e4458d097e44d6f4a9cacb225942dea0bd9e6c2150
 SHA512:
-  metadata.gz: 7768a47145ae07f6ae99e808ad513107ccd98327fc009311cd0bfde1f1dbd3a52a3d9f5061c6bb3918b12da6850b0cf4e5242efade679d950a603047c8dd9cfc
-  data.tar.gz: e2709800fe62d599bba1ea64960b4a09e8a97a87da3d60731e8293f4957c9ac35147122dea16220481b9c49b17d3cf31377663f1328b99608c0fc3cc84ca4ad9
+  metadata.gz: cf5bef7facd1ea27f82ec70b458db18ed09025b21482ba3271f209387e2b4ff656ece67679748f98a9c86dd2633f8e66a94dbbcb28917595781ccd6a5ff1b700
+  data.tar.gz: 437a136ec48f2e952a76b723529e121a13bebde0879fa4743c1f776680b5fcf5d12d12d09e516e062642089efbe3ddadcc5f9cf36de4aa05969a004f13f6f8b5

data/Gemfile

@@ -1,9 +1,15 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/clrgit/#{repo_name}" }
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in prick.gemspec
+# Specify your gem's dependencies in prick_build.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
+
+gem 'shellopts', :github => 'clrgit/shellopts', branch: "master"
+gem 'pg_graph', :github => 'clrgit/pg_graph', branch: "master"
+gem 'pg_meta', :github => 'clrgit/pg_meta', branch: "master"
+gem 'pg_conn', :github => 'clrgit/pg_conn', branch: "master"
+

data/README.md

@@ -1,6 +1,6 @@
-# Prick
+# PrickBuild
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/prick`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/prick_build`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 TODO: Delete this and the text above, and describe your gem
 
@@ -9,16 +9,16 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'prick'
+gem 'prick_build'
 ```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
-    $ gem install prick
+    $ gem install prick_build
 
 ## Usage
 
@@ -28,8 +28,8 @@ TODO: Write usage instructions here
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/prick.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/prick_build.

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/TODO

@@ -1,13 +1,15 @@
 
-o Add a top-level 'global' directory for stuff that doesn't belong to a schema or that 
-  require superuser privileges. prick-build should then execute the content of that
-  directory first before switching to the database user
-o Check for commits to tags
-o Accumulate version history in prick.versions instead of just having the newest
-o Using rc's in migration syntax: fork-version-fork-version.rc1 ?
-o Make it possible to execute prick in any subdirecty instead of only in the root
-o Hack migra to create separate file(s) for table changes
-o Also execute subject/ directory if only a subject.sql is found. subject.yml
-  should still override everything
-o Track included files - this will make dependency checks much easier
+o Store fox.state, reflections, and reflections in the database so third-party
+  programs can use them when testing
+o 'prick make <resource>' should build everything up the resource, then commit
+  before trying to build the resource upon the database. Then it is easy to
+  re-run the failed (sql-)script in psql to see why it failed
+o 'prick make' should build everything up a touched file, then commit before
+  proceeding
+o Build functions after schema so that there are no order dependencies on
+  functions. Problem is to detect function files
+o Build views after schema so that there are no order dependencies on
+  views. Problem is to detect view files
 
++ prick release major|minor|patch
++ Check modification time of build.yml files too

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
-require "prick"
+require "prick_build"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/doc/build-yml.txt

@@ -0,0 +1,14 @@
+
+Format
+
+---
+- schema: schema-name
+- file
+- seed: file
+- seed:
+    - file
+    - file
+- schema_init: file
+- schema_term: file
+- init: file
+- term: file

data/exe/prick

@@ -1,38 +1,250 @@
 #!/usr/bin/env ruby
 
-require 'prick.rb'
-require 'prick/program.rb'
+#$LOAD_PATH.unshift "/home/clr/prj/shellopts/lib"
 
-require 'shellopts'
+require 'bootsnap'
+begin
+  cache_dir = "/run/user/" + `id -u`.chomp
+  Bootsnap.setup(
+    cache_dir:            cache_dir,            # Path to your cache
+    development_mode:     true,                 # Current working environment, e.g. RACK_ENV, RAILS_ENV, etc
+    load_path_cache:      true,                 # Optimize the LOAD_PATH with a cache
+    compile_cache_iseq:   true,                 # Compile Ruby code into ISeq cache, breaks coverage reporting.
+    compile_cache_yaml:   true                  # Compile YAML into a cache
+  )
+  Bootsnap.instrumentation = ->(event, path) { puts "#{event} #{path}" }
+end
 
-require 'tempfile'
+require 'prick.rb'
+require 'shellopts'
 
 include ShellOpts
 include Prick
 
-SPEC = %(
-  -n,name=NAME
-      Name of project. Defauls to the environment variable `PRICK_PROJECT` if
-      set and else the name of the current directory
-
-  -C,directory=DIR
-      Change to directory DIR before doing anything else
+TIME = false
 
-  -h,help COMMAND...
-      Print this page
+SPEC = %(
+  @ Prick project command
 
   +v,verbose
-      Be verbose. Repeated --verbose options increase the verbosity level
+      Be verbose. Repeated -v options increase the verbosity level
 
   -q,quiet
       Be quiet
 
-  --version
-      Print prick version
+  -C,directory=EDIR
+      Change to directory DIR before doing anything else
+
+  -d,database=DATABASE
+      Override database name from prick.yml
+
+  -U,username=USERNAME
+      Override username from from prick.yml
+
+  version!
+      Print project version
+
+  init! -n,name=NAME -t,title=TITLE [DIRECTORY]
+      Initializes a prick project
+
+  setup!
+      Create the database user (if necessary) and an empty database
+
+  teardown!
+      Drop the database and the database user. TODO: Also run teardown scripts
+
+  create.data!
+  create.schema!
+  create.database!
+  create.users!
+  create.all!
+      Create an object. Fails if migration exist unless the --force flag is given
+
+  create.migration! -f,force -o,file=FILE -- VERSION
+      Create a migration from VERSION to the current and write it to
+      migration/VERSION. Fails if migration exist unless the --force flag is
+      given. If --file is given, the migration is written to FILE instead of
+      the migration directory. This doesn't require you to be on a release
+      branch and can be used to create ad-hoc migration scripts
+
+  drop! -- [KIND]
+      @ Drop objects
+
+      Kind can be 'users', 'data', 'schema', 'database' (the default), or 'all'. It is
+      not an error if the object doesn't exist. TODO Only 'users' is currently defined
+
+  build! -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)
+
+  make! -t,time --dump=KIND? -- [SCHEMA]
+      @ Only rebuild changed files
+
+      Checks file timestamps against the time of the last build and only
+      rebuild affected parts of the project. KIND can be 'nodes', 'allnodes' or
+      'batches' (the default)
+
+  fox! -- FILE...
+      Load fox file data. Data are reset to their initial state after build
+      before the fox data are loaded
+
+  release! -- KIND
+      Create a release of the given kind. KIND can be 'major', 'minor', or
+      'patch'. Release checks that the current repo is clean and up to date
+      with the origin
+
+  migrate! -f,file=FILE
+      Execute a migration
+
+  dump.type!
+  dump.data!
+  dump.schema!
+  dump.database!
+      TODO
+
+  dump.migration! --force -- VERSION
+)
+
+opts, args = ShellOpts.process(SPEC, ARGV, exception: true)
+
+begin
+  # Handle verbose and quiet
+  $verbose = opts.verbose
+  $quiet = opts.quiet?
+
+  # Honor -C option
+  if opts.directory?
+    if File.exist?(opts.directory)
+      begin
+        Dir.chdir(opts.directory)
+      rescue Errno::ENOENT
+        raise Prick::Error, "Can't cd to '#{opts.directory}'"
+      end
+    else
+      raise Prick::Error, "Can't find directory: #{opts.directory}"
+    end
+  end
+
+  # Get subcommand
+  cmd = opts.subcommand!
+
+  # Process init command
+  if opts.subcommand == :init
+    dir, state = Prick::SubCommand.init(args.expect(0..1), cmd.name, cmd.title, opts.database, opts.username)
+    puts "Initialized prick project '#{state.name}' in #{dir}"
+    if opts.database.nil? || opts.username.nil?
+      puts
+      puts "Please check database/username in #{PRICK_CONTEXT_FILE}"
+    end
+    exit
+  end
+
+  # Check state
+  File.exist?(PRICK_PROJECT_FILE) or raise Prick::Error, "Not in a prick project directory"
+
+  # Load state
+  Prick.state = State.load
+
+  # Handle -d and -U options
+  database = opts.database || Prick.state.database
+  username = opts.username || Prick.state.username
+    
+  # Expect a sub-command
+  cmd = opts.subcommand! or raise Prick::Error, "Subcomand expected"
+
+  # Process subcommands
+  case opts.subcommand
+    when :version!
+      puts "#{Prick.state.name}-#{Prick.state.version}"
+
+    when :setup!
+      Prick::SubCommand.setup(database, username)
+
+    when :teardown!
+      Prick::SubCommand.teardown(database, username)
+
+    when :create!
+      create_command = opts.create!
+      case create_command.subcommand
+        when :migration
+          arg = args.expect(1)
+          version = PrickVersion.try(arg) or raise Prick::Error, "Illegal version: #{arg}"
+          Prick::SubCommand.create_migration(
+              username, version, 
+              force: create_command.subcommand!.force?, 
+              file: create_command.subcommand!.file)
+        else
+          raise NotImplementedError
+      end
+
+    when :build!
+      dump = cmd.dump? ? cmd.dump("batches").to_sym : nil
+      Prick::SubCommand.build(database, username, args.expect(0..1), timer: cmd.time?, dump: dump)
+
+    when :make!
+      dump = cmd.dump? ? cmd.dump("batches").to_sym : nil
+      Prick::SubCommand.make(database, username, args.expect(0..1), timer: cmd.time?, dump: dump)
+
+    when :fox!
+      Prick::SubCommand.fox(database, username, args)
+
+    when :drop!
+      case subject = args.expect(1).to_sym
+        when :all
+          Prick::SubCommand.drop_all(database)
+        when :users
+          Prick::SubCommand.drop_users(database)
+        when :database
+          Prick::SubCommand.drop_database(database)
+        when :data, :schema, :database, :all
+          raise NotImplementedError
+      else
+        raise Prick::Error, "Unknown subject: #{subject}"
+      end
+
+    when :release!
+      kind = args.expect(1).to_sym
+      constrain? kind, :major, :minor, :patch or 
+          raise Prick::Fail, "Expected 'major', 'minor', or 'patch' argument, got '#{kind}'"
+      Prick::SubCommand.release(kind)
+
+    when :migrate!
+      args.expect(0)
+      Prick::SubCommand.migrate(database, username, file: cmd.file)
+
+    when :dump!
+      subject = cmd.subcommand!
+      case cmd.subcommand
+        when :migration
+          arg = args.expect(1)
+          version = PrickVersion.try(arg) or raise "Illegal version number: #{arg}"
+          Prick::SubCommand.create_migration(username, version, force: subject.force?, file: "/dev/stdout")
+        when :data, :schema, :database
+          raise NotImplementedError
+      else
+        raise Prick::Error, "Unknown subject: #{subject.inspect}"
+      end
+
+    else
+      raise Prick::Fail, "Internal error: Unhandled command - #{opts.subcommand.inspect}"
+  end
+
+rescue ShellOpts::Failure, Prick::Fail, Prick::Build::PostgresError => ex 
+  ShellOpts.failure(ex.message)
+
+rescue ShellOpts::Error, Prick::Error => ex
+  ShellOpts.error(ex.message)
+end
+
+__END__
+
+  -n,name=NAME
+      Name of project. Defauls to the environment variable `PRICK_PROJECT` if
+      set and else the name of the current directory
 
-  init! -u,user=USER [DIR]
-      Initialize a project in the given directory. DIR defaults to the current
-      directory. The USER is the postgres user, it defaults to the project name
+  init! -u,user=USER [NAME]
+      Initialize a project in the given directory. The USER is the postgres
+      user and defaults to the project name
 
   info!
       Print project information
@@ -51,11 +263,13 @@ SPEC = %(
   list.cache!
       List cache files
 
-  build! -d,database=DATABASE -C,no-cache [TAG]
-      Build the current database from the content in the schemas/ directory.
-      With a tag the version is built into the associated versioned database
-      and the result is saved to cache unless the -C option is given. The -d
-      option overrides the default database
+  build! -d,database=DATABASE -s,state=FILE -C,no-cache [TAG]
+      Drop all users associated with the database before building the current
+      database from the content in the schemas/ directory.  With a tag the
+      version is built into the associated versioned database and the result is
+      saved to cache unless the -C option is given. The -d option overrides the
+      default database and the -s option overrides the default state file
+      (fox.state)
 
   make! -d,database=DATABASE -C,no-cache [TAG]
       Build the current database from the content in the schemas/ directory.
@@ -77,8 +291,12 @@ SPEC = %(
       given file
 
   drop! -a,all [DATABASE]
-      Drop the given database or all versioned databases. The --all option also
-      drops the project database
+      Drop the given database or all versioned databases. Users with a username
+      on the form <database>__<username> are also dropped. The --all option
+      also drops the project database
+
+  drop.users! [DATABASE]
+      Drop users with a username on the form <database>__<username>
 
   diff! -m,mark -t,tables -T,notables
       diff [FROM-DATABASE|FROM-VERSION [TO-DATABASE|TO-VERSION]]
@@ -153,8 +371,15 @@ SPEC = %(
       in the var/spool directory
 )
 
+__END__
+  
+
+
 
 
+
+DEFAULT_STATE_FILE = "fox.state"
+
 opts, args = ShellOpts.process(SPEC, ARGV)
 
 # Handle --help
@@ -185,6 +410,7 @@ begin
 
   # Create program object
   program = Program.new(quiet: opts.quiet?, verbose: opts.verbose?)
+  $verbose = opts.verbose? ? opts.verbose : nil
 
   # Handle init command
   if opts.subcommand == :init
@@ -236,7 +462,9 @@ begin
 
     when :build
       version = args.expect(0..1)
-      program.build(opts.build!.database, version, opts.build!.no_cache?)
+      state_file = File.expand_path(opts.build!.state || DEFAULT_STATE_FILE)
+      FileUtils.rm_f(state_file)
+      program.build(opts.build!.database, version, state_file, opts.build!.no_cache?)
 
     when :make
       command = opts.make!
@@ -258,7 +486,15 @@ begin
       program.save(version, file)
 
     when :drop
-      program.drop(args.expect(0..1), opts.drop!.all?)
+      command = opts.drop!
+      case command.subcommand
+        when :users
+          database = args.extract(0..1) || program.project.database.name
+          args.expect(0)
+          program.drop_users(database)
+        else
+          program.drop(args.expect(0..1), opts.drop!.all?)
+      end
 
     when :diff
       mark = opts.diff!.mark

data/lib/builder/batch.rb

@@ -0,0 +1,147 @@
+module Prick
+  module Build
+    class BuildBatch
+      include Timer
+
+      attr_reader :builder
+      forward_to :builder, :conn
+
+      def kind() @nodes.first&.kind end
+      attr_reader :nodes
+
+      def initialize(builder) 
+        @builder = builder
+        @nodes = [] 
+      end
+
+      def execute(&block)
+        name = self.class.to_s.sub(/.*::/, "").split(/(?=[A-Z])/).map(&:downcase).join(" ")
+        time "Execute #{name} (nodes: #{nodes.size})" do
+          yield
+        end
+      end
+
+      def dump
+        puts kind.upcase
+        indent { nodes.each(&:dump) }
+      end
+    end
+
+    class SqlBatch < BuildBatch
+      def execute
+        super {
+          begin
+            sql = []
+            if nodes.first.is_a?(ExeNode)
+              time "Execute script" do
+                sql = [nodes.first.source]
+              end
+            end
+            conn.execute sql + nodes[sql.size..-1].map(&:source)
+
+          rescue PG::SyntaxError, PG::Error => ex 
+            error, line, pos = parse_pg_message(ex.message)
+            if line
+              if line < nodes.first.lines
+                node = nodes.first;
+              else
+                line -= nodes.first.lines
+                node = nodes[1..-1].find { |node|
+                  line -= 1
+                  if line < node.lines
+                    line -= 2
+                    true
+                  else
+                    line -= node.lines
+                    false
+                  end
+                }
+              end
+
+              if node.is_a?(SqlNode)
+                message = ["prick: #{error} in #{node.path}", line, pos].compact.join(":")
+              else
+                message = "prick: #{error} from #{node.path}"
+              end
+            else
+              raise
+            end
+            raise PostgresError.new(message)
+          end
+        }
+      end
+
+    private
+      # Returns [error, line, pos] tuple
+      def parse_pg_message(message)
+        message =~ /ERROR:\s*(.*?)\n(LINE (\d+): ).*?\n(\s*\^)/m or return nil
+        [$1, $3.to_i, $4.size - $2.size]
+      end
+    end
+
+    class ModuleBatch < BuildBatch
+      def execute
+        super { 
+          nodes.each { |node| 
+            sql = node&.call
+            conn.execute sql if sql 
+          }
+        }
+      end
+    end
+
+    class FoxBatch < BuildBatch
+      # Inlining Fox instead of using command line program as it saves some deciseconds
+      def execute
+        t_type = t_fox = t_exe = nil
+
+        super {
+          timer = Timer.new "Execute fox batch (nodes: #{nodes.size}, clean: #{builder.clean})"
+          t_type = Timer.new "  Load data model"
+
+          files = nodes.map(&:path)
+
+          # Load meta object
+          meta = PgMeta.new(conn)
+
+          # Create type object
+          type = PgGraph::Type.new(meta, builder.reflections_file)
+
+          t_type.stop
+          t_fox = Timer.new "  Parse files"
+
+          # Create fox object
+          fox = FixtureFox::Fox.new(type)
+
+          # Parse files
+          for file in files
+            source, lines = fox.tokenize(file)
+            fox.parse(source, lines)
+          end
+
+          # Analyze
+          fox.assign_types
+          fox.generate
+
+          # Dump state file
+          fox.write_state(FOX_STATE_PATH)
+
+          t_fox.stop
+          t_exe = Timer.new "  Execute SQL"
+
+          delete = builder.clean ? :none : :touched
+          begin
+            conn.execute fox.to_sql(format: :exec, delete: delete)
+            conn.execute "update prick.versions set built_at = now() at time zone 'UTC'"
+          rescue PG::SyntaxError, PG::Error => ex 
+            raise PostgresError, "prick: #{error} from #{node.path}"
+          end
+        }
+        t_type.emit
+        t_fox.emit
+        t_exe.emit
+      end
+    end
+  end
+end
+