rspec-non-deterministic-let 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb600b2f24a47896b1bafcb90dd19903a4cf3c98
-  data.tar.gz: fe8481a4118ca712b7f28a410c8a4386ad5b7c8e
+  metadata.gz: cea4fb4fbdbf5a9379120496fbc73d880af94536
+  data.tar.gz: 6367cbad8e85b5d3cc0f14aba2e8d04ff6eb5b3c
 SHA512:
-  metadata.gz: bbf85bbafbb3c314239961919eba2db6dbd4bc5624b86733d535c27dd5e1c1bae461e8f5151a89ba11943d2dd6e656494a1cff6ebd89bf1225aafbb10e372c3b
-  data.tar.gz: 876beaf7858c0568c220fa3a8803432d34f857c615b703710d06848358d022bfa63476e9b3124e6ed1633b75d4f946525477d34b21341dc357be4ad064ecbfd0
+  metadata.gz: 2d29c201b0c3b877c30411de04e2e6c6f4eb0b75a343f05e3e08b2f15d1da8db2cd447d6e298607d131a1eb2468628d4bc0f7489b0a7c9c732c7cb9f941304ad
+  data.tar.gz: b3e1fc0be30949f5e844528ce4e81036d446d3c13d72b82524fd2a830fc4af4eb66ab2ecce01be162accb40d23dc85d17e2369d093e0decc96588178d6879759

data/README.md

@@ -1,7 +1,6 @@
-# Rspec::Non::Deterministic::Let
-
-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/non/deterministic/let`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Rspec::NonDeterministicLet
 
+The aim of this gem is easy and intuitive writing with multi precondition specs.
 
 ## Installation
 
@@ -21,7 +20,107 @@ Or install it yourself as:
 
 ## Usage
 
-Write usage instructions here
+### How to use your project
+
+#### Rails
+
+Please add spec/rails_helper.rb
+
+```ruby
+require 'rspec/actioncheck'
+```
+
+#### Other
+
+Please add spec/spec_helper.rb
+
+```ruby
+require 'rspec/actioncheck'
+```
+
+### Simple case
+
+You can write that code in spec.
+
+```ruby
+RSpec.describe 'Some test'do
+  nd_let(:some_state) { 1 }
+  nd_let(:some_state) { 2 }
+
+  nd_let_context :some_state do
+    it 'some_state = 1 or 2' do
+      expect(some_state).to be >= 1
+      expect(some_state).to be <= 2
+    end
+    it 'some_state only 1 or 2' do
+      expect(some_state).not_to be < 1
+      expect(some_state).not_to be > 2
+    end
+  end
+end
+```
+
+It is same as this code. (but context message is different)
+
+```ruby
+RSpec.describe 'Some test without this gem'do
+
+  shared_examples 'some_state is 1 or 2' do
+    it 'some_state = 1 or 2' do
+      expect(some_state).to be >= 1
+      expect(some_state).to be <= 2
+    end
+    it 'some_state only 1 or 2' do
+      expect(some_state).not_to be < 1
+      expect(some_state).not_to be > 2
+    end
+  end
+
+  context 'some_state = 1' do
+    let(:some_state) { 1 }
+    include_examples 'some_state is 1 or 2' 
+  end
+
+  context 'some_state = 2' do
+    let(:some_state) { 1 }
+    include_examples 'some_state is 1 or 2' 
+  end
+end
+```
+
+I think that before one is more intuitive.
+
+`spec/rspec/examples_spec.rb` contain these examples.
+
+### Description
+
+If you want to description with `nd_let` then you can set description using by second argument.
+
+```
+RSpec.describe 'Some test use by description' do
+  nd_let(:some_state, 'some_state = 1') { 1 }
+  nd_let(:some_state, 'some_state = 2') { 2 }
+
+  nd_let_context :some_state do
+    it 'some_state = 1 or 2' do
+      expect(some_state).to be >= 1
+      expect(some_state).to be <= 2
+    end
+    it 'some_state only 1 or 2' do
+      expect(some_state).not_to be < 1
+      expect(some_state).not_to be > 2
+    end
+  end
+end
+```
+
+This example is exactry same as `Some test without this gem` case.
+
+
+### nd_let!
+
+You can use `nd_let!`.
+The effect of 'nd_let!' is same as `let!` for `let`
 
 ## Development
 

data/lib/rspec/non_deterministic_let/helpers.rb

@@ -3,9 +3,13 @@ module RSpec
     module Helpers
       module ClassMethods
         def nd_let_context(nd_let_name, *args, &example_group_block)
-          send(nd_let_name).each do |let_options|
+          send(__nd_let_state_name(nd_let_name)).each do |let_options|
             context(let_options[:description], *args) do
-              let(nd_let_name, &let_options[:block])
+              if let_options[:is_exclamation]
+                let!(nd_let_name, &let_options[:block])
+              else
+                let(nd_let_name, &let_options[:block])
+              end
               self.module_exec(&example_group_block)
             end
           end
@@ -25,6 +29,38 @@ module RSpec
             end
           end
         end
+
+        def nd_let(nd_let_name, description=nil, &let_block)
+          __update_let_state(nd_let_name, description, let_block, false)
+        end
+
+        def nd_let!(nd_let_name, description=nil, &let_block)
+          __update_let_state(nd_let_name, description, let_block, true)
+        end
+
+        def __update_let_state(nd_let_name, description, let_block, is_exclamation)
+          nd_let = 'nd_let'
+          nd_let += '!' if is_exclamation
+
+          nd_let_state_name = __nd_let_state_name(nd_let_name)
+
+          begin
+            let_blocks = send(nd_let_state_name)
+            description ||= "#{nd_let}:#{nd_let_name} \##{let_blocks.size + 1}"
+            self.define_singleton_method(nd_let_state_name) do ||
+              let_blocks + [{block: let_block, description: description, is_exclamation: is_exclamation}]
+            end
+          rescue NoMethodError
+            description ||= "#{nd_let}:#{nd_let_name} \##{1}"
+            self.define_singleton_method(nd_let_state_name) do ||
+              [{block: let_block, description: description, is_exclamation: is_exclamation}]
+            end
+          end
+        end
+
+        def __nd_let_state_name(nd_let_name)
+          "__nd_let_state_#{nd_let_name.to_s}".to_sym
+        end
       end
     end
   end

data/lib/rspec/non_deterministic_let/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module NonDeterministicLet
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-non-deterministic-let
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Yuta Hinokuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2017-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler