arrow_test 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab80fb2ab081c38e14d753204fe4fc886959df00
-  data.tar.gz: 0fec4258fb1605fdf9f1b3b7c9150b3fbfe9540c
+  metadata.gz: 6b46b6c8dbd1a5aa735ffdcdd3b53255802deef8
+  data.tar.gz: f3c846eb3cd86cc947d28e1ae927599b7fa7071e
 SHA512:
-  metadata.gz: a542a1596a9d11dedd585bd572b63f9dd4698c0291c5f4b985f88d49fa6505872bb0b40cdbc1338c462ea78b5a0a9e8262b64c84c6a2e677da4a0241ff96a3db
-  data.tar.gz: d07eef93af3f466c51e03b2fda5360096fb0693b37035de6af23cbf6f1717aa17ecef515eee6636ec8a461bba82adbd30da65f5da6754e4153c455ccd4b24eed
+  metadata.gz: 2dfeaf8256e946431251e03e5a1f92a6f235811338fba09d104d1e0dc71a25e44a10b4ee48d7f5abb393b5476ddb680cbaf832f7a32218042997a243dd1881cb
+  data.tar.gz: 9d4a393b4fe64a4b0587f8ba0fe930128bfca3382957885207224355ab07a31727d25fa4f58139e550e30a63478f1275c7f173787efd8891c51134bb8b1b4d8c

data/lib/arrow_test.rb

@@ -1,5 +1,14 @@
 require 'colorize'
 
+ # Performs the logic of the arrow  test.
+ #
+ # Example:
+ #   >> helper_arrow_test(["", "1+1 #-> 3"])
+ #   => ["ERROR:\n        EXECUTING: 1  + 1\n        EXPECTED: 3\n        INSTEAD GOT: 2\n\n\n"]
+ #
+ # Arguments:
+ #   lines: (String) The lines of code to be arrow tested.
+ #   verbose: (Boolean) If true returns also correct tests.
 def helper_arrow_test(lines, verbose=false)
   messages = []
   arrow_regex = Regexp.new('\ *\#\ *\-\ *\>\ *')
@@ -29,6 +38,17 @@ END
   messages
 end
 
+ # Performs Input/Output wrapping `helper_arrow_test`
+ # Call this in your code.
+ #
+ # Example:
+ #   require 'arrow_testing'
+ #   1 + 1 # -> 3
+ #   arrow_test
+ #
+ # Arguments:
+ #   filename: (String) The filename to be tested. Default is $0: your current file.
+ #   verbose: (Boolean) If true outputs also correct tests.
 def arrow_test(filename=$0, verbose=false)
   puts helper_arrow_test(IO.foreach(filename).to_a, verbose)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arrow_test
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Caridorc Tergilti
@@ -13,17 +13,11 @@ dependencies: []
 description: |2
    `Vigorous testing is coincise`
 
-  This gem allows coincise testing, even shorter than docctest.
+  This gem allows coincise testing, even shorter than doctest.
 
   It also adds minimal overhead to your file!
 
-  An example usage shows how little typing is required:
-
-      require 'arrow_test'
-      1 + 1 -> 3
-      arrow_test
-
-  And you are done! Running the above will show you the error.
+  See the documentation for examples.
 email: riki100024@gmail.com
 executables: []
 extensions: []