travis_check_rubies 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab21a220cbfd5c324fed2b89437b745669ac522e
-  data.tar.gz: 535c8f939a7d062574f920c0c1f42d28e06ed754
+  metadata.gz: d0565043dfa3d7dcaed61f34261c1af5b367d923
+  data.tar.gz: fd91c41ce727573376e72d29f05e6c5e68751553
 SHA512:
-  metadata.gz: 849c73497444dfcf8e1aa7c0303e6169c8ee823d8ae072ec7190016468857cad59618cbdaaeb232b0e67c523a6eef3b3b5bcad03913baabfeb54aa88c98025ac
-  data.tar.gz: 010526626e47ad0a788cf4b15acf2849318ba4c5f4d0936ee6d729679a0f496a5f180b8a8c104af8201e4f7e4c58ef04d9853de89c7ff1f7e347c2329d2c4988
+  metadata.gz: acedf4996dadb6720dfffa8444ad5def2e4b5076ff1a09a5a56bd770c14a051ea242f6a8769035d8335f023f9191f49f340fc8632e830d6db4f9800ca866e17d
+  data.tar.gz: 70f4e50e8362147dcd4ec8a0deed8ef07acacffcc97235e336263e6dd96818ebaf4a7a56c0d32595371cc74971298639f7e241d7f69ef799aa38c2fd9b820e7c

data/.travis.yml

@@ -1,12 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - '2.0.0-p648'
-  - '2.1.10'
-  - '2.2.8'
-  - '2.3.5'
-  - '2.4.2'
-  - 'jruby-9.0.5.0'
+  - '2.3.8'
+  - '2.4.5'
+  - '2.5.3'
   - 'jruby-9.1.9.0'
 before_script:
   - env
@@ -14,10 +11,3 @@ before_script:
 script:
   - bundle exec rspec
   - bundle exec travis_check_rubies
-matrix:
-  allow_failures:
-    - rvm: 'jruby-9.0.5.0'
-  exclude:
-    - rvm: 'jruby-9.0.5.0'
-  include:
-    - rvm: 'jruby-9.0.5.0'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Ivan Kuchin
+Copyright (c) 2017-2018 Ivan Kuchin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -43,4 +43,4 @@ bundle exec travis_check_rubies
 
 ## Copyright
 
-Copyright (c) 2017 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.
+Copyright (c) 2017-2018 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.

data/bin/travis_check_rubies

@@ -6,6 +6,8 @@ require 'yaml'
 
 CONFIG_FILE = '.travis_check_rubies.yml'
 
+update = false
+
 options = if File.exist?(CONFIG_FILE)
   yaml = YAML.load_file(CONFIG_FILE) || {}
   fail "#{CONFIG_FILE} doesn't contain options hash" unless yaml.is_a?(Hash)
@@ -36,11 +38,18 @@ end
 op.on('--exclude V,V,V', Array, 'Exclude matching versions') do |exclude|
   options[:exclude] = exclude
 end
+op.on('-u', '--update', 'Update versions') do
+  update = true
+end
 begin
   op.parse!
 rescue => e
   abort "#{e}\n\n#{op.help}"
 end
 
-suggestions = TravisCheckRubies::TravisYml.new.suggestions(options)
-abort suggestions if suggestions
+travis_yml = TravisCheckRubies::TravisYml.new(options: options)
+if update
+  abort unless travis_yml.update
+else
+  abort unless travis_yml.suggest
+end

data/lib/travis_check_rubies/travis_yml.rb

@@ -1,66 +1,152 @@
+require 'fspath'
 require 'yaml'
+require 'travis_check_rubies/updater'
 require 'travis_check_rubies/version'
 
 module TravisCheckRubies
   class TravisYml
-    attr_reader :path
-    attr_reader :versions, :allow_failures_versions, :exclude_versions, :include_versions
+    Suggestion = Struct.new(:section, :from, :choices, :to)
 
-    def initialize(path = '.travis.yml')
-      @path = path
+    attr_reader :path, :options
 
-      yaml = YAML.load_file(path)
-      @versions = Array(yaml['rvm']).map(&Version.method(:new))
-      @allow_failures_versions = matrix_versions(yaml, 'allow_failures')
-      @exclude_versions = matrix_versions(yaml, 'exclude')
-      @include_versions = matrix_versions(yaml, 'include')
+    def initialize(path: '.travis.yml', options: {})
+      @path = FSPath(path)
+      @options = options
     end
 
-    def suggestions(options)
-      suggestions = Hash.new{ |h, k| h[k] = [] }
+    def warnings
+      return @warnings if @warnings
 
-      updates = Version.updates(versions, options)
+      @warnings = []
 
-      versions.each do |version|
-        next unless (for_version = updates[version])
-        suggestions['rvm'] << "#{version} -> #{for_version.join(', ')}"
+      rvm_versions.group_by(&:itself).select{ |_, versions| versions.count > 1 }.each do |version, _|
+        @warnings << "#{version} in rvm is repeating"
       end
 
-      allow_failures_versions.each do |version|
-        next if versions.include?(version)
-        next if include_versions.include?(version)
-        suggestions['matrix.allow_failures'] << "#{version} in matrix.allow_failures is not in rvm or include list"
+      (allow_failures_versions - rvm_versions - include_versions).each do |version|
+        @warnings << "#{version} in matrix.allow_failures is not in rvm or include list"
       end
 
-      exclude_versions.each do |version|
-        next if versions.include?(version)
-        suggestions['matrix.exclude'] << "#{version} in matrix.exclude is not in rvm list"
+      (exclude_versions - rvm_versions).each do |version|
+        @warnings << "#{version} in matrix.exclude is not in rvm list"
+      end
+
+      @warnings
+    end
+
+    def suggestions
+      return @suggestions if @suggestions
+
+      @suggestions = []
+
+      updates = Version.updates(rvm_versions, options)
+      rvm_versions.each do |version|
+        next unless (suggestions = updates[version])
+        @suggestions << Suggestion.new('rvm', version, suggestions)
       end
 
       {
-        'matrix.allow_failures' => allow_failures_versions,
-        'matrix.exclude' => exclude_versions,
+        'allow_failures' => allow_failures_versions,
+        'exclude' => exclude_versions,
+        'include' => include_versions,
       }.each do |section, versions|
         versions.each do |version|
-          next unless (for_version = updates[version])
-          suggestions[section] << "#{version} -> #{for_version.join(', ')}"
+          next unless (suggestions = Version.update(version, options))
+          next if suggestions.include?(version)
+          to = section == 'include' ? suggestions.last : suggestions.first
+          @suggestions << Suggestion.new(section, version, suggestions, to)
         end
       end
 
-      include_versions.each do |version|
-        next unless (for_version = Version.update(version, options))
-        next if for_version.include?(version)
-        suggestions['matrix.include'] << "#{version} -> #{for_version.join(', ')}"
+      @suggestions
+    end
+
+    def suggest
+      puts warnings
+
+      suggestions.group_by(&:section).each do |section, section_suggestions|
+        puts "#{section}:"
+        section_suggestions.each do |suggestion|
+          puts "  #{suggestion.from} -> #{suggestion.choices.join(', ')}"
+        end
       end
 
-      return if suggestions.empty?
-      suggestions.map do |section, lines|
-        "#{section}:\n#{lines.map{ |line| "  #{line}" }.join("\n")}"
-      end.join("\n")
+      warnings.empty? && suggestions.empty?
+    end
+
+    def update
+      unless warnings.empty?
+        puts warnings
+
+        return false
+      end
+
+      unless YAML.load(updated_content) == expected_object
+        puts updated_content
+
+        return false
+      end
+
+      FSPath.temp_file(path.basename, path.dirname) do |f|
+        f.write(updated_content)
+        f.path.rename(path)
+      end
+
+      true
     end
 
   private
 
