Merge pull request #754 from ruby-concurrency/pitr-ch/build

Documentation, building, test TruffleRuby

Author: pitr-ch

.gitignore

@@ -7,7 +7,6 @@
 
 # Yard documentation
 /.yardoc
-/yardoc
 
 # IDEs' files
 *.iml

.travis.yml

@@ -1,46 +1,71 @@
 language: ruby
-
-rvm:
-  # start with the latest
-  - 2.5.1
-  - jruby-9.2.0.0
-
-  # older versions
-  - 2.4.4
-  - 2.3.7
-  - 2.2.10
-  - 2.1.10
-  - 2.0.0
-
-  - jruby-9.1.17.0
-  - jruby-9.0.5.0
-
-  - ruby-head
-  - ruby-2.6.0-preview2
-  - jruby-head
-
-  - rbx-3
-
-jdk:
-  - oraclejdk8
-
 sudo: false
-
 branches:
   only:
     - master
 
 matrix:
   fast_finish: true
   include:
-    - rvm: 2.3.7
+    - name: MRI 2.5.1 Latest
+      rvm: 2.5.1
+    - name: JRuby 9.2.0.0 Latest
+      rvm: jruby-9.2.0.0
       jdk: oraclejdk8
+    - name: TruffleRuby Latest
+      rvm: system
+      install:
+        - export TRUFFLERUBY_VERSION=1.0.0-rc5
+        - curl -L https://github.com/oracle/truffleruby/releases/download/vm-$TRUFFLERUBY_VERSION/truffleruby-$TRUFFLERUBY_VERSION-linux-amd64.tar.gz | tar xz
+        - export PATH="$PWD/truffleruby-$TRUFFLERUBY_VERSION-linux-amd64/bin:$PATH"
+        - gem install bundler
+        - bundle install
+    - name: YARD uptodate in docs
+      rvm: 2.5.1
+      script:
+      - bundle install --with documentation
+      - bundle exec rake spec:docs_uptodate
+
+    - name: MRI 2.4.4
+      rvm: 2.4.4
+    - name: MRI 2.3.7
+      rvm: 2.3.7
+    - name: MRI 2.2.10
+      rvm: 2.2.10
+    - name: MRI 2.1.10
+      rvm: 2.1.10
+    - name: MRI 2.0.0
+      rvm: 2.0.0
+
+    - name: JRuby 9.1.17.0
+      rvm: jruby-9.1.17.0
+      jdk: oraclejdk8
+    - name: JRuby 9.0.5.0
+      rvm: jruby-9.0.5.0
+      jdk: oraclejdk8
+
+    - name: MRI head
+      rvm: ruby-head
+    - name: MRI 2.6.0-preview2
+      rvm: 2.6.0-preview2
+    - name: JRuby head
+      rvm: jruby-head
+      jdk: oraclejdk8
+
+    - name: Rubinius
+      rvm: rbx-3
+
+    - name: Coverage on MRI 2.3.7
+      rvm: 2.3.7
       env: COVERAGE=1
+
   allow_failures:
+    - rvm: 2.6.0-preview2
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-3
-    - rvm: ruby-2.6.0-preview2
+    - name: TruffleRuby Latest
+    - name: YARD uptodate in docs
 
 env:
   global:

.yardopts

@@ -1,18 +1,5 @@
---no-private
---embed-mixins
---output-dir ./yardoc
---markup markdown
---title=Concurrent Ruby
---template default
---template-path ./yard-template
---default-return undocumented
-
-./lib/**/*.rb
-./lib-edge/**/*.rb
-./ext/concurrent_ruby_ext/**/*.c
+--use-bundle-exec-rake-yard-instead
+--output-dir tmp
+--
+no-lib
 -
-doc/thread_pools.md
-doc/promises.out.md
-README.md
-LICENSE.txt
-CHANGELOG.md

CHANGELOG.md

@@ -4,36 +4,39 @@ concurrent-ruby:
 
 * [Promises](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Promises.html)
   are moved from `concurrent-ruby-edge` to `concurrent-ruby`
-* #644 Fix Map#each and #each_pair not returning enumerator outside of MRI
-* #659 Edge promises fail during error handling
-* #741 Raise on recursive Delay#value call
-* #727 #717 fix global IO executor on JRuby
-* #740 Drop support for CRuby 1.9, JRuby 1.7, Rubinius.
-* #737 Move AtomicMarkableReference out of Edge
-* #708 Prefer platform specific memory barriers 
 * Add support for TruffleRuby
-  * #734 Fix Array/Hash/Set construction broken on TruffleRuby    
-* #735 Fix wrong expected exception in channel spec assertion
+  * (#734) Fix Array/Hash/Set construction broken on TruffleRuby
+  * AtomicReference fixed    
 * CI stabilization
-* #729 Allow executor option in `Promise#then`
-* #725 fix timeout check to use timeout_interval
-* #719 update engine detection
-* #660 Add specs for Promise#zip/Promise.zip ordering
-* #654 Promise.zip execution changes
-* #666 Add thread safe set implementation
-* #651 #699 #to_s, #inspect should not output negative object IDs.
-* #685 Avoid RSpec warnings about raise_error
-* #680 Avoid RSpec monkey patching, persist spec results locally, use RSpec
-  v3.7.0
-* #665 Initialize the monitor for new subarrays on Rubinius
-* #661 Fix error handling in edge promises
 * remove sharp dependency edge -> core
 * remove warnings
 * documentation updates
+* Exchanger is no longer documented as edge since it was already available in 
+  `concurrent-ruby`
+* (#644) Fix Map#each and #each_pair not returning enumerator outside of MRI
+* (#659) Edge promises fail during error handling
+* (#741) Raise on recursive Delay#value call
+* (#727) #717 fix global IO executor on JRuby
+* (#740) Drop support for CRuby 1.9, JRuby 1.7, Rubinius.
+* (#737) Move AtomicMarkableReference out of Edge
+* (#708) Prefer platform specific memory barriers 
+* (#735) Fix wrong expected exception in channel spec assertion
+* (#729) Allow executor option in `Promise#then`
+* (#725) fix timeout check to use timeout_interval
+* (#719) update engine detection
+* (#660) Add specs for Promise#zip/Promise.zip ordering
+* (#654) Promise.zip execution changes
+* (#666) Add thread safe set implementation
+* (#651) #699 #to_s, #inspect should not output negative object IDs.
+* (#685) Avoid RSpec warnings about raise_error
+* (#680) Avoid RSpec monkey patching, persist spec results locally, use RSpec
+  v3.7.0
+* (#665) Initialize the monitor for new subarrays on Rubinius
+* (#661) Fix error handling in edge promises
 
 concurrent-ruby-edge:
 
-* #659 Edge promises fail during error handling
+* (#659) Edge promises fail during error handling
 * Edge files clearly separated in `lib-edge`
 * added ReInclude
 

Gemfile

@@ -13,13 +13,13 @@ group :development do
   gem 'rake', '~> 12.0'
   gem 'rake-compiler', '~> 1.0'
   gem 'rake-compiler-dock', '~> 0.6.0'
-  gem 'pry', '~> 0.11'
+  gem 'pry', '~> 0.11', platforms: :mri
 end
 
 group :documentation, optional: true do
   gem 'yard', '~> 0.9.0', :require => false
   gem 'redcarpet', '~> 3.0', platforms: :mri # understands github markdown
-  gem 'md-ruby-eval'
+  gem 'md-ruby-eval', '~> 0.2'
 end
 
 group :testing do

README.md

@@ -16,7 +16,7 @@ Modern concurrency tools for Ruby. Inspired by
 [Java](http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/package-summary.html),
 and classic concurrency patterns.
 
-<img src="https://raw.githubusercontent.com/ruby-concurrency/concurrent-ruby/master/doc/logo/concurrent-ruby-logo-300x300.png" align="right" style="margin-left: 20px;" />
+<img src="https://raw.githubusercontent.com/ruby-concurrency/concurrent-ruby/master/doc-source/logo/concurrent-ruby-logo-300x300.png" align="right" style="margin-left: 20px;" />
 
 The design goals of this gem are:
 
@@ -58,7 +58,7 @@ other Ruby library, many of which support the mantra of
 Concurrent Ruby is also the only Ruby library which provides a full suite of thread safe and
 immutable variable types and data structures.
 
-We've also initiated discussion to document [memory model](doc/synchronization.md) of Ruby which 
+We've also initiated discussion to document [memory model](docs-source/synchronization.md) of Ruby which 
 would provide consistent behaviour and guarantees on all three of the main Ruby interpreters 
 (MRI/CRuby, JRuby, Rubinius, TruffleRuby).
 
@@ -323,13 +323,13 @@ best practice is to depend on `concurrent-ruby` and let users to decide if they
 *   [Jerry D'Antonio](https://github.com/jdantonio) (creator)
 *   [Chris Seaton](https://github.com/chrisseaton)
 
-### Special Thanks
+### Special Thanks to
 
 *   [Brian Durand](https://github.com/bdurand) for the `ref` gem
 *   [Charles Oliver Nutter](https://github.com/headius) for the `atomic` and `thread_safe` gems
 *   [thedarkone](https://github.com/thedarkone) for the `thread_safe` gem
 
-### Maintainers of the past
+and to the past maintainers
 
 *   [Michele Della Torre](https://github.com/mighe)
 *   [Paweł Obrok](https://github.com/obrok)