evm 0.6.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fa493d9fc81acf42d9f914f5c4c0d1aa8da81f4
-  data.tar.gz: 650bd1b8fb3cf9dba7166f8911b5613459445aa1
+  metadata.gz: c5392493424325795161d08251f378a299d56cc3
+  data.tar.gz: f604f55213ea59e47e5b22922a084ad60ae65566
 SHA512:
-  metadata.gz: 9d96037b4a1641442b4e6fdb0be51abe518d09640ee23c3bb3454b666585306f08fded1628c6f5dcf20c21ca35519ac7885f32fae9220fc31a8a3bc98b3e9390
-  data.tar.gz: 76abec058233b16059a2f5cf8cb2c5187d689152deeab732bab28abcf6b562b3edaa395d3dc46820fd1c3e3dc7f123f0cf35235f08e3f71bfde8389ed08caf32
+  metadata.gz: f0c77cbc74d367fddd3fc4e177090321633962f66312019f4ca3c7aba3c27234cbdcfb22b9113cbed735ba3973fac1621245e5933e5d2c2b4f617a332dd42c9d
+  data.tar.gz: 324f07d326f8326d907173dd48d229168c93d034133099f0514bc650e75ac49a2afa4f301f78dd6f2e92dfb7fb3ff6fbd92874443449c5d19ddc94eca097f598

data/README.md

