docspec 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad249396cfc15361e8f19e3932b5c75ab565b5042ce3431204daf0a39d4f0a14
-  data.tar.gz: a0772e8fd3692466756215f0786709fae4c0772248d1715a0503810a7e0af719
+  metadata.gz: 3084cbb5bf7c1a0d99ec73d0e3a505b0690d44f28a5ec8e8cdcd8b74ab325bdf
+  data.tar.gz: 4f3dc9b69fb2ed4a0a32d52f4aeb2e25f3245c0734fa78362fd0f97279369884
 SHA512:
-  metadata.gz: 4985a1fcb629b102bd560fc4a33bb24d18b0ef91368619cfbcc1f053ac2ac3fffa15426e81f1826de87bebeb5233ad4d416551f8eaad9c52f2513cd273d0b04f
-  data.tar.gz: cae6a31e132105853a6015d53d39a3d0ad13bbd99b94fd03e10bedada81e635d7409a2495940d98d9447ff51e9f8249de719e5bd8dfa1aec8a1c4af8dd2a52cc
+  metadata.gz: ce61cf2c337223fcbaff45694209c9259922f3148f06dac163e647a8ac559fb597dc48096cc9c6c6f789491aca35087cf676b37af1d7f317e87720d2c761296a
+  data.tar.gz: 1044d67ab45478ca2e3bbe632bbc220e475a99b1269278f9364c2e4acd4183b59cd7a53e87fdfc86bdd1b6df94eae522b72e6fa96d54e8d052096d472dbc602a

data/README.md

@@ -26,8 +26,8 @@ test.
 Code snippets should be enclosed in a `ruby` or `shell` code fence:
 
     ```ruby
-    code_to_test = 'here'
-    #=> expected output
+    puts "code to test (should output something)"
+    #=> code to test (should output something)
     ```
 
 This document itself serves as the test suite for this gem, so you can take a
@@ -75,8 +75,8 @@ string of that exception:
 
 ```ruby
 # Exceptions are captured
-raise ArgumentError, "Testing error raising"
-#=> #<ArgumentError: Testing error raising>
+puts "hello".camel_case
+#=> #<NoMethodError: undefined method `camel_case' for "hello":String>
 ```
 
 Your code and expected output can contain multiple lines of code:
@@ -103,6 +103,13 @@ puts 2 - 3
 #=> -1
 ```
 
+or have the expected output in the same line as its code:
+
+```ruby
+puts 2 * 3    #=> 6
+puts 'works'  #=> works
+```
+
 The first line of the example may contain specially formatted flags. Flags 
 are always formatted like this: `[:flag_name]`. 
 
@@ -128,27 +135,29 @@ this will not be executed
 
 Sometimes it is useful to build the example over several different code 
 blocks. To help achieve this, docspec will treat any example that does not 
-output anything as a code that needs to be executed before all subsequent 
-examples:
+expect any output (no `#=> markers`) as a code that needs to be executed
+before all subsequent examples:
 
 ```ruby
-# Define a function for later use
+# Define functions or variables for later use
 def create_caption(text)
   [text.upcase, ("=" * text.length)].join "\n"
 end
+
+message = 'tada!'
 ```
 
 All the examples below this line, will have the above function available:
 
 ```ruby
-# Use a previously defined function
-puts create_caption "tada!"
+# Use a previously defined function or variable
+puts create_caption message
 #=> TADA!
 #=> =====
 ```
 
 
-Finally, examples marked with a `shell` code fence will be executed by the
+Examples marked with a `shell` code fence will be executed by the
 shell, and not by ruby:
 
 ```shell
@@ -157,4 +166,16 @@ echo hello world
 #=> hello world
 ```
 
+and they also support chaining of examples:
+
+```shell
+# Prepend shell example to all subsequent shell examples
+# (since this example does not define an expected output)
+SOME_ENV_VAR=yes
+```
+
+```shell
+echo $SOME_ENV_VAR
+#=> yes
+```
 

data/bin/docspec

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 require 'simplecov'
+SimpleCov.configure do
+  command_name 'Docspec'
+end
 SimpleCov.start
 
 require 'docspec'
@@ -14,10 +17,10 @@ document.test
 say ''
 
 if document.success?
-  say "!txtgrn!#{document.total_examples} tests, #{document.failed_examples} failed\n"
+  say "!txtgrn!#{document.examples.count} tests, #{document.failed_examples.count} failed\n"
   exit 0
 else
-  say "!txtred!#{document.total_examples} tests, #{document.failed_examples} failed\n"
+  say "!txtred!#{document.examples.count} tests, #{document.failed_examples.count} failed\n"
   exit 1
 end
 

data/lib/docspec/document.rb

@@ -15,13 +15,23 @@ module Docspec
       @examples ||= examples!
     end
 
+    def before
+      @before ||= {}
+    end
+
   protected
 
     def examples!
       result = []
       markdown.scan(/```(ruby|shell)\s*\n(.*?)```/m) do |type, code|
-        example = Example.new(code, type)
-        result << example unless example.skip?
+        example = Example.new(type: type, code: code, before: before[type])
+        
+        next if example.skip?
+
+        before[type] ||= []
+        before[type] << example.code if example.empty?
+        
+        result << example
       end
       result
     end

data/lib/docspec/example.rb

@@ -3,29 +3,36 @@ require 'diffy'
 module Docspec
   class Example
     include OutputCapturer
-    attr_reader :code, :type, :full_code
+    attr_reader :code, :type, :before
 
-    def initialize(code, type)
-      @code, @type = code, type
-      @full_code = @code
+    def initialize(type:, code:, before: nil)
+      @code, @type, @before = code, type, before
     end
 
     def actual
       @actual ||= actual!
     end
 
+    def consider_failed?
+      failed? and !ignore_failure?
+    end
+
     def diff
       @diff ||= Diffy::Diff.new("#{expected}\n", "#{actual}\n", context: 2).to_s :color
     end
 
     def empty?
-      actual.empty?
+      expected.empty?
     end
 
     def expected
       @expected ||= code.scan(/#=>\s*(.*)/).map { |match| match.first.strip }.join "\n"
     end
 
+    def failed?
+      !success?
+    end
+
     def first_line
       @first_line ||= code.split("\n").first
     end
@@ -34,6 +41,10 @@ module Docspec
       @flags ||= first_line.scan(/\[:(.+?)\]/).map { |f| f.first.to_sym }
     end
 
+    def full_code
+      @full_code ||= full_code!
+    end
+
     def ignore_failure?
       flags.include? :ignore_failure
     end
@@ -42,12 +53,6 @@ module Docspec
       @label ||= label!
     end
 
-    def prepend(codes)
-      codes = [codes] unless codes.is_a? Array
-      codes = codes.join "\n\n"
-      @full_code = "#{codes}\n#{@full_code}"
-    end
-
     def skip?
       flags.include? :skip
     end
@@ -64,11 +69,16 @@ module Docspec
         when 'ruby'
           eval full_code
         when 'shell'
-          puts `#{code}`
+          puts `#{full_code}`
         end
       end.strip
     end
 
+    def full_code!
+      return code unless before
+      [before.join("\n\n"), code].join "\n"
+    end
+
     def label!
       first_line.gsub(/^#\s*/, '').strip
     end

data/lib/docspec/testable.rb

@@ -3,34 +3,17 @@ require 'colsole'
 module Docspec
   module Testable
     include Colsole
-    attr_reader :failed_examples, :total_examples
-
-    def before_codes
-      @before_codes ||= []
-    end
 
     def success?
-      failed_examples == 0
+      failed_examples.count == 0
     end
 
-    def each_example
-      reset_counters
-
-      examples.each do |example|
-        if example.empty?
-          before_codes << example.code
-        else
-          @total_examples += 1
-          example.prepend before_codes
-          @failed_examples += 1 unless example.success? or example.ignore_failure?
-        end
-        
-        yield example
-      end
+    def failed_examples
+      @failed_examples ||= examples.select(&:consider_failed?)
     end
 
     def test
-      each_example do |example|
+      examples.each do |example|
         if example.empty?
           say "!txtpur!void :!txtrst! #{example.label}"          
         elsif example.success?
@@ -44,14 +27,6 @@ module Docspec
       end
     end
 
-  protected
-
-    def reset_counters
-      @before_codes = nil
-      @failed_examples = 0
-      @total_examples = 0
-    end
-
   end
 end
 

data/lib/docspec/version.rb

@@ -1,3 +1,3 @@
 module Docspec
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docspec
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-13 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole