doc_rspec 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e3a986df1d2228b1455a425584ffa80e6ca725961a5e86e2cf14eb7d600b0c
-  data.tar.gz: ccbe8af928c2762e281e776b451d7a14a981d8f28fef39ac2ceb72f447b297de
+  metadata.gz: 2fb556df1f9e8f00edb81eb6fc6db4c0d86d7864dbaedda0a9e559625df7fe98
+  data.tar.gz: 69296b360896f5a2258884bc59dc26b115648b107242f8f877eecca507b3b371
 SHA512:
-  metadata.gz: 9a1a4f71792902e0454f2e857471f0122f06c2cea648401cdee47e7c6e743fbcd52ea689771edd675d3d69a529c77b2a602b130bbb2246dce045a3e51a020df2
-  data.tar.gz: 0f51c159a2cdde070fc6339c4bf7c2fab713047d391b649f887337c24544ee039f5493df0e66d8172d228b49d630767e61d4a9bf470aed31da3518458970d346
+  metadata.gz: 641237f09a349ea510b93a562d3548e8398409af64c58f03be21499ce42eee8053f0b2fa4d596befdb6ac035747ba761f3e6e494de5c317966554756c74921cc
+  data.tar.gz: b7100cb9cf8d8b016c4466409fd4a608d569f022e62e20a30bacf90031e65f7047fad2d7d3e758504db4fb64d732a072c4cbb1a8fef853a40e8588a4a17b0230

data/lib/doc_rspec/compiler.rb

@@ -30,15 +30,13 @@ class DocRSpec
     def compile_example(example_spec)
       # See comment above for an explanation why we capture
       # this method as a function into a closure
-      compile_example_line = method(:compile_example_line)
       example_group.it example_spec.it_name(path) do
         example = self
-        code_lines = example_spec
+        code = example_spec
           .lines
-          .map { compile_example_line.(it, example) }
-          .compact
+          .join("\n")
 
-        eval(code_lines.join("\n")) unless code_lines.empty?
+        eval(code) unless code.empty?
       end
     end
 

data/lib/doc_rspec/context/example.rb

@@ -5,8 +5,8 @@ class DocRSpec
     class Example
       attr_reader :lines, :lnb, :name
 
-      def add(op, lhs, rhs)
-        lines << [op, lhs, rhs].compact
+      def add(code)
+        lines << code
       end
 
       def it_name(path)

data/lib/doc_rspec/context.rb

@@ -10,8 +10,8 @@ class DocRSpec
       examples << Example.new(lnb, name:)
     end
 
-    def add_example_line(op, lhs, rhs=nil)
-      examples.last.add(op, lhs, rhs)
+    def add_example_line(code)
+      examples.last.add(code)
     end
 
     def context_name(path)

data/lib/doc_rspec/parser.rb

@@ -10,9 +10,11 @@ class DocRSpec
 
     CONTEXT_DEFINITION = %r{\A \s* \# \s ={1,7} \s (.*)}x
 
-    EQUALS_OP = %r{\s+ => \s+}x
     EXAMPLE_LINE = %r{\A \s* \# \s{4,} (.*)}x
 
+    SHORT_EQUALS = %r{\s eq\! \s}x
+    SHORT_MATCHES = %r{\s \= \~ \s}x
+    SHORT_PREDICATE = %r{\s is\! \s}x
     START_EXAMPLE = %r{\A \s* \# \s{4,} \# \s example: \s (.*)}x
 
     attr_reader :ast, :lines, :state
@@ -48,12 +50,23 @@ class DocRSpec
 
     def parse_example_line(match)
       code = match[1]
+      return if code.empty?
 
-      case code.split(EQUALS_OP)
+      case code.split(SHORT_EQUALS)
       in [lhs, rhs]
-        ast.last.add_example_line(:eq, lhs, rhs)
+        ast.last.add_example_line("expect(#{lhs}).to eq(#{rhs})")
       else
-        ast.last.add_example_line(:verb, code) unless code.empty?
+        case code.split(SHORT_MATCHES)
+        in [lhs, rhs]
+          ast.last.add_example_line("expect(#{lhs}).to match(#{rhs})")
+        else
+          case code.split(SHORT_PREDICATE)
+          in [lhs, rhs]
+            ast.last.add_example_line("expect(#{lhs}).to be_#{rhs}")
+          else
+            ast.last.add_example_line(code)
+          end
+        end
       end
     end
 

data/lib/doc_rspec/version.rb

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

data/lib/doc_rspec.rb

@@ -7,6 +7,10 @@ require_relative 'doc_rspec/parser'
 RSpec.configure { it.extend DocRSpec::RSpecExampleGroup }
 
 ##
+# = Code
+#
+# can be found [at Codeberg](https://codeberg.org/lab419/doc_rspec)
+#
 # = Usage
 #
 # Install the gem <tt>gem install doc_rspec</tt> or put +doc_rspec+ in your Gemfile
@@ -18,7 +22,6 @@ RSpec.configure { it.extend DocRSpec::RSpecExampleGroup }
 #
 # Inside your +RSpec+ file, at the example group level then call
 #
-#   # Usage example
 #   docspec '<path_to_file>'
 #
 # Where +path_to_file+ is relative to the +lib+ directory
@@ -41,15 +44,7 @@ RSpec.configure { it.extend DocRSpec::RSpecExampleGroup }
 #
 #    # example: We have access to the wrapping context
 #
-#     this_is_available(22) => 44
-#
-# Although this gem is named +doc_rspec+ and its goal is certainly to document behavior
-# of Ruby code inside the +RDoc+ documentation of that code, and _most_ _importantly_
-# backing the claims made in this documentation up with *actual* +RSpec+ examples,
-# in this _MVP_ the parser will simply generate code for all lines matching 
-# <tt>/\A \s* \# \s{3,}/x</tt> after a triggering line macthing
-# <tt>/\A \s* \# \s{3,} \# \s example: \s (.+)/x</tt>
-# and potentially ended with the aforementioned <tt>/\A \s* \# \s{3,} \# \s end \s of \s example/x</tt>
+#    this_is_available(22) eq! 44
 #
 # This implies two thing
 #
@@ -63,6 +58,33 @@ RSpec.configure { it.extend DocRSpec::RSpecExampleGroup }
 #     # example: equality
 #     expect(41 + 1).to eq(42)
 #
+# == Shortcuts
+#
+# In addition to _standard_ +RSpec+ code, one can use 3 shorthand forms that are compiled as follows
+#
+# === +eq!+
+#
+#     # example: eq! shorthand for eq
+#
+#     answer = 42
+#
+#     answer eq! 42
+#
+# this was compiled to <tt>expect(answer).to eq(42)</tt>
+#
+# === +=~+ for match
+#
+#     # example: =~ shorthand for match
+#
+#     "alpha" =~ /\Aa.+a\z/
+#
+# === +is!+ for be_
+#
+#     # example: =~ shorthand for be 
+#
+#     require 'ostruct'
+#     OpenStruct.new(ok?: true) is! ok
+#
 class DocRSpec
 
   attr_reader :example_group, :lines, :path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Robert Dober
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.8
 specification_version: 4
 summary: '["Extract RSpec Examples from RDocs formatted with RDoc::Markup (the default)"]'
 test_files: []