poet 0.4 → 0.5

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
 rvm:
-  - 1.8.7
+  - 1.9.2
   - 1.9.3
+  - rbx-18mode
+  - jruby
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: rbx-18mode

data/History.txt

@@ -1,5 +1,23 @@
 master
 
+0.5
+
+- drop support for Ruby 1.8
+
+- edit files under ~/.ssh/config.d/ directly with `poet edit some_ssh_config_file`
+
+- use Thor internally for CLI
+
+- 'bootstrap' is now a subcommand (use `poet bootstrap` instead of `poet --bootstrap`)
+
+- also test against JRuby, Rubinius, and 1.9.2
+
+- running verbosely works again
+
+- extended help
+
+0.4
+
 - let users organize their config files in directories
 
 0.3.1

data/README.md

@@ -1,16 +1,26 @@
 [![Build Status](https://secure.travis-ci.org/awendt/poet.png)](http://travis-ci.org/awendt/poet)
 
-# Wanna split up your `~/.ssh/config` into several files?
+# Split your `ssh_config` into separate files!
 
-1. `gem install poet`
-2. `poet --bootstrap`
-3. Organize files in `~/.ssh/config.d/ssh_config` any way you want. Just remember to re-run `poet` afterwards.
+## Getting started
+
+    $ gem install poet
+    $ poet bootstrap
+
+This will move your `~/.ssh/config` into `~/.ssh/config.d/` and create an identical `~/.ssh/config`.
+Organize files in `~/.ssh/config.d/` any way you want (just remember to re-run `poet` afterwards).
+
+To edit `~/.ssh/config.d/some_file`, run `poet edit some_file`.
+Poet will open your favorite $EDITOR and automatically create a new `~/.ssh/config`
+when you quit the editor.
+
+## Advanced usage
 
 Poet won't touch your existing ssh_config.
 If you want to play with it, pass a different filename to the "-o" option.
 Or move your existing config out of the way.
 
-Stanzas under `~/.ssh/config.d/` with an extension of .disabled are ignored by Poet.
+Stanzas under `~/.ssh/config.d/` with an extension of .disabled are ignored by default.
 Every now and then, when you do need it, run `poet --with CONFIG` to explicitly include
 `CONFIG.disabled` in your generated ssh_config. You can even include several by running several
 `--with` options or using `--with CONFIG1,CONFIG2`.

data/bin/poet

@@ -1,37 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
 require 'poet'
 
-options = {
-  :ssh_config => ENV['POET_OUTPUT'] || File.expand_path('~/.ssh/config'),
-  :verbose => false,
-  :with => [],
-  :dir => ENV['POET_GLOBDIR'] || File.expand_path('~/.ssh/config.d')
-}
-
-optparse = OptionParser.new do|opts|
-  opts.on('-h', '--help', 'Display this screen') do
-    puts opts
-    exit
-  end
-  opts.on('-d', '--dir DIR', '') do |dir|
-    options[:dir] = File.expand_path(dir)
-  end
-  opts.on('-o', '--output FILE', '') do |file|
-    options[:ssh_config] = file
-  end
-  opts.on('-v', '--verbose', 'Be verbose') do
-    options[:verbose] = true
-  end
-  opts.on('--bootstrap [FILE]', '') do |file|
-    options[:bootstrap] = File.expand_path(file || options[:ssh_config])
-  end
-  opts.on('-w', '--with CONFIG', 'Include an otherwise disabled config file') do |file|
-    options[:with] += file.split(',')
-    options[:with].each{|file| puts "Including #{file} even if disabled..."}
-  end
-end
-optparse.parse!
-
-Poet.application(options).run
+PoetCLI.start(ARGV)

data/features/bootstrapping.feature

@@ -8,7 +8,7 @@ Feature: Bootstrapping
     Host *.amazonaws.com
       StrictHostKeyChecking no
     """
-    When I run `poet --bootstrap --dir ./config.d`
+    When I run `poet bootstrap --dir ./config.d`
     Then the exit status should be 0
     And a directory named "config.d" should exist
     And a file named "config.d/ssh_config" should exist
@@ -24,8 +24,8 @@ Feature: Bootstrapping
     Host *.amazonaws.com
       StrictHostKeyChecking no
     """
-    When I run `poet --bootstrap --dir ./config.d`
+    When I run `poet bootstrap --dir ./config.d`
     Then the exit status should be 0
-    When I run `poet --bootstrap --dir ./config.d`
-    Then the output from "poet --bootstrap --dir ./config.d" should contain "You're already good to go"
+    When I run `poet bootstrap --dir ./config.d`
+    Then the output from "poet bootstrap --dir ./config.d" should contain "You're already good to go"
     And the exit status should not be 0

data/features/editing_files.feature

@@ -0,0 +1,32 @@
+Feature: Editing files
+  Scenario: User wants to edit files quickly
+    Given a file named "favorite_editor" with:
+    """
+    Host vim
+      User me
+    """
+    When I set env variable "EDITOR" to "/bin/cat"
+    And I run `poet edit favorite_editor`
+    Then the output from "poet edit favorite_editor" should contain "Host vim"
+    And the file "ssh_config" should contain "Host vim"
+
+  Scenario: Show warning when user does not have EDITOR set
+    Given a file named "no_editor" with:
+    """
+    Host none
+      User me
+    """
+    When I set env variable "EDITOR" to ""
+    And I run `poet edit no_editor`
+    Then the output from "poet edit no_editor" should contain "$EDITOR is empty. Could not determine your favorite editor."
+    And the exit status should not be 0
+
+  Scenario: Do not re-create ssh_config when no file was created
+    Given a file named "important" with:
+    """
+    This is absolutely vital information
+    """
+    When I set env variable "EDITOR" to "/bin/cat"
+    And I run `poet edit missing -o important`
+    Then the output from "poet edit missing -o important" should not contain "Found hand-crafted ssh_config"
+    And the exit status should be 0

data/features/step_definitions/editor_steps.rb

@@ -0,0 +1,3 @@
+When /^I set env variable "(\w+)" to "([^"]*)"$/ do |var, value|
+  ENV[var] = value
+end

data/features/verbose.feature

@@ -0,0 +1,29 @@
+Feature: Seeing more output when running verbosely
+  Scenario: Silent by default
+    Given a file named "test" with:
+    """
+    Host te.st
+      User me
+    """
+    When I run `poet`
+    Then the output should not contain "Using test"
+
+  Scenario: User sees which files are included
+    Given a directory named "customers"
+    And a file named "customers/first" with:
+    """
+    Host customer1
+      User me
+    """
+    And a file named "customers/second" with:
+    """
+    Host customer2
+      User me
+    """
+    When I run `poet -v`
+    Then the output should contain exactly:
+    """
+    Using customers/first
+    Using customers/second
+
+    """

data/lib/poet.rb

@@ -1,71 +1,87 @@
 require "poet/version"
+require "thor"
 require "fileutils"
 
-module Poet
+class PoetCLI < Thor
 
   MAGIC_LINE = "# Generated by #{File.basename(__FILE__, '.rb')}"
 
-  class << self
-
-    def application(options={})
-      @application ||= Poet::Application.new(options)
+  default_task :create
+  class_option :dir,
+      desc: 'Use specified directory to collect conf files',
+      default: ENV['POET_GLOBDIR'] || File.expand_path('~/.ssh/config.d')
+  class_option :output,
+      desc: 'Generate output in specified file',
+      aliases: '-o',
+      default: ENV['POET_OUTPUT'] || File.expand_path('~/.ssh/config')
+  class_option :with,
+      desc: 'Include an otherwise disabled config file',
+      aliases: '-w',
+      default: ""
+  class_option :verbose,
+      desc: 'Be verbose',
+      aliases: '-v',
+      type: :boolean
+
+  desc "bootstrap [FILE]",
+      "Move ~/.ssh/config (or whatever you specified) to ~/.ssh/config.d/ to help you get started"
+  def bootstrap(file=nil)
+    file ||= File.expand_path(file || options[:output])
+    if File.directory?(options[:dir])
+      $stderr.puts "You're already good to go."
+      Process.exit!(3)
     end
-        
+    FileUtils.mkdir_p(options[:dir])
+    FileUtils.mv(file, options[:dir])
+    create
   end
 
-  class Application
-
-    attr_reader :options
-
-    def initialize(options={})
-      @options = options
+  desc "", "Concatenate all host stanzas under ~/.ssh/config.d/ into a single ~/.ssh/config"
+  def create
+    if !File.directory?(options[:dir])
+      $stderr.puts "#{options[:dir]} does not exist or is not a directory"
+      Process.exit!(1)
     end
 
-    def bootstrap
-      if File.directory?(options[:dir])
-        $stderr.puts "You're already good to go."
-        Process.exit!(3)
-      end
-      FileUtils.mkdir_p(options[:dir])
-      FileUtils.mv(options[:bootstrap], options[:dir])
+    if File.exists?(options[:output]) && File.new(options[:output]).gets == "#{MAGIC_LINE}\n"
+      puts "Found generated ssh_config under #{options[:output]}. Overwriting..."
+    elsif File.exists?(options[:output])
+      $stderr.puts "Found hand-crafted ssh_config under #{options[:output]}. Please move it out of the way or specify a different output file with the -o option."
+      Process.exit!(2)
     end
 
-    def run
-      bootstrap if options.has_key?(:bootstrap)
-
-      if !File.directory?(options[:dir])
-        $stderr.puts "#{options[:dir]} does not exist or is not a directory"
-        Process.exit!(1)
-      end
-
-      if File.exists?(options[:ssh_config]) && File.new(options[:ssh_config]).gets == "#{MAGIC_LINE}\n"
-        puts "Found generated ssh_config under #{options[:ssh_config]}. Overwriting..."
-      elsif File.exists?(options[:ssh_config])
-        $stderr.puts "Found hand-crafted ssh_config under #{options[:ssh_config]}. Please move it out of the way or specify a different output file with the -o option."
-        Process.exit!(2)
-      end
+    whitelist = options[:with].split(',')
+    files = Dir["#{options[:dir]}/**/*"].reject do |file|
+      File.directory?(file) || \
+        file =~ /\.disabled$/ && !whitelist.include?("#{File.basename(file, '.disabled')}")
+    end
 
-      files = Dir["#{options[:dir]}/**/*"].reject do |file|
-        File.directory?(file) || \
-          file =~ /\.disabled$/ && !options[:with].include?("#{File.basename(file, '.disabled')}")
-      end
+    files -= [options[:output]]
 
-      files -= [options[:ssh_config]]
+    entries = []
 
-      entries = []
+    files.sort.each do |file|
+      entries << File.read(file)
+      $stdout.puts "Using #{file.gsub(/^\.\//, '')}" if options[:verbose]
+    end
 
-      files.sort.each do |file|
-        entries << File.read(file)
-      end
+    File.open(options[:output], 'w', 0600) do |ssh_config|
+      ssh_config.puts(MAGIC_LINE)
+      ssh_config.puts("# DO NOT EDIT THIS FILE")
+      ssh_config.puts("# Create or modify files under #{options[:dir]} instead")
+      ssh_config.puts(entries.join("\n"))
+    end
+  end
 
-      File.open(options[:ssh_config], 'w', 0600) do |ssh_config|
-        ssh_config.puts(MAGIC_LINE)
-        ssh_config.puts("# DO NOT EDIT THIS FILE")
-        ssh_config.puts("# Create or modify files under #{options[:dir]} instead")
-        ssh_config.puts(entries.join("\n"))
-      end
+  desc "edit FILE", "Open FILE under ~/.ssh/config.d/ in your favorite $EDITOR"
+  def edit(file)
+    if ENV['EDITOR'].to_s.empty?
+      $stderr.puts "$EDITOR is empty. Could not determine your favorite editor."
+      Process.exit!(4)
     end
- 
+    filepath = File.join(options[:dir], file)
+    system("#{ENV['EDITOR']} #{filepath}")
+    create if File.exists?(filepath)
   end
 
 end

data/lib/poet/version.rb

@@ -1,3 +1,3 @@
 module Poet
-  VERSION = "0.4"
+  VERSION = "0.5"
 end

data/poet.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "cucumber"
   s.add_development_dependency "aruba"
   s.add_development_dependency "rake"
+  s.add_runtime_dependency "thor"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poet
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-27 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70266493053500 !ruby/object:Gem::Requirement
+  requirement: &70099056296460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70266493053500
+  version_requirements: *70099056296460
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70266493053040 !ruby/object:Gem::Requirement
+  requirement: &70099056296020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70266493053040
+  version_requirements: *70099056296020
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70266493052600 !ruby/object:Gem::Requirement
+  requirement: &70099056295560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70266493052600
+  version_requirements: *70099056295560
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70099056311480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70099056311480
 description: Split your longish ~/.ssh/config into files in ~/.ssh/config.d/ and let
   poet join them for you.
 email:
@@ -62,11 +73,14 @@ files:
 - Rakefile
 - bin/poet
 - features/bootstrapping.feature
+- features/editing_files.feature
 - features/permissions.feature
 - features/running.feature
 - features/selective_files.feature
+- features/step_definitions/editor_steps.rb
 - features/step_definitions/permissions_steps.rb
 - features/support/env.rb
+- features/verbose.feature
 - lib/poet.rb
 - lib/poet/version.rb
 - poet.gemspec
@@ -84,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4363712381040709860
+      hash: -3487840776745573411
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -93,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4363712381040709860
+      hash: -3487840776745573411
 requirements: []
 rubyforge_project: poet
 rubygems_version: 1.8.11
@@ -102,8 +116,11 @@ specification_version: 3
 summary: Poet concatenates stanzas
 test_files:
 - features/bootstrapping.feature
+- features/editing_files.feature
 - features/permissions.feature
 - features/running.feature
 - features/selective_files.feature
+- features/step_definitions/editor_steps.rb
 - features/step_definitions/permissions_steps.rb
 - features/support/env.rb
+- features/verbose.feature