fig 1.0.0 → 1.1.0

data/Changes

@@ -1,3 +1,46 @@
+v1.1.0
+
+  Backwards incompatibilities:
+
+  - Package names and versions and config names can no longer be "." or "..".
+    Attempting to use one of these would produce bad effects before, so this
+    should not be a big deal.
+
+  - The FIG_USERNAME and FIG_PASSWORD environment variables take precedence
+    over values in ~/.netrc.  This is a better fit with the general *nix idea
+    that the command-line should take precedence over the environment which
+    should take precedence over dotfiles.
+
+  - Removed support for SSH.  It was never fully functional and depended upon
+    fig being installed at the same absolute path on the remote machine as it
+    was on the local one.  Use SFTP instead.
+
+  New features:
+
+  - Graphviz (http://graphviz.org/) output for --list-dependencies and
+    --list-variables via --graphviz option.  You'll need something that can
+    interpret .dot files to use this.
+
+      fig package/v1.2.3 --list-dependencies --graphviz |
+        dot -Tpng -o package-1.2.3.png
+
+      fig package/v1.2:config --list-variables --list-all-configs --graphviz |
+        dot -Tpng -o package-1.2.3.png
+
+    Since Fig just emits DOT (http://graphviz.org/content/dot-language), Fig
+    doesn't have a dependency upon Graphviz libraries, etc.
+
+  - Support for SFTP.  Set FIG_REMOTE_URL to something like
+    «sftp://host:port/some/path».  Note that this *requires* the use of
+    ~/.netrc or FIG_USERNAME/FIG_PASSWORD in order to authenticate; there is no
+    anonymous SFTP.  Thus, the use of the --login option is superfluous with
+    SFTP.
+
+v1.0.1.beta.2
+v1.0.1.beta.1
+
+  - Test releases.
+
 v1.0.0
 
   New features:

data/lib/fig.rb

@@ -1,3 +1,3 @@
 module Fig
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/fig/command.rb

@@ -167,6 +167,9 @@ class Fig::Command
 
   def configure()
     set_up_update_lock()
+
+    @operating_system = Fig::OperatingSystem.new(@options.login?)
+
     set_up_application_configuration()
 
     Fig::Logging.initialize_post_configuration(
@@ -174,8 +177,6 @@ class Fig::Command
       @options.log_level()
     )
 
-    @operating_system = Fig::OperatingSystem.new(@options.login?)
-
     prepare_repository()
     prepare_environment()
   end
@@ -205,10 +206,10 @@ class Fig::Command
 
   def set_up_application_configuration()
     @application_configuration = Fig::FigRC.find(
-      @options.figrc(),
+      @options.figrc,
       ENV['FIG_REMOTE_URL'],
-      @options.login?,
-      @options.home(),
+      @operating_system,
+      @options.home,
       @options.no_figrc?
     )
 

data/lib/fig/command/action/list_dependencies/graphviz.rb

@@ -0,0 +1,42 @@
+require 'fig/command/action'
+require 'fig/command/action/role/list_as_graphviz'
+require 'fig/command/action/role/list_base_config'
+require 'fig/command/action/role/list_dependencies_as_graphviz'
+require 'fig/command/action/role/list_walking_dependency_tree'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+class   Fig::Command::Action::ListDependencies; end
+
+class Fig::Command::Action::ListDependencies::Graphviz
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::ListAsGraphviz
+  include Fig::Command::Action::Role::ListBaseConfig
+  include Fig::Command::Action::Role::ListDependenciesAsGraphviz
+  include Fig::Command::Action::Role::ListWalkingDependencyTree
+
+  def options()
+    return %w<--list-dependencies --graphviz>
+  end
+
+  def descriptor_requirement()
+    return nil
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return nil # don't care
+  end
+
+  def apply_config?()
+    return nil # don't care
+  end
+
+  def apply_base_config?()
+    return nil # don't care
+  end
+end

data/lib/fig/command/action/list_dependencies/graphviz_all_configs.rb

@@ -0,0 +1,42 @@
+require 'fig/command/action'
+require 'fig/command/action/role/list_all_configs'
+require 'fig/command/action/role/list_as_graphviz'
+require 'fig/command/action/role/list_dependencies_as_graphviz'
+require 'fig/command/action/role/list_walking_dependency_tree'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+class   Fig::Command::Action::ListDependencies; end
+
+class Fig::Command::Action::ListDependencies::GraphvizAllConfigs
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::ListAllConfigs
+  include Fig::Command::Action::Role::ListAsGraphviz
+  include Fig::Command::Action::Role::ListDependenciesAsGraphviz
+  include Fig::Command::Action::Role::ListWalkingDependencyTree
+
+  def options()
+    return %w<--list-dependencies --graphviz --list-all-configs>
+  end
+
+  def descriptor_requirement()
+    return nil
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return nil # don't care
+  end
+
+  def apply_config?()
+    return nil # don't care
+  end
+
+  def apply_base_config?()
+    return nil # don't care
+  end
+end

data/lib/fig/command/action/list_variables/all_configs.rb

@@ -40,7 +40,7 @@ class Fig::Command::Action::ListVariables::AllConfigs
     variable_names = Set.new()
 
     walk_dependency_tree(
-      @execution_context.base_package, base_display_config_names(), nil, 0
+      @execution_context.base_package, base_display_config_names()
     ) do
       |package, config_name, depth|
 

data/lib/fig/command/action/list_variables/graphviz.rb

@@ -0,0 +1,22 @@
+require 'fig/command/action'
+require 'fig/command/action/role/list_as_graphviz'
+require 'fig/command/action/role/list_base_config'
+require 'fig/command/action/role/list_variables_as_graphviz'
+require 'fig/command/action/role/list_walking_dependency_tree'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+class   Fig::Command::Action::ListVariables; end
+
+class Fig::Command::Action::ListVariables::Graphviz
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::ListAsGraphviz
+  include Fig::Command::Action::Role::ListBaseConfig
+  include Fig::Command::Action::Role::ListVariablesAsGraphviz
+  include Fig::Command::Action::Role::ListWalkingDependencyTree
+
+  def options()
+    return %w<--list-variables --graphviz>
+  end
+end

data/lib/fig/command/action/list_variables/graphviz_all_configs.rb

@@ -0,0 +1,22 @@
+require 'fig/command/action'
+require 'fig/command/action/role/list_all_configs'
+require 'fig/command/action/role/list_as_graphviz'
+require 'fig/command/action/role/list_variables_as_graphviz'
+require 'fig/command/action/role/list_walking_dependency_tree'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+class   Fig::Command::Action::ListVariables; end
+
+class Fig::Command::Action::ListVariables::GraphvizAllConfigs
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::ListAllConfigs
+  include Fig::Command::Action::Role::ListAsGraphviz
+  include Fig::Command::Action::Role::ListVariablesAsGraphviz
+  include Fig::Command::Action::Role::ListWalkingDependencyTree
+
+  def options()
+    return %w<--list-variables --graphviz --list-all-configs>
+  end
+end

data/lib/fig/command/action/role/list_as_graphviz.rb

@@ -0,0 +1,80 @@
+require 'set'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+module  Fig::Command::Action::Role; end
+
+# Requires a #node_content(package, config_name) method.
+module Fig::Command::Action::Role::ListAsGraphviz
+  def execute()
+    @subgraphs = {}
+
+    puts 'digraph {'
+    puts '    node [shape = box];'
+    walk_dependency_tree(
+      @execution_context.base_package,
+      base_display_config_names(),
+      include_emit,
+      &package_gather
+    )
+    emit_subgraphs
+    puts '}'
+
+    return Fig::Command::Action::EXIT_SUCCESS
+  end
+
+  private
+
+  def include_emit
+    visited = Set.new
+
+    return lambda do
+      |including_package, including_config, included_package, included_config|
+
+      including_name = node_name(including_package, including_config)
+      included_name = node_name(included_package, included_config)
+      edge = %Q/    "#{including_name}" -> "#{included_name}";/
+
+      if ! visited.include? edge
+        visited << edge
+        puts edge
+      end
+    end
+  end
+
+  def package_gather
+    visited = Set.new
+
+    return lambda do
+      |package, config_name, depth|
+
+      name = node_name package, config_name
+
+      if ! visited.include? name
+        visited << name
+
+        package_name = node_name package, nil
+        @subgraphs[package_name] ||= []
+        @subgraphs[package_name] << node_content(package, config_name)
+      end
+    end
+  end
+
+  def emit_subgraphs()
+    @subgraphs.each do
+      |package_name, nodes|
+
+      cluster = nodes.size > 1 ? 'cluster ' : ''
+      puts %Q<    subgraph "#{cluster}#{package_name}" {>
+      nodes.each { |node| puts %Q<        #{node}> }
+      puts %q<    }>
+    end
+
+    return
+  end
+
+  def node_name(package, config_name)
+    return package.to_s_with_config(config_name)
+  end
+end

data/lib/fig/command/action/role/list_dependencies_as_graphviz.rb

@@ -0,0 +1,25 @@
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+module  Fig::Command::Action::Role; end
+
+module Fig::Command::Action::Role::ListDependenciesAsGraphviz
+  private
+
+  def node_content(package, config_name)
+    name = node_name package, config_name
+
+    style = ''
+    color = ''
+    if package == @execution_context.base_package
+      if base_display_config_names.include?(config_name)
+        style = ' style = "rounded, bold"'
+      end
+      if config_name == @execution_context.base_config
+        color = ' color = blue'
+      end
+    end
+
+    return %Q<"#{name}" [label = "#{name}"#{style}#{color}];>
+  end
+end

data/lib/fig/command/action/role/list_dependencies_in_a_tree.rb

@@ -8,7 +8,7 @@ module  Fig::Command::Action::Role; end
 module Fig::Command::Action::Role::ListDependenciesInATree
   def execute()
     walk_dependency_tree(
-      @execution_context.base_package, base_display_config_names(), nil, 0
+      @execution_context.base_package, base_display_config_names()
     ) do
       |package, config_name, depth|
 

data/lib/fig/command/action/role/list_variables_as_graphviz.rb

@@ -0,0 +1,76 @@
+require 'cgi'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+module  Fig::Command::Action::Role; end
+
+module Fig::Command::Action::Role::ListVariablesAsGraphviz
+  def descriptor_requirement()
+    return nil
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return nil # don't care
+  end
+
+  def apply_config?()
+    return nil # don't care
+  end
+
+  private
+
+  def node_content(package, config_name)
+    style = ''
+    color = ''
+    if package == @execution_context.base_package
+      if base_display_config_names.include?(config_name)
+        style = ' style = "rounded, bold"'
+      end
+      if config_name == @execution_context.base_config
+        color = ' color = blue'
+      end
+    end
+
+    name = node_name package, config_name
+    rows = variable_statement_rows package, config_name
+    label = nil
+    if rows.empty?
+      label = %Q<"#{name}">
+    else
+      label = %Q[<<table border="0"><tr><td border="0" colspan="3"><b>#{name}</b></td></tr>#{rows}</table>>]
+    end
+
+    return %Q<"#{name}" [label = #{label}#{style}#{color}];>
+  end
+
+  def variable_statement_rows(package, config_name)
+    string = ''
+
+    package[config_name].walk_statements do
+      |statement|
+
+      if statement.is_environment_variable?
+        string << format_variable_statement(statement)
+      end
+    end
+
+    return string
+  end
+
+  def format_variable_statement(statement)
+    string = '<tr><td align="right">'
+    string << statement.statement_type
+    string << '</td><td align="left">$'
+    string << CGI.escape_html(statement.name)
+    string << '</td><td align="left">'
+    string << CGI.escape_html(statement.tokenized_value.to_escaped_string)
+    string << '</td></tr>'
+
+    return string
+  end
+end

data/lib/fig/command/action/role/list_variables_in_a_tree.rb

@@ -53,7 +53,7 @@ module Fig::Command::Action::Role::ListVariablesInATree
     current_parent = tree
 
     walk_dependency_tree(
-      @execution_context.base_package, base_display_config_names(), nil, 0
+      @execution_context.base_package, base_display_config_names()
     ) do
       |package, config_name, depth|
 

data/lib/fig/command/action/role/list_walking_dependency_tree.rb

@@ -13,44 +13,12 @@ module Fig::Command::Action::Role::ListWalkingDependencyTree
     return false
   end
 
-  def walk_dependency_tree(base_package, config_names, backtrace, depth, &block)
-    config_names.each do
-      |config_name|
-
-      if depth < 1
-        @execution_context.repository.reset_cached_data
-      end
-
-      yield base_package, config_name, depth
-
-      new_backtrace = Fig::IncludeBacktrace.new(
-        backtrace,
-        Fig::PackageDescriptor.new(
-          base_package.name(),
-          base_package.version(),
-          config_name,
-          :description => base_package.description
-        )
-      )
-
-      base_package.package_dependencies(config_name, new_backtrace).each do
-        |descriptor|
-
-        package = nil
-        if descriptor.name
-          package =
-            @execution_context.repository.get_package(
-              descriptor, :allow_any_version
-            )
-        else
-          package = base_package
-        end
-
-        walk_dependency_tree(
-          package, [descriptor.config], new_backtrace, depth + 1, &block
-        )
-      end
-    end
+  def walk_dependency_tree(
+    base_package, config_names, include_block = nil, &package_block
+  )
+    do_walk_dependency_tree(
+      base_package, config_names, nil, 0, include_block, &package_block
+    )
 
     return
   end
@@ -68,7 +36,7 @@ module Fig::Command::Action::Role::ListWalkingDependencyTree
       packages[base_package] = starting_config_names.to_set
     end
 
-    walk_dependency_tree(base_package, starting_config_names, nil, 0) do
+    do_walk_dependency_tree(base_package, starting_config_names, nil, 0, nil) do
       |package, config_name, depth|
 
       if (
@@ -92,4 +60,67 @@ module Fig::Command::Action::Role::ListWalkingDependencyTree
 
     return packages
   end
+
+  private
+
+  def do_walk_dependency_tree(
+    base_package, config_names, backtrace, depth, include_block, &package_block
+  )
+    config_names.each do
+      |config_name|
+
+      if depth < 1
+        @execution_context.repository.reset_cached_data
+      end
+
+      package_block.call base_package, config_name, depth
+
+      new_backtrace = new_backtrace(backtrace, base_package, config_name)
+
+      base_package.package_dependencies(config_name, new_backtrace).each do
+        |descriptor|
+
+        package = package_for_descriptor descriptor, base_package
+
+        do_walk_dependency_tree(
+          package,
+          [descriptor.config],
+          new_backtrace,
+          depth + 1,
+          include_block,
+          &package_block
+        )
+
+        if include_block
+          include_block.call(
+            base_package, config_name, package, descriptor.config
+          )
+        end
+      end
+    end
+
+    return
+  end
+
+  def new_backtrace(backtrace, base_package, config_name)
+    return Fig::IncludeBacktrace.new(
+      backtrace,
+      Fig::PackageDescriptor.new(
+        base_package.name(),
+        base_package.version(),
+        config_name,
+        :description => base_package.description
+      )
+    )
+  end
+
+  def package_for_descriptor(descriptor, base_package)
+    if descriptor.name
+      return @execution_context.repository.get_package(
+        descriptor, :allow_any_version
+      )
+    end
+
+    return base_package
+  end
 end