elm_install 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0d18a4779273c1b3132102c5f4740f2ad0f755e
-  data.tar.gz: 978a7b2c7c6e8cef8ffe4de27d903990f1389d1d
+  metadata.gz: 135de9d0626d6405f8a3d794d61c61df46a82691
+  data.tar.gz: 7b19ca3f3f7ccdb6f08bcfc25173ffe6eacb5e4c
 SHA512:
-  metadata.gz: f7482bd87dc668e476194cb782fb03e202324cf4b9fa41fd543c9d22a6ef1768e08290d1e47ecb006ce0c2cd290b048b8641c0e951a5d392d064aeef8c6a0c73
-  data.tar.gz: 8cfd8e742406174371b9c17c4c3a4a5b5c28ea4ad07907ca8c1a9521eaf848f2eaf2074e60b80115895bea87b6a483b9d44b7ce868102d0969e9bcf2ddc22a94
+  metadata.gz: e2cec562fdb050f6d5094b734fd6a1bd9af060770ff4e6d8acbc63ac5bf7d5ba925084a8b52d42c4ca8498e1b87bae30959e474977837f97d0487b3311bc7224
+  data.tar.gz: 72c6dcbb7b493af368540289eb996e6ccd36239072b0aed5f090578b33d874858714ce7f366fb01e221088430717b9e2e081ccc3a6edf09cd6fe83c902dcd181

data/.reek

@@ -2,3 +2,7 @@ TooManyStatements:
   max_statements: 7
 InstanceVariableAssumption:
   enabled: false
+Attribute:
+  enabled: false
+FeatureEnvy:
+  enabled: false

data/.rspec

@@ -1 +1,2 @@
 --color
+--require spec_helper

data/.rubocop.yml

@@ -4,3 +4,7 @@ AllCops:
     - 'vendor/**/*'
 Style/FrozenStringLiteralComment:
   Enabled: False
+Metrics/MethodLength:
+  Enabled: False
+Metrics/AbcSize:
+  Enabled: False

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    elm_install (0.3.1)
+    elm_install (1.0.0)
+      adts (~> 0.1.2)
       commander (~> 4.4, >= 4.4.2)
+      contracts (~> 0.16.0)
       git (~> 1.3)
       git_clone_url (~> 2.0)
       hashdiff (~> 0.3.1)
@@ -13,8 +15,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.0)
+    addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
+    adts (0.1.2)
     ast (2.3.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
@@ -22,32 +25,33 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     codeclimate-engine-rb (0.4.0)
       virtus (~> 1.0)
-    codeclimate-test-reporter (1.0.3)
-      simplecov
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
     coderay (1.1.1)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    commander (4.4.2)
+    commander (4.4.3)
       highline (~> 1.7.2)
+    contracts (0.16.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     docile (1.1.5)
     equalizer (0.0.11)
     erubis (2.7.0)
-    flay (2.8.1)
+    flay (2.9.0)
       erubis (~> 2.7.0)
       path_expander (~> 1.0)
       ruby_parser (~> 3.0)
       sexp_processor (~> 4.0)
-    flog (4.4.0)
+    flog (4.6.1)
       path_expander (~> 1.0)
       ruby_parser (~> 3.1, > 3.1.0)
-      sexp_processor (~> 4.4)
+      sexp_processor (~> 4.8)
     git (1.3.0)
     git_clone_url (2.0.0)
       uri-ssh_git (>= 2.0)
-    hashdiff (0.3.1)
+    hashdiff (0.3.4)
     highline (1.7.8)
     ice_nine (0.11.2)
     inch (0.7.1)
@@ -56,12 +60,12 @@ GEM
       term-ansicolor
       yard (~> 0.8.7.5)
     indentation (0.1.1)
-    json (2.0.2)
+    json (2.1.0)
     launchy (2.4.3)
       addressable (~> 2.3)
     method_source (0.8.2)
-    molinillo (0.5.4)
-    parser (2.3.3.1)
+    molinillo (0.5.7)
+    parser (2.4.0.0)
       ast (~> 2.2)
     path_expander (1.0.1)
     powerpack (0.1.1)
@@ -69,12 +73,13 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    public_suffix (2.0.4)
-    rainbow (2.1.0)
+    public_suffix (2.0.5)
+    rainbow (2.2.2)
+      rake
     rake (12.0.0)
-    reek (4.5.3)
+    reek (4.6.2)
       codeclimate-engine-rb (~> 0.4.0)
-      parser (~> 2.3.1, >= 2.3.1.2)
+      parser (>= 2.4.0.0, < 2.5)
       rainbow (~> 2.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -96,19 +101,19 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
-    ruby_parser (3.8.3)
+    ruby_parser (3.9.0)
       sexp_processor (~> 4.1)
-    rubycritic (3.1.3)
+    rubycritic (3.2.0)
       flay (~> 2.8)
       flog (~> 4.4)
       launchy (= 2.4.3)
-      parser (= 2.3.3.1)
+      parser (= 2.4.0)
       rainbow (~> 2.1)
       reek (~> 4.4)
       ruby_parser (~> 3.8)
       virtus (~> 1.0)
     semverse (2.0.0)
-    sexp_processor (4.7.0)
+    sexp_processor (4.9.0)
     simplecov (0.12.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -120,11 +125,11 @@ GEM
       molinillo (>= 0.5)
       semverse (>= 1.1, < 3.0)
     sparkr (0.4.1)
-    term-ansicolor (1.4.0)
+    term-ansicolor (1.6.0)
       tins (~> 1.0)
-    thread_safe (0.3.5)
-    tins (1.13.0)
-    unicode-display_width (1.1.2)
+    thread_safe (0.3.6)
+    tins (1.13.2)
+    unicode-display_width (1.2.1)
     uri-ssh_git (2.0.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)

data/Rakefile

@@ -3,8 +3,8 @@ require 'bundler/setup'
 Bundler::GemHelper.install_tasks
 
 task :ci do
-  sh 'rspec'
   sh 'rubocop'
   sh 'rubycritic -m --no-browser -s 90 lib'
-  sh 'inch suggest lib --pedantic'
+  sh 'inch suggest lib'
+  sh 'rspec'
 end

data/Readme.md

@@ -7,10 +7,12 @@
 [![Inline docs](http://inch-ci.org/github/gdotdesign/elm-github-install.svg?branch=master)](http://inch-ci.org/github/gdotdesign/elm-github-install)
 [![Build Status](https://travis-ci.org/gdotdesign/elm-github-install.svg?branch=master)](https://travis-ci.org/gdotdesign/elm-github-install)
 
-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.
+This gem/npm-package allows you to install Elm packages **in a decentralized way from Git repositories**, this allows:
+* installing of **effect manager** and **native** packages
+* installing **forks of packages** for testing or unreleased features
+* using packages from **local directories**
+* installing **private packages** using private git repositories
+* installing packages **offline** (packages are cached)
 
 ## Installation
 
@@ -58,27 +60,39 @@ Resolving packages...
   ▶ Package: https://github.com/elm-lang/virtual-dom not found in cache, cloning...
   ▶ Package: https://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.3 (2.0.3)
+  ● elm-lang/core - https://github.com/elm-lang/core (5.1.1)
+  ● elm-lang/svg - https://github.com/elm-lang/svg (2.0.0)
+  ● elm-lang/dom - https://github.com/elm-lang/dom (1.1.1)
+  ● elm-lang/html - https://github.com/elm-lang/html (2.0.0)
+  ● elm-lang/virtual-dom - https://github.com/elm-lang/virtual-dom (2.0.4)
 Packages configured successfully!
 ```
 
 ## Advanced Usage
-Sources (urls for git repositories) can be defined in the `dependency-sources`
-field in `elm-package.json` for any package defined in 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 with
-other packages and with native code.
+Sources can be defined in the `dependency-sources` field in `elm-package.json`
+for any package defined in the `dependencies` field.
+
+The source can be defined as:
+* an URL pointing to a Git repository:
+  ```
+  "elm-lang/core": "git@github.com:someuser/core"
+  ```
+* a hash containing the URL and the reference (tag, commit hash, branch) to use:
+  ```
+  "gdotdesign/elm-install-test": {
+    "url": "gdotdesign@bitbucket.org:gdotdesign/elm-install-test",
+    "ref": "master"
+  }
+  ```
+* an absolute or relative path to the package in your hard drive:
+  ```
+  "elm-lang/dom": "../elm-lang/dom"
+  ```
 
-The source can be defined by a string (url) 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**.
+If a reference or a path is defined then the version in the `dependencies` field is
+ignored and the **version will be used from the `elm-package.json` at that source**.
 
+Examples:
 ```
   ...
   "dependencies": {
@@ -88,7 +102,8 @@ used from the `elm-package.json` at that reference**.
     "elm-lang/dom": "1.1.1 <= v < 2.0.0"
   },
   "dependency-sources": {
-    "elm-lang/core": "git@github.com:elm-lang/core",
+    "elm-lang/core": "git@github.com:someuser/core",
+    "elm-lang/dom": "../elm-lang/dom",
     "gdotdesign/elm-install-test": {
       "url": "gdotdesign@bitbucket.org:gdotdesign/elm-install-test",
       "ref": "master"
@@ -97,6 +112,56 @@ used from the `elm-package.json` at that reference**.
   ...
 ```
 
+### CLI
+Help for the `elm-install` command:
+```
+NAME:
+
+  elm-install
+
+DESCRIPTION:
+
+  Install Elm packages from Git repositories.
+
+COMMANDS:
+
+  help    Display global or [command] help documentation
+  install Install Elm packages from the elm-package.json file.
+
+GLOBAL OPTIONS:
+
+  -h, --help
+      Display help documentation
+
+  -v, --version
+      Display version information
+
+  -t, --trace
+      Display backtrace when an error occurs
+```
+
+Help for the `elm-install install` command.
+```
+NAME:
+
+  install
+
+SYNOPSIS:
+
+  elm-install install
+
+DESCRIPTION:
+
+  Install Elm packages from the elm-package.json file.
+
+OPTIONS:
+
+  --cache-directory STRING
+      Specifies where the cache is stored
+
+  --verbose
+```
+
 ## FAQ
 
 #### Do I need to use SSH keys?
@@ -115,6 +180,3 @@ The following protocols can be used:
 #### Can I install from private repositories?
 Yes private repositories are supported provided you have authentication
 (for example SSH keys).
-
-## How is it work exactly?
-You can read more about it [here](docs/How it works.md).

data/bin/elm-install

@@ -15,8 +15,11 @@ command :install do |c|
            'Specifies where the cache is stored'
   c.option '--verbose'
   c.action do |_args, options|
-    ElmInstall.install verbose: options.verbose,
-                       cache_directory: options.cache_directory
+    ElmInstall.install(
+      verbose: options.verbose,
+      cache_directory: options.cache_directory ||
+                       File.join(Dir.home, '.elm-install')
+    )
   end
 end
 

data/elm_install.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'smart_colored', '~> 1.1', '>= 1.1.1'
   s.add_dependency 'hashdiff', '~> 0.3.1'
   s.add_dependency 'indentation', '~> 0.1.1'
+  s.add_dependency 'contracts', '~> 0.16.0'
+  s.add_dependency 'adts', '~> 0.1.2'
 
   s.extra_rdoc_files = ['Readme.md']
 end

data/lib/elm_install.rb

@@ -3,12 +3,29 @@ require 'git_clone_url'
 require 'forwardable'
 require 'indentation'
 require 'fileutils'
+require 'contracts'
 require 'hashdiff'
-require 'solve'
 require 'json'
+require 'adts'
 require 'git'
 
+require 'solve/constraint'
+require 'solve'
+
 require_relative './elm_install/version'
+require_relative './elm_install/utils'
+require_relative './elm_install/logger'
+require_relative './elm_install/ext'
+require_relative './elm_install/base'
+require_relative './elm_install/types'
+require_relative './elm_install/source'
+require_relative './elm_install/directory_source'
+require_relative './elm_install/repository'
+require_relative './elm_install/git_source'
+require_relative './elm_install/dependency'
+require_relative './elm_install/identifier'
+require_relative './elm_install/resolver'
+require_relative './elm_install/populator'
 require_relative './elm_install/installer'
 
 # The main module for the gem.

data/lib/elm_install/base.rb

@@ -1,50 +1,7 @@
 module ElmInstall
-  # This class is the base for the Cache and GitResolver packages.
+  # Base class that contains contracts.
   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 = {}
-      load
-    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 path of the directory where the cache is stored.
-    #
-    # @return [String] The path
-    def directory
-      @options[:directory]
-    end
+    include Contracts::Core
+    include Contracts::Builtin
   end
 end

data/lib/elm_install/dependency.rb

@@ -0,0 +1,37 @@
+module ElmInstall
+  # Represents a dependency
+  class Dependency < Base
+    extend Forwardable
+
+    # @return [Array] The constraints for the dependency
+    attr_reader :constraints
+
+    # @overload version
+    #   @return [Semverse::Version] The version
+    # @overload version=(value)
+    #   Sets the version
+    #   @param [Semverse::Version] The version
+    attr_accessor :version
+
+    # @return [Source] The source to use for resolving (Git, Directory)
+    attr_reader :source
+
+    # @return [String] The name of the dependency
+    attr_reader :name
+
+    Contract String, Source, ArrayOf[Solve::Constraint] => Dependency
+    # Initializes a new dependency.
+    #
+    # @param constraints [Array<Solve::Constraint>] The contraints
+    # @param source [Source] The source
+    # @param name [String] The name
+    #
+    # @return [Dependency] The dependency instance
+    def initialize(name, source, constraints)
+      @constraints = constraints
+      @source = source
+      @name = name
+      self
+    end
+  end
+end