mutant 0.11.34 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e98171c271934f978770ae00e52d0e3e801a4197fa4b5efb0a43f966ff5af54c
-  data.tar.gz: 0d2d7823052db9d2a46efcc0fdd11808d95510dd58a77933288c063f7195851f
+  metadata.gz: 4e8ba758de42528dd4dd4fdb5686df439d9ea4e2b1635905e89d7a98b904b959
+  data.tar.gz: df2317b0cabc5964fec52e0fc1d7e76c0f368a01f713fa411f03cba4808b834a
 SHA512:
-  metadata.gz: ba1991d33cb05098cb78bc5325d05c8b4dbe974752a276a5daf43139c1e1202bb5ce5505b2ce1072d8d86ca4ca6ca22a828d971589b1c22b13fd012703cf7ebf
-  data.tar.gz: 8e3f0a5ce588b5b49c08233bceb8c855c6b32ce7cbb4fb1a1056e981775e9007c7188b09e73438fb56d7faff64c6f13b280dbed580273b329b3981693123b3dd
+  metadata.gz: 3b74495aa82f4489e22a95b5c25f3185d759fa616354af51c07544bb66be08f69becf8e5021db80008d169c2de12e677bf8a3a38becb954c32dc8287f1eea24d
+  data.tar.gz: 82e7bdc18591e89028a39a3489291452b0b73cc4bcc6ea7549e9fa376778de622ac53bd4a2dbbe7702ff875eb9d84f55b6fa1ad424e55bfb0e4c7bdaa7243d13

data/lib/mutant/cli/command/environment/run.rb

@@ -9,13 +9,6 @@ module Mutant
           SHORT_DESCRIPTION = 'Run code analysis'
           SUBCOMMANDS       = EMPTY_ARRAY
 
-          UNLICENSED = <<~MESSAGE.lines.freeze
-            You are using mutant unlicensed.
-
-            See https://github.com/mbj/mutant#licensing to aquire a license.
-            Note: Its free for opensource use, which is recommended for trials.
-          MESSAGE
-
           NO_TESTS_MESSAGE = <<~'MESSAGE'
             ===============
             Mutant found no tests available for mutation testing.
@@ -34,8 +27,8 @@ module Mutant
         private
 
           def action
-            License.call(world)
-              .bind { bootstrap }
+            bootstrap
+              .bind(&method(:verify_usage))
               .bind(&method(:validate_tests))
               .bind(&Mutation::Runner.public_method(:call))
               .bind(&method(:from_result))
@@ -56,6 +49,10 @@ module Mutant
               Either::Left.new('Uncovered mutations detected, exiting nonzero!')
             end
           end
+
+          def verify_usage(environment)
+            environment.config.usage.verify.fmap { environment }
+          end
         end # Run
       end # Environment
     end # Command

data/lib/mutant/cli/command/environment.rb

@@ -15,6 +15,7 @@ module Mutant
             add_integration_options
             add_matcher_options
             add_reporter_options
+            add_usage_options
           ].freeze
 
       private
@@ -136,6 +137,20 @@ module Mutant
             set(reporter: @config.reporter.with(print_warnings: true))
           end
         end
+
+        def add_usage_options(parser)
+          parser.separator('Usage:')
+
+          parser.accept(Usage, Usage::CLI_REGEXP) do |value|
+            Usage.parse(value).from_right
+          end
+
+          parser.on(
+            '--usage USAGE_TYPE',
+            Usage,
+            'License usage: opensource|commercial'
+          ) { |usage| set(usage: usage) }
+        end
       end # Run
       # rubocop:enable Metrics/ClassLength
     end # Command

data/lib/mutant/cli/command/root.rb

@@ -10,7 +10,7 @@ module Mutant
       class Root < self
         NAME              = 'mutant'
         SHORT_DESCRIPTION = 'mutation testing engine main command'
-        SUBCOMMANDS       = [Environment::Run, Environment, Subscription, Util].freeze
+        SUBCOMMANDS       = [Environment::Run, Environment, Util].freeze
       end # Root
     end # Command
   end # CLI

data/lib/mutant/cli/command.rb

@@ -122,7 +122,7 @@ module Mutant
 
       def parse(arguments)
         Either
-          .wrap_error(OptionParser::InvalidOption) { parser.order(arguments) }
+          .wrap_error(OptionParser::InvalidArgument, OptionParser::InvalidOption) { parser.order(arguments) }
           .lmap(&method(:with_help))
           .bind(&method(:parse_remaining))
       end
@@ -176,14 +176,6 @@ module Mutant
         end
       end
 
-      def parse_remaining_arguments(remaining)
-        if remaining.any?
-          Either::Left.new("#{full_name}: Does not expect extra arguments")
-        else
-          Either::Right.new(self)
-        end
-      end
-
       def parse_subcommand(arguments)
         command_name, *arguments = arguments
 

data/lib/mutant/config.rb

@@ -21,7 +21,8 @@ module Mutant
       :matcher,
       :mutation,
       :reporter,
-      :requires
+      :requires,
+      :usage
     )
 
     %i[fail_fast].each do |name|
@@ -87,7 +88,8 @@ module Mutant
         jobs:                  other.jobs || jobs,
         matcher:               matcher.merge(other.matcher),
         mutation:              mutation.merge(other.mutation),
-        requires:              requires + other.requires
+        requires:              requires + other.requires,
+        usage:                 other.usage.merge(usage)
       )
     end
     # rubocop:enable Metrics/AbcSize
@@ -247,6 +249,10 @@ module Mutant
           Transform::Hash::Key.new(
             transform: Transform::STRING_ARRAY,
             value:     'requires'
+          ),
+          Transform::Hash::Key.new(
+            transform: Usage::TRANSFORM,
+            value:     'usage'
           )
         ],
         required: []

data/lib/mutant/reporter/cli/printer/config.rb

@@ -15,6 +15,7 @@ module Mutant
           #
           # rubocop:disable Metrics/AbcSize
           def run
+            info 'Usage:           %s',    object.usage.value
             info 'Matcher:         %s',    object.matcher.inspect
             info 'Integration:     %s',    object.integration.name || 'null'
             info 'Jobs:            %s',    object.jobs || 'auto'

data/lib/mutant/repository/diff.rb

@@ -36,9 +36,8 @@ module Mutant
 
       def repository_root
         world
-          .capture_stdout(%w[git rev-parse --show-toplevel])
-          .fmap(&:chomp)
-          .fmap(&world.pathname.public_method(:new))
+          .capture_command(%w[git rev-parse --show-toplevel])
+          .fmap { |status| world.pathname.new(status.stdout.chomp) }
       end
 
       def touched_path(path, &block)
@@ -52,11 +51,10 @@ module Mutant
 
       def diff_index(root)
         world
-          .capture_stdout(%W[git diff-index #{to}])
-          .fmap(&:lines)
-          .bind do |lines|
+          .capture_command(%W[git diff-index #{to}])
+          .bind do |status|
             Mutant
-              .traverse(->(line) { parse_line(root, line) }, lines)
+              .traverse(->(line) { parse_line(root, line) }, status.stdout.lines)
               .fmap do |paths|
                 paths.to_h { |path| [path.path, path] }
               end
@@ -105,8 +103,8 @@ module Mutant
 
         def diff_ranges
           world
-            .capture_stdout(%W[git diff --unified=0 #{to} -- #{path}])
-            .fmap(&Ranges.public_method(:parse))
+            .capture_command(%W[git diff --unified=0 #{to} -- #{path}])
+            .fmap { |status| Ranges.parse(status.stdout) }
             .from_right
         end
         memoize :diff_ranges

data/lib/mutant/usage.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Mutant
+  class Usage
+    include Adamantium, Equalizer.new
+
+    def value
+      self.class::VALUE
+    end
+
+    def verify
+      Either::Right.new(nil)
+    end
+
+    def message
+      self.class::MESSAGE
+    end
+
+    def merge(_other)
+      self
+    end
+
+    class Commercial < self
+      VALUE = 'commercial'
+
+      MESSAGE = <<~'MESSAGE'
+        ## Commercial use
+
+        `commercial` usage type requires [payment](https://github.com/mbj/mutant?tab=readme-ov-file#pricing),
+        If you are under an active payment plan you can use the commercial usage type on any
+        repository, including private ones.
+
+        To use `commercial` usage type either specify `--usage commercial` on the command
+        line or use the config file key `usage`:
+
+        ```
+        # mutant.yml or config/mutant.yml
+        usage: commercial
+        ```
+      MESSAGE
+    end
+
+    class Opensource < self
+      VALUE = 'opensource'
+
+      MESSAGE = <<~'MESSAGE'
+        ## Opensource use
+
+        `opensource` usage is free while mutant is run on an opensource project.
+        Under that usage mutant does not require any kind of sign up or payment.
+        Set this usage type exclusively on public opensource projects. Any other
+        scenario requires payment.
+        Using the `opensource` usage type on private repotiories and or on commercial
+        code bases is not valid.
+
+        To use `opensource` usage type either specify `--usage opensource` on the command
+        line or use the config file key `usage`:
+
+        ```
+        # mutant.yml or config/mutant.yml
+        usage: opensource
+        ```
+      MESSAGE
+    end
+
+    class Unknown < self
+      VALUE = 'unknown'
+
+      MESSAGE = <<~"MESSAGE".freeze
+        # Unknown mutant usage type
+
+        Mutant license usage is unspecified. Valid usage types are `opensource` or `commercial`.
+
+        Usage can be specified via the `--usage` command line parameter or via the
+        config file under the `usage` key.
+
+        #{Commercial::MESSAGE}
+        #{Opensource::MESSAGE}
+        This is a breaking change for users of the 0.11.x / 0.10.x mutant releases.
+        Sorry for that but its going to make future adoption much easier.
+        License gem is gone entirely.
+      MESSAGE
+
+      def merge(other)
+        other
+      end
+
+      def verify
+        Either::Left.new(MESSAGE)
+      end
+    end
+
+    def self.parse(value)
+      {
+        'commercial' => Either::Right.new(Commercial.new),
+        'opensource' => Either::Right.new(Opensource.new)
+      }.fetch(value) { Either::Left.new("Unknown usage option: #{value.inspect}") }
+    end
+
+    CLI_REGEXP = /\A(?:commercial|opensource)\z/
+
+    TRANSFORM = Transform::Sequence.new(
+      steps: [
+        Transform::STRING,
+        Transform::Block.capture(:environment_variables, &method(:parse))
+      ]
+    )
+  end # Usage
+end # Mutant

data/lib/mutant/version.rb

@@ -2,5 +2,5 @@
 
 module Mutant
   # Current mutant version
-  VERSION = '0.11.34'
+  VERSION = '0.12.0'
 end # Mutant

data/lib/mutant/world.rb

@@ -39,19 +39,25 @@ module Mutant
       INSPECT
     end
 
+    class CommandStatus
+      include Adamantium, Anima.new(:process_status, :stderr, :stdout)
+    end # CommandStatus
+
     # Capture stdout of a command
     #
     # @param [Array<String>] command
     #
-    # @return [Either<String,String>]
-    def capture_stdout(command)
-      stdout, status = open3.capture2(*command, binmode: true)
+    # @return [Either<CommandStatus,CommandStatus>]
+    def capture_command(command)
+      stdout, stderr, process_status = open3.capture3(*command, binmode: true)
 
-      if status.success?
-        Either::Right.new(stdout)
-      else
-        Either::Left.new("Command #{command} failed!")
-      end
+      (process_status.success? ? Either::Right : Either::Left).new(
+        CommandStatus.new(
+          process_status: process_status,
+          stderr:         stderr,
+          stdout:         stdout
+        )
+      )
     end
 
     # Try const get

data/lib/mutant.rb

@@ -109,6 +109,7 @@ module Mutant
     require 'mutant/require_highjack'
     require 'mutant/mutation'
     require 'mutant/mutation/operators'
+    require 'mutant/usage'
     require 'mutant/mutation/config'
     require 'mutant/mutator'
     require 'mutant/mutator/util'
@@ -221,7 +222,6 @@ module Mutant
     require 'mutant/config/coverage_criteria'
     require 'mutant/cli'
     require 'mutant/cli/command'
-    require 'mutant/cli/command/subscription'
     require 'mutant/cli/command/environment'
     require 'mutant/cli/command/environment/irb'
     require 'mutant/cli/command/environment/run'
@@ -255,11 +255,6 @@ module Mutant
     require 'mutant/repository/diff/ranges'
     require 'mutant/zombifier'
     require 'mutant/range'
-    require 'mutant/license'
-    require 'mutant/license/subscription'
-    require 'mutant/license/subscription/commercial'
-    require 'mutant/license/subscription/opensource'
-    require 'mutant/license/subscription/repository'
     require 'mutant/segment'
     require 'mutant/segment/recorder'
   end
@@ -363,7 +358,8 @@ module Mutant
       matcher:               Matcher::Config::DEFAULT,
       mutation:              Mutation::Config::EMPTY,
       reporter:              Reporter::CLI.build(WORLD.stdout),
-      requires:              EMPTY_ARRAY
+      requires:              EMPTY_ARRAY,
+      usage:                 Usage::Unknown.new
     )
   end # Config
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mutant
 version: !ruby/object:Gem::Version
-  version: 0.11.34
+  version: 0.12.0
 platform: ruby
 authors:
 - Markus Schirp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -177,7 +177,6 @@ files:
 - lib/mutant/cli/command/environment/subject.rb
 - lib/mutant/cli/command/environment/test.rb
 - lib/mutant/cli/command/root.rb
-- lib/mutant/cli/command/subscription.rb
 - lib/mutant/cli/command/util.rb
 - lib/mutant/config.rb
 - lib/mutant/config/coverage_criteria.rb
@@ -197,11 +196,6 @@ files:
 - lib/mutant/isolation/exception.rb
 - lib/mutant/isolation/fork.rb
 - lib/mutant/isolation/none.rb
-- lib/mutant/license.rb
-- lib/mutant/license/subscription.rb
-- lib/mutant/license/subscription/commercial.rb
-- lib/mutant/license/subscription/opensource.rb
-- lib/mutant/license/subscription/repository.rb
 - lib/mutant/loader.rb
 - lib/mutant/matcher.rb
 - lib/mutant/matcher/chain.rb
@@ -341,6 +335,7 @@ files:
 - lib/mutant/test/runner/sink.rb
 - lib/mutant/timer.rb
 - lib/mutant/transform.rb
+- lib/mutant/usage.rb
 - lib/mutant/util.rb
 - lib/mutant/variable.rb
 - lib/mutant/version.rb
@@ -366,7 +361,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: ''

data/lib/mutant/cli/command/subscription.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Mutant
-  module CLI
-    class Command
-      class Subscription < self
-        NAME              = 'subscription'
-        SHORT_DESCRIPTION = 'Subscription subcommands'
-
-      private
-
-        def license
-          License.call(world)
-        end
-
-        class Test < self
-          NAME              = 'test'
-          SUBCOMMANDS       = [].freeze
-          SHORT_DESCRIPTION = 'Silently validates subscription, exits accordingly'
-
-        private
-
-          def execute
-            license.right?
-          end
-        end # Test
-
-        class Show < self
-          NAME              = 'show'
-          SUBCOMMANDS       = [].freeze
-          SHORT_DESCRIPTION = 'Show subscription status'
-
-        private
-
-          def execute
-            license.either(method(:unlicensed), method(:licensed))
-          end
-
-          def licensed(subscription)
-            world.stdout.puts(subscription.description)
-            true
-          end
-
-          def unlicensed(message)
-            world.stderr.puts(message)
-            false
-          end
-        end # Show
-
-        SUBCOMMANDS = [Show, Test].freeze
-      end # Subscription
-    end # Command
-  end # CLI
-end # Mutant

data/lib/mutant/license/subscription/commercial.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-module Mutant
-  module License
-    class Subscription
-      class Commercial < self
-        include AbstractType
-
-        def self.from_json(value)
-          {
-            'individual'   => Individual,
-            'organization' => Organization
-          }.fetch(value.fetch('type', 'individual')).from_json(value)
-        end
-
-        class Organization < self
-          SUBSCRIPTION_NAME = 'commercial organization'
-
-          def self.from_json(value)
-            new(licensed: value.fetch('repositories').map(&Repository.public_method(:parse)).to_set)
-          end
-
-          def call(world)
-            Repository.load_from_git(world).bind(&method(:check_subscription))
-          end
-
-        private
-
-          def check_subscription(actual)
-            if licensed.any? { |repository| actual.any? { |other| repository.allow?(other) } }
-              success
-            else
-              failure(licensed, actual)
-            end
-          end
-        end
-
-        class Individual < self
-          SUBSCRIPTION_NAME = 'commercial individual'
-
-          class Author
-            include Anima.new(:email)
-
-            alias_method :to_s, :email
-            public :to_s
-          end
-
-          def self.from_json(value)
-            new(licensed: value.fetch('authors').to_set { |email| Author.new(email: email) })
-          end
-
-          def call(world)
-            candidates = candidates(world)
-
-            if (licensed & candidates).any?
-              success
-            else
-              failure(licensed, candidates)
-            end
-          end
-
-        private
-
-          def candidates(world)
-            git_author(world).merge(commit_author(world))
-          end
-
-          def git_author(world)
-            capture(world, %w[git config --get user.email])
-          end
-
-          def commit_author(world)
-            capture(world, %w[git show --quiet --pretty=format:%ae])
-          end
-
-          def capture(world, command)
-            world
-              .capture_stdout(command)
-              .fmap(&:chomp)
-              .fmap { |email| Author.new(email: email) }
-              .fmap { |value| Set.new([value]) }
-              .from_right { Set.new }
-          end
-        end # Individual
-      end # Commercial
-    end # Subscription
-  end # License
-end # Mutant

data/lib/mutant/license/subscription/opensource.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Mutant
-  module License
-    class Subscription
-      class Opensource < self
-        SUBSCRIPTION_NAME = 'opensource repository'
-
-        def self.from_json(value)
-          new(licensed: value.fetch('repositories').map(&Repository.public_method(:parse)).to_set)
-        end
-
-        def call(world)
-          Repository.load_from_git(world).bind(&method(:check_subscription))
-        end
-
-      private
-
-        def check_subscription(actual)
-          if licensed.any? { |repository| actual.any? { |other| repository.allow?(other) } }
-            success
-          else
-            failure(licensed, actual)
-          end
-        end
-
-      end # Opensource
-    end # Subscription
-  end # License
-end # Mutant

data/lib/mutant/license/subscription/repository.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Mutant
-  module License
-    class Subscription
-      class Repository
-        include Anima.new(:host, :path)
-
-        REMOTE_REGEXP    = /\A[^\t]+\t(?<url>[^ ]+) \((?:fetch|push)\)\n\z/
-        GIT_SSH_REGEXP   = %r{\A[^@]+@(?<host>[^:/]+)[:/](?<path>.+?)(?:\.git)?\z}
-        GIT_HTTPS_REGEXP = %r{\Ahttps://(?<host>[^/]+)/(?<path>.+?)(?:\.git)?\z}
-        WILDCARD         = '/*'
-        WILDCARD_RANGE   = (..-WILDCARD.length)
-
-        private_constant(*constants(false))
-
-        def to_s
-          [host, path].join('/')
-        end
-
-        def self.load_from_git(world)
-          world
-            .capture_stdout(%w[git remote --verbose])
-            .fmap(&method(:parse_remotes))
-        end
-
-        def self.parse_remotes(input)
-          input.lines.map(&method(:parse_remote)).to_set
-        end
-        private_class_method :parse_remotes
-
-        def self.parse(input)
-          host, path = *input.split('/', 2).map(&:downcase)
-          new(host: host, path: path)
-        end
-
-        def self.parse_remote(input)
-          match = REMOTE_REGEXP.match(input) or
-            fail "Unmatched remote line: #{input.inspect}"
-
-          parse_url(match[:url])
-        end
-        private_class_method :parse_remote
-
-        def self.parse_url(input)
-          match = GIT_SSH_REGEXP.match(input) || GIT_HTTPS_REGEXP.match(input)
-
-          unless match
-            fail "Unmatched git remote URL: #{input.inspect}"
-          end
-
-          new(host: match[:host], path: match[:path].downcase)
-        end
-        private_class_method :parse_url
-
-        def allow?(other)
-          other.host.eql?(host) && path_match?(other.path)
-        end
-
-      private
-
-        def path_match?(other_path)
-          path.eql?(other_path) || wildcard_match?(path, other_path) || wildcard_match?(other_path, path)
-        end
-
-        def wildcard_match?(left, right)
-          left.end_with?(WILDCARD) && right.start_with?(left[WILDCARD_RANGE])
-        end
-      end # Repository
-    end # Subscription
-  end # License
-end # Mutant

data/lib/mutant/license/subscription.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Mutant
-  module License
-    class Subscription
-      include Anima.new(:licensed)
-
-      FORMAT = <<~'MESSAGE'
-        %<subscription_name>s subscription:
-        Licensed:
-        %<licensed>s
-      MESSAGE
-
-      FAILURE_FORMAT = <<~'MESSAGE'
-        Can not validate %<subscription_name>s license.
-        Licensed:
-        %<expected>s
-        Present:
-        %<actual>s
-      MESSAGE
-
-      # Load value into subscription
-      #
-      # @param [Object] value
-      #
-      # @return [Subscription]
-      def self.load(world, value)
-        {
-          'com' => Commercial,
-          'oss' => Opensource
-        }.fetch(value.fetch('type'))
-          .from_json(value.fetch('contents'))
-          .call(world)
-      end
-
-      # Subscription self description
-      #
-      # @return [String]
-      def description
-        FORMAT % {
-          licensed:          licensed.to_a.join("\n"),
-          subscription_name: subscription_name
-        }
-      end
-
-    private
-
-      def failure(expected, actual)
-        Either::Left.new(failure_message(expected, actual))
-      end
-
-      def success
-        Either::Right.new(self)
-      end
-
-      def subscription_name
-        self.class::SUBSCRIPTION_NAME
-      end
-
-      def failure_message(expected, actual)
-        FAILURE_FORMAT % {
-          actual:            actual.any? ? actual.map(&:to_s).join("\n") : '[none]',
-          expected:          expected.map(&:to_s).join("\n"),
-          subscription_name: subscription_name
-        }
-      end
-    end # Subscription
-  end # License
-end # Mutant

data/lib/mutant/license.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Mutant
-  module License
-    NAME    = 'mutant-license'
-    VERSION = ['>= 0.1', '< 0.3'].freeze
-
-    # Load license
-    #
-    # @param [World] world
-    #
-    # @return [Either<String,Subscription>]
-    #
-    # @api private
-    def self.call(world)
-      load_mutant_license(world)
-        .fmap { license_path(world) }
-        .bind { |path| Subscription.load(world, world.json.load(path)) }
-    end
-
-    def self.load_mutant_license(world)
-      Either
-        .wrap_error(LoadError) { world.gem_method.call(NAME, *VERSION) }
-        .lmap(&:message)
-        .lmap(&method(:check_for_rubygems_mutant_license))
-    end
-    private_class_method :load_mutant_license
-
-    def self.check_for_rubygems_mutant_license(message)
-      if message.include?('already activated mutant-license-0.0.0')
-        'mutant-license gem from rubygems.org is a dummy'
-      else
-        message
-      end
-    end
-    private_class_method :check_for_rubygems_mutant_license
-
-    def self.license_path(world)
-      world
-        .pathname
-        .new(world.gem.loaded_specs.fetch(NAME).full_gem_path)
-        .join('license.json')
-    end
-    private_class_method :license_path
-  end
-end