lab42_literate 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9af148dabdc4777ca8d0e99ddb16853ceafd4ca5
-  data.tar.gz: e431c6f0d2aa762843140ae80f73fd09ceb3d39b
+  metadata.gz: 719c356f00f0141fa7a9c0bfec1b25792f067927
+  data.tar.gz: ab1de21e75855dcf24996a447d08479734a54901
 SHA512:
-  metadata.gz: 25db3aefd339b3016e646894321c29503633a77db4924581fbcc4d8f2946df5d4d23640a040b372e086b7deeeb1d2c34a9f8885d06027d11b336ded6d0d7ab6e
-  data.tar.gz: 2d390a643c3a1ce311f456ed0e0d41449db276ee2973368d5dcfae2555ce8fa8a08b5cbf5d6eaa8aa97859dccbd46bd7be09e89d6d6f843dc3e6dde414338069
+  metadata.gz: eb38c90f79ff71b04b4d6252fe0f5ce7ba6d4bc9564ce279ee8ea2f198f107568d7e609eccf3952af8680a389c13b0654086cc0edd784d631af86c4db4fbd8f4
+  data.tar.gz: fadeeeee4eb23c14de66a2d1788a7d01aa2ffb620c7a6f65b3c5b82c01c9d5def3e517bb607bdfe3ea7be8e6ce5f643d0dfd12943f6e9c8fae498b58348813d3

data/README.md

@@ -25,9 +25,9 @@ Then in your `spec_helper`
 
 which makes the `doctest` method available in all example groupes of type `literate`.
 
-### Example
+### Very Quick Start
 
-You can write RSpec example code inside a ` ```ruby literate ` block. 
+You can write RSpec example code inside a ` ```ruby literate ` block.
 
         ```ruby literate
           expect(%w{a b c}).not_to be_empty
@@ -45,3 +45,18 @@ with
         RSpec.describe 'example', type: :literate do
           doctest 'some_literate.md'
         end
+
+
+### How does it work?
+
+Each block ` ```ruby literate`  creates an example with title `"literate block in #{file}:#{start_lnb}..#{end_lnb}"`
+and instance_evals the lines from the block in the example's context.
+
+
+### Setup?
+
+Not yet.
+
+### Explicit Title of the generated example
+
+Just add text  after ` ```ruby literate`

data/lib/lab42/literate/example_doctest.rb

@@ -4,8 +4,8 @@ module Lab42::Literate::ExampleDoctest
 
   def doctest filename
     doc_blocks = Ex.extract(File.readlines(filename))
-    doc_blocks.each do  |_, lines|
-      instance_eval(lines.join("\n"))
+    doc_blocks.each do  |block|
+      instance_eval(block.lines.join("\n"))
     end
   end
   

data/lib/lab42/literate/extractor/block.rb

@@ -0,0 +1,24 @@
+class Lab42::Literate::Extractor::Block
+  attr_reader :lines, :start_lnb, :title
+
+  def add_line line
+    lines << line
+  end
+
+  def get_title alternative
+    title.empty? ?  alternative : title
+  end
+  
+  def range
+    start_lnb..(start_lnb.pred + lines.size)
+  end
+
+  private
+
+  def initialize start_lnb, title: ''
+    @lines     = []
+    @start_lnb = start_lnb
+    @title     = title
+  end
+  
+end

data/lib/lab42/literate/extractor.rb

@@ -1,16 +1,20 @@
+require 'ostruct'
+
 module Lab42::Literate::Extractor extend self
+  require_relative 'extractor/block'
+
 
-  START_EXTRACTION = %r[\A \s* ``` ruby \s+ literate ]x
+  START_EXTRACTION = %r[\A \s* ``` ruby \s+ literate \s* (?<explicit_title> .*) ]x
   STOP_EXTRACTION  = %r[\A \s* ``` \s* \z]x
 
   ALTERNATE_EQ_FORM = %r[\A (\s*) (.*) \s+ \#=> \s+ (.*) \z]x
 
   def extract from_lines
-    hash = Hash.new{|h, k| h[k] =[]}
+    initial = OpenStruct.new(state: :outside, blocks: []) 
     from_lines
       .each_with_index
-      .inject([:outside, 0,  hash]){|state, (line, lnb)| update(line, lnb, *state) }
-      .last
+      .inject(initial){|acc, (line, lnb)| update(line, lnb, acc) }
+      .blocks
   end
 
 
@@ -23,28 +27,33 @@ module Lab42::Literate::Extractor extend self
       %W{#{$1}expect(#{$2}).to eq(#{$3.strip})}.join(' ') }
   end
 
-  def update line, lnb, state, last_lnb, blocks
-    if state == :outside
-      update_outside line, lnb, blocks
+  def update line, lnb, acc
+    if acc.state == :outside
+      update_outside line, lnb, acc
     else
-      update_inside line, last_lnb, blocks
+      update_inside line, acc
     end
   end
 
-  def update_inside line, last_lnb,  blocks
+  def update_inside line, acc
     if STOP_EXTRACTION === line.chomp
-      [:outside, nil, blocks]
+      merge_acc( acc, state: :outside )
     else
-      [:inside, last_lnb, blocks.merge(last_lnb => blocks[last_lnb] << convert(line))]
+      acc.blocks.last.add_line(convert(line))
+      acc
     end
   end
 
-  def update_outside line, lnb, blocks
-    if START_EXTRACTION === line.chomp
-      [:inside, lnb, blocks]
+  def update_outside line, lnb, acc
+    match = START_EXTRACTION.match line.chomp
+    if match 
+      merge_acc( acc, state: :inside, blocks: acc.blocks << Block.new(lnb, title: match['explicit_title']) )
     else
-      [:outside, nil, blocks]
+      acc
     end
   end
-  
+
+  def merge_acc acc, **params
+    OpenStruct.new(**(acc.to_h.merge params))
+  end
 end

data/lib/lab42/literate/group_doctest.rb

@@ -4,11 +4,17 @@ module Lab42::Literate::GroupDoctest
 
   def doctest filename
     doc_blocks = Ex.extract(File.readlines(filename))
-    doc_blocks.each do  |lnb, lines|
-      context "literate block in #{filename}:#{lnb}..#{lnb+lines.size-1}" do
-        it do
-          eval(lines.join("\n"))
-        end
+    doc_blocks.each{ |block| make_context filename, block }
+  end
+
+  private
+
+  def make_context filename, block
+    return if block.lines.empty?
+    title = block.get_title "literate block in #{filename}:#{block.range.inspect}"
+    context title do
+      it do
+        eval(block.lines.join("\n"))
       end
     end
   end

data/lib/lab42/literate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab42_literate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Robert Dober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -134,6 +134,7 @@ files:
 - lib/lab42/literate.rb
 - lib/lab42/literate/example_doctest.rb
 - lib/lab42/literate/extractor.rb
+- lib/lab42/literate/extractor/block.rb
 - lib/lab42/literate/group_doctest.rb
 - lib/lab42/literate/version.rb
 homepage: https://github.com/RobertDober/lab42_literate