@@ -0,0 +1,278 @@
+# Emacs Version Manager
+
+## Deprecation Warning!
+
+As Travis is moving towards a container-based infrastructure, hence
+sudo is not possible, EVM added support for Travis specific binaries
+(ends with `-travis`), which will be installed in `/tmp`.
+
+All `-bin` versions will are deprecated and will be removed. Do not use them!
+
+To run EVM on Travis, set the EVM path to `/tmp`:
+
+```bash
+$ evm config path /tmp
+```
+
+See https://gist.github.com/rejeep/ebcd57c3af83b049833b for more
+information on how to use EVM on Travis.
+
+## Why EVM?
+
+* Did you ever wonder how to install Emacs? Homebrew, apt-get, Emacs
+  for OSX, Compile from scratch, etc...
+
+* Are you currently maintaining an Emacs package? How do you know it
+  works? Because you have tests of course. Ok, so you know it works on
+  your platform and with your Emacs version. But what about all other
+  versions that people are using? Does your package work for them?
+
+* EVM provides pre compiled binaries to allow for quick installation
+  on CI systems.
+
+## Platform Support
+
+### OSX
+
+Supported!
+
+### GNU/Linux
+
+Supported!
+
+### Windows
+
+Not supported. Need help from someone running Windows.
+
+## Installation
+
+Default installation directory for EVM Emacs versions is
+`/usr/local/evm`. This can be changed with the `config` command:
+
+```sh
+$ evm config path /foo/bar
+```
+
+No matter what installation approach you choose, create the
+installation directory and give your user access rights, for example:
+
+```sh
+$ sudo mkdir /usr/local/evm
+$ sudo chown $USER: /usr/local/evm
+```
+
+### Automatic
+
+```sh
+$ curl -fsSkL https://raw.github.com/rejeep/evm/master/go | bash
+```
+
+Add EVM's `bin` directory to your `PATH`.
+
+```sh
+$ export PATH="$HOME/.evm/bin:$PATH"
+```
+
+### Homebrew
+
+_NOT ADDED YET_
+
+```sh
+$ brew install evm
+```
+
+### Ruby gem
+
+```sh
+$ gem install evm
+```
+
+### Manual
+
+```sh
+$ git clone https://github.com/rejeep/evm.git ~/.evm
+```
+
+Add EVM's `bin` directory to your `PATH`.
+
+```sh
+$ export PATH="$HOME/.evm/bin:$PATH"
+```
+
+## Usage
+
+In the Evm `bin` directory, there are a few commands:
+
+* `evm` - Manage Emacs packages
+* `emacs/evm-emacs` - Emacs shim with currently selected Emacs package
+
+### list
+
+To list all available Emacs versions you can install, run:
+
+```sh
+$ evm list
+```
+
+The output will look something like this:
+
+```
+emacs-23.4
+emacs-24.1 [I]
+emacs-24.2
+* emacs-24.3 [I]
+emacs-24.3-travis [I]
+...
+```
+
+The `[I]` shows what versions are currently installed and the `*`
+shows what version is currently selected.
+
+### install <name>
+
+To install a version, run:
+
+```sh
+$ evm install version
+```
+
+Example:
+
+```sh
+$ evm install emacs-24.3
+```
+
+### use <name>
+
+To start using a specific package, run:
+
+```sh
+$ evm use name
+```
+
+Example:
+
+```sh
+$ evm use emacs-24.2
+```
+
+The Evm binary will update and use that Emacs package.
+
+### disuse
+
+To stop using an EVM binary and restore your personal or system defaults:
+
+```sh
+$ evm disuse
+```
+
+### uninstall <name>
+
+To uninstall a version, run:
+
+```sh
+$ evm uninstall emacs-24.2
+```
+
+### bin [name]
+
+Prints the full path to `name`'s Emacs executable. If no name is
+specified, use currently selected.
+
+```sh
+$ evm bin # /usr/local/evm/emacs-24.5/Emacs.app/Contents/MacOS/Emacs
+$ evm bin emacs-24.2 # /usr/local/evm/emacs-24.2/Emacs.app/Contents/MacOS/Emacs
+```
+
+### help
+
+For more information, run:
+
+```sh
+$ evm --help
+```
+
+## Contribution
+
+Be sure to!
+
+Implement the features and don't forget to test it. Run the tests
+with:
+
+```sh
+$ rspec spec
+```
+
+If all passes, send us a
+[pull request](https://github.com/rejeep/evm/pulls) with the changes.
+
+### Adding a new Emacs version
+
+Copy an existing recipe in the [recipes](/recipes) directory and make
+modifications for the new version.  Also add the new version to the
+[Travis configuration](/.travis.yml).
+
+### Adding Travis binary
+
+If you want to contribute a Travis binary, these instructions will help.
+
+* Install [Vagrant](https://www.vagrantup.com/)
+
+* Install Vagrant SCP (https://github.com/invernizzi/vagrant-scp)
+
+* Clone https://github.com/travis-ci/travis-cookbooks
+
+* Enter `travis-cookbooks` and run `vagrant init hashicorp/precise64` then `vagrant up`
+
+* SSH into the VM: `$ vagrant ssh ID`
+
+* Install necessary tools
+
+```bash
+$ sudo apt-get install build-essential
+$ sudo apt-get install libncurses-dev
+$ sudo apt-get install autoconf
+$ sudo apt-get install automake
+$ sudo apt-get install autogen
+$ sudo apt-get install git
+$ sudo apt-get install texinfo
+$ sudo apt-get install libtool
+```
+
+* Download Emacs source
+
+```bash
+$ wget http://ftpmirror.gnu.org/emacs/emacs-MAJOR.MINOR.tar.gz
+```
+
+* Unzip it
+
+```bash
+$ tar -xvzf emacs-MAJOR-MINOR.tar.gz
+```
+
+* Compile and Install Emacs
+
+```bash
+$ ./autogen.sh # for snapshot
+$ ./configure --without-all --prefix=/tmp/emacs-MAJOR.MINOR-travis
+$ make bootstrap
+$ make install
+```
+
+* Tar it
+
+```bash
+$ cd /tmp
+$ tar -cvzf emacs-MAJOR.MINOR-travis.tar.gz emacs-MAJOR.MINOR-travis
+```
+
+* Copy from VM
+
+```bash
+$ vagrant scp ID:/tmp/emacs-MAJOR.MINOR-travis.tar.gz .
+```
+
+* Create a new recipe and make a pull request.
+
+* Ask maintainer to add a new release and add the binary.

data/bin/evm

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'evm'
+
+begin
+  Evm::Cli.parse(ARGV)
+rescue Evm::Exception => e
+  STDERR.puts e.message
+  exit 1
+end

data/lib/evm.rb

@@ -1,37 +1,17 @@
 require 'fileutils'
 
 module Evm
+  class Exception < StandardError; end
+
   ROOT_PATH = File.expand_path('..', File.dirname(__FILE__))
   LOCAL_PATH = File.join('/', 'usr', 'local', 'evm')
   EMACS_PATH = File.join(ROOT_PATH, 'bin', 'emacs')
   EVM_EMACS_PATH = File.join(ROOT_PATH, 'bin', 'evm-emacs')
+  CONFIG_FILE = File.join(ROOT_PATH, '.config')
+  CONFIG_TYPES = [:path]
 
-  def self.abort(*args)
-    STDERR.puts args.join(' ')
-
-    exit 1
-  end
-
-  def self.print_usage_and_exit
-    Evm.abort <<-EOS
-USAGE: evm COMMAND [OPTIONS]
-
-Emacs Version Manager
-
-COMMANDS:
- install <name>             Install package name
- uninstall <name>           Uninstall package name
- bin [name]                 Show path to Emacs binary for package name
- list                       List all available packages
- use <name>                 Select name as current package
- help                       Display this help message
-
-OPTIONS:
- --force                    Force install even when already installed
- --use                      Select as current package after installing
- --skip                     Ignore if already installed
- --help, -h                 Display this help message
-    EOS
+  def self.config
+    Evm::Config.new(CONFIG_FILE, path: LOCAL_PATH)
   end
 end
 
@@ -40,10 +20,9 @@ require 'evm/cli'
 require 'evm/recipe'
 require 'evm/package'
 require 'evm/command'
-require 'evm/exception'
 require 'evm/builder'
 require 'evm/tar_file'
 require 'evm/remote_file'
 require 'evm/system'
-require 'evm/progress_bar'
 require 'evm/git'
+require 'evm/config'

data/lib/evm/builder.rb

@@ -23,19 +23,12 @@ module Evm
         end
       end
 
-      def tar_gz(url)
-        tar_file_path = File.join(builds_path, @name + '.tar.gz')
-
-        remote_file = Evm::RemoteFile.new(url)
-        remote_file.download(tar_file_path) do |progress|
-          progress_bar.set(progress)
-        end
-        progress_bar.done
-
-        FileUtils.mkdir(build_path)
+      def tar_xz(url)
+        tar_packaged(url, 'xz')
+      end
 
-        tar_file = Evm::TarFile.new(tar_file_path)
-        tar_file.extract(builds_path, @name)
+      def tar_gz(url)
+        tar_packaged(url, 'gz')
       end
 
       def osx(&block)
@@ -68,7 +61,7 @@ module Evm
       end
 
       def builds_path
-        File.join(Evm::LOCAL_PATH, 'tmp')
+        File.join(Evm.config[:path], 'tmp')
       end
 
       def build_path
@@ -76,7 +69,7 @@ module Evm
       end
 
       def installations_path
-        Evm::LOCAL_PATH
+        Evm.config[:path]
       end
 
       def installation_path
@@ -88,13 +81,21 @@ module Evm
       end
 
       def copy(from, to)
-        FileUtils.cp_r(from, to)
+        run_command "cp -a #{from} #{to}"
       end
 
       private
 
-      def progress_bar
-        @progress_bar ||= Evm::ProgressBar.new
+      def tar_packaged(url,extension)
+        tar_file_path = File.join(builds_path, @name + '.tar.' + extension)
+
+        remote_file = Evm::RemoteFile.new(url)
+        remote_file.download(tar_file_path)
+
+        FileUtils.mkdir(build_path)
+
+        tar_file = Evm::TarFile.new(tar_file_path)
+        tar_file.extract(builds_path, @name)
       end
 
       def run_command(command, *args)

data/lib/evm/cli.rb

@@ -1,37 +1,62 @@
+require 'optparse'
+
 module Evm
   module Cli
     def self.parse(argv)
       options = {}
 
-      if argv.include?('--force')
-        options[:force] = !!argv.delete('--force')
-      end
+      optparse = OptionParser.new do |opts|
+        opts.banner += ' command'
 
-      if argv.include?('--skip')
-        options[:skip] = !!argv.delete('--skip')
-      end
+        opts.separator  ''
+        opts.separator  'Emacs Version Manager.'
+        opts.separator  ''
+        opts.separator  'Commands:'
+        opts.separator  '        install                      Install package name'
+        opts.separator  '        uninstall                    Uninstall package name'
+        opts.separator  '        bin [name]                   Show path to Emacs binary for package name'
+        opts.separator  '        list                         List all available packages'
+        opts.separator  '        use <name>                   Select name as current package'
+        opts.separator  '        disuse                       Stop using the current package (remove binary from path but leave installed)'
+        opts.separator  '        config <var> <value>         Set the value of a configuration variable (like path)'
+        opts.separator  '        help                         Display this help message'
+        opts.separator  ''
+        opts.separator  'Options:'
+
+        opts.on('--force', 'Force install even when already installed') do
+          options[:force] = true
+        end
+
+        opts.on('--skip', 'Ignore if already installed') do
+          options[:skip] = true
+        end
 
-      if argv.include?('--use')
-        options[:use] = !!argv.delete('--use')
+        opts.on('--use', 'Select as current package after installing') do
+          options[:use] = true
+        end
+
+        opts.on_tail('--help', '-h', 'Display this help message') do
+          puts opts
+          exit
+        end
       end
 
-      command, argument = argv
+      optparse.parse!(argv)
+
+      command = argv.shift
 
-      if argv.include?('--help') || argv.include?('-h') || command.nil?
-        Evm.print_usage_and_exit
+      if command == 'help' || !command
+        puts optparse
+        exit
       end
 
       begin
         const = Evm::Command.const_get(command.capitalize)
-      rescue NameError => exception
-        Evm.abort 'No such command:', command
+      rescue NameError
+        raise Evm::Exception, "No such command: #{command}"
       end
 
-      begin
-        const.new(argument, options)
-      rescue Evm::Exception => exception
-        Evm.abort exception.message
-      end
+      const.new(argv, options)
     end
   end
 end