txus-aversion 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aversion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Josep M. Bach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# aversion
+
+Aversion makes your Ruby objects versionable. It also makes them immutable, so
+the only way to obtain transformed copies is to explicitly mutate state in
+`#transform` calls, which will return the modified copy, leaving the original
+intact.
+
+You can also compute the difference between two versions, expressed as an array
+of transformations, and apply it onto an arbitrary object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'txus-aversion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install txus-aversion
+
+Yeah, I know the name sucks. There is another gem called aversion so I have to
+prefix mine with my name :(
+
+## Usage
+
+```ruby
+class Person
+  include Aversion
+
+  def initialize(hunger)
+    @hunger = hunger
+  end
+
+  def eat
+    transform do
+      @hunger -= 5
+    end
+  end
+end
+
+# Objects are immutable. Calls to mutate state will return new modified
+# copies (thanks to #transform):
+john       = Person.new
+new_john   = john.eat
+newer_john = new_john.eat
+
+# You can roll back to a previous state:
+new_john_again = newer_john.rollback
+
+# Calculate deltas between objects, and replay the differences to get to the
+# desired state:
+difference = newer_john - john
+newer_john_again = john.replay(difference)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Who's this
+
+This was made by [Josep M. Bach (Txus)](http://txustice.me) under the MIT
+license. I'm [@txustice](http://twitter.com/txustice) on twitter (where you
+should probably follow me!).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/aversion.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aversion/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "txus-aversion"
+  gem.version       = Aversion::VERSION
+  gem.authors       = ["Josep M. Bach"]
+  gem.email         = ["josep.m.bach@gmail.com"]
+  gem.description   = %q{Make your Ruby objects versionable}
+  gem.summary       = %q{Make your Ruby objects versionable}
+  gem.homepage      = "https://github.com/txus/aversion"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/aversion/version.rb

@@ -0,0 +1,3 @@
+module Aversion
+  VERSION = "0.0.1"
+end

data/lib/aversion.rb

@@ -0,0 +1,131 @@
+require "aversion/version"
+
+# Public: Aversion makes your Ruby objects versionable. It also makes them
+# immutable, so the only way to obtain transformed copies is to explicitly
+# mutate state in #transform calls, which will return the modified copy, leaving
+# the original intact.
+#
+# Examples
+#
+#   class Person
+#     include Aversion
+#
+#     def initialize(hunger)
+#       @hunger = hunger
+#     end
+#
+#     def eat
+#       transform do
+#         @hunger -= 5
+#       end
+#     end
+#   end
+#
+#   # Objects are immutable. Calls to mutate state will return new modified
+#   # copies (thanks to #transform):
+#   john       = Person.new
+#   new_john   = john.eat
+#   newer_john = new_john.eat
+#
+#   # You can roll back to a previous state:
+#   new_john_again = newer_john.rollback
+#
+#   # Calculate deltas between objects, and replay the differences to get to the
+#   # desired state:
+#   difference = newer_john - john
+#   newer_john_again = john.replay(difference)
+#
+module Aversion
+  # Public: When we include Aversion, we override .new with an immutable
+  # constructor and provide a .new_mutable version.
+  def self.included(base)
+    base.class_eval do
+      # Public: Initializes an immutable instance.
+      def self.new(*args)
+        new_mutable(*args).freeze
+      end
+
+      # Public: Initializes a mutable instance.
+      def self.new_mutable(*args)
+        allocate.tap do |instance|
+          instance.send :initialize, *args
+          instance.instance_eval do
+            @transformations = []
+            @initial_args    = args
+          end
+        end
+      end
+    end
+  end
+
+  # Public: Returns a mutable version of the object, in case anyone needs it. We
+  # do need it internally to perform transformations.
+  def mutable
+    self.class.new_mutable(*@initial_args).tap do |mutable|
+      instance_variables.each do |ivar|
+        mutable.instance_variable_set(ivar, instance_variable_get(ivar))
+        mutable.instance_variable_set(:@transformations, @transformations.dup)
+      end
+    end
+  end
+
+  # Public: The only way to transform state.
+  #
+  # Returns a new, immutable copy with the transformation applied.
+  def transform(&block)
+    mutable.tap do |new_instance|
+      new_instance.replay([block.dup])
+    end.freeze
+  end
+
+  # Public: Rolls back to a previous version of the state.
+  #
+  # Returns a new, immutable copy with the previous state.
+  def rollback
+    self.class.new_mutable(*@initial_args).tap do |instance|
+      instance.replay(history[0..-2])
+    end.freeze
+  end
+
+  # Public: Replays an array of transformations (procs).
+  #
+  # transformations - the Array of Procs to apply.
+  #
+  # Returns a new, immutable copy with those transformations applied.
+  def replay(transformations)
+    (frozen? ? mutable : self).tap do |object|
+      transformations.each do |transformation|
+        object.history << transformation
+        object.instance_eval(&transformation)
+      end
+    end.freeze
+  end
+
+  # Internal: Returns the history of this object.
+  def history
+    @transformations
+  end
+
+  # Internal: Sets the history of this object to a specific array fo
+  # transformations.
+  def history=(transformations)
+    @transformations = transformations
+  end
+
+  # Public: Returns the difference between two versioned objects, which is an
+  # array of the transformations one lacks from the other.
+  def -(other)
+    younger, older = [history, other.history].sort { |a,b| a.length <=> b.length }
+    difference     = (older.length - younger.length) - 1
+    older[difference..-1]
+  end
+
+  # Public: Returns whether two versionable objects are equal.
+  #
+  # They will be equal as long as they have the same initial args with they were
+  # constructed with and their history is the same.
+  def ==(other)
+    @initial_args == other.instance_variable_get(:@initial_args) &&
+      history == other.history
+  end
+end

data/test/aversion_test.rb

@@ -0,0 +1,97 @@
+require 'test_helper'
+
+class Person
+  include Aversion
+  attr_reader :age, :hunger
+
+  def initialize(age)
+    @age   = age
+    @hunger = 100
+  end
+
+  def eat
+    transform do
+      @hunger -= 5
+    end
+  end
+end
+
+describe Aversion do
+  let(:person) { Person.new(20) }
+
+  describe 'immutability' do
+    it 'makes objects immutable' do
+      person.frozen?.must_equal true
+    end
+
+    it 'allows for constructing mutable copies' do
+      Person.new_mutable(20).frozen?.must_equal false
+    end
+
+    it 'exposes a mutable version of the object' do
+      person.mutable.frozen?.must_equal false
+      person.age.must_equal 20
+    end
+  end
+
+  describe '#transform' do
+    it 'returns a new, modified instance' do
+      new_person = person.eat
+      new_person.hunger.must_equal 95
+    end
+
+    it 'preserves the original object' do
+      person.eat
+      person.hunger.must_equal 100
+    end
+  end
+
+  describe '#rollback' do
+    it 'rolls back to a previous state' do
+      new_person = person.eat
+      new_person.rollback.must_equal person
+    end
+  end
+
+  describe 'calculating and applying deltas' do
+    let(:new_person)        { person.eat }
+    let(:newer_person)      { new_person.eat }
+    let(:even_newer_person) { newer_person.eat }
+
+    let(:difference) { even_newer_person - new_person }
+
+    describe '#difference' do
+      it 'returns an array of deltas (transformations)' do
+        difference.length.must_equal 2
+      end
+    end
+
+    describe '#replay' do
+      it 'returns an array of deltas (transformations)' do
+        new_person.replay(difference).must_equal even_newer_person
+      end
+    end
+  end
+
+  describe '#==' do
+    describe 'when two objects have the same history' do
+      describe 'and the same initial args' do
+        it 'returns true' do
+          (person.eat.rollback == person).must_equal true
+        end
+      end
+
+      describe 'but different initial args' do
+        it 'returns false' do
+          (Person.new(10) == person).must_equal false
+        end
+      end
+    end
+
+    describe 'when two objects differ in history' do
+      it 'returns false' do
+        (person.eat == person).must_equal false
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+$: << 'lib'
+require 'aversion'

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: txus-aversion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josep M. Bach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-20 00:00:00.000000000 Z
+dependencies: []
+description: Make your Ruby objects versionable
+email:
+- josep.m.bach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aversion.gemspec
+- lib/aversion.rb
+- lib/aversion/version.rb
+- test/aversion_test.rb
+- test/test_helper.rb
+homepage: https://github.com/txus/aversion
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Make your Ruby objects versionable
+test_files:
+- test/aversion_test.rb
+- test/test_helper.rb