tree_stand 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 736381046f8ec987fd106632c34cfbcf79055801d19c519d59980da52d9ebf6a
-  data.tar.gz: 7e1563ffb2af294542d3ac35fd287738bae0ebb69f7312907c18b5ff07fafd64
+  metadata.gz: c800b4009161889917105434b7f93ec8f75e678edf643cc4705e9a4e98da8aef
+  data.tar.gz: 6313e2c9035433aae6023ffa1d49fff987ae4d13addcfe097684e4a73c2ceab5
 SHA512:
-  metadata.gz: 36c90d3233c617abb88bb364cd79bc8fc0465301ef91dd0f9043cbc390d7e7ea5bf7f6ddf07ce4d82f715fd6dc2f76a3c3886a601610c29ddd6679effe2aa3f9
-  data.tar.gz: 3ffc48adac74e5623244e0024534c867f074715d03640f7a428b077556e71f5d5b9b9394ad6f02c586b76768878f13511f3772fa70a5871d9fedea537eca6f67
+  metadata.gz: d4c2690b25d485b36e0e1d9718295dd7d5e941fa40cb127fc908ab8b11b2fd5bab94d0d396f0d0db6955dd9299c7750364d747246fcd514466a2b3570bff4632
+  data.tar.gz: acc8c9ef231e3c4a05f64c33c26871a9ca7cbb41b54319ab43db2f99dd9bc3fc3c263c038315df751cbf7595528fd814340ad6e26f149eee3354586c77bd072a

data/.github/workflows/publish_docs.yml

@@ -0,0 +1,35 @@
+name: Publish docs
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Publish documentation website
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup TreeSitter
+        run: sudo apt-get install -y libtree-sitter-dev make gcc
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.1
+          bundler-cache: true
+
+      - name: Configure git
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+
+      - name: Generate documentation
+        run: bundle exec yard --output-dir docs
+
+      - name: Commit to gh-pages
+        run: |
+          git add docs
+          git commit -m "Publish website $(git log --format=format:%h -1)"
+          git push --force origin main:gh-pages

data/Gemfile

@@ -3,12 +3,3 @@ source "https://rubygems.org"
 gemspec
 
 gem 'tree_sitter', git: 'https://github.com/Faveod/ruby-tree-sitter'
-
-group :development do
-  gem "yard"
-end
-
-group :test do
-  gem "minitest-focus"
-  gem "minitest-reporters"
-end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 derekstride
+Copyright (c) 2022-present, Shopify Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -14,6 +14,8 @@ Add this line to your application's Gemfile:
 gem "tree_stand"
 ```
 
+See the [documentation](https://shopify.github.io/tree_stand) for supported features.
+
 ## Usage
 
 ### Setting Up a Parser

data/lib/tree_stand/node.rb

@@ -9,6 +9,11 @@ module TreeStand
 
     def_delegators :@ts_node, :type, :start_byte, :end_byte, :start_point, :end_point
 
+    # @return [TreeStand::Tree]
+    attr_reader :tree
+    # @return [TreeSitter::Node]
+    attr_reader :ts_node
+
     # @api private
     def initialize(tree, ts_node)
       @tree = tree

data/lib/tree_stand/version.rb

@@ -1,4 +1,4 @@
 module TreeStand
   # The current version of the gem.
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/tree_stand.gemspec

@@ -12,11 +12,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/Shopify/tree_stand"
   spec.license       = "MIT"
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => spec.homepage,
+    "documentation_uri" => "https://shopify.github.io/tree_stand",
+  }
 
   # 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.
@@ -29,8 +31,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "zeitwerk"
 
-  spec.add_development_dependency "bundler", "~> 2.3"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-focus"
   spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tree_stand
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - derekstride
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -28,30 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: minitest-focus
+  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: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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'
 description: 
 email:
 - derek@stride.host
@@ -90,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".github/workflows/cla.yml"
+- ".github/workflows/publish_docs.yml"
 - ".gitignore"
 - ".shopify-build/VERSION"
 - ".shopify-build/tree-stand-publish-package.yml"
@@ -124,6 +167,7 @@ metadata:
   homepage_uri: https://github.com/Shopify/tree_stand
   source_code_uri: https://github.com/Shopify/tree_stand
   changelog_uri: https://github.com/Shopify/tree_stand
+  documentation_uri: https://shopify.github.io/tree_stand
 post_install_message: 
 rdoc_options: []
 require_paths: