rspec-action-check 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be043c2da7461ad1dc61cc1bd7921395f70f5da8
-  data.tar.gz: 3d7f7c417edb494fa1feb0b72712146bef1ceaf9
+  metadata.gz: 923efd500d7f9bc2bfde5bc1b1ef1f05f02c12cc
+  data.tar.gz: efe08f5b452d90ae153f14d2d38a5ee881807257
 SHA512:
-  metadata.gz: 337a747fce58cedcbe9111cdf5ad397f1dcd3ae2047faa61fbbb120008462b3ca742568e283aeb44f48661347c95db85c22e72b5209c3ad988e7d2179de3205f
-  data.tar.gz: f7cd5d9f20f8f64388df3c4a447217ad69f906541c2d0e0101b6e0e6b64f00ddd2cd82ce57b7aefe83edec1f4880f99657277c91e93f2944e3a31766775efa5d
+  metadata.gz: 2974a67eb82955ee4123ffdfaeea91be5e733cb53a26d0505845591c803e046c3eee8ee1f051434b3464f30508d4541226ff3651b5793c639f5dda75047cb30b
+  data.tar.gz: 7debd562446a2b023f27445e1103e13bfea812ca715f4710b26b1ee6b86f7bafbf3bb4e2433edcd876daac2ab70f860eda3ac02200cd2f5ad68421e39f885d05

data/README.md

@@ -2,7 +2,6 @@
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/actioncheck`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +21,166 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Simple case
+
+You can write that code in spec.
+
+```ruby
+RSpec.describe 'First Example' do
+  before do
+    @some_state1 = nil
+    @some_state2 = nil
+  end
+
+  actions 'some actions like a scenario test story' do
+    action 'set some_state1 = 100' do
+      @some_state1 = 100
+    end
+
+    check 'some_state1 = 100' do
+      expect(@some_state1).to eq 100
+    end
+
+    action 'set some_state2 = 100' do
+      @some_state2 = 200
+    end
+
+    check 'some_state2 = 200' do
+      expect(@some_state2).to eq 200
+    end
+  end
+end
+```
+
+It output that when It run
+
+```rspec
+First Example
+  some actions like a scenario test story
+    action:set some_state1 = 100
+      check:some_state1 = 100
+      action:set some_state2 = 100
+        check:some_state2 = 200
+```
+
+It is same as
+
+```ruby
+RSpec.describe SomeTest do
+  before do
+    @some_state1 = nil
+    @some_state2 = nil
+  end
+
+  context 'some actions like a scenario test story' do
+    context 'action:set some_state1 = 100' do
+      before do
+        @some_state1 = 100
+      end
+
+      it 'check:some_state1 = 100' do
+        expect(@some_state1).to eq 100
+      end
+
+      context 'action:set some_state2 = 200' do
+        before do
+          @some_state1 = 100
+        end
+
+        it 'check:some_state2 = 200' do
+          expect(@some_state2).to eq 200
+        end
+      end
+    end
+  end
+end
+```
+
+First one is more clearly to write story test.
+
+### Branching
+
+You can write that code in spec if you want to branch story.
+
+```ruby
+RSpec.describe 'Branch Example' do
+  before do
+    @some_state1 = nil
+    @some_state2 = nil
+    @some_state3 = nil
+  end
+
+  actions 'some actions like a scenario test story with branching' do
+    action 'set some_state1 = 100' do
+      @some_state1 = 100
+    end
+
+    branch 'branch1' do
+      check 'some_state1 = 100' do
+        expect(@some_state1).to eq 100
+      end
+
+      action 'set some_state2 = 200'
+        @some_state2 = 200
+      end
+
+      check 'some_state1 = 100 and some_state2 == 200' do
+        expect(@some_state1).to eq 100
+        expect(@some_state2).to eq 200
+      end
+
+      branch 'branch in branch1' do
+        action 'set some_state3 = 300'
+           @some_state3 = 300
+        end
+
+        check 'some_state1 = 100 and some_state2 == 200 and some_state3 == 300' do
+          expect(@some_state1).to eq 100
+          expect(@some_state2).to eq 200
+          expect(@some_state3).to eq 300
+        end
+      end
+      branch 'branch` in branch1' do
+        check 'some_state1 = 100 and some_state2 == 200 and some_state3 is nil' do
+          expect(@some_state1).to eq 100
+          expect(@some_state2).to eq 200
+          expect(@some_state3).to be_nil
+        end
+      end
+    end
+
+    branch 'branch2' do
+      check 'some_state1 = 100 and some_state2 is nil' do
+        expect(@some_state1).to eq 100
+        expect(@some_state2).to be_nil
+      end
+    end
+  end
+end
+```
+
+It output that when It run
+
+```
+Branch Example
+  some actions like a scenario test story with branching
+    action:set some_state1 = 100
+      action:branch1
+        check:some_state1 = 100
+        action:set some_state2 = 200
+          check:some_state1 = 100 and some_state2 == 200
+          action:branch in branch1
+            action:set some_state3 = 300
+              check:some_state1 = 100 and some_state2 == 200 and some_state3 == 300
+          action:branch` in branch1
+            check:some_state1 = 100 and some_state2 == 200 and some_state3 is nil
+      action:branch2
+        check:some_state1 = 100 and some_state2 is nil
+```
+
+It same as ... That code as too long. I will write it when I feel like it.
+
+Both examples contain in `spec/rspec/example/`
 
 ## Development
 

data/lib/rspec/actioncheck/helpers.rb

@@ -89,7 +89,7 @@ module RSpec
           _action_dags[name].merge!({
             forwards: _action_dags[name][:forwards],
             backwards: _action_dags[name][:backwards] | [before_action_name],
-            action: {description: "action:#{description}", block: action_block},
+            action: {description: "action:#{action_description}", block: action_block},
           })
           _action_dags[before_action_name].merge!({
             forwards: _action_dags[before_action_name][:forwards] | [name],

data/lib/rspec/actioncheck/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module ActionCheck
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-action-check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yuta Hinokuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2017-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler