immutability 0.0.1

data/config/metrics/cane.yml

@@ -0,0 +1,5 @@
+---
+abc_max: "10"
+line_length: "80"
+no_doc: "y"
+no_readme: "y"

data/config/metrics/churn.yml

@@ -0,0 +1,6 @@
+---
+ignore_files:
+- spec
+- config
+minimum_churn_count: 0
+start_date: "1 year ago"

data/config/metrics/flay.yml

@@ -0,0 +1,2 @@
+---
+minimum_score: 8

data/config/metrics/metric_fu.yml

@@ -0,0 +1,14 @@
+---
+folders: # The list of folders to be used by any metric.
+- lib
+metrics: # The list of allowed metrics. The other metrics are disabled.
+- cane
+- churn
+- flay
+- flog
+- reek
+- roodi
+- saikuro
+format: html
+output: tmp/metric_fu
+verbose: false

data/config/metrics/reek.yml

@@ -0,0 +1 @@
+---

data/config/metrics/roodi.yml

@@ -0,0 +1,24 @@
+---
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:
+  line_count: 100
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:
+CyclomaticComplexityBlockCheck:
+  complexity: 2
+CyclomaticComplexityMethodCheck:
+  complexity: 3
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:
+  line_count: 6
+MethodNameCheck:
+  pattern: !ruby/regexp /^[\||\^|\&|\!]$|^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:
+  line_count: 120
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:
+  parameter_count: 4

data/config/metrics/rubocop.yml

@@ -0,0 +1,71 @@
+---
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - '**/*_spec.rb'
+
+Lint/RescueException:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AccessorMethodName:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineMethods:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  Exclude:
+    - '**/*_spec.rb'

data/config/metrics/saikuro.yml

@@ -0,0 +1,3 @@
+---
+warn_cyclo:  3
+error_cyclo: 4

data/config/metrics/simplecov.yml

@@ -0,0 +1,6 @@
+---
+output: tmp/coverage
+filters: # The list of paths to be excluded from coverage checkup
+- "spec/"
+- "config/"
+groups: []

data/config/metrics/yardstick.yml

@@ -0,0 +1,37 @@
+---
+# Settings added by the 'hexx-suit' gem
+output: "tmp/yardstick/output.log"
+path: "lib/**/*.rb"
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: false
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []
+threshold: 100
+verbose: false

data/immutability.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "immutability/version"
+
+Gem::Specification.new do |gem|
+
+  gem.name        = "immutability"
+  gem.version     = Immutability::VERSION.dup
+  gem.author      = "Andrew Kozin"
+  gem.email       = "andrew.kozin@gmail.com"
+  gem.homepage    = "https://github.com/nepalez/immutability"
+  gem.summary     = "Make instances immutable (deeply frozen) and versioned"
+  gem.license     = "MIT"
+
+  gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files       = Dir["spec/**/*.rb"]
+  gem.extra_rdoc_files = Dir["README.md", "LICENSE"]
+  gem.require_paths    = ["lib"]
+
+  gem.required_ruby_version = ">= 1.9.3"
+
+  gem.add_runtime_dependency "ice_nine", "~> 0.11.1"
+
+  gem.add_development_dependency "hexx-rspec", "~> 0.5"
+
+end # Gem::Specification

data/lib/immutability.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+require "ice_nine"
+
+require_relative "immutability/with_memory"
+
+# Makes the object immutable (deeply frozen) with possibility to remember
+# and forget previous states (snapshots).
+#
+# Uses 'ice_nine' to freeze object deeply by the initializer
+#
+# @example Without memory
+#   require "immutability"
+#
+#   class User
+#     include Immutability
+#
+#     attr_reader :name
+#
+#     def initialize(name)
+#       @name = name
+#     end
+#   end
+#
+#   user = User.new "Andre"
+#   user.name             # => "Andre"
+#   # It is frozen deeply
+#   user.frozen?          # => true
+#   user.name.frozen?     # => true
+#
+#   new_user = user.update { @name = "Andrew" }
+#   new_user.name         # => "Andrew"
+#   # It is frozen deeply
+#   new_user.frozen?      # => true
+#   new_user.name.frozen? # => true
+#
+# @example With memory
+#   class User
+#     include Immutability.with_memory
+#
+#     attr_reader :name
+#
+#     def initialize(name)
+#       @name = name
+#     end
+#   end
+#
+#   user = User.new "Andre"
+#   user.name             # => "Andre"
+#   # It has version and reference to the parent (nil for the first version)
+#   user.version          # => 0
+#   user.parent           # => nil
+#
+#   new_user = user.update { @name = "Andrew" }
+#   new_user.name         # => "Andrew"
+#   # It stores current version and reference to the parent
+#   new_user.version      # => 1
+#   new_user.parent       # => #<User @name="Andre">
+#
+#   mankurt = new_user.forget_history
+#   mankurt.name          # => "Andrew"
+#   # It doesn't refer to previous states (they can be garbage collected)
+#   mankurt.version       # => 0
+#   mankurt.parent        # => nil
+#
+# @author Andrew Kozin <Andrew.Kozin@gmail.com>
+#
+module Immutability
+
+  # Methods to be added to class, that included the `Immutability` module
+  #
+  # @api private
+  #
+  module ClassMethods
+
+    # Reloads instance's constructor to make it immutable
+    #
+    # @api private
+    #
+    # @param [Object, Array<Object>] args
+    #
+    # @return [Object]
+    #
+    def new(*args)
+      IceNine.deep_freeze __new__(*args)
+    end
+
+    private
+
+    def __new__(*args, &block)
+      allocate.tap do |instance|
+        instance.__send__(:initialize, *args)
+        instance.instance_eval(&block) if block_given?
+      end
+    end
+
+  end # module ClassMethods
+
+  # Returns the new immutable instances that preserves old variables and
+  # updates some of them from inside the block
+  #
+  # @param [Proc] block
+  #   The block to be evaluated by new instance's "initializer"
+  #
+  # @return [Object] the updated instance
+  #
+  def update(&block)
+    instance = dup
+    instance.instance_eval(&block) if block_given?
+    IceNine.deep_freeze(instance)
+  end
+
+  # @private
+  def self.included(klass)
+    klass.instance_exec(ClassMethods) { |mod| extend(mod) }
+  end
+
+  # Returns the module extended by features to record history
+  #
+  # @return [Module]
+  #
+  def self.with_memory
+    WithMemory
+  end
+
+end # module Immutability

data/lib/immutability/rspec.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+# Loads spec matcher to check the immutability
+require_relative "../../spec/support/immutable"

data/lib/immutability/version.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Immutability
+
+  # The semantic version of the gem.
+  # @see http://semver.org/ Semantic versioning 2.0
+  VERSION = "0.0.1".freeze
+
+end # module Immutability

data/lib/immutability/with_memory.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module Immutability
+
+  # Extends +Immutability+ to remember version and previous state of instance.
+  #
+  # @author Andrew Kozin <Andrew.Kozin@gmail.com>
+  #
+  module WithMemory
+
+    # @private
+    class << self
+      private
+
+      def included(klass)
+        klass.__send__ :include, Immutability
+        klass.__send__ :extend,  ClassMethods
+        klass.__send__ :define_method, :update, update
+      end
+
+      # Redefines the +update+ so that it increment version and refer
+      # to the previous snapshot of the continuous object
+      #
+      def update
+        proc do |&block|
+          current = [(version + 1), self]
+          super() do
+            @version, @parent = current
+            instance_eval(&block) if block
+          end
+        end
+      end
+    end
+
+    # Adds version and parent variables to newly created instance
+    #
+    module ClassMethods
+      private
+
+      def __new__(*args)
+        super(*args) { @version, @parent = 0 }
+      end
+    end
+
+    # @!attribute [r] version
+    #
+    # @return [Integer] the current version number of the instance
+    #
+    attr_reader :version
+
+    # @!attribute [r] parent
+    #
+    # @return [Object] the previous version (immutable instance)
+    #
+    attr_reader :parent
+
+    # Forgets the previous history of the object
+    #
+    # Returns a new instance with the same variables,
+    # except for [#version] and [#parent] that are set to +0+ and +nil+.
+    #
+    # @return [Object]
+    #
+    def forget_history
+      update { @version, @parent = 0 }
+    end
+
+  end # module WithMemory
+
+end # module Immutability

data/spec/shared/user.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+shared_examples :user do
+  before do
+    class User
+      attr_reader :name, :age
+
+      def initialize(name, age)
+        @name = name
+        @age  = age
+      end
+    end
+  end
+
+  after { Object.send :remove_const, :User }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+begin
+  require "hexx-suit"
+  Hexx::Suit.load_metrics_for(self)
+rescue LoadError
+  require "hexx-rspec"
+  Hexx::RSpec.load_metrics_for(self)
+end
+
+# Loads the code under test
+require "immutability"
+
+# Loads custom matchers
+require "immutability/rspec"
+
+# Loads shared examples
+require_relative "shared/user"