travis-yaml 0.1.0

data/lib/travis/yaml/parser/ruby.rb

@@ -0,0 +1,77 @@
+require 'time'
+
+module Travis::Yaml
+  module Parser
+    class Ruby
+      def self.parses?(value)
+        value.is_a? Hash
+      end
+
+      def self.parse(value)
+        new(value).parse
+      end
+
+      def initialize(value, implicit = false)
+        @value    = value
+        @implicit = implicit
+      end
+
+      def parse(root = nil)
+        root ||= Travis::Yaml::Nodes::Root.new
+        accept(root, @value)
+        root
+      end
+
+      def accept(node, value)
+        case value
+        when Array                then node.visit_sequence   self, value
+        when Hash                 then node.visit_mapping    self, value
+        when SecureString         then node.visit_scalar     self, :secure, value,      @implicit
+        when String               then node.visit_scalar     self, :str,    value,      @implicit
+        when Symbol               then node.visit_scalar     self, :str,    value.to_s, @implicit
+        when Integer              then node.visit_scalar     self, :int,    value,      @implicit
+        when Float                then node.visit_scalar     self, :float,  value,      @implicit
+        when DateTime, Time, Date then node.visit_scalar     self, :time,   value,      @implicit
+        when true, false          then node.visit_scalar     self, :bool,   value,      @implicit
+        when Regexp               then node.visit_scalar     self, :regexp, value,      @implicit
+        when nil                  then node.visit_scalar     self, :null,   value,      @implicit
+        else                           node.visit_unexpected self, value
+        end
+        node.verify
+      end
+
+      def cast(type, value)
+        case type
+        when :str    then value.to_s
+        when :binary then value.unpack('m').first
+        when :bool   then !!value
+        when :float  then Float   value
+        when :int    then Integer value
+        when :time   then value.to_time
+        when :secure then SecureString === value ? value : SecureString.new(value.value)
+        when :regexp then Regexp.new(value)
+        when :null   then nil
+        else raise ArgumentError, 'unknown scalar type %p' % type
+        end
+      rescue RegexpError => error
+        raise ArgumentError, "broken regular expression - #{error.message}"
+      end
+
+      def apply_mapping(node, value)
+        value.each_pair { |key, value| node.visit_pair(self, key, value) }
+      end
+
+      def apply_sequence(node, value)
+        value.each { |child| node.visit_child(self, child) }
+      end
+
+      def generate_key(node, value)
+        case value
+        when String then value
+        when Symbol then value.to_s
+        else node.visit_unexpected(self, value, "expected string as key")
+        end
+      end
+    end
+  end
+end

data/lib/travis/yaml/secure_string.rb

@@ -0,0 +1,12 @@
+module Travis::Yaml
+  class SecureString
+    attr_accessor :encrypted_string, :decrypted_string
+    def initialize(string, encrypted = true)
+      if encrypted
+        @encryped_string = string
+      else
+        @decrypted_string = string
+      end
+    end
+  end
+end

data/lib/travis/yaml/version.rb

@@ -0,0 +1,5 @@
+module Travis
+  module Yaml
+    VERSION = '0.1.0'
+  end
+end

data/play/lint.rb

@@ -0,0 +1,8 @@
+# Usage: ruby play/travis.rb [FILE]
+# Will output any error/warnings
+require 'bundler/setup'
+require 'travis/yaml'
+
+file    = ARGV[0] || ".travis.yml"
+content = File.read(file)
+Travis::Yaml.parse!(content, file)

data/play/spec.rb

@@ -0,0 +1,183 @@
+require 'bundler/setup'
+require 'travis/yaml'
+
+module Travis::Yaml
+  def spec(**options)
+    Nodes::Root.spec(**options)
+  end
+
+  module Nodes
+    TEMPLATE_VARS     = Notifications::Template::VARIABLES.map { |v| "`%{#{v}}`"}.join(", ")
+    SPEC_DESCRIPTIONS = {
+      Stage                   => "Commands that will be run on the VM.",
+      Notifications::Template => "Strings will be interpolated. Available variables: #{TEMPLATE_VARS}.",
+      %w[gemfile]             => "Gemfile(s) to use.",
+      "gemfile"               => "Gemfile to use."
+    }
+
+    TYPES = {
+      binary: 'binary string',
+      bool:   'boolean value',
+      float:  'float value',
+      int:    'integer value',
+      null:   'null value',
+      str:    'string',
+      time:   'time value',
+      secure: 'encrypted string',
+      regexp: 'regular expression'
+    }
+
+    class Node
+      def self.spec_description(*prefix)
+        description = SPEC_DESCRIPTIONS[prefix] || SPEC_DESCRIPTIONS[prefix.last]
+        ancestors.each { |a| description ||= SPEC_DESCRIPTIONS[a] }
+        description
+      end
+
+      def self.spec_format
+      end
+
+      def self.spec(*prefix, **options)
+        options[:experimental] ||= false
+        options[:required]     ||= false
+        [{ key: prefix, description: spec_description(*prefix), format: spec_format, **options }]
+      end
+    end
+
+    class Scalar
+      def self.spec_format(append = "")
+        formats = cast.any? ? cast : [default_type]
+        formats.map { |f| TYPES[f] ? TYPES[f]+append : f.to_s }.join(', ').gsub(/, ([^,]+)$/, ' or \1')
+      end
+    end
+
+    class Version
+      def self.spec_description(*prefix)
+        super || "`#{prefix.last}` version to use."
+      end
+    end
+
+    class VersionList
+      def self.spec_description(*prefix)
+        super || "List of `#{prefix.last}` versions to use."
+      end
+    end
+
+    class FixedValue
+      def self.spec_description(*prefix)
+        super || begin
+          list = valid_values.map { |v| "`#{v}`#{" (default)" if default == v.to_s}" }.join(', ').gsub(/,([^,]+)$/, ' or\1')
+          if aliases.any?
+            alias_list = aliases.map { |k,v| "`#{k}` for `#{v}`" }.join(', ').gsub(/,([^,]+)$/, ' or\1')
+            list += "; or one of the known aliases: #{alias_list}"
+          end
+          "Value has to be #{list}. Setting is#{" not" if ignore_case?} case sensitive."
+        end
+      end
+    end
+
+    class Notifications::Notification
+      def self.spec_notification_format
+        "list of strings or encrypted strings"
+      end
+
+      def self.spec_format
+        super + ", or #{spec_notification_format}, or boolean value"
+      end
+    end
+
+    class Notifications::Flowdoc
+      def self.spec_notification_format
+        "string, encrypted string"
+      end
+    end
+
+    class Sequence
+      def self.spec_format
+        "list of " << type.spec_format("s") << "; or a single " << type.spec_format if type.spec_format
+      end
+
+      def self.spec(*prefix, **options)
+        specs = super
+        specs += type.spec(*prefix, '[]') unless type <= Scalar and not type < FixedValue
+        specs
+      end
+    end
+
+    class Root
+      def self.spec(*)
+        super[1..-1].sort_by { |e| e[:key] }
+      end
+    end
+
+    class OpenMapping
+      def self.spec(*prefix, **options)
+        super + default_type.spec(*prefix, '*')
+      end
+    end
+
+    class Mapping
+      def self.spec_format(append = "")
+        "key value mapping#{append}"
+      end
+
+      def self.default_spec_description
+        "a key value map"
+      end
+
+      def self.spec_options(key, **options)
+        if self < LanguageSpecific and languages = LanguageSpecific::LANGUAGE_SPECIFIC[key.to_sym]
+          languages = languages.map { |v| "`#{v}`#{" (default)" if v.to_s == 'ruby'}" }.join(', ').gsub(/,([^,]+)$/, ' or\1')
+        end
+        { required: required.include?(key), experimental: experimental.include?(key), languages:  languages }
+      end
+
+      def self.spec_aliases(*prefix, **options)
+        aliases.map { |k,v| { key: [*prefix, k], alias_for: [*prefix, v], **spec_options(k, **options) } }
+      end
+
+      def self.spec(*prefix, **options)
+        specs = mapping.sort_by(&:first).inject(super) { |l, (k,v)| l + v.spec(*prefix, k, **spec_options(k, **options)) }
+        specs + spec_aliases(*prefix, **options)
+      end
+    end
+  end
+end
+
+def self.format_name(key)
+  key.join('.').gsub('.[]', '[]')
+end
+
+def self.format_link(key)
+  key.join.gsub('[]', '')
+end
+
+content = <<-MARKDOWN
+## The `.travis.yml` Format
+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
+MARKDOWN
+
+Travis::Yaml.spec.each do |entry|
+  content << "#### `" << format_name(entry[:key]) << "`\n"
+  content << "**This setting is only relevant if [`language`](#language) is set to #{entry[:languages]}.**\n\n" if entry[:languages]
+  content << "**This setting is required!**\n\n" if entry[:required]
+  content << "**This setting is experimental and might be removed!**\n\n" if entry[:experimental]
+  if other = entry[:alias_for]
+    content << "Alias for " << "[`#{format_name(other)}`](##{format_link(other)})." << "\n\n"
+  else
+    content << entry[:description] << "\n\n" if entry[:description]
+    content << "**Expected format:** " <<  entry[:format].capitalize << ".\n\n" if entry[:format]
+  end
+end
+
+content << <<-MARKDOWN
+## Generating the Specification
+
+This file is generated. You currently update it by running `play/spec.rb`.
+MARKDOWN
+
+File.write('SPEC.md', content)

data/play/weblint.rb

@@ -0,0 +1,296 @@
+require 'bundler/setup'
+require 'travis/yaml'
+require 'sinatra'
+require 'slim'
+require 'gh'
+
+configure :production do
+  GH.set token: ENV.fetch('GITHUB_TOKEN')
+end
+
+get '/' do
+  slim ""
+end
+
+get '/style.css' do
+  sass :style
+end
+
+post '/' do
+  redirect to(params[:repo]) if params[:repo]
+  show_result
+end
+
+get '/gist/:id' do
+  file         = params[:file] || '.travis.yml'
+  params[:yml] = GH["/gists/#{params[:id]}"]['files'][file]['content']
+  show_result
+end
+
+get '/:owner/:name' do
+  params[:repo] = request.path_info[1..-1]
+  show_result
+end
+
+error GH::Error, NoMethodError do
+  halt 400, slim("ul.result\n  li failed to fetch <b class='error'>.travis.yml</b>")
+end
+
+helpers do
+  def show_result
+    halt 400, 'needs repo or yml' unless params[:repo] or params[:yml]
+    branch = params[:branch] || 'master'
+    params[:yml] ||= GH["/repos/#{params[:repo]}/contents/.travis.yml?ref=#{branch}"]['content'].to_s.unpack('m').first
+    @result = Travis::Yaml.parse(params[:yml])
+    @matrix = Travis::Yaml::Matrix.new(@result)
+    slim :result
+  end
+end
+
+__END__
+
+@@ result
+
+- if @result.nested_warnings.empty?
+  p.result Hooray, your .travis.yml seems to be solid!
+- else
+  ul.result
+    - @result.nested_warnings.each do |key, warning|
+      li
+        - if key.any?
+          | in <b class="error">#{key.join('.')}</b> section:
+          = " "
+        == slim('= error', {}, error: warning).gsub(/&quot;(.+?)&quot;/, '<b class="error">\1</b>')
+
+- if @matrix.size > 1
+  p.jobs It will generate #{@matrix.size} jobs:
+  ul.jobs
+    - @matrix.each do |job|
+      li = job.matrix_attributes.map { |k,v| "%s=%p" % [k,v] if v }.compact.join(', ')
+
+@@ layout
+
+html
+  head
+    title Validate your .travis.yml file
+    link rel="stylesheet" type="text/css" href="/style.css"
+  body
+    h1
+      a href="/" Travis WebLint
+    p.tagline
+      | Uses <a href="https://github.com/travis-ci/travis-yaml">travis-yaml</a> to check your .travis.yml config.
+
+    == yield
+
+    form class="first" action="/" method="post" accept-charset="UTF-8"
+      label for="repo" Enter your Github repository
+      input type="text" id="repo" name="repo" maxlength="80" placeholder="travis-ci/travis-yaml" required=true value=params[:repo]
+      input type="submit" value="Validate"
+
+    form action="/" method="post" accept-charset="UTF-8" id="ymlform"
+      label for="yml" Or paste your .travis.yml
+      textarea id="yml" name="yml" maxlength="10000" autofocus=true = params[:yml]
+      input type="submit" value="Validate"
+
+    javascript:
+      var input = document.getElementById("yml");
+      var form  = document.getElementById("ymlform");
+      input.onkeydown = function(event) {
+          if ((event.metaKey || event.ctrlKey) && event.keyCode == 13) form.submit();
+      };
+
+      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+      ga('create', 'UA-24868285-9', 'travis-ci.org');
+      ga('send', 'pageview');
+
+@@ style
+
+// http://meyerweb.com/eric/tools/css/reset/
+// v2.0 | 20110126
+// License: none (public domain)
+
+html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video
+  margin: 0
+  padding: 0
+  border: 0
+  font-size: 100%
+  font: inherit
+  vertical-align: baseline
+
+// HTML5 display-role reset for older browsers
+article, aside, details, figcaption, figure, footer, header, hgroup, menu, nav, section
+  display: block
+
+body
+  line-height: 1
+
+ol, ul
+  list-style: none
+
+blockquote, q
+  quotes: none
+
+blockquote
+  &:before, &:after
+    content: ''
+    content: none
+
+q
+  &:before, &:after
+    content: ''
+    content: none
+
+table
+  border-collapse: collapse
+  border-spacing: 0
+
+// General
+
+body
+  margin: 2em auto 2em auto
+  width: 960px
+  font-size: 14px
+  line-height: 1.4286
+  color: #555
+  background: #fff
+  font-family: "Helvetica Neue", Arial, Verdana, sans-serif
+
+b
+  font-weight: bold
+
+a
+  color: #36c
+  outline: none
+  text-decoration: underline
+
+a:visited
+  color: #666
+
+a:hover
+  color: #6c3
+  text-decoration: none
+
+h1
+  color: #000
+  font-size: 4em
+  font-weight: bold
+  line-height: 1em
+
+h1 a:link, h1 a:visited, h1 a:hover, h1 a:active
+  color: #000
+  text-decoration: none
+
+h2
+  font-size: 2em
+  font-weight: bold
+  line-height: 2em
+
+p.tagline
+  color: #777
+  display: block
+  font: italic 1.25em Georgia, Times, Serif
+  line-height: 1.67em
+  margin: 1em 0 4em 0
+  padding: 0 0 1.25em 0
+  border-bottom: 1px solid #ccc
+
+// Result
+
+.result
+  font-size: 1.5em
+  margin-bottom: 2em
+
+p.result
+  color: #6c3
+
+ul.result
+  list-style: none
+
+ul.result li:before
+  content: ">"
+  display: inline-block
+  background-color: #c00
+  color: #fff
+  width: 1.4em
+  height: 1.4em
+  font-size: 40%
+  margin-right: 1em
+  text-align: center
+  position: relative
+  top: -0.5em
+
+// jobs
+
+.jobs
+  font-size: 1.5em
+
+ul.jobs
+  list-style: none
+  margin-bottom: 2em
+  font-size: 1.25em
+
+ul.jobs li:before
+  content: ">"
+  display: inline-block
+  background-color: #000
+  color: #fff
+  width: 1.4em
+  height: 1.4em
+  font-size: 48%
+  margin-right: 1em
+  text-align: center
+  position: relative
+  top: -0.5em
+
+// Form
+
+form
+  display: inline-block
+  vertical-align: top
+  width: 475px
+
+form.left
+  margin-right: 55px
+
+label, input
+  display: block
+
+label
+  margin-bottom: 0.5em
+
+input, textarea
+  font-size: 14px
+  line-height: 1.4286
+  color: #555
+  font-family: "Helvetica Neue", Arial, Verdana, sans-serif
+  border: 1px solid #ccc
+  margin: 0
+
+input[type=text]
+  padding: 4px 8px
+  width: 400px
+
+input[type=submit]
+  background: #efefef
+  padding: 4px 8px
+  margin-top: 0.5em
+
+input[type=submit]:hover
+  cursor: pointer
+
+textarea
+  padding: 4px 8px
+  width: 460px
+  height: 250px
+
+// Various
+
+.error
+  color: #c00
+
+.note
+  margin-top: 5em