immutability 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTQ3MDdmODU2NDZkZmYxMzJjY2E2OTExYTAzMmRlNzY1NmU5NmU4Mw==
+  data.tar.gz: !binary |-
+    MTc4MTk4OGVkOWY5NmQzMTNjNGRlMGRmMzk1ZTQwNzdmYzI5MjhhMQ==
+SHA512:
+  metadata.gz: !binary |-
+    Yzc0NTMyOTM1MmY4ZTllOTMyZmE0N2QzOGFhNzg1YjBiZTE2ZmE1ZGQ4OWU1
+    N2QzMzVmZjQ2NWU0YzUzYmU1YTU3MTM1ZDE3OTU3OTg0NzhlZDIwYTAyN2Yx
+    NWU4NzM0ZjI5YWQ5MTRkOWIyOGY2MWM5Y2UxZDliZDE2ZWJkYTE=
+  data.tar.gz: !binary |-
+    ODg1NDUxY2UzM2VhOGE0M2E2NDQ0ZjlmMzk4NTRiMmM2NzgxN2RjMGM3MTIw
+    MjdlY2Q4M2NlYzZkMzU5NzE3MzE3MTFmMWYzNWNkNzcxNTEyMjc5ZmUwM2I4
+    YjM0NmZhODQ3ODA1MDk3MDczYzBjNTQ4ZDRkYzRmMWVmYzFjNDM=

data/.coveralls.yml

@@ -0,0 +1,2 @@
+---
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.lock
+.bundle/
+.yardoc/
+coverage/
+doc/
+log/
+pkg/
+tmp/

data/.metrics

@@ -0,0 +1,9 @@
+# Settings for metric_fu and its packages are collected in the `config/metrics`
+# and loaded by the Hexx::Suit::Metrics::MetricFu.
+
+begin
+  require "hexx-suit"
+  Hexx::Suit::Metrics::MetricFu.load
+rescue LoadError
+  puts "The 'hexx-suit' gem is not installed"
+end

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+---
+inherit_from: "./config/metrics/rubocop.yml"

data/.travis.yml

@@ -0,0 +1,24 @@
+---
+language:     ruby
+bundler_args: --without metrics
+cache:        bundler
+script:       bundle exec rake test:coverage:run
+env:
+  global:
+    - JRUBY_OPTS="-Xcli.debug=true --debug"
+rvm:
+  - '1.9.3'
+  - '2.0'
+  - '2.1'
+  - '2.2'
+  - ruby-head
+  - rbx-2 --1.9
+  - rbx-2 --2.1
+  - jruby-1.7-19mode
+  - jruby-1.7-21mode
+  - jruby-9.0.0.0
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/.yardopts

@@ -0,0 +1,3 @@
+--asset LICENSE
+--exclude lib/immutability/version.rb
+--output doc/api

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1 2015-09-20
+
+First public release.

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :metrics do
+  gem "hexx-suit", "~> 2.3" if RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.1"
+end

data/Guardfile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+guard :rspec, cmd: "bundle exec rspec" do
+
+  watch(%r{^spec/.+_spec\.rb$})
+
+  watch(%r{^lib/immutability/(.+)\.rb}) do |m|
+    "spec/unit/#{m[1]}_spec.rb"
+  end
+
+  watch("lib/immutability.rb") { "spec" }
+  watch("spec/spec_helper.rb") { "spec" }
+
+end # guard :rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2015 Andrew Kozin (nepalez), andrew.kozin@gmail.com
+
+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,201 @@
+Immutability
+============
+
+[![Gem Version](https://img.shields.io/gem/v/immutability.svg?style=flat)][gem]
+[![Build Status](https://img.shields.io/travis/nepalez/immutability/master.svg?style=flat)][travis]
+[![Dependency Status](https://img.shields.io/gemnasium/nepalez/immutability.svg?style=flat)][gemnasium]
+[![Code Climate](https://img.shields.io/codeclimate/github/nepalez/immutability.svg?style=flat)][codeclimate]
+[![Coverage](https://img.shields.io/coveralls/nepalez/immutability.svg?style=flat)][coveralls]
+[![Inline docs](http://inch-ci.org/github/nepalez/immutability.svg)][inch]
+
+Makes instances immutable (deeply frozen) and versioned.
+
+Preamble
+--------
+
+The project is a clone of the [aversion][aversion] gem by [Josep M. Bach][txus] with some implementation differencies:
+
+- it uses [ice_nine][ice_nine] gem to freeze instances deeply.
+- instead of storing procedures that changed the instance, it stores reference to the previous state and the number of current version.
+
+This approach to object's identity as a sequence of immutable snapshots is heavily inspired by 2009 year's brilliant talk ["Are We There Yet?"][are_we_there_yet] by [Rich Hickey][richhickey].
+
+Synopsis
+--------
+
+### Immutable objects without memory:
+
+Include the `Immutability` module to make the object immutable (deeply frozen).
+
+```ruby
+require "immutability"
+
+class User
+  include Immutability
+
+  attr_reader :name, :age
+
+  def initialize(name, age)
+    @name = name
+    @age  = 44
+  end
+end
+
+young_andrew = User.new "Andrew", 44
+young_andrew.name         #  => "Andrew"
+young_andrew.age          #  => 44
+
+# The instance is frozen deeply:
+young_andrew.frozen?      #  => true
+young_andrew.name.frozen? #  => true
+young_andrew.age.frozen?  #  => true
+```
+
+Use `update` with a block to create a **new instance** with updated values (other instance values remains the same):
+
+```ruby
+elder_andrew = young_andrew.update { @age = 45 }
+elder_andrew.name         #  => "Andrew"
+elder_andrew.age          #  => 45
+
+# The instance is frozen deeply:
+elder_andrew.frozen?      #  => true
+elder_andrew.name.frozen? #  => true
+elder_andrew.age.frozen?  #  => true
+```
+
+### Immutable objects with memory
+
+Include `Immutability.with_memory` module to add `version` and `parent`:
+
+```ruby
+require "immutability"
+
+class User
+  include Immutability.with_memory
+
+  attr_reader :name, :age
+
+  def initialize(name, age)
+    @name = name
+    @age  = 44
+  end
+end
+
+young_andrew = User.new "Andrew", 44
+young_andrew.name         #  => "Andrew"
+young_andrew.age          #  => 44
+
+# The instance is frozen as well:
+young_andrew.frozen?      #  => true
+young_andrew.name.frozen? #  => true
+young_andrew.age.frozen?  #  => true
+
+# Now it is versioned:
+young_andrew.version      # => 0
+young_andrew.parent       # => nil
+```
+
+The method `update` stores reference to the `#parent` and increases `#version`:
+
+```ruby
+elder_andrew = young_andrew.update { @age = 45 }
+elder_andrew.name    #  => "Andrew"
+elder_andrew.age     #  => 45
+
+# Version is updated:
+elder_andrew.version # => 1
+elder_andrew.parent.equal? young_andrew # => true
+```
+
+Notice, than no instances in the sequence can be garbage collected (they still refer to each other).
+
+Use `#forget_history` methods to reset version and free old instances for GC:
+
+```ruby
+reborn_andrew = elder_andrew.forget_history
+reborn_andrew.name # => "Andrew"
+reborn_andrew.age  # => 45
+
+# History is forgotten
+reborn_andrew.version # => 0
+reborn_andrew.parent  # => nil
+```
+
+RSpec helper
+------------
+
+Include `immutability/rspec` and use `be_immutable` RSpec matcher to check, whether an instance is deeply immutable (with all its variables):
+
+```ruby
+include "immutability/rspec"
+
+describe User, ".new" do
+  subject { User.new "Andrew", 44 }
+
+  it { is_expected.to be_immutable }
+end
+```
+
+The matcher will pass if both the object and all its variables are immutable at any level of nesting.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem "immutability"
+```
+
+Then execute:
+
+```
+bundle
+```
+
+Or add it manually:
+
+```
+gem install immutability
+```
+
+Compatibility
+-------------
+
+Tested under rubies [compatible to MRI 1.9+](.travis.yml).
+
+Uses [RSpec][rspec] 3.0+ for testing and [hexx-suit][suit] for dev/test tools collection.
+
+Contributing
+------------
+
+* Read the [STYLEGUIDE](config/metrics/STYLEGUIDE)
+* [Fork the project](https://github.com/nepalez/immutability)
+* Create your feature branch (`git checkout -b my-new-feature`)
+* Add tests for it
+* Run `rake mutant` or `rake exhort` to ensure 100% [mutant-proof][mutant] coverage
+* Commit your changes (`git commit -am '[UPDATE] Add some feature'`)
+* Push to the branch (`git push origin my-new-feature`)
+* Create a new Pull Request
+
+License
+-------
+
+See the [MIT LICENSE](LICENSE).
+
+[are_we_there_yet]: http://www.infoq.com/presentations/Are-We-There-Yet-Rich-Hickey
+[aversion]: https://github.com/txus/aversion
+[codeclimate]: https://codeclimate.com/github/nepalez/immutability
+[coveralls]: https://coveralls.io/r/nepalez/immutability
+[gem]: https://rubygems.org/gems/immutability
+[gemnasium]: https://gemnasium.com/nepalez/immutability
+[ice_nine]: https://github.com/dkubb/ice_nine
+[inch]: https://inch-ci.org/github/nepalez/immutability
+[mutant]: https://github.com/mbj/mutant
+[richhickey]: http://github.com/richhickey
+[rspec]: http://rspec.org
+[suit]: https://github.com/nepalez/hexx-suit
+[travis]: https://travis-ci.org/nepalez/immutability
+[txus]: https://github.com/txus

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require "bundler/setup"
+require "rubygems"
+
+# Loads bundler tasks
+Bundler::GemHelper.install_tasks
+
+# Loads the Hexx::RSpec and its tasks
+begin
+  require "hexx-suit"
+  Hexx::Suit.install_tasks
+rescue LoadError
+  require "hexx-rspec"
+  Hexx::RSpec.install_tasks
+end
+
+desc "Runs specs and check coverage"
+task :default do
+  system "bundle exec rake test:coverage:run"
+end
+
+desc "Runs mutation metric for testing"
+task :mutant do
+  system "mutant -r immutability --use rspec Immutability* --fail-fast"
+end
+
+desc "Exhort all evils"
+task :exhort do
+  system "mutant -r immutability --use rspec Immutability*"
+end
+
+desc "Runs all the necessary metrics before making a commit"
+task prepare: %w(exhort check:inch check:rubocop check:fu)

data/config/metrics/STYLEGUIDE

@@ -0,0 +1,230 @@
+= Ruby Style Guide
+
+Adapted from Dan Kubb's Ruby Style Guide
+https://github.com/dkubb/styleguide/blob/master/RUBY-STYLE
+
+== Commiting:
+
+* Write descriptive commit messages, following the pattern:
+
+    [TYPE] name
+
+    The message, describing the changes being made
+
+* Use the types below to mark commits:
+
+  - FEATURE - for adding new features, or backward-compatible changes;
+  - CHANGE - for backward-incompatible changes;
+  - BUG FIX - for fixing bugs;
+  - REFACTORING - for other changes of the code not affecting the API;
+  - OTHER - for changes in documentaton, metrics etc, not touching the code;
+  - VERSION - for version changes.
+
+* Always separate commits of different types (such as FEATURE and CHANGE).
+
+* Try to separate various features from each other.
+
+* Include specification to the same commit as the code.
+
+* Run all tests before making a commit.
+  Never commit the code that break unit tests.
+
+* Use metric (run `rake check`) before making a commit.
+
+* Do refactoring before making a commit. Best writing is rewriting.
+
+* Follow semantic versioning.
+
+    http://semver.org/
+
+* For versions name the commit after a version number, following the pattern:
+
+    VERSION 1.0.0-rc2
+
+
+== Formatting:
+
+* Use UTF-8. Declare encoding in the first line of every file.
+
+    # encoding: utf-8
+
+* Use 2 space indent, no tabs.
+
+* Use Unix-style line endings.
+
+* Use spaces around operators, after commas, colons and semicolons,
+  around { and before }.
+
+* No spaces after (, [ and before ], ).
+
+* Align `when` and `else` with `case`.
+
+* Use an empty line before the return value of a method (unless it
+  only has one line), and an empty line between defs.
+
+* Use empty lines to break up a long method into logical paragraphs.
+
+* Keep lines fewer than 80 characters.
+
+* Strip trailing whitespace.
+
+
+== Syntax:
+
+* Write for 2.0.
+
+* Use double quotes
+  
+    http://viget.com/extend/just-use-double-quoted-ruby-strings
+
+* Use def with parentheses when there are arguments.
+
+* Never use for, unless you exactly know why.
+
+* Never use then, except in case statements.
+
+* Use when x then ... for one-line cases.
+
+* Use &&/|| for boolean expressions, and/or for control flow. (Rule
+  of thumb: If you have to use outer parentheses, you are using the
+  wrong operators.)
+
+* Avoid double negation (!!), unless Null Objects are expected.
+  
+    http://devblog.avdi.org/2011/05/30/null-objects-and-falsiness
+
+* Avoid multiline ?:, use if.
+
+* Use {...} when defining blocks on one line. Use do...end for multiline
+  blocks.
+
+* Avoid return where not required.
+
+* Use ||= freely.
+
+* Use OO regexps, and avoid =~ $0-9, $~, $` and $' when possible.
+
+* Do not use Enumerable#inject when the "memo" object does not change between
+  iterations, use Enumerable#each_with_object instead (in ruby 1.9,
+  active_support and backports).
+
+* Prefer ENV.fetch to ENV[] syntax.
+  Prefer block syntax for ENV.fetch to usage of the second argument.
+
+
+== Naming:
+
+* Use snake_case for methods.
+
+* Use CamelCase for classes and modules. (Keep acronyms like HTTP,
+  RFC, XML uppercase.)
+
+* Use SCREAMING_SNAKE_CASE for other constants.
+
+* Do not use single letter variable names. Avoid uncommunicative names.
+
+* Use consistent variable names. Try to keep the variable names close
+  to the object class name.
+
+* Use names prefixed with _ for unused variables.
+
+* When defining a predicate method that compares against another object of
+  a similar type, name the argument "other".
+
+* Prefer map over collect, detect over find, select over find_all.
+
+* Use def self.method to define singleton methods.
+
+* Avoid alias when alias_method will do.
+
+
+== Comments:
+
+* Use YARD and its conventions for API documentation. Don't put an
+  empty line between the comment block and the def.
+
+* Comments longer than a word are capitalized and use punctuation.
+  Use one space after periods.
+
+* Avoid superfluous comments.
+
+
+== Code structuring:
+
+* Break code into packages, decoupled from the environment.
+
+* Wrap packages into gems.
+
+* Inject dependencies explicitly.
+  Leave all outer references on the border of any package. Inside
+  the package use internal references only.
+
+* Follow SOLID principles.
+
+    http://en.wikipedia.org/wiki/SOLID_(object-oriented_design)
+
+* Only give a method one purpose for existing. If you pass in a boolean
+  to a method, what you're saying is that this method has two different
+  behaviours. Just split it into two single purpose methods. If you have
+  to use the words "AND" or "OR" to describe what the method does it
+  probably does too much.
+
+* Avoid long methods.
+  Try to keep them at no more than 6 lines long, and preferably 4 or less.
+
+  If sections of a method are logically separate by blank lines, then
+  that's probably a sign that those sections should be split into separate
+  methods.
+
+* Avoid hashes-as-optional-parameters. Does the method do too much?
+
+* Avoid long parameter lists.
+
+* Add "global" methods to Kernel (if you have to) and make them private.
+
+* Use OptionParser for parsing complex command line options and
+  ruby -s for trivial command line options.
+
+* Avoid needless metaprogramming.
+
+* Always freeze objects assigned to constants.
+
+
+== General:
+
+* Code in a functional way, avoid mutation when it makes sense.
+
+* Try to have methods either return the state of the object and have
+  no side effects, or return self and have side effects. This is
+  otherwise known as Command-query separation (CQS):
+
+    http://en.wikipedia.org/wiki/Command-query_separation
+
+* Do not mutate arguments unless that is the purpose of the method.
+
+* Try following TRUE heuristics by Sandi Metz
+
+    http://designisrefactoring.com/2015/02/08/introducing-sandi-metz-true/
+
+* Do not mess around in core classes when writing libraries.
+  Namespace your code inside the modules, or wrap core classes to
+  decorators of your own.
+
+* Do not program defensively.
+  
+    http://www.erlang.se/doc/programming_rules.shtml#HDR11
+
+* Keep the code simple.
+
+* Don't overdesign.
+
+* Don't underdesign.
+
+* Avoid bugs.
+
+* Read other style guides and apply the parts that don't dissent with
+  this list.
+
+* Be consistent.
+
+* Use common sense.