prick 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb7c2d20ea8aa16ba957f5139e00b02eec90d92a16316d9a468b97df7f83bc93
-  data.tar.gz: 6c2a0acd245344a1bb302aede789bb964757462786aebdc5fec14ea33f43e42f
+  metadata.gz: 98dae1ae969be39dba2d394c5ef973837bddd75b57e95a50984369b9b63b68a9
+  data.tar.gz: 2d346ef2b8b6ea0bde7c6a0442278f9c9a3132a8268555417790f7cd5f45a936
 SHA512:
-  metadata.gz: 4d350899a5591bc2c6b8d2b6f88948ddf39a6146a535411c1affccf3f5f32dcee4ccb8b30ea0e19060d7bc6a6d1c21064ae10dacf9f19aa3997d04fd2466c892
-  data.tar.gz: fad2bbb8a50f18c779160bc17308072a94fd4ca98b1db76c3c16724eafe1c4128c4df4b0485051a136a19cf0315daff9b19dd4035dfe54cdbf624376c7c3c4c4
+  metadata.gz: fe461c8c031c7279cdd53329b92808a92367939841d30c4e7a995ae2c42e089fbdf0c8e143beef9997512bb94dc0b2c838df83d8990b545a27dec1ab94e0f3ba
+  data.tar.gz: 03cd1324f95be8e3672cc0e1a05e1818c287d62e786a4ac27eebf42d9f71151766d7002f1f19de0c1f44b86568797e80d96e6209103661ba1d4cb8132d959ca8

data/.gitignore

@@ -24,3 +24,6 @@
 
 # Ignore development testing dir
 /dir
+
+# Ignore stove-away directory
+/hold

data/TODO

@@ -1,3 +1,10 @@
 
+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
 

data/exe/prick

@@ -4,180 +4,163 @@ require 'prick.rb'
 require 'prick/program.rb'
 
 require 'shellopts'
-require 'indented_io'
 
 require 'tempfile'
 
 include ShellOpts
 include Prick
 
-PROGRAM = File.basename($0)
-
 SPEC = %(
-  n,name=NAME
-  C,directory=DIR
-  h,help
-  v,verbose
-  q,quiet
-  version
+  -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
+  -C,directory=DIR
+      Change to directory DIR before doing anything else
 
-  info!
-  list! list.releases! m,migrations c,cancelled list.migrations! list.upgrades! a,all
+  -h,help COMMAND...
+      Print this page
 
-  build! d,database=DATABASE C,nocache
-  make!
-  load! d,database=DATABASE
-  save! d,database=DATABASE
-  migrate!
+  +v,verbose
+      Be verbose. Repeated --verbose options increase the verbosity level
 
-  prepare! prepare.release! prepare.migration! prepare.schema! prepare.diff!
-  include! include.feature!
-  check!
+  -q,quiet
+      Be quiet
 
-  create! create.release! create.prerelease! create.feature!
-  cancel! cancel.release!
+  --version
+      Print prick version
 
-  upgrade!
-  backup!
-  restore!
-)
+  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
 
-USAGE = "Usage: #{PROGRAM} -h -v -n NAME -C DIR COMMAND" # FIXME: Why doesn't shellopts include PROGRAM?
+  info!
+      Print project information
 
