masamune-ast 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1131c8f9da2cb862e77f3840c9abc806443a7d4445d788fd3683cec41b1916e8
-  data.tar.gz: bb9025361d1063fd3f7776070830b4e41b7529d3ea04b11fbe9466890bca8d28
+  metadata.gz: 418c2c9ca6e229ff03320d7057ff12f19cdbb60d3da8b9f1d03db901b6971b43
+  data.tar.gz: 3dda8f6d319d4ce961a8f9b3421d73bea5a8462c8c740b0c1f6e37e25e3020a1
 SHA512:
-  metadata.gz: f6e571ac354ab0fae7e39fbf1d0030c1025738732d008b9c3afa9ade11c2cb41b88d67a08ac66d878dd913fae1a9cf08f79d4539f931b7a55fd43f563332d08b
-  data.tar.gz: 47065f76eebaab82601b9d577a738765e66d588f6ad300931223bd61824e0f290612a6341dd098d8bd78cdb90e5b44ce9513d6beb5280b9ebc5691b4044145ea
+  metadata.gz: 165fb67094e4e12730106dd7262d4d8be67db9d7994ca96c5d94a46d2334c0c62d1aa9fab64637e9290e3aff6f7a8c8b913580b4ae3e2ed4584b52f40a82d55a
+  data.tar.gz: '006920de6a9409d6a08f6cfe955f918e8411c267665559aec9847fddffb6c514ca9283db8efbe73d8098f687c274d06439ffd681a817172ac5e7216fd61ef774'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [1.0.0] - 2023-05-01
+
+- Change `MasamuneAst` module to `Masamune`.
+
 ## [0.1.0] - 2023-04-24
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    masamune-ast (0.1.0)
+    masamune-ast (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,9 +1,14 @@
-# MasamuneAst
+# Masamune
 
 ## A Ruby source code analyzer based on Ripper’s Abstract Syntax Tree generator (`Ripper#sexp`).
 
 ## Installation
 
+```ruby
+sudo gem install "masamune-ast"
+```
+
+Or add the following to your Gemfile and run `bundle install`
 ```ruby
 gem "masamune-ast"
 ```
@@ -19,13 +24,37 @@ puts java + " is not " + javascript
 # java
 CODE
 
-msmn = MasamuneAst::AbstractSyntaxTree.new(code)
+msmn = Masamune::AbstractSyntaxTree.new(code)
 
+# Searching the tree returns the specific node and the line number it's on.
 msmn.variables
-[[[1, 0], "java"], [[2, 0], "javascript"], [[2, 13], "java"]]
+#=> [[[1, 0], "java"], [[2, 0], "javascript"], [[2, 13], "java"]]
 
 msmn.search(:variable, "java")
 #=> [[[1, 0], "java"], [[2, 13], "java"]]
+
+code = <<CODE
+ary = [1, 2, 3]
+ary.sum.times do |n|
+  puts n
+end
+
+def foo
+end
+foo
+foo # Call again
+CODE
+
+msmn = Masamune::AbstractSyntaxTree.new(code)
+
+msmn.search(:method_call, "sum")
+#=> [[[2, 4], "sum"]]
+
+msmn.search(:def, "foo")
+#=> [[[6, 4], "foo"]]
+
+msmn.search(:method_call, "foo")
+#=> [[[8, 0], "foo"], [[9, 0], "foo"]]
 ```
 
 In some cases, it can be easier to look at the given lex nodes to analyze your source code:
@@ -59,7 +88,7 @@ msmn.lex_nodes[8].is_method_definition?
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/gazayas/masamune.
+Bug reports and pull requests are welcome on GitHub at https://github.com/gazayas/masamune-ast.
 
 ## License
 

data/lib/masamune-ast/abstract_syntax_tree/data_node.rb

@@ -1,8 +1,8 @@
 # TODO: Not sure if I'll implement this yet.
 
-module MasamuneAst
+module Masamune
   class AbstractSyntaxTree
-    class DataNode << MasamuneAst::AbstractSyntaxTree::Node
+    class DataNode << Masamune::AbstractSyntaxTree::Node
       def initialize(tree_node)
         @parent, @contents, _ = tree_node
       end

data/lib/masamune-ast/abstract_syntax_tree/node.rb

@@ -1,6 +1,6 @@
 # TODO: Not sure if I'll implement this yet.
 
-module MasamuneAst
+module Masamune
   class AbstractSyntaxTree
     class Node
       def initialize(tree_node)

data/lib/masamune-ast/abstract_syntax_tree.rb

@@ -1,4 +1,4 @@
-module MasamuneAst
+module Masamune
   class AbstractSyntaxTree
     attr_reader :data
     attr_accessor :lex_nodes, :debug
@@ -7,7 +7,7 @@ module MasamuneAst
       @data = Ripper.sexp(code)
       raw_lex_nodes = Ripper.lex(code)
       @lex_nodes = raw_lex_nodes.map do |lex_node|
-        MasamuneAst::LexNode.new(raw_lex_nodes.index(lex_node), lex_node, self.__id__)
+        Masamune::LexNode.new(raw_lex_nodes.index(lex_node), lex_node, self.__id__)
       end
       @debug = false
     end

data/lib/masamune-ast/lex_node.rb

@@ -1,4 +1,4 @@
-module MasamuneAst
+module Masamune
   # https://docs.ruby-lang.org/en/3.0/Ripper.html#method-c-lex
   #
   # @position: Line number and starting point on the line. i.e. - [4, 7].

data/lib/masamune-ast/slicer.rb

@@ -1,4 +1,4 @@
-module MasamuneAst
+module Masamune
   module Slicer
     def initialize(ast)
       @ast = ast

data/lib/masamune-ast/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module MasamuneAst
-  VERSION = "0.1.0"
+module Masamune
+  VERSION = "1.0.0"
 end

data/lib/masamune-ast.rb

@@ -8,5 +8,5 @@ require "masamune-ast/abstract_syntax_tree"
 require "pp"
 require "pry"
 
-module MasamuneAst
+module Masamune
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: masamune-ast
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gabriel Zayas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-29 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies: []
 description: A layer of abstraction on top of Ripper for handling Abstract Syntax
   Trees in Ruby.
@@ -32,13 +32,13 @@ files:
 - lib/masamune-ast/slicer.rb
 - lib/masamune-ast/version.rb
 - sig/masamune.rbs
-homepage: https://www.github.com/gazayas/masamune
+homepage: https://www.github.com/gazayas/masamune-ast
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://www.github.com/gazayas/masamune
-  source_code_uri: https://www.github.com/gazayas/masamune
-  changelog_uri: https://www.github.com/gazayas/masamune
+  homepage_uri: https://www.github.com/gazayas/masamune-ast
+  source_code_uri: https://www.github.com/gazayas/masamune-ast
+  changelog_uri: https://www.github.com/gazayas/masamune-ast
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -57,5 +57,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: MasamuneAst
+summary: Masamune
 test_files: []