qb 0.1.60 → 0.1.61

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b47bdac25f6db4d1fea5cf3b018229d4b94a0987
-  data.tar.gz: d3a4cdd1d235048c4f49dbbaf7824fe77706ce46
+  metadata.gz: ac5214f10fb124d147d91b4618033b426d389558
+  data.tar.gz: f051f2779ee56a8aa1747642080c99e08e567f02
 SHA512:
-  metadata.gz: 95cc0afa926ddf49719cbe7b77effbeb99923dc7241430fa5adcf1ead739434662aca811d9978b9f077520a25095b6347887ea99b261bf763c178c23b27d1c62
-  data.tar.gz: 46ab3b3bd3866aa64cb3982be5fdd126b5ba479dd550f4d7e05c292e3fc49c4506381e891ac951ef05e998e60f8ea21df2547b0b7e44919a9d28a0cfe9d12b85
+  metadata.gz: 2102fe8bf8be9a227dc3f5644c31c2e8d0ae57b9aa30dc4578914531c569afc05c71dbed9449f8ec0cda4c4a060203f0c1db91260fd9c423c1a3f6ede0a76323
+  data.tar.gz: c992b406840a86966b0b8d8b9e59c215255b23245c0f764db261dfb666639d24a9f30f30ecc5b6ca258ef8b80333bd93949f54023ccd944f68a3ab677cb1970b

data/lib/qb/options.rb

@@ -1,6 +1,6 @@
 require 'optparse'
 
-require_relative "options/errors"
+require_relative "role/errors"
 require_relative "options/option"
 
 module QB
@@ -88,7 +88,7 @@ module QB
         when String
           include_path + [include_meta['as']]
         else
-          raise QB::Options::MetadataError.new,
+          raise QB::Role::MetadataError.new,
             "bad 'as' value: #{ include_meta.inspect }"
         end
       else
@@ -125,7 +125,7 @@ module QB
           else
             ruby_type = case option.meta['type']
             when nil
-              raise QB::Options::MetadataError,
+              raise QB::Role::MetadataError,
                 "must provide type in qb metadata for option #{ option.meta_name }"
             when 'string', 'str'
               String
@@ -140,17 +140,17 @@ module QB
                   if option.meta['type']['one_of'].include? value
                     value
                   else
-                    raise QB::Options::MetadataError,
+                    raise QB::Role::MetadataError,
                       "option '#{ option.cli_name }' must be one of: #{ option.meta['type']['one_of'].join(', ') }"
                   end
                 }
                 klass
               else 
-                raise QB::Options::MetadataError,
+                raise QB::Role::MetadataError,
                   "bad type for option #{ option.meta_name }: #{ option.meta['type'].inspect }"
               end
             else
-              raise QB::Options::MetadataError,
+              raise QB::Role::MetadataError,
                 "bad type for option #{ option.meta_name }: #{ option.meta['type'].inspect }"
             end
             

data/lib/qb/role.rb

@@ -3,6 +3,8 @@ require 'cmds'
 require 'parseconfig'
 require 'nrser/refinements'
 
+require_relative 'role/errors'
+
 using NRSER
 
 module QB
@@ -37,36 +39,7 @@ module QB
     #     the path qb metadata was load from. `nil` if it's never been loaded
     #     or doesn't exist.
     attr_reader :meta_path
-    
-    # errors
-    # =======================================================================
-    
-    # base for errors in the module, extends QB:Error
-    class Error < QB::Error
-    end
-    
-    # raised by `.require` when no roles match input
-    class NoMatchesError < Error
-      attr_accessor :input
-      
-      def initialize input
-        @input = input
-        
-        super "no roles match input #{ @input.inspect }"
-      end
-    end
-    
-    # raised by `.require` when multiple roles match
-    class MultipleMatchesError < Error
-      attr_accessor :input, :matches
-      
-      def initialize input, matches
-        @input = input
-        @matches = matches
-        
-        super "mutiple roles match input #{ @input.inspect }:\n#{ @matches.join("\n") }"
-      end
-    end
+
     
     # static role utils
     # =======================================================================
@@ -280,7 +253,7 @@ module QB
         when String
           current_include_path + [option_meta['as']]
         else
-          raise QB::Options::MetadataError.new,
+          raise QB::Role::MetadataError.new,
             "bad 'as' value: #{ option_meta.inspect }"
         end
       else
@@ -361,9 +334,23 @@ module QB
     #
     # if `cache` is true caches it as `@meta`
     # 
-    def load_meta cache = true      
+    def load_meta cache = true
       meta = if @meta_path.extname == '.yml'
-        YAML.load(@meta_path.read) || {}
+        contents = begin
+          @meta_path.read
+        rescue Exception => error
+          raise QB::Role::MetadataError,
+            "Failed to read metadata file at #{ @meta_path.to_s }, " +
+            "error: #{ error.inspect }"
+        end
+        
+        begin
+          YAML.load(contents) || {}
+        rescue Exception => error
+          raise QB::Role::MetadataError,
+            "Failed to load metadata YAML from #{ @meta_path.to_s }, " +
+            "error: #{ error.inspect }"
+        end
       else
         YAML.load(Cmds.out!(@meta_path.realpath.to_s)) || {}
       end

data/lib/qb/role/errors.rb

@@ -0,0 +1,30 @@
+module QB
+  class Role
+    # raised by `.require` when no roles match input
+    class NoMatchesError < QB::Error
+      attr_accessor :input
+      
+      def initialize input
+        @input = input
+        
+        super "no roles match input #{ @input.inspect }"
+      end
+    end
+    
+    # raised by `.require` when multiple roles match
+    class MultipleMatchesError < QB::Error
+      attr_accessor :input, :matches
+      
+      def initialize input, matches
+        @input = input
+        @matches = matches
+        
+        super "mutiple roles match input #{ @input.inspect }:\n#{ @matches.join("\n") }"
+      end
+    end
+    
+    # raised when there's bad metadata 
+    class MetadataError < QB::Error
+    end
+  end # Role
+end # QB

data/lib/qb/version.rb

@@ -1,7 +1,7 @@
 module QB
   GEM_NAME = 'qb'
   
-  VERSION = "0.1.60"
+  VERSION = "0.1.61"
   
   def self.gemspec
     Gem.loaded_specs[GEM_NAME]

data/library/path_facts

@@ -0,0 +1,304 @@
+#!/usr/bin/env ruby
+# WANT_JSON
+
+# init bundler in dev env
+if ENV['QB_DEV_ENV']
+  ENV.each {|k, v|
+    if k.start_with? 'QB_DEV_ENV_'
+      ENV[k.sub('QB_DEV_ENV_', '')] = v
+    end
+  }
+  require 'bundler/setup'
+end
+
+require 'ostruct'
+
+require 'qb'
+require 'cmds'
+require 'pathname'
+require 'uri'
+require 'net/http'
+
+class Result < OpenStruct
+  def to_json *args
+    to_h.to_json *args
+  end
+end
+
+GITHUB_SSH_URL_RE = /^git@github\.com\:(?<owner>.*)\/(?<name>.*)\.git$/
+GITHUB_HTTPS_URL_RE = /^https:\/\/github\.com\/(?<owner>.*)\/(?<name>.*)\.git$/
+
+# An attempt to unify NPM and Gem version schemes to a reasonable extend, 
+# and hopefully cover whatever else the cat may drag in.
+class Version
+  # Create a Version instance from a Gem::Version
+  def self.from_gem_version version
+    release_segments = version.segments.take_while {|seg| !seg.is_a?(String)}
+    prerelease_segments = version.segments[release_segments.length..-1]
+    
+    new raw: version.to_s,
+        major: release_segments[0],
+        minor: release_segments[1],
+        patch: release_segments[2],
+        prerelease: prerelease_segments,
+        build: [],
+        release: version.release
+  end
+  
+  def self.from_npm_version version
+    stmt = NRSER.squish <<-END
+      var Semver = require('semver');
+      
+      console.log(
+        JSON.stringify(
+          Semver(#{ JSON.dump version })
+        )
+      );
+    END
+    
+    parse = JSON.load Cmds.out!("node --eval %s", stmt)
+    
+    new raw: version,
+        major: parse['major'],
+        minor: parse['minor'],
+        patch: parse['patch'],
+        prerelease: parse['prerelease'],
+        build: parse['build'],
+        release: [parse['major'], parse['minor'], parse['patch']].join(".")
+  end
+  
+  # Construct a new Version
+  def initialize raw:, major:, minor:, patch:, prerelease:, build:, release:
+    @raw = raw
+    @major = major
+    @minor = minor
+    @patch = patch
+    @prerelease = prerelease
+    @build = build
+    @release = release
+    
+    @level = @prerelease[0] || 'release'
+    
+    @is_release = @prerelease.empty?
+    @is_dev = @prerelease[0] == 'dev'
+    @is_rc = @prerelease[0] == 'rc'
+  end
+  
+  # Dump all instance variables in JSON serialization
+  def to_json *args
+    instance_variables.map {|var| 
+      [var[1..-1].to_sym, instance_variable_get(var)]
+    }.to_h.to_json *args
+  end
+end
+
+class PathFacts < QB::AnsibleModule
+  # Add a bunch of useful things to know about the path
+  def add_path_facts
+    @result.expanded = @path.expand_path
+    @result.exists = @path.exist?
+    @result.is_expanded = @result.expanded == @path
+    @result.is_absolute = @path.absolute?
+    @result.is_relative = @path.relative?
+    @result.is_dir = @path.directory?
+    @result.is_file = @path.file?
+    @result.is_cwd = @path == Pathname.getwd
+    
+    # Will raise if there is no relative path between them, in which case
+    # 'relative' will be null.
+    @result.relative = begin
+      @path.relative_path_from Pathname.getwd
+    rescue ArgumentError => error
+    end
+    
+    # Pathname#realpath will raise if the path doesn't exist
+    @result.realpath = begin
+      @path.realpath
+    rescue Exception => error
+    end
+    
+    @result.is_realpath = @result.realpath == @path
+  end
+  
+  # If the path is a Git repo (has a .git file in it's root) add useful
+  # Git facts.
+  def add_git_facts
+    git_file_path = @path.join('.git')
+    
+    unless @path.directory? && git_file_path.exist?
+      @result.is_git = false
+      return
+    end
+    
+    @result.is_git = true
+    
+    Dir.chdir(@path) do  
+      git = @result.git = Result.new
+      
+      user = git.user = Result.new
+      
+      ['name', 'email'].each {|key|
+        user[key] = begin
+          Cmds.chomp! "git config user.#{ key }"
+        rescue
+        end
+      }
+      
+      git.root = begin
+        Cmds.chomp! "git rev-parse --show-toplevel"
+      rescue
+      end
+      
+      git.origin = begin
+        Cmds.chomp! "git remote get-url origin"
+      rescue
+      end
+      
+      match = GITHUB_SSH_URL_RE.match(git.origin) ||
+              GITHUB_HTTPS_URL_RE.match(git.origin)
+      
+      git.is_github = !! match
+      
+      return unless match
+      
+      git.owner = match['owner']
+      git.name = match['name']
+      git.full_name = "#{ git.owner }/#{ git.name }"
+      
+      if true == @args['github_api']
+        github = git.github = Result.new
+        github.api_url = "https://api.github.com/repos/#{ git.owner }/#{ git.name }"
+        
+        response = Net::HTTP.get_response URI(github.api_url)
+        
+        if response.is_a? Net::HTTPSuccess
+          # parse response body and add everything to github result
+          parsed = JSON.parse response.body
+          parsed.each {|k, v| github[k] = v}
+        else
+          # assume it's private if we failed to find it
+          github.private = true
+        end
+        
+      end
+      
+    end
+  end
+  
+  # Find the only *.gemspec path in the `@path` directory. Warns and returns
+  # `nil` if there is more than one match.
+  def gemspec_path
+    paths = Pathname.glob(@path.join('*.gemspec'))
+    
+    case paths.length
+    when 0
+      nil
+    when 1
+      paths[0]
+    else
+      warn "found multiple gemspecs: #{ paths }, unable to pick one."
+      nil
+    end
+  end
+  
+  # If `path` is a directory containing the source for a Ruby Gem, add 
+  # useful information about it.
+  def add_gem_facts
+    unless @path.directory?
+      @result.is_gem = false
+      return
+    end
+    
+    path = gemspec_path
+    
+    if path.nil?
+      @result.is_gem = false
+      return
+    end
+    
+    @result.is_gem = true
+    @result.package.types << 'gem'
+    
+    gem = @result.gem = Result.new
+    
+    gem.gemspec_path = gemspec_path.to_s
+    
+    spec = Gem::Specification::load(gemspec_path.to_s)
+    gem.name = spec.name
+    gem.version = Version.from_gem_version spec.version
+  end
+  
+  # Add facts about an NPM package based in `@path`, if any.
+  def add_npm_facts
+    package_json_path = @path.join('package.json')
+    
+    unless @path.directory? && package_json_path.file?
+      @result.is_npm = false
+      return
+    end
+    
+    @result.is_npm = true
+    @result.package.types << 'npm'
+    
+    npm = @result.npm = Result.new
+    
+    npm.package_json = JSON.load package_json_path.read
+    
+    # To stay consistent with Gem
+    npm.name = npm.package_json['name']
+    npm.version = Version.from_npm_version npm.package_json['version']
+  end
+  
+  # Run the module.
+  def main
+    # check the 'path' arg
+    unless @args['path'].is_a? String
+      raise ArgumentError,
+        "'path' arg must be a string, found #{ @args['path'].inspect }."
+    end
+    
+    # We'll return the value of @result
+    @result = Result.new
+    
+    # Default to signaling no change (we're not gonna change anything in this
+    # module either)
+    @result.changed = false
+    
+    # String warnings that will be shown to the user
+    @result.warnings = []
+    
+    @result.package = Result.new
+    @result.package.types = []
+    
+    # Return the input as 'raw'
+    @result.raw = @args['path']
+    
+    @path = Pathname.new @result.raw
+    
+    add_path_facts
+    add_git_facts
+    add_gem_facts
+    add_npm_facts
+    
+    # If we only have one type of package present, we set it's type and 
+    # version as `package.type` and `package.version`, which makes it easy for
+    # code to 'auto-detect' the info.
+    # 
+    # If there's more than one then we obviously can't guess what to do; the
+    # user needs to specify.
+    # 
+    if @result.package.types.length == 1
+      @result.package.type = @result.package.types[0]
+      @result.package.name = @result[@result.package.type].name
+      @result.package.version = @result[@result.package.type].version
+    end
+    
+    nil
+  end
+  
+  def done
+    exit_json @result.to_h
+  end
+end
+
+PathFacts.new.run