puppetfiler 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e2e5783e88c6066b2e029741e8246192c59216f
-  data.tar.gz: c6a19c79436262c91b7d263205de583b5eb5484b
+  metadata.gz: 00dccc7d68143e696a7314713198851263fee00e
+  data.tar.gz: 76e038e1307597430b1cfe2f9ef75bf6b0a4f49e
 SHA512:
-  metadata.gz: 263b769794f7d8aadff453d04d11a92ab9eaeb7fb1a461fb9d64d83ddd8a8a4b326318adfd75ac8473b1e24279a2e902d19543e257002307702633beacfde14d
-  data.tar.gz: 49d3855d4009093d043fcdc74e7b3fe1a34f08b0450cd0e26d214db327e2690a7c7bca29006289a3c944d9924ed259d8a1ab52b1e23d76d9e51cc29225be164d
+  metadata.gz: e34855099378cabd5c06c897b228beaef766c695dd6daaf3502c08732715b8e49db85217a4f1db7baf88fe1422a53fac75bac44eb86f1df7d72a2f613f4bab12
+  data.tar.gz: 806f538051bf95a4d4efcf4f9352f209e0ee5b59fa30638170e10d9a1e695ff1a78062e55691ffb411e757aea17750dcea4657535f8462fb5e04fb45c5484dab

data/CHANGELOG.rst

@@ -1,3 +1,21 @@
+v0.2.0
+------
+
+Bugfixes
+~~~~~~~~
+- ``Puppetfiler::Mod`` now correctly checks for the symbolized member
+  'version_requirement' of metadata.json entries.
+
+Changes
+~~~~~~~
+- ``puppetfiler/rake_task`` adds the rake task ``fixture``, which
+  generates the ``.fixtures.yml`` for both environments and modules.
+  Additionally it is set as a requirement for the task ``spec_prep``
+  from ``puppetlabs_spec_helper``.
+
+- Puppetfiler now has a single calling convention via the core module
+  and figures the target out if none was passed.
+
 v0.1.5
 ------
 

data/README.rst

@@ -27,8 +27,13 @@ Installation
 Usage
 =====
 
-If no Puppetfile has been specified puppetfiler uses the Puppetfile in
-the current directory.
+A puppetfile can be specified via ``-p path/to/pf`` or ``--puppetfile path/to/pf``,
+a metadata file via ``-m path/to/metadata.json`` or ``--metadata
+path/to/metadata.json``.
+
+If neither are specified ``puppetfiler`` will check for a file named
+``Puppetfile`` in the current working directory first, then for a file
+named ``metadata.json``.
 
 check
 -----
@@ -46,8 +51,7 @@ to be queried from the forge.
 
 fixture
 -------
-Create puppetlabs_spec_helper_ compatible ``.fixtures.yml`` from
-Puppetfile.
+Create puppetlabs_spec_helper_ compatible ``.fixtures.yml``.
 
 .. code:: sh
 
@@ -68,23 +72,32 @@ Puppetfile.
 Gerating .fixture.yml when executing rake tasks
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Without modifying the result:
+
+.. code:: ruby
+
+    require 'puppetfiler/rake_tasks'
+
+Which adds the task ``fixture``, which is equivalent to runnning
+``puppetfiler fixture``.
+
+With modifying the result:
+
 .. code:: ruby
 
     require 'puppetfiler'
 
     desc 'Generate .fixtures.yml'
-    task :fixtures do
-        pf = Puppetfiler::Puppetfile.new('Puppetfile')
-        fixtures = pf.fixture(
-            {
-                'forge_modules' => {
-                    /.*/ => {
-                        'flags' => '--module_repository https://inhouse.forge.lan/',
-                    },
+    task :fixture do
+        modifier = {
+            'forge_modules' => {
+                /.*/ => {
+                    'flags' => '--module_repository https://inhouse.forge.lan/',
                 },
             },
-        )
-        File.write('.fixtures.yml', fixtures.to_yaml)
+        }
+
+        Puppetfiler.fixture(modifier)
     end
 
     task :spec => [:fixtures]

data/data/empty_puppetfile.rb

@@ -0,0 +1 @@
+moduledir 'external_modules'

data/lib/puppetfiler/cli.rb

@@ -3,6 +3,14 @@ require 'yaml'
 require 'puppetfiler/puppetfile'
 require 'puppetfiler/version'
 
+module SemanticPuppet
+    class Version < Numeric
+        def length
+            to_s.length
+        end
+    end
+end
+
 module Puppetfiler
     class CLI < Thor
         class_option :puppetfile, {
@@ -18,70 +26,57 @@ module Puppetfiler
         }
 
         desc 'check', 'Check forge for newer versions of used forge modules'
-        def check()
-            target = target(options)
+        def check
+            t = [nil, nil]
+            %i{puppetfile metadata}.each do |m|
+                if not options[m].nil?
+                    t = [m, options[m]]
+                end
+            end
+            updates = Puppetfiler.check(*t)
+
+            if updates.empty?
+                return
+            end
 
-            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]}"
+            maxlen_name = 0
+            maxlen_val  = 0
+            val_count   = 0
+
+            updates.each do |name, hash|
+                maxlen_name = name.length if name.length > maxlen_name
+                hash.each do |k, v|
+                    val_count += 1
+                    maxlen_val = k.length if k.length > maxlen_val
+                    maxlen_val = v.length if v.length > maxlen_val
+                end
             end
 
-            format = "% -#{t.maxlen_name}s  % -#{t.maxlen_ver}s  %s"
+            format = "% -#{maxlen_name}s  " + ( "% -#{maxlen_val}s" * val_count )
 
-            puts sprintf(format, 'module', 'current', 'newest')
+            puts sprintf(format, 'module', *updates.first[1].keys)
 
-            # 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])
+            updates.each do |name, hash|
+                puts sprintf(format, name, *hash.values)
             end
         end
 
         desc 'fixture', 'Create puppetlabs_spec_helper compatible .fixtures.yml from puppetfile or metadata.json'
         method_option :stdout, :aliases => '-o'
-        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]}"
+        def fixture
+            t = [nil, nil]
+            %i{puppetfile metadata}.each do |m|
+                if not options[m].nil?
+                    t = [m, options[m]]
+                end
             end
 
-            f = f.fixture.to_yaml
-
-            if options[:stdout]
-                puts f
-            else
-                File.write('.fixtures.yml', f)
-            end
+            Puppetfiler.fixture(*t, {}, options[:stdout])
         end
 
         desc 'version', 'Output version'
         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/fixture.rb

@@ -0,0 +1,61 @@
+module Puppetfiler
+    class Fixture
+        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
+end

data/lib/puppetfiler/metadata.rb

@@ -13,7 +13,7 @@ module Puppetfiler
         end
 
         def fixture(modifiers = {})
-            Puppetfiler.fixture(@dependencies, {}, modifiers)
+            Puppetfiler::Fixture.fixture(@dependencies, {}, modifiers)
         end
 
         def eql?(other)

data/lib/puppetfiler/mod.rb

@@ -19,7 +19,7 @@ module Puppetfiler
             @forge = PuppetForge::Module.find(@slug)
 
             @range = nil
-            [:range, 'range', 'version_requirement'].each do |v|
+            %i{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])
@@ -30,7 +30,7 @@ module Puppetfiler
             end
 
             @version = nil
-            [:version, 'version'].each do |v|
+            %i{version}.each do |v|
                 @version = SemanticPuppet::Version.parse(args[v]) if args.has_key?(v)
             end
             @version = latest_valid if not @version

data/lib/puppetfiler/puppetfile.rb

@@ -5,16 +5,12 @@ module Puppetfiler
         attr :modules
         attr :repos
         attr :puppetfile
-        attr :maxlen_name
 
         def initialize(path = 'Puppetfile')
             @modules    = {}
             @repos      = {}
             @puppetfile = path
 
-            @maxlen_name = 0
-            @maxlen_ver  = 0
-
             self.evaluate
         end
 
@@ -36,10 +32,6 @@ module Puppetfiler
             end
         end
 
-        def maxlen_ver
-            [@maxlen_ver, 'current'.length].max
-        end
-
         def updates
             updates = {}
 
@@ -59,7 +51,7 @@ module Puppetfiler
         end
 
         def fixture(modifiers = {})
-            Puppetfiler.fixture(@modules, @repos, modifiers)
+            Puppetfiler::Fixture.fixture(@modules, @repos, modifiers)
         end
 
         private
@@ -75,8 +67,6 @@ module Puppetfiler
 
                 @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)
 
                 @repos[name] = {}

data/lib/puppetfiler/rake_tasks.rb

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Generate .fixtures.yml from metadata.json or Puppetfile'
+task :fixture do
+    require 'puppetfiler/cli'
+
+    Puppetfiler.fixture
+end
+
+if defined?(:PuppetlabsSpec)
+    task :spec_prep => [:fixture]
+end

data/lib/puppetfiler/version.rb

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

data/lib/puppetfiler.rb

@@ -1,65 +1,66 @@
 require 'puppetfiler/cli'
+require 'puppetfiler/fixture'
 require 'puppetfiler/metadata'
 require 'puppetfiler/mod'
 require 'puppetfiler/puppetfile'
 require 'puppetfiler/version'
 
 module Puppetfiler
-    def self.fixture(modules, repos, modifiers = {})
-        fixtures = {}
+    def self.detect(type = nil, target = nil)
+        if (type.nil? && !target.nil?) || (!type.nil? && target.nil?)
+            fail 'Type and target are required to bet both set'
+        elsif !type.nil? && !target.nil?
+            return type, target
+        end
 
-        %w{forge_modules repositories}.each do |k|
-            modifiers[k] = {} if not modifiers.has_key?(k)
+        {
+            :puppetfile => %w{Puppetfile},
+            :metadata   => %w{metadata.json},
+        }.each do |type, targets|
+            targets.each do |target|
+                if File.exists?(target)
+                    return type, target
+                end
+            end
         end
 
-        modules.each do |name, mod|
-            short = name.split('/')[1]
-            value = {
-                'repo' => name,
-                'ref'  => mod.version.to_s,
-            }
+        fail 'No valid target found, aborting'
+    end
 
-            modifiers['forge_modules'].each do |modifier, merger|
-                # TODO use x.match?(y) on ruby 2.4
-                value.merge!(merger) if name =~ /#{modifier}/
-            end
+    def self.check(type = nil, target = nil)
+        type, target = detect(type, target)
 
-            fixtures['forge_modules'] = {} if not fixtures.has_key?('forge_modules')
-            fixtures['forge_modules'][short] = value
+        case type
+        when :puppetfile
+            t = Puppetfiler::Puppetfile.new(target)
+        when :metadata
+            # TODO see below
+            fail 'Checking metadata.json for version range updates is not implemented yet'
+        else fail "Unkown type: #{type}"
         end
 
-        repos.each do |name, hash|
-            if hash.has_key?(:ref)
-                content = {
-                    'repo' => hash[:uri],
-                    'ref'  => hash[:ref],
-                }
+        # TODO the updates should be collected asynchronously to
+        # speed up the process
+        return t.updates
+    end
 
-                modifiers['repositories'].each do |modifier, merger|
-                    content.merge!(merger) if name =~ /#{modifier}/
-                end
-            else
-                content = hash[:uri]
+    def self.fixture(type = nil, target = nil, modifier = {}, stdout = false)
+        type, target = detect(type, target)
 
-                modifiers['repositories'].each do |modifier, merger|
-                    if name =~ /#{modifier}/
-                        if merger.is_a?(String)
-                            content = merger
-                        else
-                            content = {
-                                'repo' => hash[:uri],
-                            }
+        case type
+        when :puppetfile
+            f = Puppetfiler::Puppetfile.new(target)
+        when :metadata
+            f = Puppetfiler::Metadata.new(File.new(target))
+        else fail "Unkown type: #{type}"
+        end
 
-                            content.merge!(merger)
-                        end
-                    end
-                end
-            end
+        f = f.fixture(modifier).to_yaml
 
-            fixtures['repositories'] = {} if not fixtures.has_key?('repositories')
-            fixtures['repositories'][name] = content
+        if stdout
+            puts f
+        else
+            File.write('.fixtures.yml', f)
         end
-
-        return { 'fixtures' => fixtures }
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetfiler
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Nelo-T. Wallus
@@ -212,6 +212,7 @@ files:
 - TODO
 - bin/console
 - bin/setup
+- data/empty_puppetfile.rb
 - data/metadata_emptydeps.json
 - data/metadata_nodeps.json
 - data/simple_metadata.json
@@ -219,9 +220,11 @@ files:
 - exe/puppetfiler
 - lib/puppetfiler.rb
 - lib/puppetfiler/cli.rb
+- lib/puppetfiler/fixture.rb
 - lib/puppetfiler/metadata.rb
 - lib/puppetfiler/mod.rb
 - lib/puppetfiler/puppetfile.rb
+- lib/puppetfiler/rake_tasks.rb
 - lib/puppetfiler/version.rb
 - puppetfiler.gemspec
 homepage: https://github.com/ntnn/puppetfiler
@@ -244,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Miscallenous actions on Puppetfiles