doc_rspec 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3ea3a68b2a618eeac53b5988fcf7bef4c767b43899fa158ea5171af5e2b9866
-  data.tar.gz: a95753a22dd8b00590b733b9774823a722b883dff39b7e79f60a018386278905
+  metadata.gz: 8e2ea270de14b4a37fd648bde29d59a4f0a2244159d22a06e798c2387faa96f8
+  data.tar.gz: b3588a664c869b921e789c778be7508f8189628281d2c65796be3c3b31c1d060
 SHA512:
-  metadata.gz: 15dfea09b23cf93667f6b7b2845a60b98e8346ae64b539040e4d17c4562c000035dc391e70258e2d39847e4f591c08cd724dcedd3b053aee38d49d6b37f9cb1d
-  data.tar.gz: 51d041f6637b3aa8069511f08ff014fbf610e07c6678604c7e4b5324e6c63daf5d5161a5ffe54b00a1b9391c0123cb958df7cb61c320674f61cc3b0b3eb272e0
+  metadata.gz: 90a3129c0e172feaaae26d3d15cee20df6199d43d9d76676eab7b579038fbbd97c5f129fd4e72ac3ece19be2a4a01b260b60e255d765aa5f5b60478808ef2bfa
+  data.tar.gz: 31d6850d1534204007cf3953800c9d5a9f1cdf4e2f7e4450e93ca4dbfa44af7ea76fd8bf2e1fc03697f50a248c21eefe1f5d3d2693f76c30b9f564d18cbd59cc

data/lib/doc_rspec/compiler.rb

@@ -4,6 +4,7 @@ class DocRSpec
   class Compiler
     class IncorrectSpec < RuntimeError; end
 
+    include DocRSpec::Debugging
     attr_reader :example_group, :path, :spec_definitions
 
     def compile
@@ -30,13 +31,22 @@ class DocRSpec
     def compile_example(example_spec)
       # See comment above for an explanation why we capture
       # this method as a function into a closure
-      example_group.it example_spec.it_name(path) do
-        example = self
-        code = example_spec
-          .lines
-          .join("\n")
+      code = example_spec
+        .lines
+        .join("\n")
+      return if code.empty?
+
+      example_name = example_spec.it_name(path)
+      if debug_level > 1
+        puts "Example: #{example_name}"
+        puts example_spec.lines.map { ">  #{it}" }
+        puts "=" * 72
+      end
+      return if debug_level > 2
 
-        eval(code) unless code.empty?
+      example_group.it example_name do
+        example = self
+        eval(code)
       end
     end
 

data/lib/doc_rspec/debugging.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class DocRSpec
+  module Debugging
+
+    DEBUG_ENV_VAR_NAME = 'DEBUG_DOC_RSPEC'
+    def debug_level
+      @__debug_level__ ||=
+        case ENV[DEBUG_ENV_VAR_NAME]
+        in nil
+          0
+        in value
+          value.to_i.succ
+        end
+    end
+
+    def debugging? = debug_level.positive?
+
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/doc_rspec/parser.rb

@@ -1,23 +1,32 @@
 # frozen_string_literal: true
 
 require_relative 'context'
+require_relative '../enumerable'
 
 class DocRSpec
   class Parser
     class InternalError < RuntimeError; end
     class SyntaxError < RuntimeError; end
+    include DocRSpec::Debugging
 
-
+    COMMENT_LINE = %r{\A \s* \#}x
     CONTEXT_DEFINITION = %r{\A \s* \# \s ={1,7} \s (.*)}x
 
     EXAMPLE_LINE = %r{\A \s* \# \s{4,} (.*)}x
-
+    
     SHORT_EQUALS = %r{\s \=\=\> \s}x
     SHORT_MATCHES = %r{\s \~\> \s}x
     SHORT_PREDICATE = %r{\s is\! \s}x
     SHORT_ANTIPREDICATE = %r{\s not\! \s}x
     START_EXAMPLE = %r{\A \s* \# \s{4,} \# \s example: \s (.*)}x
 
+    SHORTCUTS = [
+      [ SHORT_EQUALS, "to", "eq(%%%)" ],
+      [ SHORT_MATCHES, "to", "match(%%%)" ],
+      [ SHORT_PREDICATE, "to", "be_%%%" ],
+      [ SHORT_ANTIPREDICATE, "not_to", "be_%%%" ],
+    ]
+
     attr_reader :ast, :lines, :state
 
     def parse
@@ -53,31 +62,23 @@ class DocRSpec
       code = match[1]
       return if code.empty?
 
-      case code.split(SHORT_EQUALS)
-      in [lhs, rhs]
-        ast.last.add_example_line("expect(#{lhs}).to eq(#{rhs})")
-      else
-        case code.split(SHORT_MATCHES)
-        in [lhs, rhs]
-          ast.last.add_example_line("expect(#{lhs}).to match(#{rhs})")
-        else
-          case code.split(SHORT_PREDICATE)
+      return if COMMENT_LINE === code
+
+      compiled =
+        SHORTCUTS.find_value(default: code) do |shtct_def|
+          shtct_def => [rgx, to_or_not, rhs_template]
+          case code.split(rgx)
           in [lhs, rhs]
-            ast.last.add_example_line("expect(#{lhs}).to be_#{rhs}")
+            "expect(#{lhs}).#{to_or_not} #{rhs_template.sub("%%%", rhs)}"
           else
-            case code.split(SHORT_ANTIPREDICATE)
-            in [lhs, rhs]
-            ast.last.add_example_line("expect(#{lhs}).not_to be_#{rhs}")
-            else
-              ast.last.add_example_line(code)
-            end
+            nil
           end
         end
-      end
+      ast.last.add_example_line(compiled)
     end
 
     def parse_line(line, lnb)
-      p(state:, lnb:, line:) if ENV["DEBUG"]
+      p(state:, lnb:, line:) if debugging?
       case state
       when :outside
         parse_line_outside(line, lnb)
@@ -96,6 +97,10 @@ class DocRSpec
         add_example(lnb, Regexp.last_match)
       when EXAMPLE_LINE
         parse_example_line(Regexp.last_match)
+      when COMMENT_LINE
+        nil
+      else
+        @state = :outside
       end
     end
 

data/lib/doc_rspec/version.rb

@@ -2,7 +2,7 @@
 
 class DocRSpec
   module Version
-    VERSION = '0.2.3'
+    VERSION = '0.2.5'
   end
 end
 # SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/doc_rspec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rspec'
+require_relative 'doc_rspec/debugging'
 require_relative 'doc_rspec/compiler'
 require_relative 'doc_rspec/rspec_example_group'
 require_relative 'doc_rspec/parser'
@@ -92,6 +93,22 @@ RSpec.configure { it.extend DocRSpec::RSpecExampleGroup }
 #     require 'ostruct'
 #     OpenStruct.new(ok?: false) not! ok
 #
+#
+# === Comments inside examples
+#
+#     # example: comments are removed
+#     
+#     # so this works
+#     expect(1).to eq(1)
+#     # and this ==> too
+#
+# === End of Example
+#
+# the code does not continue after the rdoc comment
+
+#     # not a problem
+#     raise "This should never happen"
+#
 class DocRSpec
 
   attr_reader :example_group, :lines, :path

data/lib/enumerable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Enumerable
+  def find_value(default: nil, &blk)
+    each do |ele|
+      result = blk.(ele)
+      return result if result
+    end
+    default 
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Robert Dober
@@ -49,9 +49,11 @@ files:
 - lib/doc_rspec/compiler.rb
 - lib/doc_rspec/context.rb
 - lib/doc_rspec/context/example.rb
+- lib/doc_rspec/debugging.rb
 - lib/doc_rspec/parser.rb
 - lib/doc_rspec/rspec_example_group.rb
 - lib/doc_rspec/version.rb
+- lib/enumerable.rb
 homepage: https://codeberg.org/lab419/doc_rspec
 licenses:
 - AGPL-3.0-or-later