Small cleanup

milmazz · milmazz · commit 26e85467fcbc · 2018-09-18T21:09:48.000-05:00
* Added a few typespecs
* Removed commented code
* Promote implicit try. But I think that using
{:ok, value} | {:error, reason} would be a lot better.
diff --git a/lib/scenic/component/input/caret.ex b/lib/scenic/component/input/caret.ex
@@ -5,15 +5,16 @@
 
 defmodule Scenic.Component.Input.Caret do
   use Scenic.Component, has_children: false
-  alias Scenic.Graph
-  alias Scenic.Primitive.Style.Paint.Color
 
   import Scenic.Primitives,
     only: [
       {:line, 3},
       {:update_opts, 2}
     ]
 
+  alias Scenic.Graph
+  alias Scenic.Primitive.Style.Paint.Color
+
   @width 2
   @inset_v 4
 
@@ -34,6 +35,7 @@ defmodule Scenic.Component.Input.Caret do
   end
 
   # --------------------------------------------------------
+  @spec verify(any()) :: :invalid_data | {:ok, {number(), any()}}
   def verify({height, color} = data)
       when is_number(height) and height > 0 do
     case Color.verify(color) do
diff --git a/lib/scenic/math/matrix.ex b/lib/scenic/math/matrix.ex
@@ -25,15 +25,16 @@ defmodule Scenic.Math.Matrix do
   #  import IEx
 
   @app Mix.Project.config()[:app]
-  # @env Mix.env
 
   # load the NIF
   @compile {:autoload, false}
   @on_load :load_nifs
   @doc false
   def load_nifs do
     :ok =
-      :filename.join(:code.priv_dir(@app), 'matrix')
+      @app
+      |> :code.priv_dir()
+      |> :filename.join('matrix')
       |> :erlang.load_nif(0)
   end
 
diff --git a/lib/scenic/primitive/arc.ex b/lib/scenic/primitive/arc.ex
@@ -8,9 +8,6 @@ defmodule Scenic.Primitive.Arc do
   alias Scenic.Primitive.Sector
   alias Scenic.Primitive.Triangle
 
-  # alias Scenic.Primitive
-  #  alias Scenic.Primitive.Style
-
   @styles [:hidden, :fill, :stroke]
 
   # ============================================================================
@@ -26,20 +23,20 @@ defmodule Scenic.Primitive.Arc do
 
   # --------------------------------------------------------
   def verify(data) do
-    try do
-      normalize(data)
-      {:ok, data}
-    rescue
-      _ -> :invalid_data
-    end
+    normalize(data)
+    {:ok, data}
+  rescue
+    _ -> :invalid_data
   end
 
   # --------------------------------------------------------
+  @spec normalize({number(), number(), number()}) :: {number(), number(), number()}
   def normalize({radius, start, finish} = data)
       when is_number(start) and is_number(finish) and is_number(radius),
       do: data
 
   # ============================================================================
+  @spec valid_styles() :: [:fill | :hidden | :stroke]
   def valid_styles(), do: @styles
 
   # --------------------------------------------------------
diff --git a/lib/scenic/primitive/circle.ex b/lib/scenic/primitive/circle.ex
@@ -6,9 +6,6 @@
 defmodule Scenic.Primitive.Circle do
   use Scenic.Primitive
 
-  # alias Scenic.Primitive
-  #  alias Scenic.Primitive.Style
-
   @styles [:hidden, :fill, :stroke]
 
   # ============================================================================
@@ -24,20 +21,20 @@ defmodule Scenic.Primitive.Circle do
 
   # --------------------------------------------------------
   def verify(data) do
-    try do
-      normalize(data)
-      {:ok, data}
-    rescue
-      _ -> :invalid_data
-    end
+    normalize(data)
+    {:ok, data}
+  rescue
+    _ -> :invalid_data
   end
 
   # --------------------------------------------------------
+  @spec normalize(number()) :: number()
   def normalize(radius) when is_number(radius) do
     radius
   end
 
   # ============================================================================
+  @spec valid_styles() :: [:hidden | :fill | :stroke]
   def valid_styles(), do: @styles
 
   # --------------------------------------------------------
diff --git a/lib/scenic/primitive/ellipse.ex b/lib/scenic/primitive/ellipse.ex
@@ -6,9 +6,6 @@
 defmodule Scenic.Primitive.Ellipse do
   use Scenic.Primitive
 
-  # alias Scenic.Primitive
-  #  alias Scenic.Primitive.Style
-
   @styles [:hidden, :fill, :stroke]
 
   # ============================================================================
@@ -24,20 +21,20 @@ defmodule Scenic.Primitive.Ellipse do
 
   # --------------------------------------------------------
   def verify(data) do
-    try do
-      normalize(data)
-      {:ok, data}
-    rescue
-      _ -> :invalid_data
-    end
+    normalize(data)
+    {:ok, data}
+  rescue
+    _ -> :invalid_data
   end
 
   # --------------------------------------------------------
+  @spec normalize({number(), number()}) :: {number(), number()}
   def normalize({r1, r2} = data) when is_number(r1) and is_number(r2) do
     data
   end
 
   # ============================================================================
+  @spec valid_styles() :: [:fill | :hidden | :stroke, ...]
   def valid_styles(), do: @styles
 
   # --------------------------------------------------------
diff --git a/lib/scenic/primitive/group.ex b/lib/scenic/primitive/group.ex
@@ -6,7 +6,6 @@
 defmodule Scenic.Primitive.Group do
   use Scenic.Primitive
   alias Scenic.Primitive
-  #  alias Scenic.Graph
 
   #  import IEx
 
@@ -42,7 +41,9 @@ defmodule Scenic.Primitive.Group do
   # ============================================================================
   # filter and gather styles
 
+  @spec valid_styles() :: [:all, ...]
   def valid_styles(), do: [:all]
+
   def filter_styles(styles) when is_map(styles), do: styles
 
   # ============================================================================
diff --git a/lib/scenic/primitive/line.ex b/lib/scenic/primitive/line.ex
@@ -5,8 +5,6 @@
 
 defmodule Scenic.Primitive.Line do
   use Scenic.Primitive
-  #  alias Scenic.Primitive
-  #  alias Scenic.Primitive.Style
 
   #  import IEx
 
@@ -31,6 +29,7 @@ defmodule Scenic.Primitive.Line do
   def verify(_), do: :invalid_data
 
   # ============================================================================
+  @spec valid_styles() :: [:cap | :hidden | :stroke, ...]
   def valid_styles(), do: @styles
 
   # ============================================================================
diff --git a/lib/scenic/primitive/path.ex b/lib/scenic/primitive/path.ex
@@ -5,8 +5,6 @@
 
 defmodule Scenic.Primitive.Path do
   use Scenic.Primitive
-  #  alias Scenic.Primitive
-  #  alias Scenic.Primitive.Style
 
   #  import IEx
 
@@ -68,6 +66,7 @@ defmodule Scenic.Primitive.Path do
   defp verify_action(_), do: false
 
   # ============================================================================
+  @spec valid_styles() :: [:fill | :hidden | :stroke, ...]
   def valid_styles(), do: @styles
 
   # ============================================================================
diff --git a/lib/scenic/primitive/quad.ex b/lib/scenic/primitive/quad.ex
@@ -26,10 +26,6 @@ defmodule Scenic.Primitive.Quad do
   def verify({{x0, y0}, {x1, y1}, {x2, y2}, {x3, y3}} = data)
       when is_number(x0) and is_number(y0) and is_number(x1) and is_number(y1) and is_number(x2) and
              is_number(y2) and is_number(x3) and is_number(y3) do
-    # case Math.Quad.classification(data) == :convex do
-    #   true -> {:ok, data}
-    #   false -> :invalid_data
-    # end
     {:ok, data}
   end
 
diff --git a/lib/scenic/primitive/rectangle.ex b/lib/scenic/primitive/rectangle.ex
@@ -6,9 +6,6 @@
 defmodule Scenic.Primitive.Rectangle do
   use Scenic.Primitive
 
-  # alias Scenic.Primitive
-  #  alias Scenic.Primitive.Style
-
   @styles [:hidden, :fill, :stroke]
 
   # ============================================================================
@@ -30,6 +27,7 @@ defmodule Scenic.Primitive.Rectangle do
   def verify(_), do: :invalid_data
 
   # ============================================================================
+  @spec valid_styles() :: [:fill | :hidden | :stroke, ...]
   def valid_styles(), do: @styles
 
   # --------------------------------------------------------
diff --git a/lib/scenic/primitive/rounded_rectangle.ex b/lib/scenic/primitive/rounded_rectangle.ex
@@ -25,12 +25,10 @@ defmodule Scenic.Primitive.RoundedRectangle do
 
   # --------------------------------------------------------
   def verify(data) do
-    try do
-      normalize(data)
-      {:ok, data}
-    rescue
-      _ -> :invalid_data
-    end
+    normalize(data)
+    {:ok, data}
+  rescue
+    _ -> :invalid_data
   end
 
   # --------------------------------------------------------
@@ -61,6 +59,7 @@ defmodule Scenic.Primitive.RoundedRectangle do
   end
 
   # ============================================================================
+  @spec valid_styles() :: [:fill | :hidden | :stroke, ...]
   def valid_styles(), do: @styles
 
   # --------------------------------------------------------
diff --git a/lib/scenic/primitive/scene_ref.ex b/lib/scenic/primitive/scene_ref.ex
@@ -29,6 +29,8 @@ defmodule Scenic.Primitive.SceneRef do
   # ============================================================================
   # filter and gather styles
 
+  @spec valid_styles() :: [:all, ...]
   def valid_styles(), do: [:all]
+
   def filter_styles(styles) when is_map(styles), do: styles
 end
diff --git a/lib/scenic/primitive/sector.ex b/lib/scenic/primitive/sector.ex
@@ -6,9 +6,6 @@
 defmodule Scenic.Primitive.Sector do
   use Scenic.Primitive
 
-  # alias Scenic.Primitive
-  #  alias Scenic.Primitive.Style
-
   # import IEx
 
   @styles [:hidden, :fill, :stroke]
@@ -26,20 +23,20 @@ defmodule Scenic.Primitive.Sector do
 
   # --------------------------------------------------------
   def verify(data) do
-    try do
-      normalize(data)
-      {:ok, data}
-    rescue
-      _ -> :invalid_data
-    end
+    normalize(data)
+    {:ok, data}
+  rescue
+    _ -> :invalid_data
   end
 
   # --------------------------------------------------------
+  @spec normalize({number(), number(), number()}) :: {number(), number(), number()}
   def normalize({radius, start, finish} = data)
       when is_number(start) and is_number(finish) and is_number(radius),
       do: data
 
   # ============================================================================
+  @spec valid_styles() :: [:fill | :hidden | :stroke, ...]
   def valid_styles(), do: @styles
 
   # --------------------------------------------------------
diff --git a/lib/scenic/primitive/text.ex b/lib/scenic/primitive/text.ex
@@ -5,8 +5,6 @@
 
 defmodule Scenic.Primitive.Text do
   use Scenic.Primitive
-  # alias Scenic.Primitive
-  #  alias Scenic.Primitive.Style
 
   @styles [:hidden, :fill, :font, :font_size, :font_blur, :text_align, :text_height]
 
@@ -22,9 +20,14 @@ defmodule Scenic.Primitive.Text do
     """
 
   # --------------------------------------------------------
+  @spec verify(any()) :: :invalid_data | {:ok, bitstring()}
   def verify(text) when is_bitstring(text), do: {:ok, text}
   def verify(_), do: :invalid_data
 
   # ============================================================================
+  @spec valid_styles() :: [
+          :fill | :font | :font_blur | :font_size | :hidden | :text_align | :text_height,
+          ...
+        ]
   def valid_styles(), do: @styles
 end
diff --git a/lib/scenic/primitive/transform/pin.ex b/lib/scenic/primitive/transform/pin.ex
@@ -19,15 +19,14 @@ defmodule Scenic.Primitive.Transform.Pin do
 
   # --------------------------------------------------------
   def verify(percent) do
-    try do
-      normalize(percent)
-      true
-    rescue
-      _ -> false
-    end
+    normalize(percent)
+    true
+  rescue
+    _ -> false
   end
 
   # --------------------------------------------------------
   # normalize named stipples
+  @spec normalize({number(), number()}) :: {number(), number()}
   def normalize({x, y}) when is_number(x) and is_number(y), do: {x, y}
 end
diff --git a/lib/scenic/primitive/transform/rotate.ex b/lib/scenic/primitive/transform/rotate.ex
@@ -22,15 +22,14 @@ defmodule Scenic.Primitive.Transform.Rotate do
 
   # --------------------------------------------------------
   def verify(angle) do
-    try do
-      normalize(angle)
-      true
-    rescue
-      _ -> false
-    end
+    normalize(angle)
+    true
+  rescue
+    _ -> false
   end
 
   # --------------------------------------------------------
   # normalize named stipples
+  @spec normalize(number()) :: number()
   def normalize(a) when is_number(a), do: a
 end
diff --git a/lib/scenic/primitive/transform/scale.ex b/lib/scenic/primitive/transform/scale.ex
@@ -26,16 +26,15 @@ defmodule Scenic.Primitive.Transform.Scale do
 
   # --------------------------------------------------------
   def verify(percent) do
-    try do
-      normalize(percent)
-      true
-    rescue
-      _ -> false
-    end
+    normalize(percent)
+    true
+  rescue
+    _ -> false
   end
 
   # --------------------------------------------------------
   # normalize named stipples
+  @spec normalize(number() | {number(), number()}) :: {number(), number()}
   def normalize(pct) when is_number(pct), do: {pct, pct}
   def normalize({px, py}) when is_number(px) and is_number(py), do: {px, py}
 end
diff --git a/lib/scenic/primitive/transform/translate.ex b/lib/scenic/primitive/transform/translate.ex
diff --git a/lib/scenic/primitive/triangle.ex b/lib/scenic/primitive/triangle.ex
