elm_install 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 866f31dd5848df9cc5fdce2188f1de72c04d8863
-  data.tar.gz: 5e78e0422f41adbcc320908a4d704429c4f030ff
+  metadata.gz: 37be0aa80902c18689f3c326dac58a7150bdbbbd
+  data.tar.gz: dcfc9bfb502d542eda6cbc3b50911253d35eb784
 SHA512:
-  metadata.gz: 9807dde1aba8c797b9f9e4db38885ff67f54c132eb022bb2733ec75fcfa09863260332fbd2bcca97a6ec5501d8a718e26350e0a4bb05eb84610f1e7eb0ee755c
-  data.tar.gz: 3877767e0e6038f564e01016d378ceae90120c68efc99accf0f3edfe523abd2b32f872fc2768a51872f5277c56e0bfba6d5f6ef0226bf4b1822fe5ad497c400c
+  metadata.gz: 68fda6c2faa66874538594da8c1656bc33ccd7100a7b728a4f7ab78d3895d1f5fb5b78be3f17fd29e77dd4c0f45f141fa2471dd8ff94dead8c0fcf9a17bb5b59
+  data.tar.gz: 4a6ec599550195f0a253f2702f833741a3c9cee21e2c504d7adb7bb5862e68fe4e0441d3eb312a347ce33f1daa456163ed901f1400c56413fbd274093ea2faf6

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 gemspec
 
+gem 'inch', '~> 0.7.1'
 gem 'rspec', '~> 3.5'
 gem 'rubocop', '~> 0.46.0'
 gem 'rubycritic', '~> 3.1', '>= 3.1.3'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elm_install (0.1.2)
+    elm_install (0.1.3)
       commander (~> 4.4, >= 4.4.2)
       git (~> 1.3)
       git_clone_url (~> 2.0)
@@ -22,6 +22,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     codeclimate-engine-rb (0.4.0)
       virtus (~> 1.0)
+    coderay (1.1.1)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     commander (4.4.2)
@@ -47,15 +48,25 @@ GEM
     hashdiff (0.3.1)
     highline (1.7.8)
     ice_nine (0.11.2)
+    inch (0.7.1)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.8.7.5)
     indentation (0.1.1)
     json (2.0.2)
     launchy (2.4.3)
       addressable (~> 2.3)
+    method_source (0.8.2)
     molinillo (0.5.4)
     parser (2.3.3.1)
       ast (~> 2.2)
     path_expander (1.0.1)
     powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     public_suffix (2.0.4)
     rainbow (2.1.0)
     reek (4.5.3)
@@ -100,11 +111,16 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    slop (3.6.0)
     smart_colored (1.1.1)
     solve (3.1.0)
       molinillo (>= 0.5)
       semverse (>= 1.1, < 3.0)
+    sparkr (0.4.1)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
     thread_safe (0.3.5)
+    tins (1.13.0)
     unicode-display_width (1.1.2)
     uri-ssh_git (2.0.0)
     virtus (1.0.5)
@@ -112,12 +128,14 @@ GEM
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   elm_install!
+  inch (~> 0.7.1)
   rspec (~> 3.5)
   rubocop (~> 0.46.0)
   rubycritic (~> 3.1, >= 3.1.3)

data/Rakefile

@@ -6,4 +6,5 @@ task :ci do
   sh 'rspec'
   sh 'rubocop'
   sh 'rubycritic -m --no-browser -s 90 lib'
+  sh 'inch suggest lib --pedantic'
 end

data/Readme.md

@@ -1,74 +1,87 @@
-# elm-github-install
+# elm-install
 
-[![npm version](https://badge.fury.io/js/elm-github-install.svg)](https://badge.fury.io/js/elm-github-install)
+[![Gem Version](https://badge.fury.io/rb/elm_install.svg)](https://badge.fury.io/rb/elm_install)
+[![Code Climate](https://codeclimate.com/github/gdotdesign/elm-github-install/badges/gpa.svg)](https://codeclimate.com/github/gdotdesign/elm-github-install)
+[![Inline docs](http://inch-ci.org/github/gdotdesign/elm-github-install.svg?branch=master)](http://inch-ci.org/github/gdotdesign/elm-github-install)
 
-This node script and package that allows you to install Elm packages **directly
-from Github**, bypassing the package repository (package.elm-lang.org) while also
-enabling restricted (effect manager and native) packages to be installed.
+This gem allows you to install Elm packages **directly from any Git repository
+(even private ones)**, bypassing the package repository (package.elm-lang.org)
+while also enabling restricted (effect manager and native) packages to be
+installed.
 
-## Description
+## Installation
 
-There are some things that made this possible:
-* The basic design of Elm packages: using github, semantic versioning and tags
-* [Semver package](https://www.npmjs.com/package/semver) to validate versions
-* [SemverResolver package](https://github.com/pghalliday/semver-resolver) that
-  does the actual resolving
-
-These are the steps the installer takes:
-* Reads the dependencies from `elm-package.json`
-* Transforms them to semver dependencies - **4.0.4 <= v < 5.0.0** becomes
-	**>= 4.0.4 < 5.0.0**
-* Loads the dependencies of the packages form Github and transforms them also
-* Resolve the dependencies
-* Install resolved dependencies into `elm-stuff/packages`
-* Writes `elm-stuff/exact-dependencies.json` with the resolved dependencies
-
-## Warnings
-
-There are some caveats though:
-* [TODO] This installer doesn't check the installed elm-version
-* [DEPENDENCY] Git tags (semver) are needed other references cannot be installed
-	(branch-name, commit-hash)
-* [DEPENDENCY] Git is needed
-* [DEPENDENCY] Node is needed
-
-## Usage
-
-Install it:
+If you have ruby installed on your machine then you can install it directy from
+[rubygems.org](https://rubygems.org/gems/elm_install):
 ```
-npm install -g elm-github-install
+gem install elm-install
 ```
 
-Elm packages are name after their github repositories, so you can simply declare the
-github package you want the way you would declare any other package.
-For example, if you want to install [NoRedInk's Elm css](https://github.com/NoRedInk/nri-elm-css)
-at version 1.3.0, you would do the following:
+There are also dependency free versions available for every release in the
+[releases page](https://github.com/gdotdesign/elm-github-install/releases).
+
+## Basic Usage
+Once installed `elm-install` can be used instead of `elm-package` as a
+replacement:
 
+`elm-package.json`:
 ```
-# elm-package.json
 {
   ...
   "dependencies": {
-    ...
-    "githubUser/repoName": "desiredVersion <= v < someLargerNumber",
-    "NoRedInk/nri-elm-css": "1.3.0 <= 1.3.0 < 2.0.0",
-    ...
+    "elm-lang/core": "5.0.0 <= v < 6.0.0",
+    "elm-lang/svg": "2.0.0 <= v < 3.0.0",
+    "elm-lang/dom": "1.1.1 <= v < 2.0.0"
   }
   ...
 }
 ```
 
-You can find the current version of the package in the repository's `elm-package.json`.
+Command:
+```sh
+$ elm-install install
 
-Use the command:
-```
-elm-github-install
+Resolving packages...
+  ▶ Package: git@github.com:elm-lang/core not found in cache, cloning...
+  ▶ Package: git@github.com:elm-lang/svg not found in cache, cloning...
+  ▶ Package: git@github.com:elm-lang/html not found in cache, cloning...
+  ▶ Package: git@github.com:elm-lang/virtual-dom not found in cache, cloning...
+  ▶ Package: git@github.com:elm-lang/dom not found in cache, cloning...
+Solving dependencies...
+Saving package cache...
+  ● elm-lang/core - 5.0.0 (5.0.0)
+  ● elm-lang/svg - 2.0.0 (2.0.0)
+  ● elm-lang/dom - 1.1.1 (1.1.1)
+  ● elm-lang/html - 2.0.0 (2.0.0)
+  ● elm-lang/virtual-dom - 2.0.2 (2.0.2)
+Packages configured successfully!
 ```
 
-## Demonstration
-The following repositories have their packages successfully installed and
-the main file successfully compiled (2016-06-12):
-* [STANDARD] https://github.com/debois/elm-mdl/tree/v7/demo - Demo.elm
-* [STANDARD] https://github.com/evancz/elm-sortable-table/tree/master/examples -
-	1-presidents.elm
-* [HAVE GITHUB DEPS] https://github.com/gdotdesign/elm-ui-website - source/Main.elm
+## Advanced Usage
+Sources (urls for git repositories) can be defined in the `dependency-sources`
+field in `elm-package.json` for any package defined the the `dependencies`
+field. There is only one restriction: the pacakges name must match the path of
+the url of the git repository, this is because it could cause conflicts.
+
+The source can be defined by a string or a hash containing the url and the
+reference (tag, commit hash, branch) to use. If a reference is defined then
+the version in the `dependencies` field is ignored and the **version will be
+used from the `elm-package.json` at that reference (= 2.0.0)**.
+
+```
+  ...
+  "dependencies": {
+    "gdotdesign/elm-install-test": "1.0.0 <= v < 2.0.0",
+    "elm-lang/core": "5.0.0 <= v < 6.0.0",
+    "elm-lang/svg": "2.0.0 <= v < 3.0.0",
+    "elm-lang/dom": "1.1.1 <= v < 2.0.0"
+  },
+  "dependency-sources": {
+    "elm-lang/core": "git@github.com:elm-lang/core",
+    "gdotdesign/elm-install-test": {
+      "url": "gdotdesign@bitbucket.org:gdotdesign/elm-install-test",
+      "ref": "master"
+    }
+  }
+  ...
+```

data/lib/elm_install.rb

@@ -15,6 +15,11 @@ require_relative './elm_install/installer'
 module ElmInstall
   module_function
 
+  # Starts an install with the given isntallation.
+  #
+  # @param options [Hash] The options
+  #
+  # @return [void]
   def install(options = { verbose: false })
     Installer.new(options).install
   end

data/lib/elm_install/base.rb

@@ -3,10 +3,14 @@ module ElmInstall
   class Base
     extend Forwardable
 
+    # @return [Hash] The current cache
     attr_reader :cache
 
     def_delegators :@cache, :each, :key?
 
+    # Initializes a new base for a cache.
+    #
+    # @param options [Hash] The options
     def initialize(options = {})
       @options = options
       @cache = {}
@@ -14,22 +18,31 @@ module ElmInstall
     end
 
     # Saves the cache into the json file.
+    #
+    # @return [void]
     def save
       File.binwrite(file, JSON.pretty_generate(@cache))
     end
 
     # Loads a cache from the json file.
+    #
+    # @return [void]
     def load
       @cache = JSON.parse(File.read(file))
     rescue
       @cache = {}
     end
 
+    # Returns the patch of the cache file.
+    #
+    # @return [String] The path
     def file
       File.join(directory, @file)
     end
 
-    # Returns the directory where the cache is stored.
+    # Returns the path of the directory where the cache is stored.
+    #
+    # @return [String] The path
     def directory
       @options[:directory]
     end

data/lib/elm_install/cache.rb

@@ -8,6 +8,9 @@ module ElmInstall
   # home directory (~/.elm-install), this can be changed with
   # the `directory` option.
   class Cache < Base
+    # Initializes a cache with the given options.
+    #
+    # @param options [Hash] The options
     def initialize(options)
       @file = 'cache.json'
       super options
@@ -15,18 +18,33 @@ module ElmInstall
 
     # Adds a new dependency to the cache for a given package & version
     # combination.
+    #
+    # @param package [String] The url of the package
+    # @param version [String] The semver version (1.0.0 or 1.0.0+master)
+    # @param constraint [Array] The constraint ["pacakge", "<= 1.0.0"]
+    #
+    # @return [Array] The dependencies of the package & version combination
     def dependency(package, version, constraint)
       ensure_package version
       @cache[package][version] << constraint
     end
 
     # Ensures that a package & version combination exists in the cache.
+    #
+    # @param package [String] The url of the package
+    # @param version [String] The semver version (1.0.0 or 1.0.0+master)
+    #
+    # @return [Array] The dependencies of the package & version combination
     def ensure_version(package, version)
       ensure_package package
       @cache[package][version] ||= []
     end
 
     # Ensures that a package exists in the cache.
+    #
+    # @param package [String] The url of the package
+    #
+    # @return [Hash] The dependency hash of the package
     def ensure_package(package)
       @cache[package] ||= {}
     end

data/lib/elm_install/elm_package.rb

@@ -2,31 +2,104 @@ module ElmInstall
   # This is a class for reading the `elm-package`.json file and
   # transform it's `dependecies` field to a unified format.
   module ElmPackage
-    # TODO: Error handling
+    # Returns the dependencies for the given `elm-package`.
+    #
+    # @param path [String] The path for the file
+    #
+    # @return [Hash] The hash of dependenceis (url => version or ref)
     def self.dependencies(path)
       json = read path
       transform_dependencies(
-        json['dependencies'],
+        json['dependencies'].to_h,
         json['dependency-sources'].to_h
       )
     end
 
+    # Reads the given file as JSON.
+    #
+    # :reek:DuplicateMethodCall
+    #
+    # @param path [String] The path
+    #
+    # @return [Hash] The json
     def self.read(path)
       JSON.parse(File.read(path))
+    rescue JSON::ParserError
+      Logger.arrow "Invalid JSON in file: #{path.bold}."
+      Process.exit
+    rescue Errno::ENOENT
+      Logger.arrow "Could not find file: #{path.bold}."
+      Process.exit
     end
 
+    # Transform dependencies from (package name => version) to
+    # (url => version or ref) format using the `depdendency-sources` field.
+    #
+    # @param raw_dependencies [Hash] The raw dependencies
+    # @param sources [Hash] The sources for the dependencies
+    #
+    # @return [Hash] The dependencies
     def self.transform_dependencies(raw_dependencies, sources)
       raw_dependencies.each_with_object({}) do |(package, constraint), memo|
         value = sources.fetch(package, package)
 
-        if value.is_a?(Hash)
-          memo[value['url']] = value['ref']
-        else
-          memo[transform_package(value)] = constraint
-        end
+        transform_dependency package, value, constraint, memo
       end
     end
 
+    # Transforms a dependecy.
+    #
+    # :reek:LongParameterList
+    # :reek:DuplicateMethodCall
+    #
+    # @param package [String] The package
+    # @param value [String] The version
+    # @param constraint [String] The constarint
+    # @param memo [Hash] The hash to save the dependency to
+    #
+    # @return [Hash] The memo object
+    def self.transform_dependency(package, value, constraint, memo)
+      if value.is_a?(Hash)
+        check_path package, value['url']
+        memo[value['url']] = value['ref']
+      else
+        url = transform_package(value)
+        check_path package, url
+        memo[url] = constraint
+      end
+    end
+
+    # Checks if the given url matches the given package.
+    #
+    # :reek:DuplicateMethodCall
+    #
+    # @param package [String] The package
+    # @param url [String] The url
+    #
+    # @return [void]
+    def self.check_path(package, url)
+      uri = GitCloneUrl.parse(url)
+      path = uri.path.sub(%r{^/}, '')
+
+      return if path == package
+
+      puts "
+  The source of package #{package.bold} is set to #{url.bold} which would
+  be install to #{"elm-stuff/#{path}".bold}. This would cause a conflict
+  when trying to compile anything.
+
+  The name of a package must match the source url's path.
+
+  #{package.bold} <=> #{path.bold}
+      "
+      Process.exit
+    end
+
+    # Transforms a package to it's url for if needed.
+    #
+    # @param key [String] The package
+    #
+    # @return [String] The url
     def self.transform_package(key)
       GitCloneUrl.parse(key).to_s
     rescue

data/lib/elm_install/git_resolver.rb

@@ -4,6 +4,9 @@ module ElmInstall
   # This class if for cloning and fetching repositories based
   # on a cache.
   class GitResolver < Base
+    # Initializes a git resolver with the given options.
+    #
+    # @param options [Hash] The options
     def initialize(options)
       @file = 'ref-cache.json'
       super options
@@ -11,36 +14,71 @@ module ElmInstall
         @cache.keys.each_with_object({}) { |key, memo| memo[key] = true }
     end
 
+    # Returns the refs for a given url.
+    #
+    # @param url [String] the url
+    #
+    # @return [Hash] The refs
     def refs(url)
       self.class.refs(url)
     end
 
+    # Clears the cache
+    #
+    # @return [void]
     def clear
       @check_cache = {}
     end
 
+    # Returns the refs for a given url.
+    #
+    # @param url [String] the url
+    #
+    # @return [Hash] The refs
     def self.refs(url)
       refs = Git.ls_remote url
       refs.delete 'head'
       JSON.parse(refs.to_json)
     end
 
+    # Returns if the given package (url) is in the cache.
+    #
+    # @param url [String] The url
+    #
+    # @return [Boolean] True if exists false if not
     def package?(url)
       @check_cache.key?(repository_path(url))
     end
 
+    # Returns the path of the repository for a given url.
+    #
     # :reek:FeatureEnvy
+    #
+    # @param url [String] The url
+    #
+    # @return [String] The path
     def repository_path(url)
       uri = GitCloneUrl.parse(url)
       File.join(directory, uri.host, uri.path)
     end
 
+    # Returns a git repository object for the given url, cloning it
+    # if it does not exists.
+    #
+    # @param url [String] The url
+    #
+    # @return [Git::Base] The repository
     def repository(url)
       open(url) do |repo|
         update_cache repo
       end
     end
 
+    # Updates a repository checking it's refs and fetching changes if needed.
+    #
+    # @param repo [Git::Base] The repository
+    #
+    # @return [void]
     def update_cache(repo)
       directory = File.dirname(repo.repo.path)
       url = repo.remote.url
@@ -55,6 +93,11 @@ module ElmInstall
       cache[directory] = refs
     end
 
+    # Opens a git repository cloning if it's not exists.
+    #
+    # @param url [String] The url
+    #
+    # @return [Git::Base] The repository
     def open(url)
       path = repository_path(url)
 
@@ -68,6 +111,12 @@ module ElmInstall
       repo
     end
 
+    # Clones the repostiry from the given url to the given path.
+    #
+    # @param url [String] The url
+    # @param path [String] The path
+    #
+    # @return [Git::Base] The repository
     def clone(url, path)
       Logger.arrow "Package: #{url.bold} not found in cache, cloning..."
       FileUtils.mkdir_p path

data/lib/elm_install/graph_builder.rb

@@ -1,16 +1,25 @@
 module ElmInstall
   # This class is for building dependency graphs from a cache.
   class GraphBuilder
+    # @return [Solve::Graph] The graph
     attr_reader :graph
 
-    # Returns a graph from a cache.
+    # Returns a graph from a cache and options.
+    #
+    # @param cache [Cache] The cache to generate the graph from.
+    # @param options [Hash] The options to use.
+    #
+    # @return [Solve::Graph] The graph
     def self.graph_from_cache(cache, options = { verbose: false })
       graph = new cache, options
       graph.build
       graph.graph
     end
 
-    # Initialies a graph build with a cache
+    # Initialies a graph build with a cache and options.
+    #
+    # @param cache [Cache] The cache to generate the graph from.
+    # @param options [Hash] The options to use.
     def initialize(cache, options = { verbose: false })
       @graph = Solve::Graph.new
       @options = options
@@ -18,6 +27,8 @@ module ElmInstall
     end
 
     # Builds the graph.
+    #
+    # @return [void]
     def build
       @cache.each do |package, versions|
         add_versions package, versions

data/lib/elm_install/installer.rb

@@ -9,9 +9,9 @@ module ElmInstall
   # file and populating the `elm-stuff` directory with the packages and
   # writing the `elm-stuff/exact-dependencies.json`.
   class Installer
-    extend Forwardable
-
     # Initializes a new installer with the given options.
+    #
+    # @param options [Hash] The options
     def initialize(options)
       init_options options
       @git_resolver = GitResolver.new directory: cache_directory
@@ -20,11 +20,19 @@ module ElmInstall
       @options = options
     end
 
+    # Initializes the options setting default values.
+    #
+    # @param options [Hash] The options
+    #
+    # @return [Hash] The options
     def init_options(options = { verbose: false })
       options[:cache_directory] ||= File.join(Dir.home, '.elm-install')
       @options = options
     end
 
+    # Returns the path to the cache directory
+    #
+    # @return [String] The path
     def cache_directory
       @options[:cache_directory]
     end
@@ -32,6 +40,8 @@ module ElmInstall
     # Executes the installation
     #
     # :reek:TooManyStatements { max_statements: 7 }
+    #
+    # @return [void]
     def install
       puts 'Resolving packages...'
       resolver.add_constraints dependencies
@@ -42,12 +52,18 @@ module ElmInstall
       retry_install
     end
 
+    # Saves the caches
+    #
+    # @return [void]
     def save
       puts 'Saving package cache...'
       @git_resolver.save
       @cache.save
     end
 
+    # Clears the reference cache and retries installation.
+    #
+    # @return [void]
     def retry_install
       Logger.arrow(
         'Could not find a solution in local cache, refreshing packages...'
@@ -66,6 +82,8 @@ module ElmInstall
 
     # Populates the `elm-stuff` directory with the packages from
     # the solution.
+    #
+    # @return [void]
     def populate_elm_stuff
       save
       @populator.populate calculate_solution
@@ -73,11 +91,15 @@ module ElmInstall
     end
 
     # Returns the resolver to calculate the solution.
+    #
+    # @return [Resolver] The resolver
     def resolver
       @resolver ||= Resolver.new @cache, @git_resolver
     end
 
     # Returns the solution for the given `elm-package.json` file.
+    #
+    # @return [Hash] The solution
     def calculate_solution
       Solve.it!(
         GraphBuilder.graph_from_cache(@cache, @options),
@@ -85,6 +107,9 @@ module ElmInstall
       )
     end
 
+    # Returns the dependencies form `elm-package.json`.
+    #
+    # @return [Hash] The dependencies
     def dependencies
       @dependencies ||= ElmPackage.dependencies 'elm-package.json'
     end

data/lib/elm_install/logger.rb

@@ -2,10 +2,20 @@ module ElmInstall
   # This is a helper module for logging.
   module Logger
     # :nocov:
+    # Logs the given message prefixed a green dot.
+    #
+    # @param message [String] The message to log
+    #
+    # @return [void]
     def self.dot(message)
       puts '  ● '.green + message
     end
 
+    # Logs the given message prefixed an arrow.
+    #
+    # @param message [String] The message to log
+    #
+    # @return [void]
     def self.arrow(message)
       puts "  ▶ #{message}"
     end

data/lib/elm_install/populator.rb

@@ -1,10 +1,18 @@
 module ElmInstall
   # This class is responsible for populating the `elm-stuff` directory.
   class Populator
+    # Initializes a new populator.
+    #
+    # @param git_resolver [GitResolver] The git resolver to use.
     def initialize(git_resolver)
       @git_resolver = git_resolver
     end
 
+    # Populates `elm-stuff` from the given solution.
+    #
+    # @param solution [Hash] The solution.
+    #
+    # @return [void]
     def populate(solution)
       solution.each do |package, version|
         resolve_package package, version
@@ -17,22 +25,13 @@ module ElmInstall
     # directory.
     #
     # :reek:TooManyStatements { max_statements: 9 }
+    #
+    # @param package [String] The package
+    # @param version_str [String] The resolved version
+    #
+    # @return [void]
     def resolve_package(package, version_str)
-      match = version_str.match /(.+)\+(.+)/
-
-      version =
-        if match
-          match[1]
-        else
-          version_str
-        end
-
-      ref =
-        if match
-          match[2]
-        else
-          version_str
-        end
+      version, ref = self.class.version_and_ref(version_str)
 
       package_name, package_path = Utils.package_version_path package, version
 
@@ -46,6 +45,11 @@ module ElmInstall
     end
 
     # Copies the given package from it's repository to the given path.
+    #
+    # @param package [String] The package to copy
+    # @param package_path [String] The destination
+    #
+    # @return [void]
     def copy_package(package, package_path)
       repository_path = File.join(@git_resolver.repository_path(package), '.')
 
@@ -55,6 +59,10 @@ module ElmInstall
     end
 
     # Writes the `elm-stuff/exact-dependencies.json` file.
+    #
+    # @param solution [Hash] The solution
+    #
+    # @return [void]
     def write_exact_dependencies(solution)
       File.binwrite(
         File.join('elm-stuff', 'exact-dependencies.json'),
@@ -63,19 +71,30 @@ module ElmInstall
     end
 
     # Returns the exact dependencies from the solution.
+    #
+    # @param solution [Hash] The solution
+    #
+    # @return [void]
     def self.exact_dependencies(solution)
       solution.each_with_object({}) do |(key, value), memo|
-        match = value.match /(.+)\+(.+)/
-
-        version =
-          if match
-            match[1]
-          else
-            value
-          end
+        version, = version_and_ref value
 
         memo[GitCloneUrl.parse(key).path.sub(%r{^/}, '')] = version
       end
     end
+
+    # Retruns the version and the ref from the given string.
+    #
+    # @param value [String] The input
+    #
+    # @return [Array] The version and the ref as an array
+    def self.version_and_ref(value)
+      match = value.match(/(.+)\+(.+)/)
+
+      version = match ? match[1] : value
+      ref = match ? match[2] : value
+
+      [version, ref]
+    end
   end
 end

data/lib/elm_install/resolver.rb

@@ -4,9 +4,13 @@ require_relative './utils'
 module ElmInstall
   # Resolves git dependencies into the cache.
   class Resolver
+    # @return [Array] The constraints
     attr_reader :constraints
 
-    # Initializes a resolver for a chace.
+    # Initializes a resolver with a chace and git resolver.
+    #
+    # @param cache [Cache] The cache
+    # @param git_resolver [GitResolver] The git resolver
     def initialize(cache, git_resolver)
       @git_resolver = git_resolver
       @constraints = []
@@ -14,6 +18,10 @@ module ElmInstall
     end
 
     # Add constraints, usually from the `elm-package.json`.
+    #
+    # @param constraints [Hash] The constraints
+    #
+    # @return [void]
     def add_constraints(constraints)
       @constraints = add_dependencies(constraints) do |package, constraint|
         [package, constraint]
@@ -23,7 +31,11 @@ module ElmInstall
     # Adds dependencies, usually from any `elm-package.json` file.
     #
     # :reek:NestedIterators { max_allowed_nesting: 2 }
-    # :reek:TooManyStatements { max_statements: 6 }
+    #
+    # @param dependencies [Hash] The dependencies
+    #
+    # @yieldreturn [Array] A constraint
+    # @return [void]
     def add_dependencies(dependencies)
       dependencies.flat_map do |package, constraint|
         add_package(package)
@@ -38,15 +50,17 @@ module ElmInstall
     end
 
     # Adds a dependency by git reference.
+    #
+    # @param package [String] The package
+    # @param ref [String] The reference
+    #
+    # @return [void]
     def add_ref_dependency(package, ref)
       @git_resolver.repository(package).checkout(ref)
       pkg_version = elm_package(package)['version']
       version = "#{pkg_version}+#{ref}"
       @cache.ensure_version(package, version)
-      add_dependencies(elm_dependencies(package)) do |dep_package, constraint|
-        add_package(dep_package)
-        @cache.dependency(package, version, [dep_package, constraint])
-      end
+      add_package_dependencies(package, version)
       [[package, "= #{version}"]]
     end
 
@@ -55,6 +69,10 @@ module ElmInstall
     # * Getting all the tags and adding the valid ones to the cache
     # * Checking out and getting the `elm-package.json` for each version
     #   and adding them recursivly
+    #
+    # @param package [String] The package
+    #
+    # @return [void]
     def add_package(package)
       return if @git_resolver.package?(package) && @cache.key?(package)
 
@@ -68,29 +86,58 @@ module ElmInstall
         end
     end
 
+    # Adds a package's dependencies to the cache.
+    #
+    # @param package [String] The package
+    # @param version [String] The version
+    #
+    # @return [void]
+    def add_package_dependencies(package, version)
+      add_dependencies(elm_dependencies(package)) do |dep_package, constraint|
+        add_package(dep_package)
+        @cache.dependency(package, version, [dep_package, constraint])
+      end
+    end
+
     # Adds a version and it's dependencies to the cache.
+    #
+    # @param package [String] The package
+    # @param version [String] The version
+    #
+    # @return [void]
     def add_version(package, version)
       @git_resolver
         .repository(package)
         .checkout(version)
 
-      add_dependencies(elm_dependencies(package)) do |dep_package, constraint|
-        add_package(dep_package)
-        @cache.dependency(package, version, [dep_package, constraint])
-      end
+      add_package_dependencies(package, version)
     end
 
     # Gets the `elm-package.json` for a package.
+    #
+    # @param package [String] The package
+    #
+    # @return [Hash] The dependencies
     def elm_dependencies(package)
       ElmPackage.dependencies elm_package_path(package)
     rescue
-      []
+      {}
     end
 
+    # Retruns the contents of the `elm-pacakge.json` of the given package.
+    #
+    # @param package [String] The package
+    #
+    # @return [Hash] The contents
     def elm_package(package)
       ElmPackage.read elm_package_path(package)
     end
 
+    # Retruns the path of the `elm-pacakge.json` of the given package.
+    #
+    # @param package [String] The package
+    #
+    # @return [String] The path
     def elm_package_path(package)
       File.join(@git_resolver.repository_path(package), 'elm-package.json')
     end

data/lib/elm_install/utils.rb

@@ -3,6 +3,7 @@ module ElmInstall
   module Utils
     module_function
 
+    # Regexes for converting constraints.
     CONVERTERS = {
       /v<(?!=)(.*)/ => '<',
       /(.*)<=v/ => '>=',
@@ -10,6 +11,11 @@ module ElmInstall
       /(.*)<v/ => '>'
     }.freeze
 
+    # Transform constraints form Elm's package format to semver's.
+    #
+    # @param constraint [String] The input constraint
+    #
+    # @return [Array] The output constraints
     def transform_constraint(constraint)
       constraint.gsub!(/\s/, '')
 
@@ -19,6 +25,12 @@ module ElmInstall
       end.compact
     end
 
+    # Returns the path for a package with the given version.
+    #
+    # @param package [String] The package
+    # @param version [String] The version
+    #
+    # @return [Strin] The path
     def package_version_path(package, version)
       package_name = GitCloneUrl.parse(package).path.sub(%r{^/}, '')
       [package_name, File.join('elm-stuff', 'packages', package_name, version)]

data/lib/elm_install/version.rb

@@ -1,3 +1,4 @@
 module ElmInstall
-  VERSION = '0.1.2'.freeze
+  # The version of ElmInstall
+  VERSION = '0.1.3'.freeze
 end

data/packaging/Gemfile.lock

@@ -3,11 +3,12 @@ GEM
   specs:
     commander (4.4.2)
       highline (~> 1.7.2)
-    elm_install (0.1.1)
+    elm_install (0.1.2)
       commander (~> 4.4, >= 4.4.2)
       git (~> 1.3)
       git_clone_url (~> 2.0)
       hashdiff (~> 0.3.1)
+      indentation (~> 0.1.1)
       smart_colored (~> 1.1, >= 1.1.1)
       solve (~> 3.1)
     git (1.3.0)
@@ -15,6 +16,7 @@ GEM
       uri-ssh_git (>= 2.0)
     hashdiff (0.3.1)
     highline (1.7.8)
+    indentation (0.1.1)
     molinillo (0.5.4)
     semverse (2.0.0)
     smart_colored (1.1.1)
@@ -33,4 +35,4 @@ RUBY VERSION
    ruby 2.2.2p95
 
 BUNDLED WITH
-   1.13.6
+   1.13.7

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elm_install
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Gusztáv Szikszai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -188,3 +188,4 @@ signing_key:
 specification_version: 4
 summary: Install Elm packages from git repositories.
 test_files: []
+has_rdoc: