poet 0.0.1 → 0.2

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+tmp/aruba

data/History.txt

@@ -0,0 +1,11 @@
+master
+
+- testing with Aruba
+
+- new CLI options --output and --dir
+
+- Dropped CLI option --only
+
+0.0.1
+
+- Initial release as gem

data/README.md

@@ -0,0 +1,9 @@
+Lost in a long list of host stanzas in your `$HOME/.ssh/config`?
+
+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.
+
+`poet` does not overwrite your existing ssh_config. If you want to play with it, move your existing config out of the way.
+
+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`.
+
+If you only want an ssh_config from certain files, use `--only CONFIG` or `--only CONFIG1,CONFIG2`.

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:default, "Run tests")

data/bin/poet

@@ -2,61 +2,63 @@
 
 require 'optparse'
 
-CONF_DIR = File.expand_path('~/.ssh/config.d')
-SSH_CONFIG = File.expand_path('~/.ssh/config')
 MAGIC_LINE = "# Generated by #{File.basename(__FILE__)}"
 
-options = {:verbose => false, :with => [], :only => []}
+options = {
+  :ssh_config => File.expand_path('~/.ssh/config'),
+  :verbose => false,
+  :with => [],
+  :dir => 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('-v', '--verbose', 'Be verbose') do |file|
+  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('-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
-  opts.on('-o', '--only CONFIG', 'Use only given config files') do |file|
-    options[:only] += file.split(',')
-    options[:only].each{|file| puts "Using only #{file}..."}
-  end
 end
 optparse.parse!
 
-if !File.directory?(CONF_DIR)
-  puts "#{CONF_DIR} does not exist or is not a directory"
+if !File.directory?(options[:dir])
+  $stderr.puts "#{options[:dir]} does not exist or is not a directory"
   Process.exit!(1)
 end
 
-if File.exists?(SSH_CONFIG) && File.new(SSH_CONFIG).gets == "#{MAGIC_LINE}\n"
-  puts "Found generated ssh_config under #{SSH_CONFIG}. Overwriting..."
-elsif File.exists?(SSH_CONFIG)
-  puts "Found hand-crafted ssh_config under #{SSH_CONFIG}. Please move it out of the way."
+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
 
-File.open(SSH_CONFIG, 'w') do |ssh_config|
-  ssh_config.puts(MAGIC_LINE)
-  ssh_config.puts("# DO NOT EDIT THIS FILE")
-  ssh_config.puts("# Create or modify files under #{CONF_DIR}/ instead")
+files = Dir["#{options[:dir]}/**"].reject do |file|
+  file =~ /\.disabled$/ && !options[:with].include?("#{File.basename(file, '.disabled')}")
 end
 
-if options[:only].empty?
-  files = Dir["#{CONF_DIR}/**"].reject do |file|
-    file =~ /\.disabled$/ && !options[:with].include?("#{File.basename(file, '.disabled')}")
-  end
-else
-  files = Dir["#{CONF_DIR}/**"].select do |file|
-    options[:only].include?(File.basename(file, '.disabled'))
-  end
-end
+files -= [options[:ssh_config]]
+
+entries = []
 
 files.sort.each do |file|
-  puts "Concatenating #{file}" if options[:verbose]
-  %x(/bin/cat #{file} >> #{SSH_CONFIG})
-  %x(echo >> #{SSH_CONFIG})
+  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

data/features/permissions.feature

@@ -0,0 +1,10 @@
+Feature: Correct permissions
+  Scenario: User wants the generated file to work with SSH out-of-the-box.
+    Given a file named "permissions" with:
+    """
+    Host permissio.ns
+      User whatever
+    """
+    When I run `poet --dir . -o ssh_config`
+    And I run `ls -la ssh_config`
+    Then the file "ssh_config" should not be world-accessible

data/features/running.feature

@@ -0,0 +1,30 @@
+Feature: Running the program
+  Scenario: User runs the program
+    Given a file named "test" with:
+    """
+    Host te.st
+      User me
+    """
+    When I run `poet --dir . -o ssh_config`
+    Then the exit status should be 0
+    And the file "ssh_config" should contain "Host te.st"
+
+  Scenario: User wants her own files not to be overwritten
+    Given a file named "important" with:
+    """
+    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"
+    And the exit status should not be 0
+    And the file "important" should contain "This is absolutely vital information"
+
+  Scenario: User wants sensible warnings
+    Given a file named "test" with:
+    """
+    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"
+    And the exit status should not be 0

data/features/selective_files.feature

@@ -0,0 +1,45 @@
+Feature: Selectively whitelist files
+  Scenario: Does not include disabled files by default
+    Given a file named "sometimes.disabled" with:
+    """
+    Host sometimes
+      User me
+    """
+    And a file named "always" with:
+    """
+    Host always
+      User me
+    """
+    When I run `poet --dir . -o ssh_config`
+    Then the file "ssh_config" should contain "Host always"
+    But the file "ssh_config" should not contain "Host sometimes"
+
+  Scenario: Does include disabled files when asked
+    Given a file named "sometimes.disabled" with:
+    """
+    Host sometimes
+      User me
+    """
+    And a file named "always" with:
+    """
+    Host always
+      User me
+    """
+    When I run `poet --dir . -o ssh_config -w sometimes`
+    Then the file "ssh_config" should contain "Host always"
+    And the file "ssh_config" should contain "Host sometimes"
+
+  Scenario: Allows to include several disabled files
+    Given a file named "sometimes.disabled" with:
+    """
+    Host sometimes
+      User me
+    """
+    Given a file named "almost_never.disabled" with:
+    """
+    Host almost_never
+      User me
+    """
+    When I run `poet --dir . -o ssh_config -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

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

data/features/support/env.rb

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

data/lib/poet/version.rb

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

data/poet.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba"
+  s.add_development_dependency "rake"
 end

metadata

@@ -1,76 +1,106 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: poet
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: '0.2'
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
-- "Andr\xC3\xA9 Wendt"
+authors:
+- André Wendt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-29 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: Split your longish ~/.ssh/config into files in ~/.ssh/config.d/ and let poet join them for you.
-email: 
+date: 2012-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70193940334220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70193940334220
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70193940333780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70193940333780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70193940333300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70193940333300
+description: Split your longish ~/.ssh/config into files in ~/.ssh/config.d/ and let
+  poet join them for you.
+email:
 - awendt@freeshell.org
-executables: 
+executables:
 - poet
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
+- History.txt
 - MIT-LICENSE
-- README
+- README.md
 - Rakefile
 - bin/poet
+- features/permissions.feature
+- features/running.feature
+- features/selective_files.feature
+- features/step_definitions/permissions_steps.rb
+- features/support/env.rb
 - lib/poet.rb
 - lib/poet/version.rb
 - poet.gemspec
-has_rdoc: true
 homepage: https://github.com/awendt/poet
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3681220582875752418
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 3681220582875752418
 requirements: []
-
 rubyforge_project: poet
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Poet concatenates stanzas
-test_files: []
-
+test_files:
+- features/permissions.feature
+- features/running.feature
+- features/selective_files.feature
+- features/step_definitions/permissions_steps.rb
+- features/support/env.rb

data/README

@@ -1,9 +0,0 @@
-Lost in a long list of host stanzas in your ssh_config?
-
-Fear not -- divide them up into several smaller files under $HOME/.ssh/config.d/ and run 'ssh-confgen' to concatenate them into a single ssh_config.
-
-'ssh-confgen' does not overwrite your existing ssh_config. If you want to play with it, move your existing config out of the way.
-
-Stanzas under $HOME/.ssh/config.d/ with an extension of .disabled are ignored by ssh-confgen. Every now and then, when you do need it, run 'ssh-confgen --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'.
-
-If you only want an ssh_config from certain files, use '--only CONFIG' or '--only CONFIG1,CONFIG2'.