rephrase 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50dd6a940c19895850f10694544b163b9362ab853242972760a885f555750a54
-  data.tar.gz: 0d41895ceb222d573384ae073bc183d0eaf5ee3d3429acc5f59f894af4af628f
+  metadata.gz: fff798527479ef2c51091ce5358d97f744439765c654efe86bf076ea3b71f66a
+  data.tar.gz: d5b22bfc4f8155b67aa384eef563d099e2b7c9baef0b59515d0fb4f68230e771
 SHA512:
-  metadata.gz: '0513931ee88c085b5026f71e9e5f427664a745ba93fa94e0d20422d7b690dec9bce8142fc8129ebd59379c0f3ee7f425d898a671011762c2c373c8266ea47a83'
-  data.tar.gz: 42757fb4d2ca4cad5feff6b19a42350662875864e8c262bced0dd6dcb73c1ed12d20630884ee09e9351a3411ca438360b76909e2a927467561c25e911415f50d
+  metadata.gz: e4d6310d5dd1f17bc8a234689e647dbf63dd6eac0139ddb7b8bfc4587f23919fa54ff717f51b5bf600d230180205c0aa173a56d9cbb595ea6c25742af42501d4
+  data.tar.gz: e0626f72497824c948f447dc8b7f32fdec3ac2f065ef7f5ab83b22ef48d24b823e33f88811aa9eb9a8ecea6b00cd6ee29985996baef95e58a2e17fc64287638f

data/CHANGELOG.md

@@ -1,8 +1,12 @@
+## 0.3 2011-11-17
+
+- Improve documentation.
+
 ## 0.2 2011-11-16
 
-- Rename `#to_ruby` to `#to_source`
-- Add documentation
+- Rename `#to_ruby` to `#to_source`.
+- Add documentation.
 
 ## 0.1 2021-11-16
 
-- First working version
+- First working version.

data/lib/rephrase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Rephrase
-  VERSION = '0.2'
+  VERSION = '0.3'
 end

data/lib/rephrase.rb

@@ -6,21 +6,27 @@
 class Rephrase
   # Class for faking a node
   class FakeNode
-    # Constructs a FakeNode with type `:LIST_EMBEDDED`
+    # Constructs a FakeNode with type `:LIST_EMBEDDED`.
     # @param children [Array] child nodes
     def self.list(children)
       new(:LIST_EMBEDDED, children)
     end
 
-    # Constructs a FakeNode with type `:ITER_SCOPE`
+    # Constructs a FakeNode with type `:ITER_SCOPE`.
     # @param children [Array] child nodes
     def self.iter_scope(children)
       new(:ITER_SCOPE, children)
     end
 
-    attr_reader :type, :children
+    # Node type
+    # @return [Symbol]
+    attr_reader :type
+
+    # Node children
+    # @return [Array]
+    attr_reader :children
     
-    # Initializes a FakeNode
+    # Initializes a FakeNode.
     # @param type [Symbol] node type
     # @param children [Array] child nodes
     def initialize(type, children)
@@ -29,7 +35,7 @@ class Rephrase
     end
   end
   
-  # Converts a :block or method to its source code
+  # Converts a block or method to its source code.
   # @param code [Proc, BoundMethod, UnboundMethod] proc or method
   # @return [String] converted source code
   def self.to_source(code)
@@ -37,7 +43,7 @@ class Rephrase
     new.convert({}, ast)
   end
 
-  # Pretty-prints an AST
+  # Pretty-prints an AST.
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def self.pp_ast(node, level = 0)
     case node
@@ -54,7 +60,7 @@ class Rephrase
     end
   end
 
-  # Converts an AST node to a string containing its source code
+  # Converts an AST node to a string containing its source code.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   # @return [String] source code
@@ -71,7 +77,7 @@ class Rephrase
     ctx[:buffer]
   end
 
-  # Converts a :SCOPE AST node
+  # Converts a `:SCOPE` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_scope(ctx, node)
@@ -82,7 +88,7 @@ class Rephrase
     emit(ctx, "proc do", [body], "end")
   end
 
-  # Converts a :BLOCK AST node
+  # Converts a `:BLOCK` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_block(ctx, node)
@@ -93,7 +99,7 @@ class Rephrase
     end
   end
 
-  # Converts a :ITER AST node
+  # Converts a `:ITER` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_iter(ctx, node)
@@ -102,7 +108,7 @@ class Rephrase
     emit(ctx, FakeNode.iter_scope(scope.children))
   end
 
-  # Converts a :ITER_SCOPE AST (fake) node
+  # Converts a `:ITER_SCOPE` AST (fake) node.
   # @param ctx [Hash] context object
   # @param node [Rephrase::FakeNode] AST node
   def on_iter_scope(ctx, node)
@@ -114,14 +120,14 @@ class Rephrase
     emit(ctx, "\nend")
   end
 
-  # Converts a :CONST AST node
+  # Converts a `:CONST` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_const(ctx, node)
     emit(ctx, node.children.first.to_s)
   end
 
-  # Converts a :COLON2 AST node
+  # Converts a `:COLON2` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_colon2(ctx, node)
@@ -129,7 +135,7 @@ class Rephrase
     emit(ctx, left, "::", right.to_s)
   end
 
-  # Converts a :CALL AST node
+  # Converts a `:CALL` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_call(ctx, node)
@@ -147,7 +153,7 @@ class Rephrase
     end
   end
 
-  # Converts a :FCALL AST node
+  # Converts a `:FCALL` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_fcall(ctx, node)
@@ -156,14 +162,14 @@ class Rephrase
     emit(ctx, "#{method}(", args, ")")
   end
 
-  # Converts a :VCALL AST node
+  # Converts a `:VCALL` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_vcall(ctx, node)
     emit(ctx, node.children.first.to_s, "()")
   end
 
-  # Converts a :OPCALL AST node
+  # Converts a `:OPCALL` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_opcall(ctx, node)
@@ -175,7 +181,7 @@ class Rephrase
     end
   end
 
-  # Converts a :DASGN_CURR AST node
+  # Converts a `:DASGN_CURR` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_dasgn_curr(ctx, node)
@@ -183,7 +189,7 @@ class Rephrase
     emit(ctx, left.to_s, " = ", right)
   end
 
-  # Converts a :IASGN AST node
+  # Converts a `:IASGN` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_iasgn(ctx, node)
@@ -191,7 +197,7 @@ class Rephrase
     emit(ctx, left.to_s, " = ", right)
   end
 
-  # Converts a :IF AST node
+  # Converts a `:IF AST` node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_if(ctx, node)
@@ -203,7 +209,7 @@ class Rephrase
     end
   end
 
-  # Converts a :UNLESS AST node
+  # Converts a `:UNLESS` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_unless(ctx, node)
@@ -215,7 +221,7 @@ class Rephrase
     end
   end
 
-  # Converts a :WHILE AST node
+  # Converts a `:WHILE` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_while(ctx, node)
@@ -223,56 +229,56 @@ class Rephrase
     emit(ctx, "while ", cond, "\n", body, "\nend")
   end
 
-  # Converts a :LIT AST node
+  # Converts a `:LIT` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_lit(ctx, node)
     emit(ctx, node.children.first.inspect)
   end
 
-  # Converts a :NIL AST node
+  # Converts a `:NIL` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_nil(ctx, node)
     emit(ctx, "nil")
   end
 
-  # Converts a :TRUE AST node
+  # Converts a `:TRUE` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_true(ctx, node)
     emit(ctx, "true")
   end
 
-  # Converts a :FALSE AST node
+  # Converts a `:FALSE` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_false(ctx, node)
     emit(ctx, "false")
   end
 
-  # Converts a :DVAR AST node
+  # Converts a `:DVAR` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_dvar(ctx, node)
     emit(ctx, node.children.first.to_s)
   end
 
-  # Converts a :IVAR AST node
+  # Converts a `:IVAR` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_ivar(ctx, node)
     emit(ctx, node.children.first.to_s)
   end
 
-  # Converts a :STR AST node
+  # Converts a `:STR` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_str(ctx, node)
     emit(ctx, node.children.first.inspect)
   end
 
-  # Converts a :DSTR AST node
+  # Converts a `:DSTR` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_dstr(ctx, node)
@@ -293,14 +299,14 @@ class Rephrase
     emit(ctx, "\"")
   end
 
-  # Converts a :EVSTR AST node
+  # Converts a `:EVSTR` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_evstr(ctx, node)
     emit(ctx, "\#{", node.children.first, "}")
   end
 
-  # Converts a :AND AST node
+  # Converts a `:AND` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_and(ctx, node)
@@ -308,7 +314,7 @@ class Rephrase
     emit(ctx, left, " && ", right)
   end
 
-  # Converts a :OR AST node
+  # Converts a `:OR` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_or(ctx, node)
@@ -316,7 +322,7 @@ class Rephrase
     emit(ctx, left, " || ", right)
   end
 
-  # Converts a :LIST AST node
+  # Converts a `:LIST` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_list(ctx, node)
@@ -330,7 +336,7 @@ class Rephrase
     emit(ctx, "]")
   end
 
-  # Converts a :LIST_EMBEDDED AST (fake) node
+  # Converts a `:LIST_EMBEDDED` AST (fake) node.
   # @param ctx [Hash] context object
   # @param node [Rephrase::FakeNode] AST node
   def on_list_embedded(ctx, node)
@@ -342,7 +348,7 @@ class Rephrase
     end
   end
 
-  # Converts a :HASH AST node
+  # Converts a `:HASH` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_hash(ctx, node)
@@ -360,7 +366,7 @@ class Rephrase
     emit(ctx, "}")
   end
 
-  # Converts a :ATTRASGN AST node
+  # Converts a `:ATTRASGN` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_attrasgn(ctx, node)
@@ -377,7 +383,7 @@ class Rephrase
     end
   end
 
-  # Converts a :RESCUE AST node
+  # Converts a `:RESCUE` AST node.
   # @param ctx [Hash] context object
   # @param node [RubyVM::AbstractSyntaxTree::Node] AST node
   def on_rescue(ctx, node)
@@ -386,7 +392,7 @@ class Rephrase
     emit(ctx, " rescue ", rescue_body.children[1])
   end
 
-  # Emits code into the context buffer
+  # Emits code into the context buffer.
   # @param ctx [Hash] context object
   # @param entries [Array<String, Symbol>] code entries
   def emit(ctx, *entries)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rephrase
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: ciconia@gmail.com
 executables: []
@@ -54,6 +82,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/digital-fabric/rephrase
+  documentation_uri: https://www.rubydoc.info/gems/rephrase/0.3
 post_install_message: 
 rdoc_options:
 - "--title"