lab42_literate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbef1724d92d9a3df339142900482ca1dc58e69a
-  data.tar.gz: 4662d0f09f4940508bd2032052798e3e039fbbf5
+  metadata.gz: 9af148dabdc4777ca8d0e99ddb16853ceafd4ca5
+  data.tar.gz: e431c6f0d2aa762843140ae80f73fd09ceb3d39b
 SHA512:
-  metadata.gz: 20abba63d97c849c167ee5037accc083ee8204314c01038e8987cb504957f41c18d7b339f072c43687c2a6dc255fb6c4628b47a74495289a317494e675402582
-  data.tar.gz: f8b75604fbbc2ba09ced1db0d4bcb28ab495e767081ef75ed4d05851b1ef9fb010adf02544ea53649abd35a041043606f718a4b3fd601728ab164e439c576f66
+  metadata.gz: 25db3aefd339b3016e646894321c29503633a77db4924581fbcc4d8f2946df5d4d23640a040b372e086b7deeeb1d2c34a9f8885d06027d11b336ded6d0d7ab6e
+  data.tar.gz: 2d390a643c3a1ce311f456ed0e0d41449db276ee2973368d5dcfae2555ce8fa8a08b5cbf5d6eaa8aa97859dccbd46bd7be09e89d6d6f843dc3e6dde414338069

data/README.md

@@ -11,3 +11,37 @@
 
 Just extract code blocks from any file, and run them as specs with a simple `doctest file` in an RSpec example group.
 
+### Installation
+
+      gem install lab42_literate
+
+or in Gemfile
+
+      gem 'lab42_literate'
+
+Then in your `spec_helper`
+
+      require 'lab42/literate'
+
+which makes the `doctest` method available in all example groupes of type `literate`.
+
+### Example
+
+You can write RSpec example code inside a ` ```ruby literate ` block. 
+
+        ```ruby literate
+          expect(%w{a b c}).not_to be_empty
+        ```
+
+There is an easy way to express `expect(...).to eq(...)` with the following special form...
+
+        ```ruby literate
+          1 + 41 #=> 42
+        ```
+
+Then, assuming the above text being inside a file `some_literate.md` one can execute the two examples above
+with
+
+        RSpec.describe 'example', type: :literate do
+          doctest 'some_literate.md'
+        end

data/lib/lab42/literate/extractor.rb

@@ -19,7 +19,6 @@ module Lab42::Literate::Extractor extend self
   # Potentially convert alternate equality syntax to class equality synatx, meaning that
   # \A(.*)\s+#=>\s+(.*)\z => expect(strip($1)).to eq(strip($2))
   def convert line
-    p line
     line.chomp.sub(ALTERNATE_EQ_FORM){ |*| 
       %W{#{$1}expect(#{$2}).to eq(#{$3.strip})}.join(' ') }
   end

data/lib/lab42/literate/version.rb

@@ -1,5 +1,5 @@
 module Lab42
   module Literate
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lab42_literate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert Dober