stable 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 175189cf26af9af442179f76fd0af6f4d2fcc0f5b4ef435844a7d35a1f1ff03d
-  data.tar.gz: 1c4b639f56e3f711a3325ec071e059b7b6a666399e17cb346560539bbaaba330
+  metadata.gz: 84ffc96e3befd0fb806003874c7b63dcc466b0c93de4c0490742542d0c22b98e
+  data.tar.gz: f7ed6f16c45d94a71f5042c91819617694d0ecb0a229dd15efe62c6b34463e59
 SHA512:
-  metadata.gz: 9bcf35dba6eca3109e0a0bbd5676ca3976dcf7bcbaa4dea2e79bab467a7c69fa765490de0137e54130d6e22eb950b0d7e2bd63ab9712de5c186cfb389c54b207
-  data.tar.gz: c00fc59dbd7f6240bee2a359bb3cf9500ca00bc4adb0ab58d0644a417a71be4db98a51bd02b4801ece007d72eac908c34415370051a69b76cd7b1f4920ee0027
+  metadata.gz: 347c9d97b2e4f4a320bc43e62674de74b2c60e0001b5d05df852347d8307cd3be93332bbcb2c8b921ec60ebc51970f9e5cf180d8e92e4a14626d0b7c65d4493a
+  data.tar.gz: 4f9cb7f894efd116ce22dc200c11d5f2a1401cdadbbb4d9cc131961c4a612964196379c761db9d37f071cb5a682ece70a0cc983d30d46a8b495b61e782e56c6f

data/lib/stable/configuration.rb

@@ -1,11 +1,12 @@
 # lib/stable/configuration.rb
 module Stable
   class Configuration
-    attr_accessor :storage_path, :enabled
+    attr_accessor :storage_path, :enabled, :fact_paths
 
     def initialize
       @storage_path = nil
       @enabled = false
+      @fact_paths = ['facts/**/*.fact']
     end
   end
 end

data/lib/stable/{spec.rb → fact.rb}

@@ -1,13 +1,13 @@
-# lib/stable/spec.rb
+# lib/stable/fact.rb
 require 'json'
 require 'securerandom'
 require 'digest'
 
 module Stable
-  # a spec is a recording of a single method call, including the inputs and
+  # a fact is a recording of a single method call, including the inputs and
   # outputs. it's a self-contained, serializable representation of a method's
   # behavior at a specific point in time.
-  class Spec
+  class Fact
     attr_reader :class_name, :method_name, :args, :result, :error, :actual_result, :actual_error, :status, :uuid, :signature, :name
 
     def initialize(class_name:, method_name:, args:, result: nil, error: nil, uuid: SecureRandom.uuid, name: nil)
@@ -51,42 +51,7 @@ module Stable
       self
     end
 
-    def to_s
-      short_uuid = uuid.split('-').last
-      short_sig = signature[0..6]
-      desc = "#{short_uuid}/#{short_sig}"
-      name_str = name[..19].ljust(20)
-      call = "#{class_name}##{method_name}(#{args.join(', ')})"
-      status_code = _status_code
-      error_code = _error_code
 
-      case status
-      when :passed, :passed_with_error
-        "#{desc} #{name_str} #{status_code}#{error_code} #{call}"
-      when :failed
-        lines = ["#{desc} #{name_str} #{status_code}#{error_code} #{call}"]
-        if actual_error
-          if error
-            lines << "  Expected error: #{error['class']}"
-            lines << "  Actual error:   #{actual_error.class.name}: #{actual_error.message}"
-          else
-            lines << "  Expected result: #{result.inspect}"
-            lines << "  Actual error:    #{actual_error.class.name}: #{actual_error.message}"
-          end
-        else
-          if error
-            lines << "  Expected error: #{error['class']}"
-            lines << "  Actual result: #{actual_result.inspect}"
-          else
-            lines << "  Expected: #{result.inspect}"
-            lines << "  Actual:   #{actual_result.inspect}"
-          end
-        end
-        lines.join("\n")
-      else
-        "#{desc} #{name_str} #{status_code}#{error_code} #{call}"
-      end
-    end
 
     def to_jsonl
       {
@@ -114,39 +79,6 @@ module Stable
       )
     end
 
-    def _green(text)
-      "\e[32m#{text}\e[0m"
-    end
-
-    def _red(text)
-      "\e[31m#{text}\e[0m"
-    end
-
-    def _yellow(text)
-      "\e[33m#{text}\e[0m"
-    end
-
-    def _light_blue(text)
-      "\e[94m#{text}\e[0m"
-    end
-
-    def _status_code
-      case status
-      when :passed, :passed_with_error
-        _green('P')
-      when :failed
-        _red('F')
-      else
-        _yellow('?')
-      end
-    end
 
-    def _error_code
-      if error || actual_error
-        _light_blue('E')
-      else
-        _green('N')
-      end
-    end
   end
 end

data/lib/stable/formatters/colors.rb

@@ -0,0 +1,24 @@
+# lib/stable/formatters/colors.rb
+module Stable
+  module Formatters
+    module Colors
+      extend self
+
+      def green(text)
+        "\e[32m#{text}\e[0m"
+      end
+
+      def red(text)
+        "\e[31m#{text}\e[0m"
+      end
+
+      def yellow(text)
+        "\e[33m#{text}\e[0m"
+      end
+
+      def light_blue(text)
+        "\e[94m#{text}\e[0m"
+      end
+    end
+  end
+end

data/lib/stable/formatters/verbose.rb

@@ -0,0 +1,84 @@
+# lib/stable/formatters/verbose.rb
+require_relative 'colors'
+
+module Stable
+  module Formatters
+    class Verbose
+
+      def initialize(facts)
+        @facts = facts
+      end
+
+      def to_s(fact)
+        short_uuid = fact.uuid.split('-').last
+        short_sig = fact.signature[0..6]
+        desc = "#{short_uuid}/#{short_sig}"
+        name_str = fact.name[..19].ljust(20)
+        call = "#{fact.class_name}##{fact.method_name}(#{fact.args.join(', ')})"
+        status_code = _status_code(fact)
+        error_code = _error_code(fact)
+
+        case fact.status
+        when :passed, :passed_with_error
+          "#{desc} #{name_str} #{status_code}#{error_code} #{call}"
+        when :failed
+          lines = ["#{desc} #{name_str} #{status_code}#{error_code} #{call}"]
+          if fact.actual_error
+            if fact.error
+              lines << "  Expected error: #{fact.error['class']}"
+              lines << "  Actual error:   #{fact.actual_error.class.name}: #{fact.actual_error.message}"
+            else
+              lines << "  Expected result: #{fact.result.inspect}"
+              lines << "  Actual error:    #{fact.actual_error.class.name}: #{fact.actual_error.message}"
+            end
+          else
+            if fact.error
+              lines << "  Expected error: #{fact.error['class']}"
+              lines << "  Actual result: #{fact.actual_result.inspect}"
+            else
+              lines << "  Expected: #{fact.result.inspect}"
+              lines << "  Actual:   #{fact.actual_result.inspect}"
+            end
+          end
+          lines.join("\n")
+        else
+          "#{desc} #{name_str} #{status_code}#{error_code} #{call}"
+        end
+      end
+
+      def header
+        header = "#{'uuid        / sig'.ljust(20)} #{'name'.ljust(20)} st call"
+        "#{header}\n#{'-' * 20} #{'-' * 20} -- #{'-' * 35}"
+      end
+
+      def summary
+        passing = @facts.count { |f| f.status == :passed || f.status == :passed_with_error }
+        failing = @facts.count { |f| f.status == :failed }
+        pending = @facts.count { |f| f.status == :pending }
+        "\n#{@facts.count} facts, #{passing} passing, #{pending} pending, #{failing} failing"
+      end
+
+
+      private
+
+      def _status_code(fact)
+        case fact.status
+        when :passed, :passed_with_error
+          Colors.green('P')
+        when :failed
+          Colors.red('F')
+        else
+          Colors.yellow('?')
+        end
+      end
+
+      def _error_code(fact)
+        if fact.error || fact.actual_error
+          Colors.light_blue('E')
+        else
+          Colors.green('N')
+        end
+      end
+    end
+  end
+end

data/lib/stable.rb

@@ -1,6 +1,6 @@
 # `stable` is a library for recording and replaying method calls.
 # See README.md for detailed usage instructions.
-require_relative 'stable/spec'
+require_relative 'stable/fact'
 require_relative 'stable/configuration'
 
 if defined?(Rake)
@@ -38,7 +38,7 @@ module Stable
     end
 
     # this method is a block-based way to enable and disable recording of
-    # specs. It ensures that recording is turned on for the duration of the
+    # facts. It ensures that recording is turned on for the duration of the
     # block and is automatically turned off afterward, even if an error occurs.
     #
     # example:
@@ -63,20 +63,20 @@ module Stable
           if Stable.enabled?
             begin
               result = original_method.bind(self).call(*args, &block)
-              spec = Spec.new(
+              fact = Fact.new(
                 class_name: klass.name,
                 method_name: method_name,
                 args: args,
                 result: result
               )
-              unless Stable.send(:_spec_exists?, spec.signature)
-                Stable.storage.puts(spec.to_jsonl)
+              unless Stable.send(:_fact_exists?, fact.signature)
+                Stable.storage.puts(fact.to_jsonl)
                 Stable.storage.flush
-                Stable.send(:_recorded_specs) << spec
+                Stable.send(:_recorded_facts) << fact
               end
               result
             rescue => e
-              spec = Spec.new(
+              fact = Fact.new(
                 class_name: klass.name,
                 method_name: method_name,
                 args: args,
@@ -86,10 +86,10 @@ module Stable
                   backtrace: e.backtrace
                 }
               )
-              unless Stable.send(:_spec_exists?, spec.signature)
-                Stable.storage.puts(spec.to_jsonl)
+              unless Stable.send(:_fact_exists?, fact.signature)
+                Stable.storage.puts(fact.to_jsonl)
                 Stable.storage.flush
-                Stable.send(:_recorded_specs) << spec
+                Stable.send(:_recorded_facts) << fact
               end
               raise e
             end
@@ -102,23 +102,23 @@ module Stable
     end
 
     def verify(record_hash)
-      Spec.from_jsonl(record_hash.to_json).run!
+      Fact.from_jsonl(record_hash.to_json).run!
     end
 
     private
 
-    def _recorded_specs
-      @_recorded_specs ||= begin
+    def _recorded_facts
+      @_recorded_facts ||= begin
         return [] unless storage.respond_to?(:path) && File.exist?(storage.path)
         storage.rewind
-        specs = storage.each_line.map { |line| Spec.from_jsonl(line) }
+        facts = storage.each_line.map { |line| Fact.from_jsonl(line) }
         storage.seek(0, IO::SEEK_END)
-        specs
+        facts
       end
     end
 
-    def _spec_exists?(signature)
-      _recorded_specs.any? { |spec| spec.signature == signature }
+    def _fact_exists?(signature)
+      _recorded_facts.any? { |fact| fact.signature == signature }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stable
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Jeff Lunt
@@ -33,7 +33,9 @@ files:
 - lib/example/calculator.rb
 - lib/stable.rb
 - lib/stable/configuration.rb
-- lib/stable/spec.rb
+- lib/stable/fact.rb
+- lib/stable/formatters/colors.rb
+- lib/stable/formatters/verbose.rb
 homepage: https://github.com/jefflunt/stable
 licenses:
 - MIT