producer-core 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 459e9b701305da92f97559b14552a99a244d3df2
-  data.tar.gz: 9803a517b543aba2e7f7eb23de3eb59eee7696df
+  metadata.gz: e267920fce6f6536aa7aeabe841d440bd3ffae7b
+  data.tar.gz: d9f71061074b02737726ccbbb56f468fdc5e8432
 SHA512:
-  metadata.gz: 027259efb32585c69b5f05c8aac66a8b5917037b33f4d82ea727eb8946a897229e4e546c1e395b27a7dd501321fdc247bccb475a03146c4227ed850045cdc5ca
-  data.tar.gz: 2aa5aa800650d057e0a6b13aca136c56c615c8d572879dc56d010bacf97fe4b5d0607b8b96af3f576d6b002eac3b045a07d4f2ba90dce6d6771f9823001b1a8b
+  metadata.gz: c4fd1d85b8191a94838c39f866f3fcb583c9e4a59c7db09b7a37c84d5c0cf096d55ae92d11bba1362cee35f3c7262b1e044075cba0ff82bb6ba2387284aec9d3
+  data.tar.gz: 5b9e9ea1ec0f4f5ae937c23d53ba115fd9f4427a810b4ea8a674c39dd6289ce59e3389c601244bdc71b0984451ba12e614baafa17e0aea6bebcaa1b90b91887e

data/bin/producer

@@ -2,4 +2,4 @@
 
 require 'producer/core'
 
-Producer::Core::CLI.new(ARGV).run!
+Producer::Core::CLI.run!(ARGV)

data/features/actions/echo.feature

@@ -1,11 +1,11 @@
 Feature: `echo' task action
 
-  Scenario: ouputs text
+  Scenario: prints text on standard output
     Given a recipe with:
       """
-      task :some_task do
+      task :say_hello do
         echo 'hello'
       end
       """
     When I successfully execute the recipe
-    Then the output must contain exactly "hello\n"
+    Then the output must match /\Ahello\n/

data/lib/producer/core/actions/echo.rb

@@ -3,7 +3,7 @@ module Producer
     module Actions
       class Echo < Action
         def apply
-          env.output arguments.first
+          env.output.puts arguments.first
         end
       end
     end

data/lib/producer/core/actions/shell_command.rb

@@ -3,7 +3,7 @@ module Producer
     module Actions
       class ShellCommand < Action
         def apply
-          env.output env.remote.execute(arguments.first)
+          env.output.puts env.remote.execute(arguments.first)
         end
       end
     end

data/lib/producer/core/cli.rb

@@ -1,24 +1,34 @@
 module Producer
   module Core
     class CLI
+      ArgumentError = Class.new(::ArgumentError)
+
       USAGE = "Usage: #{File.basename $0} recipe_file"
 
-      attr_reader :arguments
+      class << self
+        def run!(arguments, output: $stderr)
+          begin
+            cli = new(arguments)
+          rescue ArgumentError
+            output.puts USAGE
+            exit 64
+          end
+          cli.run!
+        end
+      end
 
-      def initialize(arguments, stdout = $stdout)
-        @stdout     = stdout
+      attr_reader :arguments, :stdout
+
+      def initialize(arguments, stdout: $stdout)
+        raise ArgumentError unless arguments.any?
         @arguments  = arguments
+        @stdout     = stdout
       end
 
       def run!
-        check_arguments!
         interpreter.process recipe.tasks
       end
 
-      def check_arguments!
-        print_usage_and_exit(64) unless @arguments.length == 1
-      end
-
       def env
         @env ||= Env.new
       end
@@ -30,14 +40,6 @@ module Producer
       def interpreter
         @interpreter ||= Interpreter.new
       end
-
-      private
-
-      def print_usage_and_exit(status)
-        @stdout.puts USAGE
-
-        exit status
-      end
     end
   end
 end

data/lib/producer/core/env.rb

@@ -1,18 +1,13 @@
 module Producer
   module Core
     class Env
-      attr_writer   :output
-      attr_accessor :target
+      attr_accessor :output, :target
 
-      def initialize
-        @output = $stdout
+      def initialize(output: $stdout)
+        @output = output
         @target = nil
       end
 
-      def output(str)
-        @output.puts str
-      end
-
       def remote
         @remote ||= Remote.new(target)
       end

data/lib/producer/core/remote/environment.rb

@@ -2,24 +2,23 @@ module Producer
   module Core
     class Remote
       class Environment
+        class << self
+          def string_to_hash(str)
+            Hash[str.each_line.map { |l| l.chomp.split '=', 2 }]
+          end
+
+          def new_from_string(str)
+            new string_to_hash str
+          end
+        end
+
         require 'forwardable'
 
         extend Forwardable
         def_delegator :@variables, :has_key?
 
         def initialize(variables)
-          case variables
-          when String
-            @variables = parse_from_string variables
-          else
-            @variables = variables
-          end
-        end
-
-        private
-
-        def parse_from_string(str)
-          Hash[str.each_line.map { |l| l.chomp.split '=', 2 }]
+          @variables = variables
         end
       end
     end

data/lib/producer/core/remote.rb

@@ -45,7 +45,7 @@ module Producer
       end
 
       def environment
-        Environment.new(execute 'env')
+        Environment.new_from_string(execute 'env')
       end
     end
   end

data/lib/producer/core/version.rb

@@ -1,5 +1,5 @@
 module Producer
   module Core
-    VERSION = '0.1.7'
+    VERSION = '0.1.8'
   end
 end

data/producer-core.gemspec

@@ -1,11 +1,9 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH << lib unless $LOAD_PATH.include? lib
-require 'producer/core/version'
+require File.expand_path('../lib/producer/core/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name    = 'producer-core'
-  s.version = Producer::Core::VERSION
-  s.summary = "producer-core-#{Producer::Core::VERSION}"
+  s.version = Producer::Core::VERSION.dup
+  s.summary = 'Provisioning tool'
   s.description = <<-eoh.gsub(/^ +/, '')
     Software provisioning tool, including a DSL to write "recipes".
   eoh

data/spec/producer/core/actions/echo_spec.rb

@@ -2,14 +2,14 @@ require 'spec_helper'
 
 module Producer::Core
   describe Actions::Echo do
-    let(:env)       { double 'env' }
+    let(:env)       { Env.new(output: StringIO.new) }
     let(:text)      { 'hello' }
     subject(:echo)  { Actions::Echo.new(env, text) }
 
     describe '#apply' do
-      it 'outputs the string given as argument through env.output' do
-        expect(env).to receive(:output).with(text)
+      it 'writes the given string to env.output with a record separator' do
         echo.apply
+        expect(env.output.string).to eq "hello\n"
       end
     end
   end

data/spec/producer/core/actions/shell_command_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module Producer::Core
   describe Actions::ShellCommand do
-    let(:env)           { Env.new }
+    let(:env)           { Env.new(output: StringIO.new) }
     let(:command_args)  { 'hello from remote host' }
     let(:command)       { "echo #{command_args}" }
     subject(:sh)        { Actions::ShellCommand.new(env, command) }
@@ -15,10 +15,10 @@ module Producer::Core
         sh.apply
       end
 
-      it 'forwards the returned output to env.output' do
+      it 'writes the returned output to env.output with a record separator' do
         allow(env.remote).to receive(:execute) { command_args }
-        expect(env).to receive(:output).with(command_args)
         sh.apply
+        expect(env.output.string).to eq "#{command_args}\n"
       end
     end
   end

data/spec/producer/core/cli_spec.rb

@@ -7,11 +7,53 @@ module Producer::Core
 
     let(:recipe_file) { fixture_path_for 'recipes/empty.rb' }
     let(:arguments)   { [recipe_file] }
-    subject(:cli)     { CLI.new(arguments) }
+    let(:stdout)      { StringIO.new }
+
+    subject(:cli)     { CLI.new(arguments, stdout: stdout) }
+
+    describe '.run!' do
+      let(:output)    { StringIO.new }
+      subject(:run)   { described_class.run! arguments, output: output }
+
+      it 'builds a new CLI with given arguments' do
+        expect(CLI).to receive(:new).with(arguments).and_call_original
+        run
+      end
+
+      it 'runs the CLI' do
+        cli = double 'cli'
+        allow(CLI).to receive(:new) { cli }
+        expect(cli).to receive :run!
+        run
+      end
+
+      context 'when recipe argument is missing' do
+        let(:arguments) { [] }
+
+        it 'exits with a return status of 64' do
+          expect { run }.to raise_error(SystemExit) { |e|
+            expect(e.status).to eq 64
+          }
+        end
+
+        it 'prints the usage' do
+          trap_exit { run }
+          expect(output.string).to match /\AUsage: .+/
+        end
+      end
+    end
 
     describe '#initialize' do
+      subject(:cli) { CLI.new(arguments) }
+
       it 'assigns $stdout as the default standard output' do
-        expect(cli.instance_eval { @stdout }).to be $stdout
+        expect(cli.stdout).to be $stdout
+      end
+
+      context 'without arguments' do
+        let(:arguments) { [] }
+
+        specify { expect { cli }.to raise_error described_class::ArgumentError }
       end
     end
 
@@ -21,12 +63,13 @@ module Producer::Core
       end
     end
 
-    describe '#run!' do
-      it 'checks the arguments' do
-        expect(cli).to receive :check_arguments!
-        cli.run!
+    describe '#stdout' do
+      it 'returns the assigned standard output' do
+        expect(cli.stdout).to be stdout
       end
+    end
 
+    describe '#run!' do
       it 'processes the tasks with the interpreter' do
         allow(cli.recipe).to receive(:tasks) { [:some_task] }
         expect(cli.interpreter).to receive(:process).with [:some_task]
@@ -34,31 +77,6 @@ module Producer::Core
       end
     end
 
-    describe '#check_arguments!' do
-      context 'when recipe argument is provided' do
-        it 'does not raise any error' do
-          expect { cli.check_arguments! }.to_not raise_error
-        end
-      end
-
-      context 'when recipe argument is missing' do
-        let(:arguments) { [] }
-        let(:stdout)    { StringIO.new }
-        subject(:cli)   { CLI.new(arguments, stdout) }
-
-        it 'exits with a return status of 64' do
-          expect { cli.check_arguments! }.to raise_error(SystemExit) { |e|
-            expect(e.status).to eq 64
-          }
-        end
-
-        it 'prints the usage' do
-          trap_exit { cli.check_arguments! }
-          expect(stdout.string).to match /\AUsage: .+/
-        end
-      end
-    end
-
     describe '#env' do
       it 'builds an environment with the current recipe' do
         expect(Env).to receive :new

data/spec/producer/core/env_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 module Producer::Core
   describe Env do
+    let(:output)  { double 'output' }
     subject(:env) { Env.new }
 
     describe '#initialize' do
@@ -12,15 +13,21 @@ module Producer::Core
       it 'assigns no default target' do
         expect(env.target).not_to be
       end
+
+      context 'when output is given as argument' do
+        subject(:env) { Env.new(output: output) }
+
+        it 'assigns the given output' do
+          expect(env.instance_eval { @output }).to eq output
+        end
+      end
     end
 
     describe '#output' do
-      let(:stdout) { StringIO.new }
+      subject(:env) { Env.new(output: output) }
 
-      it 'writes the given string to the assigned IO with a record separator' do
-        env.output = stdout
-        env.output 'some content'
-        expect(stdout.string).to eq "some content\n"
+      it 'returns the assigned output' do
+        expect(env.output).to eq output
       end
     end
 

data/spec/producer/core/remote/environment_spec.rb

@@ -7,19 +7,29 @@ module Producer::Core
     let(:argument)        { variables }
     subject(:environment) { Remote::Environment.new(argument) }
 
-    describe '#initialize' do
-      context 'when a hash is given' do
-        it 'assigns the key/value pairs' do
-          expect(environment.instance_eval { @variables }).to eq variables
-        end
+    describe '.string_to_hash' do
+      it 'converts key=value pairs separated by new lines to a hash' do
+        expect(Remote::Environment.string_to_hash(string))
+          .to eq variables
       end
+    end
 
-      context 'when a string is given' do
-        let(:argument) { string }
+    describe '.new_from_string' do
+      it 'builds a new instance after converting from string' do
+        expect(Remote::Environment).to receive(:new).with(variables)
+        Remote::Environment.new_from_string(string)
+      end
 
-        it 'assigns the key/value pairs' do
-          expect(environment.instance_eval { @variables }).to eq variables
-        end
+      it 'returns the instance' do
+        environment = double 'environment'
+        allow(Remote::Environment).to receive(:new) { environment }
+        expect(Remote::Environment.new_from_string(string)).to be environment
+      end
+    end
+
+    describe '#initialize' do
+      it 'assigns the key/value pairs' do
+        expect(environment.instance_eval { @variables }).to eq variables
       end
     end
 

data/spec/producer/core/remote_spec.rb

@@ -128,13 +128,13 @@ module Producer::Core
       end
 
       it 'builds a remote environment with the result of `env` command' do
-        expect(Remote::Environment).to receive(:new).with(output)
+        expect(Remote::Environment).to receive(:new_from_string).with(output)
         remote.environment
       end
 
       it 'returns the environment' do
         environment = double 'environment'
-        allow(Remote::Environment).to receive(:new) { environment }
+        allow(Remote::Environment).to receive(:new_from_string) { environment }
         expect(remote.environment).to be environment
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: producer-core
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Thibault Jouan
@@ -201,7 +201,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: producer-core-0.1.7
+summary: Provisioning tool
 test_files:
 - features/actions/echo.feature
 - features/actions/file_write.feature