Merge pull request #31 from Herb-AI/feat/anti-piracy

Address Aqua type piracy errors

Project.toml

@@ -1,13 +1,11 @@
 name = "HerbCore"
 uuid = "2b23ba43-8213-43cb-b5ea-38c12b45bd45"
 authors = ["Jaap de Jong <[email protected]>", "Nicolae Filat <[email protected]>", "Tilman Hinnerichs <[email protected]>", "Sebastijan Dumancic <[email protected]>"]
-version = "0.3.2"
+version = "0.3.3"
+
+[deps]
+AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
 
 [compat]
+AbstractTrees = "0.4.5"
 julia = "^1.8"
-
-[extras]
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-
-[targets]
-test = ["Test"]

src/HerbCore.jl

@@ -1,8 +1,10 @@
 module HerbCore
 
+using AbstractTrees
+
+include("grammar.jl")
 include("rulenode.jl")
 include("constraint.jl")
-include("grammar.jl")
 
 export
        AbstractRuleNode,

src/grammar.jl

@@ -19,3 +19,11 @@ If the grammar is non-probabilistic, the list can be `nothing`.
 For concrete types, see `ContextSensitiveGrammar` within the `HerbGrammar` module.
 """
 abstract type AbstractGrammar end
+
+function Base.show(io::IO, grammar::AbstractGrammar)
+    for i in eachindex(grammar.rules)
+        println(io, i, ": ", grammar.types[i], " = ", grammar.rules[i])
+    end
+end
+
+Base.getindex(grammar::AbstractGrammar, typ::Symbol) = grammar.bytype[typ]

src/rulenode.jl

@@ -16,6 +16,10 @@ Expression trees consist of [`RuleNode`](@ref)s and [`AbstractHole`](@ref)s.
 """
 abstract type AbstractRuleNode end
 
+# Interface to AbstractTrees.jl
+AbstractTrees.children(node::AbstractRuleNode) = get_children(node)
+AbstractTrees.nodevalue(node::AbstractRuleNode) = get_rule(node)
+
 """
     RuleNode <: AbstractRuleNode
 

test/Project.toml

@@ -0,0 +1,4 @@
+[deps]
+AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

test/runtests.jl

@@ -1,7 +1,19 @@
+using AbstractTrees: children, nodevalue, treeheight
+using Aqua
 using HerbCore
 using Test
 
 @testset "HerbCore.jl" verbose=true begin
+    @testset "Aqua Tests" Aqua.test_all(HerbCore)
+
+    @testset "AbstractTrees Interface" begin
+        @test nodevalue(RuleNode(1)) == 1
+        @test isempty(children(RuleNode(1)))
+        @test length(children(RuleNode(1, [RuleNode(2), RuleNode(2)]))) == 2
+        @test treeheight(RuleNode(1)) == 0
+        @test treeheight(RuleNode(1, [RuleNode(2), RuleNode(2)])) == 1
+    end
+
     @testset "RuleNode tests" begin
         @testset "Equality tests" begin
             @test RuleNode(1) == RuleNode(1)
@@ -335,4 +347,27 @@ using Test
                   "12{14,2{4{hole[Bool[1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]]}},2{4{6}}}"
         end
     end
+
+    @testset "Grammar" begin
+        struct ExGrammar <: AbstractGrammar
+            rules::Vector{Any}
+            types::Vector{Symbol}
+            bytype::Dict{Symbol, Vector{Int}}
+            # ...
+            # only partially implementing the AbstractGrammar interface
+            # to test the Base.show
+        end
+
+        g = ExGrammar([1], [:A], Dict([:A => [1]]))
+
+        @testset "show" begin
+            io = IOBuffer()
+            Base.show(io, g)
+            @test String(take!(io)) == "1: A = 1\n"
+        end
+
+        @testset "get_index" begin
+            @test g[:A] == [1]
+        end
+    end
 end