rspecz 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b437acabae389beb51eda1e28f49ed9f19502536b6dbcdbfacdb0ed7f3b144c
-  data.tar.gz: e83aba1baed93bd0d1208f22386103bbd791b87854e90f86101fc42a308aefe0
+  metadata.gz: 0a70abeda07ff4667c437333890cdcff13274fe69c9b48d34e969675380b9839
+  data.tar.gz: be9d9924e73c8c9e0a618e7afb69988bda6b6e21e30d4865b4629ad49fea29c5
 SHA512:
-  metadata.gz: abdac6c31c319e1d6a0ebd1538ad686a67588c056fd6b524098f7cdde3d1344e4a58ce6875d8e5ee61b2dae07ee15078016625c48c4ce3beafe036a274862f0f
-  data.tar.gz: 17b20b3397efe8951ac991a9fde7362b4b5ac1ed105e2059ba870be831637fca8fa57804bd6b499b429d121d22e3d5d1e48220f04d550ad4d963ad347c9b714e
+  metadata.gz: a9f097c4e7c1d3b6a4ecc581ec7d03b6a05c0651cfc0a044da4e3e0a4af81da17761714c788e40caa352acc72417e64b32d3231cdcaf07b6976ea6fb8a4d0cb7
+  data.tar.gz: 03041a3c5637ea20572fb12dfbd107d6a7e0dfdcfa75430bba743b20c822af914792dae539a778afc121626759b81a412fff158a4ddf81e9c8dc0a94c76b49d3

data/Gemfile.lock

@@ -1,13 +1,19 @@
 PATH
   remote: .
   specs:
-    rspecz (0.1.1)
+    rspecz (0.1.2)
+      method_source (~> 0.9.0)
       rspec (>= 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -15,7 +21,7 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -28,8 +34,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  pry
   rake (~> 10.0)
   rspecz!
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/README.md

@@ -1,43 +1,315 @@
 # RSpecZ
 
-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/RSpecZ`. To experiment with that code, run `bin/console` for an interactive prompt.
+RSpecZ is a powerful extension for RSpec with strong and straightforward syntaxes.
+With RSpecZ you can handle different contexts with only a single line of code.
+RSpecZ also provides a number of aliases to improve the readability of RSpec code.
+
+## Effect of RSpecZ
+
+![image](https://user-images.githubusercontent.com/10380303/46996479-c60e8380-d157-11e8-9c8a-58ca1012e2ed.png)
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
+Use github syntax until release Version 1.0.
+
 ```ruby
-gem 'rspecz'
+gem 'rspecz', github: 'RSpecZ/RSpecZ'
 ```
 
-And then execute:
+## Features
+
+### Context
+
+This is one of the most powerful features in RSpecZ.
+RSpecZ has a number of context-related methods that can automatically
+generate context descriptions for you.
+You can also use methods like `set_values` to assign different values to a variable without writing multiple lines of code in your test.
+
+### Let
+
+RSpecZ provides variable assignment methods like `create_params` and `strings`, which allows you to create complex variables in only one line of code.
+
+### Subject
+
+RSpecZ also provides subject-related methods to simplify your code when you test subjects.
 
-    $ bundle
+### Alias
 
-Or install it yourself as:
+To improve the readability of your test code, RSpecZ provides aliases such as `make` and `behave`. These aliases can help to greatly simplify your code and make them easier to review.
 
-    $ gem install RSpecZ
 
 ## Usage
 
-TODO: Write usage instructions here
+### context
+
+#### with(name, value)
+
+You can use `with` to set value to a variable, and execute the specified block:
+
+```
+with(name, value).so { my_block }
+```
+
+This will automatically create context description for you based on the name and value you specified, like this:
+
+```
+context "when #{name} is #{value}" do
+  let(name) { value }
+  my_block
+end
+```
+
+In the example above, `value` is assigned to `name` and the specified block will be executed.
+
+You can also specify your own description:
+
+```
+with(name, value).desc('my_context_description').so { my_block }
+```
+
+#### with(name, *values)
+
+`with` allows you to assign multiple values to a variable in only one line of code,
+it also creates context for each value, for example:
+
+```
+with(:age, 20, 30).so { my_block }
+```
+
+This is equals to:
+
+```
+context "when age is 20" do
+  let(:age) { 20 }
+  my_block
+end
+
+context "when age is 30" do
+  let(:age) { 30 }
+  my_block
+end
+```
+
+Using multiple values don't allow you to set your own context description.
+
+If you want to set description, you should write `with(name, value)` multiple times.
+
+#### with(name) { value }
+
+`with` also allow you to assign block value to a variable.
+
+You can use dynamic values like `FactoryBot`.
+
+```
+with(:person) { create(:person) }.so { my_block }
+```
+
+This is equals to:
+
+```
+context "when person is create(:person)" do
+  let(:person) { create(:person) }
+   my_block
+end
+```
+
+`with` with block produce description from your block source, so you can know what kind of context it is.
+
+#### `and`
+
+Each `with` method can chain `and` method.
+
+If you want to set another variable for spec, you can set additional variable with `and` method.
+
+```
+with(:name, 'test').and(:age) { 10 }.so { my_block }
+```
+
+This is equals to:
+
+```
+context 'when name is test and age is 10' do
+  let(:name) { 'test' }
+  let(:age) { 10 }
+  my_block
+end
+```
+
+#### with_nil(*variables)
+
+`with_nil` is a specific method to set nil to variables.
+
+```
+with_nil(:name, :age, :phone_number).so { my_block }
+```
+
+This is equals to:
+
+```
+%i[name age phone_number].each do |variable|
+  context "when #{variable} is nil" do
+    let(variable) { nil }
+    my_block
+  end
+end
+```
+
+
+### valid, invalid, missing
+
+`with` method doesn't provide any information about what kind of spec it is.
+
+RSpecZ has `with_valid` , `with_invalid` , `with_missing` provide spec information by method name.
+
+You can use these method to make specs review easy.
+
 
-## Development
+### super in with method
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+RSpec's `super` in `let` cannot be used in RSpecZ.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+RSpecZ has `_super` method for this.
+
+You can use `_super` like this.
+
+```
+let(:name) { 'test' }
+
+with(:name) { _super + '10' }.so { my_block }
+```
+
+#### set_context
+
+`set_context` will include the specified shared context and generate a proper context description, for example:
+
+```
+set_context(shared_context) { my_block }
+```
+
+will act like this:
+
+```
+context "when include context(#{name})" do
+  include_context name
+  my_block
+end
+```
+
+---
+
+### let
+
+#### create_params
+
+`create_params` helps to create hash in just one line.
+
+Suppose you have some variables like this:
+
+```
+let(:name) { 'Alan' }
+let(:age) { 20 }
+```
+
+Generally, to create a hash with these variables, you need to write:
+
+```
+let(:params) {{
+  name: name,
+  age: age
+}}
+```
+
+While in RSpecZ, you just use `create_params` and it will automatically create a hash with proper keys and values:
+
+```
+create_params(:name, :age)
+```
+
+#### string
+
+`string` is useful when you are trying to create a number of strings,
+it will create strings using the variable name with the prefix `test-`.
+
+For example:
+
+```
+string(name, address)
+```
+
+This equals to:
+
+```
+let(:name) { 'test-name' }
+let(:address) { 'test-address' }
+```
+
+---
+
+### subject
+
+#### subject_freezed
+
+Some times the code needs to be tested under a specified time.
+In RSpec, you will write code like this:
+
+```
+let(:now) { Time.zone.now }
+subject do
+  travel_to(now) do
+    my_block
+  end
+end
+```
+
+However, RSpecZ provides a simpler way to do this:
+
+```
+let(:now) { Time.zone.now }
+subject_freezed { my_block }
+```
+
+---
+
+### alias
+
+#### make
+
+`let` and `let!` are so confusing for rubyists when writing specs, for example:
+
+```
+let(:user)    { create(:user) }
+let!(:post)   { create(:post, user: user) } # eager evaluation
+let(:like)    { create(:like, user: user, post: post) }
+let(:comment) { create(:comment, user: user, post: post) }
+```
+
+In RSpecZ, you can use `make` instead of `let!`, which provides better identification and readability.
+
+```
+let(:user)    { create(:user) }
+make(:post)   { create(:post, user: user) } # eager evaluation
+let(:like)    { create(:like, user: user, post: post) }
+let(:comment) { create(:comment, user: user, post: post) }
+```
+
+#### behave
+
+RSpecZ also provides a short version of `it_behaves_like` when you use `shared_examples`, just use the keyword `behave`:
+
+```
+behave 'my_shared_examples'
+
+# equals to:
+# it_behaves_like 'my_shared_examples'
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/RSpecZ. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the RSpecZ project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/RSpecZ/blob/master/CODE_OF_CONDUCT.md).

data/lib/rspecz/contexts.rb

@@ -71,7 +71,7 @@ module RSpec
         alias_method :block_context, :set_block
 
         def set_missing(name, value = 'missing-value', description = nil, &block)
-          context description || "when #{name} is not exist(#{value})" do
+          context description || "when #{name} does not exist(#{value})" do
             let(name) { value }
             instance_exec(name, &block)
           end

data/lib/rspecz/describe.rb

@@ -0,0 +1,14 @@
+module RSpecZ
+  METADATA_WITH_COUNT = :___rspecz_with_count
+  METADATA_SO_COUNT = :___rspecz_so_count
+
+  class << self
+    def describe(*args, &example_group_block)
+      RSpec.describe(*args, &example_group_block).tap do |result|
+        if result.metadata[RSpecZ::METADATA_WITH_COUNT] != result.metadata[RSpecZ::METADATA_SO_COUNT]
+          raise RuntimeError.new('You have some .with method without .so method. You may miss .so method in your code.')
+        end
+      end
+    end
+  end
+end

data/lib/rspecz/lets.rb

@@ -15,7 +15,7 @@ module RSpec
           let(:with_nil) { false } unless __lib_method_defined?(:with_nil)
           let(:params) {
             array.each_with_object({}) do |elem, acc|
-              acc[elem] = send(elem) if send(:with_nil) || send(elem).present?
+              acc[elem] = send(elem) if send(:with_nil) || !send(elem).nil?
             end
           }
         end

