fig 1.2.0 → 1.3.0

data/Changes

@@ -1,3 +1,49 @@
+v1.3.0
+
+  Backwards incompatibility:
+
+  - If you specify one of FIG_USERNAME/FIG_PASSWORD, you must specify both.
+
+  Bug fixes:
+
+  - In the change to not use the environment variables/prompting for assets,
+    ~/.netrc gained priority over the environment variables again. Fixed.
+
+  - Newlines are allowed in command-line options.
+
+  New feature:
+
+  - New --publish-comment option that allows you to put a comment at the top of
+    published packages.  Works regardless of whether the package definition
+    comes from a file or other command-line options.
+
+      > fig --publish package/version --publish-comment $'This package is\n    awesome!' ...
+
+      > fig --dump-package-definition-text package/version
+      # This package is
+      #     awesome!
+      #
+      #
+      # Publishing information for package/version:
+      ...
+
+  Miscellaneous:
+
+  - Publishing now includes VCS revision information.
+
+    For Subversion, this is from the "Revision: " in the output of "svn info".
+    It might be better to use the output of "svnversion", but this would
+    require an additional FIG_SVNVERSION_EXECUTABLE environment variable and it
+    seems better to keep things simpler by avoiding that.
+
+    For Git, it includes the current branch and SHA1.
+
+v1.2.1.beta.3
+v1.2.1.beta.2
+v1.2.1.beta.1
+
+  - Test releases.
+
 v1.2.0
 
   Bug fixes:

data/lib/fig.rb

@@ -1,3 +1,3 @@
 module Fig
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/fig/command/options.rb

@@ -60,6 +60,7 @@ class Fig::Command::Options
   attr_reader   :log_level
   attr_reader   :package_definition_file
   attr_reader   :parser
+  attr_reader   :publish_comment
   attr_reader   :shell_command
   attr_reader   :suppress_cleanup_of_retrieves
   attr_reader   :suppress_includes
@@ -164,7 +165,7 @@ class Fig::Command::Options
   # Note that OptionParser insists that the regex match the entire value, not
   # just matches the regex in general.  In effect, OptionParser is wrapping the
   # regex with "\A" and "\z".
-  STARTS_WITH_NON_HYPHEN = %r< \A [^-] .* >x
+  STARTS_WITH_NON_HYPHEN = %r< \A [^-] .* >xm
 
   def list_all_configs?()
     return @list_all_configs
@@ -362,6 +363,14 @@ class Fig::Command::Options
       set_base_action(Fig::Command::Action::PublishLocal)
     end
 
+    @parser.on(
+      '--publish-comment COMMENT',
+      STARTS_WITH_NON_HYPHEN,
+      'comment to include in published package'
+    ) do |comment|
+      @publish_comment = comment
+    end
+
     @force = nil
     @parser.on(
       '--force',
@@ -754,16 +763,18 @@ class Fig::Command::Options
         raise Fig::Command::OptionError.new(
           'Cannot use --suppress-all-includes/--suppress-cross-package-includes with --list-all-configs.'
         )
-      elsif @base_action.list_dependencies?
-        raise Fig::Command::OptionError.new(
-          %q<It doesn't make much sense to suppress dependencies when attempting to list them.>
-        )
-      elsif @base_action.publish?
-        # Don't want to support broken publishes (though versionless includes
-        # are pretty broken).
-        raise Fig::Command::OptionError.new(
-          'Cannot use --suppress-all-includes/--suppress-cross-package-includes when publishing.'
-        )
+      elsif @base_action
+        if @base_action.list_dependencies?
+          raise Fig::Command::OptionError.new(
+            %q<It doesn't make much sense to suppress dependencies when attempting to list them.>
+          )
+        elsif @base_action.publish?
+          # Don't want to support broken publishes (though versionless includes
+          # are pretty broken).
+          raise Fig::Command::OptionError.new(
+            'Cannot use --suppress-all-includes/--suppress-cross-package-includes when publishing.'
+          )
+        end
       end
     elsif list_tree?
       validate_list_option '--list-tree'
@@ -779,6 +790,12 @@ class Fig::Command::Options
       )
     end
 
+    if @publish_comment && (! @base_action || ! @base_action.publish?)
+      raise Fig::Command::OptionError.new(
+        'Cannot use --publish-comment when not publishing.'
+      )
+    end
+
     return
   end
 

data/lib/fig/operating_system.rb

@@ -244,9 +244,9 @@ class Fig::OperatingSystem
 
   def shell_exec(command)
     if Fig::OperatingSystem.windows?
-      plain_exec [ ENV['ComSpec'], '/c', command ]
+      plain_exec [ ENV['ComSpec'],            '/c', command ]
     else
-      plain_exec [ ENV['SHELL'],   '-c', command ]
+      plain_exec [ ENV['SHELL'] || '/bin/sh', '-c', command ]
     end
   end
 

data/lib/fig/protocol/netrc_enabled.rb

@@ -24,15 +24,21 @@ module Fig::Protocol::NetRCEnabled
     end
 
     entry = nil
-    begin
-      login_data = Net::Netrc.locate host
-      if login_data
-        entry = NetRCEntry.new login_data.login, login_data.password
-      elsif prompt_if_missing
-        entry = get_authentication_from_user(host)
+    if prompt_if_missing
+      entry = get_authentication_from_environment
+    end
+
+    if ! entry
+      begin
+        login_data = Net::Netrc.locate host
+        if login_data
+          entry = NetRCEntry.new login_data.login, login_data.password
+        elsif prompt_if_missing
+          entry = get_authentication_from_user(host)
+        end
+      rescue SecurityError => error
+        raise Fig::UserInputError.new error.message
       end
-    rescue SecurityError => error
-      raise Fig::UserInputError.new error.message
     end
 
     @netrc_entries_by_host[host] = entry
@@ -40,15 +46,31 @@ module Fig::Protocol::NetRCEnabled
     return entry
   end
 
+  def get_authentication_from_environment()
+    username = ENV['FIG_USERNAME']
+    password = ENV['FIG_PASSWORD']
+
+    if username.nil? && password.nil?
+      return nil
+    end
+
+    if ! username.nil? && ! password.nil?
+      return NetRCEntry.new username, password
+    end
+
+    if password.nil?
+      raise Fig::UserInputError.new \
+        'FIG_USERNAME is set but FIG_PASSWORD is not.'
+    end
+
+    raise Fig::UserInputError.new 'FIG_PASSWORD is set but FIG_USERNAME is not.'
+  end
+
   def get_authentication_from_user(host)
-    username =
-      ENV['FIG_USERNAME'] ||
-      HighLine.new.ask("Username for #{host}: ") { |q| q.echo = true }
-    password =
-      ENV['FIG_PASSWORD'] ||
-      HighLine.new.ask("Password for #{username}@#{host}: ") {
-        |q| q.echo = false
-      }
+    username = HighLine.new.ask("Username for #{host}: ") { |q| q.echo = true }
+    password = HighLine.new.ask("Password for #{username}@#{host}: ") {
+      |q| q.echo = false
+    }
 
     return NetRCEntry.new username, password
   end

data/lib/fig/repository_package_publisher.rb

@@ -147,6 +147,8 @@ class Fig::RepositoryPackagePublisher
   end
 
   def add_package_metadata_comments()
+    add_publish_comment
+
     @text_assembler.add_header(
       %Q<# Publishing information for #{@descriptor.to_string()}:>
     )
@@ -158,7 +160,10 @@ class Fig::RepositoryPackagePublisher
 
     @text_assembler.add_header %Q<#     User: #{@publish_login}>
     @text_assembler.add_header %Q<#     Host: #{@publish_host}>
-    @text_assembler.add_header %Q<#     Args: "#{ARGV.join %q[", "]}">
+
+    sanitized_argv = ARGV.map {|arg| arg.gsub "\n", '\\n'}
+    @text_assembler.add_header %Q<#     Args: "#{sanitized_argv.join %q[", "]}">
+
     @text_assembler.add_header %Q<#     Fig:  v#{Fig::VERSION}>
 
     add_environment_variables_to_package_metadata
