mutator_rails 0.1.8

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mutator_rails'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/mutator_rails.yml

@@ -0,0 +1,8 @@
+---
+logroot: 'log/mutant/'
+guide_file: 'log/mutant/guide.txt'
+analysis_csv: 'log/mutant/analysis.tsv'
+statistics: 'log/mutant/statistics.txt'
+
+exclusions:
+  -

data/defaults.reek

@@ -0,0 +1,131 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+InstanceVariableAssumption:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+ManualDispatch:
+  enabled: true
+  exclude: []
+ModuleInitialize:
+  enabled: true
+  exclude: []
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators:
+  - tap
+NilCheck:
+  enabled: true
+  exclude: []
+PrimaDonnaMethod:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 2
+SubclassedFromCoreClass:
+  enabled: true
+  exclude: []
+Syntax:
+  enabled: true
+  exclude: []
+TooManyConstants:
+  enabled: true
+  exclude: []
+  max_constants: 5
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 4
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 15
+TooManyStatements:
+  enabled: true
+  exclude:
+  - initialize
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  - !ruby/regexp /^_/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - !ruby/regexp /^_$/
+UnusedParameters:
+  enabled: true
+  exclude: []
+UnusedPrivateMethod:
+  enabled: false
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  public_methods_only: false

data/lib/mutator_rails.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'etc'
+require 'yaml'
+require 'json'
+require 'ostruct'
+require 'fileutils'
+require 'rake/file_list'
+require 'procto'
+require 'adamantium'
+require 'concord'
+require 'rails'
+
+require 'mutator_rails/guide'
+require 'mutator_rails/railtie'
+require 'mutator_rails/config'
+require 'mutator_rails/version'
+require 'mutator_rails/list_maker'
+
+require 'mutator_rails/analyze'
+require 'mutator_rails/cleanup'
+require 'mutator_rails/statistics'
+require 'mutator_rails/full_mutate'
+
+# Mutator Rails' core functionality
+module MutatorRails
+  MUTANT_VERSION = `bundle exec mutant --version`.strip.split('-').last.strip
+
+  COMMAND     = 'RAILS_ENV=test bundle exec mutant '
+  BASIC_PARMS = ['-r./config/environment.rb', '--use rspec'].freeze
+
+  APP_BASE = 'app/'
+end

data/lib/mutator_rails/analyze.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'mutator_rails/mutation_log'
+
+module MutatorRails
+  class Analyze
+    include Procto.call
+    include Adamantium::Flat
+
+    def call
+      list = ListMaker.new.make_list
+      return if list.blank?
+
+      content = list.map(&:to_s).join("\n")
+
+      puts " ... storing #{csv}"
+      File.write(csv,
+                 MutationLog::HEADER + content)
+    end
+
+    private
+
+    def csv
+      MutatorRails::Config.configuration.analysis_csv
+    end
+  end
+end

data/lib/mutator_rails/cleanup.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'mutator_rails/single_mutate'
+
+module MutatorRails
+  class Cleanup
+    include Procto.call
+    include Adamantium::Flat
+
+    def initialize(*)
+      excluded_files
+      @guide = Guide.new
+      @guide_keys = guide.guides.keys
+    end
+
+    def call
+      Dir
+        .glob(APP_BASE + '**/*.rb') 
+        .each do |file|
+        next if exclude?(file)
+
+        check(file)
+      end
+
+      guide_keys.each do |file|
+        File.delete(file) if File.exist?(file)
+        puts "removing #{file}"
+        guide.remove(file)
+      end
+    end
+
+    private
+    
+    def check(file)
+      log = file.sub(APP_BASE, Config.configuration.logroot).sub('.rb','.log')
+
+      if guide_keys.include?(log)
+        guide_keys.delete(log)
+      end
+    end
+
+    def excluded_files
+      @exclusions ||= load_exclusions
+    end
+
+    def load_exclusions
+      MutatorRails::Config
+        .configuration
+        .exclusions
+        .compact
+        .flat_map { |exclusion| Dir.glob(exclusion) }
+    end
+
+    def exclude?(file)
+      excluded_files.include?(file)
+    end
+
+    attr_reader :guide_keys, :guide
+  end
+end

data/lib/mutator_rails/config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'mutator_rails/mutation_log'
+
+module MutatorRails
+  class Config
+
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'mutator_rails.yml').freeze
+    USER_CONFIG    = Pathname(Dir.pwd).join('mutator_rails.yml').freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+
+    class << self
+      def configuration
+        @configuration ||= load_configuration
+      end
+
+      def load_configuration
+        default_config = YAML.load_file(CONFIG_DEFAULT)
+        user_config    = if USER_CONFIG && File.exist?(USER_CONFIG.to_s)
+                           YAML.load_file(USER_CONFIG)
+                         else
+                           {}
+                         end
+
+        consolidated = default_config.merge(user_config)
+
+        JSON.parse(consolidated.to_json, object_class: OpenStruct).freeze
+      end
+
+    end
+  end
+end

data/lib/mutator_rails/full_mutate.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'mutator_rails/single_mutate'
+
+module MutatorRails
+  class FullMutate
+    include Procto.call
+    include Adamantium::Flat
+
+    def initialize(*)
+      excluded_files
+      @guide = Guide.new
+    end
+
+    def call
+      Dir.glob(APP_BASE + '**/*.rb').sort_by { |x| File.size(x) }.each do |file|
+        next if exclude?(file)
+
+        SingleMutate.new(guide, file).call
+      end
+    end
+
+    private
+
+    def excluded_files
+      @exclusions ||= load_exclusions
+    end
+
+    def load_exclusions
+      MutatorRails::Config.configuration.exclusions.compact.flat_map { |exclusion| Dir.glob(exclusion) }
+    end
+
+    def exclude?(file)
+      excluded_files.include?(file)
+    end
+
+    attr_reader :guide
+  end
+end

data/lib/mutator_rails/guide.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module MutatorRails
+  class Guide
+
+    SEP = ' | '.freeze
+
+    attr_reader :guides
+
+    def initialize(*)
+      preset_file
+    end
+
+    def current?(log, code_md5, spec_md5)
+      # p guides[log]
+      File.exist?(log) &&
+        File.size(log).positive? &&
+        guides[log].present? &&
+        guides[log].eql?([code_md5, spec_md5, MUTANT_VERSION])
+    end
+
+    def update(log, code_md5, spec_md5)
+      guides[log] = [code_md5, spec_md5, MUTANT_VERSION]
+      recreate
+    end
+
+    def remove(log)
+      guides.delete(log)
+      recreate
+    end
+
+    private
+
+    def preset_file
+      create_guide_file unless File.exist?(guide_file_name)
+
+      load
+    end
+
+    def load
+      @guides = {}
+      File.readlines(guide_file_name).each do |line|
+        log, code_md5, spec_md5, mutant_version = line.strip.split(SEP)
+        guides[log]                             = [code_md5, spec_md5, mutant_version]
+      end
+    end
+
+    def recreate
+      f = File.open(guide_file_name, 'w')
+      guides.sort.each do |k, v|
+        f.puts ("#{k}#{SEP}#{v.join(SEP)}") if k.present?
+      end
+      f.close
+    end
+
+    def create_guide_file
+      puts ".. creating guide file #{guide_file_name}"
+      File.open(guide_file_name, "w+")
+    end
+
+    def guide_file_name
+      Pathname(Dir.pwd).join(MutatorRails::Config.configuration.guide_file).tap do |p|
+        FileUtils.mkdir_p(p.dirname)
+      end
+    end
+
+
+  end
+end

data/lib/mutator_rails/list_maker.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'mutator_rails/single_mutate'
+
+module MutatorRails
+  class ListMaker
+    include Adamantium::Flat
+
+    def make_list
+      list = []
+
+      Dir.glob(Config.configuration.logroot + '**/*.log').each do |target_log|
+        next unless File.exist?(target_log)
+
+        begin
+          list << MutationLog.new(target_log)
+        rescue Exception => se
+          # skip it
+          puts "Error: #{se}"
+        end
+      end
+      list.sort
+    end
+  end
+end