spectus 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07c8c866806313aa6dd76d20cd16a210b7ec463e
-  data.tar.gz: 7230d480f8eeee4c7f4250585c17ce39dd5ee2f4
+  metadata.gz: f9c5f017cdf442b8b5b030ba4a89faec996d46d0
+  data.tar.gz: e92e7bce6997f75a1932d8593cf21e0150e95d08
 SHA512:
-  metadata.gz: e4a66a9f0cfba508da590e374f0ad5fe14a79ab15afe4e4a4208f3f0b44c2d09f530e9d9a40cfc27eed059d0786b9561a4af2fcf3c6faba1d81e5e54629789cf
-  data.tar.gz: 15274e958e2909d61f4ef169ff5a9847b8f262aa4540ab3581a966d5380820c3316ae956244763bcf58fbdea16d4c18a40b7677251c987a00ccc8cb962e35ee0
+  metadata.gz: 6ccc7b4ab0aea3ee90b6a9cb28fe62e7d4458118df8cb34ccdbf3fdd530cf1fce8f0c1aab2a9884df30f99a1586708bc071ce5056fb8277d4d94b6e7f7c3ee0e
+  data.tar.gz: 62c3f9dd0ab650be6226c5564f4df238876683175b9cd20694467674dc6533afcae2f07aef42f4908390a2a56244349dabbf719a9c243af7798b896881df2b94

data.tar.gz.sig

@@ -1,2 +1 @@
-�"�[=׾���j#�CO�^+-�mjgb@����-�+פ���"��dY$��S�'93��(�H����v��
-/x��7��F����=){QЇ��%����{�����=�~�=^�
�ȹ�2��
+H���{Û8�A�X��E 5J�T4�p�x1�Bx?Ž+Z�Qs�aZ�0+��G8�:�\�|@��W��'�7����dD�AR;�	j�x%�@D�#vU�XX;Cy�:��Lu͚�]��Eۏ��$�T<����O�Qm(1Jl_��?7Ѫ���Y�ēLJD�~�1 M7S���ѭ4�KX��g�ͨl }��J��g���TP�� C�O<�ٷ��j�5d���Ls{��t�6T����Qw���%$W+F��r�����X_�

data/.rubocop.yml

@@ -1,12 +1 @@
-TrivialAccessors:
-  Enabled: true
-  ExactNameMatch: true
-
-Style/MethodName:
-  Enabled: false
-
-ParameterLists:
-  Max: 11
-
-Metrics/MethodLength:
-  Max: 16
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-10-10 17:44:08 +0200 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 12
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
+Style/TrivialAccessors:
+  Exclude:
+    - 'lib/spectus/level/base.rb'
+    - 'lib/spectus/report.rb'

data/VERSION.semver

@@ -1 +1 @@
-2.7.1
+2.8.0

data/checksum/spectus-2.7.1.gem.sha512

@@ -0,0 +1 @@
+7d429237e89c48a3f04e6299578fb5663b977b4191bbe99c6d0db155a06b85bd8a1985e06b18794f36e9320f05743d145ae16bf8e34beef341e7a0c56491fc93

data/lib/spectus.rb

@@ -1,5 +1,3 @@
-require_relative File.join 'spectus', 'expectation_target'
-
 # Namespace for the Spectus library.
 #
 # @api public
@@ -19,3 +17,5 @@ module Spectus
     ExpectationTarget.new(&input)
   end
 end
+
+require_relative File.join 'spectus', 'expectation_target'

data/lib/spectus/expectation_target.rb

@@ -1,6 +1,3 @@
-require_relative File.join 'level', 'high'
-require_relative File.join 'level', 'medium'
-require_relative File.join 'level', 'low'
 require 'defi'
 
 module Spectus
@@ -27,6 +24,8 @@ module Spectus
     # @return [Array] The challenges to call on the subject.
     attr_reader :challenges
 
+    # rubocop:disable Style/MethodName
+
     # This word, or the terms "REQUIRED" or "SHALL", mean that the
     # definition is an absolute requirement of the specification.
     #
@@ -107,3 +106,7 @@ module Spectus
     end
   end
 end
+
+require_relative File.join 'level', 'high'
+require_relative File.join 'level', 'medium'
+require_relative File.join 'level', 'low'

data/lib/spectus/level/base.rb

@@ -1,7 +1,3 @@
-require_relative File.join '..', 'sandbox'
-require_relative File.join '..', 'result', 'fail'
-require_relative File.join '..', 'result', 'pass'
-
 module Spectus
   # Namespace for the requirement levels.
   #
@@ -24,21 +20,46 @@ module Spectus
         @challenges = challenges
       end
 
+      # @!attribute [r] req
+      #
+      # @return [Hash, Symbol] The definition of the expected value.
+      attr_reader :req
+
+      # The value of the negate instance variable.
+      #
+      # @return [Boolean] Evaluated to a negative assertion or not.
+      def negate?
+        @negate
+      end
+
+      # @!attribute [r] subject
+      #
+      # @return [#object_id] The front object to test.
+      attr_reader :subject
+
+      # @!attribute [r] challenges
+      #
+      # @return [Array] A list of challenges.
+      attr_reader :challenges
+
       protected
 
       # @param state [Sandbox] The sandbox that tested the code.
       #
       # @return [Result::Pass] Pass the spec.
       def pass!(state)
-        Result::Pass.new(message(state, true), *result_signature(state))
+        msg = Report.new(req, negate?, state, true)
+
+        Result::Pass.new(msg, *result_signature(state))
       end
 
       # @param state [Sandbox] The sandbox that tested the code.
       #
       # @raise [Result::Fail] Fail the spec.
       def fail!(state)
-        fail Result::Fail.new(message(state, false), *result_signature(state)),
-             message(state, false), caller[2..-1]
+        msg = Report.new(req, negate?, state, false)
+
+        fail Result::Fail.new(msg, *result_signature(state)), msg, caller[2..-1]
       end
 
       # @param state [Sandbox] The sandbox that tested the code.
@@ -46,14 +67,14 @@ module Spectus
       # @return [Array] List of parameters.
       def result_signature(state)
         [
-          @subject,
+          subject,
           state.last_challenge,
           state.actual,
-          @req,
+          req,
           state.got,
           state.exception,
           level,
-          @negate,
+          negate?,
           state.valid?
         ]
       end
@@ -65,69 +86,17 @@ module Spectus
 
       # @return [Sandbox] The sandbox.
       def sandbox
-        if Process.respond_to?(:fork)
-          fork_and_return { Sandbox.new(@req, @negate, @subject, *@challenges) }
-        else
-          Sandbox.new(@req, @negate, @subject, *@challenges)
-        end
+        Process.respond_to?(:fork) ? fork_and_return { execute } : execute
       end
 
-      # @param state  [Sandbox] The sandbox that tested the code.
-      # @param result [Boolean] The result of the test.
-      #
-      # @return [String] The message that describe the state.
-      def message(state, result)
-        "#{title(state, result)}: #{summary(state)}."
-      end
-
-      # The title of the state.
-      #
-      # @param state  [Sandbox] The sandbox that tested the code.
-      # @param result [Boolean] The result of the test.
-      #
-      # @return [String] The title of the state.
-      def title(state, result)
-        if result
-          state.got ? 'Pass' : 'Info'
-        else
-          state.exception.nil? ? 'Failure' : 'Error'
-        end
-      end
-
-      # The summary of the state.
-      #
-      # @param state [Sandbox] The sandbox that tested the code.
-      #
-      # @return [String] The summary of the state.
-      def summary(state)
-        if state.valid? || state.exception.nil?
-          'Expected ' + state.actual.inspect + (@negate ? ' not ' : ' ') +
-            'to ' + if @req.is_a?(Hash)
-                      readable(@req.keys.first) + ' ' +
-                        @req.values.first.inspect
-                    else
-                      readable(@req)
-                    end
-        else
-          state.exception.message
-        end + (state.exception.nil? ? '' : " (#{state.exception.class})")
-      end
-
-      # @param st [#to_s] A UpperCamelCase string.
-      #
-      # @return [String] The snake_case string.
-      def readable(st)
-        st.to_s
-          .gsub(/::/, '/')
-          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-          .tr('-_', ' ')
-          .downcase
+      # @return [Sandbox] The sandbox.
+      def execute
+        Sandbox.new(req, negate?, subject, *challenges)
       end
 
       # Run the code in a separate process.
       #
-      # @api private
+      # @yieldreturn [Sandbox] Execute the untested code in the sandbox.
       def fork_and_return
         read, write = IO.pipe
 
@@ -146,3 +115,8 @@ module Spectus
     end
   end
 end
+
+require_relative File.join '..', 'report'
+require_relative File.join '..', 'result', 'fail'
+require_relative File.join '..', 'result', 'pass'
+require_relative File.join '..', 'sandbox'

data/lib/spectus/report.rb

@@ -0,0 +1,110 @@
+module Spectus
+  # The class that is responsible for reporting the result of the test.
+  #
+  # @api private
+  #
+  class Report
+    # Initialize the report class.
+    #
+    # @param req    [Hash, Symbol]  The definition of the expected value.
+    # @param negate [Boolean]       Evaluate to a negative assertion.
+    # @param state  [Sandbox]       The sandbox that tested the code.
+    # @param result [Boolean]       The result of the test.
+    def initialize(req, negate, state, result)
+      @req    = req
+      @negate = negate
+      @state  = state
+      @result = result
+    end
+
+    # @!attribute [r] req
+    #
+    # @return [Hash, Symbol] The definition of the expected value.
+    attr_reader :req
+
+    # The value of the negate instance variable.
+    #
+    # @return [Boolean] Evaluated to a negative assertion or not.
+    def negate?
+      @negate
+    end
+
+    # @!attribute [r] state
+    #
+    # @return [Sandbox] The sandbox that tested the code.
+    attr_reader :state
+
+    # @!attribute [r] result
+    #
+    # @return [Boolean] The result of the test.
+    attr_reader :result
+
+    # The message.
+    #
+    # @return [String] The message that describe the state.
+    def to_s
+      "#{title}: #{summary}#{maybe_exception}."
+    end
+
+    # The title of the state.
+    #
+    # @return [String] The title of the state.
+    def title
+      if result
+        state.got ? 'Pass' : 'Info'
+      else
+        state.exception.nil? ? 'Failure' : 'Error'
+      end
+    end
+
+    # The summary of the state.
+    #
+    # @return [String] The summary of the state.
+    def summary
+      return state.exception.message unless state.valid? || state.exception.nil?
+
+      'Expected ' + state.actual.inspect + maybe_negate + ' to ' + definition
+    end
+
+    # The negation, if any.
+    #
+    # @return [String] The negation, or an empty string.
+    def maybe_negate
+      negate? ? ' not' : ''
+    end
+
+    # The type of exception, if any.
+    #
+    # @return [String] The type of exception, or an empty string.
+    def maybe_exception
+      state.exception.nil? ? '' : " (#{state.exception.class})"
+    end
+
+    # The readable definition.
+    #
+    # @return [String] The readable definition string.
+    def definition
+      if req.is_a?(Hash)
+        snake_case(req.keys.first) + ' ' + req.values.first.inspect
+      else
+        snake_case(req)
+      end
+    end
+
+    private
+
+    # @api private
+    #
+    # @param st [#to_s] An UpperCamelCase string.
+    #
+    # @return [String] The snake_case string.
+    def snake_case(st)
+      st.to_s
+        .gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-_', ' ')
+        .downcase
+    end
+  end
+end

data/lib/spectus/result/base.rb

@@ -9,7 +9,7 @@ module Spectus
     module Base
       # Initialize the result class.
       #
-      # @param message    [String] It is describing the actual/error value.
+      # @param message    [#to_s] It is describing the actual/error value.
       # @param subject    [#object_id] The untrusted object to be tested.
       # @param challenge  [Defi::Challenge] The challenge for the subject.
       # @param actual     [#object_id] The value that the subject return through
@@ -24,7 +24,7 @@ module Spectus
       def initialize(message, subject, challenge, actual, expected, got, error,
         level, negate, valid)
 
-        @message    = message
+        @message    = message.to_s
         @subject    = subject
         @challenge  = challenge
         @actual     = actual

data/lib/spectus/sandbox.rb

@@ -52,7 +52,7 @@ module Spectus
       if defined?(@exception)
         false
       else
-        @got
+        got
       end
     end
 

data/spectus.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',       '~> 10.4'
   spec.add_development_dependency 'yard',       '~> 0.8'
   spec.add_development_dependency 'simplecov',  '~> 0.10'
-  spec.add_development_dependency 'rubocop',    '~> 0.32'
+  spec.add_development_dependency 'rubocop',    '~> 0.34'
 
   spec.cert_chain   = ['certs/gem-fixrb-public_cert.pem']
   private_key       = File.expand_path('~/.ssh/gem-fixrb-private_key.pem')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectus
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Cyril Wack
@@ -30,7 +30,7 @@ cert_chain:
   dzJvWzQ1+dJU6WQv75E9ddSkaQrK3nhdgQVu+/wgvGSrsMvOGNz+LXaSDxQqZuwX
   0KNQFuIukfrdk8URwRnHoAnvx4U93iUw
   -----END CERTIFICATE-----
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -122,14 +122,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: '0.34'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: '0.34'
 description: Expectation library with RFC 2119's requirement levels.
 email:
 - contact@cyril.email
@@ -139,6 +139,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
@@ -166,12 +167,14 @@ files:
 - checksum/spectus-2.5.0.gem.sha512
 - checksum/spectus-2.6.0.gem.sha512
 - checksum/spectus-2.7.0.gem.sha512
+- checksum/spectus-2.7.1.gem.sha512
 - lib/spectus.rb
 - lib/spectus/expectation_target.rb
 - lib/spectus/level/base.rb
 - lib/spectus/level/high.rb
 - lib/spectus/level/low.rb
 - lib/spectus/level/medium.rb
+- lib/spectus/report.rb
 - lib/spectus/result/base.rb
 - lib/spectus/result/fail.rb
 - lib/spectus/result/pass.rb
@@ -198,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Expectation library with RFC 2119 keywords.

metadata.gz.sig

@@ -1,3 +1,3 @@
-0c�):����#M�'��gR���������u���~Л.hƾ}����rÙ�yֶQ�.��8�)�����	+}k�c��IP�e'�����bG
-�|<.��8xF��v?�Z��,�5qf<g�/��[��8������Ta��D�����_�?Q-#����ʁ�
-�j̍�,�%8|�9�/��-:	v=K,ut��@�)ԯ��ۥƞ���'j�z'îx7����	�O����ܳI����}Jgb������`�5��ك��EidD'
+��'A!H���?r
+�����>�n�O���.e�����ė銗 �.
�:��X	�
+����TuZ)O�ۊ�����ʍ���s����w��N:ɤ֋�뜗��`D�l���/�b���>P�{{�ctn��󩇍����,ю�\�����"3��W�kD��~��!%�N�e��h�ӫ�tMb�l��~�6�.㌔>�<Q��*,���:��C\�wzw��>^��5���W���b�qj��h�}iv�S"�q��4@