wrapper.rb in arstotzka-1.0.2

- old
+ new
@@ -1,36 +1,61 @@
-class Arstotzka::Wrapper
-  include Arstotzka::TypeCast
+# frozen_string_literal: true
 
-  attr_reader :clazz, :type
+module Arstotzka
+  # Class responsible for wrapping / parsing a value fetched
+  class Wrapper
+    include Arstotzka::TypeCast
 
-  def initialize(clazz: nil, type: nil)
-    @clazz = clazz
-    @type = type
-  end
+    # @param clazz [Class] class to wrap the value
+    # @param type [String/Symbol] type to cast the value. The
+    #   possible type_cast is defined by {TypeCast}
+    def initialize(clazz: nil, type: nil)
+      @clazz = clazz
+      @type = type
+    end
 
-  def wrap(value)
-    return wrap_array(value) if value.is_a?(Array)
-    wrap_element(value)
-  end
+    # wrap a value
+    #
+    # @example
+    #   class Person
+    #     attr_reader :name
+    #
+    #     def initialize(name)
+    #       @name = name
+    #     end
+    #   end
+    #
+    #   wrapper = Arstotzka::Wrapper.new(clazz: Person)
+    #   wrapper.wrap('John') # retruns Person.new('John')
+    #
+    # @example
+    #   wrapper = Arstotzka::Wrapper.new(type: :integer)
+    #   wrapper.wrap(['10', '20', '30']) # retruns [10, 20, 30]
+    def wrap(value)
+      return wrap_array(value) if value.is_a?(Array)
+      wrap_element(value)
+    end
 
-  private
+    private
 
-  def wrap_element(value)
-    value = cast(value) if has_type? && !value.nil?
-    return if value.nil?
+    attr_reader :clazz, :type
 
-    clazz ? clazz.new(value) : value
-  end
+    def wrap_element(value)
+      value = cast(value) if type? && !value.nil?
+      return if value.nil?
 
-  def wrap_array(array)
-    array.map { |v| wrap v }
-  end
+      clazz ? clazz.new(value) : value
+    end
 
-  def has_type?
-    type.present? && type != :none
-  end
+    def wrap_array(array)
+      array.map { |v| wrap v }
+    end
 
-  def cast(value)
-    public_send("to_#{type}", value)
+    def type?
+      type.present? && type != :none
+    end
+
+    def cast(value)
+      public_send("to_#{type}", value)
+    end
   end
 end