vagrant-auto_network 1.0.0.rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 497131d24f1670f54dd51b9264f9d896c6d5c299
-  data.tar.gz: acfdf515d2a0c57f6607b1d43029d290e99ce33c
+  metadata.gz: 72d0e15630b3b3850d0409ca564ea4c47734696e
+  data.tar.gz: d34b1e0afaf9fc015585eb9249ff8f9f66c2c288
 SHA512:
-  metadata.gz: ebb3a65b50265b98b07310e1a5ceab508acb57f2146bea4157d57f5562bdc4453176d89954c8b0dea0a20fb6817e52c8afbf2e6bcd1e329df0ec1931fe6a6fa7
-  data.tar.gz: b0df283881996781bcf2ad23fe7dfcca4259a3c10f7ac3e7022f5e304c8d4f521af6d9f9062e864b0b2d2a1d5c91421bfdb79072c28151780d1a3ada2565032e
+  metadata.gz: ec5a9d7f8ba9dfb6e2fbb7516295e0fee80d603e7c18506d17d26241c4a5ac41876d446a71b92a108344226b93a4527eb6f1d89a0cdc1e7ea6b7aaf542d6cc39
+  data.tar.gz: e1d119a3a2e652e4c11821a88b24fca41958e3b733bf4126bd6360912339abe05eeef19c2c7ae55a0c589d4d61ad0e94d466aa2464232b801a1a59259b393339

data/CHANGELOG

@@ -4,7 +4,7 @@ vagrant-auto_network
 1.0.0
 -----
 
-Unreleased
+2014-05-21
 
 This is a mostly-backwards compatible feature release.
 

data/lib/auto_network/action/base.rb

@@ -5,6 +5,8 @@ module AutoNetwork
   #
   # @abstract Subclass and override {#call} to implement a new AutoNetwork
   #   action.
+  #
+  # @since 1.0.0
   class Action::Base
     # Create a new action instance that is suitable for execution as part of
     # Vagrant middleware.

data/lib/auto_network/pool.rb

@@ -83,6 +83,8 @@ module AutoNetwork
     # @return [Hash{String=>String}] A hash containing the path to the
     #   directory containing the Vagrantfile that defined the machine and the
     #   machine name.
+    #
+    # @since 1.0.0
     def id_for(machine)
       {
         'path' => machine.env.root_path.to_s,

data/lib/auto_network/pool_manager.rb

@@ -16,6 +16,8 @@ module AutoNetwork
   # @see AutoNetwork::PoolStorage The object used to implement file-based
   #   persistance for this class.
   # @see AutoNetwork::Pool The objects managed by this class.
+  #
+  # @since 1.0.0
   class PoolManager
     # Create a new `PoolManager` instance with persistent storage.
     #
@@ -44,27 +46,30 @@ module AutoNetwork
       end
     end
 
-    # {include:AutoNetwork::Pool#request}
+    # (see AutoNetwork::Pool#request)
     #
-    # @see AutoNetwork::Pool#request
+    # @see AutoNetwork::Pool#request This method is a proxy for
+    #   AutoNetwork::Pool#request
     def request(machine)
       with_pool_for(machine) do |pool|
         pool.request(machine)
       end
     end
 
-    # {include:AutoNetwork::Pool#release}
+    # (see AutoNetwork::Pool#release)
     #
-    # @see AutoNetwork::Pool#release
+    # @see AutoNetwork::Pool#release This method is a proxy for
+    #   AutoNetwork::Pool#release
     def release(machine)
       with_pool_for(machine) do |pool|
         pool.release(machine)
       end
     end
 
-    # {include:AutoNetwork::Pool#address_for}
+    # (see AutoNetwork::Pool#address_for)
     #
-    # @see AutoNetwork::Pool#address_for
+    # @see AutoNetwork::Pool#address_for This method is a proxy for
+    #   AutoNetwork::Pool#address_for
     def address_for(machine)
       with_pool_for(machine, read_only=true) do |pool|
         pool.address_for(machine)

data/lib/auto_network/pool_storage.rb

@@ -3,12 +3,41 @@ require 'yaml/store'
 require 'auto_network/pool'
 
 module AutoNetwork
-  # This is a specialized subclass of `YAML::Store` that knows how to
-  # initialize and upgrade AutoNetwork Pool files.
+  # This is a specialized subclass of `YAML::Store` that manages data
+  # persistence for {AutoNetwork::PoolManager} instances.
   #
-  # @api private
+  # In addition to managing serialization, the `YAML::Store` parent class also
+  # provides facilities for synchronizing state across multiple Vagrant
+  # processes. This subclass adds functionality for handling upgrades when the
+  # AutoNetwork serialization format changes.
+  #
+  # Format history:
+  #
+  #   - **Version 1:** A single instance of {AutoNetwork::Pool} instance
+  #     serialized to YAML. Never formalized with a version number.
+  #
+  #   - **Version 2:** A hash containing a `poolfile_version` set to `2` and a
+  #     `pools` sub-hash with keys created from Vagrant provider names and
+  #     values of a single {AutoNetwork::Pool} instance serialized to YAML.
+  #
+  # @example Version 1
+  #   --- !ruby/object:AutoNetwork::Pool
+  #   # Single serialized AutoNetwork::Pool
+  #
+  # @example Version 2
+  #   ---
+  #   poolfile_version: 2
+  #   pools:
+  #     some_vagrant_provider_name: !ruby/object:AutoNetwork::Pool
+  #       # Single serialized AutoNetwork::Pool
+  #
+  # @since 1.0.0
   class PoolStorage < YAML::Store
+    # An integer indicating the current AutoNetwork serialization format.
     POOLFILE_VERSION = 2
+
+    # The data structure that {AutoNetwork::PoolManager} instances
+    # expect to be available in all pool files.
     POOLFILE_SKELETON =  {
       'poolfile_version' => POOLFILE_VERSION,
       'pools' => {},
@@ -17,6 +46,8 @@ module AutoNetwork
     # Creates a new pool file at a target location and fills it with default
     # data.
     #
+    # @see POOLFILE_SKELETON
+    #
     # @param path [String, Pathname] the location of the new pool file.
     # @return [void]
     def self.init(path)
@@ -29,8 +60,8 @@ module AutoNetwork
 
     private
 
-    # Override the method inherited from `YAML::Store`. All `PStore` object
-    # expect load to strictly return a `Hash`. This override allows us to
+    # Override the method inherited from `YAML::Store`. All `PStore` instances
+    # expect `load` to strictly return a `Hash`. This override allows us to
     # perform on-the-fly upgrading of data loaded from old pool files and
     # ensure the right structure is returned.
     #
@@ -51,12 +82,13 @@ module AutoNetwork
     # The loosely defined "version 1" of the pool file just serialized a single
     # {AutoNetwork::Pool} object. All AutoNetwork releases that used Version 1
     # files only supported the Vagrant VirtualBox provider, so we return a new
-    # Hash-based data structure that includes the old Pool.
+    # Hash-based data structure that assigns the old Pool to the `virtualbox`
+    # provider.
     #
     # @api private
     #
     # @param data [AutoNetwork::Pool] the old pool object.
-    # @return [Hash] a hash containing the old pool object.
+    # @return [Hash] a hash conforming to the current {POOLFILE_VERSION}.
     def upgrade_from_version_1!(data)
       {
         'poolfile_version' => POOLFILE_VERSION,

data/lib/auto_network/settings.rb

@@ -5,6 +5,8 @@ require 'vagrant/errors'
 module AutoNetwork
   # This module is used by AutoNetwork to store global state when running under
   # Vagrant. This module is mixed into the top-level AutoNetwork namespace.
+  #
+  # @since 1.0.0
   module Settings
 
     # An error class raised when an invalid value is assigned to a setting.

data/lib/auto_network/version.rb

@@ -1,3 +1,3 @@
 module AutoNetwork
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-auto_network
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0
 platform: ruby
 authors:
 - Adrien Thebo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -97,9 +97,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14