Module: ElmInstall

Defined in:
lib/elm_install.rb,
lib/elm_install/base.rb,
lib/elm_install/types.rb,
lib/elm_install/utils.rb,
lib/elm_install/logger.rb,
lib/elm_install/source.rb,
lib/elm_install/version.rb,
lib/elm_install/resolver.rb,
lib/elm_install/installer.rb,
lib/elm_install/populator.rb,
lib/elm_install/dependency.rb,
lib/elm_install/git_source.rb,
lib/elm_install/identifier.rb,
lib/elm_install/repository.rb,
lib/elm_install/directory_source.rb

Overview

The main module for the gem.

Defined Under Namespace

Modules: Logger, Utils Classes: Base, Dependency, DirectorySource, GitSource, Identifier, Installer, Populator, Repository, Resolver, Source

Constant Summary collapse

Branch =

Represents a branch

ADT do
  Just(ref: String) |
    Nothing()
end
Uri =

Represents an uri

ADT do
  Ssh(uri: URI::SshGit::Generic) do
    def to_s
      uri.to_s
    end
  end |

    Http(uri: URI::HTTP) do
      def to_s
        uri.to_s
      end
    end |

    Github(name: String) do
      def to_s
        "https://github.com/#{name}"
      end
    end
end
Type =

Represents a source type

ADT do
  Git(uri: Uri, branch: Branch) do
    def source
      @source ||= GitSource.new uri, branch
    end
  end |

    Directory(path: Pathname) do
      def source
        @source ||= DirectorySource.new path
      end
    end
end
VERSION =

The version of ElmInstall

'1.6.0'.freeze

Class Method Summary collapse

Class Method Details

.install(options = { verbose: false }) ⇒ void

This method returns an undefined value.

Starts an install with the given isntallation.

Parameters:

  • options (Hash) (defaults to: { verbose: false }) —

    The options



39
40
41
 
# File 'lib/elm_install.rb', line 39

def install(options = { verbose: false })
  Installer.new(options).install
end