add snakecase helper and human_name default

Author: ablaom

src/StatisticalTraits.jl

@@ -21,6 +21,7 @@ const TRAITS = [
     :supports_online,
     :docstring,
     :name,
+    :human_name,
     :is_supervised,
     :prediction_type,
     :hyperparameters,
@@ -60,6 +61,40 @@ function typename(M)
     end
 end
 
+function is_uppercase(char::Char)
+    i = Int(char)
+    i > 64 && i < 91
+end
+
+"""
+    snakecase(str, del='_')
+
+Return the snake case version of the abstract string or symbol, `str`, as in
+
+    snakecase("TheLASERBeam") == "the_laser_beam"
+
+"""
+function snakecase(str::AbstractString; delim='_')
+    snake = Char[]
+    n = length(str)
+    for i in eachindex(str)
+        char = str[i]
+        if is_uppercase(char)
+            if i != 1 && i < n &&
+                !(is_uppercase(str[i + 1]) && is_uppercase(str[i - 1]))
+                push!(snake, delim)
+            end
+            push!(snake, lowercase(char))
+        else
+            push!(snake, char)
+        end
+    end
+    return join(snake)
+end
+
+snakecase(s::Symbol) = Symbol(snakecase(string(s)))
+
+
 
 ## TRAITS
 
@@ -96,10 +131,12 @@ prediction_type(::Type)        = :unknown # used for measures too
 
 # Miscellaneous:
 
-is_wrapper(::Type)             = false     # or `true`
-supports_online(::Type)        = false     # or `true`
-docstring(M::Type)             = string(M) # some `String`
-is_supervised(::Type)          = false     # or `true`
+is_wrapper(::Type)        = false     # or `true`
+supports_online(::Type)   = false     # or `true`
+docstring(M::Type)        = string(M) # some `String`
+is_supervised(::Type)     = false     # or `true`
+human_name(M::Type)       = snakecase(name(M), delim=' ') # `name` defined below
+
 
 # Returns a tuple, with one entry per field of `T` (the type of some
 # statistical model, for example). Each entry is `nothing` or defines

test/runtests.jl

@@ -5,7 +5,7 @@ import SparseArrays
 
 module Fruit
 
-struct Apple end
+struct RedApple end
 
 end
 
@@ -17,11 +17,19 @@ import .Fruit
 @testset "typename" begin
     @test StatisticalTraits.typename(Nothing) == :Nothing
     @test StatisticalTraits.typename(UnionAll) == :UnionAll
-    @test StatisticalTraits.typename(Union{Char,Int}) == Symbol("Union{Char, Int64}")
+    @test StatisticalTraits.typename(Union{Char,Int}) ==
+        Symbol("Union{Char, Int64}")
     T = SparseArrays.sparse([1,2], [1,3], [0.5, 0.6]) |> typeof
     @test StatisticalTraits.typename(T) == :SparseMatrixCSC
 end
 
+@testset "snakecase" begin
+    @test StatisticalTraits.snakecase("AnthonyBlaomsPetElk") ==
+        "anthony_blaoms_pet_elk"
+    @test StatisticalTraits.snakecase("TheLASERBeam", delim=' ') ==
+        "the laser beam"
+end
+
 
 ## TRAITS WITH NON-CONSTANT FALL-BACK
 
@@ -32,28 +40,34 @@ end
 
 @testset "docstring" begin
     @test docstring(Foo(1,'x')) == "Foo"
-    @test docstring(Fruit.Apple()) == "Main.Fruit.Apple"
+    @test docstring(Fruit.RedApple()) == "Main.Fruit.RedApple"
 end
 
 @testset "hyperparameter_ranges" begin
     @test hyperparameter_ranges(Foo(1, 'x')) == (nothing, nothing)
-    @test hyperparameter_ranges(Fruit.Apple()) == ()
+    @test hyperparameter_ranges(Fruit.RedApple()) == ()
 end
 
 @testset "name" begin
     @test name(Float64) == "Float64"
-    @test name(Fruit.Apple) == "Apple"
-    @test name(Fruit.Apple()) == "Apple"
+    @test name(Fruit.RedApple) == "RedApple"
+    @test name(Fruit.RedApple()) == "RedApple"
+end
+
+@testset "human_name" begin
+    @test human_name(AbstractString) == "abstract string"
+    @test human_name(Fruit.RedApple) == "red apple"
+    @test human_name(Fruit.RedApple()) == "red apple"
 end
 
 @testset "hyperparameters" begin
     @test hyperparameters(Foo(1, 'x')) == (:x, :y)
-    @test hyperparameters(Fruit.Apple()) == ()
+    @test hyperparameters(Fruit.RedApple()) == ()
 end
 
 @testset "hyperparameter_types" begin
     @test hyperparameter_types(Foo(1, 'x')) == ("Int64", "Char")
-    @test hyperparameter_types(Fruit.Apple()) == ()
+    @test hyperparameter_types(Fruit.RedApple()) == ()
 end
 
 
@@ -62,13 +76,14 @@ end
 const NONCONSTANT = [:docstring,
                      :hyperparameter_ranges,
                      :name,
+                     :human_name,
                      :hyperparameters,
                      :hyperparameter_types]
 
 @testset "traits with constant fall-back" begin
     for trait in setdiff(StatisticalTraits.TRAITS, NONCONSTANT)
         ex = quote
-            @test $trait(Fruit.Apple()) == $trait(Foo(1, 'x'))
+            @test $trait(Fruit.RedApple()) == $trait(Foo(1, 'x'))
         end
         Main.eval(ex)
     end