statefully 0.1.3 → 0.1.4

data/spec/diff_spec.rb

@@ -2,35 +2,43 @@ require 'spec_helper'
 
 module Statefully
   describe Diff do
-    subject { described_class.create(current, previous) }
+    let(:diff) { described_class.create(current: current, previous: previous) }
+
+    context 'when created' do
+      let(:current)  { State.create }
+      let(:previous) { State::None.instance }
+
+      it { expect(diff).to be_created }
+    end # context 'when created'
 
     context 'when key added' do
       let(:current)  { State.create(key: 'val') }
       let(:previous) { State.create }
 
-      it { expect(subject).not_to be_empty }
-      it { expect(subject.added).to have_key(:key) }
-      it { expect(subject.added?(:key)).to be_truthy }
-      it { expect(subject.added.fetch(:key)).to eq 'val' }
-      it { expect(subject.changed).to be_empty }
+      it { expect(diff).not_to be_empty }
+      it { expect(diff).not_to be_created }
+      it { expect(diff.added).to have_key(:key) }
+      it { expect(diff.added?(:key)).to be_truthy }
+      it { expect(diff.added.fetch(:key)).to eq 'val' }
+      it { expect(diff.changed).to be_empty }
 
-      it { expect(subject.inspect).to start_with '#<Statefully::Diff::Changed' }
-      it { expect(subject.inspect).to include 'added={key: "val"}>' }
+      it { expect(diff.inspect).to start_with '#<Statefully::Diff::Changed' }
+      it { expect(diff.inspect).to include 'added={key: "val"}>' }
     end # context 'when key added'
 
     context 'when key changed' do
       let(:current)  { State.create(key: 'new') }
       let(:previous) { State.create(key: 'old') }
 
-      it { expect(subject).not_to be_empty }
-      it { expect(subject.added).to be_empty }
-      it { expect(subject.changed).to have_key(:key) }
-      it { expect(subject.changed?(:key)).to be_truthy }
+      it { expect(diff).not_to be_empty }
+      it { expect(diff.added).to be_empty }
+      it { expect(diff.changed).to have_key(:key) }
+      it { expect(diff.changed?(:key)).to be_truthy }
 
-      it { expect(subject.inspect).to include 'changed=' }
+      it { expect(diff.inspect).to include 'changed=' }
 
       context 'with change' do
-        let(:change) { subject.changed.fetch(:key) }
+        let(:change) { diff.changed.fetch(:key) }
 
         it { expect(change.current).to eq 'new' }
         it { expect(change.previous).to eq 'old' }
@@ -41,14 +49,14 @@ module Statefully
       let(:current)  { State.create(key: 'key') }
       let(:previous) { current }
 
-      it { expect(subject).to be_empty }
-      it { expect(subject.inspect).to eq '#<Statefully::Diff::Unchanged>' }
+      it { expect(diff).to be_empty }
+      it { expect(diff.inspect).to eq '#<Statefully::Diff::Unchanged>' }
     end # context 'when nothing changed'
 
     shared_examples 'diff_is_empty' do
-      it { expect(subject).to be_empty }
-      it { expect(subject.added).to be_empty }
-      it { expect(subject.changed).to be_empty }
+      it { expect(diff).to be_empty }
+      it { expect(diff.added).to be_empty }
+      it { expect(diff.changed).to be_empty }
     end # shared_examples 'diff_is_empty'
 
     context 'when failed' do
@@ -58,10 +66,10 @@ module Statefully
 
       it_behaves_like 'diff_is_empty'
 
-      it { expect(subject.error).to eq error }
+      it { expect(diff.error).to eq error }
 
-      it { expect(subject.inspect).to start_with '#<Statefully::Diff::Failed' }
-      it { expect(subject.inspect).to include 'error=#<RuntimeError: boo!>' }
+      it { expect(diff.inspect).to start_with '#<Statefully::Diff::Failed' }
+      it { expect(diff.inspect).to include 'error=#<RuntimeError: boo!>' }
     end # context 'when failed'
 
     context 'when finished' do
@@ -70,7 +78,7 @@ module Statefully
 
       it_behaves_like 'diff_is_empty'
 
-      it { expect(subject.inspect).to eq '#<Statefully::Diff::Finished>' }
+      it { expect(diff.inspect).to eq '#<Statefully::Diff::Finished>' }
     end # context 'when finished'
   end # describe Diff
 end # module Statefully

data/spec/errors_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module Statefully
+  module Errors
+    describe StateMissing do
+      let(:field) { :bacon }
+      let(:error) { described_class.new(field) }
+
+      it { expect(error.field).to eq field }
+      it { expect(error.message).to eq "field 'bacon' missing from state" }
+    end # describe StateMissing
+  end # module Errors
+end # module Statefully

data/spec/spec_helper.rb

@@ -3,10 +3,12 @@ Bundler.setup
 
 require 'pry'
 
-require 'simplecov'
-SimpleCov.start
+if ENV['CI'] == 'true'
+  require 'simplecov'
+  SimpleCov.start
 
-require 'codecov'
-SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
 
 require 'statefully'

data/spec/state_spec.rb

@@ -3,56 +3,87 @@ require 'spec_helper'
 module Statefully
   describe State do
     describe '.create' do
-      subject { described_class.create(key: 'val') }
-      it      { expect(subject).to be_successful }
+      let(:state) { described_class.create(**args) }
+
+      context 'without keyword arguments' do
+        let(:args) { {} }
+
+        it { expect(state).to be_successful }
+
+        context 'with diff' do
+          let(:diff)     { state.diff }
+          let(:expected) { '#<Statefully::Diff::Created>' }
+
+          it { expect(diff).to be_created }
+          it { expect(diff.inspect).to eq expected }
+        end # context 'with diff'
+      end # context 'without keyword arguments'
+
+      context 'with keyword arguments' do
+        let(:args) { { key: 'val' } }
+
+        context 'with diff' do
+          let(:diff)     { state.diff }
+          let(:expected) { '#<Statefully::Diff::Created added={key: "val"}>' }
+
+          it { expect(diff).to be_created }
+          it { expect(diff.inspect).to eq expected }
+        end # context 'with diff'
+      end # context 'with keyword arguments'
     end # describe '.create'
   end # describe State
 
   describe 'State::Success' do
-    let(:val) { 'val' }
-
-    subject { State.create(old_key: val) }
+    let(:val)   { 'val' }
+    let(:state) { State.create(old_key: val) }
 
     describe 'methods delegated to the underlying Hash' do
-      it { expect(subject.keys).to eq [:old_key] }
-      it { expect(subject.key?(:old_key)).to be_truthy }
-      it { expect(subject.any? { |_, value| value == val }).to be_truthy }
+      it { expect(state.keys).to eq [:old_key] }
+      it { expect(state.key?(:old_key)).to be_truthy }
+      it { expect(state.any? { |_, value| value == val }).to be_truthy }
     end # describe 'methods delegated to the underlying Hash'
 
     describe "methods dynamically dispatched using 'method_missing'" do
-      it { expect(subject.old_key).to eq val }
-      it { expect(subject.old_key?).to be_truthy }
-      it { expect(subject.old_key!).to eq val }
+      it { expect(state.old_key).to eq val }
+      it { expect(state.old_key?).to be_truthy }
+      it { expect(state.old_key!).to eq val }
 
-      it { expect { subject.new_key }.to raise_error NoMethodError }
-      it { expect(subject.new_key?).to be_falsey }
-      it { expect { subject.new_key! }.to raise_error State::Missing }
+      it { expect { state.new_key }.to raise_error NoMethodError }
+      it { expect(state.new_key?).to be_falsey }
+      it { expect { state.new_key! }.to raise_error Errors::StateMissing }
     end # describe "methods dynamically dispatched using 'method_missing'"
 
     describe 'trivial readers' do
-      it { expect(subject.resolve).to eq subject }
-      it { expect(subject).to be_successful }
-      it { expect(subject).not_to be_failed }
-      it { expect(subject).not_to be_finished }
+      it { expect(state.resolve).to eq state }
+      it { expect(state).to be_successful }
+      it { expect(state).not_to be_failed }
+      it { expect(state).not_to be_finished }
     end # describe 'trivial readers'
 
+    describe 'history' do
+      let(:history) { state.history }
+
+      it { expect(history.length).to eq 1 }
+      it { expect(history.first).to be_created }
+    end # describe 'history'
+
     describe '#inspect' do
       let(:expected) { '#<Statefully::State::Success old_key="val">' }
 
-      it { expect(subject.inspect).to eq expected }
+      it { expect(state.inspect).to eq expected }
     end # describe '#inspect'
 
     shared_examples 'successful_state' do
       it { expect(next_state).to be_successful }
       it { expect(next_state.old_key).to eq val }
 
-      it { expect(next_state.previous).to eq subject }
+      it { expect(next_state.previous).to eq state }
       it { expect(next_state.resolve).to eq next_state }
     end # shared_examples 'successful_state'
 
     describe '#succeed' do
       let(:new_val)    { 'new_val' }
-      let(:next_state) { subject.succeed(new_key: new_val) }
+      let(:next_state) { state.succeed(new_key: new_val) }
 
       it_behaves_like 'successful_state'
 
@@ -64,6 +95,7 @@ module Statefully
         let(:history) { next_state.history }
 
         it { expect(history.size).to eq 2 }
+        it { expect(history.first).not_to be_created }
         it { expect(history.first.added).to include :new_key }
         it { expect(history.last.added).to include :old_key }
       end # context 'with history'
@@ -71,21 +103,16 @@ module Statefully
 
     describe '#fail' do
       let(:error)      { RuntimeError.new('boo!') }
-      let(:next_state) { subject.fail(error) }
+      let(:next_state) { state.fail(error) }
 
       it { expect(next_state).not_to be_successful }
       it { expect(next_state).to be_failed }
       it { expect(next_state).not_to be_finished }
-      it { expect(subject).not_to be_finished }
+      it { expect(state).not_to be_finished }
       it { expect(next_state.old_key).to eq val }
-      it { expect(next_state.previous).to eq subject }
+      it { expect(next_state.previous).to eq state }
       it { expect(next_state.error).to eq error }
-
-      it 'raises passed error on #resolve' do
-        expect { next_state.resolve }.to raise_error do |err|
-          expect(err).to eq error
-        end
-      end
+      it { expect { next_state.resolve }.to raise_error(error) }
 
       describe '#inspect' do
         let(:inspect) { next_state.inspect }
@@ -106,7 +133,7 @@ module Statefully
 
     describe '#finish' do
       let(:new_val)    { 'new_val' }
-      let(:next_state) { subject.finish }
+      let(:next_state) { state.finish }
 
       it_behaves_like 'successful_state'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statefully
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Marcin Wyszynski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-21 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,6 +30,80 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.14.6
+- !ruby/object:Gem::Dependency
+  name: closing_comments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+- !ruby/object:Gem::Dependency
+  name: ensure_version_bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +118,128 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Immutable state with helpers to build awesome things
 email: 
 executables: []
@@ -51,16 +247,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/statefully.rb
+- lib/statefully/change.rb
 - lib/statefully/diff.rb
+- lib/statefully/errors.rb
 - lib/statefully/inspect.rb
 - lib/statefully/state.rb
 - spec/diff_spec.rb
+- spec/errors_spec.rb
 - spec/spec_helper.rb
 - spec/state_spec.rb
 homepage: https://github.com/marcinwyszynski/statefully
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yard
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -83,5 +283,6 @@ specification_version: 4
 summary: Immutable state with helpers to build awesome things
 test_files:
 - spec/diff_spec.rb
+- spec/errors_spec.rb
 - spec/spec_helper.rb
 - spec/state_spec.rb