puppetfiler 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6a40769b4aa2a0201e674c15b721130beaee9ac
-  data.tar.gz: 00733ee0f252f42cc63c17f81aeb5be2c590d006
+  metadata.gz: 0e2e5783e88c6066b2e029741e8246192c59216f
+  data.tar.gz: c6a19c79436262c91b7d263205de583b5eb5484b
 SHA512:
-  metadata.gz: 355e96a75fbafe5cbe0ac079f9fa6cb9ee28f34397f7888952a70edb0c896aa19aef773fbfeda207669abe6af177261716703e10257ac0e3482ca11b340a5bba
-  data.tar.gz: 0922e770b569f21c47ba227c78d78c511d09a4826daf0d3a17a2222f7867e59a9d89e32e978e385837e2d81fe8f2ae465c11444fa509bc31f27c3d177eab72ca
+  metadata.gz: 263b769794f7d8aadff453d04d11a92ab9eaeb7fb1a461fb9d64d83ddd8a8a4b326318adfd75ac8473b1e24279a2e902d19543e257002307702633beacfde14d
+  data.tar.gz: 49d3855d4009093d043fcdc74e7b3fe1a34f08b0450cd0e26d214db327e2690a7c7bca29006289a3c944d9924ed259d8a1ab52b1e23d76d9e51cc29225be164d

data/CHANGELOG.rst

@@ -0,0 +1,52 @@
+v0.1.5
+------
+
+Breaking changes
+~~~~~~~~~~~~~~~~
+- Puppetfile/metadata.json are now specified via flags instead of
+  passing them in.
+  If neither are passed puppetfiler checks for a Puppetfile first, then
+  for a metadata.json.
+  If neither are found puppetfiler fails.
+
+Changes
+~~~~~~~
+- The fixture method is now a module function with the following
+  signature ``fixture(forge_modules, repos, modifier)``, with
+  forge_modules being instances of ``Puppetfiler::Mod``
+
+  ``Puppetfiler::Puppetfile#fixture`` is still available.
+
+- Fixtures can now also be generated from metadata.json files
+
+
+v0.1.4
+------
+Bugfix release
+
+The output of the fixture() method did not include the top-level
+'fixtures' key.
+
+v0.1.3
+------
+
+Changes
+~~~~~~~
+
+- A hash can now be passed into the fixture() method, allowing to
+  modify the resulting hashes.
+  Primarily useful to pass additional proxy flags or to target in-house
+  mirrors
+
+v0.1.2
+------
+
+Changes
+~~~~~~~
+
+- Set mimimum ruby version to latest stable 2.1
+
+v0.1.1
+------
+
+Initial release

data/TODO

@@ -9,8 +9,8 @@
   environment, which'd favor matching against found metaparams below the
   current path
 
-* Building of .fixtures.yml for modules based on the metadata
-  I did something similar on my modulesync config[1], however having it
-  this way and called via a rake task might be favorable
+* Mock api calls in aruba tests
+  Not as easy as with rspec, see https://github.com/cucumber/aruba/issues/169
+  However using arubas in-process execution it is possible to use webmock to mock these calls.
 
-  [1]: https://github.com/ntnn/modulesync-cfg/blob/master/moduleroot/.fixtures.yml
+  It is quite ugly though: https://github.com/erikhuda/thor/wiki/Integrating-with-Aruba-In-Process-Runs

data/data/metadata_emptydeps.json

@@ -0,0 +1,12 @@
+{
+    "name": "example-module",
+    "version": "0.1.0",
+    "author": "Some Author",
+    "summary": "Examplary summary",
+    "license": "MIT",
+    "source": "https://github.com/ntnn/puppetfiler",
+    "project_page": "https://github.com/ntnn/puppetfiler",
+    "issues_url": "https://github.com/ntnn/puppetfiler/issues",
+    "dependencies": [
+    ]
+}

data/data/metadata_nodeps.json

@@ -0,0 +1,10 @@
+{
+    "name": "example-module",
+    "version": "0.1.0",
+    "author": "Some Author",
+    "summary": "Examplary summary",
+    "license": "MIT",
+    "source": "https://github.com/ntnn/puppetfiler",
+    "project_page": "https://github.com/ntnn/puppetfiler",
+    "issues_url": "https://github.com/ntnn/puppetfiler/issues"
+}

data/data/simple_metadata.json

@@ -0,0 +1,16 @@
+{
+    "name": "example-module",
+    "version": "0.1.0",
+    "author": "Some Author",
+    "summary": "Examplary summary",
+    "license": "MIT",
+    "source": "https://github.com/ntnn/puppetfiler",
+    "project_page": "https://github.com/ntnn/puppetfiler",
+    "issues_url": "https://github.com/ntnn/puppetfiler/issues",
+    "dependencies": [
+        {
+            "name": "puppetlabs/stdlib",
+            "version_requirement": ">= 4.13.0 < 5.0.0"
+        }
+    ]
+}

data/lib/puppetfiler/cli.rb

@@ -5,22 +5,56 @@ require 'puppetfiler/version'
 
 module Puppetfiler
     class CLI < Thor
-        desc 'check [puppetfile]', 'Check forge for newer versions of used forge modules'
-        def check(puppetfile = 'Puppetfile')
-            pf = Puppetfiler::Puppetfile.new(puppetfile)
-            format = "% -#{pf.maxlen_name}s  % -#{pf.maxlen_ver}s  %s"
+        class_option :puppetfile, {
+            :default => nil,
+            :desc    => 'Puppetfile to act on',
+            :aliases => ['p'],
+        }
+
+        class_option :metadata, {
+            :default => nil,
+            :desc    => 'metadata.json to act on',
+            :aliases => ['m'],
+        }
+
+        desc 'check', 'Check forge for newer versions of used forge modules'
+        def check()
+            target = target(options)
+
+            case target[:type]
+            when :puppetfile
+                t = Puppetfiler::Puppetfile.new(target[:result])
+            when :metadata
+                # TODO see below
+                fail 'Checking metadata.json for version range updates is not implemented yet'
+            else fail "Unkown type: #{target[:type]}"
+            end
+
+            format = "% -#{t.maxlen_name}s  % -#{t.maxlen_ver}s  %s"
 
             puts sprintf(format, 'module', 'current', 'newest')
 
-            pf.updates.each do |name, hash|
+            # TODO the updates should be collected asynchronously to
+            # speed up the process
+            t.updates.each do |name, hash|
                 puts sprintf(format, name, hash[:current], hash[:newest])
             end
         end
 
-        desc 'fixture [puppetfile]', 'Create puppetlabs_spec_helper compatible .fixtures.yml from puppetfile'
+        desc 'fixture', 'Create puppetlabs_spec_helper compatible .fixtures.yml from puppetfile or metadata.json'
         method_option :stdout, :aliases => '-o'
-        def fixture(puppetfile = 'Puppetfile')
-            f = Puppetfiler::Puppetfile.new(puppetfile).fixture.to_yaml
+        def fixture()
+            target = target(options)
+
+            case target[:type]
+            when :puppetfile
+                f = Puppetfiler::Puppetfile.new(target[:result])
+            when :metadata
+                f = Puppetfiler::Metadata.new(File.new(target[:result]))
+            else fail "Unkown type: #{target[:type]}"
+            end
+
+            f = f.fixture.to_yaml
 
             if options[:stdout]
                 puts f
@@ -33,5 +67,21 @@ module Puppetfiler
         def version
             puts "puppetfiler v#{Puppetfiler::VERSION}"
         end
+
+        private
+        def target(opts)
+            {
+                :puppetfile => 'Puppetfile',
+                :metadata   => 'metadata.json',
+            }.each do |sym, str|
+                if opts[sym]
+                    return { :result => opts[sym], :type => sym }
+                elsif File.exists?(str)
+                    return { :result => str, :type => sym }
+                end
+            end
+
+            fail 'No Puppetfile or metadata.json found, aborting'
+        end
     end
 end

data/lib/puppetfiler/metadata.rb

@@ -0,0 +1,37 @@
+require 'json'
+require 'puppetfiler/mod'
+require 'semantic_puppet'
+
+module Puppetfiler
+    class Metadata
+        attr :dependencies
+        attr :path
+        def initialize(target)
+            @dependencies = {}
+
+            parse target
+        end
+
+        def fixture(modifiers = {})
+            Puppetfiler.fixture(@dependencies, {}, modifiers)
+        end
+
+        def eql?(other)
+            @dependencies.eql?(other.dependencies)
+        end
+
+        private
+        def parse(target)
+            json = JSON.load(target)
+
+            if not json.has_key?('dependencies') or json['dependencies'].eql?([])
+                warn 'No dependencies found'
+                return nil
+            end
+
+            json['dependencies'].each do |hash|
+                @dependencies[hash['name']] = Puppetfiler::Mod.new(hash)
+            end
+        end
+    end
+end

data/lib/puppetfiler/mod.rb

@@ -3,10 +3,90 @@ require 'semantic_puppet'
 
 module Puppetfiler
     class Mod
-        def self.newest(name)
-            mod = PuppetForge::Module.find(name.gsub('/', '-'))
-            version = mod.current_release.version
-            return SemanticPuppet::Version.parse(version)
+        attr :name
+        attr :slug
+        attr :range
+
+        def initialize(*args)
+            require 'hashie'
+            args = Hashie.symbolize_keys(args[0])
+
+            raise "Names with dashes are disallowed: #{args[:name]}" if /-/.match(args[:name])
+
+            @name = args[:name]
+            @slug = @name.gsub('/', '-')
+
+            @forge = PuppetForge::Module.find(@slug)
+
+            @range = nil
+            [:range, 'range', 'version_requirement'].each do |v|
+                if args.has_key?(v)
+                    if not args[v].is_a?(SemanticPuppet::VersionRange)
+                        args[v] = SemanticPuppet::VersionRange.parse(args[v])
+                    end
+
+                    @range = args[v]
+                end
+            end
+
+            @version = nil
+            [:version, 'version'].each do |v|
+                @version = SemanticPuppet::Version.parse(args[v]) if args.has_key?(v)
+            end
+            @version = latest_valid if not @version
+        end
+
+        def eql?(other)
+            return false if not @name.eql?(other.name)
+
+            # range has to be checked first, sine version is a method
+            # returning at least latest
+            if @range
+                return false if not other.range
+                return true if @range.eql?(other.range)
+            end
+
+            return true if version.eql?(other.version)
+
+            return false
+        end
+
+        def version
+            return latest_valid if not @version
+
+            return @version
+        end
+
+        def latest
+            return SemanticPuppet::Version.parse(@forge.current_release.version)
+        end
+
+        def valid_versions
+            return [] if not @range
+
+            versions = []
+
+            @forge.releases.each do |release|
+                version = SemanticPuppet::Version.parse(release.version)
+                versions << version if @range.cover?(version)
+            end
+
+            return versions
+        end
+
+        def latest_valid
+            if not @range
+                return latest
+            end
+
+            return valid_versions[0]
+        end
+
+        def version_valid(version = @version)
+            return false if not @range
+
+            version = SemanticPuppet::Version.parse(version) if not version.is_a?(SemanticPuppet::Version)
+            return range.cover?(version)
         end
     end
 end

data/lib/puppetfiler/puppetfile.rb

@@ -1,4 +1,4 @@
-require 'puppetfiler/mod'
+require 'puppetfiler'
 
 module Puppetfiler
     class Puppetfile
@@ -25,6 +25,9 @@ module Puppetfiler
             end
 
             begin
+                # TODO similar to Metadata, allow IO objects like File,
+                # string or similar to be passed in instead of expecting
+                # a path
                 self.instance_eval(File.read(@puppetfile))
             rescue SyntaxError => error
                 STDERR.puts "Puppetfile at path '#{@puppetfile}' is invalid:"
@@ -40,9 +43,9 @@ module Puppetfiler
         def updates
             updates = {}
 
-            @modules.each do |name, version|
-                current = SemanticPuppet::Version.parse(version)
-                newest = Puppetfiler::Mod.newest(name)
+            @modules.each do |name, mod|
+                current = mod.version
+                newest = mod.latest
 
                 if not newest.eql?(current)
                     updates[name] = {
@@ -56,62 +59,7 @@ module Puppetfiler
         end
 
         def fixture(modifiers = {})
-            fixtures = {
-                'forge_modules' => {},
-                'repositories'  => {},
-            }
-
-            fixtures.each do |k, v|
-                modifiers[k] = {} if not modifiers.has_key?(k)
-            end
-
-            @modules.each do |name, version|
-                short = name.split('/')[1]
-                value = {
-                    'repo' => name,
-                    'ref'  => version,
-                }
-
-                modifiers['forge_modules'].each do |modifier, merger|
-                    # TODO use x.match?(y) on ruby 2.4
-                    value.merge!(merger) if name =~ /#{modifier}/
-                end
-
-                fixtures['forge_modules'][short] = value
-            end
-
-            @repos.each do |name, hash|
-                if hash.has_key?(:ref)
-                    content = {
-                        'repo' => hash[:uri],
-                        'ref'  => hash[:ref],
-                    }
-
-                    modifiers['repositories'].each do |modifier, merger|
-                        content.merge!(merger) if name =~ /#{modifier}/
-                    end
-                else
-                    content = hash[:uri]
-
-                    modifiers['repositories'].each do |modifier, merger|
-                        if name =~ /#{modifier}/
-                            if merger.is_a?(String)
-                                content = merger
-                            else
-                                content = {
-                                    'repo' => hash[:uri],
-                                }
-
-                                content.merge!(merger)
-                            end
-                        end
-                    end
-                end
-
-                fixtures['repositories'][name] = content
-            end
-
-            { 'fixtures' => fixtures }
+            Puppetfiler.fixture(@modules, @repos, modifiers)
         end
 
         private
@@ -124,7 +72,9 @@ module Puppetfiler
 
             if arg.is_a?(String)
                 return if arg == 'latest'
-                @modules[name] = arg
+
+                @modules[name] = Puppetfiler::Mod.new(:name => name, :version => arg)
+
                 @maxlen_name = name.length if name.length > @maxlen_name
                 @maxlen_ver  = arg.length if arg.length > @maxlen_ver
             else args.is_a?(Hash)

data/lib/puppetfiler/version.rb

@@ -1,3 +1,3 @@
 module Puppetfiler
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/puppetfiler.rb

@@ -1,7 +1,65 @@
 require 'puppetfiler/cli'
+require 'puppetfiler/metadata'
 require 'puppetfiler/mod'
 require 'puppetfiler/puppetfile'
 require 'puppetfiler/version'
 
 module Puppetfiler
+    def self.fixture(modules, repos, modifiers = {})
+        fixtures = {}
+
+        %w{forge_modules repositories}.each do |k|
+            modifiers[k] = {} if not modifiers.has_key?(k)
+        end
+
+        modules.each do |name, mod|
+            short = name.split('/')[1]
+            value = {
+                'repo' => name,
+                'ref'  => mod.version.to_s,
+            }
+
+            modifiers['forge_modules'].each do |modifier, merger|
+                # TODO use x.match?(y) on ruby 2.4
+                value.merge!(merger) if name =~ /#{modifier}/
+            end
+
+            fixtures['forge_modules'] = {} if not fixtures.has_key?('forge_modules')
+            fixtures['forge_modules'][short] = value
+        end
+
+        repos.each do |name, hash|
+            if hash.has_key?(:ref)
+                content = {
+                    'repo' => hash[:uri],
+                    'ref'  => hash[:ref],
+                }
+
+                modifiers['repositories'].each do |modifier, merger|
+                    content.merge!(merger) if name =~ /#{modifier}/
+                end
+            else
+                content = hash[:uri]
+
+                modifiers['repositories'].each do |modifier, merger|
+                    if name =~ /#{modifier}/
+                        if merger.is_a?(String)
+                            content = merger
+                        else
+                            content = {
+                                'repo' => hash[:uri],
+                            }
+
+                            content.merge!(merger)
+                        end
+                    end
+                end
+            end
+
+            fixtures['repositories'] = {} if not fixtures.has_key?('repositories')
+            fixtures['repositories'][name] = content
+        end
+
+        return { 'fixtures' => fixtures }
+    end
 end

data/puppetfiler.gemspec

@@ -31,8 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.10.4'
   spec.add_development_dependency 'simplecov', '~> 0.13.0'
   spec.add_development_dependency 'simplecov-console', '~> 0.4.1'
+  spec.add_development_dependency 'webmock', '~> 2.3'
 
   spec.add_dependency 'puppet_forge', '~> 2.2'
   spec.add_dependency 'semantic_puppet', '~> 0.1.4'
   spec.add_dependency 'thor', '~> 0.19.4'
+  spec.add_dependency 'hashie', '~> 3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppetfiler
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Nelo-T. Wallus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: puppet_forge
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.19.4
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: 
 email:
 - nelo@wallus.de
@@ -176,6 +204,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.rst
 - Gemfile
 - LICENSE.txt
 - README.rst
@@ -183,10 +212,14 @@ files:
 - TODO
 - bin/console
 - bin/setup
+- data/metadata_emptydeps.json
+- data/metadata_nodeps.json
+- data/simple_metadata.json
 - data/simple_puppetfile.rb
 - exe/puppetfiler
 - lib/puppetfiler.rb
 - lib/puppetfiler/cli.rb
+- lib/puppetfiler/metadata.rb
 - lib/puppetfiler/mod.rb
 - lib/puppetfiler/puppetfile.rb
 - lib/puppetfiler/version.rb
@@ -211,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Miscallenous actions on Puppetfiles