data/lib/rspecz/version.rb

@@ -1,3 +1,3 @@
 module RSpecZ
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/rspecz/with.rb

@@ -30,6 +30,10 @@ module RSpec
           end
 
           def so(&block)
+            root_context = @myobject.send(:root_context)
+            so_count = root_context.metadata[RSpecZ::METADATA_SO_COUNT]
+            root_context.metadata[RSpecZ::METADATA_SO_COUNT] = so_count == nil ? 1 : so_count + 1;
+
             continue_object = self
             continue_object_block = @block
             # TODO: create description from block.source
@@ -46,7 +50,10 @@ module RSpec
                 spec = @and_block.nil? ? spec_without_and : lambda do
                   context "and #{continue_object.and_name} is #{continue_object.__get_description(continue_object.and_block.source, 'and')}" do
                     let(continue_object.and_name) do
-                      @super = super() if defined? super
+                      @super = lambda { super() } if defined? super
+                      def _super
+                        @super.call()
+                      end
                       instance_eval(&continue_object.and_block)
                     end
                     instance_exec(&spec_without_and)
@@ -65,7 +72,10 @@ module RSpec
               spec_without_and = lambda do
                 if continue_object.name
                   let(continue_object.name) do
-                    @super = super() if defined? super
+                    @super = lambda { super() } if defined? super
+                    def _super
+                      @super.call()
+                    end
                     instance_eval(&continue_object_block)
                   end
                 else
@@ -151,6 +161,8 @@ module RSpec
         private
 
         def _with(name, hint, focused, values, block)
+          count_up_with_count
+
           with_context = WithContext.new(name, values, block, self)
           with_context.hint(hint) if hint
           with_context.focused if focused
@@ -159,6 +171,7 @@ module RSpec
 
         def _with_nil(names, focused)
           raise RuntimeError.new("Argument Error. You should set names.") if names.nil? || names.length == 0
+          count_up_with_count
 
           continue_object = { names: names, focused: focused, myobject: self }
 
@@ -167,6 +180,10 @@ module RSpec
           end
 
           def continue_object.so(&block)
+            root_context = self[:myobject].send(:root_context)
+            so_count = root_context.metadata[RSpecZ::METADATA_SO_COUNT]
+            root_context.metadata[RSpecZ::METADATA_SO_COUNT] = so_count == nil ? 1 : so_count + 1;
+
             continue_object = self
             continue_object[:names].each do |name|
               spec = lambda do
@@ -182,6 +199,19 @@ module RSpec
           end
           continue_object
         end
+
+        def count_up_with_count
+          with_count = root_context.metadata[RSpecZ::METADATA_WITH_COUNT]
+          root_context.metadata[RSpecZ::METADATA_WITH_COUNT] = with_count == nil ? 1 : with_count + 1
+        end
+
+        def root_context
+          current = self
+          # RSpec module describe how deep context is. So, minimum module class is the root context
+          current.parent_groups.min do |a,b|
+            a.ancestors.length <=> b.ancestors.length
+          end
+        end
       end
     end
   end

data/lib/rspecz.rb

@@ -1,3 +1,4 @@
+require 'method_source'
 require 'rspec/core'
 require 'rspecz/version'
 require 'rspecz/contexts'
@@ -5,5 +6,6 @@ require 'rspecz/subjects'
 require 'rspecz/lets'
 require 'rspecz/with'
 require 'rspecz/behave'
+require 'rspecz/describe'
 require 'rspecz/aliases/behave'
 require 'rspecz/aliases/make'

data/rspecz.gemspec

@@ -6,11 +6,11 @@ require "rspecz/version"
 Gem::Specification.new do |spec|
   spec.name          = "rspecz"
   spec.version       = RSpecZ::VERSION
-  spec.authors       = ["seteen"]
+  spec.authors       = ["yazumoto"]
   spec.email         = ["app.zenn@gmail.com"]
 
   spec.summary       = %q{Provide functions for smart RSpec.}
-  spec.homepage      = "https://github.com/seteen/RSpecZ"
+  spec.homepage      = "https://github.com/RSpecZ/RSpecZ"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rspec', '>= 3.0'
+  spec.add_dependency 'method_source', '~> 0.9.0'
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspecz
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- seteen
+- yazumoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-01 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
 email:
 - app.zenn@gmail.com
@@ -75,12 +103,13 @@ files:
 - lib/rspecz/aliases/make.rb
 - lib/rspecz/behave.rb
 - lib/rspecz/contexts.rb
+- lib/rspecz/describe.rb
 - lib/rspecz/lets.rb
 - lib/rspecz/subjects.rb
 - lib/rspecz/version.rb
 - lib/rspecz/with.rb
 - rspecz.gemspec
-homepage: https://github.com/seteen/RSpecZ
+homepage: https://github.com/RSpecZ/RSpecZ
 licenses:
 - MIT
 metadata: {}
@@ -99,8 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Provide functions for smart RSpec.