enzyme 1.0.0.beta02 → 1.0.0.beta03

data/VERSION

@@ -1 +1 @@
-1.0.0.beta02
+1.0.0.beta03

data/lib/commands/config.rb

@@ -3,7 +3,7 @@ require 'enzyme'
 module Config extend self
 
   def run()
-    file = ['--global', '--organisation', '--project'].keep_if { |x| ARGV.delete(x) }.last.to_s[/[a-z]+$/] || nil
+    file = ARGV.delete((ARGV & ['--global', '--organisation', '--project']).first)
     ARGV.each { |x| raise UnknownOption.new(x) if x.start_with?("-") }
     key = ARGV.shift
     value = ARGV.shift
@@ -12,7 +12,7 @@ module Config extend self
     if file.nil?
       file = $system_settings.config.project.exists ? "project" : "global"
     else
-      file = file.to_s
+      file = file.to_s[/[a-z]+$/]
     end
 
     raise ConfigFileNotFound.new($system_settings.config[file].path) unless $system_settings.config[file].exists
@@ -24,20 +24,21 @@ module Config extend self
       puts "Set '#{key}' to '#{value}' in '#{path}'."
     else
       val = get(key, path)
-      if val.is_a?(Array) || val.is_a?(Hash)
+      if val.nil?
+        puts "<nil>"
+      elsif val.is_a?(Array) || val.is_a?(Hash)
         puts val.to_hash.to_yaml
       else
         puts val.to_s
       end
     end
-    puts
   end
 
   # Gets the value of a given setting.
   # - key: The setting to get.
   # - path: The path to the config file to get the setting from.
   def get(key, path)
-    s = file ? (YAML.load_file(path) || {}) : $settings
+    s = path ? (YAML.load_file(path) || {}) : $settings
     key.to_s.split('.').each do |o|
       return nil if s[o].nil?
       s = s[o]
@@ -82,17 +83,30 @@ end
 
 Enzyme.register('config', Config) do
   puts "#{$format.bold}SYNOPSIS#{$format.normal}"
-  puts '     enzyme config [<key> [<value> [--global]]]'
+  puts '       enzyme config [--global|--organisation|--project]'
+  puts '       enzyme config <key> [--global|--organisation|--project]'
+  puts '       enzyme config <key> <value> [--global|--organisation|--project]'
+  puts
+  puts "#{$format.bold}DESCRIPTION#{$format.normal}"
+  puts "       In its first form the config command dumps the settings."
+  puts
+  puts "       In its second form the config command prints the value of a given key."
+  puts
+  puts "       In its third form the config command sets the value of a given key."
   puts
   puts "#{$format.bold}EXAMPLES#{$format.normal}"
-  puts '     enzyme config user dave --global'
+  puts "        1. Get the value of the 'short_name' setting:"
+  puts
+  puts "               $ enzyme config short_name"
+  puts "               dave"
   puts
-  puts '     enzyme config user'
-  puts '     > dave'
+  puts "        2. Set the value of the 'short_name' setting:"
   puts
-  puts '     enzyme config project_name my_project'
+  puts "               $ enzyme config short_name jill"
+  puts "               Set 'short_name' to 'jill' in '/Users/jill/.enzyme.yml'."
   puts
-  puts '     enzyme config project_name'
-  puts '     > my_project'
+  puts "        3. Get the value of the 'sync.projects_directory' setting in the organisation config file:"
   puts
+  puts "               $ enzyme config sync.projects_directory --organisation"
+  puts "               Projects"
 end

data/lib/commands/create.rb

@@ -26,75 +26,90 @@ module Create extend self
     # If the project already exists, raise an error.
     raise ProjectAlreadyExists.new(directory) if File.directory?(directory)
 
+    puts "Creating remote project at '#{directory}'..."
+
     create_repo directory, [ "*", "!.enzyme.yml", "!.gitignore" ]
+    print "."
     Config.write("#{directory}/.enzyme.yml", { "project_name" => project_name })
+    print "."
     commit_repo directory
+    print "."
     detach_repo directory
+    print "."
 
     create_repo "#{directory}/resources"
+    print "."
     commit_repo "#{directory}/resources"
+    print "."
     detach_repo "#{directory}/resources"
+    print "."
 
     create_repo "#{directory}/production"
+    print "."
     commit_repo "#{directory}/production"
+    print "."
     detach_repo "#{directory}/production"
-
-    puts "Created remote project at:"
-    puts
-    puts "    #{directory}"
     puts
+
+    puts "Done."
   end
 
   def create_repo(path, gitignore=[])
     # Create the project's directory.
-    system "mkdir -p #{path} > /dev/null"
+    system "mkdir -p #{path} &> /dev/null"
 
     # Change into the directory.
-    system "cd #{path} > /dev/null"
+    system "cd #{path} &> /dev/null"
     Dir.chdir(path)
 
     # Gitify.
-    system "git init > /dev/null"
+    system "git init &> /dev/null"
     system "echo '#{gitignore.join("\n")}' > .gitignore"
   end
 
   def commit_repo(path)
     # Create the project's directory.
-    system "mkdir -p #{path} > /dev/null"
+    system "mkdir -p #{path} &> /dev/null"
 
     # Change into the directory.
-    system "cd #{path} > /dev/null"
+    system "cd #{path} &> /dev/null"
     Dir.chdir(path)
 
     # Gitify.
-    system "git add . > /dev/null"
-    system "git commit -m 'Initial commit.' > /dev/null"
+    system "git add . &> /dev/null"
+    system "git commit -m 'Initial commit.' &> /dev/null"
   end
 
   def detach_repo(path)
     # Create the project's directory.
-    system "mkdir -p #{path} > /dev/null"
+    system "mkdir -p #{path} &> /dev/null"
 
     # Change into the directory.
-    system "cd #{path} > /dev/null"
+    system "cd #{path} &> /dev/null"
     Dir.chdir(path)
 
     # Gitify.
-    system "git checkout -q --detach > /dev/null"
+    system "git checkout -q --detach &> /dev/null"
   end
 
 end
 
 Enzyme.register('create', Create) do
   puts "#{$format.bold}SYNOPSIS#{$format.normal}"
-  puts '     enzyme create <project_name>'
+  puts "       enzyme create <project_name> [--skip-join]"
+  puts
+  puts "#{$format.bold}DESCRIPTION#{$format.normal}"
+  puts "       Creates a project on the sync server and (if --skip-join hasn't been passed) joins the"
+  puts "       project using the `enzyme join` command."
   puts
   puts "#{$format.bold}EXAMPLES#{$format.normal}"
-  puts '     > enzyme create example-project'
-  puts '     '
-  puts '     Created local project at:'
-  puts '     '
-  puts '       `/Users/jane/Projects/example-project`'
-  puts '     '
+  puts "       Creating a project called 'abc':"
   puts
+  puts "               $ enzyme create abc"
+  puts "               Creating remote project at '/Volumes/Shared/Projects/abc'..."
+  puts "               ........"
+  puts "               Done."
+  puts "               Joining the 'abc' project at '/Volumes/Shared/Projects/abc'..."
+  puts "               ......"
+  puts "               Done."
 end

data/lib/commands/join.rb

@@ -30,30 +30,45 @@ module Join extend self
     # If the remote project directory doesn't exists, raise an error.
     raise CannotFindProject.new(remote_directory) unless File.directory?(remote_directory)
 
+    puts "Joining the '#{project_name}' project at '#{local_directory}'..."
+
     # Clone the resources and production directories.
-    system "git clone -q #{remote_directory} #{local_directory}"
-    system "cd #{local_directory}; git checkout -q master;"
-    system "git clone -q #{remote_directory}/resources #{local_directory}/resources"
-    system "cd #{local_directory}/resources; git checkout -q master;"
-    system "git clone -q #{remote_directory}/production #{local_directory}/production"
-    system "cd #{local_directory}/production; git checkout -q master;"
+    system "git clone -q #{remote_directory} #{local_directory} &> /dev/null"
+    print "."
+    system "cd #{local_directory}; git checkout -q master &> /dev/null;"
+    print "."
+    system "git clone -q #{remote_directory}/resources #{local_directory}/resources &> /dev/null"
+    print "."
+    system "cd #{local_directory}/resources; git checkout -q master &> /dev/null;"
+    print "."
+    system "git clone -q #{remote_directory}/production #{local_directory}/production &> /dev/null"
+    print "."
+    system "cd #{local_directory}/production; git checkout -q master &> /dev/null;"
+    print "."
 
     # Create the user's production directory unless it's already there.
     system "mkdir #{local_directory}/production/#{$settings.short_name}" unless File.directory?("#{local_directory}/production/#{$settings.short_name}")
