docspec 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 285211d9493c575fb886a6e587e6163440017936c9171a015f323ee5b5e75f12
-  data.tar.gz: 8481fd32a94801a88e995c82acee35cbf82f703f59212194e5b8da07d88c1607
+  metadata.gz: 50f8d84c839b9b2c42002526d2a71b7ba77c3e4593e3bd11707b15437b8ff8fd
+  data.tar.gz: 03b17f9c88a24ac31c405954aadd080b65b8c288ccb3f8b92d25b3ec45d03017
 SHA512:
-  metadata.gz: acee792d5459ed127e6508feb898c3dc37f7cd0a705c3076ac0adbe457470de40b13282a465527a58275cdc7c21785a4e74cd8fd9d692bb3c24d1e026c6e0def
-  data.tar.gz: c5e0e51cef54cf5080914695a1f6292bdd50bfbf113deb10d439e5b093d5265715d02f0172df6f4d551161ea002e5a9416ea00f8b51d30c607ee4f1f1b1a817d
+  metadata.gz: ad12b1aa05ab33e0fa3d506375c7f5de01edd4da59c3423d995af02b642ce56b6d08820fa0ea602998b6f895e4be8e2b0b2b5cbb4774f46cec4a1e19e7fb26ed
+  data.tar.gz: ed148aa6718aaa0b9c624e9af55b0029a115a6cb48e710d55acb1029ebce895001e5ff77ae9af8c0ee3cdac39cb4972a994a94a2490040dcf1322dce59fab18f

data/README.md

@@ -2,8 +2,11 @@ Docspec
 ==================================================
 
 [![Gem Version](https://badge.fury.io/rb/docspec.svg)](https://badge.fury.io/rb/docspec)
+[![Build Status](https://travis-ci.com/DannyBen/docspec.svg?branch=master)](https://travis-ci.com/DannyBen/docspec)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e0c15c1f33fa4aa45f70/maintainability)](https://codeclimate.com/github/DannyBen/docspec/maintainability)
 
-Inline tests in Markdown documents.
+Docspec lets you reuse your Markdown documents as the unit tests for your
+Ruby library.
 
 ---
 
@@ -32,6 +35,9 @@ Rules
   expected output.
 - If a piece of code raises an error, the captured output will be the 
   `#inspect` string of that exception.
+- If the first line of a code block includes the string `[:ignore_failure]`, 
+  the example will not be considered an error if it fails.
+
 
 To test the `README.md` in the current folder, just run:
 
@@ -82,11 +88,29 @@ puts 2 - 3
 ```
 
 ```ruby
-# This example should fail
+# This example may fail [:ignore_failure]
+# Due to the :ignore_failure flag, it will show the failure diff, but will
+# not be considered a failure in the exit status.
 puts 'hello world'.upcase
 #=> hello world
 ```
 
+```ruby
+# Code that does not generate any output will be executed before each
+# of the subsequent examples.
+def create_caption(text)
+  [text.upcase, ("=" * text.length)].join "\n"
+end
+```
+
+```ruby
+# Example that builds upon code that was defined earlier
+puts create_caption "tada!"
+#=> TADA!
+#=> =====
+```
+
+
 ### Shell
 
 ```shell

data/bin/docspec

@@ -13,10 +13,6 @@ success = tester.execute
 
 say ''
 
-if tester.expected_failures != 0
-  say "!txtblu!Expected failures: #{tester.expected_failures}"
-end
-
 if success
   say "!txtgrn!#{tester.total} tests, #{tester.errors} failed\n"
   exit 0

data/lib/docspec/document.rb

@@ -18,7 +18,7 @@ module Docspec
 
     def examples!
       result = []
-      markdown.scan(/```(ruby|shell)\n(.*?)```/m) do |type, code|
+      markdown.scan(/```(ruby|shell)\s*\n(.*?)```/m) do |type, code|
         result << Example.new(code, type)
       end
       result

data/lib/docspec/example.rb

@@ -3,50 +3,71 @@ require 'diffy'
 module Docspec
   class Example
     include OutputCapturer
-
-    attr_reader :code, :type
+    attr_reader :code, :type, :full_code
 
     def initialize(code, type)
       @code, @type = code, type
+      @full_code = @code
     end
 
-    def label
-      @label ||= label!
+    def actual
+      @actual ||= actual!
+    end
+
+    def diff
+      @diff ||= Diffy::Diff.new("#{expected}\n", "#{actual}\n", context: 2).to_s :color
+    end
+
+    def empty?
+      actual.empty?
     end
 
     def expected
       @expected ||= code.scan(/#=>\s*(.*)/).map { |match| match.first.strip }.join "\n"
     end
 
-    def actual
-      @actual ||= actual!
+    def first_line
+      @first_line ||= code.split("\n").first
     end
 
-    def passing?
-      actual == expected
+    def flags
+      @flags ||= first_line.scan(/\[:(.+?)\]/).map { |f| f.first.to_sym }
     end
 
-    def diff
-      Diffy::Diff.new(expected, actual, context: 2).to_s :color
+    def ignore_failure?
+      flags.include? :ignore_failure
     end
 
-  protected
+    def label
+      @label ||= label!
+    end
 
-    def label!
-      first_line = code.split("\n").first
-      first_line.gsub(/^#\s*/, '').strip
+    def prepend(codes)
+      codes = [codes] unless codes.is_a? Array
+      codes = codes.join "\n\n"
+      @full_code = "#{codes}\n#{@full_code}"
+    end
+
+    def success?
+      actual == expected
     end
 
+  protected
+
     def actual!
       capture_output do
         case type
         when 'ruby'
-          instance_eval(code)
+          eval full_code
         when 'shell'
           puts `#{code}`
         end
       end.strip
     end
 
+    def label!
+      first_line.gsub(/^#\s*/, '').strip
+    end
+
   end
 end

data/lib/docspec/tester.rb

@@ -3,24 +3,34 @@ require 'colsole'
 module Docspec
   class Tester
     include Colsole
-    attr_reader :document, :errors
+    attr_reader :document, :errors, :total
 
     def initialize(document)
       document = Document.new document unless document.is_a? Document
       @document = document
       @errors = 0
+      @total = 0
     end
 
-    def total
-      @total ||= document.examples.count
+    def before_codes
+      @before_codes ||= []
     end
 
     def execute
       document.examples.each do |example|
-        if example.passing?
+        if example.empty?
+          before_codes << example.code
+          next
+        end
+
+        @total += 1
+
+        example.prepend before_codes
+
+        if example.success?
           say "!txtgrn!PASS: #{example.label}"
         else
-          @errors += 1
+          @errors += 1 unless example.ignore_failure?
           say "!txtred!FAIL: #{example.label}"
           say "---"
           puts example.diff
@@ -28,11 +38,7 @@ module Docspec
         end
       end
 
-      errors == expected_failures
-    end
-
-    def expected_failures
-      ENV['DOCSPEC_EXPECTED_FAILURES']&.to_i || 0
+      errors == 0
     end
   end
 end

data/lib/docspec/version.rb

@@ -1,3 +1,3 @@
 module Docspec
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 description: Make your READMEs testable
 email: db@dannyben.com
 executables: