poet 0.2 → 0.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3

data/History.txt

@@ -1,5 +1,11 @@
 master
 
+- options: Use env var POET_OUTPUT in addition to --output and POET_GLOBDIR in addition to --dir
+
+- bootstrapping support
+
+0.2
+
 - testing with Aruba
 
 - new CLI options --output and --dir

data/README.md

@@ -1,9 +1,23 @@
-Lost in a long list of host stanzas in your `$HOME/.ssh/config`?
+[![Build Status](https://secure.travis-ci.org/awendt/poet.png)](http://travis-ci.org/awendt/poet)
 
-Fear not -- divide them up into several smaller files under `$HOME/.ssh/config.d/` and run `poet` to concatenate them into a single ssh_config.
+# Wanna split up your `~/.ssh/config` into several files?
 
-`poet` does not overwrite your existing ssh_config. If you want to play with it, move your existing config out of the way.
+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.
 
-Stanzas under `$HOME/.ssh/config.d/` with an extension of .disabled are ignored by poet. 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`.
+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.
 
-If you only want an ssh_config from certain files, use `--only CONFIG` or `--only CONFIG1,CONFIG2`.
+Stanzas under `~/.ssh/config.d/` with an extension of .disabled are ignored by Poet.
+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`.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Send me a pull request. Bonus points for topic branches.

data/bin/poet

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-
-MAGIC_LINE = "# Generated by #{File.basename(__FILE__)}"
+require 'poet'
 
 options = {
-  :ssh_config => File.expand_path('~/.ssh/config'),
+  :ssh_config => ENV['POET_OUTPUT'] || File.expand_path('~/.ssh/config'),
   :verbose => false,
   :with => [],
-  :dir => File.expand_path('~/.ssh/config.d')
+  :dir => ENV['POET_GLOBDIR'] || File.expand_path('~/.ssh/config.d')
 }
 
 optparse = OptionParser.new do|opts|
@@ -25,6 +24,9 @@ optparse = OptionParser.new do|opts|
   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..."}
@@ -32,33 +34,4 @@ optparse = OptionParser.new do|opts|
 end
 optparse.parse!
 
-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
-
-files = Dir["#{options[:dir]}/**"].reject do |file|
-  file =~ /\.disabled$/ && !options[:with].include?("#{File.basename(file, '.disabled')}")
-end
-
-files -= [options[:ssh_config]]
-
-entries = []
-
-files.sort.each do |file|
-  entries << File.read(file)
-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
+Poet.application(options).run

data/features/bootstrapping.feature

@@ -0,0 +1,31 @@
+Feature: Bootstrapping
+  Scenario: User wants help to get started
+    Given a file named "ssh_config" with:
+    """
+    Host home
+      StrictHostKeyChecking ask
+
+    Host *.amazonaws.com
+      StrictHostKeyChecking no
+    """
+    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
+    And the file "config.d/ssh_config" should contain "Host home"
+    And the file "ssh_config" should contain "# Generated by poet"
+
+  Scenario: Bootstrapping a second time
+    Given a file named "ssh_config" with:
+    """
+    Host home
+      StrictHostKeyChecking ask
+
+    Host *.amazonaws.com
+      StrictHostKeyChecking no
+    """
+    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"
+    And the exit status should not be 0

data/features/permissions.feature

@@ -5,6 +5,5 @@ Feature: Correct permissions
     Host permissio.ns
       User whatever
     """
-    When I run `poet --dir . -o ssh_config`
-    And I run `ls -la ssh_config`
+    When I run `poet`
     Then the file "ssh_config" should not be world-accessible

data/features/running.feature

@@ -5,7 +5,7 @@ Feature: Running the program
     Host te.st
       User me
     """
-    When I run `poet --dir . -o ssh_config`
+    When I run `poet`
     Then the exit status should be 0
     And the file "ssh_config" should contain "Host te.st"
 
@@ -14,8 +14,8 @@ Feature: Running the program
     """
     This is absolutely vital information
     """
-    When I run `poet --dir . -o important`
-    Then the output from "poet --dir . -o important" should contain "Found hand-crafted ssh_config"
+    When I run `poet -o important`
+    Then the output from "poet -o important" should contain "Found hand-crafted ssh_config"
     And the exit status should not be 0
     And the file "important" should contain "This is absolutely vital information"
 
@@ -25,6 +25,6 @@ Feature: Running the program
     Host te.st
       User me
     """
-    When I run `poet --dir missing -o ssh_config`
-    Then the output from "poet --dir missing -o ssh_config" should contain "missing does not exist"
+    When I run `poet --dir missing`
+    Then the output from "poet --dir missing" should contain "missing does not exist"
     And the exit status should not be 0

data/features/selective_files.feature

@@ -10,7 +10,7 @@ Feature: Selectively whitelist files
     Host always
       User me
     """
-    When I run `poet --dir . -o ssh_config`
+    When I run `poet`
     Then the file "ssh_config" should contain "Host always"
     But the file "ssh_config" should not contain "Host sometimes"
 
@@ -25,7 +25,7 @@ Feature: Selectively whitelist files
     Host always
       User me
     """
-    When I run `poet --dir . -o ssh_config -w sometimes`
+    When I run `poet -w sometimes`
     Then the file "ssh_config" should contain "Host always"
     And the file "ssh_config" should contain "Host sometimes"
 
@@ -40,6 +40,6 @@ Feature: Selectively whitelist files
     Host almost_never
       User me
     """
-    When I run `poet --dir . -o ssh_config -w sometimes,almost_never`
+    When I run `poet -w sometimes,almost_never`
     Then the file "ssh_config" should contain "Host almost_never"
     And the file "ssh_config" should contain "Host sometimes"

data/features/step_definitions/permissions_steps.rb

@@ -1,3 +1,4 @@
 Then /^the file "([^"]*)" should not be world-accessible$/ do |filename|
+  step "I run `ls -la ssh_config`"
   step %Q(the output from "ls -la #{filename}" should contain "-rw-------")
 end

data/features/support/env.rb

@@ -1,3 +1,5 @@
 ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+ENV['POET_OUTPUT'] = 'ssh_config'
+ENV['POET_GLOBDIR'] = '.'
 
 require 'aruba/cucumber'

data/lib/poet.rb

@@ -1 +1,69 @@
 require "poet/version"
+
+module Poet
+
+  MAGIC_LINE = "# Generated by #{File.basename(__FILE__, '.rb')}"
+
+  class << self
+
+    def application(options={})
+      @application ||= Poet::Application.new(options)
+    end
+        
+  end
+
+  class Application
+
+    attr_reader :options
+
+    def initialize(options={})
+      @options = options
+    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])
+    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
+
+      files = Dir["#{options[:dir]}/**"].reject do |file|
+        file =~ /\.disabled$/ && !options[:with].include?("#{File.basename(file, '.disabled')}")
+      end
+
+      files -= [options[:ssh_config]]
+
+      entries = []
+
+      files.sort.each do |file|
+        entries << File.read(file)
+      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
+    end
+ 
+  end
+
+end

data/lib/poet/version.rb

@@ -1,3 +1,3 @@
 module Poet
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poet
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-04 00:00:00.000000000 Z
+date: 2012-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70193940334220 !ruby/object:Gem::Requirement
+  requirement: &70282917431800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70193940334220
+  version_requirements: *70282917431800
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70193940333780 !ruby/object:Gem::Requirement
+  requirement: &70282917431300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70193940333780
+  version_requirements: *70282917431300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70193940333300 !ruby/object:Gem::Requirement
+  requirement: &70282917430840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70193940333300
+  version_requirements: *70282917430840
 description: Split your longish ~/.ssh/config into files in ~/.ssh/config.d/ and let
   poet join them for you.
 email:
@@ -54,12 +54,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - History.txt
 - MIT-LICENSE
 - README.md
 - Rakefile
 - bin/poet
+- features/bootstrapping.feature
 - features/permissions.feature
 - features/running.feature
 - features/selective_files.feature
@@ -82,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3681220582875752418
+      hash: 62288698588282443
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -91,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3681220582875752418
+      hash: 62288698588282443
 requirements: []
 rubyforge_project: poet
 rubygems_version: 1.8.11
@@ -99,6 +101,7 @@ signing_key:
 specification_version: 3
 summary: Poet concatenates stanzas
 test_files:
+- features/bootstrapping.feature
 - features/permissions.feature
 - features/running.feature
 - features/selective_files.feature