@@ -169,6 +174,17 @@ class Fig::RepositoryPackagePublisher
     return
   end
 
+  def add_publish_comment
+    return if ! @options.publish_comment
+
+    comment = @options.publish_comment.strip.gsub /[ \t]*\n/, "\n# "
+    @text_assembler.add_header %Q<# #{comment}>
+    @text_assembler.add_header %q<#>
+    @text_assembler.add_header %q<#>
+
+    return
+  end
+
   def add_environment_variables_to_package_metadata()
     variables = @application_configuration[
       'environment variables to include in comments in published packages'
@@ -197,20 +213,25 @@ class Fig::RepositoryPackagePublisher
   def add_version_control_to_package_metadata()
     return if @options.suppress_vcs_comments_in_published_packages?
 
-    add_subversion_url_to_package_metadata()
-    add_git_url_to_package_metadata()
+    add_subversion_metadata_to_package_metadata()
+    add_git_metadata_to_package_metadata()
 
     return
   end
 
-  def add_subversion_url_to_package_metadata()
+  def add_subversion_metadata_to_package_metadata()
     output = get_subversion_working_directory_info
     return if not output =~ /^URL: +(.*\S)\s*$/
     url = $1
 
+    revision = ''
+    if output =~ /^Revision: +(\S+)\s*$/
+      revision = ", revision #{$1}"
+    end
+
     @text_assembler.add_header %q<#>
     @text_assembler.add_header(
-      %Q<# Publish happened in a Subversion working directory from\n# #{url}.>
+      %Q<# Publish happened in a Subversion working directory from\n# #{url}#{revision}.>
     )
 
     return
@@ -255,14 +276,27 @@ class Fig::RepositoryPackagePublisher
     return executable
   end
 
-  def add_git_url_to_package_metadata()
+  def add_git_metadata_to_package_metadata()
     url = get_git_origin_url or return
     url.strip!
     return if url.empty?
 
+    branch = get_git_branch
+    if branch.nil?
+      branch = ''
+    else
+      branch = ", branch #{branch}"
+    end
+    sha1 = get_git_sha1
+    if sha1.nil?
+      sha1 = ''
+    else
+      sha1 = ",\n# SHA1 #{sha1}"
+    end
+
     @text_assembler.add_header %q<#>
     @text_assembler.add_header(
-      %Q<# Publish happened in a Git working directory from\n# #{url}.>
+      %Q<# Publish happened in a Git working directory from\n# #{url}#{branch}#{sha1}.>
     )
 
     return
@@ -278,6 +312,36 @@ class Fig::RepositoryPackagePublisher
     )
   end
 
+  def get_git_branch()
+    executable =
+      get_version_control_executable('FIG_GIT_EXECUTABLE', 'git') or return
+    reference = run_version_control_command(
+      [executable, 'rev-parse', '--abbrev-ref=strict', 'HEAD'],
+      'Git',
+      'FIG_GIT_EXECUTABLE'
+    )
+    return if reference.nil?
+
+    reference.strip!
+    return if reference.empty?
+
+    return reference
+  end
+
+  def get_git_sha1()
+    executable =
+      get_version_control_executable('FIG_GIT_EXECUTABLE', 'git') or return
+    reference = run_version_control_command(
+      [executable, 'rev-parse', 'HEAD'], 'Git', 'FIG_GIT_EXECUTABLE'
+    )
+    return if reference.nil?
+
+    reference.strip!
+    return if reference.empty?
+
+    return reference
+  end
+
   # Deals with Archive and Resource statements.  It downloads any remote
   # files (those where the statement references a URL as opposed to a local
   # file) and then copies all files into the local repository and the remote

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fig
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &16367000 !ruby/object:Gem::Requirement
+  requirement: &7783280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.5.8
   type: :runtime
   prerelease: false
-  version_requirements: *16367000
+  version_requirements: *7783280
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &16366480 !ruby/object:Gem::Requirement
+  requirement: &7782280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.2
   type: :runtime
   prerelease: false
-  version_requirements: *16366480
+  version_requirements: *7782280
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &16365980 !ruby/object:Gem::Requirement
+  requirement: &7781400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.5
   type: :runtime
   prerelease: false
-  version_requirements: *16365980
+  version_requirements: *7781400
 - !ruby/object:Gem::Dependency
   name: libarchive-static
-  requirement: &16365480 !ruby/object:Gem::Requirement
+  requirement: &7780440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *16365480
+  version_requirements: *7780440
 - !ruby/object:Gem::Dependency
   name: log4r
-  requirement: &16364880 !ruby/object:Gem::Requirement
+  requirement: &7779700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.1.5
   type: :runtime
   prerelease: false
-  version_requirements: *16364880
+  version_requirements: *7779700
 - !ruby/object:Gem::Dependency
   name: net-netrc
-  requirement: &16364380 !ruby/object:Gem::Requirement
+  requirement: &7797340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *16364380
+  version_requirements: *7797340
 - !ruby/object:Gem::Dependency
   name: net-sftp
-  requirement: &16363920 !ruby/object:Gem::Requirement
+  requirement: &7796880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 2.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *16363920
+  version_requirements: *7796880
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &16471780 !ruby/object:Gem::Requirement
+  requirement: &7796340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: 2.0.15
   type: :runtime
   prerelease: false
-  version_requirements: *16471780
+  version_requirements: *7796340
 - !ruby/object:Gem::Dependency
   name: open4
-  requirement: &16471280 !ruby/object:Gem::Requirement
+  requirement: &7795660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *16471280
+  version_requirements: *7795660
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &16470760 !ruby/object:Gem::Requirement
+  requirement: &7794460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '3.12'
   type: :runtime
   prerelease: false
-  version_requirements: *16470760
+  version_requirements: *7794460
 - !ruby/object:Gem::Dependency
   name: sys-admin
-  requirement: &16470220 !ruby/object:Gem::Requirement
+  requirement: &7793400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: 1.5.6
   type: :runtime
   prerelease: false
-  version_requirements: *16470220
+  version_requirements: *7793400
 - !ruby/object:Gem::Dependency
   name: treetop
-  requirement: &16469680 !ruby/object:Gem::Requirement
+  requirement: &7792720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: 1.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *16469680
+  version_requirements: *7792720
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &16469140 !ruby/object:Gem::Requirement
+  requirement: &7792200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: 1.0.15
   type: :development
   prerelease: false
-  version_requirements: *16469140
+  version_requirements: *7792200
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16468620 !ruby/object:Gem::Requirement
+  requirement: &7791600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *16468620
+  version_requirements: *7791600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16468100 !ruby/object:Gem::Requirement
+  requirement: &7791100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -175,10 +175,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *16468100
+  version_requirements: *7791100
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &16467580 !ruby/object:Gem::Requirement
+  requirement: &7790640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,10 +186,10 @@ dependencies:
         version: 2.7.1
   type: :development
   prerelease: false
-  version_requirements: *16467580
+  version_requirements: *7790640
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
-  requirement: &16467100 !ruby/object:Gem::Requirement
+  requirement: &7790180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -197,10 +197,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *16467100
+  version_requirements: *7790180
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
-  requirement: &16466520 !ruby/object:Gem::Requirement
+  requirement: &7789720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -208,10 +208,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *16466520
+  version_requirements: *7789720
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &16465740 !ruby/object:Gem::Requirement
+  requirement: &7871460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -219,10 +219,10 @@ dependencies:
         version: 0.6.2
   type: :development
   prerelease: false
-  version_requirements: *16465740
+  version_requirements: *7871460
 - !ruby/object:Gem::Dependency
   name: simplecov-html
-  requirement: &16465240 !ruby/object:Gem::Requirement
+  requirement: &7870980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -230,7 +230,7 @@ dependencies:
         version: 0.5.3
   type: :development
   prerelease: false
-  version_requirements: *16465240
+  version_requirements: *7870980
 description: Fig is a utility for configuring environments and managing dependencies
   across a team of developers. Given a list of packages and a command to run, Fig
   builds environment variables named in those packages (e.g., CLASSPATH), then executes