statefully 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dc0029ce1cfb0d959f2dcb1a011f353769cfcea
-  data.tar.gz: 4489a554669bd6b77bfba5ff11ce7807324f2666
+  metadata.gz: ab676bd0fdc9e9d6b17d8c606aa381e9aeab8cac
+  data.tar.gz: 11c77ad8e395dac8b413606ce8e7698b4482c27b
 SHA512:
-  metadata.gz: d0987e59f77ab66c7f702959f99d70cdaafa4d9c01730abb91b9c6de0d1e95698822959573c24cc9d332f1529f31dba86bfa2473de0e74859d999b4bae6bfe2f
-  data.tar.gz: 0f52245a34ee7133f6f9fd9be58cebcf7b687a10c703c804fc88e3d2c1ca353a93824b4cfd21d3b4aae14ccc6adc2c2e82fd14222bf4b6666f8d31937ea198b0
+  metadata.gz: a6dcbb610b68d77357d1f4a015cadb5c33430b763ea244bacc6bf2d9748356bb7576ec5154b6c3c4840248bac1df85b1f45134ad11c1e99c011510fd8cd2e024
+  data.tar.gz: '0543961fa3864e71e1c647c8f1d1176ee1ad6bdfd420dd8a2336358f8f2e65b3c5a4c6458815a85c64c10f82aa4c14919a5a5b5de4d4d456bfa0d847eec9cc92'

data/lib/statefully/change.rb

@@ -48,5 +48,5 @@ module Statefully
       "#<#{self.class.name} " \
       "#{Inspect.from_fields(current: current, previous: previous)}>"
     end
-  end # class Change
-end # module Statefully
+  end
+end

data/lib/statefully/diff.rb

@@ -194,7 +194,7 @@ module Statefully
       def inspect_changed
         changed.empty? ? nil : "changed=#{Inspect.from_hash(changed)}"
       end
-    end # class Changed
+    end
 
     module SingletonInspect
       # Human-readable representation of the {Diff} singleton
@@ -204,7 +204,7 @@ module Statefully
       def inspect
         "#<#{self.class.name}>"
       end
-    end # module SingletonInspect
+    end
     private_constant :SingletonInspect
 
     # {Created} represents a difference between a null and non-null {State}.
@@ -222,13 +222,13 @@ module Statefully
       def created?
         true
       end
-    end # class Created
+    end
 
     # {Unchanged} represents a lack of difference between two {State}s.
     class Unchanged < Diff
       include Singleton
       include SingletonInspect
-    end # class Unchanged
+    end
 
     # {Failed} represents a difference between a succesful and failed {State}.
     class Failed < Diff
@@ -262,13 +262,13 @@ module Statefully
       def inspect
         "#<#{self.class.name} error=#{error.inspect}>"
       end
-    end # class Failed
+    end
 
     # {Failed} represents a difference between a succesful and finished {State}.
     class Finished < Diff
       include Singleton
       include SingletonInspect
-    end # class Finished
+    end
 
     class Builder
       # Constructor for the {Builder} object
@@ -350,7 +350,7 @@ module Statefully
       def previous_keys
         Set.new(@previous.keys)
       end
-    end # class Builder
+    end
     private_constant :Builder
-  end # class Diff
-end # module Statefully
+  end
+end

data/lib/statefully/errors.rb

@@ -27,6 +27,7 @@ module Statefully
         @field = field
         super("field '#{field}' missing from state")
       end
-    end # class StateMissing
-  end # module Errors
-end # module Statefully
+    end
+  end
+end
+# rubocop:enable Metrics/LineLength

data/lib/statefully/inspect.rb

@@ -20,6 +20,6 @@ module Statefully
       input.map { |key, val| "#{key}=#{val.inspect}" }.join(', ')
     end
     module_function :from_fields
-  end # module Inspect
+  end
   private_constant :Inspect
-end # module Statefully
+end

data/lib/statefully/state.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'securerandom'
 require 'singleton'
 
 # rubocop:disable Metrics/LineLength
@@ -66,7 +67,8 @@ module Statefully
     #   Statefully::State.create(key: 'val')
     #   => #<Statefully::State::Success key="val">
     def self.create(**values)
-      Success.send(:new, values, previous: None.instance).freeze
+      base = { correlation_id: SecureRandom.uuid }
+      Success.send(:new, base.merge(values), previous: None.instance).freeze
     end
 
     # Return a {Diff} between current and previous {State}
@@ -322,7 +324,7 @@ module Statefully
         @_members = {}.freeze
         @previous = self
       end
-    end # class None
+    end
 
     # {Success} is a not-yet failed {State}.
     class Success < State
@@ -362,7 +364,7 @@ module Statefully
       def finish
         Finished.send(:new, _members, previous: self).freeze
       end
-    end # class Success
+    end
 
     # {Failure} is a failed {State}.
     class Failure < State
@@ -444,7 +446,7 @@ module Statefully
       def inspect
         _inspect_details(error: error.inspect)
       end
-    end # class Failure
+    end
 
     # {Finished} state is a state which is successful, but should not be
     # processed any further. This could be useful for things like early returns.
@@ -476,6 +478,7 @@ module Statefully
       def finished?
         true
       end
-    end # class Finished
-  end # class State
-end # module Statefully
+    end
+  end
+end
+# rubocop:enable Metrics/LineLength

data/lib/statefully/version.rb

@@ -1,3 +1,3 @@
 module Statefully
-  VERSION = '0.1.6'.freeze
-end # module Statefully
+  VERSION = '0.1.7'.freeze
+end

data/spec/diff_spec.rb

@@ -9,31 +9,31 @@ module Statefully
       let(:previous) { State::None.instance }
 
       it { expect(diff).to be_created }
-    end # context 'when created'
+    end
 
     context 'when key added' do
-      let(:current)  { State.create(key: 'val') }
       let(:previous) { State.create }
+      let(:current)  { previous.succeed(key: 'val') }
 
       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).to be_added(:key) }
       it { expect(diff.added.fetch(:key)).to eq 'val' }
       it { expect(diff.changed).to be_empty }
 
       it { expect(diff.inspect).to start_with '#<Statefully::Diff::Changed' }
       it { expect(diff.inspect).to include 'added={key: "val"}>' }
-    end # context 'when key added'
+    end
 
     context 'when key changed' do
-      let(:current)  { State.create(key: 'new') }
       let(:previous) { State.create(key: 'old') }
+      let(:current)  { previous.succeed(key: 'new') }
 
       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(diff).to be_changed(:key) }
 
       it { expect(diff.inspect).to include 'changed=' }
 
@@ -42,8 +42,8 @@ module Statefully
 
         it { expect(change.current).to eq 'new' }
         it { expect(change.previous).to eq 'old' }
-      end # context 'with change'
-    end # context 'when key changed'
+      end
+    end
 
     context 'when nothing changed' do
       let(:current)  { State.create(key: 'key') }
@@ -51,13 +51,13 @@ module Statefully
 
       it { expect(diff).to be_empty }
       it { expect(diff.inspect).to eq '#<Statefully::Diff::Unchanged>' }
-    end # context 'when nothing changed'
+    end
 
     shared_examples 'diff_is_empty' do
       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'
+    end
 
     context 'when failed' do
       let(:error)    { RuntimeError.new('boo!') }
@@ -70,7 +70,7 @@ module Statefully
 
       it { expect(diff.inspect).to start_with '#<Statefully::Diff::Failed' }
       it { expect(diff.inspect).to include 'error=#<RuntimeError: boo!>' }
-    end # context 'when failed'
+    end
 
     context 'when finished' do
       let(:previous) { State.create }
@@ -79,6 +79,6 @@ module Statefully
       it_behaves_like 'diff_is_empty'
 
       it { expect(diff.inspect).to eq '#<Statefully::Diff::Finished>' }
-    end # context 'when finished'
-  end # describe Diff
-end # module Statefully
+    end
+  end
+end

data/spec/errors_spec.rb

@@ -8,6 +8,6 @@ module Statefully
 
       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
+    end
+  end
+end

data/spec/state_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 
+require 'pry'
+
 module Statefully
   describe State do
     describe '.create' do
