clintegracon 0.4.1

data/lib/CLIntegracon/formatter.rb

@@ -0,0 +1,77 @@
+require 'colored'
+
+module CLIntegracon
+  class Formatter
+
+    # @return  [FileTreeSpec]
+    #          the spec
+    attr_reader :spec
+
+    # Initialize
+    #
+    # @param  [FileTreeSpec] spec
+    #         the spec
+    #
+    def initialize(spec)
+      super()
+      @spec = spec
+    end
+
+    # Return a description text for an expectation that a file path
+    # was expected to exist, but is missing.
+    #
+    # @param  [Pathname] file_path
+    #         the file path which was expected to exist
+    #
+    # @return [String]
+    #
+    def describe_missing_file(file_path)
+      description = []
+      description << "Missing file for #{spec.spec_folder}:"
+      description << "  * #{file_path.to_s.red}"
+      description * "\n"
+    end
+
+    # Return a description text for an expectation that certain file paths
+    # were unexpected.
+    #
+    # @param  [Array<Pathname>] file_paths
+    #
+    # @return [String]
+    #
+    def describe_unexpected_files(file_paths)
+      description = []
+      description << "Unexpected files for #{spec.spec_folder}:"
+      description += file_paths.map { |f| "  * #{f.to_s.green}" }
+      description * "\n"
+    end
+
+    # Return a description text for an expectation that two files were
+    # expected to be the same, but are not.
+    #
+    # @param  [Diff] diff
+    #         the diff which holds the difference
+    #
+    # @param  [Integer] max_width
+    #         the max width of the terminal to print matching separators
+    #
+    # @return [String]
+    #
+    def describe_file_diff(diff, max_width=80)
+      description = []
+      description << "File comparison error `#{diff.relative_path}` for #{spec.spec_folder}:"
+      description << "--- DIFF ".ljust(max_width, '-')
+      description += diff.map do |line|
+        case line
+          when /^\+/ then line.green
+          when /^-/ then  line.red
+          else            line
+        end.gsub("\n",'')
+      end
+      description << "--- END ".ljust(max_width, '-')
+      description << ''
+      description * "\n"
+    end
+
+  end
+end

data/lib/CLIntegracon/subject.rb

@@ -0,0 +1,128 @@
+module CLIntegracon
+  class Subject
+
+    #-----------------------------------------------------------------------------#
+
+    # @!group Attributes
+
+    # @return [String]
+    #         The name of the binary to use for the tests
+    attr_accessor :name
+
+    # @return [String]
+    #         The executable statement to use for the tests
+    attr_accessor :executable
+
+    # @return [Hash<String,String>]
+    #         The environment variables which will always been defined for the executable
+    #         on launch should not been passed explicitly every time to the launch method.
+    attr_accessor :environment_vars
+
+    # @return [Array<String>]
+    #         The arguments which will always passed to the executable on launch and
+    #         should not been passed explicitly every time to the launch method.
+    #         Those are added behind the arguments given on +launch+.
+    attr_accessor :default_args
+
+    # @return [Hash<String,String>]
+    #         The special paths, which are not relative to the project, when the statement
+    #         will be executed. These are paths were side-effects occur, like manipulation
+    #         of user configurations in dot files or caching-specific directories.
+    attr_accessor :special_paths
+
+    # @return [String]
+    #         The path where the output of the executable will be written to.
+    attr_accessor :output_path
+
+
+    #-----------------------------------------------------------------------------#
+
+    # @!group Initializer
+
+    # "Designated" initializer
+    #
+    # @param [String] name
+    #        The name of the binary
+    #
+    # @param [String] executable
+    #        The executable subject statement (optional)
+    #
+    def initialize(name='subject', executable=nil)
+      self.name = name
+      self.executable = executable || name
+      self.environment_vars = {}
+      self.default_args = []
+      self.special_paths = {}
+      self.output_path = 'execution_output.txt'
+    end
+
+
+    #-----------------------------------------------------------------------------#
+
+    # @!group DSL-like Setter
+
+    # Define a path in the user directory as special path
+    #
+    # @param [String] path
+    #        The path
+    #
+    # @param [String] name
+    #        The name of the path, or the basename of the given path
+    #
+    def has_special_path(path, name=nil)
+      name ||= File.basename path
+      self.special_paths[name] = path
+    end
+
+    # Define a path in the user directory as special path
+    #
+    # @param [String] path
+    #        The path
+    #
+    # @param [String] name
+    #        The name of the path, or the basename of the given path
+    #
+    def has_special_user_path(path, name=nil)
+      self.has_special_path %r[/Users/.*/#{path.to_s}], name
+    end
+
+    #-----------------------------------------------------------------------------#
+
+    # @!group Interaction
+
+    # Runs the executable with the given arguments in the temporary directory.
+    #
+    # @note: You can check by `$?.success?` if the execution succeeded.
+    #
+    # @param  [String] head_arguments
+    #         The arguments to pass to the executable before the default arguments.
+    #
+    # @param  [String] tail_arguments
+    #         The arguments to pass to the executable after the default arguments.
+    #
+    # @return [String]
+    #         The output, which is emitted while execution from the binary.
+    #
+    def launch(head_arguments='', tail_arguments='')
+      vars = environment_vars.map { |key,value| "#{key}=#{value}" }.join ' '
+      args = [head_arguments, default_args, tail_arguments].flatten.compact.select { |s| s.length > 0 }.join ' '
+      command = "#{vars} #{executable} #{args} 2>&1"
+
+      output = `#{command}`
+
+      File.open(output_path, 'w') do |file|
+        file.write command.sub(executable, name)
+        file.write "\n"
+
+        special_paths.each do |key, path|
+          output.gsub!(path, key)
+        end
+
+        file.write output
+      end
+
+      output
+    end
+
+  end
+end

data/lib/CLIntegracon/version.rb

@@ -0,0 +1,3 @@
+module CLIntegracon
+  VERSION = "0.4.1"
+end

data/spec/bacon/execution_output.txt

@@ -0,0 +1,72 @@
+CLIntegracon::Adapter::Bacon
+  coffee-maker
+    Brew recipes
+      without milk
+        - $ coffee-maker --no-milk
+        - BlackEye.brewed-coffee
+        - CaPheSuaDa.brewed-coffee
+        - Coffeemakerfile.yml
+        - execution_output.txt
+        - RedTux.brewed-coffee
+        - should not produce unexpected files [FAILED]
+      with honey as sweetner
+        - $ coffee-maker --sweetner=honey
+        - Affogato.brewed-coffee [FAILED]
+        - BlackEye.brewed-coffee [FAILED]
+        - Coffeemakerfile.yml
+        - execution_output.txt
+        - RedTux.brewed-coffee [FAILED]
+        - should not produce unexpected files
+    Get help
+      - $ coffee-maker --help
+      - execution_output.txt
+      - should not produce unexpected files
+
+Bacon::Error: Unexpected files for coffeemaker_no_milk:
+  * Affogato.brewed-coffee
+	./spec/bacon/spec_helper.rb:45
+	./spec/bacon/spec_helper.rb:44
+	./spec/bacon/spec_helper.rb:42
+	./spec/bacon/spec_helper.rb:17
+	./spec/bacon/spec_helper.rb:15
+	$GEM_HOME/bin/ruby_executable_hooks:15
+
+Bacon::Error: File comparison error `Affogato.brewed-coffee` for coffeemaker_sweetner_honey:
+--- DIFF -----------------------------------------------------------------------
+ class Affogato < BrewedCoffee
++  @milk = true
+   @sweetner = honey
+--- END ------------------------------------------------------------------------
+
+	./spec/bacon/spec_helper.rb:49
+	./spec/bacon/spec_helper.rb:48
+	./spec/bacon/spec_helper.rb:42
+	./spec/bacon/spec_helper.rb:17
+	./spec/bacon/spec_helper.rb:15
+	$GEM_HOME/bin/ruby_executable_hooks:15
+
+Bacon::Error: Missing file for coffeemaker_sweetner_honey:
+  * BlackEye.brewed-coffee
+	./spec/bacon/spec_helper.rb:49
+	./spec/bacon/spec_helper.rb:48
+	./spec/bacon/spec_helper.rb:42
+	./spec/bacon/spec_helper.rb:17
+	./spec/bacon/spec_helper.rb:15
+	$GEM_HOME/bin/ruby_executable_hooks:15
+
+Bacon::Error: File comparison error `RedTux.brewed-coffee` for coffeemaker_sweetner_honey:
+--- DIFF -----------------------------------------------------------------------
+ class RedTux < BrewedCoffee
+-  @sweetner = sugar
++  @milk = true
++  @sweetner = honey
+--- END ------------------------------------------------------------------------
+
+	./spec/bacon/spec_helper.rb:49
+	./spec/bacon/spec_helper.rb:48
+	./spec/bacon/spec_helper.rb:42
+	./spec/bacon/spec_helper.rb:17
+	./spec/bacon/spec_helper.rb:15
+	$GEM_HOME/bin/ruby_executable_hooks:15
+
+17 specifications (27 requirements), 4 failures, 0 errors

data/spec/bacon/spec_helper.rb

@@ -0,0 +1,60 @@
+require 'bacon'
+require 'CLIntegracon'
+
+ROOT = Pathname.new(File.expand_path('../../../', __FILE__))
+BIN  = ROOT + 'spec/fixtures/bin'
+
+CLIntegracon.configure do |c|
+  c.context.spec_path = ROOT + 'spec/integration'
+  c.context.temp_path = ROOT + 'tmp/bacon_specs'
+
+  c.hook_into :bacon
+end
+
+
+describe CLIntegracon::Adapter::Bacon do
+
+  describe_cli 'coffee-maker' do
+
+    subject do |s|
+      s.name = 'coffee-maker'
+      s.executable = "bundle exec ruby #{BIN}/coffeemaker.rb"
+      s.environment_vars = {
+          'COFFEE_MAKER_FILE' => 'Coffeemakerfile.yml'
+      }
+      s.default_args = [
+          '--verbose',
+          '--no-ansi'
+      ]
+      s.has_special_path ROOT.to_s, 'ROOT'
+      s.has_special_path `bundle show claide`.rstrip, 'CLAIDE_SRC'
+    end
+
+    context do |c|
+      c.ignores '.DS_Store'
+      c.ignores '.gitkeep'
+
+      c.has_special_handling_for 'execution_output.txt' do |path|
+        File.read(path).gsub(/:in `<main>'$/, '') # workaround different stack trace format by ruby-1.8.7
+      end
+    end
+
+    describe 'Brew recipes' do
+
+      describe 'without milk' do
+        behaves_like cli_spec('coffeemaker_no_milk', '--no-milk')
+      end
+
+      describe 'with honey as sweetner' do
+        behaves_like cli_spec('coffeemaker_sweetner_honey', '--sweetner=honey')
+      end
+
+    end
+
+    describe 'Get help' do
+      behaves_like cli_spec('coffeemaker_help', '--help')
+    end
+
+  end
+
+end

data/spec/fixtures/bin/coffeemaker.rb

@@ -0,0 +1,58 @@
+#encoding: utf-8
+
+require 'claide'
+require 'colored'
+require 'yaml'
+
+# Don’t worry, this makes no sense, just an example
+# command which modifies the file system.
+class CoffeeMaker < CLAide::Command
+  self.description = 'Make delicious coffee from the comfort of your terminal.'
+
+  def self.options
+    [
+      ['--no-milk', 'Don’t add milk'],
+      ['--sweetner=[sugar|honey]', 'Use one of the available sweetners'],
+    ].concat(super)
+  end
+
+  def initialize(argv)
+    @add_milk = argv.flag?('milk', true)
+    @sweetner = argv.option('sweetner')
+    @config_file = ENV['COFFEE_MAKER_FILE'] || 'Coffeemakerfile'
+    super
+  end
+
+  def validate!
+    super
+    if @sweetner && !%w(sugar honey).include?(@sweetner)
+      help! "'#{@sweetner}' is not a valid sweetner."
+    end
+  end
+
+  def brew(recipe)
+    File.open recipe+'.brewed-coffee', 'w' do |f|
+      f.write "class #{recipe} < BrewedCoffee\n"
+      if @add_milk
+        f.write "  @milk = true\n"
+      end
+      if @sweetner
+        f.write "  @sweetner = #{@sweetner}\n"
+      end
+    end
+  end
+
+  def run
+    @config = YAML.load_file @config_file
+    if @config['recipes'] == nil
+      help! "Didn’t found any `recipes` in the Coffeemakerfile.yml."
+    end
+    @config['recipes'].each do |recipe|
+      puts "* Brewing #{recipe}"
+      brew(recipe)
+    end
+    puts '* Enjoy!'
+  end
+end
+
+CoffeeMaker.run(ARGV)

data/spec/integration/coffeemaker_help/after/execution_output.txt

@@ -0,0 +1,23 @@
+COFFEE_MAKER_FILE=Coffeemakerfile.yml coffee-maker --help --verbose --no-ansi 2>&1
+Usage:
+
+    $ coffee-maker
+
+      Make delicious coffee from the comfort of your terminal.
+
+Options:
+
+    --no-milk                  Don’t add milk
+    --sweetner=[sugar|honey]   Use one of the available sweetners
+    --completion-script        Print the auto-completion script
+    --version                  Show the version of the tool
+    --verbose                  Show more debugging information
+    --no-ansi                  Show output without ANSI codes
+    --help                     Show help banner of specified command
+
+CLAIDE_SRC/lib/claide/command.rb:348:in `help!'
+CLAIDE_SRC/lib/claide/command.rb:466:in `help!'
+CLAIDE_SRC/lib/claide/command.rb:434:in `validate!'
+ROOT/spec/fixtures/bin/coffeemaker.rb:27:in `validate!'
+CLAIDE_SRC/lib/claide/command.rb:280:in `run'
+ROOT/spec/fixtures/bin/coffeemaker.rb:58:in `<main>'

data/spec/integration/coffeemaker_no_milk/after/BlackEye.brewed-coffee

@@ -0,0 +1 @@
+class BlackEye < BrewedCoffee

data/spec/integration/coffeemaker_no_milk/after/CaPheSuaDa.brewed-coffee

@@ -0,0 +1 @@
+class CaPheSuaDa < BrewedCoffee

data/spec/integration/coffeemaker_no_milk/after/Coffeemakerfile.yml

@@ -0,0 +1,5 @@
+recipes:
+  - BlackEye
+  - Affogato
+  - CaPheSuaDa
+  - RedTux

data/spec/integration/coffeemaker_no_milk/after/RedTux.brewed-coffee

@@ -0,0 +1 @@
+class RedTux < BrewedCoffee

data/spec/integration/coffeemaker_no_milk/after/execution_output.txt

@@ -0,0 +1,6 @@
+COFFEE_MAKER_FILE=Coffeemakerfile.yml coffee-maker --no-milk --verbose --no-ansi 2>&1
+* Brewing BlackEye
+* Brewing Affogato
+* Brewing CaPheSuaDa
+* Brewing RedTux
+* Enjoy!