Merge remote-tracking branch 'origin/master' into merge_release_branch

Author: ansalond

.gitattributes

@@ -7,7 +7,10 @@
 # and a whole lot of actually vendored code isn't listed! What we want to do is
 # make the stats accurate for what is actually runtime code.
 
-# Ignore everything that isn't actually runtime code
+# Note that changes to this file have to be *committed* for github-linguist to
+# notice them.
+
+# Non-runtime code
 
 /bench/* linguist-vendored
 /bin/* linguist-vendored
@@ -23,22 +26,22 @@
 /lib/json/tools/* linguist-vendored
 /src/main/c/Makefile linguist-vendored
 /src/main/c/truffleposix/Makefile linguist-vendored
+/lib/ruby/gems/*/gems/*/bin/setup linguist-vendored
+/lib/truffle/post_install_hook.sh linguist-vendored
+/src/test/* linguist-vendored
+/src/processor/* linguist-vendored
 
-# Some things that I just want to ignore as it skews things
-
-/lib/ruby/gems/2.3.0/gems/net-telnet-0.1.1/bin/setup linguist-vendored
-
-# Ignore generated code
+# Generated code
 
 /src/main/java/org/truffleruby/parser/parser/RubyParser.java linguist-generated
 
-# Ignore templates
+# templates
 
 /lib/mri/rdoc/generator/template/* linguist-vendored
 
-# Ignore extra documentation
+# Documentation
 
-/lib/ruby/gems/2.3.0/gems/rake-10.4.2/doc/rake.1 linguist-documentation
+/lib/ruby/gems/*/gems/*/doc/* linguist-documentation
 
 # All our headers are C - don't magically work out they're ObjectiveC or C++
 

.reek.yml

@@ -0,0 +1,49 @@
+detectors:
+  UncommunicativeVariableName:
+    enabled: false  # we're happy with short variable names
+  UncommunicativeParameterName:
+    enabled: false  # we're happy with short parameter names
+  LongParameterList:
+    enabled: false  # we're often meeting an existing Ruby API with fixed parameters
+  UncommunicativeModuleName:
+    enabled: false  # we're often meeting an existing Ruby API with fixed module names
+  UncommunicativeMethodName:
+    enabled: false  # we're often meeting an existing Ruby API with fixed method names
+  BooleanParameter:
+    enabled: false  # we're often meeting an existing Ruby API with boolean parameters
+  TooManyStatements:
+    enabled: false  # yes we often write longer methods
+  FeatureEnvy:
+    enabled: false  # we don't want to add new public methods to Ruby API classes to better encapsulate behaviour
+  UnusedParameters:
+    enabled: false  # primitives mean that the use of parameters can be hidden
+  NilCheck:
+    enabled: false  # our code is often too low level to factor this away
+  ManualDispatch:
+    enabled: false  # manual dispatch is often part of Ruby internal semantics
+  IrresponsibleModule:
+    enabled: false  # we don't comment all modules because we're implementing an existing interface so they do not need a raison d'être
+  ControlParameter:
+    enabled: false  # we're often meeting an existing Ruby API with control parameters
+  DataClump:
+    enabled: false  # we're often meeting an existing Ruby API with 'data clumps'
+  TooManyMethods:
+    enabled: false  # we're often meeting an existing Ruby API with an existing set of methods
+  TooManyConstants:
+    enabled: false  # we're often meeting an existing Ruby API with an existing set of constants
+  UtilityFunction:
+    enabled: false  # we're often meeting an existing Ruby API with utility functions
+  MissingSafeMethod:
+    enabled: false  # we're often meeting an existing Ruby API without safe equivalents, or the safe equivalent is implemented in Java
+  Attribute:
+    enabled: false  # we're often meeting an existing Ruby API with writable attributes
+  InstanceVariableAssumption:
+    enabled: false  # we often set instance variables lazily
+  NestedIterators:
+    enabled: false  # yes we often write nested iterators
+  TooManyInstanceVariables:
+    enabled: false  # yes we sometimes use a lot of instance variables
+  RepeatedConditional:
+    enabled: false  # we don't want to add new public methods to Ruby API classes to better encapsulate behaviour
+  DuplicateMethodCall:
+    enabled: false  # needs investigation - sometimes legitimate due to Ruby semantics, but lots of failures

.rubocop.yml

@@ -11,7 +11,7 @@ AllCops:
 
 # Type 'Style' (166):
 # Supports --auto-correct
-Layout/TrailingBlankLines:
+Style/TrailingBlankLines:
   Description: Checks trailing blank lines and final newline.
   StyleGuide: "#newline-eof"
   Enabled: true
@@ -21,7 +21,7 @@ Layout/TrailingBlankLines:
   - final_blank_line
 
 # Supports --auto-correct
-Layout/TrailingWhitespace:
+Style/TrailingWhitespace:
   Description: Avoid trailing whitespace.
   StyleGuide: "#no-trailing-whitespace"
   Enabled: true

CHANGELOG.md

@@ -1,4 +1,24 @@
-# 1.0 RC 11
+# 1.0 RC 12
+
+Bug fixes:
+
+* Fixed a bug with `String#lines` and similar methods with multibyte
+  characters (#1543).
+* Fixed an issue with `String#{encode,encode!}` double-processing strings
+  using XML conversion options and a new destination encoding (#1545).
+* Fixed a bug where a raised cloned exception would be caught as the
+  original exception (#1542).
+* Fixed a bug with `StringScanner` and patterns starting with `^` (#1544).
+* Fixed `Enumerable::Lazy#uniq` with infinite streams (#1516).
+
+Compatibility:
+
+* Change to a new system for handling Ruby objects in C extensions which
+  greatly increases compatibility with MRI.
+* Implemented `BigDecimal#to_r` (#1521).
+* `Symbol#to_proc` now returns `-1` like on MRI (#1462).
+
+# 1.0 RC 11, 15 January 2019
 
 New features:
 

LICENCE.md

@@ -1,6 +1,6 @@
 # TruffleRuby Licence
 
-TruffleRuby is copyright (c) 2013-2018 Oracle and/or its
+TruffleRuby is copyright (c) 2013-2019 Oracle and/or its
 affiliates, and is made available to you under the terms of any one of the following three licenses:
 
 * Eclipse Public License version 1.0, or

README.md

@@ -21,15 +21,23 @@ There are three ways to install TruffleRuby:
   using a Ruby manager.
 
 * Using the [standalone distribution](doc/user/standalone-distribution.md)
-  as a simple binary tarball. This distribution can also be used for
+  as a simple binary tarball. This distribution is also useful for
   [testing TruffleRuby in CI](doc/user/standalone-distribution.md).
+  On [TravisCI](https://docs.travis-ci.com/user/languages/ruby#truffleruby), you can simply use:
+  ```yaml
+  language: ruby
+  rvm:
+    - truffleruby
+  ```
 
 You can use `gem` to install Gems as normal.
 
 You can also build TruffleRuby from source, see the
 [building instructions](doc/contributor/workflow.md), and using
 [Docker](doc/contributor/docker.md).
 
+Please report any issue you might find on [GitHub](https://github.com/oracle/truffleruby/issues).
+
 ## Aim
 
 TruffleRuby aims to:
@@ -163,6 +171,7 @@ The main authors of TruffleRuby in order of joining the project are:
 * Petr Chalupa
 * Brandon Fish
 * Duncan MacGregor
+* Christian Wirth
 
 Additionally:
 
@@ -187,7 +196,7 @@ See the [security documentation](doc/user/security.md).
 
 ## Licence
 
-TruffleRuby is copyright (c) 2013-2018 Oracle and/or its affiliates, and is made
+TruffleRuby is copyright (c) 2013-2019 Oracle and/or its affiliates, and is made
 available to you under the terms of any one of the following three licenses:
 
 * Eclipse Public License version 1.0, or

ci.jsonnet

@@ -40,6 +40,10 @@ local part_definitions = {
         PATH: std.join(":", self.path + ["$PATH"]),
       },
 
+      packages+: {
+        "pip:ninja_syntax": "==1.7.2", # Required by NFI and mx
+      },
+
       setup+: [
         # We don't want to proxy any internet access
         ["unset", "ANT_OPTS", "FTP_PROXY", "ftp_proxy", "GRADLE_OPTS",
@@ -175,7 +179,7 @@ local part_definitions = {
       ],
 
       environment+: {
-        GRAAL_HOME: "$PWD/../graal-enterprise/graal-enterprise",
+        GRAAL_HOME: "$BUILD_DIR/graal-enterprise/graal-enterprise",
         HOST_VM: "server",
         HOST_VM_CONFIG: "graal-enterprise",
       },
@@ -214,8 +218,8 @@ local part_definitions = {
 
       environment+: {
         HOST_VM_CONFIG: "graal-core",
-        GRAAL_HOME: "$PWD/../graal/compiler",
-        VM_SUITE_HOME: "$PWD/../graal/vm",
+        GRAAL_HOME: "$BUILD_DIR/graal/compiler",
+        VM_SUITE_HOME: "$BUILD_DIR/graal/vm",
       },
     },
 
@@ -240,8 +244,8 @@ local part_definitions = {
 
       environment+: {
         HOST_VM_CONFIG: "graal-enterprise",
-        GRAAL_HOME: "$PWD/../graal-enterprise/graal-enterprise",
-        VM_SUITE_HOME: "$PWD/../graal-enterprise/vm-enterprise",
+        GRAAL_HOME: "$BUILD_DIR/graal-enterprise/graal-enterprise",
+        VM_SUITE_HOME: "$BUILD_DIR/graal-enterprise/vm-enterprise",
       },
     },
 
@@ -297,7 +301,7 @@ local part_definitions = {
       downloads+: {
         JAVA_HOME: {
           name: "labsjdk",
-          version: "8u192-jvmci-0.52",
+          version: "8u192-jvmci-0.54",
           platformspecific: true,
         },
       },
@@ -311,7 +315,7 @@ local part_definitions = {
       downloads+: {
         JAVA_HOME: {
           name: "openjdk",
-          version: "8u192-jvmci-0.52",
+          version: "8u192-jvmci-0.54",
           platformspecific: true,
         },
       },
@@ -367,7 +371,7 @@ local part_definitions = {
       ],
       "$.run.specs":: { test_spec_options: ["-GdarwinCI"] },
       "$.cap":: {
-        normal_machine: ["darwin_sierra", "amd64"],
+        normal_machine: ["darwin_mojave", "amd64"],
       },
       environment+: {
         LANG: "en_US.UTF-8",

doc/contributor/static-analysis.md

@@ -0,0 +1,118 @@
+# Static Analysis of TruffleRuby
+
+We apply static analysis to the production code that we maintain -
+`lib/truffle`, `lib/cext`, `src/annotations`, `src/launcher`, `src/main`,
+`src/services` (some parts of static analysis are also applied to other files,
+but these are the key ones).
+
+## C
+
+The [Clang Static Analyzer](https://clang-analyzer.llvm.org) finds bugs in C
+code. We occasionally run this tool locally but only take its output as a
+suggestion. We use a default configuration.
+
+```
+$ scan-build --use-analyzer `which clang` -analyze-headers clang -c --std=c99 -Ilib/cext/include src/main/c/cext/ruby.c src/main/c/truffleposix/truffleposix.c
+$ scan-view ...as instructed by scan-build...
+```
+
+## Java
+
+### DSL usage
+
+We have a tool to check that some use of our internal annotations and the
+Truffle DSL are correct. Passing this is enforced in our CI gate.
+
+```
+$ jt check_dsl_usage
+```
+
+### CheckStyle
+
+[CheckStyle](http://checkstyle.sourceforge.net) enforces a Java style guide.
+Passing CheckStyle is enforced in our CI gate.
+
+```
+$ mx checkstyle
+```
+
+### FindBugs
+
+[FindBugs](http://findbugs.sourceforge.net) looks for potential Java
+programming errors. We run it with the default Graal project configuration.
+Passing FindBugs is enforced in our CI gate.
+
+```
+$ mx findbugs
+```
+
+## Ruby
+
+### Rubocop
+
+[Rubocop](https://github.com/rubocop-hq/rubocop) enforces a Ruby style guide.
+It's configured in `.rubocop.yml`, and can be run locally as `jt rubocop`.
+Passing Rubocop is enforced in our CI gate.
+
+```
+$ jt rubocop
+```
+
+### Fasterer
+
+[Fasterer](https://github.com/DamirSvrtan/fasterer) looks for potential
+performance improvements. We occasionally run this tool locally but only take
+its output as a suggestion. We use a default configuration.
+
+```
+$ gem install fasterer
+$ fasterer lib/truffle lib/cext src/main
+```
+
+### Reek
+
+[Reek](https://github.com/troessner/reek) looks for patterns of Ruby code
+which could be improved - generally around making it simpler and more clear.
+We occasionally run this tool locally but only take its output as a
+suggestion. We disable a lot of the defaults in `.reek.yml`, either because
+we're implementing a set API, because we're doing something low-level or
+outside normal Ruby semantics, or for performance reasons.
+
+```
+$ gem install reek
+$ reek lib/truffle lib/cext src/main
+```
+
+### Flog
+
+[Flog](http://ruby.sadi.st/Flog.html) lists methods by complexity. You can
+check that your methods do not appear near the top of this list. We
+occasionally run this tool locally but only take its output as a suggestion.
+
+```
+$ gem install flog
+$ flog -m -t 10 lib/truffle lib/cext src/main
+```
+
+### Flay
+
+[Flay](http://ruby.sadi.st/Flay.html) finds similar or identical code, which
+could potentially be factored out. We occasionally run this tool locally but
+only take its output as a suggestion.
+
+```
+$ gem install flay
+$ flay lib/truffle lib/cext src/main
+```
+
+### Brakeman
+
+[Brakeman](https://github.com/presidentbeef/brakeman) looks for security
+vulnerabilities. It's really designed for Rails, and many of the rules are
+specific to Rails, but we do run it ocassionally anyway and take its output as
+a suggestion.
+
+```
+$ gem install brakeman
+$ brakeman --force-scan --run-all-checks --interprocedural --no-pager --add-libs-path src --only-files lib/truffle/,lib/cext/,src/main/ruby/core/
+```

doc/legal/legal.md

@@ -5,7 +5,7 @@ GraalVM, which is the only supported way to use TruffleRuby.
 
 ## TruffleRuby
 
-TruffleRuby is copyright (c) 2013-2018 Oracle and/or its
+TruffleRuby is copyright (c) 2013-2019 Oracle and/or its
 affiliates, and is made available to you under the terms of any one of the
 following three licenses: