Merge pull request #8 from FrankHossfeld/master

several improvements

Author: niloc132

.github/workflows/build.yaml

@@ -0,0 +1,32 @@
+#
+# Copyright © 2018 The GWT Project Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      # TODO: cache dependencies (taking into accounts: Maven plugins, snapshots, etc.)
+
+      - name: Build with Maven
+        run: JAVA_HOME=$JAVA_HOME_8_X64 mvn -V -B -ntp -U -e verify
+

.gitignore

@@ -1,231 +1,10 @@
-# Created by .ignore support plugin (hsz.mobi)
-### GWT template
-*.class
+# NOTE: we don't include IDE-specific files (e.g. IntelliJ's *.iml and .idea/) on-purpose.
+# Those patterns should go in a global gitignore or repository-specific excludes.
+# See http://www.gwtproject.org/makinggwtbetter.html#global_gitignore
 
-# gwt caches and compiled units #
-war/gwt_bree/
-gwt-unitCache/
-
-# boilerplate generated classes #
-.apt_generated/
-
-# more caches and things from deploy #
-war/WEB-INF/deploy/
-war/WEB-INF/classes/
-
-#compilation logs
-.gwt/
-
-#gwt junit compilation files
-www-test/
-
-#old GWT (1.5) created this dir
-.gwt-tmp/
-### Java template
-# Compiled class file
-
-# Log file
-*.log
-
-# BlueJ files
-*.ctxt
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
-### Gradle template
-.gradle
-/build/
-
-# Ignore Gradle GUI config
-gradle-app.setting
-
-# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
-!gradle-wrapper.jar
-
-# Cache of project
-.gradletasknamecache
-
-# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
-# gradle/wrapper/gradle-wrapper.properties
-### macOS template
-# General
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must end with two \r
-Icon
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-### Example user template template
-### Example user template
-
-# IntelliJ project files
-.idea
-out
-*.iml
-
-gen### Eclipse template
-
-.metadata
-bin/
-tmp/
-*.tmp
-*.bak
-*.swp
-*~.nib
-local.properties
-.settings/
-.loadpath
-.recommenders
-
-# External tool builders
-.externalToolBuilders/
-
-# Locally stored "Eclipse launch configurations"
-*.launch
-
-# PyDev specific (Python IDE for Eclipse)
-*.pydevproject
-
-# CDT-specific (C/C++ Development Tooling)
-.cproject
-
-# CDT- autotools
-.autotools
-
-# Java annotation processor (APT)
-.factorypath
-
-# PDT-specific (PHP Development Tools)
-.buildpath
-
-# sbteclipse plugin
-.target
-
-# Tern plugin
-.tern-project
-
-# TeXlipse plugin
-.texlipse
-
-# STS (Spring Tool Suite)
-.springBeans
-
-# Code Recommenders
-.recommenders/
-
-# Scala IDE specific (Scala & Java development for Eclipse)
-.cache-main
-.scala_dependencies
-.worksheet
-### AppEngine template
-# Google App Engine generated folder
-appengine-generated/
-### Clojure template
-/lib/
-/classes/
-/target/
-/checkouts/
-.lein-deps-sum
-.lein-repl-history
-.lein-plugins/
-.lein-failures
-.nrepl-port
-.cpcache/
-### JetBrains template
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-# User-specific stuff
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
-
-# Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
-
-# Gradle
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# Gradle and Maven with auto-import
-# When using Gradle or Maven with auto-import, you should exclude module files,
-# since they will be recreated, and may cause churn.  Uncomment if using
-# auto-import.
-.idea/modules.xml
-.idea/*.iml
-.idea/modules
-
-# CMake
-cmake-build-*/
-
-# Mongo Explorer plugin
-.idea/**/mongoSettings.xml
-
-# File-based project format
-*.iws
-
-# IntelliJ
-out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-# Editor-based Rest Client
-.idea/httpRequests
+target/
+.flattened-pom.xml
 
-# in our case the war directory
+# gwt caches and compiled units #
 war/
-
-# target folder
-*/target/*
-.flattened-pom.xml
+gwt-unitCache/

.mvn/maven.config

@@ -1,16 +1,67 @@
-![GWT3/J2CL compatible](https://img.shields.io/badge/GWT3/J2CL-compatible-brightgreen.svg)
-
 # GWT Core
 
+![GWT3/J2CL compatible](https://img.shields.io/badge/GWT3/J2CL-compatible-brightgreen.svg)  [![License](https://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) [![Chat on Gitter](https://badges.gitter.im/hal/elemento.svg)](https://gitter.im/gwtproject/gwt-modules) ![CI](https://github.com/gwtproject/gwt-core/workflows/CI/badge.svg)
+
+A future-proof port of the `com.google.gwt.core.Core` GWT module, with no dependency on `gwt-user` (besides the Java Runtime Emulation), to prepare for GWT 3 / J2Cl.
+
 This project is meant to roughly approximate the various classes and methods found in gwt-user's `com.google.gwt.core`
 packages. In some cases, updated replacements are provided, in other cases working, but deprecated versions are offered,
 and further classes or members are outright skipped, encouraging projects to either find an alternative way to manage
 these operations before updating, or switch to a GWT3-version while performing the actual migration.
 
 This project is not yet complete, there are doubtlessly better ways to handle some cases here.
 
+##  Migrating from `com.google.gwt.core.Core`
+
+1. Add the dependency to your build.
+
+   For Maven:
+
+   ```xml
+   <dependency>
+     <groupId>org.gwtproject.core</groupId>
+     <artifactId>gwt-core</artifactId>
+     <version>HEAD-SNAPSHOT</version>
+   </dependency>
+   ```
+
+   For Gradle:
+
+   ```gradle
+   implementation("org.gwtproject.core:gwt-core:HEAD-SNAPSHOT")
+   ```
+
+2. Update your GWT module to use
+
+   ```xml
+   <inherits name="org.gwtproject.core.Core" />
+   ```
+
+3. Change the `import`s in your Java source files:
+
+   ```java
+   import org.gwtproject.core.client.GWT;
+   ```
+
+## Instructions
+
+To build gwt-core:
+
+* run `mvn clean verify`
 
-### Listing of classes from gwt-user's core
+on the parent directory. This will build the artifact and run tests against the JVM, J2CL, and GWT2.
+
+## System Requirements
+
+**GWT Core requires GWT 2.9.0 or newer!**
+
+
+## Dependencies
+
+GWT Core does not depend on any other module.
+
+
+## Listing of classes from gwt-user's core
 
  * client
    * debug
@@ -70,7 +121,7 @@ migrate to the new packages, then later update to newer versions of the migrated
 improvements are made.
 
 
-### Updating JavaScriptObject subclasses
+## Updating JavaScriptObject subclasses
 As with most of the deprecated classes kept in this library, existing JavaScriptObject types should be rewritten using 
 jsinterop annotations to correctly explain to the compiler what is happening. This class can still be convient to use
 as an argument or return type, but generally should not be extended in your own projects any longer.
@@ -86,21 +137,3 @@ Some basic guidlines to follow:
  * Overlay methods need to be marked with `@JsOverlay`, and continue to need to be effectively final (i.e. never 
  overridden), but no longer need to be marked as `final`.
 
-
-### Dependency
-
-```xml
-<dependency>
-    <groupId>org.gwtproject.core</groupId>
-    <artifactId>gwt-core</artifactId>
-    <version>1.0-SNAPSHOT</version>
-</dependency>
-```
-
-### Instructions
-To build gwt-core:
-
-* run `mvn clean install`
-
-on the parent directory. This will build the artifact and run tests against the JVM, J2CL, and GWT2.
-