ffast 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2cd44ce2405cd969c26c841d7d63d7c15b85cf7a0747ce1f2e08eebff83c490
-  data.tar.gz: 848f0e3ce2904183e3f0f9ec44590110efb4786ddc98862c1671fec68c11df88
+  metadata.gz: 7b1063b0bb3b8dcc82515f0b10fc24601c6b322979d0a53eb6e65fa6f3ab439c
+  data.tar.gz: b984df89b42bb0f21c2f91567d37fe10e336fb489fdea3ad8ff5ae658dc1de34
 SHA512:
-  metadata.gz: 461a90f7d5d42f9abe6fd425c85d3f6e36dc34fc3afa5abd1ce11f87492315166313e4a9b6876d5b8ada3323264c624fd965c07b1f4040c87c67a3044056ca9d
-  data.tar.gz: 1118edfdc9f336d8fc7f351575ed5aaf93720856633e12b899a7c8b0e71818f9bd82979571b0c84b2419794ad960b699ea2dc7d91936d6bc3e7daf26986fe000
+  metadata.gz: adf2973bf7e616dbd7fe1866abda708afd1e667ee2938d74f3204d26f228b8f235b017f6729cc083651627aee97ac924d6042ef73248e8d5bcd4491065f18ade
+  data.tar.gz: b6c77021c7db79ed8e7382e168409cfbc2c66b94681b6ba8fbcd6ec0842aedf3fe431ce894034640a2dfe2b22a8cf22884498d2b40df674e6a697aa16dd1282d

data/lib/fast.rb

@@ -95,7 +95,9 @@ module Fast
     end
 
     # Replaces content based on a pattern.
-    # @param &replacement gives the [Rewriter] context in the block.
+    # @param [Astrolabe::Node] ast with the current AST to search.
+    # @param [String] pattern with the expression to be targeting nodes.
+    # @param [Proc] replacement gives the [Rewriter] context in the block.
     # @example
     #   Fast.replace?(Fast.ast("a = 1"),"lvasgn") do |node|
     #     replace(node.location.name, 'variable_renamed')
@@ -115,9 +117,7 @@ module Fast
       rewriter.rewrite(buffer, ast)
     end
 
-    # Replaces the source of an {#ast_from_file} with
-    # based on a search.
-    # @return [String] with the content of the new file
+    # Replaces the source of an {Fast#ast_from_file} with
     # and the same source if the pattern does not match.
     def replace_file(file, pattern, &replacement)
       ast = ast_from_file(file)
@@ -125,7 +125,7 @@ module Fast
     end
 
     # Search with pattern directly on file
-    # @return Array<Astrolabe::Node> that matches the pattern
+    # @return [Array<Astrolabe::Node>] that matches the pattern
     def search_file(pattern, file)
       node = ast_from_file(file)
       search node, pattern
@@ -133,7 +133,7 @@ module Fast
 
     # Capture elements from searches in files. Keep in mind you need to use `$`
     # in the pattern to make it work.
-    # @return Array<Object> captured from the pattern matched in the file
+    # @return [Array<Object>] captured from the pattern matched in the file
     def capture_file(pattern, file)
       node = ast_from_file(file)
       capture node, pattern
@@ -155,7 +155,7 @@ module Fast
     end
 
     # Return only captures from a search
-    # @return Array<Object> with all captured elements.
+    # @return [Array<Object>] with all captured elements.
     # If the result is only a single capture, it will return the single element.
     def capture(node, pattern)
       res =
@@ -227,8 +227,8 @@ module Fast
       result
     end
 
-    # @return Array<String> with all ruby files from arguments.
-    # @param *files can be files or directories.
+    # @return [Array<String>] with all ruby files from arguments.
+    # @param files can be file paths or directories.
     # When the argument is a folder, it recursively fetches all `.rb` files from it.
     def ruby_files_from(*files)
       directories = files.select(&File.method(:directory?))
@@ -314,11 +314,6 @@ module Fast
   # ExpressionParser empowers the AST search in Ruby.
   # All classes inheriting Fast::Find have a grammar shortcut that is processed here.
   #
-  # Exclamation Mark to negate: `!(int _)` is equivalent to a `not integer` node.
-  # Curly Braces allows [Any]: `({int float} _)`  or `{(int _) (float _)}`.
-  # Square Braquets allows [All]: [(int _) !(int 0)] # all integer less zero.
-  # Dollar sign can be used to capture values: `(${int float} _)` will capture the node type.
-  #
   # @example find a simple int node
   #   Fast.expression("int")
   #   # => #<Fast::Find:0x00007ffae39274e0 @token="int">
@@ -620,7 +615,8 @@ module Fast
   end
 
   # Matches any of the internal expressions. Works like a **OR** condition.
-  # `{int float}` means int or float.
+  # @example Matchig int or float
+  #   Fast.expression("{int float}")
   class Any < Find
     def match?(node)
       token.any? { |expression| Fast.match?(node, expression) }
@@ -717,8 +713,8 @@ module Fast
 
     # Find search captures recursively.
     #
-    # @return Array<Object> of captures from the expression
-    # @return true in case of no captures in the expression
+    # @return [Array<Object>] of captures from the expression
+    # @return [true] in case of no captures in the expression
     # @see Fast::Capture
     # @see Fast::FindFromArgument
     def find_captures(fast = @fast)
@@ -748,9 +744,10 @@ module Fast
       end
     end
 
-    # @param [FindWithCapture] set the current captures
-    # as previous captures to the current node.
-    # @return [void] and only set [FindWithCapture#previous_captures]
+    # Prepare token  with previous captures
+    # @param [FindWithCapture] token set the current captures
+    # @return [void]
+    # @see [FindWithCapture#previous_captures]
     def prepare_token(token)
       case token
       when Fast::FindWithCapture

data/lib/fast/experiment.rb

@@ -109,20 +109,20 @@ module Fast
       @expression = expression
     end
 
-    # @param &block yields the node that matches and return the block in the
+    # @param block yields the node that matches and return the block in the
     # instance context of a [Fast::Rewriter]
     def edit(&block)
       @replacement = block
     end
 
-    # @param [String] that will be combined to find the {#files}
+    # @param [String] files_or_folders that will be combined to find the {#files}
     def lookup(files_or_folders)
       @files_or_folders = files_or_folders
     end
 
     # It calls the block after the replacement and use the result
     # to drive the {Fast::ExperimentFile#ok_experiments} and {Fast::ExperimentFile#fail_experiments}.
-    # @param &block yields a temporary file with the content replaced in the current round.
+    # @param block yields a temporary file with the content replaced in the current round.
     def policy(&block)
       @ok_if = block
     end
@@ -359,10 +359,10 @@ module Fast
       end
       done!
     end
-    #
+
     # Writes a new file with partial replacements based on the current combination.
     # Raise error if no changes was made with the given combination indices.
-    # @param [Array<Integer>] combinations to be replaced.
+    # @param [Array<Integer>] combination to be replaced.
     def run_partial_replacement_with(combination)
       content = partial_replace(*combination)
       experimental_file = experimental_filename(combination)

data/lib/fast/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fast
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffast
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Jônatas Davi Paganini