refrigerator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c9e52b0092dba4efb2a5dff7fdb325f9c701edf
+  data.tar.gz: 24545654071f599ceb971ec29599e3275f7dd196
+SHA512:
+  metadata.gz: de00ce2f90f0d7158a02e1fdd532f5f9d915bd3a84364158e86c1552ae6c0db3946b7456dbdd540eae77456b648a52f4017fedee79fb3be6522c62f82b2b51ac
+  data.tar.gz: 9c6d86426daedc0b3b5bf7ff25e8c5cdcaad9270d4600ef8b675631585dbc6ca83449caa514e8aa791e19e6ba0786ce53ce9cc4d7db8be262109951c30eb6301

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 1.0.0 (2017-02-17)
+
+* Initial Public Release

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2017 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
+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 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.rdoc

@@ -0,0 +1,155 @@
+= 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.
+
+= Installation
+
+  gem install refrigerator
+
+= Source Code
+
+Source code is available on GitHub at https://github.com/jeremyevans/ruby-refrigerator
+
+= Usage
+
+== freeze_core
+
+After loading all of the code for your application, you can call the
++freeze_core+ method to freeze all core classes:
+
+  require 'refrigerator'
+  Refrigerator.freeze_core
+
+This will freeze all core classes, so that modifications to them at runtime will
+raise exceptions.
+
+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.
+
+== check_require
+
+Refrigerator also offers a +check_require+ method for checking libraries for modifications
+to the core classes.  It allows you to easily see what fails when when you try to require
+the library with a frozen core, and offers some options that you can use to try to get
+the require to not raise an exception.  This allows you to see what changes the library
+makes to the core classes.  Here's an example of basic use:
+
+  Refrigerator.check_require('open3', :modules=>[:Open3])
+
+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)
+:depends :: Any dependencies to require before freezing the core (array of strings)
+
+Without any options, +check_require+ will likely raise an exception, as it
+freezes the core before requiring, and if the required files tries to add a
+class or module to the global namespace, that will fail.  The :modules and :classes
+options exist so that you can predefine the class so that the required file
+will reopen the existing class instead of defining a new class.
+
+The :depends option can be easily used to load all dependencies of the required
+file before freezing the core.  This is also necessary in most cases, especially
+when using the stdlib, since many stdlib files modify the core classes in ways
+beyond adding modules or classes. The :exclude option is basically a last resort,
+where you can disable the freezing of certain core classes, if you know the
+required library modifies them.
+
+Here's an example using Sequel, a ruby database toolkit:
+
+  Refrigerator.check_require 'sequel',
+    :depends=>%w'bigdecimal date thread time uri',
+    :modules=>[:Sequel]
+
+And an example using Roda, a ruby web toolkit:
+ 
+  Refrigerator.check_require 'roda',
+    :depends=>%w'rack uri fileutils set tmpdir tempfile thread date time',
+    :classes=>[:Roda]
+
+Note that many stdlib libraries will fail +check_require+ unless you use the
+:exclude option, for example, +set+:
+
+  Refrigerator.check_require 'set',
+    :classes=>[:Set, [:SortedSet, :Set]]
+  # Fails due to Enumerable#to_set addition
+
+=== bin/check_require
+
+refrigerator ships with a +check_require+ binary that offers access to
++Refrigerator.check_require+ from the command line.  Here's the usage:
+
+  $ bin/check_require
+  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
+
+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>'
+  $ bin/check_require -m Open3 open3
+
+As displayed above, open3 does not modify any core classes, beyond defining the +Open3+ module.
+
+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.
+
+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.
+
+= License
+
+MIT
+
+= Author
+
+Jeremy Evans <code@jeremyevans.net>

data/Rakefile

@@ -0,0 +1,46 @@
+require "rake"
+require "rake/clean"
+
+CLEAN.include ["refrigerator-*.gem", "rdoc", "coverage"]
+
+desc "Build refrigerator gem"
+task :package=>[:clean] do |p|
+  sh %{#{FileUtils::RUBY} -S gem build refrigerator.gemspec}
+end
+
+### Specs
+
+desc "Run specs"
+task :spec do
+  sh "#{FileUtils::RUBY} test/refrigerator_test.rb"
+end
+
+task :default => :spec
+
+### RDoc
+
+RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'Refrigerator: Freeze core ruby classes']
+
+begin
+  gem 'rdoc'
+  gem 'hanna-nouveau'
+  RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
+rescue Gem::LoadError
+end
+
+rdoc_task_class = begin
+  require "rdoc/task"
+  RDoc::Task
+rescue LoadError
+  require "rake/rdoctask"
+  Rake::RDocTask
+end
+
+RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
+
+rdoc_task_class.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.options += RDOC_OPTS
+  rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
+end
+

data/bin/check_require

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen-string-literal: true
+
+require 'optparse'
+require File.join(File.expand_path(__FILE__), '../../lib/refrigerator')
+
+cr_opts = {:modules => [], :classes => [], :depends => [], :exclude => []}
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: check_require [options] path"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on_tail("-h", "-?", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on("-m", "--modules [Module1,Module2]", "define given modules under Object before freezing core classes") do  |v|
+    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)
+  end
+  
+  opts.on("-r", "--require [foo,bar/baz]", "require given libraries before freezing core classes") do  |v|
+    cr_opts[:depends].concat v.split(',')
+  end
+  
+  opts.on("-e", "--exclude [Object,Array]", "exclude given core classes from freezing") do  |v|
+    cr_opts[:exclude].concat v.split(',')
+  end
+end
+options.parse!
+
+if ARGV.length != 1
+  puts options
+  exit 1
+end
+
+Refrigerator.check_require(ARGV.first, cr_opts)

data/lib/refrigerator.rb

@@ -0,0 +1,39 @@
+# 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
+  
+  # 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.
+    select{|m| eval("defined?(#{m})")}.
+    each(&:freeze).
+    freeze
+
+  # Default frozen options hash
+  OPTS = {}.freeze
+
+  # Freeze core classes and modules.  Options:
+  # :except :: Don't freeze any of the classes modules listed (array of strings)
+  def self.freeze_core(opts=OPTS)
+    (CORE_MODULES - Array(opts[:except])).each{|m| eval(m).freeze}
+    nil
+  end
+
+  # Check that requiring a given file does not modify any core classes. Options:
+  # :depends :: Require the given files before freezing the core (array of strings)
+  # :modules :: Define the given modules in the Object namespace before freezing the core (array of module name symbols)
+  # :classes :: Define the given classes in the Object namespace before freezing the core (array of either class name Symbols or
+  #             array with class Name Symbol and Superclass name string)
+  # :except :: Don't freeze any of the classes modules listed (array of strings)
+  def self.check_require(file, opts=OPTS)
+    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]))
+    require file
+  end
+
+  freeze
+end

data/module_names/18.txt

@@ -0,0 +1,157 @@
+ArgumentError
+Array
+Bignum
+Binding
+Class
+Comparable
+Continuation
+Data
+Dir
+EOFError
+Enumerable
+Enumerable::Enumerator
+Errno
+Errno::E2BIG
+Errno::EACCES
+Errno::EADDRINUSE
+Errno::EADDRNOTAVAIL
+Errno::EAFNOSUPPORT
+Errno::EAGAIN
+Errno::EALREADY
+Errno::EBADF
+Errno::EBUSY
+Errno::ECHILD
+Errno::ECONNABORTED
+Errno::ECONNREFUSED
+Errno::ECONNRESET
+Errno::EDEADLK
+Errno::EDESTADDRREQ
+Errno::EDOM
+Errno::EDQUOT
+Errno::EEXIST
+Errno::EFAULT
+Errno::EFBIG
+Errno::EHOSTDOWN
+Errno::EHOSTUNREACH
+Errno::EIDRM
+Errno::EILSEQ
+Errno::EINPROGRESS
+Errno::EINTR
+Errno::EINVAL
+Errno::EIO
+Errno::EISCONN
+Errno::EISDIR
+Errno::ELOOP
+Errno::EMFILE
+Errno::EMLINK
+Errno::EMSGSIZE
+Errno::ENAMETOOLONG
+Errno::ENETDOWN
+Errno::ENETRESET
+Errno::ENETUNREACH
+Errno::ENFILE
+Errno::ENOBUFS
+Errno::ENODEV
+Errno::ENOENT
+Errno::ENOEXEC
+Errno::ENOLCK
+Errno::ENOMEM
+Errno::ENOMSG
+Errno::ENOPROTOOPT
+Errno::ENOSPC
+Errno::ENOSYS
+Errno::ENOTBLK
+Errno::ENOTCONN
+Errno::ENOTDIR
+Errno::ENOTEMPTY
+Errno::ENOTSOCK
+Errno::ENOTTY
+Errno::ENXIO
+Errno::EOPNOTSUPP
+Errno::EOVERFLOW
+Errno::EPERM
+Errno::EPFNOSUPPORT
+Errno::EPIPE
+Errno::EPROTONOSUPPORT
+Errno::EPROTOTYPE
+Errno::ERANGE
+Errno::EREMOTE
+Errno::EROFS
+Errno::ESHUTDOWN
+Errno::ESOCKTNOSUPPORT
+Errno::ESPIPE
+Errno::ESRCH
+Errno::ESTALE
+Errno::ETIMEDOUT
+Errno::ETOOMANYREFS
+Errno::ETXTBSY
+Errno::EUSERS
+Errno::EXDEV
+Exception
+FalseClass
+File
+File::Constants
+File::Stat
+FileTest
+Fixnum
+Float
+FloatDomainError
+GC
+Hash
+IO
+IOError
+IndexError
+Integer
+Interrupt
+Kernel
+LoadError
+LocalJumpError
+Marshal
+MatchData
+Math
+Method
+Module
+NameError
+NameError::message
+NilClass
+NoMemoryError
+NoMethodError
+NotImplementedError
+Numeric
+Object
+ObjectSpace
+Precision
+Proc
+Process
+Process::GID
+Process::Status
+Process::Sys
+Process::UID
+Range
+RangeError
+Regexp
+RegexpError
+RuntimeError
+ScriptError
+SecurityError
+Signal
+SignalException
+StandardError
+StopIteration
+String
+Struct
+Struct::Tms
+Symbol
+SyntaxError
+SystemCallError
+SystemExit
+SystemStackError
+Thread
+ThreadError
+ThreadGroup
+Time
+TrueClass
+TypeError
+UnboundMethod
+ZeroDivisionError
+fatal