iv-cli 0.0.5 → 0.0.6

data/features/nodes.feature

@@ -81,3 +81,18 @@ Feature: User can interact with opscode nodes
     Unable to read opscode account info from config.
     """
     And the exit status should be 4
+
+  Scenario: User can specify a CSV formatter for node lists
+    Given a default iv configuration file for "demo"
+    And the following nodes:
+      | status        | name   | fqdn   | ip          | os       |
+      | 1 minute ago  | host.1 | host.1 | 10.10.10.10 | solaris2 |
+      | 2 minutes ago | host.2 | host.2 | 10.10.10.11 | solaris2 |
+    When I run `iv nodes --formatter csv`
+    Then the stderr should contain ""
+    And the exit status should be 0
+    And the stdout should contain:
+    """
+    1 minute ago,host.1,10.10.10.10,solaris2,demo
+    2 minutes ago,host.2,10.10.10.11,solaris2,demo
+    """

data/features/step_definitions/chef_steps.rb

@@ -1,10 +1,22 @@
+
+def node_response(table)
+  table.rows.map{|r| r.join(', ')}.join("\n")
+end
+
 Given /^I expect Chef to return the following nodes for "([^"]*)", with user "([^"]*)" and key "([^"]*)":$/ do |organization, user, key, table|
-  nodes = table.rows.map{|r| r.join(', ')}.join("\n")
   steps %{
     Given I double `knife status -s https://api.opscode.com/organizations/#{organization} -u #{user} -k #{key} --no-color` with exit status 0 and stdout:
     """
-    #{nodes}
+    #{node_response(table)}
     """
   }
 end
 
+Given /^the following nodes:$/i do |table|
+  steps %{
+    Given I double `knife status -s https://api.opscode.com/organizations/acct -u user -k key --no-color` with exit status 0 and stdout:
+    """
+    #{node_response(table)}
+    """
+  }
+end

data/features/step_definitions/init_steps.rb

@@ -34,3 +34,12 @@ Given /^the following iv config file:$/i do |contents|
     file.puts contents
   end
 end
+
+Given /^a default iv configuration file for "([^"]+)"$/i do |identifier|
+  steps %{
+    Given a directory named "tmp/test/.iv"
+  }
+  ::File.open("tmp/test/.iv/config.yml","w") do |file|
+    file.puts "---\nopscode:\n  #{identifier}:\n    acct: acct\n    user: user\n    key: key\n"
+  end
+end

data/lib/iv-cli.rb

@@ -3,5 +3,7 @@ module IV
   end
 end
 
-Dir["#{File.dirname(__FILE__)}/iv-cli/helpers/*.rb"].sort.each { |f| require f }
-Dir["#{File.dirname(__FILE__)}/iv-cli/**/*.rb"].sort.each { |f| require f }
+$:.unshift(File.dirname(__FILE__))
+
+require 'iv-cli/config'
+require 'iv-cli/app'

data/lib/iv-cli/app.rb

@@ -1,5 +1,8 @@
 require 'mixlib/cli'
 
+require 'iv-cli/helpers/errors'
+require 'iv-cli/command'
+
 class IV::CLI::App
   include Mixlib::CLI
   include IV::CLI::Helpers::Errors

data/lib/iv-cli/command.rb

@@ -1,60 +1,49 @@
+require 'mixlib/cli'
 require 'yaml'
 
+require 'iv-cli/helpers/errors'
+require 'iv-cli/helpers/subclass_registration'
+
 class IV::CLI::Command
   include Mixlib::CLI
   include IV::CLI::Helpers::Errors
+  include IV::CLI::Helpers::SubclassRegistration
 
-  attr_reader :config
+  attr_reader :iv_config
 
   def self.run_command args, options = {}
-    command_class(args.shift).new.run(args, options)
+    subclass_class(args.shift).new.run(args, options)
   end
 
   def self.invalid_command? command
-    ! commands.include? command
+    ! subclasses.include? command
   end
 
 
   protected
 
-  def self.commands
-    @@commands ||= {}
-  end
-
-  def self.command_name
-    name.split("::").last.downcase
-  end
-
-  def self.command_class(command)
-    commands[command]
-  end
-
   def self.config_dir
     "#{ENV['HOME']}/.iv"
   end
 
-  def self.config
+  def self.config_file
     "#{config_dir}/config.yml"
   end
 
-  def parse_config
-    unless ::File.exists?(self.class.config)
+  def parse_iv_config
+    unless ::File.exists?(self.class.config_file)
       fail(4, %{Unable to find IV configuration.\nPlease run 'iv init' and update config.yml with your credentials})
     end
-    @config = ::YAML.load_file(self.class.config)
+    @iv_config = ::YAML.load_file(self.class.config_file)
   end
 
   def ensure_opscode_config
-    parse_config unless config
-    unless config["opscode"]
+    parse_iv_config unless iv_config
+    unless iv_config["opscode"]
       fail(4, %{Unable to read opscode account info from config.})
     end
   end
-
-  private
-
-  def self.inherited(subclass)
-    commands[subclass.command_name] = subclass
-  end
-
 end
+
+require 'iv-cli/commands/init'
+require 'iv-cli/commands/nodes'

data/lib/iv-cli/commands/init.rb

@@ -26,7 +26,7 @@ class IV::CLI::Command::Init < IV::CLI::Command
     ::FileUtils.mkdir_p(self.class.config_dir)
 
     puts "Generating config file ~/.iv/config.yml"
-    ::File.open(self.class.config, "w") do |f|
+    ::File.open(self.class.config_file, "w") do |f|
       f.puts "---"
       write_default_opscode(f)
     end
@@ -35,7 +35,7 @@ class IV::CLI::Command::Init < IV::CLI::Command
   private
 
   def validate
-    if !config[:force] && ::File.exists?(self.class.config)
+    if !config[:force] && ::File.exists?(self.class.config_file)
       STDERR.puts "Config file already exists at ~/.iv/config.yml"
       STDERR.puts "Use --force to overwrite file"
       Process.exit 10

data/lib/iv-cli/commands/nodes.rb

@@ -1,14 +1,24 @@
 require 'pty'
 
+require 'iv-cli/formatter'
+
 class IV::CLI::Command::Nodes < IV::CLI::Command
 
   banner "Usage: iv nodes [options]"
 
+  option :formatter,
+    :short   => '-f FORMATTER',
+    :long    => '--formatter FORMATTER',
+    :default => 'table',
+    :description => 'Output formatter'
+
   def run(args, options = {})
     parse_options(args)
-    parse_config
+    parse_iv_config
     ensure_opscode_config
 
+    @formatter = IV::CLI::Formatter.find(config[:formatter]).new({:columns => [:status,:name,:ip,:os,:org]})
+
     stream_converge_status
   end
 
@@ -16,15 +26,15 @@ class IV::CLI::Command::Nodes < IV::CLI::Command
 
   def stream_converge_status
     node_info = []
-    config["opscode"].each_pair do |org, settings|
+    iv_config["opscode"].each_pair do |org, settings|
       command = "knife status -s https://api.opscode.com/organizations/#{settings["acct"]} -u #{settings["user"]} -k #{settings["key"]} --no-color 2> /dev/null"
       begin
         PTY.spawn(command) do |stdin, stdout, pid|
           begin
             stdin.each do |node|
-              node_info << translate_node_status(node.gsub(/\033\[[0-9;]*m/,''), org)
+              node_info << translate_node_status(node, org)
               if node_info.length%30 == 0
-                output_node_info(node_info.slice!(0..29))
+                @formatter.output_rows(node_info.slice!(0..29))
               end
             end
           rescue Errno::EIO
@@ -33,51 +43,11 @@ class IV::CLI::Command::Nodes < IV::CLI::Command
       rescue PTY::ChildExited
       end
     end
-    output_node_info(node_info)
+    @formatter.output_rows(node_info)
   end
 
   def translate_node_status(knife_output, org)
     node = knife_output.chomp.split(", ")
     {:status => node[0], :name => node[1], :fqdn => node[2], :ip => node[3], :os => node[4], :org => org}
   end
-
-  def output_node_info(nodes)
-    column_width = {}
-    column_width[:status] = largest_size(nodes, :status)
-    column_width[:name] = largest_size(nodes, :name)
-    column_width[:ip] = largest_size(nodes, :ip)
-    column_width[:os] = largest_size(nodes, :os)
-    column_width[:org] = largest_size(nodes, :org)
-
-    headers = []
-    [:status, :name, :ip, :os, :org].each do |key|
-      headers << sprintf(" %#{column_width[key]}s ", key.to_s)
-    end
-    print_row(headers, "+")
-
-    nodes.each do |node|
-      node_output = []
-      [:status, :name, :ip, :os, :org].each do |key|
-        node_output << sprintf(" %-#{column_width[key]}s ", node[key])
-      end
-      print_row(node_output)
-    end
-    STDOUT.flush
-  end
-
-  def largest_size(array, key)
-    array.inject(0) do |largest, member|
-      begin
-        size = member[key].size; largest > size ? largest : size
-      rescue NoMethodError
-        largest
-      end
-    end
-  end
-
-  def print_row(array, separator = "|")
-    STDOUT.print separator
-    STDOUT.print array.join(separator)
-    STDOUT.puts separator
-  end
 end

data/lib/iv-cli/formatter.rb

@@ -0,0 +1,13 @@
+
+module IV::CLI::Formatter
+
+  COLOR_REGEX = /\033\[[0-9;]*m/
+
+  def self.find(formatter_type)
+    IV::CLI::Formatter::Base.find(formatter_type)
+  end
+end
+
+require 'iv-cli/formatters/base'
+require 'iv-cli/formatters/table'
+require 'iv-cli/formatters/csv'

data/lib/iv-cli/formatters/base.rb

@@ -0,0 +1,24 @@
+
+require 'iv-cli/helpers/errors'
+require 'iv-cli/helpers/subclass_registration'
+
+class IV::CLI::Formatter::Base
+  include IV::CLI::Helpers::Errors
+  include IV::CLI::Helpers::SubclassRegistration
+
+  attr_reader :options
+
+  def initialize(options = {})
+    @options = options
+  end
+
+  def self.find(formatter_type)
+    fail(4, %|Unable to find formatter for #{formatter_type}|) unless subclasses.include?(formatter_type)
+    subclasses[formatter_type]
+  end
+
+  def output_rows(*args)
+    #abstract method
+    raise "Abstract method called on IV::CLI::Formatter"
+  end
+end

data/lib/iv-cli/formatters/csv.rb

@@ -0,0 +1,20 @@
+
+require 'iv-cli/formatter'
+require 'iv-cli/formatters/base'
+
+class IV::CLI::Formatter::CSV < IV::CLI::Formatter::Base
+
+  SEPARATOR = ','
+
+  def output_rows(list)
+    line = []
+    list.each do |row|
+      options[:columns].each do |column|
+        line << row[column]
+      end
+
+      STDOUT.puts line.join(SEPARATOR).gsub(IV::CLI::Formatter::COLOR_REGEX,'')
+      line.slice!(0..-1)
+    end
+  end
+end

data/lib/iv-cli/formatters/table.rb

@@ -0,0 +1,54 @@
+
+require 'iv-cli/formatter'
+require 'iv-cli/formatters/base'
+
+class IV::CLI::Formatter::Table < IV::CLI::Formatter::Base
+
+  def output_rows(list)
+    column_width = {}
+
+    # find column width by searching out widest member of each column
+    options[:columns].each do |column|
+      column_width[column] = largest_size(list, column)
+    end
+
+    # print row of headers every so often
+    headers = []
+    options[:columns].each do |key|
+      headers << sprintf(" %#{column_width[key]}s ", key.to_s)
+    end
+    print_row(headers, "+")
+
+    # print out each row
+    list.each do |member|
+      output = []
+      options[:columns].each do |key|
+        output << sprintf(" %-#{column_width[key]}s ", remove_color(member[key]))
+      end
+      print_row(output)
+    end
+    STDOUT.flush
+  end
+
+  private
+
+  def largest_size(array, key)
+    array.inject(0) do |largest, member|
+      begin
+        size = remove_color(member[key]).size; largest > size ? largest : size
+      rescue NoMethodError
+        largest
+      end
+    end
+  end
+
+  def print_row(array, separator = "|")
+    STDOUT.print separator
+    STDOUT.print array.join(separator)
+    STDOUT.puts separator
+  end
+
+  def remove_color(string)
+    string.gsub(IV::CLI::Formatter::COLOR_REGEX,'') rescue ''
+  end
+end

data/lib/iv-cli/helpers/errors.rb

@@ -1,9 +1,22 @@
-module IV::CLI::Helpers
-  module Errors
-    def fail(exit_status=1, message="")
-      STDERR.puts "Error: #{message}" unless message.empty?
-      STDERR.puts IV::CLI::USAGE
-      exit exit_status
+require 'iv-cli/usage'
+
+module IV
+  module CLI
+    module Helpers
+      module Errors
+        module Methods
+          def fail(exit_status=1, message="")
+            STDERR.puts "Error: #{message}" unless message.empty?
+            STDERR.puts IV::CLI::USAGE
+            exit exit_status
+          end
+        end
+
+        def self.included(base)
+          base.send :include, Methods
+          base.extend Methods
+        end
+      end
     end
   end
 end

data/lib/iv-cli/helpers/subclass_registration.rb

@@ -0,0 +1,37 @@
+
+module IV
+  module CLI
+    module Helpers
+      module SubclassRegistration
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+
+          protected
+
+          def subclasses
+            @@subclasses ||= {}
+          end
+
+          def subclass_name
+            name.split("::").last.downcase
+          end
+
+          def subclass_class(subclass)
+            subclasses[subclass]
+          end
+
+          private
+
+          def inherited(subclass)
+            subclasses[subclass.subclass_name] = subclass
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/iv-cli/version.rb

@@ -1,5 +1,5 @@
 module IV
   module CLI
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iv-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -189,7 +189,12 @@ files:
 - lib/iv-cli/commands/init.rb
 - lib/iv-cli/commands/nodes.rb
 - lib/iv-cli/config.rb
+- lib/iv-cli/formatter.rb
+- lib/iv-cli/formatters/base.rb
+- lib/iv-cli/formatters/csv.rb
+- lib/iv-cli/formatters/table.rb
 - lib/iv-cli/helpers/errors.rb
+- lib/iv-cli/helpers/subclass_registration.rb
 - lib/iv-cli/usage.rb
 - lib/iv-cli/version.rb
 - spec/lib/config_spec.rb