@@ -12,12 +14,12 @@ module Statefully
 
         context 'with diff' do
           let(:diff)     { state.diff }
-          let(:expected) { '#<Statefully::Diff::Created>' }
+          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'
+          it { expect(diff.inspect).to start_with expected }
+        end
+      end
 
       context 'with keyword arguments' do
         let(:args) { { key: 'val' } }
@@ -27,51 +29,49 @@ module Statefully
           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
+          it { expect(diff.added).to include args }
+        end
+      end
+    end
+  end
 
   describe 'State::Success' do
     let(:val)   { 'val' }
     let(:state) { State.create(old_key: val) }
 
     describe 'methods delegated to the underlying Hash' do
-      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'
+      it { expect(state.keys).to eq %i[correlation_id old_key] }
+      it { expect(state).to be_key(:old_key) }
+      it { expect(state).to(be_any { |_, value| value == val }) }
+    end
 
     describe "methods dynamically dispatched using 'method_missing'" do
       it { expect(state.old_key).to eq val }
-      it { expect(state.old_key?).to be_truthy }
+      it { expect(state).to be_old_key }
       it { expect(state.old_key!).to eq val }
 
       it { expect { state.new_key }.to raise_error NoMethodError }
-      it { expect(state.new_key?).to be_falsey }
+      it { expect(state).not_to be_new_key }
       it { expect { state.new_key! }.to raise_error Errors::StateMissing }
-    end # describe "methods dynamically dispatched using 'method_missing'"
+    end
 
     describe 'trivial readers' do
       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'
+    end
 
     describe 'history' do
       let(:history) { state.history }
 
       it { expect(history.length).to eq 1 }
       it { expect(history.first).to be_created }
-    end # describe 'history'
+    end
 
     describe '#inspect' do
-      let(:expected) { '#<Statefully::State::Success old_key="val">' }
-
-      it { expect(state.inspect).to eq expected }
-    end # describe '#inspect'
+      it { expect(state.inspect).to include 'old_key="val"' }
+    end
 
     shared_examples 'successful_state' do
       it { expect(next_state).to be_successful }
@@ -79,7 +79,7 @@ module Statefully
 
       it { expect(next_state.previous).to eq state }
       it { expect(next_state.resolve).to eq next_state }
-    end # shared_examples 'successful_state'
+    end
 
     describe '#succeed' do
       let(:new_val)    { 'new_val' }
@@ -89,7 +89,7 @@ module Statefully
 
       it { expect(next_state).not_to be_finished }
       it { expect(next_state.new_key).to eq new_val }
-      it { expect(next_state.keys).to eq %i[old_key new_key] }
+      it { expect(next_state.keys).to eq %i[correlation_id old_key new_key] }
 
       context 'with history' do
         let(:history) { next_state.history }
@@ -98,8 +98,8 @@ module Statefully
         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'
-    end # describe '#succeed'
+      end
+    end
 
     describe '#fail' do
       let(:error)      { RuntimeError.new('boo!') }
@@ -120,7 +120,7 @@ module Statefully
         it { expect(inspect).to start_with '#<Statefully::State::Failure' }
         it { expect(inspect).to include 'old_key="val"' }
         it { expect(inspect).to include 'error="#<RuntimeError: boo!>"' }
-      end # describe '#inspect'
+      end
 
       context 'with history' do
         let(:history) { next_state.history }
@@ -128,8 +128,8 @@ module Statefully
         it { expect(history.size).to eq 2 }
         it { expect(history.first.error).to eq error }
         it { expect(history.last.added).to include :old_key }
-      end # context 'with history'
-    end # describe '#fail'
+      end
+    end
 
     describe '#finish' do
       let(:new_val)    { 'new_val' }
@@ -145,7 +145,7 @@ module Statefully
         it { expect(history.size).to eq 2 }
         it { expect(history.first).to eq Diff::Finished.instance }
         it { expect(history.last.added).to include :old_key }
-      end # context 'with history'
-    end # describe '#finish'
-  end # describe 'State::Success'
-end # module Statefully
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statefully
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Marcin Wyszynski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,26 +30,6 @@ 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
@@ -284,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Immutable state with helpers to build awesome things