-
Notifications
You must be signed in to change notification settings - Fork 1k
get tut to work with Travis #593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
662621e
get tut to work with Travis
jarrodu b8a575b
Update run-tut.sh
jarrodu 736b650
tutify the Scala tour
jarrodu 6b24056
Merge branch 'tut' into tour-tut
jarrodu 990085e
add breaking change
jarrodu 6224340
try to get travis to give exit status 1 for run-tut script
jarrodu 3a052b6
fix breaking change.
jarrodu 2778265
add a bit of documentation about tut
jarrodu aab3b23
Update contribute.md
jarrodu d57f721
update Gemfile to reflect current usage.
jarrodu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,6 +39,8 @@ It's statically generated from [Markdown](http://en.wikipedia.org/wiki/Markdown) | |
|
||
The markdown syntax being used supports [Maruku](http://maruku.rubyforge.org/maruku.html) extensions, and has automatic syntax highlighting, without the need for any tags. | ||
|
||
Additionally [tut](https://github.com/tpolecat/tut) is used during pull requests to valid Scala code blocks. To use this feature you must use the backtick notation as documented by tut. Note that only validation are done. The output files from tut are not used in the building of the tutorial. Either use `tut` or `tut:fail` for your code blocks. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/valid/validate/ |
||
|
||
## Submitting Docs | ||
|
||
For one to contribute a document, one must simply | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
#!/bin/bash | ||
curl -L -o coursier https://git.io/vgvpD | ||
chmod +x coursier |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#!/bin/bash | ||
|
||
COURSIER_CLASSPATH="$(./coursier fetch -p com.chuusai:shapeless_2.11:2.3.1 org.scala-lang.modules::scala-xml:1.0.3)" | ||
|
||
./coursier launch -r "https://dl.bintray.com/tpolecat/maven/" org.tpolecat:tut-core_2.11:0.4.4 -- . tut-tmp '.*\.md$' -classpath "$COURSIER_CLASSPATH" | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,93 +38,110 @@ In the following example we add the `throws` annotation to the definition of the | |
> A Java compiler checks that a program contains handlers for [checked exceptions](http://docs.oracle.com/javase/specs/jls/se5.0/html/exceptions.html) by analyzing which checked exceptions can result from execution of a method or constructor. For each checked exception which is a possible result, the **throws** clause for the method or constructor _must_ mention the class of that exception or one of the superclasses of the class of that exception. | ||
> Since Scala has no checked exceptions, Scala methods _must_ be annotated with one or more `throws` annotations such that Java code can catch exceptions thrown by a Scala method. | ||
|
||
package examples | ||
import java.io._ | ||
class Reader(fname: String) { | ||
private val in = new BufferedReader(new FileReader(fname)) | ||
@throws(classOf[IOException]) | ||
def read() = in.read() | ||
} | ||
``` | ||
package examples | ||
import java.io._ | ||
class Reader(fname: String) { | ||
private val in = new BufferedReader(new FileReader(fname)) | ||
@throws(classOf[IOException]) | ||
def read() = in.read() | ||
} | ||
``` | ||
|
||
The following Java program prints out the contents of the file whose name is passed as the first argument to the `main` method. | ||
|
||
package test; | ||
import examples.Reader; // Scala class !! | ||
public class AnnotaTest { | ||
public static void main(String[] args) { | ||
try { | ||
Reader in = new Reader(args[0]); | ||
int c; | ||
while ((c = in.read()) != -1) { | ||
System.out.print((char) c); | ||
} | ||
} catch (java.io.IOException e) { | ||
System.out.println(e.getMessage()); | ||
``` | ||
package test; | ||
import examples.Reader; // Scala class !! | ||
public class AnnotaTest { | ||
public static void main(String[] args) { | ||
try { | ||
Reader in = new Reader(args[0]); | ||
int c; | ||
while ((c = in.read()) != -1) { | ||
System.out.print((char) c); | ||
} | ||
} catch (java.io.IOException e) { | ||
System.out.println(e.getMessage()); | ||
} | ||
} | ||
} | ||
``` | ||
|
||
Commenting out the `throws` annotation in the class Reader produces the following error message when compiling the Java main program: | ||
|
||
Main.java:11: exception java.io.IOException is never thrown in body of | ||
corresponding try statement | ||
} catch (java.io.IOException e) { | ||
^ | ||
1 error | ||
``` | ||
Main.java:11: exception java.io.IOException is never thrown in body of | ||
corresponding try statement | ||
} catch (java.io.IOException e) { | ||
^ | ||
1 error | ||
``` | ||
|
||
### Java Annotations ### | ||
|
||
**Note:** Make sure you use the `-target:jvm-1.5` option with Java annotations. | ||
|
||
Java 1.5 introduced user-defined metadata in the form of [annotations](http://java.sun.com/j2se/1.5.0/docs/guide/language/annotations.html). A key feature of annotations is that they rely on specifying name-value pairs to initialize their elements. For instance, if we need an annotation to track the source of some class we might define it as | ||
|
||
@interface Source { | ||
public String URL(); | ||
public String mail(); | ||
} | ||
``` | ||
@interface Source { | ||
public String URL(); | ||
public String mail(); | ||
} | ||
``` | ||
|
||
And then apply it as follows | ||
|
||
@Source(URL = "http://coders.com/", | ||
mail = "[email protected]") | ||
public class MyClass extends HisClass ... | ||
``` | ||
@Source(URL = "http://coders.com/", | ||
mail = "[email protected]") | ||
public class MyClass extends HisClass ... | ||
``` | ||
|
||
An annotation application in Scala looks like a constructor invocation, for instantiating a Java annotation one has to use named arguments: | ||
|
||
@Source(URL = "http://coders.com/", | ||
mail = "[email protected]") | ||
class MyScalaClass ... | ||
``` | ||
@Source(URL = "http://coders.com/", | ||
mail = "[email protected]") | ||
class MyScalaClass ... | ||
``` | ||
|
||
This syntax is quite tedious if the annotation contains only one element (without default value) so, by convention, if the name is specified as `value` it can be applied in Java using a constructor-like syntax: | ||
|
||
@interface SourceURL { | ||
public String value(); | ||
public String mail() default ""; | ||
} | ||
``` | ||
@interface SourceURL { | ||
public String value(); | ||
public String mail() default ""; | ||
} | ||
``` | ||
|
||
And then apply it as follows | ||
|
||
@SourceURL("http://coders.com/") | ||
public class MyClass extends HisClass ... | ||
``` | ||
@SourceURL("http://coders.com/") | ||
public class MyClass extends HisClass ... | ||
``` | ||
|
||
In this case, Scala provides the same possibility | ||
|
||
@SourceURL("http://coders.com/") | ||
class MyScalaClass ... | ||
``` | ||
@SourceURL("http://coders.com/") | ||
class MyScalaClass ... | ||
``` | ||
|
||
The `mail` element was specified with a default value so we need not explicitly provide a value for it. However, if we need to do it we can not mix-and-match the two styles in Java: | ||
|
||
@SourceURL(value = "http://coders.com/", | ||
mail = "[email protected]") | ||
public class MyClass extends HisClass ... | ||
``` | ||
@SourceURL(value = "http://coders.com/", | ||
mail = "[email protected]") | ||
public class MyClass extends HisClass ... | ||
``` | ||
|
||
Scala provides more flexibility in this respect | ||
|
||
@SourceURL("http://coders.com/", | ||
mail = "[email protected]") | ||
class MyScalaClass ... | ||
|
||
|
||
|
||
|
||
|
||
``` | ||
@SourceURL("http://coders.com/", | ||
mail = "[email protected]") | ||
class MyScalaClass ... | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need to be able to use
sudo
and similar commands. The main thing is to be able tochmod
coursier. This is disallowed on the container version of Travis. Thesudo: true
puts it all on a virtual machine. At least this is my understanding.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can't even
chmod +x
things we just downloaded ourselves in our own home directory? that surprises me, I wouldn't expect superuser privileges to be necessary. are you sure?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it is our home directory. It is Travis's directory and Travis executes our scripts. At least this is how I think about it.
https://docs.travis-ci.com/user/ci-environment/
The container builds are heavily restricted. You can't even install all
apt
packages.https://github.com/travis-ci/apt-package-whitelist
I did not look to deeply into it. If you remove the
sudo: true
Travis will throw an error when you try tochmod
. There maybe another way to get around this error. Feel feel to play around with it.