creatable 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c83e3f19290c6508f5dd3440c16c4153ecdab7d
-  data.tar.gz: d676eae79e326cf161399f709ec4e65edcb356f0
+  metadata.gz: c329dfc34d0517b100f5f53dcd1d56997ff21ded
+  data.tar.gz: 332be29fed1620fbb6cfea7fd6b6fce9904b6ffd
 SHA512:
-  metadata.gz: 72cefaad2c05643ff0a09a72151bb5d726b8b751483e1581c8dbe27a4efa1432130b151c856e1a461f48d84e431cc5ad86c3a6f59a9904f117947201b3e32e11
-  data.tar.gz: e897d53dc78f7ef879c8e074d9a9d79592bf841ad3dafb8b149c5549b86942407aa21080d63dc07f2aed9993f21683f5f7b8f6be948e047c453c5330ebb3431e
+  metadata.gz: 6e112941a632494e7c0ea34bff9e0b56751726d75fa4ecbb1a6f74efc31908a0efb168067784713cd53558de8602a836c845709f456d70f8b53a5ff84daa49ca
+  data.tar.gz: e65394e04cfe7df279f5c4d583615fd5fbf81c86291b84171566ee3abe241408b1120d912eeb746c8e009e2e83cfeff5728181787d86dc0ee12cbdc8fc730bc9

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+_config.yml

data/README.md

@@ -20,12 +20,12 @@ Or install it yourself as:
 
     gem install creatable
 
-## Usage
+## Class Usage
 
 ``` ruby
 class A
-    # extend the class (not include)
-    extend Creatable
+    # include the class
+    include Creatable
 
     # add an attribute (will default to accessor)
     attribute name: 'an_attribute'
@@ -44,6 +44,29 @@ class A
 end
 ```
 
+## Instance Usage
+
+``` ruby
+    i = A.create an_attribute: 'this'
+
+    # pass a block to create for it to be processed during initialize
+    # note that you have to accept an argument in the block to get the object
+    # you want to change.
+    i = A.create(an_attribute: 'this') { |obj| obj.an_attribute = 'that' }
+
+    # a hash of the current attributes.
+    i.attributes
+
+    # an array of the names
+    i.attribute_names
+
+    # The current values of all attributes as a hash
+    i.to_parameters
+
+    # creating a new object from parameters
+    A.create i.to_parameters
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -52,4 +75,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 [creatable](https://github.com/erniebrodeur/creatable).
+Bug reports and pull requests are welcome on GitHub at [github.com](https://github.com/erniebrodeur/creatable).

data/lib/creatable.rb

@@ -1,5 +1,5 @@
 require "creatable/version"
-require 'creatable/instance_methods'
+require 'creatable/class_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 InstanceMethods
+    object.extend ClassMethods
   end
 
   # Returns the hash of built attributes

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

@@ -1,6 +1,6 @@
 module Creatable
   # Class methods that get mixed in.
-  module InstanceMethods
+  module ClassMethods
     # Returns the list of attributes attatched to this object
     # @return [Array] the current attributes
     def attributes
@@ -45,8 +45,11 @@ module Creatable
       object = new
       names = attributes.map { |e| e[:name].to_sym }
       args.each do |k, v|
-        object.instance_variable_set "@#{k}".to_sym, v if names.include? k
+        object.instance_variable_set "@#{k}".to_sym, v if names.include? k.to_sym
       end
+
+      yield(object) if block_given?
+
       object
     end
 

data/lib/creatable/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creatable
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Ernie Brodeur
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-13 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -239,12 +239,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- _config.yml
 - bin/console
 - bin/setup
 - creatable.gemspec
 - lib/creatable.rb
-- lib/creatable/instance_methods.rb
+- lib/creatable/class_methods.rb
 - lib/creatable/version.rb
 homepage: https://github.com/erniebrodeur/creatable
 licenses: []

data/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-midnight