aye_commander 1.0.0

data/spec/aye_commander/resultable_spec.rb

@@ -0,0 +1,64 @@
+describe AyeCommander::Resultable::ClassMethods do
+  include_context :command
+
+  context '.result' do
+    it 'returns the command if command option is specified' do
+      expect(command.result(instance, :command)).to eq instance
+    end
+
+    it 'calls and returns .new_result with the complete hash if true option is specified' do
+      expect(instance).to receive(:to_hash).and_return(:stubbed)
+      expect(command).to  receive(:new_result).with(:stubbed).and_return(:result)
+      expect(command.result(instance, true)).to eq :result
+    end
+
+    it 'calls and returns .new_result with the result hash if no option is specified' do
+      expect(instance).to receive(:to_result_hash).and_return(:stubbed)
+      expect(command).to  receive(:new_result).with(:stubbed).and_return(:result)
+      expect(command.result(instance, false)).to eq :result
+    end
+  end
+
+  context '.new_result' do
+    let(:values) { { :@status => :success } }
+
+    it 'returns an instance of the result class' do
+      expect(command.new_result(values)).to be_an_instance_of result_class
+    end
+
+    it 'should contain the expected results' do
+      expect(command.new_result(values).to_hash).to eq values
+    end
+  end
+
+  context '.result_class' do
+    it 'returns the result class' do
+      expect(result_class).to be_an_instance_of Class
+    end
+
+    it 'defines the class under the Result const name' do
+      expect(result_class).to eq command.const_get('Result')
+    end
+
+    it 'only defines the class once' do
+      expect(result_class.object_id).to eq command.result_class.object_id
+    end
+
+    it 'includes the necessary result modules' do
+      expect(result_class).to include AyeCommander::Initializable
+      expect(result_class).to include AyeCommander::Inspectable
+      expect(result_class).to include AyeCommander::Status::Readable
+      expect(result_class).to include AyeCommander::Ivar::Readable
+    end
+
+    it 'extends the necessary result modules' do
+      expect(result_class.singleton_class).to include AyeCommander::Ivar::ClassMethods
+    end
+
+    it 'defines readers for the class' do
+      command.uses :variable
+      expect(result_class.new).to respond_to :variable
+      expect(result_class.new).to_not respond_to :variable=
+    end
+  end
+end

data/spec/aye_commander/shareable_spec.rb

@@ -0,0 +1,38 @@
+describe AyeCommander::Shareable::ClassMethods do
+  include_context :command
+
+  context '.included' do
+    it 'ensures that the includer has command methods available' do
+      expect(includer.ancestors).to include AyeCommander::Command
+      expect(includer.singleton_class.ancestors).to include AyeCommander::Command::ClassMethods
+    end
+
+    it 'ensure that even down the line the command methods are available' do
+      expect(includer2.ancestors).to include AyeCommander::Command
+      expect(includer2.singleton_class.ancestors).to include AyeCommander::Command::ClassMethods
+    end
+
+    it 'adds the needed instance variables to the further includers' do
+      includer.receives :hopefully_this
+      includer.succeeds_with :inclusion
+      expect(includer2.receives).to include :hopefully_this
+      expect(includer2.succeeds).to include :inclusion
+      expect(includer2.send(:hooks)).to be_empty
+    end
+  end
+
+  context '.inherited' do
+    it 'has access to the command class methods' do
+      expect(inheriter.ancestors).to include AyeCommander::Command
+      expect(inheriter.singleton_class.ancestors).to include AyeCommander::Command::ClassMethods
+    end
+
+    it 'adds the needed instance variables to the further inheriters' do
+      command.receives :hopefully_this
+      command.succeeds_with :inclusion
+      expect(inheriter.receives).to include :hopefully_this
+      expect(inheriter.succeeds).to include :inclusion
+      expect(inheriter.send(:hooks)).to be_empty
+    end
+  end
+end

data/spec/aye_commander/status_spec.rb

@@ -0,0 +1,97 @@
+describe AyeCommander::Status::ClassMethods do
+  include_context :command
+
+  context '.succeeds' do
+    it 'returns [:success] if nothing else has been set' do
+      expect(command.succeeds).to eq [:success]
+    end
+
+    it 'returns whathever the :@succeds class instance variable contains' do
+      command.instance_variable_set :@succeeds, %i(im a little teapot)
+      expect(command.succeeds).to eq %i(im a little teapot)
+    end
+  end
+
+  context '.suceeds_with' do
+    let(:args) { %i(succ1 succ2) }
+
+    before :each do
+      command.succeeds_with(*args)
+    end
+
+    it 'adds the values to the succeeds array' do
+      expect(command.succeeds).to eq %i(success succ1 succ2)
+    end
+
+    it 'allows consecutive succeeds' do
+      command.succeeds_with :potato
+      expect(command.succeeds).to eq %i(success succ1 succ2 potato)
+    end
+
+    it 'doesnt add repeated succeeds' do
+      command.succeeds_with(*args)
+      expect(command.succeeds).to eq %i(success succ1 succ2)
+    end
+
+    it 'removes :success from the array if called with the exclude_suceed option' do
+      command.succeeds_with exclude_success: true
+      expect(command.succeeds).to eq args
+    end
+  end
+end
+
+describe AyeCommander::Status::Readable do
+  include_context :command
+
+  context 'when included' do
+    it 'adds #status method' do
+      expect(instance).to respond_to :status
+    end
+  end
+
+  context '#success?' do
+    it 'returns true if nothing else is set' do
+      expect(instance.success?).to be true
+    end
+
+    it 'returns true if status is contained in the succeeds array' do
+      command.succeeds_with :taco
+      instance.status = :taco
+      expect(instance.success?).to be true
+    end
+
+    it 'returns false if status is NOT contained in the succeeds array' do
+      command.succeeds_with :taco, exclude_success: true
+      instance.status = :success
+      expect(instance.success?).to be false
+    end
+  end
+
+  context '#failure?' do
+    it 'is the boolean opposite of success' do
+      expect(instance.failure?).to be false
+    end
+  end
+end
+
+describe AyeCommander::Status::Writeable do
+  include_context :command
+
+  context 'when included' do
+    it 'adds #status= method' do
+      expect(instance).to respond_to :status=
+    end
+  end
+
+  context '#fail!' do
+    it 'fails the command with :failure' do
+      instance.fail!
+      expect(instance.status).to eq :failure
+    end
+
+    it 'fails the command with specified status' do
+      instance.fail!(:meltdown)
+      expect(instance.status).to eq :meltdown
+    end
+  end
+end

data/spec/aye_commander_spec.rb

@@ -0,0 +1,5 @@
+describe AyeCommander do
+  it 'should exist' do
+    expect(AyeCommander).to be
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec/'
+  end
+end
+
+require 'pry'
+require 'aye_commander'
+
+# Shared context for command tests
+shared_context :command do
+  let(:command) do
+    Class.new do
+      include AyeCommander::Command
+      define_method(:call) {}
+    end
+  end
+
+  let(:commandsc)    { command.singleton_class }
+  let(:instance)     { command.new }
+  let(:result)       { command.result_class.new }
+  let(:result_class) { command.result_class }
+
+  let(:inheriter) { Class.new(command) }
+  let(:includer)  { Module.new.send(:include, AyeCommander::Command) }
+  let(:includer2) { Module.new.send(:include, includer) }
+end
+
+# Shared context for commander tests
+shared_context :commander do
+  let(:command) do
+    Class.new do
+      include AyeCommander::Command
+      define_method(:call) {}
+    end
+  end
+
+  let(:commander) { Class.new.send(:include, AyeCommander::Commander) }
+  let(:instance)  { commander.new }
+  let(:commandi)  { command.new }
+
+  let(:includer)  { Module.new.send(:include, AyeCommander::Commander) }
+  let(:includer2) { Module.new.send(:include, includer) }
+  let(:inheriter) { Class.new(commander) }
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: aye_commander
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- pyzlnar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies: []
+description: A gem that helps to write commands in ruby.
+email: pyzlnar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- lib/aye_commander.rb
+- lib/aye_commander/abortable.rb
+- lib/aye_commander/callable.rb
+- lib/aye_commander/command.rb
+- lib/aye_commander/commander.rb
+- lib/aye_commander/errors.rb
+- lib/aye_commander/hookable.rb
+- lib/aye_commander/initializable.rb
+- lib/aye_commander/inspectable.rb
+- lib/aye_commander/ivar.rb
+- lib/aye_commander/limitable.rb
+- lib/aye_commander/resultable.rb
+- lib/aye_commander/shareable.rb
+- lib/aye_commander/status.rb
+- lib/aye_commander/version.rb
+- spec/aye_commander/abortable_spec.rb
+- spec/aye_commander/callable_spec.rb
+- spec/aye_commander/command_spec.rb
+- spec/aye_commander/commander_spec.rb
+- spec/aye_commander/errors_spec.rb
+- spec/aye_commander/hookable_spec.rb
+- spec/aye_commander/initializable_spec.rb
+- spec/aye_commander/inspectable_spec.rb
+- spec/aye_commander/ivar_spec.rb
+- spec/aye_commander/limitable_spec.rb
+- spec/aye_commander/resultable_spec.rb
+- spec/aye_commander/shareable_spec.rb
+- spec/aye_commander/status_spec.rb
+- spec/aye_commander_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pyzlnar/aye_commander
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A simple command pattern gem
+test_files:
+- spec/aye_commander/abortable_spec.rb
+- spec/aye_commander/callable_spec.rb
+- spec/aye_commander/command_spec.rb
+- spec/aye_commander/commander_spec.rb
+- spec/aye_commander/errors_spec.rb
+- spec/aye_commander/hookable_spec.rb
+- spec/aye_commander/initializable_spec.rb
+- spec/aye_commander/inspectable_spec.rb
+- spec/aye_commander/ivar_spec.rb
+- spec/aye_commander/limitable_spec.rb
+- spec/aye_commander/resultable_spec.rb
+- spec/aye_commander/shareable_spec.rb
+- spec/aye_commander/status_spec.rb
+- spec/aye_commander_spec.rb
+- spec/spec_helper.rb