suture 0.2.0 → 0.3.0

data/lib/suture/surgeon/observer.rb

@@ -4,10 +4,20 @@ module Suture::Surgeon
   class Observer
     def operate(plan)
       dictaphone = Suture::Adapter::Dictaphone.new(plan)
-      plan.old.call(*plan.args).tap do |result|
+      invoke(plan).tap do |result|
         dictaphone.record(result)
       end
     end
+
+    private
+
+    def invoke(plan)
+      if plan.args
+        plan.old.call(*plan.args)
+      else
+        plan.old.call
+      end
+    end
   end
 end
 

data/lib/suture/tests_patient.rb

@@ -1,13 +1,19 @@
 require "suture/adapter/dictaphone"
 require "suture/value/test_results"
+require "suture/util/timer"
+require "suture/util/shuffle"
+require "backports/1.9.2/random"
 
 module Suture
   class TestsPatient
     def test(test_plan)
-      dictaphone = Suture::Adapter::Dictaphone.new(test_plan)
       experienced_failure_in_life = false
-      Value::TestResults.new(dictaphone.play.map { |observation|
-        if test_plan.fail_fast && experienced_failure_in_life
+      timer = Suture::Util::Timer.new(test_plan.time_limit) unless test_plan.time_limit.nil?
+      test_cases = build_test_cases(test_plan)
+      Value::TestResults.new(test_cases.each_with_index.map { |observation, i|
+        if (test_plan.fail_fast && experienced_failure_in_life) ||
+            (test_plan.call_limit && i >= test_plan.call_limit) ||
+            (timer && timer.time_up?)
           {
             :observation => observation,
             :ran => false
@@ -16,17 +22,35 @@ module Suture
           invoke(test_plan, observation).merge({
             :observation => observation,
             :ran => true
-          }).tap { |r| experienced_failure_in_life = true unless r[:passed]}
+          }).tap { |r| experienced_failure_in_life = true unless r[:passed] }
         end
       })
     end
 
+    private
+
+    def build_test_cases(test_plan)
+      dictaphone = Suture::Adapter::Dictaphone.new(test_plan)
+      shuffle(
+        dictaphone.play(test_plan.verify_only),
+        test_plan.random_seed
+      )
+    end
+
+    def shuffle(rows, random_seed)
+      return rows unless random_seed
+      Suture::Util::Shuffle.shuffle(Random.new(random_seed), rows)
+    end
+
     def invoke(test_plan, observation)
       {}.tap do |result|
         begin
-          result[:new_result] = test_plan.subject.call(*observation.args)
-          # TODO: Comparators go here:
-          result[:passed] = result[:new_result] == observation.result
+          result[:new_result] = if observation.args
+                                  test_plan.subject.call(*observation.args)
+                                else
+                                  test_plan.subject.call
+                                end
+          result[:passed] = test_plan.comparator.call(observation.result, result[:new_result])
         rescue StandardError => e
           result[:passed] = false
           result[:error] = e

data/lib/suture/util/env.rb

@@ -1,11 +1,11 @@
 module Suture::Util
   module Env
-    def self.to_map(excludes)
+    def self.to_map(excludes = {})
       Hash[
         ENV.keys.
             select { |k| k.start_with?("SUTURE_") }.
             map { |k| [to_sym(k), sanitize_value(ENV[k])] }
-      ].reject { |(k,v)| excludes.include?(k) }
+      ].reject { |(k,_)| excludes.include?(k) }
     end
 
     # private
@@ -15,8 +15,13 @@ module Suture::Util
     end
 
     def self.sanitize_value(value)
-      return false if value == "false"
-      value
+      if value == "false"
+        false
+      elsif value == "true"
+        true
+      else
+        value
+      end
     end
   end
 end

data/lib/suture/util/shuffle.rb

@@ -0,0 +1,13 @@
+module Suture::Util
+  module Shuffle
+    def self.shuffle(random, unshuffled_array)
+      old_array = unshuffled_array.dup
+      new_array = []
+      while new_array.size < unshuffled_array.size
+        index = random.rand(old_array.size)
+        new_array << old_array.delete_at(index)
+      end
+      return new_array
+    end
+  end
+end

