bruv 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eca092238ec4bfc036555e83d48dceee434b436e
-  data.tar.gz: 53c94cc89ab4bfe96674efe1b7493538c2856a3b
+  metadata.gz: bfc7b872f4ef813b3774c0f2c01a05d366da170c
+  data.tar.gz: 63c914799df3ea299d29345853884e2feae9bcce
 SHA512:
-  metadata.gz: 5d5d51c491b47bb11e1135b773b2f4f9e040856dc553d1b3f9dcea19c83d16330adc9ddcf197a0cfc7e5516d0503a4b3a3c6eeca89d53eafc228da9e37d3d934
-  data.tar.gz: d7eb67646a4dfe9a3d0c5be9064bab9c18f1d543bb9534fee056e799c4b5833f39a2ebceb7a7468bcfaa225f2db99259459a6efe5f8d4877bfeef6e8d99007b3
+  metadata.gz: 557b116006f221ba2685ac502adacacb510fdd8308db167c02d96529e0824debf7a129d7c4e73819d9cde3cc915712815120d33c0a9b03b312d69b03b6dbb89c
+  data.tar.gz: 4acdefdd914e009e8b03edf8766e14c5f886bf2db91ef1c9aaf86efd4c003deb68448fd8c1484e2fdd6ed6bdb0584c0ad51b35798772bf8dfd6ee8ad2dc14ebb

data/lib/bruv.rb

@@ -1,31 +1,74 @@
 require "bruv/version"
 
+# Module adding Bruv.attribute and Bruv.attributes helper methods.
+# It adds an initializer method which sets values for defined attributes
+# and perform additional conversions if specified.
+#
+# @example
+#   class MyClass
+#     include Bruv
+#     attribute :price, ->(ci) { Float(ci) }
+#     attributes :age, :type
+#   end
+#
+#   mc = MyClass.new("123", 100, :user)
+#   mc.first_name # => 123.00
+#   mc.age        # => 100
+#   mc.type       # => :user
+#
 module Bruv
   class BruvArgumentError < ArgumentError; end
 
   def self.included(obj)
     obj.class_eval do
+      # Array of registered attribute names.
       @instance_variables = []
+
+      # Hash of procs for registered attributes.
       @procs = {}
 
+      # Getter for @instance_variables
+      # @return [Array]
       def self.instance_variables
         @instance_variables
       end
 
+      # Getter for @procs
+      # @return [Hash]
       def self.procs
         @procs
       end
 
+      # Appends single variable name to {instance_variables} and if mproc
+      # is passed it adds it to {procs}.
+      # @param name [#to_sym] Name of the variable to be defined.
+      # @param mproc [#call] Proc called in the #initialize method
+      #   which can perform additional value conversions
+      # @return [Hash]
+      # @example
+      #   attribute :tag, ->(t) { t.downcase }
+      #   attribute :code, ->(c) { { a: 123, b: 321 }.fetch(c) }
       def self.attribute(name, mproc = nil)
         mname = name.to_sym
         instance_variables << mname
         procs[mname] = mproc
       end
 
+      # Appends multiple variable names to {instance_variables}
+      # @param *names [Array<#to_sym>] Array of names, each name variable should
+      #   respond to #to_sym
+      # @return [Array]
+      # @example
+      #   attributes :first_name, :last_name
       def self.attributes(*names)
         @instance_variables += names.map(&:to_sym)
       end
 
+      # Defines getter methods for each attribute in {instance_variables},
+      # and calls a proc for an attribute if it was registered.
+      # @note Attributes are defined in order in which they were registered.
+      # @param *args [Array] Array of attribute values.
+      # @raise [BruvArgumentError] when more values are passed that registered attributes.
       def initialize(*args)
         raise_argument_error if args.size > self.class.instance_variables.size
         self.class.instance_variables.each_with_index do |var, index|
@@ -37,9 +80,10 @@ module Bruv
 
       private
 
+      # Prepares Error message
       def raise_argument_error
-        message = "Number of arguments exceeds number of instance variables for: #{self.class.name}"
-        raise BruvArgumentError, message
+        message = "Number of arguments exceeds number of instance variables for:"
+        raise BruvArgumentError, "#{message} #{self.class.name}"
       end
     end
   end

data/lib/bruv/version.rb

@@ -1,3 +1,3 @@
 module Bruv
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bruv
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - smnkrt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler