Merge pull request #6 from glennsarti/prep-0.2.0

(maint) Prepare for 0.2.0 release

CHANGELOG.md

@@ -6,27 +6,33 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## Unreleased
 
-## 0.1.0 - 2020-04-03
+## 0.2.0 - 2020-03-20
 
 ### Added
 
-- ([GH-6](https://github.com/lingua-pupuli/puppetfile-resolver/pull/7)) Add magic comments for Puppetfile parser
+- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/6f267240b387d8399c5821415243c2ab426446f2)) Add flag to ignore :latest validation errors
+
+## 0.1.0 - 2020-03-04
+
+### Added
+
+- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/67678ff4d5b52f5afabe6c141167fc10e582f86e)) Add magic comments for Puppetfile parser
 
 ## 0.0.3 - 2019-11-25
 
 ### Fixed
 
-- ([GH-2](https://github.com/lingua-pupuli/puppetfile-resolver/issues/2)) OpenSSL errors cause resolution to fail
+- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/0793b9e4fa0acefd6c52aff7fb170c96b09a0311)) OpenSSL errors cause resolution to fail
 
 ## 0.0.2 - 2019-11-21
 
 ### Added
 
-- ([Commit](https://github.com/lingua-pupuli/puppetfile-resolver/commit/522a22a7d7715822212704807486b8954ee64ce3)) Added support for Ruby 2.1.9
+- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/522a22a7d7715822212704807486b8954ee64ce3)) Added support for Ruby 2.1.9
 
 ### Fixed
 
-- ([Commit](https://github.com/lingua-pupuli/puppetfile-resolver/commit/5bd5253873e012c6a4d0b4474a3a90c8feaaeafc)) Use plain version range
+- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/5bd5253873e012c6a4d0b4474a3a90c8feaaeafc)) Use plain version range
 
 ## 0.0.1 - 2019-11-04
 

RELEASE_PROCES.md

@@ -0,0 +1,46 @@
+# An overview on how to release the puppetfile-resolver gem
+
+1. Generate and merge a release prep
+
+    * Move the Unreleased parts of the changelog to the released section
+
+    * Modify `lib/puppetfile-resolver/version.rb` with the new version number
+
+    * Update the YARD Reference documentation using `bundle exec rake generate:docs`
+
+    * Update the SSL Certs File using `bundle exec rake ssl:vendor_ca_certs`
+
+2. Once merged, get the commit id of the preparation
+
+3. Tag the commit
+
+    `git tag -a '<version>' -m '<version>' <commit id>`
+
+    For example;
+    `git tag -a '0.11.0' -m '0.11.0' 8766a5dd5e476bb10c164962e8d9185810e96a17`
+
+4. Push the commit
+
+    `git push <remote> <version>`
+
+    For example;
+    `git push upstream 0.11.0`
+
+5. Checkout and reset the repo for the new tag
+
+    For example;
+
+    ``` text
+    > git checkout 0.11.0
+    > git reset --hard 0.11.0
+    ```
+
+6. Build the artefacts
+
+    `gem build puppetfile-resolver`
+
+7. Upload the artefacts to ruby gems
+
+    ``` text
+    > git push puppetfile-resolver-0.11.0.gem
+    ```

docs/reference/PuppetfileResolver.html

@@ -119,7 +119,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:29 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Cache.html

@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:29 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Cache/Base.html

@@ -433,7 +433,7 @@ <h3 class="signature " id="save-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Cache/Persistent.html

@@ -422,7 +422,7 @@ <h3 class="signature " id="persist-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Models.html

@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:29 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Models/MissingModuleSpecification.html

@@ -375,7 +375,7 @@ <h3 class="signature " id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Models/ModuleDependency.html

@@ -589,7 +589,7 @@ <h3 class="signature " id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Models/ModuleSpecification.html

@@ -957,7 +957,7 @@ <h3 class="signature " id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Models/PuppetDependency.html

@@ -479,7 +479,7 @@ <h3 class="signature " id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Models/PuppetSpecification.html

@@ -455,7 +455,7 @@ <h3 class="signature " id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Models/PuppetfileDependency.html

@@ -291,7 +291,7 @@ <h3 class="signature first" id="puppetfile_module-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile.html

@@ -112,7 +112,8 @@ <h2>
     <p>Resolver Flags</p>
 
 <p>DISABLE_PUPPET_DEPENDENCY_FLAG - Instructs the resolver to not consider Puppet version in its dependency traversal. Useful for modules with outdated metadata.json information.
-DISABLE_ALL_DEPENDENCIES_FLAG - Instructs the resolver to ignore any dependencies in its dependency traversal. Useful for modules with outdated metadata.json information.</p>
+DISABLE_ALL_DEPENDENCIES_FLAG - Instructs the resolver to ignore any dependencies in its dependency traversal. Useful for modules with outdated metadata.json information.
+DISABLE_LATEST_VALIDATION_FLAG - Instructs the resolution validator to ignore modules that have a version of :latest</p>
 
 
   </div>
@@ -129,6 +130,11 @@ <h2>
         </dt>
         <dd><pre class="code"><span class='symbol'>:disable_all_dependencies</span></pre></dd>
 
+        <dt id="DISABLE_LATEST_VALIDATION_FLAG-constant" class="">DISABLE_LATEST_VALIDATION_FLAG =
+
+        </dt>
+        <dd><pre class="code"><span class='symbol'>:disable_latest_validation</span></pre></dd>
+
         <dt id="FORGE_MODULE-constant" class="">FORGE_MODULE =
 
         </dt>
@@ -168,7 +174,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:29 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/BaseModule.html

@@ -774,7 +774,7 @@ <h3 class="signature first" id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/Document.html

@@ -672,7 +672,8 @@ <h3 class="signature " id="resolution_validation_errors-instance_method">
 119
 120
 121
-122</pre>
+122
+123</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/puppetfile-resolver/puppetfile/document.rb', line 69</span>
@@ -686,6 +687,7 @@ <h3 class="signature " id="resolution_validation_errors-instance_method">
     <span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_mod'>mod</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='op'>==</span> <span class='symbol'>:latest</span>
     <span class='id identifier rubyid_resolved_module'>resolved_module</span> <span class='op'>=</span> <span class='id identifier rubyid_resolution_result'>resolution_result</span><span class='period'>.</span><span class='id identifier rubyid_specifications'>specifications</span><span class='lbracket'>[</span><span class='id identifier rubyid_mod'>mod</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>
     <span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_resolved_module'>resolved_module</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_resolved_module'>resolved_module</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../PuppetfileResolver.html" title="PuppetfileResolver (module)">PuppetfileResolver</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="PuppetfileResolver::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/MissingModuleSpecification.html" title="PuppetfileResolver::Models::MissingModuleSpecification (class)">MissingModuleSpecification</a></span></span><span class='rparen'>)</span>
+    <span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_mod'>mod</span><span class='period'>.</span><span class='id identifier rubyid_resolver_flags'>resolver_flags</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../PuppetfileResolver.html" title="PuppetfileResolver (module)">PuppetfileResolver</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Puppetfile.html" title="PuppetfileResolver::Puppetfile (module)">Puppetfile</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Puppetfile.html#DISABLE_LATEST_VALIDATION_FLAG-constant" title="PuppetfileResolver::Puppetfile::DISABLE_LATEST_VALIDATION_FLAG (constant)">DISABLE_LATEST_VALIDATION_FLAG</a></span></span><span class='rparen'>)</span>
     <span class='ivar'>@validation_errors</span> <span class='op'>&lt;&lt;</span> <span class='const'><span class='object_link'><a href="DocumentLatestVersionError.html" title="PuppetfileResolver::Puppetfile::DocumentLatestVersionError (class)">DocumentLatestVersionError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DocumentResolutionErrorBase.html#initialize-instance_method" title="PuppetfileResolver::Puppetfile::DocumentResolutionErrorBase#initialize (method)">new</a></span></span><span class='lparen'>(</span>
       <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Latest version of </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_mod'>mod</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'> is </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resolved_module'>resolved_module</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
       <span class='id identifier rubyid_mod'>mod</span><span class='comma'>,</span>
@@ -901,7 +903,7 @@ <h3 class="signature " id="validation_errors-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentCircularDependencyError.html

@@ -269,7 +269,7 @@ <h3 class="signature first" id="puppetfile_modules-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentDuplicateModuleError.html

@@ -289,7 +289,7 @@ <h3 class="signature first" id="duplicates-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentInvalidModuleError.html

@@ -145,7 +145,7 @@ <h2>Constructor Details</h2>
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentLatestVersionError.html

@@ -153,7 +153,7 @@ <h2>Constructor Details</h2>
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentLocation.html

@@ -393,7 +393,7 @@ <h3 class="signature " id="start_line-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentMissingDependenciesError.html

@@ -302,7 +302,7 @@ <h3 class="signature first" id="missing_specifications-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentMissingModuleError.html

@@ -153,7 +153,7 @@ <h2>Constructor Details</h2>
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentResolutionErrorBase.html

@@ -372,7 +372,7 @@ <h3 class="signature " id="puppet_module-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentResolveError.html

@@ -290,7 +290,7 @@ <h3 class="signature first" id="molinillo_error-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentValidationErrorBase.html

@@ -401,7 +401,7 @@ <h3 class="signature first" id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/DocumentVersionConflictError.html

@@ -295,7 +295,7 @@ <h3 class="signature first" id="puppetfile_modules-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/ForgeModule.html

@@ -211,7 +211,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/GitModule.html

@@ -493,7 +493,7 @@ <h3 class="signature " id="tag-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/InvalidModule.html

@@ -289,7 +289,7 @@ <h3 class="signature first" id="reason-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/LocalModule.html

@@ -211,7 +211,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:30 2020 by
+  Generated on Fri Mar 20 14:31:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>

docs/reference/PuppetfileResolver/Puppetfile/Parser.html

@@ -109,7 +109,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  9 16:30:29 2020 by
+  Generated on Fri Mar 20 14:31:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.5.1).
 </div>