docspec 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330b6b64b2112f4c04771bb41f1d2baaba6040a8154f8d8d21538792c9e5531a
-  data.tar.gz: 59df2785073b757fe4d444ab143632fa853d64f685fd9f59f967db6e338ef6d0
+  metadata.gz: b8a5c9b5152aec40381604f7b29473d9df865cba3cd650cd1b70dda2115e9165
+  data.tar.gz: 618428c8f9733ee701f6e2fb4babd5c1da39e85c0db601ae8b0f07e9f942e864
 SHA512:
-  metadata.gz: 760aa463ba9ca213098e0dcd54b087e8f394d367ba25e19c5971fdc60db69849b2a45c50a2df4d2ff97464e34ed302ef18cb485cea52873fa7c0a7b4661d8fda
-  data.tar.gz: 8e7010b439685d276d166e1906eaacc652b2e4bcb30bb612f0d00618b5de9c9da3bb927687f72e5c1b4992be4963c9e3b935613049e408f36940808909b44b39
+  metadata.gz: 2a2eacb5a463a059419863bf58676146b73e9398c5ec94563e444525865764bf2ba1814bc4cdb9980983a1314d7c8951c3be0b23f7cb3a6a4b7e312d46761164
+  data.tar.gz: 5de5e31541b08ba45594da601462db482b6c677eae357026b75678fb0d50dbaad861f4e86e339f2dbcdd5760fc13ae22f47d4577e39e604be83e971ef598e75a

data/README.md

@@ -1,8 +1,7 @@
-Docspec
-==================================================
+# 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)
+[![Build Status](https://github.com/DannyBen/docspec/workflows/Test/badge.svg)](https://github.com/DannyBen/docspec/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/e0c15c1f33fa4aa45f70/maintainability)](https://codeclimate.com/github/DannyBen/docspec/maintainability)
 
 Docspec lets you reuse your Markdown documents as the unit tests for your
@@ -11,30 +10,29 @@ Ruby library.
 ---
 
 
-Installation
---------------------------------------------------
+## Installation
 
-    $ gem install docspec
+```
+$ gem install docspec
+```
 
 
-Demo
---------------------------------------------------
+## Demo
 
-![Demo](demo/cast.svg)
+![Demo](demo/cast.gif)
 
 
-Usage
---------------------------------------------------
+## Usage
 
 Docspec expects one or more Markdown files with embedded code snippets to 
 test.
 
 Code snippets should be enclosed in a `ruby` or `shell` code fence:
 
-    ```ruby
-    puts "code to test (should output something)"
-    #=> code to test (should output something)
-    ```
+```ruby
+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
 look at its source.
@@ -86,13 +84,19 @@ success = runner.run
 #=> file : test/sample.md
 #=> pass : Sample Test
 #=> 
-#=> 2 tests, 0 failed
+#=> file : test/sample2.md
+#=> pass : echo shell
+#=> void : echo shell
+#=> pass : puts "ruby"
+#=> void : puts "ruby"
+#=>
+#=> 6 tests, 0 failed
+
 ```
 
 
 
-Examples
---------------------------------------------------
+## Examples
 
 Code examples that you want to test, should output something to stdout. 
 Specify the expected output by prefixing it with `#=>`:
@@ -211,4 +215,3 @@ SOME_ENV_VAR=yes
 echo $SOME_ENV_VAR
 #=> yes
 ```
-

data/bin/docspec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-if Gem.loaded_specs.has_key?('simplecov') and !ENV['DISABLE_SIMPLECOV']
+if Gem.loaded_specs.has_key?('simplecov') && !ENV['DISABLE_SIMPLECOV']
   require 'simplecov'
   SimpleCov.configure do
     command_name ENV['SIMPLECOV_COMMAND'] || 'Docspec'

data/lib/docspec/cli.rb

@@ -5,7 +5,7 @@ module Docspec
   class CLI
     attr_reader :target, :exit_code, :total_examples, :failed_examples
 
-    def initialize(target=nil)
+    def initialize(target = nil)
       @target = target || 'README.md'
     end
 
@@ -33,9 +33,9 @@ module Docspec
 
     def run_dir
       all_success = true
-      Dir["#{target}/**/*.md"].each do |file|
+      Dir["#{target}/**/*.md"].sort.each do |file|
         say ''
-        say "!txtcyn!file : #{file}"
+        say "c`file : #{file}`"
         success = run_file file
         all_success = false unless success
       end
@@ -45,27 +45,23 @@ module Docspec
     def run_file(file)
       document = Docspec::Document.from_file file
       document.test
-      
+
       @failed_examples += document.failed_examples.count
       @total_examples += document.examples.count
-      
+
       document.success?
     end
 
     def show_footer
       say ''
 
-      if failed_examples == 0
-        say "!txtgrn!#{total_examples} tests, #{failed_examples} failed\n"
+      if failed_examples.zero?
+        say "g`#{total_examples} tests, #{failed_examples} failed`\n"
         true
       else
-        say "!txtred!#{total_examples} tests, #{failed_examples} failed\n"
+        say "r`#{total_examples} tests, #{failed_examples} failed`\n"
         false
       end
     end
-
   end
 end
-
-
-

data/lib/docspec/document.rb

@@ -25,16 +25,15 @@ module Docspec
       result = []
       markdown.scan(/```(ruby|shell)\s*\n(.*?)```/m) do |type, code|
         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
-
   end
 end

data/lib/docspec/example.rb

@@ -6,7 +6,9 @@ module Docspec
     attr_reader :code, :type, :before
 
     def initialize(type:, code:, before: nil)
-      @code, @type, @before = code, type, before
+      @code = code
+      @type = type
+      @before = before
     end
 
     def actual
@@ -30,7 +32,7 @@ module Docspec
     end
 
     def failed?
-      !success?
+      !success? && !empty?
     end
 
     def first_line
@@ -76,12 +78,12 @@ module Docspec
 
     def full_code!
       return code unless before
+
       [before.join("\n\n"), code].join "\n"
     end
 
     def label!
       first_line.gsub(/^#\s*/, '').strip
     end
-
   end
 end

data/lib/docspec/testable.rb

@@ -5,7 +5,7 @@ module Docspec
     include Colsole
 
     def success?
-      failed_examples.count == 0
+      failed_examples.count.zero?
     end
 
     def failed_examples
@@ -15,18 +15,16 @@ module Docspec
     def test
       examples.each do |example|
         if example.empty?
-          say "!txtpur!void :!txtrst! #{example.label}"          
+          say "m`void :` #{example.label}"
         elsif example.success?
-          say "!txtgrn!pass :!txtrst! #{example.label}"
+          say "g`pass :` #{example.label}"
         else
-          say "!txtred!FAIL : #{example.label}"
-          say "---"
+          say "r`FAIL : #{example.label}`"
+          say '---'
           puts example.diff
-          say "---"
+          say '---'
         end
       end
     end
-
   end
 end
-

data/lib/docspec/version.rb

@@ -1,3 +1,3 @@
 module Docspec
-  VERSION = "0.1.1"
-end
+  VERSION = '0.1.3'
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: docspec
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2023-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -57,7 +63,8 @@ files:
 homepage: https://github.com/dannyben/docspec
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -66,14 +73,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.8
 signing_key: 
 specification_version: 4
 summary: Embedded tests in Markdown documents