-
-    puts "Joined the '#{project_name}' project at:"
-    puts
-    puts "    #{local_directory}"
+    print "."
+    system "touch #{local_directory}/production/#{$settings.short_name}/.gitkeep" unless File.exists?("#{local_directory}/production/#{$settings.short_name}/.gitkeep")
     puts
+
+    puts "Done."
   end
 
 end
 
 Enzyme.register('join', Join) do
   puts "#{$format.bold}SYNOPSIS#{$format.normal}"
-  puts '     enzyme join <project_name>'
+  puts "       enzyme join <project_name>"
+  puts
+  puts "#{$format.bold}DESCRIPTION#{$format.normal}"
+  puts "       Joins a project by creating a local version of a project from the sync server."
   puts
   puts "#{$format.bold}EXAMPLES#{$format.normal}"
-  puts '     enzyme join abc'
+  puts "       Joining a project called 'abc':"
   puts
+  puts "               $ enzyme join abc"
+  puts "               Joining the 'abc' project at '/Volumes/Shared/Projects/abc'..."
+  puts "               ......"
+  puts "               Done."
 end

data/lib/commands/sync.rb

@@ -11,67 +11,116 @@ module Sync extend self
 
     raise ArgumentOrSettingMissing.new("project_name", "project_name") unless project_name
     raise SettingMissing.new("projects_directory") unless $settings.projects_directory
+    raise SettingMissing.new("short_name") unless $settings.short_name
 
     directory = "#{$settings.projects_directory}/#{project_name}"
 
     raise CannotFindProject.new(directory) unless File.directory?(directory)
 
+    puts "Syncing project '#{project_name}' at '#{directory}'..."
+
     # BASE
 
     system "cd #{directory}"
     Dir.chdir("#{directory}")
+    print "."
 
-    system "git add .enzyme.yml > /dev/null"
-    system "git commit -m 'Enzyme sync.'"
-    system "git pull > /dev/null"
-    system "git push > /dev/null"
+    system "git add .enzyme.yml &> /dev/null"
+    print "."
+    system "git commit -q -m 'Enzyme sync.' &> /dev/null"
+    print "."
+    system "git pull -q &> /dev/null"
+    print "."
+    system "git push -q &> /dev/null"
+    puts
 
     # RESOURCES
 
     unless skip_resources
+      # TODO: Check if the directory exists.
+
+      puts "Syncing resources directory..."
+
       system "cd #{directory}/resources"
       Dir.chdir("#{directory}/resources")
-
-      system "git checkout -q . > /dev/null"
-      system "git add . > /dev/null"
-      system "git commit -m 'Enzyme sync.'"
-      system "git pull > /dev/null"
-      system "git push > /dev/null"
+      print "."
+
+      system "git checkout -q . &> /dev/null"
+      print "."
+      system "git add . &> /dev/null"
+      print "."
+      system "git commit -q -m 'Enzyme sync.' &> /dev/null"
+      print "."
+      system "git pull -q &> /dev/null"
+      print "."
+      system "git push -q &> /dev/null"
+      puts
     end
 
     # PRODUCTION
 
-    system "cd #{directory}/production"
-    Dir.chdir("#{directory}/production")
+    unless skip_production
+      # TODO: Check if the directory exists.
+
+      puts "Syncing production directory..."
+
+      system "cd #{directory}/production"
+      Dir.chdir("#{directory}/production")
+      print "."
+
+      system "git add #{$settings.short_name} &> /dev/null"
+      print "."
+      system "git add -u &> /dev/null"
+      print "."
+      system "git commit -q -a -m 'Enzyme sync.' &> /dev/null"
+      print "."
+      system "git clean -fd &> /dev/null"
+      print "."
+      system "git pull -q &> /dev/null"
+      print "."
+      system "git push -q &> /dev/null"
+      puts
+    end
 
-    system "git add #{$settings.short_name} > /dev/null"
-    system "git add -u > /dev/null"
-    system "git commit -a -m 'Enzyme sync.'"
-    system "git clean -fd > /dev/null"
-    system "git pull > /dev/null"
-    system "git push > /dev/null"
+    puts "Done."
   end
 
 end
 
 Enzyme.register('sync', Sync) do
   puts "#{$format.bold}SYNOPSIS#{$format.normal}"
-  puts '     enzyme sync [<project_name>] [--discard-changes] [--init]'
+  puts "       enzyme sync [<project_name>] [--skip-resources] [--skip-production]"
   puts
   puts "#{$format.bold}DESCRIPTION#{$format.normal}"
-  puts '     Options:'
+  puts "       Sync either the current project or a specified project with the sync server."
+  puts
+  puts "       Any changes in the production directory outside of the current user's production directory"
+  puts "       will be discarded."
   puts
-  puts "     #{$format.bold}<project_name>#{$format.normal}"
-  puts '             The name of the project to sync. If the production directory is the root of a project this option does not need to be passed.'
+  puts "       Only additions to the the resources directory will be kept. Any modifications to exsiting"
+  puts "       references will be lost."
   puts
   puts "#{$format.bold}EXAMPLES#{$format.normal}"
-  puts '     You can run sync like this:'
+  puts "        1. Syncing a specific project:"
   puts
-  puts '     enzyme sync another_project'
-  puts '             If you specify a project you can run sync from anywhere.'
+  puts "               $ enzyme sync abc"
+  puts "               Syncing project 'abc' at '/Users/jane/Projects/abc'..."
+  puts "               ...."
+  puts "               Syncing resources directory..."
+  puts "               ....."
+  puts "               Syncing production directory..."
+  puts "               ......"
+  puts "               Done."
   puts
-  puts '     cd ~/Projects/my_project'
-  puts '     enzyme sync'
-  puts '             When the production directory is the root of a project you can run sync without any arguments.'
+  puts "        2. Syncing the current project:"
   puts
+  puts "               $ cd /Users/jane/Projects/abc"
+  puts "               $ enzyme sync"
+  puts "               Syncing project 'abc' at '/Users/jane/Projects/abc'..."
+  puts "               ...."
+  puts "               Syncing resources directory..."
+  puts "               ....."
+  puts "               Syncing production directory..."
+  puts "               ......"
+  puts "               Done."
 end

data/lib/enzyme.rb

@@ -5,17 +5,13 @@ module Enzyme extend self
   @@commands = {}
 
   def run
-    # Only shift the first argument off the ARGV if help flags haven't been passed.
-    command = (ARGV.delete("-h") || ARGV.delete("--help")) ? 'help' : ARGV.shift
-
-    puts
+    # If "-h" or "--help" was passed, delete the first one found and set the command to "help".
+    # Otherwise, assume the command is the first argument passed.
+    command = ARGV.delete((ARGV & [ "-h", "--help" ]).first) ? 'help' : ARGV.shift
 
     # Show info, help or run the requested command if it has been registered.
     begin
-      if command.nil?
-        info
-        help
-      elsif command.eql?('info')
+      if command.nil? || command.eql?('info')
         info
       elsif command.eql?('help')
         help
@@ -32,6 +28,9 @@ module Enzyme extend self
   end
 
   def info
+    ARGV.each { |x| raise UnknownOption.new(x) if x.start_with?("-") }
+    ARGV.each { |x| raise UnknownArgument.new(x) }
+
     puts '+-------------------------------------------------+'
     puts '| #####  ##  ##  ######  ##   ##  ##    ##  ##### |'
     puts '| ##     ### ##     ##    ## ##   ###  ###  ##    |'
@@ -41,16 +40,21 @@ module Enzyme extend self
     puts '+-------------------------------------------------+'
     puts
     puts "#{$format.bold}DESCRIPTION#{$format.normal}"
-    puts '     Katalyst\'s project collaboration tool.'
+    puts '       Katalyst\'s project collaboration tool.'
     puts
     puts "#{$format.bold}VERSION#{$format.normal}"
-    puts "     #{$system_settings.version}"
+    puts "       #{$system_settings.version}"
+    puts
+    puts "#{$format.bold}HELP#{$format.normal}"
+    puts "       Run this command to get help:"
     puts
+    puts "               $ enzyme help"
   end
 
   def help
-    ARGV.reject { |x| x.start_with?("-") }
+    ARGV.each { |x| raise UnknownOption.new(x) if x.start_with?("-") }
     command = ARGV.shift
+    ARGV.each { |x| raise UnknownArgument.new(x) }
 
     if command
       if @@commands.include?(command.to_s.downcase)
@@ -60,22 +64,21 @@ module Enzyme extend self
       end
     else
       puts "#{$format.bold}SYNOPSIS#{$format.normal}"
-      puts '     enzyme <command> [<options>]'
+      puts '       enzyme <command> [<options>]'
       puts
       puts "#{$format.bold}HELP#{$format.normal}"
-      puts '     enzyme help [<command>]'
-      puts '     enzyme [<command>] --help'
-      puts '     enzyme [<command>] -h'
+      puts '       enzyme help [<command>]'
+      puts '       enzyme [<command>] --help'
+      puts '       enzyme [<command>] -h'
       puts
       puts "#{$format.bold}COMMANDS#{$format.normal}"
 
-      ([ "info" ]+@@commands.keys).sort.each { |command| puts "     #{command}" }
+      ([ "info" ]+@@commands.keys).sort.each { |command| puts "       #{command}" }
 
       puts
       puts "#{$format.bold}DEBUGGING#{$format.normal}"
-      puts '     Use `--trace` at anytime to get full stacktraces.'
-      puts '     Use `--skip-sync-server` to prevent the sync server from mounting automatically.'
-      puts
+      puts '       Use `--trace` at anytime to get full stacktraces.'
+      puts '       Use `--skip-sync-server` to prevent the sync server from mounting automatically.'
     end
   end
 
@@ -83,10 +86,10 @@ module Enzyme extend self
     if $system_settings.trace_errors
       raise error
     else
-      puts "#{$format.bold}ERROR: #{error}#{$format.normal}"
-      puts
-      puts '  Run `enzyme help` for help or use the `--trace` option to get a full stacktrace.'
+      puts "#{$format.bold}ERROR#{$format.normal}"
+      puts "       #{error}"
       puts
+      puts "       Run `enzyme help` for help or use the `--trace` option to get a full stacktrace."
     end
   end
 

data/lib/errors.rb

@@ -33,6 +33,7 @@ end
 class ConfigFileNotFound < StandardError
 
   def initialize(path)
+    path = File.expand_path(path)
     super("Config file could not be found at '#{path}'.")
   end
 
@@ -49,6 +50,7 @@ end
 class ProjectAlreadyExists < StandardError
 
   def initialize(path)
+    path = File.expand_path(path)
     super("A project already exists at '#{path}'.")
   end
 
@@ -57,6 +59,7 @@ end
 class CannotFindProject < StandardError
 
   def initialize(path)
+    path = File.expand_path(path)
     super("Cannot find a project at '#{path}'.")
   end
 

data/lib/setup.rb

@@ -59,7 +59,7 @@ if !$system_settings.sync_server.skip && $settings.sync.host_name && $settings.s
   # Mount the sync server if it isn't already there.
   unless File.directory?($system_settings.sync_server.path)
     `mkdir #{$system_settings.sync_server.path}`
-    `mount -t afp #{afp_url} #{$system_settings.sync_server.path} > /dev/null` # > /dev/null is to suppress output
+    `mount -t afp #{afp_url} #{$system_settings.sync_server.path} &> /dev/null`
     `rm -r \"/Volumes/#{$settings.sync.share_name}\"` if $? != 0
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enzyme
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta02
+  version: 1.0.0.beta03
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000Z
+date: 2012-08-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156181420 !ruby/object:Gem::Requirement
+  requirement: &2152427040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *2156181420
+  version_requirements: *2152427040
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2156178320 !ruby/object:Gem::Requirement
+  requirement: &2152425680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156178320
+  version_requirements: *2152425680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156156060 !ruby/object:Gem::Requirement
+  requirement: &2152424900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156156060
+  version_requirements: *2152424900
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156138800 !ruby/object:Gem::Requirement
+  requirement: &2152424060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *2156138800
+  version_requirements: *2152424060
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2156133660 !ruby/object:Gem::Requirement
+  requirement: &2152422860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156133660
+  version_requirements: *2152422860
 description: Enzyme is a tool to make collaborating on projects easier. Developed
   by Katalyst Interactive.
 email: haydn@katalyst.com.au
@@ -106,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3209188080824928551
+      hash: 4011783646053326161
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: