renewable 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 648680f8f5c0283aa11938e169a4ab509991221e
-  data.tar.gz: bbc9186b86c072cf0ece86692883486088325c62
+  metadata.gz: af1d37fe4a9a6091904ef8fb8cde432d4c47c1e6
+  data.tar.gz: bc9807d81c12e440dc65a15e87c03381a1d98dac
 SHA512:
-  metadata.gz: 0cdab0882b58b0680062093a69723fcea91a86803a4ce7936bc0eeb42f37d51c97f8930e9a5fcc90ff3578500c351e33007e8c67cf9b0e438070482445736012
-  data.tar.gz: 9b64237e91316164f7dabc144e40f14f7e1e2b764d654ba22b4f16394f7170b1a37ed922da186fca65cebdf89e5964583183bac13162ce639161acd15d37a087
+  metadata.gz: 7a7fb4807078d3cfe26e4a86147eb256784cf6bc5ceab880a2fd5456d95828d417b0881adba3661ee3dbf1a096848e34958f6b1d957b0cdc9b7bc772c80b7388
+  data.tar.gz: 07207c55ba56c04dc4b463c9035534255271a1328076ccf2a558b7663dae36a84b5b4d5f6b6e4bd8fb2ab01bffe2f9f92a970dfc98e9188f6697bf0051ac8861

data/README.md

@@ -108,11 +108,41 @@ end
 
 ### Mutators (Methods that change stuff)
 
-TODO: Write this section.
+*Don't write them!* This is where the idea of being more Functional comes into
+play. Methods that modify the internal state of an object make it harder to
+ensure the thread-safety of your code. But, so much of Object-Oriented
+Programming is directly tied to mutation. Thankfully, with Renewable objects
+that functionality is explicitly not available.
 
-### #renew
+Instead, Renewable provides a method called `renew` that allows you to achieve
+functionality similar to mutation, but without the same side effects. Instead
+`renew` returns a completely new instance of the object, and you get control
+over exactly what aspects of internal state change for the new instance.
 
-TODO: Write this section.
+The major downside to this is that you have to expect your mutator methods to
+return a new instance, never just a value or nil. But, that's a pretty easy
+idea to get used to.
+
+#### #renew
+
+The `renew` method is what you use to move beyond your frozen object, it accepts
+two hashes: `attributes` and `options`. In that way, it is like calling `new`,
+but it starts with the state of your frozen object and applies the changes you
+specify.
+
+```ruby
+class Person
+  #...
+
+  def change_name(name)
+    self.renew(name: name.to_s)
+  end
+end
+```
+
+That really is as simple as `renew` is in many cases. Because it accepts the
+`attributes` and `options` arguments and calls `initialize` under the hood you
+still get all the functionality of the callback handling when renewing objects.
 
 ## Contributing
 

data/lib/renewable.rb

@@ -10,15 +10,22 @@ module Renewable
     after_freeze(attributes, options)
   end
 
+  def renew(attributes = {}, options = {})
+    merged_attributes = self.renewable_attributes.merge(attributes)
+    merged_options = self.renewable_options.merge(options)
+
+    self.class.new(merged_attributes, merged_options)
+  end
+
   protected
 
-  # def renewable_attributes
-  #   @renwable_attributes
-  # end
+  def renewable_attributes
+    @renewable_attributes
+  end
 
-  # def renewable_options
-  #   @renwable_options
-  # end
+  def renewable_options
+    @renewable_options
+  end
 
   private
 
@@ -31,11 +38,11 @@ module Renewable
       self.instance_variable_set(:"@#{name}", value)
     end
 
-    #@renwable_attributes = attributes
+    @renewable_attributes = attributes
   end
 
   def renewable_process_options(options)
-    #@renwable_options = options
+    @renewable_options = options
   end
 
   def before_freeze(attributes, options)

data/lib/renewable/version.rb

@@ -1,3 +1,3 @@
 module Renewable
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/spec/inhertitance_spec.rb

@@ -3,11 +3,11 @@ require 'samples/inheritance_sample'
 RSpec.describe Renewable do
   context 'used via inheritance' do
     it 'initializes to a frozen object' do
-      expect(PersonA.new(birth_date: '1972-06-13').frozen?).to eq(true)
+      expect(InheritedPerson.new(birth_date: '1972-06-13').frozen?).to eq(true)
     end
 
     it 'assigns all attributes' do
-      person = PersonA.new(name: 'John',
+      person = InheritedPerson.new(name: 'John',
                           birth_date: '1972-06-13',
                           hair_color: 'Brown')
 
@@ -18,19 +18,19 @@ RSpec.describe Renewable do
 
     it 'runs process_arguments callback' do
       expect {
-        PersonA.new({}, {raise_process_arguments: true})
+        InheritedPerson.new({}, {raise_process_arguments: true})
       }.to raise_error(ArgumentError, 'entered process_arguments with raise option')
     end
 
     it 'runs before_freeze callback' do
       expect {
-        PersonA.new({}, {raise_before_freeze: true})
+        InheritedPerson.new({}, {raise_before_freeze: true})
       }.to raise_error(ArgumentError, 'entered before_freeze with raise option')
     end
 
     it 'runs after_freeze callback' do
       expect {
-        PersonA.new({}, {raise_after_freeze: true})
+        InheritedPerson.new({}, {raise_after_freeze: true})
       }.to raise_error(ArgumentError, 'entered after_freeze with raise option')
     end
   end

data/spec/mixin_spec.rb

@@ -3,11 +3,11 @@ require 'samples/mixin_sample'
 RSpec.describe Renewable do
   context 'used as a mixin' do
     it 'initializes to a frozen object' do
-      expect(PersonB.new(birth_date: '1972-06-13').frozen?).to eq(true)
+      expect(MixinPerson.new(birth_date: '1972-06-13').frozen?).to eq(true)
     end
 
     it 'assigns all attributes' do
-      person = PersonB.new(name: 'John',
+      person = MixinPerson.new(name: 'John',
                           birth_date: '1972-06-13',
                           hair_color: 'Brown')
 
@@ -18,19 +18,19 @@ RSpec.describe Renewable do
 
     it 'runs process_arguments callback' do
       expect {
-        PersonB.new({}, {raise_process_arguments: true})
+        MixinPerson.new({}, {raise_process_arguments: true})
       }.to raise_error(ArgumentError, 'entered process_arguments with raise option')
     end
 
     it 'runs before_freeze callback' do
       expect {
-        PersonB.new({}, {raise_before_freeze: true})
+        MixinPerson.new({}, {raise_before_freeze: true})
       }.to raise_error(ArgumentError, 'entered before_freeze with raise option')
     end
 
     it 'runs after_freeze callback' do
       expect {
-        PersonB.new({}, {raise_after_freeze: true})
+        MixinPerson.new({}, {raise_after_freeze: true})
       }.to raise_error(ArgumentError, 'entered after_freeze with raise option')
     end
   end

data/spec/renew_spec.rb

@@ -0,0 +1,28 @@
+require 'samples/inheritance_sample'
+
+RSpec.describe Renewable do
+  describe '#renew' do
+    let(:subject) { InheritedPerson.new(attributes) }
+    let(:attributes) { {
+        name: 'John',
+        birth_date: '1973-06-15'
+    } }
+
+    it 'returns a new object' do
+      new_object = subject.renew
+      expect(new_object.__id__).not_to eq(subject.__id__)
+    end
+
+    it 'changes attributes of new object' do
+      new_object = subject.renew(name: 'Jack')
+      name = new_object.instance_variable_get(:@name)
+      expect(name).to eq('Jack')
+    end
+
+    it 'changes options of new object' do
+      new_object = subject.renew({}, example: 'test')
+      options = new_object.instance_variable_get(:@renewable_options)
+      expect(options[:example]).to eq('test')
+    end
+  end
+end

data/spec/samples/inheritance_sample.rb

@@ -1,7 +1,7 @@
 require 'date'
 require 'renewable'
 
-class PersonA < Renewable::Object
+class InheritedPerson < Renewable::Object
   attr_accessor :name, :birth_date
 
   def age

data/spec/samples/mixin_sample.rb

@@ -1,7 +1,7 @@
 require 'date'
 require 'renewable'
 
-class PersonB
+class MixinPerson
   include ::Renewable
 
   attr_accessor :name, :birth_date

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renewable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - James Thompson
@@ -102,6 +102,7 @@ files:
 - renewable.gemspec
 - spec/inhertitance_spec.rb
 - spec/mixin_spec.rb
+- spec/renew_spec.rb
 - spec/samples/inheritance_sample.rb
 - spec/samples/mixin_sample.rb
 - spec/spec_helper.rb
@@ -132,6 +133,7 @@ summary: Provides frozen by default objects
 test_files:
 - spec/inhertitance_spec.rb
 - spec/mixin_spec.rb
+- spec/renew_spec.rb
 - spec/samples/inheritance_sample.rb
 - spec/samples/mixin_sample.rb
 - spec/spec_helper.rb