Rename the package (#5)

Author: eliascarv

Project.toml

@@ -1,4 +1,4 @@
-name = "TreeDataStructures"
+name = "BinaryTrees"
 uuid = "289e92be-c05a-437b-9e67-5b0c799891f8"
 authors = ["Elias Carvalho <[email protected]> and contributors"]
 version = "0.1.0"

README.md

@@ -1,21 +1,21 @@
-# TreeDataStructures.jl
+# BinaryTrees.jl
 
-[![Build Status](https://github.com/eliascarv/TreeDataStructures.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/eliascarv/TreeDataStructures.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/eliascarv/TreeDataStructures.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/eliascarv/TreeDataStructures.jl)
+[![Build Status](https://github.com/eliascarv/BinaryTrees.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/eliascarv/BinaryTrees.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/eliascarv/BinaryTrees.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/eliascarv/BinaryTrees.jl)
 
 ## Overview
 
-This package provides a collection of tree data structures implemented in Julia. 
+This package provides a collection of binary trees implemented in Julia. 
 
-Currently, it includes the following tree data structures:
+Currently, it includes the following binary trees:
 * **AVL Tree**: A self-balancing binary search tree.
 
 ## Installation
 
-To install TreeDataStructures.jl, use the Julia's package manager:
+To install BinaryTrees.jl, use the Julia's package manager:
 
 ```
-] add https://github.com/eliascarv/TreeDataStructures.jl
+] add https://github.com/eliascarv/BinaryTrees.jl
 ```
 
 ## AVL Tree

src/TreeDataStructures.jl renamed to src/BinaryTrees.jl

@@ -1,4 +1,4 @@
-module TreeDataStructures
+module BinaryTrees
 
 import AbstractTrees
 

src/avl.jl

@@ -27,8 +27,6 @@ function AbstractTrees.children(node::AVLNode)
   end
 end
 
-AbstractTrees.nodevalue(node::AVLNode) = node.value
-
 AbstractTrees.NodeType(::Type{<:AVLNode}) = AbstractTrees.HasNodeType()
 AbstractTrees.nodetype(T::Type{<:AVLNode}) = T
 
@@ -126,7 +124,7 @@ function Base.show(io::IO, ::MIME"text/plain", tree::AVLTree)
   else
     println(io, "AVLTree")
     str = AbstractTrees.repr_tree(tree.root, context=io)
-    print(io, str[begin:(end - 1)]) # remove \n at end
+    print(io, rstrip(str)) # remove \n at end
   end
 end
 

test/runtests.jl

@@ -1,8 +1,8 @@
-using TreeDataStructures
+using BinaryTrees
 using AbstractTrees
 using Test
 
-@testset "TreeDataStructures.jl" begin
+@testset "BinaryTrees.jl" begin
   @testset "AVLTree" begin
     # insert
     tree = AVLTree{Int,Int}()
@@ -179,19 +179,14 @@ using Test
     tree[4] = 40
     tree[1] = 10
     tree[5] = 50
-    root = tree.root
-    @test children(root) === (root.left, root.right)
-    @test children(root.left) === (root.left.left,)
-    @test children(root.right) === (root.right.right,)
-    @test children(root.left.left) === ()
-    @test children(root.right.right) === ()
-    @test nodevalue(root) == 30
-    @test nodevalue(root.left) == 20
-    @test nodevalue(root.right) == 40
-    @test nodevalue(root.left.left) == 10
-    @test nodevalue(root.right.right) == 50
-    @test NodeType(root) === HasNodeType()
-    @test nodetype(root) === typeof(root)
+    @test children(tree.root) === (tree.root.left, tree.root.right)
+    @test children(tree.root.left) === (tree.root.left.left,)
+    @test children(tree.root.right) === (tree.root.right.right,)
+    @test children(tree.root.left.left) === ()
+    @test children(tree.root.right.right) === ()
+    @test nodevalue(tree.root) === tree.root
+    @test NodeType(tree.root) === HasNodeType()
+    @test nodetype(tree.root) === typeof(tree.root)
 
     # show
     tree = AVLTree{Int,Int}()