immutability 0.0.1

data/spec/support/immutable.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+# Checks whether the instance is truly (deeply) immutable
+#
+# @example
+#   expect(instance).to be_immutable
+#
+# @api public
+#
+RSpec::Matchers.define :be_immutable do
+  match do |instance|
+    if instance.class.respond_to? :new
+      expect(instance).to be_frozen
+      instance
+        .instance_variables.map(&instance.method(:instance_variable_get))
+        .each { |ivar| expect(ivar).to be_immutable }
+    else
+      expect(true).to be_truthy
+    end
+  end
+
+  failure_message do |instance|
+    "expected that #{instance.inspect} to be immutable"
+  end
+end

data/spec/unit/immutability/with_memory_spec.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+describe Immutability::WithMemory do
+
+  include_context :user
+  before { User.send :include, described_class }
+
+  let(:user) { User.new "Andrew", 44 }
+
+  describe ".new" do
+    subject { user }
+
+    it { is_expected.to be_immutable }
+
+    it "doesn't add hidden variables" do
+      expect(subject.instance_variables).to contain_exactly(
+        :@name, :@age, :@version, :@parent
+      )
+    end
+  end # describe .new
+
+  describe "#methods" do
+    subject { user.methods - Object.instance_methods }
+
+    it "are expected" do
+      expect(subject).to contain_exactly(
+        :name, :age, :version, :parent, :update, :forget_history
+      )
+    end
+  end # describe #methods
+
+  describe "#version" do
+    subject { user.version }
+
+    it { is_expected.to eql 0 }
+  end # describe #version
+
+  describe "#parent" do
+    subject { user.parent }
+
+    it { is_expected.to be_nil }
+  end # describe #parent
+
+  describe "#update" do
+    subject { user.update { @age = 45 } }
+
+    it "creates new immutable instance" do
+      expect(subject).to be_kind_of User
+      expect(subject).to be_immutable
+    end
+
+    it "sets parent" do
+      expect(subject.parent).to eql user
+    end
+
+    it "increments version" do
+      expect(subject.version).to eql 1
+      expect(subject.update.version).to eql 2
+    end
+
+    it "applies the block" do
+      expect(subject.age).to eql 45
+    end
+
+    it "preserves other variables" do
+      expect(subject.name).to eql user.name
+    end
+
+    it "doesn't add hidden variables" do
+      expect(subject.instance_variables).to eql user.instance_variables
+    end
+  end # describe #update
+
+  describe "#forget_history" do
+    subject { new_user.forget_history }
+
+    let(:new_user) { user.update { @age = 45 } }
+
+    it "creates new immutable instance" do
+      expect(subject).to be_kind_of User
+      expect(subject).to be_immutable
+    end
+
+    it "resets parent" do
+      expect(subject.parent).to be_nil
+    end
+
+    it "resets version" do
+      expect(subject.version).to eql 0
+    end
+
+    it "preserves other variables" do
+      expect(subject.name).to eql new_user.name
+      expect(subject.age).to  eql new_user.age
+    end
+
+    it "doesn't add hidden variables" do
+      expect(subject.instance_variables).to eql new_user.instance_variables
+    end
+  end # describe #forget_history
+
+end # describe Immutability::WithMemory

data/spec/unit/immutability_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+describe Immutability do
+
+  include_context :user
+  before { User.send :include, described_class }
+
+  let(:user) { User.new name, 44 }
+  let(:name) { "Andrew" }
+
+  describe "::with_memory" do
+    subject { described_class.with_memory }
+
+    it { is_expected.to eql Immutability::WithMemory }
+  end # describe .with_memory
+
+  describe ".new" do
+    subject { user }
+
+    it { is_expected.to be_immutable }
+  end # describe .new
+
+  describe "#methods" do
+    subject { user.methods - Object.instance_methods }
+
+    it { is_expected.to contain_exactly(:name, :age, :update) }
+  end # describe #methods
+
+  describe "#update" do
+    subject { user.update { @age = 45 } }
+
+    it "creates new immutable instance" do
+      expect(subject).to be_kind_of User
+      expect(subject).to be_immutable
+    end
+
+    it "applies the block" do
+      expect(subject.age).to eql 45
+    end
+
+    it "preserves other variables" do
+      expect(subject.name).to eql user.name
+    end
+
+    it "doesn't add hidden variables" do
+      expect(subject.instance_variables).to eql user.instance_variables
+    end
+
+    context "without block" do
+      subject { user.update }
+
+      it "creates new immutable instance" do
+        expect(subject).not_to be_equal(user)
+        expect(subject).to be_immutable
+      end
+
+      it "preservers all variables" do
+        expect(subject.age).to eql user.age
+        expect(subject.name).to eql user.name
+      end
+    end
+  end # describe #update
+
+end # describe Immutability

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: immutability
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kozin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ice_nine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: hexx-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: 
+email: andrew.kozin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- .coveralls.yml
+- .gitignore
+- .metrics
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- config/metrics/STYLEGUIDE
+- config/metrics/cane.yml
+- config/metrics/churn.yml
+- config/metrics/flay.yml
+- config/metrics/metric_fu.yml
+- config/metrics/reek.yml
+- config/metrics/roodi.yml
+- config/metrics/rubocop.yml
+- config/metrics/saikuro.yml
+- config/metrics/simplecov.yml
+- config/metrics/yardstick.yml
+- immutability.gemspec
+- lib/immutability.rb
+- lib/immutability/rspec.rb
+- lib/immutability/version.rb
+- lib/immutability/with_memory.rb
+- spec/shared/user.rb
+- spec/spec_helper.rb
+- spec/support/immutable.rb
+- spec/unit/immutability/with_memory_spec.rb
+- spec/unit/immutability_spec.rb
+homepage: https://github.com/nepalez/immutability
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Make instances immutable (deeply frozen) and versioned
+test_files:
+- spec/spec_helper.rb
+- spec/unit/immutability_spec.rb
+- spec/unit/immutability/with_memory_spec.rb
+- spec/support/immutable.rb
+- spec/shared/user.rb
+has_rdoc: