refrigerator 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0c9e52b0092dba4efb2a5dff7fdb325f9c701edf
-  data.tar.gz: 24545654071f599ceb971ec29599e3275f7dd196
+SHA256:
+  metadata.gz: 39830c719366bd0e689b7a784879bd834e20f9f410a01aee24adb3bd5b7368ed
+  data.tar.gz: 7fd6dda21287843f916a63283a2aa9178aec16c89fff5c6bbd24b98e9d14ad67
 SHA512:
-  metadata.gz: de00ce2f90f0d7158a02e1fdd532f5f9d915bd3a84364158e86c1552ae6c0db3946b7456dbdd540eae77456b648a52f4017fedee79fb3be6522c62f82b2b51ac
-  data.tar.gz: 9c6d86426daedc0b3b5bf7ff25e8c5cdcaad9270d4600ef8b675631585dbc6ca83449caa514e8aa791e19e6ba0786ce53ce9cc4d7db8be262109951c30eb6301
+  metadata.gz: ae3d653e46d339c4b50417de2fff4bb8787c7595fc73ca5d66434533419a6a8afdf262dcac33b8b1e85f9828bcc414a5b96ca100f15fb52c1ca15c54a3aeac5c
+  data.tar.gz: 9a480c31c4a4ffccc58b3ebae576347eae7e70a39ba78978bda81fad767ad098ad2a367d26edcec1b39577a956190a63640c349a8016f3bc0284e38a638bdd82

data/CHANGELOG

@@ -1,3 +1,23 @@
+=== 1.4.0 (2021-12-25)
+
+* Support new classes and modules in Ruby 3.1 (jeremyevans)
+
+* Support new classes and modules in Ruby 3.0 (jeremyevans)
+
+=== 1.3.0 (2020-11-17)
+
+* Support new classes and modules in Ruby 2.7 (jeremyevans)
+
+=== 1.2.0 (2019-04-11)
+
+* Support new classes and modules in Ruby 2.6 (jeremyevans)
+
+=== 1.1.0 (2018-02-16)
+
+* Support new classes and modules in Ruby 2.5 (jeremyevans)
+
+* Work when the input field separator is changed from the default (jeremyevans) (#1)
+
 === 1.0.0 (2017-02-17)
 
 * Initial Public Release

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Jeremy Evans
+Copyright (c) 2017-2021 Jeremy Evans
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/README.rdoc

@@ -1,8 +1,8 @@
 = Refrigerator
 
 Refrigerator offers an easy way to freeze all ruby core classes and modules.
-It's designed to be used in production to make sure that no code is making
-unexpected changes to core classes or modules at runtime.
+It's designed to be used in production and when testing to make sure that no
+code is making unexpected changes to core classes or modules at runtime.
 
 = Installation
 
@@ -25,14 +25,16 @@ After loading all of the code for your application, you can call the
 This will freeze all core classes, so that modifications to them at runtime will
 raise exceptions.
 
+In a rack-based application, a good place to call `freeze_core` is at the end of the
+`config.ru` file.
+
 You can also pass an :except option to +freeze_core+ with an array of class names not to
 freeze:
 
   Refrigerator.freeze_core(:except=>['BasicObject'])
 
 One reason to exclude certain classes is because you know they will be modified at
-runtime.  For example, tilt (the ruby template library) modifies BasicObject at runtime 
-as part of template compilation.
+runtime.
 
 == check_require
 
@@ -49,7 +51,7 @@ The +check_require+ method takes the following options:
 :modules :: Define the given module names before freezing the core (array of symbols)
 :classes :: Define the given class names before freezing the core (array of symbols
             or two element arrays with class name symbol and superclass name symbol)
-:exclude :: Exclude the given class/module names from freezin (array of strings)
+:exclude :: Exclude the given class/module names from freezing (array of strings)
 :depends :: Any dependencies to require before freezing the core (array of strings)
 
 Without any options, +check_require+ will likely raise an exception, as it
@@ -78,11 +80,16 @@ And an example using Roda, a ruby web toolkit:
     :classes=>[:Roda]
 
 Note that many stdlib libraries will fail +check_require+ unless you use the
-:exclude option, for example, +set+:
+:exclude option, for example, +date+:
+
+  Refrigerator.check_require 'date',
+    :classes=>[:Date, [:DateTime, :Date]]
+  # Fails due to Time#to_date addition
 
-  Refrigerator.check_require 'set',
-    :classes=>[:Set, [:SortedSet, :Set]]
-  # Fails due to Enumerable#to_set addition
+  Refrigerator.check_require 'date',
+    :classes=>[:Date, [:DateTime, :Date]],
+    :exclude=>['Time']
+  # => true
 
 === bin/check_require
 
@@ -93,21 +100,23 @@ refrigerator ships with a +check_require+ binary that offers access to
   Usage: check_require [options] path
 
   Options:
-      -m, --modules [Module1,Module2]  define given modules under Object before freezing core classes
-      -c, --classes [Class1,Class2]    define given modules under Object before freezing core classes
-      -r, --require [foo,bar/baz]      require given libraries before freezing core classes
-      -e, --exclude [Object,Array]     exclude given core classes from freezing
-      -h, -?, --help                   Show this message
+    -m, --modules [Module1,Module2]  define given modules under Object before freezing core classes
+    -c [Class1,Class2/SuperclassOfClass2],
+        --classes                    define given classes under Object before freezing core classes
+    -r, --require [foo,bar/baz]      require given libraries before freezing core classes
+    -e, --exclude [Object,Array]     exclude given core classes from freezing
+    -h, -?, --help                   Show this message
 
 You can use this to easily check ruby libraries for issues when requiring.  For example, let's try
 with +open3+:
 
   $ bin/check_require open3
-  /usr/local/lib/ruby/2.4/open3.rb:32:in `<top (required)>': can't modify frozen #<Class:Object> (RuntimeError)
-          from /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require'
-          from /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require'
-          from /data/code/ruby-refrigerator/lib/refrigerator.rb:35:in `check_require'
-          from bin/check_require:42:in `<main>'
+  Traceback (most recent call last):
+          4: from bin/check_require:42:in `<main>'
+          3: from /home/billg/ruby-refrigerator/lib/refrigerator.rb:35:in `check_require'
+          2: from /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require'
+          1: from /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require'
+  /usr/local/lib/ruby/2.5/open3.rb:32:in `<top (required)>': can't modify frozen #<Class:Object> (FrozenError)
   $ bin/check_require -m Open3 open3
 
 As displayed above, open3 does not modify any core classes, beyond defining the +Open3+ module.
@@ -115,36 +124,45 @@ As displayed above, open3 does not modify any core classes, beyond defining the
 Let's try with +date+:
 
   $ bin/check_require date
-  /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require': can't modify frozen #<Class:Object> (RuntimeError)
-          from /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require'
-          from /usr/local/lib/ruby/2.4/date.rb:4:in `<top (required)>'
-          from /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require'
-          from /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require'
-          from /data/code/ruby-refrigerator/lib/refrigerator.rb:35:in `check_require'
-          from bin/check_require:42:in `<main>'
-  $ bin/check_require -e Object date
-  /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require': can't modify frozen class (RuntimeError)
-          from /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require'
-          from /usr/local/lib/ruby/2.4/date.rb:4:in `<top (required)>'
-          from /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require'
-          from /usr/local/lib/ruby/2.4/rubygems/core_ext/kernel_require.rb:55:in `require'
-          from /data/code/ruby-refrigerator/lib/refrigerator.rb:35:in `check_require'
-          from bin/check_require:42:in `<main>'
-  $ bin/check_require -e Object,Time date
-
-The first failure is because +date+ defines the +Date+ and +DateTime+ classes. Because
-+date+ is a native library written in C, you can't define the classes in advance, so
-you have to exclude the freezing of +Object+.  Note that it still fails in that case, but
-it doesn't even tell you why.  It turns out the reason is that +date+ also adds <tt>Time#to_date</tt>
-and other methods, so you need to exclude the freezing of +Time+ as well.
+  Traceback (most recent call last):
+          6: from bin/check_require:42:in `<main>'
+          5: from /home/billg/ruby-refrigerator/lib/refrigerator.rb:35:in `check_require'
+          4: from /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require'
+          3: from /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require'
+          2: from /usr/local/lib/ruby/2.5/date.rb:4:in `<top (required)>'
+          1: from /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require'
+  /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require': can't modify frozen #<Class:Object> (FrozenError)
+  $ bin/check_require -c Date,DateTime/Date date
+  Traceback (most recent call last):
+          6: from bin/check_require:42:in `<main>'
+          5: from /home/billg/ruby-refrigerator/lib/refrigerator.rb:35:in `check_require'
+          4: from /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require'
+          3: from /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require'
+          2: from /usr/local/lib/ruby/2.5/date.rb:4:in `<top (required)>'
+          1: from /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require'
+  /usr/local/lib/ruby/2.5/rubygems/core_ext/kernel_require.rb:59:in `require': can't modify frozen class (FrozenError)
+  $ bin/check_require -c Date,DateTime/Date -e Time date
+
+The first failure is because +date+ defines the +Date+ and +DateTime+ classes, so you
+must define those classes first, using a slash to separate DateTime from the superclass
+Date. Note that it still fails in that case, but it doesn't even tell you why.  It turns
+out the reason is that +date+ also adds +to_date+ and other methods to +Time+, so you
+need to exclude the freezing of +Time+ as well.
 
 Here are a couple more examples, using Sequel and Roda:
 
   bin/check_require -m Sequel -r bigdecimal,date,thread,time,uri sequel
   bin/check_require -c Roda -r rack,uri,fileutils,set,tmpdir,tempfile,thread,date,time roda
 
-Note that +bin/check_require+'s `-c` option does not support classes that do not subclass
-from +Object+.  You must use the +Refrigerator.check_require+ API in that case.
+== Supporting new ruby minor versions
+
+The list of constants that +freeze_core+ will freeze are stored in the module_names/*.txt files
+in the repository, with separate files per ruby minor version.  When new ruby minor versions are
+released, the +module_names+ rake task can be run with the new ruby minor version, and it will
+generate the appropriate file.  This task works by looking at ObjectSpace for all modules, with
+code similar to:
+
+  ObjectSpace.each_object(Module){|m| p m.name}
 
 = License
 

data/Rakefile

@@ -8,11 +8,19 @@ task :package=>[:clean] do |p|
   sh %{#{FileUtils::RUBY} -S gem build refrigerator.gemspec}
 end
 
+### Generate module_names
+
+desc "Generate module_names/*.txt file for current ruby version"
+task :module_names do
+  sh "#{FileUtils::RUBY} -e 'a = []; ObjectSpace.each_object(Module){|m| a << m.name.to_s}; File.open(\"module_names/#{RUBY_VERSION[0..2].sub('.', '')}.txt\", \"wb\"){|f| f.write(a.reject{|m| m.empty?}.sort.join(\"\\n\")); f.write(\"\\n\")}'"
+end
+
+
 ### Specs
 
 desc "Run specs"
 task :spec do
-  sh "#{FileUtils::RUBY} test/refrigerator_test.rb"
+  sh "#{FileUtils::RUBY} #{"-w" if RUBY_VERSION >= '3'} test/refrigerator_test.rb"
 end
 
 task :default => :spec

data/bin/check_require

@@ -20,8 +20,8 @@ options = OptionParser.new do |opts|
     cr_opts[:modules].concat v.split(',').map(&:to_sym)
   end
   
-  opts.on("-c", "--classes [Class1,Class2]", "define given modules under Object before freezing core classes") do  |v|
-    cr_opts[:classes].concat v.split(',').map(&:to_sym)
+  opts.on("-c", "--classes [Class1,Class2/SuperclassOfClass2]", "define given classes under Object before freezing core classes") do  |v|
+    cr_opts[:classes].concat v.split(',').map{|s| s.include?('/') ? s.split('/').map(&:to_sym) : s.to_sym}
   end
   
   opts.on("-r", "--require [foo,bar/baz]", "require given libraries before freezing core classes") do  |v|

data/lib/refrigerator.rb

@@ -1,11 +1,11 @@
 # Refrigerator allows for easily freezing core classes and modules.
 module Refrigerator
   version_int = RUBY_VERSION[0..2].sub('.', '').to_i
-  version_int = 24 if version_int > 24
+  version_int = 31 if version_int > 31
   
   # Array of strings containing class or module names.
   CORE_MODULES = File.read(File.expand_path(File.join(File.expand_path(__FILE__), "../../module_names/#{version_int}.txt"))).
-    split.
+    split(/\s+/).
     select{|m| eval("defined?(#{m})")}.
     each(&:freeze).
     freeze
@@ -30,8 +30,8 @@ module Refrigerator
     require 'rubygems'
     Array(opts[:depends]).each{|f| require f}
     Array(opts[:modules]).each{|m| Object.const_set(m, Module.new)}
-    Array(opts[:classes]).each{|c, *sc| Object.const_set(c, Class.new(sc.empty? ? Object : eval(sc.first)))}
-    freeze_core(:except=>%w'Gem Gem::Specification'+Array(opts[:exclude]))
+    Array(opts[:classes]).each{|c, *sc| Object.const_set(c, Class.new(sc.empty? ? Object : eval(sc.first.to_s)))}
+    freeze_core(:except=>%w'Gem Gem::Specification Gem::Deprecate'+Array(opts[:exclude]))
     require file
   end
 

data/module_names/25.txt

@@ -0,0 +1,287 @@
+ARGF.class
+ArgumentError
+Array
+BasicObject
+Binding
+Class
+ClosedQueueError
+Comparable
+Complex
+Complex::compatible
+Delegator
+DidYouMean
+DidYouMean::ClassNameChecker
+DidYouMean::ClassNameChecker::ClassName
+DidYouMean::Correctable
+DidYouMean::DeprecatedIgnoredCallers
+DidYouMean::Jaro
+DidYouMean::JaroWinkler
+DidYouMean::KeyErrorChecker
+DidYouMean::Levenshtein
+DidYouMean::MethodNameChecker
+DidYouMean::NullChecker
+DidYouMean::PlainFormatter
+DidYouMean::SpellChecker
+DidYouMean::VariableNameChecker
+Dir
+EOFError
+Encoding
+Encoding::CompatibilityError
+Encoding::Converter
+Encoding::ConverterNotFoundError
+Encoding::InvalidByteSequenceError
+Encoding::UndefinedConversionError
+EncodingError
+Enumerable
+Enumerator
+Enumerator::Generator
+Enumerator::Lazy
+Enumerator::Yielder
+Errno
+Errno::E2BIG
+Errno::EACCES
+Errno::EADDRINUSE
+Errno::EADDRNOTAVAIL
+Errno::EAFNOSUPPORT
+Errno::EAGAIN
+Errno::EALREADY
+Errno::EAUTH
+Errno::EBADF
+Errno::EBADMSG
+Errno::EBADRPC
+Errno::EBUSY
+Errno::ECANCELED
+Errno::ECHILD
+Errno::ECONNABORTED
+Errno::ECONNREFUSED
+Errno::ECONNRESET
+Errno::EDEADLK
+Errno::EDESTADDRREQ
+Errno::EDOM
+Errno::EDQUOT
+Errno::EEXIST
+Errno::EFAULT
+Errno::EFBIG
+Errno::EFTYPE
+Errno::EHOSTDOWN
+Errno::EHOSTUNREACH
+Errno::EIDRM
+Errno::EILSEQ
+Errno::EINPROGRESS
+Errno::EINTR
+Errno::EINVAL
+Errno::EIO
+Errno::EIPSEC
+Errno::EISCONN
+Errno::EISDIR
+Errno::ELOOP
+Errno::EMEDIUMTYPE
+Errno::EMFILE
+Errno::EMLINK
+Errno::EMSGSIZE
+Errno::ENAMETOOLONG
+Errno::ENEEDAUTH
+Errno::ENETDOWN
+Errno::ENETRESET
+Errno::ENETUNREACH
+Errno::ENFILE
+Errno::ENOATTR
+Errno::ENOBUFS
+Errno::ENODEV
+Errno::ENOENT
+Errno::ENOEXEC
+Errno::ENOLCK
+Errno::ENOMEDIUM
+Errno::ENOMEM
+Errno::ENOMSG
+Errno::ENOPROTOOPT
+Errno::ENOSPC
+Errno::ENOSYS
+Errno::ENOTBLK
+Errno::ENOTCONN
+Errno::ENOTDIR
+Errno::ENOTEMPTY
+Errno::ENOTRECOVERABLE
+Errno::ENOTSOCK
+Errno::ENOTSUP
+Errno::ENOTTY
+Errno::ENXIO
+Errno::EOPNOTSUPP
+Errno::EOVERFLOW
+Errno::EOWNERDEAD
+Errno::EPERM
+Errno::EPFNOSUPPORT
+Errno::EPIPE
+Errno::EPROCLIM
+Errno::EPROCUNAVAIL
+Errno::EPROGMISMATCH
+Errno::EPROGUNAVAIL
+Errno::EPROTO
+Errno::EPROTONOSUPPORT
+Errno::EPROTOTYPE
+Errno::ERANGE
+Errno::EREMOTE
+Errno::EROFS
+Errno::ERPCMISMATCH
+Errno::ESHUTDOWN
+Errno::ESOCKTNOSUPPORT
+Errno::ESPIPE
+Errno::ESRCH
+Errno::ESTALE
+Errno::ETIMEDOUT
+Errno::ETOOMANYREFS
+Errno::ETXTBSY
+Errno::EUSERS
+Errno::EXDEV
+Errno::NOERROR
+Exception
+FalseClass
+Fiber
+FiberError
+File
+File::Constants
+File::Stat
+FileTest
+Float
+FloatDomainError
+FrozenError
+GC
+GC::Profiler
+Gem
+Gem::BasicSpecification
+Gem::CommandLineError
+Gem::ConflictError
+Gem::Dependency
+Gem::DependencyError
+Gem::DependencyRemovalException
+Gem::DependencyResolutionError
+Gem::Deprecate
+Gem::DocumentError
+Gem::EndOfYAMLException
+Gem::ErrorReason
+Gem::Exception
+Gem::FilePermissionError
+Gem::FormatException
+Gem::GemNotFoundException
+Gem::GemNotInHomeException
+Gem::ImpossibleDependenciesError
+Gem::InstallError
+Gem::InvalidSpecificationException
+Gem::List
+Gem::LoadError
+Gem::MissingSpecError
+Gem::MissingSpecVersionError
+Gem::OperationNotSupportedError
+Gem::PathSupport
+Gem::Platform
+Gem::PlatformMismatch
+Gem::RemoteError
+Gem::RemoteInstallationCancelled
+Gem::RemoteInstallationSkipped
+Gem::RemoteSourceException
+Gem::Requirement
+Gem::Requirement::BadRequirementError
+Gem::RubyVersionMismatch
+Gem::RuntimeRequirementNotMetError
+Gem::SourceFetchProblem
+Gem::SpecificGemNotFoundException
+Gem::Specification
+Gem::StubSpecification
+Gem::StubSpecification::StubLine
+Gem::SystemExitException
+Gem::UnsatisfiableDependencyError
+Gem::VerificationError
+Gem::Version
+Hash
+IO
+IO::EAGAINWaitReadable
+IO::EAGAINWaitWritable
+IO::EINPROGRESSWaitReadable
+IO::EINPROGRESSWaitWritable
+IO::WaitReadable
+IO::WaitWritable
+IO::generic_readable
+IO::generic_writable
+IOError
+IndexError
+Integer
+Interrupt
+Kernel
+KeyError
+LoadError
+LocalJumpError
+Marshal
+MatchData
+Math
+Math::DomainError
+Method
+Module
+Monitor
+MonitorMixin
+MonitorMixin::ConditionVariable
+MonitorMixin::ConditionVariable::Timeout
+NameError
+NameError::message
+NilClass
+NoMemoryError
+NoMethodError
+NotImplementedError
+Numeric
+Object
+ObjectSpace
+ObjectSpace::WeakMap
+Proc
+Process
+Process::GID
+Process::Status
+Process::Sys
+Process::Tms
+Process::UID
+Process::Waiter
+Random
+Random::Formatter
+Range
+RangeError
+Rational
+Rational::compatible
+RbConfig
+Regexp
+RegexpError
+RubyVM
+RubyVM::InstructionSequence
+RuntimeError
+ScriptError
+SecurityError
+Signal
+SignalException
+SimpleDelegator
+StandardError
+StopIteration
+String
+StringIO
+Struct
+Symbol
+SyntaxError
+SystemCallError
+SystemExit
+SystemStackError
+Thread
+Thread::Backtrace
+Thread::Backtrace::Location
+Thread::ConditionVariable
+Thread::Mutex
+Thread::Queue
+Thread::SizedQueue
+ThreadError
+ThreadGroup
+Time
+TracePoint
+TrueClass
+TypeError
+UnboundMethod
+UncaughtThrowError
+UnicodeNormalize
+Warning
+Warning::buffer
+ZeroDivisionError
+fatal