haiti 0.0.1

data/Readme.md

@@ -0,0 +1,51 @@
+Haiti
+=====
+
+Aruba provides Cucumber helpers for command line programs, but it's way more sophisticated than I can understand,
+so I wind up reinventing that wheel in miniature for a lot of projects. This is just an extraction of that.
+It aims to be simple and easy to understand/extend.
+
+It's barely featured, currently the only features are what I extracted from SeeingIsBelieving's test suite. I'll
+add more to it as I need them, or you're welcome to. Its testing is entirely in cucumber at the moment, and there
+are no negative tests to assert that things don't work, so if anyone winds up working on it, I wouldn't mind that.
+
+
+To run tests
+============
+
+    cd tests
+    bundle
+    bundle exec cucumber
+
+Todo
+====
+
+* Add tests showing that curlies get interpreted where expected
+* Add tests proving that bin gets stuck in the path
+* Add tests for negative assertions (currently if all step defs were empty, this would pass the suite)
+
+Things that would be nice, but probably won't ever happen, b/c honestly, how often am I really going to touch this lib?
+=======================================================================================================================
+
+* all step defs work with single or double quotes
+* multiple bin directories
+* don't fucking pollute the World (currently this is how I get `eval_curlies` in there)
+* assertions about the existence and contents of files
+* a "given I'm in a clean directory" which wipes out the proving grounds
+
+License
+=======
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                       Version 2, December 2004
+
+    Copyright (C) 2013 Josh Cheek <josh.cheek@gmail.com>
+
+    Everyone is permitted to copy and distribute verbatim or modified
+    copies of this license document, and changing it is allowed as long
+    as the name is changed.
+
+               DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+      TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+     0. You just DO WHAT THE FUCK YOU WANT TO.

data/haiti.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "haiti/version"
+
+Gem::Specification.new do |s|
+  s.name        = "haiti"
+  s.version     = Haiti::VERSION
+  s.authors     = ["Josh Cheek"]
+  s.email       = ["josh.cheek@gmail.com"]
+  s.homepage    = "https://github.com/JoshCheek/haiti"
+  s.summary     = %q{Simple Cucumber steps for command line programs}
+  s.description = "Aruba provides Cucumber helpers for command line programs, but it's way more sophisticated than I can understand, " \
+                  "so I wind up reinventing that wheel in miniature for a lot of projects. This is just an extraction of that. "       \
+                  "It aims to be simple and easy to understand/extend."
+  s.license     = "WTFPL"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "cucumber", "~> 1.0"
+  s.add_dependency "rspec",    "~> 2.0" # I don't actually know where the cutoff is, but I'm not doing anything fancy here
+end

data/lib/haiti.rb

@@ -0,0 +1,14 @@
+require 'haiti/config'
+require 'haiti/command_line_helpers'
+require 'haiti/step_definitions'
+
+# move this somewhere better
+Before { Haiti::CommandLineHelpers.make_proving_grounds }
+
+module GeneralHelpers
+  def eval_curlies(string)
+    string.gsub(/{{(.*?)}}/) { eval $1 }
+  end
+end
+
+World GeneralHelpers

data/lib/haiti/command_line_helpers.rb

@@ -0,0 +1,64 @@
+require 'fileutils'
+require 'open3'
+
+module Haiti
+  module CommandLineHelpers
+    Invocation = Struct.new :stdout, :stderr, :status do
+      def exitstatus
+        status.exitstatus
+      end
+    end
+
+    extend self
+
+    def write_file(filename, body)
+      in_proving_grounds do
+        FileUtils.mkdir_p File.dirname filename
+        File.open(filename, 'w') { |file| file.write body }
+      end
+    end
+
+    def execute(command, stdin_data=nil)
+      stdin_data ||= ''
+      in_proving_grounds do
+        with_bin_in_path do
+          Invocation.new *Open3.capture3(command, stdin_data: stdin_data)
+        end
+      end
+    end
+
+    def in_proving_grounds(&block)
+      Dir.chdir proving_grounds_dir, &block
+    end
+
+    def proving_grounds_dir
+      config.proving_grounds_dir
+    end
+
+    def make_proving_grounds
+      FileUtils.mkdir_p proving_grounds_dir
+    end
+
+    def bin_dir
+      config.bin_dir
+    end
+
+    def path_to(filename)
+      in_proving_grounds { File.join proving_grounds_dir, filename }
+    end
+
+    # workaround for Ruby 2.0 bug where passing the new path as the first arg wasn't working
+    # bug report submitted here: http://bugs.ruby-lang.org/issues/8004
+    def with_bin_in_path
+      original_path = ENV['PATH']
+      ENV['PATH'] = "#{bin_dir}:#{ENV['PATH']}"
+      yield
+    ensure
+      ENV['PATH'] = original_path
+    end
+
+    def config
+      Haiti.config
+    end
+  end
+end

data/lib/haiti/config.rb

@@ -0,0 +1,11 @@
+module Haiti
+  Config = Struct.new :bin_dir, :proving_grounds_dir
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure(&block)
+    block.call config
+  end
+end

data/lib/haiti/step_definitions.rb

@@ -0,0 +1,12 @@
+Given('the file "$filename" "$body"')        { |filename, body|       Haiti::CommandLineHelpers.write_file filename, eval_curlies(body) }
+Given('the file "$filename":')               { |filename, body|       Haiti::CommandLineHelpers.write_file filename, eval_curlies(body) }
+Given('I have the stdin content "$content"') { |content|              @stdin_data = eval_curlies(content) }
+Given('I have the stdin content:')           { |content|              @stdin_data = eval_curlies(content) }
+When('I run "$command"')                     { |command|              @last_executed = Haiti::CommandLineHelpers.execute command, @stdin_data }
+When("I run '$command'")                     { |command|              @last_executed = Haiti::CommandLineHelpers.execute command, @stdin_data }
+Then(/^(stderr|stdout) is:$/)                { |stream_name, output|  @last_executed.send(stream_name).chomp.should == eval_curlies(output) }
+Then(/^(stderr|stdout) is ["'](.*?)["']$/)   { |stream_name, output|  @last_executed.send(stream_name).chomp.should == eval_curlies(output) }
+Then(/^(stderr|stdout) is empty$/)           { |stream_name|          @last_executed.send(stream_name).should == '' }
+Then(/^(stderr|stdout) is not empty$/)       { |stream_name|          @last_executed.send(stream_name).chomp.should_not be_empty }
+Then(/^(stderr|stdout) includes "([^"]*)"$/) { |stream_name, content| @last_executed.send(stream_name).should include eval_curlies(content) }
+Then('the exit status is $status')           { |status|               @last_executed.exitstatus.to_s.should == status }

data/lib/haiti/version.rb

@@ -0,0 +1,3 @@
+module Haiti
+  VERSION = '0.0.1'
+end

data/test/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'haiti', path: '..'
+gem 'cucumber'
+gem 'rspec'

data/test/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: ..
+  specs:
+    haiti (1.0.0)
+      cucumber (~> 1.0)
+      rspec (~> 2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.2.0)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    diff-lcs (1.2.4)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
+    json (1.7.7)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber
+  haiti!
+  rspec

data/test/features/given_i_have_stdin_content.feature

@@ -0,0 +1,18 @@
+Feature:
+  Scenario:
+    Given I have the stdin content "content"
+    When I run "cat"
+    Then stdout is "content"
+
+  Scenario:
+    Given I have the stdin content:
+    """
+    some
+    content
+    """
+    When I run "cat"
+    Then stdout is:
+    """
+    some
+    content
+    """

data/test/features/given_the_file.feature

@@ -0,0 +1,13 @@
+Feature:
+  Scenario:
+    Given the file "file1" "body{{0+1}}"
+    When I run 'cat file1'
+    Then stdout is "body1"
+
+  Scenario:
+    Given the file "file2":
+    """
+    body{{1+1}}
+    """
+    When I run 'cat file2'
+    Then stdout is "body2"

data/test/features/support/env.rb

@@ -0,0 +1,6 @@
+require 'haiti'
+
+Haiti.configure do |config|
+  config.proving_grounds_dir = File.expand_path '../../../proving_grounds', __FILE__
+  config.bin_dir             = File.expand_path '../../../bin',             __FILE__
+end

data/test/features/then_exit_status_is.feature

@@ -0,0 +1,8 @@
+Feature:
+  Scenario:
+    When I run "true"
+    Then the exit status is 0
+
+  Scenario:
+    When I run "false"
+    Then the exit status is 1

data/test/features/then_stream_is.feature

@@ -0,0 +1,63 @@
+Feature:
+
+  # stdout is ...
+  Scenario: stdout single quotes
+    When I run "ruby -e 'puts %(hi)'"
+    Then stdout is 'hi'
+
+  Scenario: stdout double quotes
+    When I run "ruby -e 'puts %(hi)'"
+    Then stdout is "hi"
+
+  Scenario: stdout multiline
+    When I run "ruby -e 'puts %(hi), %(bye)'"
+    Then stdout is:
+    """
+    hi
+    bye
+    """
+
+  # stderr is ...
+  Scenario: stderr single quotes
+    When I run "ruby -e '$stderr.puts %(hi)'"
+    Then stderr is 'hi'
+
+  Scenario: stderr double quotes
+    When I run "ruby -e '$stderr.puts %(hi)'"
+    Then stderr is "hi"
+
+  Scenario: stderr multiline
+    When I run "ruby -e '$stderr.puts %(hi), %(bye)'"
+    Then stderr is:
+    """
+    hi
+    bye
+    """
+
+  # stdout is / is not empty
+  Scenario: stdout is empty
+    When I run "ruby -e ''"
+    Then stdout is empty
+
+  Scenario: stdout is not empty
+    When I run "ruby -e '$stdout.puts %(a)'"
+    Then stdout is not empty
+
+  # stderr is / is not empty
+  Scenario: stderr is empty
+    When I run "ruby -e ''"
+    Then stdout is empty
+
+  Scenario: stderr is not empty
+    When I run "ruby -e '$stderr.puts %(a)'"
+    Then stderr is not empty
+
+  # stdout includes
+  Scenario: stdout includes
+    When I run "ruby -e '$stdout.puts %(abc)'"
+    Then stdout includes "b"
+
+  # stderr includes
+  Scenario: stderr includes
+    When I run "ruby -e '$stderr.puts %(abc)'"
+    Then stderr includes "b"

data/test/features/when_i_run.feature

@@ -0,0 +1,8 @@
+Feature:
+  Scenario:
+    When I run "echo hi"
+    Then stdout is "hi"
+
+  Scenario:
+    When I run 'echo bye'
+    Then stdout is "bye"

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: haiti
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Cheek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    none: false
+  name: cucumber
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+  name: rspec
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+description: Aruba provides Cucumber helpers for command line programs, but it's way
+  more sophisticated than I can understand, so I wind up reinventing that wheel in
+  miniature for a lot of projects. This is just an extraction of that. It aims to
+  be simple and easy to understand/extend.
+email:
+- josh.cheek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- haiti.gemspec
+- lib/haiti.rb
+- lib/haiti/command_line_helpers.rb
+- lib/haiti/config.rb
+- lib/haiti/step_definitions.rb
+- lib/haiti/version.rb
+- test/Gemfile
+- test/Gemfile.lock
+- test/features/given_i_have_stdin_content.feature
+- test/features/given_the_file.feature
+- test/features/support/env.rb
+- test/features/then_exit_status_is.feature
+- test/features/then_stream_is.feature
+- test/features/when_i_run.feature
+homepage: https://github.com/JoshCheek/haiti
+licenses:
+- WTFPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple Cucumber steps for command line programs
+test_files:
+- test/Gemfile
+- test/Gemfile.lock
+- test/features/given_i_have_stdin_content.feature
+- test/features/given_the_file.feature
+- test/features/support/env.rb
+- test/features/then_exit_status_is.feature
+- test/features/then_stream_is.feature
+- test/features/when_i_run.feature
+has_rdoc: