fully_freeze 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0a581d3aed0b47fc00f843514ef0503958a17eb
+  data.tar.gz: 2ef945bcb85dd6882c27ccc8f0937221770292e4
+SHA512:
+  metadata.gz: 318cec302b0a08c1f085adb44d406ab2ff327a2d6c58a6166cc7ba07f51b1bfa5697581b3081e616c4c950c950ba502a7fd5c64bedfaabeb3579c0148c6205ea
+  data.tar.gz: 6aa5fb042ffc48486ab4a8563ace870c88c6431bcac93daa53c2a73805e8315a8ab0c73a2cb4852c1baccc2d0b2928d0e499bea3cc28f85511bfd4c5820e0dfe

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fully_freeze.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 PeterCamilleri
+
+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,79 @@
+# FullyFreeze
+
+This gem is created in recognition of two hot topics in Ruby programming.
+
+Namely:
+
+* Multi-threaded programming with guilds.
+* Functional programming.
+
+While these topics are outside the scope of this gem, both are facilitated by
+the concept of treating data as immutable, pure values.
+
+While many data types in Ruby are immutable, many are not. Further, while the
+freeze method is provided to make data immutable, and the frozen? method can be
+used to determine if data is immutable, neither of these methods digs down into
+the interior of the object to make those data immutable as well.
+
+The fully_freeze gem does not take such half measures. Instead it digs deep
+into the objects and gets the job done!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fully_freeze'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fully_freeze
+
+## Usage
+
+    require 'fully_freeze'
+
+Then when a deep freeze is needed use:
+
+    foo = my_object.fully_freeze
+
+and to determine if that data is really immutable, use:
+
+    if my_object.fully_frozen?
+      # etc etc etc...
+    end
+
+And that is all there is too it!
+
+*Note:* While this gem does employ monkey-patching, no existing methods are
+modified, so the risk level is low.
+
+## 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
+
+OR...
+
+* Make a suggestion by raising an
+ [issue](https://github.com/PeterCamilleri/fully_freeze/issues)
+. All ideas and comments are welcome.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the fully_freeze project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/fully_freeze.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fully_freeze/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fully_freeze"
+  spec.version       = FullyFreeze::VERSION
+  spec.authors       = ["PeterCamilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.summary       = %q{Deep, recursive freeze tools.}
+  spec.description   = %q{A deep, recursive freeze and freeze tester.}
+  spec.homepage      = "https://github.com/PeterCamilleri/fully_freeze"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(test|docs)/})
+                        end
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'minitest_visible', "~> 0.1"
+  spec.add_development_dependency 'reek', "~> 5.0.2"
+  
+end

data/lib/fully_freeze.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# A deep, recursive freeze and freeze tester.
+
+
+require_relative 'fully_freeze/use_self'
+require_relative 'fully_freeze/use_freeze'
+
+require_relative 'fully_freeze/array'
+require_relative 'fully_freeze/hash'
+require_relative 'fully_freeze/struct'
+require_relative 'fully_freeze/object'
+
+require_relative 'fully_freeze/version'

data/lib/fully_freeze/array.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+# Add fully_freeze support to the array class.
+class Array
+
+  # Do fully_freeze the array.
+  def fully_freeze(progress={})
+    progress[object_id] = freeze
+
+    each do |value|
+      value.fully_freeze(progress) unless progress[value.object_id]
+    end
+
+    self
+  end
+
+  # Is this array fully_frozen?
+  def fully_frozen?(progress={})
+    return false unless frozen?
+
+    progress[object_id] = self
+
+    each do |value|
+      return false unless progress[value.object_id] || value.fully_frozen?(progress)
+    end
+
+    true
+  end
+
+end

data/lib/fully_freeze/hash.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+# Add fully_freeze support to the hash class.
+class Hash
+
+  # Do fully_freeze the hash.
+  def fully_freeze(progress={})
+    progress[object_id] = freeze
+
+    each_pair do |key, value|
+      key.fully_freeze(progress)   unless progress[key.object_id]
+      value.fully_freeze(progress) unless progress[value.object_id]
+    end
+
+    self
+  end
+
+  # Is this hash fully_frozen?
+  def fully_frozen?(progress={})
+    return false unless frozen?
+
+    progress[object_id] = self
+
+    each_pair do |key, value|
+      return false unless progress[key.object_id]   || key.fully_frozen?(progress)
+      return false unless progress[value.object_id] || value.fully_frozen?(progress)
+    end
+
+    true
+  end
+
+end

data/lib/fully_freeze/object.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+# Add fully_freeze support to the object class.
+class Object
+
+  # Do fully_freeze the object.
+  def fully_freeze(progress={})
+    progress[object_id] = freeze
+
+    instance_variables.each do |name|
+      value = instance_variable_get(name)
+      value.fully_freeze(progress) unless progress[value.object_id]
+    end
+
+    self
+  end
+
+  # Is this object fully_frozen?
+  def fully_frozen?(progress={})
+    return false unless frozen?
+
+    progress[object_id] = self
+
+    instance_variables.each do |name|
+      value = instance_variable_get(name)
+      return false unless progress[value.object_id] || value.fully_frozen?(progress)
+    end
+
+    true
+  end
+
+end

data/lib/fully_freeze/struct.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+# Add fully_freeze support to the struct class.
+class Struct
+
+  # Do fully_freeze the struct.
+  def fully_freeze(progress={})
+    progress[object_id] = freeze
+
+    members.each do |name|
+      value = self[name]
+      value.fully_freeze(progress) unless progress[value.object_id]
+    end
+
+    self
+  end
+
+  # Is this struct fully_frozen?
+  def fully_frozen?(progress={})
+    return false unless frozen?
+
+    progress[object_id] = self
+
+    members.each do |name|
+      value = self[name]
+      return false unless progress[value.object_id] || value.fully_frozen?(progress)
+    end
+
+    true
+  end
+
+
+end

data/lib/fully_freeze/use_freeze.rb

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+# The mixin for classes where freeze is just simple freeze.
+module FullyFreezeFreeze
+  def fully_freeze(_progress=nil)
+    freeze
+  end
+
+  def fully_frozen?(_progress=nil)
+    frozen?
+  end
+end
+
+# Strings answer freeze.
+class String
+  include FullyFreezeFreeze
+end
+
+# Ranges answer freeze.
+class Range
+  include FullyFreezeFreeze
+end
+
+# Enumerators answer freeze.
+class Enumerator
+  include FullyFreezeFreeze
+end
+
+# MatchData answer freeze.
+class MatchData
+  include FullyFreezeFreeze
+end
+
+# Regular expressions answer freeze.
+class Regexp
+  include FullyFreezeFreeze
+end
+
+# Threads answer freeze.
+class Thread
+  include FullyFreezeFreeze
+end
+
+# Complex are an exception, they answer freeze.
+class Complex
+  include FullyFreezeFreeze
+end
+
+# Rational are an exception, they answer freeze.
+class Rational
+  include FullyFreezeFreeze
+end

data/lib/fully_freeze/use_self.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+# A mixin for classes where the freeze is the object itself.
+module FullyFreezeSelf
+  def fully_freeze(_progress=nil)
+    self
+  end
+
+  def fully_frozen?(_progress=nil)
+    true
+  end
+end
+
+# By default, Numerics answer self.
+class Numeric
+  include FullyFreezeSelf
+end
+
+# NilClass objects (nil) answer self.
+class NilClass
+  include FullyFreezeSelf
+end
+
+# TrueClass objects (true) answer self.
+class TrueClass
+  include FullyFreezeSelf
+end
+
+# FalseClass objects (false) answer self.
+class FalseClass
+  include FullyFreezeSelf
+end
+
+# Symbols answer self.
+class Symbol
+  include FullyFreezeSelf
+end

data/lib/fully_freeze/version.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+# A deep, recursive freeze. Adds the fully_freeze and fully_frozen? methods.
+module FullyFreeze
+  VERSION = "0.1.0".freeze
+  
+  DESCRIPTION = "A deep, recursive freeze and freeze tester.".freeze
+end

data/rakefile.rb

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+desc "What version of format_output is this?"
+task :vers do |t|
+  puts
+  puts "fully_freeze version = #{::FullyFreeze::VERSION}"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: fully_freeze
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PeterCamilleri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+description: A deep, recursive freeze and freeze tester.
+email:
+- peter.c.camilleri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- fully_freeze.gemspec
+- lib/fully_freeze.rb
+- lib/fully_freeze/array.rb
+- lib/fully_freeze/hash.rb
+- lib/fully_freeze/object.rb
+- lib/fully_freeze/struct.rb
+- lib/fully_freeze/use_freeze.rb
+- lib/fully_freeze/use_self.rb
+- lib/fully_freeze/version.rb
+- rakefile.rb
+homepage: https://github.com/PeterCamilleri/fully_freeze
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Deep, recursive freeze tools.
+test_files: []