creatable 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3f68612a079b4a7fd1cde02086d26ee91f4006b
-  data.tar.gz: ccdf89aaac1f988e84f63183af4c43ed05cbc711
+  metadata.gz: 2c83e3f19290c6508f5dd3440c16c4153ecdab7d
+  data.tar.gz: d676eae79e326cf161399f709ec4e65edcb356f0
 SHA512:
-  metadata.gz: a651ef82b80b066b7c390f6fa1b68fb4563fab374f6b256116f0f2f93242cb2aa8ef4208960258199bf9f19e727eb76e18a77f62db474aafda45bd9d67fe86a7
-  data.tar.gz: 10b25e036b87828ed0f5833953607c8716a1113e72eb6c9f041a62e98bb4daebe0a5002f8ea9dec2b4e41a54a660a4f2343688b95431cefca9ceb76fbf5e6902
+  metadata.gz: 72cefaad2c05643ff0a09a72151bb5d726b8b751483e1581c8dbe27a4efa1432130b151c856e1a461f48d84e431cc5ad86c3a6f59a9904f117947201b3e32e11
+  data.tar.gz: e897d53dc78f7ef879c8e074d9a9d79592bf841ad3dafb8b149c5549b86942407aa21080d63dc07f2aed9993f21683f5f7b8f6be948e047c453c5330ebb3431e

data/README.md

@@ -27,7 +27,7 @@ class A
     # extend the class (not include)
     extend Creatable
 
-    # add an attribute (will default to accesor)
+    # add an attribute (will default to accessor)
     attribute name: 'an_attribute'
 
     # add the reader method only
@@ -38,6 +38,9 @@ class A
 
     # Restrict the type you can assign to this attribute
     attribute name: 'an_attribute', type: 'accessor', kind_of: String
+
+    # You can assign multiple types
+    attribute name: 'an_attribute', type: 'accessor', kind_of: [String, Array, nil]
 end
 ```
 
@@ -49,4 +52,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/erniebrodeur/creatable.
+Bug reports and pull requests are welcome on GitHub at [creatable](https://github.com/erniebrodeur/creatable).

data/lib/creatable.rb

@@ -1,5 +1,5 @@
 require "creatable/version"
-require 'creatable/class_methods'
+require 'creatable/instance_methods'
 
 # Main module you include in your class
 module Creatable
@@ -7,7 +7,7 @@ module Creatable
   # @param [Object] object
   # @return [Void]
   def self.included(object)
-    object.extend ClassMethods
+    object.extend InstanceMethods
   end
 
   # Returns the hash of built attributes
@@ -15,4 +15,20 @@ module Creatable
   def attributes
     self.class.attributes
   end
+
+  # Returns the names of the attributes.
+  # @return [Array] list of names of the attributes
+  def attribute_names
+    self.class.attributes.map { |a| a[:name] }
+  end
+
+  # Returns the settings of all attributes.
+  # @return [Hash] k/v pairs of the current class attributes
+  def to_parameters
+    h = {}
+    attribute_names.each do |name|
+      h.store name, instance_variable_get("@#{name}")
+    end
+    h
+  end
 end

data/lib/creatable/{class_methods.rb → instance_methods.rb}

@@ -1,6 +1,6 @@
 module Creatable
   # Class methods that get mixed in.
-  module ClassMethods
+  module InstanceMethods
     # Returns the list of attributes attatched to this object
     # @return [Array] the current attributes
     def attributes
@@ -19,29 +19,22 @@ module Creatable
       raise ArgumentError, 'name is a required parameter' unless name
       raise ArgumentError, "type must be of type: 'accessor', 'reader', or 'writer'" unless ['accessor', 'reader', 'writer'].include? type
 
-      if ['accessor', 'reader'].include?(type)
-        define_method name.to_s do
-          instance_variable_get "@#{name}"
-        end
-      end
+      generate_reader(name) if ['accessor', 'reader'].include?(type)
 
       if ['accessor', 'writer'].include?(type)
         if kind_of.nil?
-          define_method("#{name}=") { |value| instance_variable_set "@#{name}", value }
+          generate_writer(name)
         else
-          define_method("#{name}=") do |value|
-            raise ArgumentError, "parameter #{name} (#{value.class}) is not a kind of (#{kind_of})" unless value.is_a?(kind_of) || value.nil?
-            instance_variable_set "@#{name}", value
-          end
+          kind_of = [kind_of] unless kind_of.is_a? Array
+          generate_required_writer(name, kind_of)
         end
       end
 
       if attributes.map { |e| e[:name] }.include? name
         attributes.delete_if { |e| e[:name] == name }
-        attributes.push(name: name, type: type, kind_of: kind_of)
-      else
-        attributes.push(name: name, type: type, kind_of: kind_of)
       end
+
+      attributes.push(name: name, type: type, kind_of: kind_of)
       nil
     end
 
@@ -56,5 +49,23 @@ module Creatable
       end
       object
     end
+
+    private
+
+    def generate_reader(name)
+      define_method(name.to_s) { instance_variable_get "@#{name}" }
+    end
+
+    def generate_writer(name)
+      define_method("#{name}=") { |value| instance_variable_set "@#{name}", value }
+    end
+
+    def generate_required_writer(name, kind_of)
+      define_method("#{name}=") do |value|
+        raise(ArgumentError, "parameter #{name} (#{value.class}) is not a kind of (#{kind_of.join})") unless kind_of.include?(value.class)
+
+        instance_variable_set "@#{name}", value
+      end
+    end
   end
 end

data/lib/creatable/version.rb

@@ -1,3 +1,3 @@
 module Creatable
-  VERSION = '2.0.1'.freeze # VERSION
+  VERSION = '2.1.0'.freeze # VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creatable
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Ernie Brodeur
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -244,7 +244,7 @@ files:
 - bin/setup
 - creatable.gemspec
 - lib/creatable.rb
-- lib/creatable/class_methods.rb
+- lib/creatable/instance_methods.rb
 - lib/creatable/version.rb
 homepage: https://github.com/erniebrodeur/creatable
 licenses: []