derelict_m 0.6.2a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f616bfcc287eb2dc4f4ffc83de0657e74b85106a
+  data.tar.gz: e0552d84cc985a3035b5bfa15c7a4c80dfa33d07
+SHA512:
+  metadata.gz: cc253a60c1642bbd4c55266f7be0449a0e39a82d0705fb0f8337c952441def545d6630147bc454be1ddc747fa06e259f5345c5b17a69fc6329625f29a48cb64e
+  data.tar.gz: '08756930ef5fd118c404160a9f67001ef7bd46413d32d46c721edea37a1938b91508ff2a2a3178f67358b11f9a2248b507cb84f44f83c6e6c99bffc8ab112141'

data/.cane

@@ -0,0 +1,2 @@
+--style-exclude spec/**/*.rb
+--gte coverage/.last_run.json,100

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+/.bundle/
+/.config/
+/.yardoc/
+/Gemfile.lock
+InstalledFiles
+_yardoc
+/coverage/
+/doc/
+/lib/bundler/man/
+/pkg/
+/rdoc/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/vendor/

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+before_install:
+  - gem update --system 2.1.11
+  - gem --version
+deploy:
+  provider: rubygems
+  api_key:
+    secure: lm8VbzXJIylbk3bHC5KBU7x0zI5zDHgOaYUkrc4z8R2gjdW9RLAoX8dwJ0N2FEX24zMf3s1fPT4dg70YD2S7FnVy3zan25BP2C2FKGkQ5kqRzV+gJCSD0Hwk8Yj5Breh1RF3xutV12asLq/+rltei7Fu6BnE2pQDk9/gGSCxILs=
+  gem: derelict
+  on:
+    repo: bradfeehan/derelict
+    ruby: 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in derelict.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brad Feehan
+
+MIT License
+
+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,99 @@
+# Derelict
+
+[![Gem Version](https://badge.fury.io/rb/derelict.png)](http://badge.fury.io/rb/derelict)
+[![Build Status](https://travis-ci.org/bradfeehan/derelict.png?branch=master)](https://travis-ci.org/bradfeehan/derelict)
+[![Coverage Status](https://coveralls.io/repos/bradfeehan/derelict/badge.png)](https://coveralls.io/r/bradfeehan/derelict)
+[![Code Climate](https://codeclimate.com/github/bradfeehan/derelict.png)](https://codeclimate.com/github/bradfeehan/derelict)
+[![Dependency Status](https://gemnasium.com/bradfeehan/derelict.png)](https://gemnasium.com/bradfeehan/derelict)
+
+Provides a Ruby API to control [Vagrant][1] where Vagrant is installed
+via the Installer package on Mac OS X.
+
+Currently a work-in-progress.
+
+[1]: <https://www.vagrantup.com>
+
+
+## Why?
+
+Vagrant was historically available as a [gem][2], naturally providing a
+Ruby API to control Vagrant in other Ruby libraries and applications.
+However, [since version 1.1.0][3], [Vagrant is distributed exclusively
+using an Installer package][4]. Derelict is a Ruby library that wraps
+the Vagrant binary, shelling out and parsing the results of each
+command.
+
+[2]: <https://rubygems.org>
+[3]: <https://groups.google.com/forum/#!msg/vagrant-up/kX_wvn7wcds/luwNur4kgDEJ>
+[4]: <http://mitchellh.com/abandoning-rubygems>
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "derelict"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install derelict
+
+
+## Usage
+
+Some examples of common operations using Derelict:
+
+```ruby
+require "derelict"
+
+# Determine if there's a "default" VM defined in /path/to/project
+Derelict.instance.connect("/path/to/project").vm(:default).exists?
+```
+
+### Advanced
+
+```ruby
+require "derelict"
+
+# Create an instance (represents a Vagrant installation)
+instance = Derelict.instance("/path/to/vagrant")
+instance = Derelict.instance # Defaults to /Applications/Vagrant
+
+# Issue commands to the instance directly (not usually necessary)
+result = instance.execute('--version') # Derelict::Executer object
+print "success" if result.success?     # if Vagrant's exit status was 0
+print result.stdout                    # "Vagrant 1.3.3\n"
+print result.status                    # 0
+
+# Connect to a Vagrant project (containing a Vagrantfile)
+connection = instance.connect("/path/to/project")
+
+# Issue commands to the connection directly (runs from the project dir)
+result = connection.execute(:up) # runs "vagrant up" in project dir
+result.success?                  # Derelict::Executer object again
+
+# Retrieve a particular VM from a connection (multi-machine support)
+vm = connection.vm(:web) # "vm" is a Derelict::VirtualMachine
+vm.exists?               # does the connection define a "web" VM?
+vm.state                 # current VM state (:running, :not_created...)
+vm.running?              # whether the VM is currently running or not
+vm.up!                   # runs "vagrant up" for this VM only
+vm.halt!                 # runs "vagrant halt" for this VM only
+vm.destroy!              # runs "vagrant destroy --force" for this VM
+vm.reload!               # runs "vagrant reload" for this VM only
+vm.suspend!              # runs "vagrant suspend" for this VM only
+vm.resume!               # runs "vagrant resume" for this VM only
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+# Define "spec" task using RSpec's built-in Rake task
+RSpec::Core::RakeTask.new :spec do |spec|
+  spec.verbose = false
+end
+
+version_major = RbConfig::CONFIG["MAJOR"].to_i
+version_minor = RbConfig::CONFIG["MINOR"].to_i
+if version_major >= 2 or (version_major == 1 and version_minor >= 9)
+  require "cane/rake_task"
+
+  # Define "quality" task using Cane's built-in Rake task
+  Cane::RakeTask.new :quality do |quality|
+    quality.canefile = File.join File.dirname(__FILE__), ".cane"
+  end
+
+  task :default => [:spec, :quality]
+else
+  task :default => :spec
+end

data/derelict.gemspec

@@ -0,0 +1,63 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "derelict/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "derelict_m"
+  spec.version       = Derelict::VERSION
+  spec.authors       = ["Brad Feehan"]
+  spec.email         = ["git@bradfeehan.com"]
+  spec.description   = <<-END.strip.gsub(/ +/, " ").gsub(/^ /, "")
+    Provides a Ruby API to control Vagrant where Vagrant is         \
+    installed via the Installer package on Mac OS X.
+
+    Vagrant was historically available as a gem, naturally          \
+    providing a Ruby API to control Vagrant in other Ruby libraries \
+    and applications. However, since version 1.1.0, Vagrant is      \
+    distributed exclusively using an Installer package. To control  \
+    Vagrant when it's installed this way, other Ruby libraries and  \
+    applications typically need to invoke the Vagrant binary, which \
+    requires forking a new process and parsing its output using     \
+    string manipulation.
+  END
+
+  spec.summary       =
+    "Ruby API for Vagrant installed via Installer package on Mac OS X."
+  spec.homepage      = "https://github.com/bradfeehan/derelict"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "log4r", "~> 1.1.0", "!= 1.1.11"
+  spec.add_runtime_dependency "memoist"
+  spec.add_runtime_dependency "open4"
+
+
+  version_major = RbConfig::CONFIG["MAJOR"].to_i
+  version_minor = RbConfig::CONFIG["MINOR"].to_i
+  cane_supported = (version_major >= 2 or (version_major == 1 and version_minor >= 9))
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "cane" if cane_supported
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rake", "< 11.0"
+  spec.add_development_dependency "rspec", "< 3.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "its"
+  spec.add_development_dependency "mime-types", "<2.0" # for coveralls
+
+  # When running on Travis CI, any passing builds will be deployed
+  # (i.e. pushed to RubyGems). This changes the version number so that
+  # these deployments are marked as pre-release versions (which will
+  # occur if the version number has a letter in it, so we add
+  # "travis" followed by the job number to the version string).
+  # So version 1.2.3 will be marked as (e.g.) "1.2.4.travis.567".
+  if ENV["TRAVIS"]
+    build = ENV["TRAVIS_JOB_NUMBER"].split(".").first
+    spec.version = "#{spec.version.to_s.succ}.travis.#{build}"
+  end
+end

data/lib/derelict.rb

@@ -0,0 +1,74 @@
+require "derelict/version"
+require "log4r"
+require "memoist"
+require "open4"
+require "set"
+require "shellwords"
+
+Log4r::Logger["root"] # creates the level constants (INFO, etc).
+
+# Main module/entry point for Derelict
+module Derelict
+  autoload :Box,            "derelict/box"
+  autoload :Connection,     "derelict/connection"
+  autoload :Exception,      "derelict/exception"
+  autoload :Executer,       "derelict/executer"
+  autoload :Instance,       "derelict/instance"
+  autoload :Parser,         "derelict/parser"
+  autoload :Plugin,         "derelict/plugin"
+  autoload :Utils,          "derelict/utils"
+  autoload :VirtualMachine, "derelict/virtual_machine"
+
+  # Make functions accessible by Derelict.foo and private when included
+  module_function
+
+  # Include "logger" method to get a logger for this class
+  extend Utils::Logger
+
+  # Creates a new Derelict instance for a Vagrant installation
+  #
+  #   * path: The path to the Vagrant installation (optional, defaults
+  #           to Instance::DEFAULT_PATH)
+  def instance(path = Instance::DEFAULT_PATH)
+    logger.info "Creating and validating new instance for '#{path}'"
+    Instance.new(path).validate!
+  end
+
+  # Enables (or disables) Derelict's debug mode
+  #
+  # When in debug mode, Derelict will log to stderr. The debug level
+  # can be controlled as well (which affects the verbosity of the
+  # logging).
+  #
+  # Valid (symbol) keys for the options hash include:
+  #
+  #   * enabled: Whether debug mode should be enabled (defaults to true)
+  #   * level:   Allows setting a custom log level (defaults to INFO)
+  def debug!(options = {})
+    options = debug_options_defaults.merge options
+    logger.level = options[:enabled] ? options[:level] : Log4r::OFF
+
+    if options[:enabled]
+      logger.add stderr unless logger.outputters.include? stderr
+      logger.info "enabling debug mode"
+    else
+      logger.info "disabling debug mode"
+      logger.remove "stderr"
+    end
+
+    self
+  end
+
+  private
+    # Retrieves the default values for the options hash for #debug!
+    def self.debug_options_defaults
+      {
+        :enabled => true,
+        :level => Log4r::INFO,
+      }
+    end
+
+    def self.stderr
+      Log4r::Outputter.stderr
+    end
+end

data/lib/derelict/box.rb

@@ -0,0 +1,29 @@
+module Derelict
+  # Represents an individual Vagrant box for a particular provider
+  class Box
+    autoload :Manager,  "derelict/box/manager"
+    autoload :NotFound, "derelict/box/not_found"
+
+    attr_reader :name, :provider
+
+    # Initializes a box with a particular name and provider
+    #
+    #   * name:     The name of the box represented by this object
+    #   * provider: The provider of the box represented by this object
+    def initialize(name, provider)
+      @name = name
+      @provider = provider
+    end
+
+    # Ensure equivalent Boxes are equal to this one
+    def ==(other)
+      other.name == name and other.provider == provider
+    end
+    alias_method :eql?, :==
+
+    # Make equivalent Boxes hash to the same value
+    def hash
+      name.hash ^ provider.hash
+    end
+  end
+end

data/lib/derelict/box/manager.rb

@@ -0,0 +1,111 @@
+module Derelict
+  class Box
+    # A class that handles managing boxes for a Vagrant instance
+    class Manager
+      # Include "memoize" class method to memoize methods
+      extend Memoist
+
+      # Include "logger" method to get a logger for this class
+      include Utils::Logger
+
+      attr_reader :instance
+
+      # Initializes a Manager for use with a particular instance
+      #
+      #   * instance: The Derelict::Instance which will have its
+      #               boxes managed by this Manager
+      def initialize(instance)
+        @instance = instance
+        logger.debug "Successfully initialized #{description}"
+      end
+
+      # Retrieves the Set of currently installed boxes
+      def list
+        logger.info "Retrieving Vagrant box list for #{description}"
+        output = instance.execute!(:box, "list").stdout
+        Derelict::Parser::BoxList.new(output).boxes
+      end
+      memoize :list
+
+      # Determines whether a particular box is installed
+      #
+      #   * box_name: Name of the box to look for (as a string)
+      def present?(box_name, provider)
+        fetch(box_name, provider)
+        true
+      rescue Box::NotFound
+        false
+      end
+
+      # Adds a box from a file or URL
+      #
+      # The provider will be automatically determined from the box
+      # file's manifest.
+      #
+      #   * box_name: The name of the box to add (e.g. "precise64")
+      #   * source:   The URL or path to the box file
+      #   * options:  Hash of options. Valid keys:
+      #      * log:   Whether to log the output (optional, defaults to
+      #               false)
+      def add(box_name, source, options = {})
+        options = {:log => false}.merge(options)
+        logger.info <<-END.gsub(/ {10}|\n\Z/, '')
+          Adding box '#{box_name}' from '#{source}' using #{description}
+        END
+
+        command = [:box, "add", box_name, source]
+        command << "--force" if options[:force]
+
+        log_block = options[:log] ? shell_log_block : nil
+        instance.execute!(*command, &log_block).tap do
+          flush_cache # flush memoized method return values
+        end
+      end
+
+      # Removes an installed box for a particular provider
+      #
+      #   * box_name:    Name of the box to remove (e.g. "precise64")
+      #   * options:     Hash of options. Valid keys:
+      #      * log:      Whether to log the output (optional, defaults
+      #                  to false)
+      #      * provider: If specified, only the box for a particular
+      #                  provider is removed; otherwise (by default),
+      #                  the box is removed for all providers
+      def remove(box_name, options = {})
+        options = {:log => false, :provider => nil}.merge(options)
+
+        provider = options[:provider]
+        command = [:box, "remove", box_name]
+        command << provider unless provider.nil?
+
+        logger.info <<-END.gsub(/ {10}|\n\Z/, '')
+          Removing box '#{box_name}' for '#{provider}' using #{description}
+        END
+
+        log_block = options[:log] ? shell_log_block : nil
+        instance.execute!(*command, &log_block).tap do
+          flush_cache # flush memoized method return values
+        end
+      end
+
+      # Retrieves a box with a particular name
+      #
+      #   * box_name: Name of the box to look for (as a string)
+      def fetch(box_name, provider)
+        box = list.find do |box|
+          box.name == box_name && box.provider == provider
+        end
+
+        raise Box::NotFound.new box_name, provider if box.nil?
+        box
+      end
+
+      # Provides a description of this Connection
+      #
+      # Mainly used for log messages.
+      def description
+        "Derelict::Box::Manager for #{instance.description}"
+      end
+    end
+  end
+end