-HELP = %(
-  NAME
-    prick - Database version management
+  list.releases! -m,migrations -c,cancelled 
+      List releases. Include migration releases if the --migration option is
+      present and also include cancelled releases if the --cancelled option is
+      present
 
-  USAGE
-    prick -v -n NAME -C DIR -h <command>
+  list.migrations! 
+      List migrations
 
-  OPTIONS
-    -n, --name=NAME
-      Name of project. Defauls to the environment variable `PRICK_PROJECT` if
-      set and else the name of the current directory
+  list.upgrades! [FROM [TO]]
+      List available upgrades
 
-    -C, --directory=DIR
-      Change to directory DIR before anything else
+  list.cache!
+      List cache files
 
-    -h, --help
-      Print this page
+  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
 
-    -v, --verbose
-      Be verbose
+  make! -d,database=DATABASE -C,no-cache [TAG]
+      Build the current database from the content in the schemas/ directory.
+      With a tag the associated versioned database is loaded from cache if
+      present. The -C option ignores the cache and the -d option overrides
+      the default database
 
-    --version
-      Print prick version
+  make.clean! -a,all
+      Drop versioned databases and remove cached and other temporary files.
+      Also drop the project database if the -a option is given
 
-  COMMANDS
-    INITIALIZATION
-      init [DIR] --user=USER
-        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
+  load! -d,database=DATABASE VERSION|FILE
+      Load the cached version or the file into the associated versioned
+      database. It is an error if the version hasn't been cached. The --database 
+      argument overrides the database
 
-    INFO COMMANDS
-      info
+  save! VERSION [FILE]
+      Save the versioned database associated with version to the cache or the
+      given file
 
-      list releases --migrations --cancelled
-      list migrations
-      list upgrades --all
-        List releases/migrations/upgrades
+  drop! -a,all [DATABASE]
+      Drop the given database or all versioned databases. The --all option also
+      drops the project database
 
-    BUILDING
-      build -d database -C --nocache [version]
-        Builds the current database from the content in the schemas/ directory.
-        With an explicit version the given version is built or loaded from cache
-        into the associated versioned database. The -C argument force a build even
-        if a cache file is present. The -d option overrides the database
-
-      make
-        Not yet implemented
-  
-      load -d database file|version
-        Load a version or file into a database. If the argument is a version the
-        assocated versioned database will be loaded from cache. If the argument is
-        a file the project database is loaded. The -d option overrides what
-        database is used. This is often used to load a specific version into the
-        project database ('prick load -d <project-name> <version>') or to load into
-        an unrelated database not controlled by prick
-
-      save -d database [file]
-        Save the project database to the given file. Default file name is the
-        username suffixed with project name, custom name, and branch
+  diff! -m,mark -t,tables -T,notables
+      diff [FROM-DATABASE|FROM-VERSION [TO-DATABASE|TO-VERSION]]
+      Create a schema diff between the given databases or versions. Default
+      to-version is the current schema and default from-version is the base
+      version of this branch/tag
 
-      migrate
-        Not yet implemented
+  migrate!
+      Not yet implemented
 
-    PREPARING RELEASES
-      prepare release
-        Populate the current migration directory with migration files
+  prepare! 
+      Prepare a release. Just a shorthand for 'prick prepare release'
 
-      prepare feature NAME
-        Create and populate a feature as a subdirectory of the current
-        directory. Also prepares the current release directory
+  prepare.release! [FORK]
+      Populate the current migration directory with migration files
 
-      prepare migration FROM
-        Create and populate a migration directory
+  prepare.feature! NAME
+      Create and populate a feature as a subdirectory of the current directory.
+      Also prepares the current release directory
 
-      prepare schema NAME
-        Create and populate a new schema directory. Existing files and
-        directories are kept
+  prepare.migration! [FROM]
+      Create and populate a migration directory
 
-      prepare diff [VERSION]
+  prepare.schema! NAME
+      Create and populate a new schema directory. Existing files and
+      directories are kept
+    
+  prepare.diff! [VERSION]
+      Not yet implemented
 
-      include feature FEATURE
-        Include the given feature in the current pre-release
+  include.feature! FEATURE
+      Include the given feature in the current pre-release
 
-      check
-        Check that the current migration applied to the base version yields the
-        same result as loading the current schema
+  check!
+      Check that the current migration applied to the base version yields the
+      same result as loading the current schema
 
-    CREATING RELEASES
-      create release [RELEASE]
-        Prepare a release and create release directory and migration file
-        before tagging and branching to a release branch. The RELEASE argument
-        can be left out if the current branch is a prerelease branch
+  create.release! [RELEASE]
+      Prepare a release and create release directory and migration file before
+      tagging and branching to a release branch. The RELEASE argument can be
+      left out if the current branch is a prerelease branch
 
-      create prerelease RELEASE
-        Prepare a release and create release directory and migration file
-        before branching to a prerelease branch
-        
-      create feature NAME
-        Prepare a feature before branching to a feature branch
+  create.prerelease! RELEASE
+      Prepare a release and create release directory and migration file before
+      branching to a prerelease branch
 
-      cancel release RELEASE
-        Cancel a release. Since tags are immutable, the release is cancelled by
-        added a special cancel-tag to the release that makes prick ignore it
+  create.feature! NAME
+      Prepare a feature before branching to a feature branch
 
-    DEPLOYING RELEASES
-      upgrade
-        Migrate the database to match the current schema
+  cancel! 
+      Cancel a release. Just a shorthand for 'prick cancel release'
+  
+  cancel.release!
+      Cancel a release. Since tags are immutable, the release is cancelled by
+      added a special cancel-tag to the release that makes prick ignore it
 
-      backup [FILE]
-        Saves a backup of the database to the given file or to the var/spool
-        directory
+  generate.migration! 
+      Create a script to migrate the database
 
-      restore [FILE]
-        Restore the database from the given backup file or from the latest
-        backup in the var/spool directory
+  generate.schema!
+      Create a script to create the database
+
+  upgrade!
+      Migrate the database to match the current schema
+
+  backup! [FILE]
+      Saves a backup of the database to the given file or to the var/spool
+      directory
+    
+  restore! [FILE]
+      Restore the database from the given backup file or from the latest backup
+      in the var/spool directory
 )
 
 
