asdf-discover 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62237375363e82aebaa954b482acd3c16109b208ad48b976bdd0fe6eef9ab946
+  data.tar.gz: 6cbe4ccee4b08822b75c8e854acc5488ec5204106f6a69d3eb56f7a4456f318b
+SHA512:
+  metadata.gz: b4834888adce95eba59ac70dcffde7778a0d367aa9f624ef6d5c1873348af089b6e26eb4cc316087f45c7e1cda77233c7d7476982fcb791d93b5b337eaecdf29
+  data.tar.gz: 9958fb09d33896bccd1333912085baffb4b47970c38db51331fa179d7ed81b51bac0afcc6f8edf5103bd6ba99aa811f84f40121f4fdc2caba3d157b62dcc825f

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,42 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"
+    - "**/*.rake"
+    - "spec/**/*.rb"
+
+RSpec/ExampleLength:
+  Max: 15
+
+RSpec/FactoryBot/CreateList:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/WordArray:
+  EnforcedStyle: brackets

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [version] - yyyy-mm-dd
+
+### Added
+### Changed
+### Deprecated
+### Fixed
+### Removed
+### Security
+
+## [Unreleased]
+
+## [1.0] - 2020-10-02
+
+### Added
+
+* Support for nodejs from .node-version, .nvmrc
+* Support for ruby from .ruby-version, .rvmrc
+* Support for golang from go.mod

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in asdf-discover.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jason Schweier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# asdf-discover
+
+A gem that provides an executable to populate [asdf](http://asdf-vm.com/)'s `.tool-versions` file.
+
+## Changelog
+
+[Changelog](./CHANGELOG.md) following https://keepachangelog.com
+
+## Installation
+
+```
+$ gem install asdf-discover
+```
+
+## Usage
+
+Run `asdf-discover` in a project directory.
+
+## Languages / Versions Discovered
+
+| Lanuage | File          |
+|---------|---------------|
+| Go      | go.mod        |
+| Ruby    | .ruby-version |
+| Ruby    | .rvmrc        |
+| node.js | .nvmrc        |
+| node.js | .node-version |
+
+## TODO
+
+* If a version comes from multiple sources, list them all (currently displays the first found)
+* There seems to be 2 ways to find a version:
+  * The contents of a file (e.g. .ruby-version)
+  * A line in a file (e.g. go.mod)
+
+  Consider a DSL for adding more:
+
+  ```ruby
+  class GoMod
+    include Asdf::Searcher
+
+    scan_file "go.mod", for: /go ([0-9.]+)$/
+  end
+
+  class DotRubyVersion
+    include Asdf::Searcher
+
+    file_contents ".ruby-version"
+  end
+  ```
+
+## Development
+
+After checking out the repo, run `bundle install`.
+Then, run `rake spec` to run the tests.
+
+You can run the binary locally with: `ruby -Ilib ./exe/asdf-discover path/to/directory`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jmks/asdf-discover.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/asdf-discover.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/asdf_discover/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "asdf-discover"
+  spec.version       = AsdfDiscover::VERSION
+  spec.authors       = ["Jason Schweier"]
+  spec.email         = ["jason.schweier@gmail.com"]
+
+  spec.summary       = %(Simple command to discover what should be in ASDF's .tool-versions file)
+  spec.homepage      = "https://github.com/jmks/asdf-discover"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jmks/asdf-discover"
+  # spec.metadata["changelog_uri"] = "https://github.com/jmks/asdf-discover/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "asdf/discover"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/asdf-discover

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require "asdf_discover"
+require "fileutils"
+
+FileUtils.cd(ARGV.first) if ARGV.first
+
+if File.exist?(AsdfDiscover::TOOL_VERSIONS)
+  puts "#{AsdfDiscover::TOOL_VERSIONS} already exists!"
+  exit(1)
+end
+
+result = AsdfDiscover.search
+
+unless result.any?
+  puts "No tool versions found!"
+  exit(1)
+end
+
+unless result.consistent?
+  result.conflicts.each do |conflict|
+    puts "Discovered multiple versions for #{conflict.tool}:"
+    conflict.sources.each do |source|
+      puts "  - #{source.version} from #{source.source}"
+    end
+    puts
+  end
+  puts "You should manually reconcile which version to use"
+  puts ".tool-versions will include all versions discovered"
+  puts "asdf, by default, will use the first entry"
+end
+
+File.open(AsdfDiscover::TOOL_VERSIONS, "w") do |f|
+  result.tool_versions.each do |tool_version|
+    f.puts "#{tool_version.tool} #{tool_version.version} # from #{tool_version.source}"
+  end
+end

data/lib/asdf_discover.rb

@@ -0,0 +1,33 @@
+require "asdf_discover/result"
+require "asdf_discover/search_result"
+require "asdf_discover/searchers/dot_node_version"
+require "asdf_discover/searchers/dot_ruby_version"
+require "asdf_discover/searchers/gemfile"
+require "asdf_discover/searchers/go_mod"
+require "asdf_discover/searchers/nvmrc"
+require "asdf_discover/version"
+
+# Namespace for the gem
+module AsdfDiscover
+  TOOL_VERSIONS = ".tool-versions".freeze
+
+  def self.add_searcher(*searchers)
+    @searchers ||= []
+    @searchers.concat(searchers)
+  end
+
+  def self.search
+    found = @searchers
+      .map(&:new)
+      .map(&:call)
+      .select(&:found?)
+
+    SearchResult.new(found)
+  end
+
+  add_searcher Searchers::DotNodeVersion
+  add_searcher Searchers::DotRubyVersion
+  add_searcher Searchers::Gemfile
+  add_searcher Searchers::GoMod
+  add_searcher Searchers::Nvmrc
+end

data/lib/asdf_discover/result.rb

@@ -0,0 +1,18 @@
+module AsdfDiscover
+  # The result of a search by a Searcher.
+  # A result is either Found or NotFound.
+
+  # A result that was found.
+  Found = Struct.new(:tool, :version, :source) do
+    def found?
+      true
+    end
+  end
+
+  # A nil result
+  class NotFound
+    def self.found?
+      false
+    end
+  end
+end

data/lib/asdf_discover/search_result.rb

@@ -0,0 +1,42 @@
+module AsdfDiscover
+  # Amalgamated results from Searchers.
+  # Contains the data required to display warnings and write the .tool-versions file.
+  class SearchResult
+    Conflict = Struct.new(:tool, :sources)
+
+    def initialize(results)
+      @results = results
+    end
+
+    def consistent?
+      conflicts.none?
+    end
+
+    def conflicts
+      @conflicts ||= find_conflicts
+    end
+
+    def tool_versions
+      @tool_versions ||= collect_tool_versions
+    end
+
+    def any?
+      @results.any?
+    end
+
+    private
+
+    def find_conflicts
+      @results
+        .group_by(&:tool)
+        .filter { |_tool, matches| matches.map(&:version).uniq.length != 1 }
+        .map { |tool, matches| Conflict.new(tool, matches) }
+    end
+
+    def collect_tool_versions
+      @results
+        .sort_by { |e| [e.tool, e.version] }
+        .uniq { |e| [e.tool, e.version] }
+    end
+  end
+end

data/lib/asdf_discover/searcher.rb

@@ -0,0 +1,9 @@
+module AsdfDiscover
+  # A Searcher responds to #call and returns a AsdfDiscover::Result
+  class Searcher
+    # call should return either Found or NotFound
+    def call
+      raise "implement me"
+    end
+  end
+end

data/lib/asdf_discover/searchers/dot_node_version.rb

@@ -0,0 +1,16 @@
+module AsdfDiscover
+  module Searchers
+    # Searches in .node-version
+    class DotNodeVersion
+      NODE_VERSION = ".node-version".freeze
+
+      def call
+        return NotFound unless File.exist?(NODE_VERSION)
+
+        version = File.read(NODE_VERSION).chomp
+
+        Found.new("nodejs", version, NODE_VERSION)
+      end
+    end
+  end
+end

data/lib/asdf_discover/searchers/dot_ruby_version.rb

@@ -0,0 +1,16 @@
+module AsdfDiscover
+  module Searchers
+    # Searches in .ruby-version
+    class DotRubyVersion
+      RUBY_VERSION_FILE = ".ruby-version".freeze
+
+      def call
+        return NotFound unless File.exist?(RUBY_VERSION_FILE)
+
+        version = File.read(RUBY_VERSION_FILE).chomp
+
+        Found.new("ruby", version, RUBY_VERSION_FILE)
+      end
+    end
+  end
+end

data/lib/asdf_discover/searchers/gemfile.rb

@@ -0,0 +1,18 @@
+module AsdfDiscover
+  module Searchers
+    # Searches for a Ruby version in a Gemfile
+    class Gemfile
+      GEMFILE = "Gemfile".freeze
+
+      def call
+        return NotFound unless File.exist?(GEMFILE)
+
+        File.open(GEMFILE, "r").each_line do |line|
+          return Found.new("ruby", Regexp.last_match(1), GEMFILE) if line =~ /ruby ['"]([0-9.]+)['"]$/
+        end
+
+        NotFound
+      end
+    end
+  end
+end

data/lib/asdf_discover/searchers/go_mod.rb

@@ -0,0 +1,18 @@
+module AsdfDiscover
+  module Searchers
+    # Searches for a Go version in the go.mod file
+    class GoMod
+      GO_MOD = "go.mod".freeze
+
+      def call
+        return NotFound unless File.exist?(GO_MOD)
+
+        File.open(GO_MOD, "r").each_line do |line|
+          return Found.new("golang", Regexp.last_match(1), GO_MOD) if line =~ /go ([0-9.]+)$/
+        end
+
+        NotFound
+      end
+    end
+  end
+end

data/lib/asdf_discover/searchers/nvmrc.rb

@@ -0,0 +1,16 @@
+module AsdfDiscover
+  module Searchers
+    # Searches in .nvmrc
+    class Nvmrc
+      NVMRC = ".nvmrc".freeze
+
+      def call
+        return NotFound unless File.exist?(NVMRC)
+
+        version = File.read(NVMRC).chomp
+
+        Found.new("nodejs", version, NVMRC)
+      end
+    end
+  end
+end

data/lib/asdf_discover/version.rb

@@ -0,0 +1,3 @@
+module AsdfDiscover
+  VERSION = "1.0.0".freeze
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: asdf-discover
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jason Schweier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- jason.schweier@gmail.com
+executables:
+- asdf-discover
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- asdf-discover.gemspec
+- bin/console
+- bin/setup
+- exe/asdf-discover
+- lib/asdf_discover.rb
+- lib/asdf_discover/result.rb
+- lib/asdf_discover/search_result.rb
+- lib/asdf_discover/searcher.rb
+- lib/asdf_discover/searchers/dot_node_version.rb
+- lib/asdf_discover/searchers/dot_ruby_version.rb
+- lib/asdf_discover/searchers/gemfile.rb
+- lib/asdf_discover/searchers/go_mod.rb
+- lib/asdf_discover/searchers/nvmrc.rb
+- lib/asdf_discover/version.rb
+homepage: https://github.com/jmks/asdf-discover
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jmks/asdf-discover
+  source_code_uri: https://github.com/jmks/asdf-discover
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Simple command to discover what should be in ASDF's .tool-versions file
+test_files: []