travis-yaml 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 752665752154cdb3b8bc22e2dd0cf9eb6c79e36c
-  data.tar.gz: c7449c2793420fe650091f84eb749e037436c453
+  metadata.gz: c1f61d26437ffa23c1db1d0bcbd7b6aa7d241816
+  data.tar.gz: 711b3d7a38ef40135868bfeda3de2d480dcf64a4
 SHA512:
-  metadata.gz: 751b783a0265500138733893196c3853ec3f8eeee609a921077dad79bd7e8fcbfbef093259657ce9737112f6ea8234f00886663fdc167fe931ac721ca2eb54ef
-  data.tar.gz: 161583c79e9e1e820e1a9495d10b103d4f2a715a59d6956a4f1d8112fe07cb0baa328a69986d8613cdf716cca405d9c819e885fd69ad0db69bba5daa8539797e
+  metadata.gz: b53af5f90a07854c69c251f1959fdb8594cbe906e4b25c873570335d84835be949fb439556056f273aca2e44c167863c9ad1924426c7fa3ddb78f9d98f9d3a18
+  data.tar.gz: 20f6bed18ae94a9e70dd8411776e238af0a792a4e538ab3089cc91b31cc80fc04d117e2248bdf4203737b26c3f898a355154036b32f7d00775aa97f3fa3b8d55

data/.travis.yml

@@ -2,13 +2,8 @@ language: ruby
 rvm:
 - 1.9.3
 - 2.0.0
+- 2.1.2
+
+sudo: false
 script: bundle exec rspec
 bundler_args: "--without play"
-deploy:
-  provider: heroku
-  api_key:
-    secure: OrCcUz+MNjlxNkReqCvQZq62Y5mdKxjA+Lwo6VdsuoWHIJ8ShKIZUhoWOE6B0VIYSxSBObkXULitqiuZAvJfHSmS6soowPc79VvVeetMkIxRbHG9v3utg5O5pHqjHeW7pOWwrvTR5sria9YPevFN3+0R/C3xsxnQrc8dw+06jEQ=
-  app: travis-yaml
-  on:
-    repo: travis-ci/travis-yaml
-    ruby: 2.0.0

data/Gemfile

@@ -1,9 +1,6 @@
 source "https://rubygems.org"
 gemspec
 
-group :play do
-  gem 'sinatra'
-  gem 'sass', '~> 3.1'
-  gem 'slim', '~> 1.3'
-  gem 'gh'
-end
+group :psych do
+  gem 'psych', '~> 2.0', platforms: :ruby_19
+end

data/Gemfile.lock

@@ -2,72 +2,42 @@ PATH
   remote: .
   specs:
     travis-yaml (0.1.0)
-      psych (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
-    backports (3.4.0)
     diff-lcs (1.2.5)
-    docile (1.1.3)
-    faraday (0.9.0)
-      multipart-post (>= 1.2, < 3)
-    gh (0.13.0)
-      addressable
-      backports
-      faraday (~> 0.8)
-      multi_json (~> 1.0)
-      net-http-persistent (>= 2.7)
-      net-http-pipeline
-    multi_json (1.8.4)
-    multipart-post (2.0.0)
-    net-http-persistent (2.9)
-    net-http-pipeline (1.0.1)
-    psych (2.0.4)
-    rack (1.5.2)
-    rack-protection (1.5.2)
-      rack
-    rake (10.1.1)
-    rspec (3.0.0.beta2)
-      rspec-core (= 3.0.0.beta2)
-      rspec-expectations (= 3.0.0.beta2)
-      rspec-mocks (= 3.0.0.beta2)
-    rspec-core (3.0.0.beta2)
-      rspec-support (= 3.0.0.beta2)
-    rspec-expectations (3.0.0.beta2)
+    docile (1.1.5)
+    multi_json (1.10.1)
+    psych (2.0.5)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (= 3.0.0.beta2)
-    rspec-mocks (3.0.0.beta2)
-      rspec-support (= 3.0.0.beta2)
-    rspec-support (3.0.0.beta2)
-    safe_yaml (1.0.1)
-    sass (3.3.3)
-    simplecov (0.8.2)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    safe_yaml (1.0.3)
+    simplecov (0.9.0)
       docile (~> 1.1.0)
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    sinatra (1.4.4)
-      rack (~> 1.4)
-      rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
-    slim (1.3.9)
-      temple (~> 0.6.3)
-      tilt (~> 1.3, >= 1.3.3)
-    temple (0.6.7)
-    tilt (1.4.1)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
-  gh
+  psych (~> 2.0)
   rake
-  rspec (~> 3.0.0.beta)
+  rspec (~> 3.0)
   safe_yaml (~> 1.0.1)
-  sass (~> 3.1)
   simplecov
-  sinatra
-  slim (~> 1.3)
   travis-yaml!

data/README.md

@@ -43,9 +43,104 @@ end
 
 ## What is missing?
 
-* Full definition of current .travis.yml format
 * Serialization
 
+## External API
+
+### Loading a config
+
+``` ruby
+config = Travis::Yaml.parse('language: ruby') # parse from a yaml string
+config = Travis::Yaml.parse(language: "ruby") # parse from Ruby object
+```
+
+For Psych/YAML compatibility, `parse` is also aliased to `load`.
+
+### Convenience
+
+Nodes generally behave like normal Ruby objects. Mappings accept both symbols and strings as keys. Known fields on mappings are exposed as methods.
+
+``` ruby
+puts config.language
+puts config[:language]
+puts config['language']
+```
+
+### Warnings and errors
+
+* **errors** are actual parse errors, parent elements should discard elements with errors.
+* **warnigns** are general warnings for an element, with the element still being usable. These do not include warnings for child elements (though an error in a child element becomes a warning for its immediate parent).
+* **nested warnings** include warnigns for the whole tree, they also come with key prefix (array of strings) to identify the position the error occured at.
+
+``` ruby
+Travis::Yaml.parse("foo: bar").nested_warnings.each do |key, warning|
+  puts "#{key.join('.')}: #{warning}"
+end
+
+# will print nested warnings to stderr, will raise on top level error
+Travis::Yaml.parse! "foo: bar"
+```
+
+### Secure Variables
+
+Secure variables are stored as `Travis::Yaml::SecureString` internally. A secure string has at least an `encrypted_string` or a `decrypted_string`, or both.
+
+You can use `decrypt`/`encrypt` with a block to generate the missing string:
+
+``` ruby
+secret = Travis::Yaml::SecureString.new("foo")
+
+secret.encrypted_string # => "foo"
+secret.decrypted_string # => nil
+secret.encrypted?       # => true
+secret.decrypted?       # => false
+
+secret.decrypt { |string| string.upcase }
+
+secret.encrypted_string # => "foo"
+secret.decrypted_string # => "FOO"
+secret.encrypted?       # => true
+secret.decrypted?       # => true
+```
+
+To avoid having to walk the whole structure manually or hardcoding the values to decrypt, these methods are also exposed on any node:
+
+``` ruby
+config = Travis::Yaml.load 'env: { secure: foo }'
+config.decrypted? # => false
+
+config.decrypt { |string| string.upcase }
+config.decrypted?                        # => true
+config.env.matrix.first.decrypted_string # => "FOO"
+```
+
+This can even be done right with the parse step:
+
+``` ruby
+content = File.read('.travis.yml')
+Travis::Yaml.parse! content do |config|
+  config.decrypt { |string| string.upcase }
+end
+```
+
+### Serializiation
+
+A travis-yaml document can be serialized to a few other formats via the `serialize` method:
+
+``` ruby
+pp   config.serialize(:ruby)
+puts config.serialize(:json, pretty: true)
+```
+
+Serializer | Descriptions                                                      | Options
+-----------|-------------------------------------------------------------------|---------
+`ruby`     | Corresponding Ruby objects, secure values will be `SecureString`s | `secure`, `symbol_keys`
+`legacy`   | Format compatible with Travis CI's old `fetch_config` service     | `secure`, `symbol_keys`
+`json`     | Serialize as JSON, parsable via `Travis::Yaml.load`               | `secure`, `pretty`
+`yaml`     | Serialize as YAML, parsable via `Travis::Yaml.load`               | `secure`, `symbol_keys`, `indentation`, `line_width`, `canonical`, `avoid_tags`
+
+The `secure` option can be set to `:decrypted` or `:encrypted`, enforcing the decrypted or encrypted form of secure strings to be serialized. In some serializations, this might lead to secure strings being mapped to normal strings if set to `:decrypted`.
+
 ## Defining Structure
 
 Good starting points for getting into the code are the [root](lib/travis/yaml/nodes/root.rb) node and the [language](lib/travis/yaml/nodes/language.rb) node.
@@ -78,7 +173,7 @@ module Travis::Yaml::Nodes
 end
 ```
 
-Available types are `str`, `binary`, `bool`, `float`, `int`, `time`, `secure` and `null`.
+Available types are `str`, `binary`, `bool`, `float`, `int`, `time`, `regexp`, `secure` and `null`.
 
 #### Default Value
 

data/SPEC.md

@@ -4,6 +4,63 @@ Here is a list of all the options understood by travis-yaml.
 Note that stricitly speaking Travis CI might not have the same understanding of these as travis-yaml has at the moment, since travis-yaml is not yet being used.
 
 ### Available Options
+#### `addons`
+**Expected format:** Key value mapping.
+
+#### `addons.code_climate`
+**Expected format:** Key value mapping.
+
+#### `addons.code_climate.repo_token`
+**Expected format:** String or encrypted string.
+
+#### `addons.coverity_scan`
+**Expected format:** Key value mapping.
+
+#### `addons.coverity_scan.branch_pattern`
+**Expected format:** String or encrypted string.
+
+#### `addons.coverity_scan.build_command`
+**Expected format:** String or encrypted string.
+
+#### `addons.coverity_scan.build_command_prepend`
+**Expected format:** String or encrypted string.
+
+#### `addons.coverity_scan.build_script_url`
+**Expected format:** String or encrypted string.
+
+#### `addons.coverity_scan.notification_email`
+**Expected format:** String or encrypted string.
+
+#### `addons.coverity_scan.project`
+**Expected format:** Key value mapping.
+
+#### `addons.coverity_scan.project.name`
+**This setting is required!**
+
+**Expected format:** String or encrypted string.
+
+#### `addons.firefox`
+`firefox` version to use.
+
+**Expected format:** String.
+
+#### `addons.hosts`
+**Expected format:** List of strings; or a single string.
+
+#### `addons.postgresql`
+`postgresql` version to use.
+
+**Expected format:** String.
+
+#### `addons.sauce_connect`
+**Expected format:** Key value mapping.
+
+#### `addons.sauce_connect.access_key`
+**Expected format:** String or encrypted string.
+
+#### `addons.sauce_connect.username`
+**Expected format:** String or encrypted string.
+
 #### `after_deploy`
 Commands that will be run on the VM.
 
@@ -29,6 +86,21 @@ Commands that will be run on the VM.
 
 **Expected format:** List of strings; or a single string.
 
+#### `android`
+**This setting is only relevant if [`language`](#language) is set to `android`.**
+
+**Expected format:** Key value mapping.
+
+#### `android.components`
+List of `components` versions to use.
+
+**Expected format:** List of strings; or a single string.
+
+#### `android.licenses`
+List of `licenses` versions to use.
+
+**Expected format:** List of strings; or a single string.
+
 #### `before_deploy`
 Commands that will be run on the VM.
 
@@ -45,7 +117,7 @@ Commands that will be run on the VM.
 **Expected format:** List of strings; or a single string.
 
 #### `branches`
-**Expected format:** Key value mapping.
+**Expected format:** Key value mapping, or list of strings or regular expressions.
 
 #### `branches.except`
 **Expected format:** List of strings or regular expressions; or a single string or regular expression.
@@ -67,9 +139,17 @@ Commands that will be run on the VM.
 #### `cache.bundler`
 **Expected format:** Boolean value.
 
+#### `cache.cocoapods`
+**Expected format:** Boolean value.
+
 #### `cache.directories`
 **Expected format:** List of strings; or a single string.
 
+#### `cache.edge`
+**This setting is experimental and might be removed!**
+
+**Expected format:** Boolean value.
+
 #### `compiler`
 **This setting is only relevant if [`language`](#language) is set to `c` or `cpp`.**
 
@@ -86,13 +166,16 @@ Value has to be `gcc` (default) or `clang`; or one of the known aliases: `g++` f
 **Expected format:** String.
 
 #### `deploy`
-**Expected format:** List of key value mappings; or a single key value mapping.
+**Expected format:** List of key value mappings, or strings; or a single key value mapping, or string.
 
 #### `deploy[]`
-**Expected format:** Key value mapping.
+**Expected format:** Key value mapping, or string.
 
 #### `deploy[].*`
-**Expected format:** String.
+**Expected format:** Key value mapping, or string or encrypted string.
+
+#### `deploy[].*.*`
+**Expected format:** String or encrypted string.
 
 #### `deploy[].edge`
 **This setting is experimental and might be removed!**
@@ -100,16 +183,16 @@ Value has to be `gcc` (default) or `clang`; or one of the known aliases: `g++` f
 **Expected format:** Boolean value.
 
 #### `deploy[].on`
-**Expected format:** Key value mapping.
+**Expected format:** Key value mapping, or list of strings; or a single string.
 
 #### `deploy[].on.all_branches`
 **Expected format:** Boolean value.
 
 #### `deploy[].on.branch`
-**Expected format:** String.
+**Expected format:** List of strings; or a single string.
 
 #### `deploy[].on.condition`
-**Expected format:** String.
+**Expected format:** List of strings; or a single string.
 
 #### `deploy[].on.jdk`
 **This setting is only relevant if [`language`](#language) is set to `clojure`, `groovy`, `java`, `ruby` (default), `scala` or `android`.**
@@ -171,7 +254,7 @@ Alias for [`deploy[].on.ruby`](#deployonruby).
 **Expected format:** String.
 
 #### `env`
-**Expected format:** Key value mapping.
+**Expected format:** Key value mapping, or list of strings or encrypted strings.
 
 #### `env.global`
 **Expected format:** List of strings or encrypted strings; or a single string or encrypted string.
@@ -234,7 +317,7 @@ List of `jdk` versions to use.
 #### `language`
 **This setting is required!**
 
-Value has to be `c`, `cpp`, `clojure`, `erlang`, `go`, `groovy`, `haskell`, `java`, `node_js`, `objective-c`, `ruby` (default), `python`, `perl`, `php`, `scala` or `android`; or one of the known aliases: `jvm` for `java`, `javascript` for `node_js`, `node` for `node_js`, `nodejs` for `node_js`, `golang` for `go`, `objective_c` for `objective-c`, `obj_c` for `objective-c`, `objc` for `objective-c`, `c++` for `cpp`, `node.js` for `node_js` or `obj-c` for `objective-c`. Setting is not case sensitive.
+Value has to be `c`, `cpp`, `clojure`, `erlang`, `go`, `groovy`, `haskell`, `java`, `node_js`, `objective-c`, `ruby` (default), `python`, `perl`, `php`, `scala`, `android` or `generic`; or one of the known aliases: `jvm` for `java`, `javascript` for `node_js`, `node` for `node_js`, `nodejs` for `node_js`, `golang` for `go`, `objective_c` for `objective-c`, `obj_c` for `objective-c`, `objc` for `objective-c`, `c++` for `cpp`, `node.js` for `node_js`, `obj-c` for `objective-c`, `bash` for `generic`, `sh` for `generic` or `shell` for `generic`. Setting is not case sensitive.
 
 **Expected format:** String.
 
@@ -652,10 +735,10 @@ Value has to be `always`, `never` or `change`. Setting is case sensitive.
 **Expected format:** String.
 
 #### `notifications.campfire.rooms`
-**Expected format:** List of strings; or a single string.
+**Expected format:** List of strings or encrypted strings; or a single string or encrypted string.
 
 #### `notifications.campfire.template`
-Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`.
+Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`, `%{commit_message}`.
 
 **Expected format:** List of strings; or a single string.
 
@@ -684,31 +767,31 @@ Value has to be `always`, `never` or `change`. Setting is case sensitive.
 **Expected format:** String.
 
 #### `notifications.email.recipients`
-**Expected format:** List of strings; or a single string.
+**Expected format:** List of strings or encrypted strings; or a single string or encrypted string.
 
-#### `notifications.flowdoc`
+#### `notifications.flowdock`
 **Expected format:** Key value mapping, or string, encrypted string, or boolean value.
 
-#### `notifications.flowdoc.api_token`
+#### `notifications.flowdock.api_token`
 **Expected format:** String or encrypted string.
 
-#### `notifications.flowdoc.disabled`
+#### `notifications.flowdock.disabled`
 **Expected format:** Boolean value.
 
-#### `notifications.flowdoc.enabled`
+#### `notifications.flowdock.enabled`
 **Expected format:** Boolean value.
 
-#### `notifications.flowdoc.on_failure`
+#### `notifications.flowdock.on_failure`
 Value has to be `always`, `never` or `change`. Setting is case sensitive.
 
 **Expected format:** String.
 
-#### `notifications.flowdoc.on_start`
+#### `notifications.flowdock.on_start`
 Value has to be `always`, `never` or `change`. Setting is case sensitive.
 
 **Expected format:** String.
 
-#### `notifications.flowdoc.on_success`
+#### `notifications.flowdock.on_success`
 Value has to be `always`, `never` or `change`. Setting is case sensitive.
 
 **Expected format:** String.
@@ -743,10 +826,10 @@ Value has to be `always`, `never` or `change`. Setting is case sensitive.
 **Expected format:** String.
 
 #### `notifications.hipchat.rooms`
-**Expected format:** List of strings; or a single string.
+**Expected format:** List of strings or encrypted strings; or a single string or encrypted string.
 
 #### `notifications.hipchat.template`
-Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`.
+Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`, `%{commit_message}`.
 
 **Expected format:** List of strings; or a single string.
 
@@ -757,7 +840,7 @@ Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repo
 **Expected format:** String or encrypted string.
 
 #### `notifications.irc.channels`
-**Expected format:** List of strings; or a single string.
+**Expected format:** List of strings or encrypted strings; or a single string or encrypted string.
 
 #### `notifications.irc.disabled`
 **Expected format:** Boolean value.
@@ -793,7 +876,7 @@ Value has to be `always`, `never` or `change`. Setting is case sensitive.
 **Expected format:** Boolean value.
 
 #### `notifications.irc.template`
-Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`.
+Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`, `%{commit_message}`.
 
 **Expected format:** List of strings; or a single string.
 
@@ -825,10 +908,10 @@ Value has to be `always`, `never` or `change`. Setting is case sensitive.
 **Expected format:** String.
 
 #### `notifications.slack.rooms`
-**Expected format:** List of strings; or a single string.
+**Expected format:** List of strings or encrypted strings; or a single string or encrypted string.
 
 #### `notifications.slack.template`
-Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`.
+Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`, `%{commit_message}`.
 
 **Expected format:** List of strings; or a single string.
 
@@ -857,10 +940,10 @@ Value has to be `always`, `never` or `change`. Setting is case sensitive.
 **Expected format:** String.
 
 #### `notifications.sqwiggle.rooms`
-**Expected format:** List of strings; or a single string.
+**Expected format:** List of strings or encrypted strings; or a single string or encrypted string.
 
 #### `notifications.sqwiggle.template`
-Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`.
+Strings will be interpolated. Available variables: `%{repository_slug}`, `%{repository_name}`, `%{repository}`, `%{build_number}`, `%{branch}`, `%{commit}`, `%{author}`, `%{message}`, `%{duration}`, `%{compare_url}`, `%{build_url}`, `%{commit_message}`.
 
 **Expected format:** List of strings; or a single string.
 
@@ -892,7 +975,7 @@ Value has to be `always`, `never` or `change`. Setting is case sensitive.
 **Expected format:** String.
 
 #### `notifications.webhooks.urls`
-**Expected format:** List of strings; or a single string.
+**Expected format:** List of strings or encrypted strings; or a single string or encrypted string.
 
 #### `npm_args`
 **This setting is only relevant if [`language`](#language) is set to `node_js`.**
@@ -938,6 +1021,11 @@ List of `php` versions to use.
 
 **Expected format:** List of strings; or a single string.
 
+#### `podfile`
+`podfile` version to use.
+
+**Expected format:** String.
+
 #### `python`
 **This setting is only relevant if [`language`](#language) is set to `python`.**
 
@@ -960,11 +1048,6 @@ Commands that will be run on the VM.
 
 **Expected format:** List of strings; or a single string.
 
-#### `sdk_components`
-**This setting is only relevant if [`language`](#language) is set to `android`.**
-
-**Expected format:** List of strings; or a single string.
-
 #### `services`
 List of `services` versions to use.