doc/NEWS-2.0.0

   1 # -*- rdoc -*-
   2
   3 = NEWS for Ruby 2.0.0
   4
   5 This document is a list of user visible feature changes made between
   6 releases except for bug fixes.
   7
   8 Note that each entry is kept so brief that no reason behind or
   9 reference information is supplied with.  For a full list of changes
  10 with all sufficient information, see the ChangeLog file.
  11
  12 == Changes since the 1.9.3 release
  13
  14 === Language changes
  15
  16 * Added keyword arguments.
  17
  18 * Added %i and %I for symbol list creation (similar to %w and %W).
  19
  20 * Default source encoding is changed to UTF-8. (was US-ASCII)
  21
  22 * No warning for unused variables starting with '_'
  23
  24 === Core classes updates (outstanding ones only)
  25
  26 * ARGF
  27   * added method:
  28     * added ARGF#codepoints and ARGF#each_codepoint, like the corresponding
  29       methods for IO.
  30
  31 * Array
  32   * added method:
  33     * added Array#bsearch for binary search.
  34   * incompatible changes:
  35     * random parameter of Array#shuffle! and Array#sample now
  36       will be called with one argument, maximum value.
  37     * when given Range arguments, Array#values_at now returns nil for each
  38       value that is out-of-range.
  39
  40 * Enumerable
  41   * added method:
  42     * added Enumerable#lazy method for lazy enumeration.
  43
  44 * Enumerator
  45   * added method:
  46     * added Enumerator#size for lazy size evaluation.
  47   * extended method:
  48     * Enumerator.new accept an argument for lazy size evaluation.
  49   * new class Enumerator::Lazy for lazy enumeration
  50
  51 * ENV
  52   * aliased method:
  53     * ENV.to_h is a new alias for ENV.to_hash
  54
  55 * Fiber
  56   * incompatible changes:
  57     * Fiber#resume cannot resume a fiber which invokes "Fiber#transfer".
  58
  59 * File
  60   * extended method:
  61     * File.fnmatch? now expands braces in the pattern if
  62       File::FNM_EXTGLOB option is given.
  63
  64 * GC
  65   * improvements:
  66     * introduced the bitmap marking which suppresses to copy a memory page
  67       with Copy-on-Write.
  68     * introduced the non-recursive marking which avoids unexpected stack overflow.
  69
  70 * GC::Profiler
  71   * added method:
  72     * added GC::Profiler.raw_data which returns raw profile data for GC.
  73
  74 * Hash
  75   * added method:
  76     * added Hash#to_h as explicit conversion method, like Array#to_a.
  77   * extended method:
  78     * Hash#default_proc= can be passed nil to clear the default proc.
  79
  80 * IO
  81   * deprecated methods:
  82     * IO#lines, #bytes, #chars and #codepoints are deprecated.
  83
  84 * Kernel
  85   * added method:
  86     * added Kernel#Hash conversion method like Array() or Float().
  87     * added Kernel#__dir__ which returns the absolute path of the
  88       directory of the file from which this method is called.
  89     * added Kernel#caller_locations which returns an array of
  90       frame information objects.
  91   * extended method:
  92     * Kernel#warn accepts multiple args in like puts.
  93     * Kernel#caller accepts second optional argument `n' which specify
  94       required caller size.
  95     * Kernel#to_enum and enum_for accept a block for lazy size evaluation.
  96   * incompatible changes:
  97     * system() and exec() close non-standard file descriptors
  98       (The default of :close_others option is changed to true by default.)
  99     * respond_to? against a protected method now returns false unless
 100       the second argument is true.
 101     * __callee__ has returned to the original behavior, and now
 102       returns the called name but not the original name in an
 103       aliased method.
 104     * Kernel#inspect does not call #to_s anymore
 105       (it used to call redefined #to_s).
 106
 107 * LoadError
 108   * added method:
 109     * added LoadError#path method to return the file name that could not be
 110       loaded.
 111
 112 * Module
 113   * added method:
 114     * added Module#prepend which is similar to Module#include,
 115       however a method in the prepended module overrides the
 116       corresponding method in the prepending module.
 117     * added Module.prepended and Module.prepend_features, similar
 118       to included and append_features.
 119     * added Module#refine, which extends a class or module locally. [experimental]
 120   * extended method:
 121     * Module#define_method accepts a UnboundMethod from a Module.
 122     * Module#const_get accepts a qualified constant string, e.g.
 123       Object.const_get("Foo::Bar::Baz")
 124
 125 * Mutex
 126   * added method:
 127     * added Mutex#owned? which returns the mutex is held by current
 128       thread or not. [experimental]
 129   * incompatible changes:
 130     * Mutex#lock, Mutex#unlock, Mutex#try_lock, Mutex#synchronize
 131       and Mutex#sleep are no longer allowed to be used from trap handler
 132       and raise a ThreadError in such case.
 133     * Mutex#sleep may spurious wakeup. Check after wakeup.
 134
 135 * NilClass
 136   * added method:
 137     * added nil.to_h which returns {}
 138
 139 * ObjectSpace::WeakMap
 140   * new low level class to hold weak references to objects.
 141
 142 * Proc
 143   * incompatible change:
 144     * removed Proc#== and #eql? so two procs are == only when they are
 145       the same object.
 146
 147 * Process
 148   * added method:
 149     * added getsid for getting session id (unix only).
 150
 151 * Range
 152   * added method:
 153     * added Range#size for lazy size evaluation.
 154     * added Range#bsearch for binary search.
 155
 156 * RubyVM (MRI specific)
 157   * added RubyVM::InstructionSequence.of to get the instruction sequence
 158     from a method or a block.
 159   * added RubyVM::InstructionSequence#path, #absolute_path, #label,
 160     #base_label and #first_lineno to retrieve information from where
 161     the instruction sequence was defined.
 162   * added Environment variables to specify stack usage:
 163     * RUBY_THREAD_VM_STACK_SIZE: vm stack size used at thread creation.
 164       default: 128KB (32bit CPU) or 256KB (64bit CPU).
 165     * RUBY_THREAD_MACHINE_STACK_SIZE: machine stack size used at thread
 166       creation. default: 512KB or 1024KB.
 167     * RUBY_FIBER_VM_STACK_SIZE: vm stack size used at fiber creation.
 168       default: 64KB or 128KB.
 169     * RUBY_FIBER_MACHINE_STACK_SIZE: machine stack size used at fiber
 170       creation. default: 256KB or 512KB.
 171     These variables are checked only at launched time.
 172   * added constant DEFAULT_PARAMS to get above default parameters.
 173
 174 * Signal
 175   * added method:
 176     * added Signal.signame which returns signal name
 177
 178   * incompatible changes:
 179     * Signal.trap raises ArgumentError when :SEGV, :BUS, :ILL, :FPE, :VTALRM
 180       are specified.
 181
 182 * String
 183   * added method:
 184     * added String#b returning a copied string whose encoding is ASCII-8BIT.
 185   * change return value:
 186     * String#lines now returns an array instead of an enumerator.
 187     * String#chars now returns an array instead of an enumerator.
 188     * String#codepoints now returns an array instead of an enumerator.
 189     * String#bytes now returns an array instead of an enumerator.
 190
 191 * Struct
 192   * added method:
 193     * added Struct#to_h returning values with keys corresponding to the
 194       instance variable names.
 195
 196 * Thread
 197   * added method:
 198     * added Thread#thread_variable_get for getting thread local variables
 199       (these are different than Fiber local variables).
 200     * added Thread#thread_variable_set for setting thread local variables.
 201     * added Thread#thread_variables for getting a list of the thread local
 202       variable keys.
 203     * added Thread#thread_variable? for testing to see if a particular thread
 204       variable has been set.
 205     * added Thread.handle_interrupt as well as instance and singleton methods
 206       pending_interrupt? for asynchronous handling of exceptions
 207     * added Thread#backtrace_locations which returns similar information of
 208       Kernel#caller_locations.
 209   * new class Thread::Backtrace::Location to hold backtrace location
 210     information. These are returned by Thread#backtrace_locations and
 211     Kernel#caller_locations.
 212   * incompatible changes:
 213     * Thread#join and Thread#value now raises a ThreadError if target thread
 214       is the current or main thread.
 215
 216 * Time
 217   * change return value:
 218     * Time#to_s now returns US-ASCII encoding instead of BINARY.
 219
 220 * TracePoint
 221   * new class. This class is replacement of set_trace_func.
 222     Easy to use and efficient implementation.
 223
 224 * toplevel
 225   * added method:
 226     * added main.define_method which defines a global function.
 227     * added main.using, which imports refinements into the current file or
 228       eval string. [experimental]
 229
 230 === Core classes compatibility issues (excluding feature bug fixes)
 231
 232 * Array#values_at
 233
 234   See above.
 235
 236 * String#lines
 237 * String#chars
 238 * String#codepoints
 239 * String#bytes
 240
 241   These methods no longer return an Enumerator, although passing a
 242   block is still supported for backwards compatibility.
 243
 244   Code like str.lines.with_index(1) { |line, lineno| ... } no longer
 245   works because str.lines returns an array.  Replace lines with
 246   each_line in such cases.
 247
 248 * IO#lines
 249 * IO#chars
 250 * IO#codepoints
 251 * IO#bytes
 252 * ARGF#lines
 253 * ARGF#chars
 254 * ARGF#bytes
 255 * StringIO#lines
 256 * StringIO#chars
 257 * StringIO#codepoints
 258 * StringIO#bytes
 259 * Zlib::GzipReader#lines
 260 * Zlib::GzipReader#bytes
 261
 262   These methods are deprecated in favor of each_line, each_byte,
 263   each_char and each_codepoint.
 264
 265 * Proc#==
 266 * Proc#eql?
 267
 268   These methods were removed. Two procs are == only when they are
 269   the same object.
 270
 271 * Fixnum
 272 * Bignum
 273 * Float
 274
 275   Fixnums, Bignums and Floats are frozen.
 276
 277 * Signal.trap
 278
 279   See above.
 280
 281 * Merge Onigmo.
 282   https://github.com/k-takata/Onigmo
 283
 284 * The :close_others option is true by default for system() and exec().
 285   Also, the close-on-exec flag is set by default for all new file descriptors.
 286   This means file descriptors doesn't inherit to spawned process unless
 287   explicitly requested such as system(..., fd=>fd).
 288
 289 * Kernel#respond_to? against a protected method now returns false
 290   unless the second argument is true.
 291
 292 * Kernel#respond_to_missing?
 293 * Kernel#initialize_clone
 294 * Kernel#initialize_dup
 295
 296   These methods are now private.
 297
 298 * Thread#join, Thread#value
 299
 300   See above.
 301
 302 * Mutex#lock, Mutex#unlock, Mutex#try_lock, Mutex#synchronize and Mutex#sleep
 303
 304   See above.
 305
 306 === Stdlib updates (outstanding ones only)
 307
 308 * cgi
 309   * Add HTML5 tag maker.
 310   * CGI#header has been renamed to CGI#http_header and
 311     aliased to CGI#header.
 312   * When HTML5 tagmaker called, overwrite CGI#header,
 313     CGI#header function is to create a <header> element.
 314
 315 * CSV
 316   * Removed CSV::dump and CSV::load to protect users from dangerous
 317     serialization vulnerability
 318
 319 * iconv
 320   * Iconv has been removed. Use String#encode instead.
 321
 322 * io/console
 323   * new methods:
 324     * added IO#cooked which sets the terminal to cooked mode within the given block.
 325     * added IO#cooked! which sets the terminal to cooked.
 326   * extended method:
 327     * IO#raw, IO#raw!, and IO#getch accept keyword arguments, :min and :time.
 328
 329 * io/wait
 330   * new features:
 331     * added IO#wait_writable method.
 332     * added IO#wait_readable method as alias of IO#wait.
 333
 334 * json
 335   * updated to 1.7.7.
 336
 337 * net/http
 338   * new features:
 339     * Proxies are now automatically detected from the http_proxy environment
 340       variable.  See Net::HTTP::new for details.
 341     * gzip and deflate compression are now requested for all requests by
 342       default.  See Net::HTTP for details.
 343     * SSL sessions are now reused across connections for a single instance.
 344       This speeds up connection by using a previously negotiated session.
 345     * Requests may be created from a URI which sets the request_uri and host
 346       header of the request (but does not change the host connected to).
 347     * Responses contain the URI requested which allows easier implementation of
 348       redirect following.
 349   * new methods:
 350     * Net::HTTP#local_host
 351     * Net::HTTP#local_host=
 352     * Net::HTTP#local_port
 353     * Net::HTTP#local_port=
 354   * extended method:
 355     * Net::HTTP#connect uses local_host and local_port if specified.
 356
 357 * net/imap
 358   * new methods:
 359     * Net::IMAP.default_port
 360     * Net::IMAP.default_imap_port
 361     * Net::IMAP.default_tls_port
 362     * Net::IMAP.default_ssl_port
 363     * Net::IMAP.default_imaps_port
 364
 365 * objspace
 366   * new method:
 367     * ObjectSpace.reachable_objects_from(obj)
 368
 369 * openssl
 370   * Consistently raise an error when trying to encode nil values. All instances
 371     of OpenSSL::ASN1::Primitive now raise TypeError when calling to_der on an
 372     instance whose value is nil. All instances of OpenSSL::ASN1::Constructive
 373     raise NoMethodError in the same case. Constructing such values is still
 374     permitted.
 375   * TLS 1.1 & 1.2 support by setting OpenSSL::SSL::SSLContext#ssl_version to
 376     :TLSv1_2, :TLSv1_2_server, :TLSv1_2_client or :TLSv1_1, :TLSv1_1_server
 377     :TLSv1_1_client. The version being effectively used can be queried
 378     with OpenSSL::SSL#ssl_version. Furthermore, it is also possible to
 379     blacklist the new TLS versions with OpenSSL::SSL::OP_NO_TLSv1_1 and
 380     OpenSSL::SSL::OP_NO_TLSv1_2.
 381   * Added OpenSSL::SSL::SSLContext#renegotiation_cb. A user-defined callback
 382     may be set which gets called whenever a new handshake is negotiated. This
 383     also allows to programmatically decline (client) renegotiation attempts.
 384   * Support for "0/n" splitting of records as BEAST mitigation via
 385     OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS.
 386   * The default options for OpenSSL::SSL::SSLContext have changed to
 387     OpenSSL::SSL::OP_ALL & ~OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS
 388     instead of OpenSSL::SSL::OP_ALL only. This enables the countermeasure for
 389     the BEAST attack by default.
 390   * OpenSSL requires passwords for decrypting PEM-encoded files to be at least
 391     four characters long. This led to awkward situations where an export with
 392     a password with fewer than four characters was possible, but accessing the
 393     file afterwards failed. OpenSSL::PKey::RSA, OpenSSL::PKey::DSA and
 394     OpenSSL::PKey::EC therefore now enforce the same check when exporting a
 395     private key to PEM with a password - it has to be at least four characters
 396     long.
 397   * SSL/TLS support for the Next Protocol Negotiation extension. Supported
 398     with OpenSSL 1.0.1 and higher.
 399   * OpenSSL::OPENSSL_FIPS allows client applications to detect whether OpenSSL
 400     is FIPS-enabled. OpenSSL.fips_mode= allows turning on and off FIPS mode
 401     manually in order to adapt to situations where FIPS mode would be an
 402     explicit requirement.
 403   * Authenticated Encryption with Associated Data (AEAD) is supported via
 404     Cipher#auth_data= and Cipher#auth_tag/Cipher#auth_tag=.
 405     Currently (OpenSSL 1.0.1c), only GCM mode is supported.
 406
 407 * ostruct
 408   * new methods:
 409     * OpenStruct#[], []=
 410     * OpenStruct#each_pair
 411     * OpenStruct#eql?
 412     * OpenStruct#hash
 413     * OpenStruct#to_h converts the struct to a hash.
 414   * extended method:
 415     * OpenStruct.new also accepts an OpenStruct / Struct.
 416
 417 * pathname
 418   * extended method:
 419     * Pathname#find returns an enumerator if no block is given.
 420
 421 * rake
 422   * rake has been updated to version 0.9.5.
 423
 424     This version is backwards-compatible with previous rake versions and
 425     contains many bug fixes.
 426
 427     See
 428     http://rake.rubyforge.org/doc/release_notes/rake-0_9_5_rdoc.html for a list
 429     of changes in rake 0.9.3, 0.9.4 and 0.9.5.
 430
 431 * RDoc
 432   * RDoc has been updated to version 4.0
 433
 434     This version is largely backwards-compatible with previous rdoc versions.
 435     The most notable change is an update to the ri data format (ri data must
 436     be regenerated for gems shared across rdoc versions).  Further API changes
 437     are internal and won't affect most users.
 438
 439     Notable changes include:
 440
 441     * Page support for ri.  Try `ri ruby:` for a list of pages in ruby or
 442       `ri ruby:syntax/literals` for the syntax documentation for literals.
 443
 444       This also works for gems such as `ri rspec:README` for the rspec gem's
 445       README file.
 446     * Markdown support.  See ri RDoc::Markdown for details.
 447
 448     See https://github.com/rdoc/rdoc/blob/master/History.rdoc for a full list
 449     of changes in rdoc 4.0.
 450
 451 * resolv
 452   * new methods:
 453     * Resolv::DNS#timeouts=
 454     * Resolv::DNS::Config#timeouts=
 455
 456 * rexml
 457   * REXML::Document#write supports Hash arguments.
 458   * REXML::Document#write supports new :encoding option. It changes
 459     XML document encoding. Without :encoding option, encoding in
 460     XML declaration is used for XML document encoding.
 461
 462 * RubyGems
 463   * Updated to 2.0.0
 464
 465     RubyGems 2.0.0 features the following improvements:
 466
 467     * Improved support for default gems shipping with ruby 2.0.0+
 468     * A gem can have arbitrary metadata through Gem::Specification#metadata
 469     * `gem search` now defaults to --remote and is anchored like gem list.
 470     * Added --document to replace --rdoc and --ri.  Use --no-document to
 471       disable documentation, --document=rdoc to only generate rdoc.
 472     * Only ri-format documentation is generated by default.
 473     * `gem server` uses RDoc::Servlet from RDoc 4.0 to generate HTML
 474       documentation.
 475
 476     For an expanded list of updates and bug fixes see:
 477     https://github.com/rubygems/rubygems/blob/master/History.txt
 478
 479 * shellwords
 480   * Shellwords#shellescape now stringifies the given object using to_s.
 481   * Shellwords#shelljoin accepts non-string objects in the given
 482     array, each of which is stringified using to_s.
 483
 484 * stringio
 485   * deprecated methods:
 486     * StringIO#lines, #bytes, #chars and #codepoints are deprecated.
 487
 488 * syslog
 489   * Added Syslog::Logger which provides a Logger API atop Syslog.
 490   * Syslog::Priority, Syslog::Level, Syslog::Option and Syslog::Macros
 491     are introduced for easy detection of available constants on a
 492     running system.
 493
 494 * tmpdir
 495   * incompatible changes:
 496     * Dir.mktmpdir uses FileUtils.remove_entry instead of
 497       FileUtils.remove_entry_secure.  This means that applications should not
 498       change the permission of the created temporary directory to make
 499       writable from other users.
 500
 501 * yaml
 502   * Syck has been removed.  YAML now completely depends on libyaml being
 503     installed.
 504   * libyaml is now bundled with ruby, for cases where the library is not
 505     installed locally.
 506
 507 * zlib
 508   * Added streaming support for Zlib::Inflate and Zlib::Deflate.  This allows
 509     processing of a stream without the use of large amounts of memory.
 510   * Added support for the new deflate strategies Zlib::RLE and Zlib::FIXED.
 511   * Zlib streams are now processed without the GVL.  This allows gzip, zlib and
 512     deflate streams to be processed in parallel.
 513   * deprecated methods:
 514     * Zlib::GzipReader#lines and #bytes are deprecated.
 515
 516 === Stdlib compatibility issues (excluding feature bug fixes)
 517
 518 * OpenStruct new methods can conflict with custom attributes named
 519   "each_pair", "eql?", "hash" or "to_h".
 520
 521 * Dir.mktmpdir in lib/tmpdir.rb
 522
 523   See above.
 524
 525 === C API updates
 526
 527 * NUM2SHORT() and NUM2USHORT() added. They are similar to NUM2INT, but short.
 528
 529 * rb_newobj_of() and NEWOBJ_OF() added. They create a new object of a given class.