+    def original_content
+      @original_content ||= path.read
+    end
+
+    def original_object
+      @original_object ||= YAML.load(original_content)
+    end
+
+    def expected_object
+      @expected_object ||= YAML.load(original_content).tap do |expected|
+        suggestions.each do |suggestion|
+          if suggestion.section == 'rvm'
+            index = expected['rvm'].find_index{ |v| suggestion.from == v }
+            expected['rvm'][index, 1] = suggestion.choices.map(&:to_s)
+          else
+            entry = expected['matrix'][suggestion.section].find{ |attrs| suggestion.from == attrs['rvm'] }
+            entry['rvm'] = suggestion.to.to_s
+          end
+        end
+      end
+    end
+
+    def updated_content
+      return @updated_content if @updated_content
+
+      updater = Updater.new(original_content)
+
+      suggestions.each do |suggestion|
+        updater = updater.apply_suggestion(suggestion)
+      end
+
+      @updated_content = updater.content
+    end
+
+    def rvm_versions
+      @rvm_versions ||= Array(original_object['rvm']).map(&Version.method(:new))
+    end
+
+    def allow_failures_versions
+      @allow_failures_versions ||= matrix_versions(original_object, 'allow_failures')
+    end
+
+    def exclude_versions
+      @exclude_versions ||= matrix_versions(original_object, 'exclude')
+    end
+
+    def include_versions
+      @include_versions ||= matrix_versions(original_object, 'include')
+    end
+
     def matrix_versions(yaml, key)
       return [] unless (matrix = yaml['matrix'])
       return [] unless (list = matrix[key])

data/lib/travis_check_rubies/updater.rb

@@ -0,0 +1,92 @@
+require 'psych'
+
+module TravisCheckRubies
+  class Updater
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+
+    def apply_suggestion(suggestion)
+      lines = content.lines
+
+      if suggestion.section == 'rvm'
+        apply_rvm_suggestion(lines, suggestion)
+      else
+        apply_matrix_suggestion(lines, suggestion)
+      end
+
+      self.class.new lines.join('')
+    end
+
+  private
+
+    def apply_rvm_suggestion(lines, suggestion)
+      node = rvm_node.children.find{ |node| suggestion.from == node.to_ruby }
+
+      lines[node.start_line] = suggestion.choices.map do |version|
+        line_with_version_change(lines, node, suggestion.from, version)
+      end.join('')
+    end
+
+    def apply_matrix_suggestion(lines, suggestion)
+      section_node = matrix_section_node(suggestion.section)
+
+      entry_node = section_node.children.find{ |node| suggestion.from == node.to_ruby['rvm'] }
+
+      node = fetch_node_mapping(entry_node, 'rvm')
+
+      lines[node.start_line] = line_with_version_change(lines, node, suggestion.from, suggestion.to)
+    end
+
+    def root
+      @root ||= Psych::Parser.new(Psych::TreeBuilder.new).parse(content).handler.root.children[0].children[0]
+    end
+
+    def rvm_node
+      fetch_node_mapping(root, 'rvm').tap do |rvm_node|
+        assert_type rvm_node, Psych::Nodes::Sequence
+        fail "Expected block style: #{rvm_node.to_ruby}" unless rvm_node.style == Psych::Nodes::Sequence::BLOCK
+      end
+    end
+
+    def matrix_section_node(section)
+      matrix_node = fetch_node_mapping(root, 'matrix')
+
+      fetch_node_mapping(matrix_node, section).tap do |section_node|
+        assert_type section_node, Psych::Nodes::Sequence
+      end
+    end
+
+    def fetch_node_mapping(mapping, key)
+      assert_type mapping, Psych::Nodes::Mapping
+
+      _, node = mapping.children.each_cons(2).find{ |key_node, _| key_node.to_ruby == key }
+
+      fail "Didn't find key #{key.inspect} in #{mapping.to_ruby}" unless node
+
+      node
+    end
+
+    def line_with_version_change(lines, node, from, to)
+      assert_type node, Psych::Nodes::Scalar
+
+      line = lines[node.start_line]
+
+      before = line[0...node.start_column]
+      excerpt = line[node.start_column...node.end_column]
+      after = line[node.end_column..-1]
+
+      fail "Didn't find #{from.to_s} in #{line}" unless excerpt.sub!(from.to_s, to.to_s)
+
+      "#{before}#{excerpt}#{after}"
+    end
+
+    def assert_type(node, expected_class)
+      return if node.is_a?(expected_class)
+
+      fail "Expected a #{expected_class}, got #{node.class}"
+    end
+  end
+end

data/spec/travis_check_rubies/updater_spec.rb

@@ -0,0 +1,116 @@
+require 'rspec'
+require 'travis_check_rubies/updater'
+
+describe TravisCheckRubies::Updater do
+  describe '#apply_suggestion' do
+    subject{ described_class.new(content).apply_suggestion(suggestion) }
+
+    context 'for rvm change suggestion' do
+      let(:content) do
+        <<~YAML
+          language: ruby
+          rvm: # rvm
+            - '2.1.3' # foo
+            - '2.2.8' # bar
+            - '2.5.0' # baz
+          before_script:
+            - env # env
+        YAML
+      end
+
+      context 'removing version' do
+        let(:suggestion){ double(section: 'rvm', from: '2.2.8', choices: []) }
+
+        let(:expected) do
+          <<~YAML
+            language: ruby
+            rvm: # rvm
+              - '2.1.3' # foo
+              - '2.5.0' # baz
+            before_script:
+              - env # env
+          YAML
+        end
+
+        it{ is_expected.to have_attributes(content: expected) }
+      end
+
+      context 'changing to one version' do
+        let(:suggestion){ double(section: 'rvm', from: '2.2.8', choices: [double(to_s: '2.2.9')]) }
+
+        let(:expected) do
+          <<~YAML
+            language: ruby
+            rvm: # rvm
+              - '2.1.3' # foo
+              - '2.2.9' # bar
+              - '2.5.0' # baz
+            before_script:
+              - env # env
+          YAML
+        end
+
+        it{ is_expected.to have_attributes(content: expected) }
+      end
+
+      context 'changing to multiple versions' do
+        let(:suggestion){ double(section: 'rvm', from: '2.2.8', choices: [double(to_s: '2.2.9'), double(to_s: '2.3.4')]) }
+
+        let(:expected) do
+          <<~YAML
+            language: ruby
+            rvm: # rvm
+              - '2.1.3' # foo
+              - '2.2.9' # bar
+              - '2.3.4' # bar
+              - '2.5.0' # baz
+            before_script:
+              - env # env
+          YAML
+        end
+
+        it{ is_expected.to have_attributes(content: expected) }
+      end
+    end
+
+    context 'for matrix change suggestion' do
+      let(:content) do
+        <<~YAML
+          language: ruby
+          before_script:
+            - env # env
+          matrix:
+            allow_failures:
+              - rvm: '2.2.8' # foo
+            exclude:
+              - rvm: '2.2.8' # bar
+            include:
+              - rvm: '2.1.3' # foo
+              - rvm: '2.2.8' # bar
+              - rvm: '2.2.8' # baz
+        YAML
+      end
+
+      let(:suggestion){ double(section: 'include', from: '2.2.8', to: double(to_s: '2.2.9')) }
+
+      let(:expected) do
+        <<~YAML
+          language: ruby
+          before_script:
+            - env # env
+          matrix:
+            allow_failures:
+              - rvm: '2.2.8' # foo
+            exclude:
+              - rvm: '2.2.8' # bar
+            include:
+              - rvm: '2.1.3' # foo
+              - rvm: '2.2.9' # bar
+              - rvm: '2.2.8' # baz
+        YAML
+      end
+
+      it{ is_expected.to have_attributes(content: expected) }
+    end
+  end
+end

data/travis_check_rubies.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'travis_check_rubies'
-  s.version     = '0.2.5'
+  s.version     = '0.3.0'
   s.summary     = 'Are you using the latest rubies in .travis.yml?'
   s.description = 'Check if `.travis.yml` specifies latest available rubies from listed on https://rubies.travis-ci.org and propose changes'
   s.homepage    = "http://github.com/toy/#{s.name}"
@@ -14,9 +14,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = %w[lib]
 
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.3.0'
 
   s.add_runtime_dependency 'fspath', '~> 3.0'
+  s.add_runtime_dependency 'psych', '~> 3.0'
 
   s.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: travis_check_rubies
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Ivan Kuchin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2018-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fspath
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +68,9 @@ files:
 - bin/travis_check_rubies
 - lib/travis_check_rubies.rb
 - lib/travis_check_rubies/travis_yml.rb
+- lib/travis_check_rubies/updater.rb
 - lib/travis_check_rubies/version.rb
+- spec/travis_check_rubies/updater_spec.rb
 - spec/travis_check_rubies/version_spec.rb
 - travis_check_rubies.gemspec
 homepage: http://github.com/toy/travis_check_rubies
@@ -69,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -77,9 +93,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Are you using the latest rubies in .travis.yml?
 test_files:
+- spec/travis_check_rubies/updater_spec.rb
 - spec/travis_check_rubies/version_spec.rb