doc_rspec 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90000c65d8bc3bbc74f74e8db74349c2da89966469523b644c8c4626bf3ec691
-  data.tar.gz: 309bec43ab7c272231f30bf244d2ee35177487eb6b37f2a27ab2ae3e04495988
+  metadata.gz: 1ea386bcbd5e9be13a6eb83e7476d536fc4b15a565312c422dda406a1fe93d96
+  data.tar.gz: b05c0db28f9d81c95dddb6f782c18ba8cce4bd6e6bdf6a208b2987b7378a856f
 SHA512:
-  metadata.gz: 6efcda2932d37904415e7b705c085d9cf270d38948d5ea583d8f4e433f360dec23a70a673345692de4e75a361edb43f4af9c5968a1830f0f59864469dbe5225a
-  data.tar.gz: e286b14434287552c08d18fa7125557bf4aad1c9af90cdc3a6b62858266c086bc501504586ac3b62a688387b27772d383641334d95d4121301e84ae4b96ef204
+  metadata.gz: 6faa80959f62b2a1a3a9e4147bc5506ec274fc64189b622d6efd3df0d5c817807636db842d7a116f2738ebeed4ac494ac98a4f52fcd6b179dffa4f9be337b322
+  data.tar.gz: 37c7b059562e6cc58ba4ad5aa759a752c5cf94472e55260d80178a77b789082dfa23da37d4ecb5fb7e172a492b2b198e3106217e0b817f221588d8345e48d70c

data/lib/{doc_spec → doc_rspec}/example_group.rb

@@ -5,7 +5,6 @@ class DocRSpec
     def docspec(path)
       DocRSpec.new(path, self).generate_specs
     end
-    
   end
 end
 # SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/{doc_spec → doc_rspec}/parser.rb

@@ -16,7 +16,7 @@ class DocRSpec
     START_EXAMPLE = %r{\A \s* \#+ \s+ ```spec \s* (\# \s+)?(.*)?}x
     START_RDOC_COMMENT = %r{\A \s* \#\#}x
     STOP_EXAMPLE = %r{\A \s* \#+ \s+ ```}x
-    STOP_RDOC_COMMENT = %r{\A \s* [^#]}x
+    STOP_RDOC_COMMENT = %r{\A \s* [^#]* \z}x
 
     attr_reader :ast, :lines, :state
 

data/lib/{doc_spec → doc_rspec}/version.rb

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

data/lib/{doc_spec.rb → doc_rspec.rb}

@@ -1,13 +1,23 @@
 # frozen_string_literal: true
 
 require 'rspec'
-require_relative 'doc_spec/compiler'
-require_relative 'doc_spec/example_group'
-require_relative 'doc_spec/parser'
+require_relative 'doc_rspec/compiler'
+require_relative 'doc_rspec/example_group'
+require_relative 'doc_rspec/parser'
 RSpec.configure { it.extend DocRSpec::ExampleGroup }
 
 ##
+# # Usage
+#
+# Install the gem `gem install doc_rspec` or put `doc_rspec` in your Gemfile
+# or gemspec file.
+#
+# Then `require doc_rspec` in the file you want to use the `docspec` macro
+# or put it into your `spec_helper.rb` or use any advanced require strategy
+# you are used to.
+#
 # # Abstract
+#
 # DocRSpec allows us to call `doctest <sourcefile>` and the specs
 # between  ` ```spec ` and ` ``` ` will be executed in the context
 # of the `RSpec` example group `doctest` has been called.
@@ -55,10 +65,10 @@ RSpec.configure { it.extend DocRSpec::ExampleGroup }
 # `formatter=:doc` looks like this:
 #
 #     DocRSpec
-#       example from rdoc (doc_spec.rb:21)
-#       example from rdoc (doc_spec.rb:34)
-#       example from rdoc (doc_spec.rb:41)
-#       example from rdoc (doc_spec.rb:49)
+#       example from rdoc (doc_rspec.rb:21)
+#       example from rdoc (doc_rspec.rb:34)
+#       example from rdoc (doc_rspec.rb:41)
+#       example from rdoc (doc_rspec.rb:49)
 #
 # We can improve on this by giving an example a name with the ` ```spec # <name>` syntax
 #
@@ -70,9 +80,9 @@ RSpec.configure { it.extend DocRSpec::ExampleGroup }
 # Now the output looks like:
 #
 #     DocRSpec
-#       example from rdoc (doc_spec.rb:21)
+#       example from rdoc (doc_rspec.rb:21)
 #       ...
-#       fourtytwo is the answer (doc_spec.rb:65)
+#       fourtytwo is the answer (doc_rspec.rb:65)
 #
 class DocRSpec
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Robert Dober
@@ -47,13 +47,13 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/doc_spec.rb
-- lib/doc_spec/ast.rb
-- lib/doc_spec/ast/example.rb
-- lib/doc_spec/compiler.rb
-- lib/doc_spec/example_group.rb
-- lib/doc_spec/parser.rb
-- lib/doc_spec/version.rb
+- lib/doc_rspec.rb
+- lib/doc_rspec/ast.rb
+- lib/doc_rspec/ast/example.rb
+- lib/doc_rspec/compiler.rb
+- lib/doc_rspec/example_group.rb
+- lib/doc_rspec/parser.rb
+- lib/doc_rspec/version.rb
 homepage: https://codeberg.org/lab419/doc_spec
 licenses:
 - AGPL-3.0-or-later