ast_builder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2420c793e56d111977a664e767a347b92daa09e85c220e98c59dbe847c6408c8
+  data.tar.gz: bdc93ccd806db6ba16cdd4e5817685b147849affb6efa70579867c810edba533
+SHA512:
+  metadata.gz: 8fa76906fc56d1ac05d2557cd0f919e82a8b7ed3c189b52cc1dc229f1e8acd8eb38d08a4acdeda2f3e987927493384aa19e24beff3eaec8737bcc21d70cd9999
+  data.tar.gz: 015d6dc81facfc59d5b33164bbbf01ea45895a60e502229d60d7c629456e45dd8e3f0eb2a74e8560e508c1fd25693d357d1002be24c83170d0e5830d6df5a901

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at baweaver@squareup.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ast_builder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    ast_builder (0.0.1)
+      parser (~> 2.6.0)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.11.3)
+    formatador (0.2.5)
+    guard (2.16.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.4)
+    listen (3.2.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.77.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ast_builder!
+  bundler (~> 2.0)
+  guard-rspec (~> 4.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/Guardfile

@@ -0,0 +1,16 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,244 @@
+# AstBuilder
+
+AstBuilder (AST Amended) is a tool to make it easier to work with and compose S-Expressions and other AST related tasks in Ruby.
+
+It relies heavily on RuboCop functionality, most notably of which the [`NodePattern`][0] meta-language for AST construction and matching.
+
+## Usage
+
+### Build
+
+AstBuilder supports direct strings, which is mostly done to generate ASTs more quickly from static strings.
+
+```ruby
+AstBuilder.build('1 + 1')
+```
+
+The more typical usage for AstBuilder involves passing it a block:
+
+```ruby
+AstBuilder.build { s(:node_type, s(:child_node, '...')) }
+=> #<AstBuilder::Builder:0x00007fe2fba18390 @ast=s(:node_type, s(:child_node, "..."))>
+```
+
+AstBuilder comes with several extensions to the standard `AST::Sexp` syntax's `s` method, as we'll be going over here.
+
+### Expanded Nodes
+
+Ruby constant strings and code that's mostly static can be a bit cumbersome to write out:
+
+```ruby
+puts AstBuilder.build('A::B::C = 1')
+(casgn
+  (const
+    (const nil :A) :B) :C
+  (int 1))
+=> nil
+```
+
+If you wanted to actually capture or use wildcards from [`NodePattern`][0] in that statement, it becomes more difficult:
+
+```ruby
+puts AstBuilder.build('A::B::C = ...')
+AstBuilder::InvalidCode: The following node is invalid:
+  'A::B::C = ...'
+from /Users/baweaver/Development/ast_builder/lib/ast_builder/builder.rb:189:in 'parse'
+```
+
+AstBuilder isn't quite smart enough to be able to tell the difference between a meta-character from [`NodePattern`][0] and a regular Ruby token. This is why the builder blocks are used, but in typical construction you would need to write out the expression by hand.
+
+With AstBuilder you can keep those larger nodes as normal Ruby:
+
+```ruby
+puts AstBuilder.build { s(:casgn, expand('A::B'), :C, expand('1')) }
+(casgn
+  (const
+    (const nil :A) :B) :C
+  (int 1))
+=> nil
+```
+
+### Literal Tokens
+
+If [`NodePattern`][0] tokens aren't valid Ruby, how does one evaluate them into an s-expression tree? `RuboCop::AST::Node`, when coercing to a `String`, will call `inspect` on items it doesn't know how to coerce.
+
+`AstBuilder::LiteralToken` defines this in such a way to not have quotation marks, allowing for a psuedo-interpolation of the meta-language:
+
+```ruby
+puts AstBuilder.build { s(:casgn, expand('A::B'), :C, literal('...')) }
+(casgn
+  (const
+    (const nil :A) :B) :C ...)
+=> nil
+```
+
+### Captures
+
+If you want to capture a node, you would use `$` in NodePattern. In AstBuilder we use `capture` to simulate the same:
+
+```ruby
+puts AstBuilder.build { s(:casgn, expand('A::B'), :C, capture(literal('...'))) }
+(casgn
+  (const
+    (const nil :A) :B) :C $...)
+=> nil
+```
+
+There's the shorter version, `capture_children`, for this same task:
+
+```ruby
+puts AstBuilder.build { s(:casgn, expand('A::B'), :C, capture_children) }
+(casgn
+  (const
+    (const nil :A) :B) :C $(...))
+=> nil
+```
+
+### Matching
+
+An `AstBuilder::Builder` can be coerced into a `RuboCop::NodePattern`, which can be used in the same fashion.
+
+> Note: RuboCop has some slight inconsistencies with how it represents `nil`, which is why when
+> coercing to a RuboCop::NodePattern syntax they're replaced with `nil?`.
+
+```ruby
+AstBuilder.build { s(:casgn, expand('A::B'), :C, capture_children) }.to_cop
+=> #<RuboCop::NodePattern:0x00007fe2fca004d8>
+```
+
+This means that you can use `match` just the same as you would on a `NodePattern`, but AstBuilder surfaces this functionality as we'll see in the next section.
+
+### match
+
+AstBuilder can directly match by coercing its internal state into a NodePattern:
+
+```ruby
+ast_builder_build = AstBuilder.build { s(:casgn, expand('A::B'), :C, capture_children) }
+
+# Using AstBuilder to build a quick AST mock:
+match_data = ast_builder_build.match(AstBuilder.build('A::B::C = 1').to_ast)
+=> s(:int, 1)
+
+# Against a string:
+ast_builder_build.match('A::B::C = 1')
+=> s(:int, 1)
+```
+
+This can also be used against nodes in a RuboCop rule match:
+
+```ruby
+module RuboCop
+  module Cop
+    # Grouping name of the Cop
+    module Deprecations
+      # Name of the check
+      class AbcDeprecation < RuboCop::Cop::Cop
+
+      # RuboCop takes a default message for errors
+      MSG = '`A::B::C` is deprecated, use `D::E::F` instead.'
+
+      # Saving the matcher as a constant allows for easier reuse if you use
+      # autocorrect later, as well as giving a consistent theme across your
+      # matchers.
+      AST_MATCH = AstBuilder.build { s(:casgn, expand('A::B'), :C, capture_children) }
+
+      # [...]
+
+      # Node matches work with the node type you're planning to capture. In this
+      # case we're trying to capture a `casgn` from the top type of the expression:
+      #
+      #     (casgn
+      #       (const
+      #         (const nil :A) :B) :C
+      #       (int 1))
+      #
+      # RuboCop matchers are all on_(type of node) for method names.
+      def on_casgn(node)
+        # Unless our node matches that expression, bail out.
+        return false unless AST_MATCH.match(node)
+
+        # If it did, add an offense so RuboCop knows it's bad.
+        add_offense(node)
+      end
+
+      def autocorrect(node)
+        # RuboCop passes this function to a batch that runs all the given
+        # correctors for the code, hence returning a lambda here.
+        -> corrector {
+          matches = AST_MATCH.match(node)
+
+          # 1. Matches are wrapped in an Enumerator, as there can be multiple
+          # 2. Then the value you want may be in an S-Expression
+          # 3. An S-Expression can have multiple children, so it's returned as an Array
+          # 4. Getting the first value specifically gives us 1, the set value
+          #
+          #       [s()] -> s() -> [1]  ->  1
+          value = matches.first.children.first
+
+          # Now we could always use the actual s-expression from step 2 here
+          # with `matches.first.location.source`, which is handy when we're
+          # not dealing with only one integer.
+          new_code = "D::E::F = #{value}"
+
+          # You can use a few things here, like `insert_before` or after or
+          # other expressions. See the corrector source for more ideas:
+          #
+          #   https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/cop/corrector.rb
+          #
+          # In this case we're replacing the entire node where it's expression is,
+          # or rather the entire thing, with our new code.
+          corrector.replace(node.location.expression, new_code)
+        }
+      end
+    end
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ast_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ast_builder
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/square/ast_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the AstBuilder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/square/ast_builder/blob/master/CODE_OF_CONDUCT.md).
+
+[0]: https://www.rubydoc.info/gems/rubocop/RuboCop/NodePattern "RuboCop NodePattern"
+
+## License
+
+Copyright 2019 Square, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ast_builder.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ast_builder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ast_builder"
+  spec.version       = AstBuilder::VERSION
+  spec.authors       = ["Brandon Weaver"]
+  spec.email         = ["baweaver@squareup.com"]
+
+  spec.summary       = %q{AstBuilder is an AST tool that makes it easier to build (and eventually manipulate) nodes}
+  spec.homepage      = "https://www.github.com/baweaver/ast_builder"
+
+  spec.license       = "Apache-2.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.0"
+
+  spec.add_runtime_dependency "parser", '~> 2.6.0'
+  spec.add_runtime_dependency "rubocop"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ast_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ast_builder.rb

@@ -0,0 +1,8 @@
+require 'parser/current'
+
+require 'ast_builder/version'
+require 'ast_builder/public_api'
+
+module AstBuilder
+  extend PublicApi
+end

data/lib/ast_builder/builder.rb

@@ -0,0 +1,275 @@
+require 'rubocop'
+
+module AstBuilder
+  class InvalidCode < StandardError; end
+
+  class Builder
+    extend RuboCop::NodePattern::Macros
+
+    attr_reader :meta_methods
+
+    # NodePattern won't allow numbers in meta-method calls, so
+    # we need to have alpha characters instead.
+    ALPHA = ('a'..'zz').to_a
+
+    # It can either work on a literal string or on a block
+    #
+    # @param s = nil [String]
+    #   String to convert
+    #
+    # @param &fn [Proc]
+    #   `instance_eval`'d function to allow for some nice Sexp-like
+    #   tokens to be used in construction
+    #
+    # @return [AstBuilder]
+    def initialize(s = nil, &fn)
+      @meta_methods = {}
+      @ast = s ? parse(s) : instance_eval(&fn)
+    end
+
+    # Stand-in for the s-expression given from `AST::Sexp`
+    # to give us some of the `Node` level features that
+    # RuboCop's variant has.
+    #
+    # @param type [String, Symbol]
+    #   Type of the node
+    #
+    # @param *children [Array[Node, respond_to?(:inspect)]]
+    #   RuboCop compatible nodes, or meta-tokens defining
+    #   `inspect` to allow for `NodePattern` interpolation
+    #
+    # @return [RuboCop::AST::Node]
+    def s_expression(type, *children)
+      RuboCop::AST::Node.new(type, children)
+    end
+
+    alias s s_expression
+
+    # A literal token. Think any of the node matchers from Rubocop's NodePattern:
+    #
+    # https://rubocop.readthedocs.io/en/latest/node_pattern/
+    #
+    # @param string [String]
+    #   String to use as a literal token
+    #
+    # @return [LiteralToken]
+    def literal(string)
+      LiteralToken.new(string)
+    end
+
+    alias l literal
+
+    # Expands a token by parsing it instead of manually having to nest
+    # the thing 3-4 layers deep for constants and the like
+    #
+    # @param string [String]
+    #   String to expand into AST Nodes
+    #
+    # @return [AST::Node]
+    def expand(*strings)
+      strings
+        .map { |s| s.is_a?(String) ? parse(s) : s }
+        .yield_self { |node, *children| node.concat(children) }
+    end
+
+    alias e expand
+
+    # Prepends a `$` to represent a captured node for matchers.
+    #
+    # @param string [String]
+    #   String or AST (yeah yeah, names) to "capture"
+    #
+    # @return [LiteralToken]
+    def capture(string)
+      literal("$#{string}")
+    end
+
+    alias c capture
+
+    # Captures the children of a node. Convenience function
+    # combining a capture and a literal.
+    #
+    # @return [String]
+    def capture_children
+      capture literal '(...)'
+    end
+
+    # Top level method send for sexps that avoids having to type out
+    # the entire `(send nil? name (...))` bit.
+    #
+    # @param name [String]
+    #   Name of the top level keyword
+    #
+    # @param *sexp [Array[String, AST::Node, LiteralToken]]
+    #   Anything that looks vaguely like a Sexp
+    #
+    # @return [AST::Node]
+    def top_method_send(name, *sexp)
+      s(:send, nil, name, *sexp)
+    end
+
+    alias t top_method_send
+
+    # Regular method send for any level, normally used for things like
+    # constants and otherwise.
+    #
+    # @param name [String]
+    #   Name of the method
+    #
+    # @param *sexp [[Array[String, AST::Node, LiteralToken]]
+    #   Anything that looks vaguely like a Sexp
+    #
+    # @return [AST::Node]
+    def method_send(name, *sexp)
+      s(:send, name, *sexp)
+    end
+
+    alias m method_send
+
+    # Wraps a variable assignment for shorthand usage. It will try and tell
+    # the difference between instance
+    #
+    # @param variable [Symbol]
+    #   Name of the variable
+    #
+    # @param value [Any]
+    #   Value of the variable. Could be a NodePattern literal
+    #
+    # @return [AST::Node]
+    def assigns(variable, value)
+      # Constant assignment if we got a node
+      return s(:casgn, nil, variable, value) unless variable.respond_to?(:to_sym)
+
+      variable_name = variable.to_sym
+
+      case variable.to_s
+      when /^@@/
+        s(:cvasgn, variable_name, value)
+      when /^@/
+        s(:ivasgn, variable_name, value)
+      when /^\$/
+        s(:gvasgn, variable_name, value)
+      when /^[[:upper:]]/
+        s(:casgn, nil, variable_name, value)
+      else
+        s(:lvasgn, variable_name, value)
+      end
+    end
+
+    # Checks to see if a given value matches a meta-method.
+    #
+    # In a normal NodePattern, this is a method which exists in the parent context or on the NodePattern itself. As
+    # these methods are rarely used outside of this context, they can be defined instead as anonymous functions
+    # using the additional flexibility of AstBuilder's builder syntax:
+    #
+    # ```ruby
+    # assigns(:value, s(:str, matching(/abc/)))
+    # ```
+    #
+    # Now instead of having to specify these checks in an actual handler, or defining a method on the parent
+    # context, we can do so inline.
+    #
+    # These meta methods are then stored and defined on the generated NodePattern upon match time to ensure they're
+    # within scope.
+    #
+    # @param value = nil [#===]
+    #   Any value that responds to `===`, used to build off of the flexibility of the Ruby `case`
+    #   expression.
+    #
+    # @param &function [Proc]
+    #   A function used to match against. Note that this function _must_ have the proper arity or NodePattern will
+    #   reject it.
+    #
+    # @return [LiteralToken]
+    #   This returns a literal token instead of a string, as NodePattern expects it to be a bare word.
+    def matching(value = nil, &function)
+      called_function = function ? function : -> x { value === x }
+
+      # NodePattern will not accept numbers, so we have to use letters instead.
+      meta_name = "_meta_method_#{ALPHA[@meta_methods.size]}"
+
+      @meta_methods[meta_name] = called_function
+
+      # These macros start with the `#` symbol, making this intentional
+      literal("##{meta_name}")
+    end
+
+    alias mm matching
+
+    # This method will both use anonymous functions or values to match against and then capture the output.
+    #
+    # @see #matching
+    #
+    # @param value = nil [#===]
+    #   Any value that responds to `===`, used to build off of the flexibility of the Ruby `case`
+    #   expression.
+    #
+    # @param &function [Proc]
+    #   A function used to match against. Note that this function _must_ have the proper arity or NodePattern will
+    #   reject it.
+    #
+    # @return [LiteralToken]
+    def capture_matching(value = nil, &function)
+      capture(matching(value, &function))
+    end
+
+    alias cm capture_matching
+
+    # Coerces the builder into a RuboCop NodePattern and attempts to match another value against it.
+    #
+    # @param other [String, AST]
+    #   Either plaintext code or another AST to match against
+    #
+    # @return [nil]
+    #   There was no match
+    #
+    # @return [String]
+    #   The matched portion of the code
+    def match(other)
+      ast = other.is_a?(String) ? self.class.new(other).to_ast : other
+      self.to_cop.match(ast)
+    end
+
+    # Because RuboCop has... interesting ...formatting rules we have
+    # to hack around nil a bit and add a question mark.
+    #
+    # @return [RuboCop::NodePattern]
+    #   RuboCop compatible Sexp
+    def to_cop
+      RuboCop::NodePattern.new(self.to_s.gsub(/\bnil\b/, 'nil?')).tap do |node_pattern|
+        # If there are any meta methods defined we bind them to the node pattern to match against
+        @meta_methods.each do |name, fn|
+          node_pattern.define_singleton_method(name, &fn)
+        end
+      end
+    end
+
+    # Returns the internal AST representation as-is
+    #
+    # @return [AST::Node]
+    def to_ast
+      @ast
+    end
+
+    # String version of the AST
+    #
+    # @return [String]
+    def to_s
+      @ast.to_s
+    end
+
+    # Parses a String to a Ruby AST
+    #
+    # @param string [String]
+    #   String to convert
+    #
+    # @return [AST::Node]
+    private def parse(string)
+      ast_results = RuboCop::ProcessedSource.new(string, RUBY_VERSION.to_f).ast
+
+      raise InvalidCode, "The following node is invalid: \n  '#{string}'" unless ast_results
+
+      ast_results
+    end
+  end
+end

data/lib/ast_builder/literal_token.rb

@@ -0,0 +1,27 @@
+module AstBuilder
+  # Represents a literal token entity to avoid any quotation marks on inspect.
+  # Parser::AST will recursively call nodes, using `inspect` for anything
+  # that's not a `Node` type, so we can cheat to get the macro language in
+  # here.
+  class LiteralToken
+    def initialize(string)
+      @string = string
+    end
+
+    # Converts to a string. If we happen to have gotten some
+    # extra fun we make sure it's a string representation instead
+    # of a node.
+    #
+    # @return [String]
+    def to_s
+      @string.to_s
+    end
+
+    # Won't show quotes around it, which we need for literal tokens
+    #
+    # @return [String]
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/ast_builder/public_api.rb

@@ -0,0 +1,22 @@
+require 'ast_builder/literal_token'
+require 'ast_builder/builder'
+
+module AstBuilder
+  module PublicApi
+    # Builds an AST Node from AstBuilder shorthand syntax
+    #
+    # @see AstBuilder::Builder
+    #   For more notes on usage
+    #
+    # @param string = nil [String]
+    #   Literal String to build
+    #
+    # @param &fn [Proc]
+    #   `instance_eval`'d function used to build an s-expression
+    #
+    # @return [AstBuilder::Builder]
+    def build(string = nil, &fn)
+      Builder.new(string, &fn)
+    end
+  end
+end

data/lib/ast_builder/version.rb

@@ -0,0 +1,3 @@
+module AstBuilder
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: ast_builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Weaver
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- baweaver@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- ast_builder.gemspec
+- bin/console
+- bin/setup
+- lib/ast_builder.rb
+- lib/ast_builder/builder.rb
+- lib/ast_builder/literal_token.rb
+- lib/ast_builder/public_api.rb
+- lib/ast_builder/version.rb
+homepage: https://www.github.com/baweaver/ast_builder
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: AstBuilder is an AST tool that makes it easier to build (and eventually manipulate)
+  nodes
+test_files: []