-opts, args = ShellOpts.as_struct(SPEC, ARGV)
+
+opts, args = ShellOpts.process(SPEC, ARGV)
 
 # Handle --help
-if opts.help? 
-  begin 
-    file = Tempfile.new("prick") 
-    file.puts HELP.split("\n").map { |l| l.sub(/^  /, "") } 
-    file.flush 
-    system "less #{file.path}" 
-  ensure 
-    file.close 
-  end 
-  exit 
+if opts.help?
+  ShellOpts.help
+  exit
 end 
 
 # Handle --version
@@ -188,7 +171,7 @@ end
 
 begin
   # Honor -C option
-  if opts.directory
+  if opts.directory?
     if File.exist?(opts.directory)
       begin
         Dir.chdir(opts.directory)
@@ -206,9 +189,9 @@ begin
   # Handle init command
   if opts.subcommand == :init
     directory = args.expect(0..1)
-    name = opts.name || directory || File.basename(Dir.getwd)
-    user = opts.init.user || name
-    program.initialize_directory(name, user, directory || ".")
+    name = opts.name || (directory && File.basename(directory)) || File.basename(Dir.getwd)
+    user = opts.init!.user || name
+    program.init(name, user, directory || ".")
     exit 0
   end
 
@@ -218,51 +201,77 @@ begin
   VERSION == file.read.to_s or 
       raise Prick::Fail, ".prick-version required prick-#{file.read} but you're using prick-#{VERSION}"
 
+  # TODO: Check for dirty detached head
+
   # Expect a sub-command
-  opts.subcommand? or raise Prick::Error, "Subcomand expected"
+  opts.subcommand or raise Prick::Error, "Subcomand expected"
 
   case opts.subcommand
     when :info
       args.expect(0)
       program.info
 
-    when :build
-      version = args.expect(0..1)
-      program.build(opts.build.database, version, opts.build.nocache)
-
-    when :save
-      file_or_version = args.expect(0..1)
-      program.save(opts.save.database, file_or_version)
-
-    when :load
-      file_or_version = args.expect(1)
-      program.load(opts.load.database, file_or_version)
-
-    when :make
-      raise NotYet
-
-    when :migrate
-      raise NotYet
-
     when :list
-      command = opts.list
+      command = opts.list!
       case command.subcommand
         when :releases;
-          obj = command.releases
+          obj = command.releases!
           program.list_releases(migrations: obj.migrations?, cancelled: obj.cancelled?)
         when :migrations; program.list_migrations
         when :upgrades; program.list_upgrades(*args.expect(0..2).compact)
+        when :cache; 
+          args.expect(0)
+          program.list_cache
         when NilClass; raise Prick::Error, "list requires a releases|migrations|upgrades sub-command"
       else
         raise Prick::Internal, "Subcommand #{opts.subcommand}.#{command.subcommand} is not matched"
       end
 
+    when :build
+      version = args.expect(0..1)
+      program.build(opts.build!.database, version, opts.build!.no_cache?)
+
+    when :make
+      command = opts.make!
+      case command.subcommand
+        when :clean
+          args.expect(0)
+          program.make_clean(command.clean!.all?)
+        else
+          version = args.expect(0..1)
+          program.make(opts.make!.database, version, opts.make!.no_cache?)
+      end
+
+    when :load
+      version_or_file = args.expect(1)
+      program.load(opts.load!.database, version_or_file)
+
+    when :save
+      version, file = args.expect(1..2)
+      program.save(version, file)
+
+    when :drop
+      program.drop(args.expect(0..1), opts.drop!.all)
+
+    when :diff
+      mark = opts.diff!.mark
+      tables = opts.diff!.tables
+      no_tables = opts.diff!.notables
+      tables.nil? && no_tables.nil? || tables ^ no_tables or
+          raise Error, "--tables and --no-tables options are exclusive"
+      select = tables ? :tables : (no_tables ? :no_tables : :all)
+      from, to = args.expect(0..2)
+      program.diff(from, to, mark, select)
+
+    when :migrate
+      raise NotYet
+
     when :prepare
-      cmd = opts.prepare.subcommand || :release
+      cmd = opts.prepare!.subcommand || :release
       case cmd
-        when :release; args.expect(0); program.prepare_release
-        when :feature; raise NotYet
-        when :migration; program.prepare_migration(args.expect(1))
+        when :release; program.prepare_release(args.expect(0..1))
+        when :feature; program.prepare_feature(args.expect(1))
+        when :migration; program.prepare_migration(args.expect(0..1))
         when :schema; program.prepare_schema(args.expect(1))
         when :diff; program.prepare_diff(args.expect(0..1))
       else
@@ -270,7 +279,7 @@ begin
       end
 
     when :include
-      cmd = opts.include.subcommand || :feature
+      cmd = opts.include!.subcommand || :feature
       case cmd
         when :feature; program.include_feature(args.expect(1))
       else
@@ -282,7 +291,7 @@ begin
       program.check
 
     when :create
-      cmd = opts.create.subcommand || :release
+      cmd = opts.create!.subcommand || :release
       case cmd
         when :release; program.create_release(args.expect(0..1))
         when :prerelease; program.create_prerelease(args.expect(0..1))
@@ -292,10 +301,20 @@ begin
       end
 
     when :cancel
-      cmd = opts.cancel.subcommand
+      cmd = opts.cancel!.subcommand
       case cmd
         when :release; program.cancel_release(args.expect(1))
-        when nil; raise Prick::Error, "'cancel' subcommand require a release argument"
+        when nil; raise Prick::Error, "'cancel' subcommand requires a release argument"
+      else
+        raise Prick::Internal, "Subcommand #{opts.subcommand}.#{cmd} is not matched"
+      end
+
+    when :generate
+      cmd = opts.generate!.subcommand
+      case cmd
+        when :schema; program.generate_schema
+        when :migration; program.generate_migration
+        when nil; raise Prick::Error, "'generate' subcommand requires a 'schema' or 'migration' argument"
       else
         raise Prick::Internal, "Subcommand #{opts.subcommand}.#{cmd} is not matched"
       end
@@ -319,3 +338,56 @@ rescue Prick::Error => ex
   ShellOpts.error(ex.message)
 end
 
+__END__
+
+# Awaits support for sections in ShellOpts
+HELP = %(
+  OPTIONS
+    -n, --name=NAME
+    -C, --directory=DIR
+    -h, --help
+    -v, --verbose
+    --version
+
+  COMMANDS
+    INITIALIZATION
+      init --user=USER [DIR]
+
+    INFO COMMANDS
+      info
+      list releases --migrations --cancelled
+      list migrations
+      list upgrades --all
+
+    BUILDING
+      build -d DATABASE -C --nocache [TAG]
+      make -d DATABASE -C --nocache [TAG]
+      make clean -a
+      load -d DATABASE VERSION|FILE
+      save VERSION [FILE]
+      drop --all [DATABASE]
+      diff [FROM-DATABASE|FROM-VERSION [TO-DATABASE|TO-VERSION]]
+      migrate
+
+    PREPARING RELEASES
+      prepare release [FORK]
+      prepare feature NAME
+      prepare migration FROM
+      prepare schema NAME
+      prepare diff [VERSION]
+      include feature FEATURE
+      check
+
+    CREATING RELEASES
+      create release [RELEASE]
+      create prerelease RELEASE
+      create feature NAME
+      cancel release RELEASE
+
+    DEPLOYING RELEASES
+      generate migration
+      generate schema
+      upgrade
+      backup [FILE]
+      restore [FILE]
+)