immutability 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: f8d657925469b79af0254ac672766659aad0406d
-  data.tar.gz: 9f00806f764b8f16ae948453f212347d29d0939d
-SHA512: 
-  metadata.gz: 77ba2967808ef4d0ef6904209edd9ef490dc171de94f55933d80e816305320c0118f65540c375bdba416139f76d548b1b9477f3da9e84a0875247f6c7b12a7f3
-  data.tar.gz: f2bad0c884a0591e27c44d6dc5df7a2ff4eacbddb007afbb668f1a33ecfb6b323151b6e84670296162c4e968bec098f1e282160b6a48362fc59ac4965a1d1054
+---
+SHA1:
+  metadata.gz: b5b988e1aad5ffa23a6021cd8ef3a93eb996a8f0
+  data.tar.gz: 534a78582224f3587a0e72af50423c40d10fc9ad
+SHA512:
+  metadata.gz: 50569698c05f0ff753b6a865c12aa2241653fa966fcf8404aba2781bf0c0553755520aeb7c02e4bcd5a7c4d4fb6508861a4af8beba4c595dcbb37075ff96fb49
+  data.tar.gz: 76ba454dc1c64cabefe26ad0baa6a584473564cc0ff234862e86a234655f3b400405ba6e0047f0411a6c7952679847c83e34c0b4866bb8b1c78d95bb6af6ae1f

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.0.4 2015-09-10
+
+The small release (backward-compatible) adds `frozen_double` to rspec helper methods.
+
+### Added
+
+- The `frozen_double` helper for attributes of immutable objects' initializers (nepalez)
+
+[Compare v0.0.3...v0.0.4](https://github.com/nepalez/immutability/compare/v0.0.3...v0.0.4)
+
 ## v0.0.3 2015-09-25
 
 The patch fixes bug in matcher that broke gems:

data/README.md

@@ -141,8 +141,10 @@ reborn_andrew.version # => 0
 reborn_andrew.parent  # => nil
 ```
 
-RSpec helper
-------------
+RSpec
+-----
+
+### be_immutable
 
 Include `immutability/rspec` and use `be_immutable` RSpec matcher to check, whether an instance is deeply immutable (with all its variables):
 
@@ -158,6 +160,30 @@ end
 
 The matcher will pass if both the object and all its variables are immutable at any level of nesting.
 
+### frozen_double
+
+Initializers of immutable objects freeze their variables deeply. When you send doubles as arguments for this initializer, RSpec will warn you about trying to freeze that double. To avoid the problem, use `frozen_double` instead of `double`:
+
+```ruby
+include "immutability/rspec"
+
+describe User, "#name" do
+  subject { User.new(name, 44).name }
+
+  let(:name) { frozen_double :name, to_s: "Andrew" }
+
+  it { is_expected.to eql "Andrew" }
+end
+```
+
+The method returns an rspec double with two methods added:
+
+```ruby
+name = frozen_double :name, to_s: "Andrew"
+name.frozen?        # => true
+name.freeze == name # => true
+```
+
 Installation
 ------------
 

data/lib/immutability/rspec.rb

@@ -2,3 +2,4 @@
 
 # Loads spec matcher to check the immutability
 require_relative "../../spec/support/immutable"
+require_relative "../../spec/support/frozen_double"

data/lib/immutability/version.rb

@@ -4,6 +4,6 @@ module Immutability
 
   # The semantic version of the gem.
   # @see http://semver.org/ Semantic versioning 2.0
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 
 end # module Immutability

data/spec/support/frozen_double.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+RSpec.configure do |config|
+  mod = Module.new do
+    # Returns the double with +#frozen?+ and +#freeze+ methods defined
+    #
+    def frozen_double(*args)
+      options  = args.pop if args.last.instance_of?(Hash)
+      name     = args.first
+      instance = double name, options.merge(frozen?: true)
+      allow(instance).to receive(:freeze).and_return(instance)
+
+      instance
+    end
+  end
+
+  config.include mod
+end

data/spec/support/immutable.rb

@@ -13,14 +13,12 @@ RSpec::Matchers.define :be_immutable do
     return false if value.nil?
     return false if value.equal? true
     return false if value.equal? false
-    return false if !value.class.respond_to?(:new)
+    return false unless value.class.respond_to?(:new)
     true
   end
 
   match do |instance|
-    if can_be_frozen? instance
-      expect(instance).to be_frozen
-    end
+    expect(instance).to be_frozen if can_be_frozen?(instance)
 
     if instance.is_a? Hash
       instance.each do |k, v|

metadata

@@ -1,53 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: immutability
-version: !ruby/object:Gem::Version 
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2015-09-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ice_nine
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
         version: 0.11.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hexx-rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.5"
+  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
-  version_requirements: *id002
+  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: 
+extra_rdoc_files:
 - README.md
 - LICENSE
-files: 
-- .coveralls.yml
-- .gitignore
-- .metrics
-- .rspec
-- .rubocop.yml
-- .travis.yml
-- .yardopts
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".metrics"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -73,42 +78,41 @@ files:
 - lib/immutability/with_memory.rb
 - spec/shared/user.rb
 - spec/spec_helper.rb
+- spec/support/frozen_double.rb
 - spec/support/immutable.rb
 - spec/unit/immutability/object_spec.rb
 - spec/unit/immutability/with_memory_spec.rb
 - spec/unit/immutability_spec.rb
 homepage: https://github.com/nepalez/immutability
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
+    - !ruby/object:Gem::Version
       version: 1.9.3
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Make instances immutable (deeply frozen) and versioned
-test_files: 
+test_files:
 - spec/spec_helper.rb
 - spec/unit/immutability_spec.rb
-- spec/support/immutable.rb
-- spec/shared/user.rb
 - spec/unit/immutability/object_spec.rb
 - spec/unit/immutability/with_memory_spec.rb
+- spec/support/frozen_double.rb
+- spec/support/immutable.rb
+- spec/shared/user.rb
 has_rdoc: