docspec 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f60e3ac26d8a9cfe1c5a03b434867f53d1846df19e6342cf54a53cb89438ea4b
-  data.tar.gz: c29737aeebe44221c0b54535456aecc1c305367991df2637ea8945c2591bbc3f
+  metadata.gz: 330b6b64b2112f4c04771bb41f1d2baaba6040a8154f8d8d21538792c9e5531a
+  data.tar.gz: 59df2785073b757fe4d444ab143632fa853d64f685fd9f59f967db6e338ef6d0
 SHA512:
-  metadata.gz: 796e4de3f27f18c2696fe150d5311180934da885f72b660adae44757b26c567bad960b34f42627373808b485bfe2e2aeb27c77b625fe02ea7e3f44c24d2dc2cd
-  data.tar.gz: bea1ec3a7759146fa9eb1a9986e3af28e05c87442896bd4fc6ccf0b12cfa158690d504105f8f5754a98165f630aa3f163862c6a131f9caa11c1ad38341f5a435
+  metadata.gz: 760aa463ba9ca213098e0dcd54b087e8f394d367ba25e19c5971fdc60db69849b2a45c50a2df4d2ff97464e34ed302ef18cb485cea52873fa7c0a7b4661d8fda
+  data.tar.gz: 8e7010b439685d276d166e1906eaacc652b2e4bcb30bb612f0d00618b5de9c9da3bb927687f72e5c1b4992be4963c9e3b935613049e408f36940808909b44b39

data/README.md

@@ -17,6 +17,12 @@ Installation
     $ gem install docspec
 
 
+Demo
+--------------------------------------------------
+
+![Demo](demo/cast.svg)
+
+
 Usage
 --------------------------------------------------
 
@@ -36,20 +42,20 @@ look at its source.
 
 ### Testing with the `docspec` command line
 
-Test the examples in `./README.md`:
-
-    $ docspec
+- Running `docspec` without arguments will run on `./README.md`
+- Running `docspec` with a filename, will run on that filename
+- Running `docspec` with a directory, will run on all the markdown files in
+  that directory.
 
-Test a different file:
-
-    $ docspec TESTS.md
+If your bundle includes the `simplecov` gem, it will be automatically loaded
+and generate coverage report in the `coverage` directory.
 
 
 ### Testing from Ruby code
 
 ```ruby
 # Running from Ruby code
-document = Docspec::Document.from_file 'sample.md'
+document = Docspec::Document.from_file 'test/sample.md'
 document.test
 #=> pass : Sample Test
 
@@ -58,6 +64,33 @@ puts document.success?
 ```
 
 
+
+
+```ruby
+# Test a file using the CLI class
+runner = Docspec::CLI.new 'test/sample.md'
+success = runner.run
+#=> pass : Sample Test
+#=> 
+#=> 1 tests, 0 failed
+```
+
+
+```ruby
+# Test a folder using the CLI class
+runner = Docspec::CLI.new 'test'
+success = runner.run
+#=> file : test/folder/another.md
+#=> pass : Another Sample Test
+#=> 
+#=> file : test/sample.md
+#=> pass : Sample Test
+#=> 
+#=> 2 tests, 0 failed
+```
+
+
+
 Examples
 --------------------------------------------------
 

data/bin/docspec

@@ -1,27 +1,15 @@
 #!/usr/bin/env ruby
-require 'simplecov'
-SimpleCov.configure do
-  command_name 'Docspec'
+if Gem.loaded_specs.has_key?('simplecov') and !ENV['DISABLE_SIMPLECOV']
+  require 'simplecov'
+  SimpleCov.configure do
+    command_name ENV['SIMPLECOV_COMMAND'] || 'Docspec'
+  end
+  SimpleCov.start
 end
-SimpleCov.start
 
 require 'docspec'
-require 'colsole'
-include Colsole
-
-document = ARGV[0] || 'README.md'
-abort "File not found #{document}" unless File.exist? document
-document = Docspec::Document.from_file document
-document.test
-
-say ''
-
-if document.success?
-  say "!txtgrn!#{document.examples.count} tests, #{document.failed_examples.count} failed\n"
-  exit 0
-else
-  say "!txtred!#{document.examples.count} tests, #{document.failed_examples.count} failed\n"
-  exit 1
-end
-
+require 'docspec/cli'
 
+runner = Docspec::CLI.new ARGV[0]
+success = runner.run
+exit success ? 0 : 1

data/lib/docspec/cli.rb

@@ -0,0 +1,71 @@
+require 'colsole'
+include Colsole
+
+module Docspec
+  class CLI
+    attr_reader :target, :exit_code, :total_examples, :failed_examples
+
+    def initialize(target=nil)
+      @target = target || 'README.md'
+    end
+
+    def mode
+      File.directory?(target) ? :dir : :file
+    end
+
+    def run
+      abort "Target not found: #{target}" unless File.exist? target
+
+      @exit_code = 0
+      @total_examples = 0
+      @failed_examples = 0
+
+      if mode == :dir
+        run_dir
+      else
+        run_file target
+      end
+
+      show_footer
+    end
+
+  private
+
+    def run_dir
+      all_success = true
+      Dir["#{target}/**/*.md"].each do |file|
+        say ''
+        say "!txtcyn!file : #{file}"
+        success = run_file file
+        all_success = false unless success
+      end
+      all_success
+    end
+
+    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"
+        true
+      else
+        say "!txtred!#{total_examples} tests, #{failed_examples} failed\n"
+        false
+      end
+    end
+
+  end
+end
+
+
+

data/lib/docspec/example.rb

@@ -26,7 +26,7 @@ module Docspec
     end
 
     def expected
-      @expected ||= code.scan(/#=>\s*(.*)/).map { |match| match.first.strip }.join "\n"
+      @expected ||= code.scan(/#=> *(.*)/).map { |match| match.first.strip }.join "\n"
     end
 
     def failed?

data/lib/docspec/output_capturer.rb

@@ -1,3 +1,5 @@
+require 'stringio'
+
 module Docspec
   module OutputCapturer
     def capture_output

data/lib/docspec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2019-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -38,20 +38,6 @@ 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:
@@ -62,6 +48,7 @@ files:
 - README.md
 - bin/docspec
 - lib/docspec.rb
+- lib/docspec/cli.rb
 - lib/docspec/document.rb
 - lib/docspec/example.rb
 - lib/docspec/output_capturer.rb
@@ -86,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Embedded tests in Markdown documents