data/lib/suture/util/timer.rb

@@ -0,0 +1,14 @@
+require "time"
+
+module Suture::Util
+  class Timer
+    def initialize(limit_in_seconds)
+      @started_at = Time.new
+      @limit_in_seconds = limit_in_seconds
+    end
+
+    def time_up?
+      Time.new >= (@started_at + @limit_in_seconds)
+    end
+  end
+end

data/lib/suture/value/plan.rb

@@ -1,12 +1,13 @@
 module Suture::Value
   class Plan
-    attr_reader :name, :old, :new, :args, :record_calls, :database_path
+    attr_reader :name, :old, :new, :args, :record_calls, :comparator, :database_path
     def initialize(attrs = {})
       @name = attrs[:name]
       @old = attrs[:old]
       @new = attrs[:new]
       @args = attrs[:args]
       @record_calls = !!attrs[:record_calls]
+      @comparator = attrs[:comparator]
       @database_path = attrs[:database_path]
     end
   end

data/lib/suture/value/test_plan.rb

@@ -1,12 +1,41 @@
 module Suture::Value
   class TestPlan
-    attr_accessor :name, :subject, :args, :fail_fast, :database_path
+    attr_accessor :name, :subject,
+                  :verify_only, :fail_fast, :call_limit, :time_limit,
+                  :error_message_limit, :random_seed,
+                  :comparator, :database_path
     def initialize(attrs = {})
-      @name = attrs[:name]
-      @subject = attrs[:subject]
-      @args = attrs[:args]
-      @fail_fast = attrs[:fail_fast]
-      @database_path = attrs[:database_path]
+      assign_simple_ivars!(attrs, :name, :subject, :fail_fast, :comparator, :database_path)
+      assign_integral_ivars(attrs, :verify_only, :call_limit, :time_limit, :error_message_limit)
+      @random_seed = determine_random_seed(attrs)
+    end
+
+    private
+
+    def assign_simple_ivars!(attrs, *names)
+      names.each do |name|
+        instance_variable_set("@#{name}", attrs[name])
+      end
+    end
+
+    def assign_integral_ivars(attrs, *names)
+      assign_simple_ivars!(
+        Hash[attrs.select {|(k,_)| names.include?(k) }.
+                   map { |(k,v)| [k, v.nil? ? nil : v.to_i]}],
+        *names
+      )
+    end
+
+    def determine_random_seed(attrs)
+      if attrs.has_key?(:random_seed)
+        if attrs[:random_seed].nil? || attrs[:random_seed] == "nil"
+          nil
+        else
+          attrs[:random_seed].to_i
+        end
+      else
+        rand(99999)
+      end
     end
   end
 end

data/lib/suture/value/test_results.rb

@@ -22,8 +22,12 @@ module Suture::Value
       @results.count { |r| r[:passed] }
     end
 
+    def failed
+      @results.select { |r| !r[:passed] && r[:ran] }
+    end
+
     def failed_count
-      @results.count { |r| !r[:passed] && r[:ran] }
+      failed.size
     end
 
     def errored_count

data/lib/suture/version.rb

@@ -1,3 +1,3 @@
 module Suture
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/suture/wrap/logger.rb

@@ -0,0 +1,40 @@
+require "logger"
+
+module Suture::Wrap
+  module Logger
+    def self.init(options)
+      if options[:log_file]
+        full_path = File.join(Dir.getwd, options[:log_file])
+        FileUtils.mkdir_p(File.dirname(full_path))
+        @logger = ::Logger.new(full_path)
+      elsif options[:log_stdout]
+        @logger = ::Logger.new(STDOUT)
+      else
+        @logger = NullLogger.new
+      end
+
+      @logger.level = if options[:log_level]
+                        ::Logger.const_get(options[:log_level])
+                      else
+                        ::Logger::INFO
+                      end
+
+      @logger.formatter = proc { |_, time , _, msg|
+        formatted_time = time.strftime("%Y-%m-%dT%H:%M:%S.%6N")
+        "[#{formatted_time}] Suture: #{msg}\n".tap { |out|
+          puts out if options[:log_file] && options[:log_stdout]
+        }
+      }
+
+      return @logger
+    end
+
+    class NullLogger
+      def formatter=; end
+      def level=; end
+      def debug; end
+      def info; end
+      def warn; end
+    end
+  end
+end

data/lib/suture/wrap/sqlite.rb

@@ -43,7 +43,14 @@ module Suture::Wrap
     end
 
     def self.select(db, table, where_clause, bind_params)
-      db.execute("select * from #{table} #{where_clause}", bind_params)
+      db.execute(
+        "select * from #{table} #{where_clause} order by id asc",
+        bind_params
+      )
+    end
+
+    def self.delete(db, table, where_clause, bind_params)
+      db.execute("delete from #{table} #{where_clause}", bind_params)
     end
   end
 end

data/lib/suture.rb

@@ -8,9 +8,16 @@ require "suture/prescribes_test_plan"
 require "suture/tests_patient"
 require "suture/interprets_results"
 
+require "suture/adapter/log"
+require "suture/comparator"
+
 module Suture
   DEFAULT_OPTIONS = {
-    :database_path => "db/suture.sqlite3"
+    :database_path => "db/suture.sqlite3",
+    :comparator => Comparator.new,
+    :log_level => "INFO",
+    :log_file => nil,
+    :log_stdout => true
   }
 
   def self.create(name, options)
@@ -23,7 +30,22 @@ module Suture
     test_plan = Suture::PrescribesTestPlan.new.prescribe(name, options)
     test_results = Suture::TestsPatient.new.test(test_plan)
     if test_results.failed?
-      Suture::InterpretsResults.new.interpret(test_results)
+      Suture::InterpretsResults.new.interpret(test_plan, test_results)
     end
   end
+
+  def self.delete(id, options = {})
+    plan = BuildsPlan.new.build(name, options)
+    Suture::Adapter::Dictaphone.new(plan).delete(id)
+  end
+
+  def self.config(config = {})
+    @config ||= DEFAULT_OPTIONS.dup
+    @config.merge!(config)
+  end
+
+  def self.reset!
+    @config = nil
+    Adapter::Log.reset!
+  end
 end

data/suture.gemspec

@@ -13,16 +13,23 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Provides tools to record calls to legacy code and verify new implementations still work}
   spec.homepage      = "https://github.com/testdouble/suture"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|db|safe|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|db|log|safe|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "sqlite3"
+  spec.add_dependency "backports"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry", "~> 0.9.12.6"
   spec.add_development_dependency "minitest", "~> 5.9"
   spec.add_development_dependency "gimme", "~> 0.5"
+  spec.add_development_dependency "github_changelog_generator"
+
+  if Gem.ruby_version >= Gem::Version.new("1.9.3")
+    spec.add_development_dependency "codeclimate-test-reporter"
+    spec.add_development_dependency "simplecov", "~> 0.11.2" #<--only here to lock
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suture
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-21 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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: codeclimate-test-reporter
+  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.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
 description: Provides tools to record calls to legacy code and verify new implementations
   still work
 email:
@@ -102,8 +158,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".projections.json"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -113,8 +171,10 @@ files:
 - bin/setup
 - lib/suture.rb
 - lib/suture/adapter/dictaphone.rb
+- lib/suture/adapter/log.rb
 - lib/suture/builds_plan.rb
 - lib/suture/chooses_surgeon.rb
+- lib/suture/comparator.rb
 - lib/suture/error/observation_conflict.rb
 - lib/suture/error/schema_version.rb
 - lib/suture/error/verification_failed.rb
@@ -125,11 +185,14 @@ files:
 - lib/suture/surgeon/observer.rb
 - lib/suture/tests_patient.rb
 - lib/suture/util/env.rb
+- lib/suture/util/shuffle.rb
+- lib/suture/util/timer.rb
 - lib/suture/value/observation.rb
 - lib/suture/value/plan.rb
 - lib/suture/value/test_plan.rb
 - lib/suture/value/test_results.rb
 - lib/suture/version.rb
+- lib/suture/wrap/logger.rb
 - lib/suture/wrap/sqlite.rb
 - suture.gemspec
 homepage: https://github.com/testdouble/suture