fix 1.0.0.beta4 → 1.0.0.beta8

data/lib/fix/requirement.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require "spectus/requirement/optional"
+require "spectus/requirement/recommended"
+require "spectus/requirement/required"
+
+module Fix
+  # Collection of expectation matchers.
+  #
+  # @api private
+  module Requirement
+    # rubocop:disable Naming/MethodName
+
+    # This method mean that the definition is an absolute requirement of the
+    # specification.
+    #
+    # @param matcher [#matches?] The matcher.
+    #
+    # @return [Requirement::Required] An absolute requirement level instance.
+    #
+    # @api public
+    def MUST(matcher)
+      ::Spectus::Requirement::Required.new(
+        isolate: false,
+        negate:  false,
+        matcher: matcher
+      )
+    end
+
+    # @see MUST
+    #
+    # @api public
+    def MUST!(matcher)
+      ::Spectus::Requirement::Required.new(
+        isolate: true,
+        negate:  false,
+        matcher: matcher
+      )
+    end
+
+    # This method mean that the definition is an absolute prohibition of the specification.
+    #
+    # @param matcher [#matches?] The matcher.
+    #
+    # @return [Requirement::Required] An absolute prohibition level instance.
+    #
+    # @api public
+    def MUST_NOT(matcher)
+      ::Spectus::Requirement::Required.new(
+        isolate: false,
+        negate:  true,
+        matcher: matcher
+      )
+    end
+
+    # @see MUST_NOT
+    #
+    # @api public
+    def MUST_NOT!(matcher)
+      ::Spectus::Requirement::Required.new(
+        isolate: true,
+        negate:  true,
+        matcher: matcher
+      )
+    end
+
+    # This method mean that there may exist valid reasons in particular
+    # circumstances to ignore a particular item, but the full implications must be
+    # understood and carefully weighed before choosing a different course.
+    #
+    # @param matcher [#matches?] The matcher.
+    #
+    # @return [Requirement::Recommended] A recommended requirement level instance.
+    #
+    # @api public
+    def SHOULD(matcher)
+      ::Spectus::Requirement::Recommended.new(
+        isolate: false,
+        negate:  false,
+        matcher: matcher
+      )
+    end
+
+    # @see SHOULD
+    #
+    # @api public
+    def SHOULD!(matcher)
+      ::Spectus::Requirement::Recommended.new(
+        isolate: true,
+        negate:  false,
+        matcher: matcher
+      )
+    end
+
+    # This method mean that there may exist valid reasons in particular
+    # circumstances when the particular behavior is acceptable or even useful, but
+    # the full implications should be understood and the case carefully weighed
+    # before implementing any behavior described with this label.
+    #
+    # @param matcher [#matches?] The matcher.
+    #
+    # @return [Requirement::Recommended] A not recommended requirement level
+    #   instance.
+    #
+    # @api public
+    def SHOULD_NOT(matcher)
+      ::Spectus::Requirement::Recommended.new(
+        isolate: false,
+        negate:  true,
+        matcher: matcher
+      )
+    end
+
+    # @see SHOULD_NOT
+    #
+    # @api public
+    def SHOULD_NOT!(matcher)
+      ::Spectus::Requirement::Recommended.new(
+        isolate: true,
+        negate:  true,
+        matcher: matcher
+      )
+    end
+
+    # This method mean that an item is truly optional.
+    # One vendor may choose to include the item because a particular marketplace
+    # requires it or because the vendor feels that it enhances the product while
+    # another vendor may omit the same item. An implementation which does not
+    # include a particular option must be prepared to interoperate with another
+    # implementation which does include the option, though perhaps with reduced
+    # functionality. In the same vein an implementation which does include a
+    # particular option must be prepared to interoperate with another
+    # implementation which does not include the option (except, of course, for the
+    # feature the option provides).
+    #
+    # @param matcher [#matches?] The matcher.
+    #
+    # @return [Requirement::Optional] An optional requirement level instance.
+    #
+    # @api public
+    def MAY(matcher)
+      ::Spectus::Requirement::Optional.new(
+        isolate: false,
+        negate:  false,
+        matcher: matcher
+      )
+    end
+
+    # @see MAY
+    #
+    # @api public
+    def MAY!(matcher)
+      ::Spectus::Requirement::Optional.new(
+        isolate: true,
+        negate:  false,
+        matcher: matcher
+      )
+    end
+
+    # rubocop:enable Naming/MethodName
+  end
+end

data/lib/fix/run.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "expresenter/fail"
+
+module Fix
+  # Run class.
+  #
+  # @api private
+  class Run
+    # @return [::Fix::Dsl] A context instance.
+    attr_reader :environment
+
+    # @return [::Spectus::Requirement::Base] An expectation.
+    attr_reader :requirement
+
+    # @return [Array<::Defi::Challenge>] A list of challenges.
+    attr_reader :challenges
+
+    # @param environment  [::Fix::Dsl]                    A context instance.
+    # @param requirement  [::Spectus::Requirement::Base]  An expectation.
+    # @param challenges   [Array<::Defi::Challenge>]      A list of challenges.
+    def initialize(environment, requirement, *challenges)
+      @environment = environment
+      @requirement = requirement
+      @challenges  = challenges
+    end
+
+    # Verify if the object checks the condition.
+    #
+    # @param subject [Proc] The block of code to be tested.
+    #
+    # @raise [::Expresenter::Fail] A failed spec exception.
+    # @return [::Expresenter::Pass] A passed spec instance.
+    #
+    # @see https://github.com/fixrb/expresenter
+    def against(&subject)
+      requirement.call { actual_value(&subject) }
+    rescue ::Expresenter::Fail => e
+      e
+    end
+
+    private
+
+    # The test's actual value.
+    #
+    # @param subject [Proc] The block of code to be tested.
+    #
+    # @return [#object_id] The actual value to be tested.
+    def actual_value(&subject)
+      challenges.inject(environment.instance_eval(&subject)) do |obj, challenge|
+        challenge.to(obj).call
+      end
+    end
+  end
+end

data/lib/fix/set.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "doc"
+require_relative "run"
+
+module Fix
+  # Collection of specifications.
+  #
+  # @api private
+  class Set
+    # The type of result.
+    #
+    # Passed expectations can be classified as:
+    #
+    #  * `success`
+    #  * `warning`
+    #  * `info`
+    #
+    # Failed expectations can be classified as:
+    #
+    #  * `failure`
+    #  * `error`
+    LOG_LEVELS = %w[
+      none
+      error
+      failure
+      warning
+      info
+      success
+    ].freeze
+
+    # @return [Array] A list of specifications.
+    attr_reader :specs
+
+    # @param name [String, Symbol] The constant name of the specifications.
+    #
+    # @api public
+    def self.load(name)
+      new(*Doc.fetch(name))
+    end
+
+    # @param contexts [Array<::Fix::Dsl>] The list of contexts document.
+    def initialize(*contexts)
+      @specs  = Doc.specs(*contexts)
+      @passed = true
+    end
+
+    # @param subject [Proc] The block of code to be tested.
+    #
+    # @raise [::SystemExit] The test set failed!
+    #
+    # @api public
+    def against(log_level: 5, &subject)
+      randomize!
+
+      specs.each do |environment, location, requirement, challenges|
+        runner = Run.new(environment, requirement, *challenges)
+        result = runner.against(&subject)
+
+        failed! if result.failed?
+        report!(location, result, log_level: log_level)
+      end
+
+      passed? || ::Kernel.exit(false)
+    end
+
+    private
+
+    def randomize!
+      specs.shuffle!
+    end
+
+    def failed!
+      @passed = false
+    end
+
+    # @return [Boolean] The test set passed or failed.
+    def passed?
+      @passed
+    end
+
+    def report!(path, result, log_level:)
+      return unless report?(result, log_level: log_level)
+
+      puts "#{path} #{result.colored_string}"
+    end
+
+    def report?(result, log_level:)
+      LOG_LEVELS[1..log_level].any? { |name| result.public_send("#{name}?") }
+    end
+  end
+end

data/lib/kernel.rb

@@ -1,9 +1,36 @@
 # frozen_string_literal: true
 
+require_relative File.join("fix", "doc")
+require_relative File.join("fix", "dsl")
+require_relative File.join("fix", "set")
+
+# The Kernel module.
 module Kernel
   # rubocop:disable Naming/MethodName
-  def Fix(subject = nil, **lets, &block)
-    ::Fix.describe(subject, **lets, &block)
+
+  # Specifications are built with this method.
+  #
+  # @example Require an answer equal to 42.
+  #   # The spec
+  #   Fix :Answer do
+  #     it MUST equal 42
+  #   end
+  #
+  #   # A test
+  #   Fix[:Answer].against { 42 }
+  #
+  # @param name   [String, Symbol]  The constant name of the specifications.
+  # @param block  [Proc]            The specifications.
+  #
+  # @return [#against] The collection of specifications.
+  #
+  # @api public
+  def Fix(name = nil, &block)
+    klass = ::Class.new(::Fix::Dsl)
+    klass.const_set(:CONTEXTS, [klass])
+    klass.instance_eval(&block)
+    ::Fix::Doc.const_set(name, klass) unless name.nil?
+    ::Fix::Set.new(*klass.const_get(:CONTEXTS))
   end
   # rubocop:enable Naming/MethodName
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fix
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.0.0.beta8
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -16,70 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: matchi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: spectus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: 4.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -94,35 +108,63 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  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'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-description: Specing framework for Ruby.
+        version: '0'
+description: Specing framework.
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -131,16 +173,21 @@ files:
 - LICENSE.md
 - README.md
 - lib/fix.rb
-- lib/fix/context.rb
-- lib/fix/expectation_result_not_found_error.rb
-- lib/fix/it.rb
-- lib/fix/suspicious_success_error.rb
+- lib/fix/doc.rb
+- lib/fix/dsl.rb
+- lib/fix/matcher.rb
+- lib/fix/requirement.rb
+- lib/fix/run.rb
+- lib/fix/set.rb
 - lib/kernel.rb
 homepage: https://fixrb.dev/
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/fixrb/fix/issues
+  documentation_uri: https://rubydoc.info/gems/fix
   source_code_uri: https://github.com/fixrb/fix
+  wiki_uri: https://github.com/fixrb/fix/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -149,15 +196,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Specing framework for Ruby.
+summary: Specing framework.
 test_files: []