rename ZeroDimensionalArrayImmutable to ZeroDimArray (#16)

Fixes #7

Author: nsajko

README.md

@@ -9,7 +9,7 @@
 A small software package for the Julia programming language providing zero-dimensional array types. `Ref`-killer.
 
 Exports three zero-dimensional subtypes of `AbstractArray`:
-* `ZeroDimensionalArrayImmutable`
+* `ZeroDimArray`
     * declared with `struct`, not with `mutable struct`
     * does not support `setfield!`, or mutating the element otherwise
     * `isbits` when the element is `isbits`
@@ -45,11 +45,11 @@ The motivation for creating this package is:
         * https://github.com/JuliaLang/julia/issues/40369
         * https://discourse.julialang.org/t/dynamic-immutable-type/127168
 * to provide a wrapper type for treating a value as a scalar in broadcasting, something `Ref` is often used for:
-    * `ZeroDimensionalArrayImmutable` can be a good replacement:
+    * `ZeroDimArray` can be a good replacement:
       ```julia-repl
       julia> using ZeroDimensionalArrays
 
-      julia> isa.(ZeroDimensionalArrayImmutable([1,2,3]), [Array, Dict, Int])
+      julia> isa.(ZeroDimArray([1,2,3]), [Array, Dict, Int])
       3-element BitVector:
        1
        0

src/ZeroDimensionalArrays.jl

@@ -1,11 +1,11 @@
 module ZeroDimensionalArrays
 
 export
-    ZeroDimensionalArrayImmutable,
+    ZeroDimArray,
     Box,
     BoxConstField
 
-struct ZeroDimensionalArrayImmutable{T} <: AbstractArray{T, 0}
+struct ZeroDimArray{T} <: AbstractArray{T, 0}
     v::T
     global function new_zero_dimensional_array_immutable(::Type{T}, v) where {T}
         new{T}(v)
@@ -30,13 +30,13 @@ mutable struct BoxConstField{T} <: AbstractArray{T, 0}
 end
 
 const ZeroDimensionalArray = Union{
-    ZeroDimensionalArrayImmutable,
+    ZeroDimArray,
     Box,
     BoxConstField,
 }
 
 function type_to_constructor_function(::Type{T}) where {T <: ZeroDimensionalArray}
-    if T <: ZeroDimensionalArrayImmutable
+    if T <: ZeroDimArray
         new_zero_dimensional_array_immutable
     elseif T <: Box
         new_zero_dimensional_array_mutable
@@ -100,7 +100,7 @@ function convert_from_other_array(::Type{Arr}, a::AbstractArray{<:Any, 0}) where
 end
 
 for Arr ∈ (
-    ZeroDimensionalArrayImmutable,
+    ZeroDimArray,
     Box,
     BoxConstField,
 )

test/runtests.jl

@@ -9,7 +9,7 @@ using Aqua: Aqua
 
     @testset "all array types joined" begin
         for Arr ∈ (
-            ZeroDimensionalArrayImmutable,
+            ZeroDimArray,
             Box,
             BoxConstField,
         )
@@ -37,10 +37,10 @@ using Aqua: Aqua
     end
 
     @testset "each array type on its own" begin
-        @testset "`ZeroDimensionalArrayImmutable`" begin
-            @test @isdefined ZeroDimensionalArrayImmutable
-            @test !ismutabletype(ZeroDimensionalArrayImmutable)
-            @test isbitstype(ZeroDimensionalArrayImmutable{Float64})
+        @testset "`ZeroDimArray`" begin
+            @test @isdefined ZeroDimArray
+            @test !ismutabletype(ZeroDimArray)
+            @test isbitstype(ZeroDimArray{Float64})
         end
         @testset "`Box`" begin
             @test @isdefined Box