qb 0.3.12 → 0.3.13

data/lib/qb/role/errors.rb

@@ -1,3 +1,13 @@
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+
+# Definitions
+# =======================================================================
+
 module QB
   class Role
     # raised by `.require` when no roles match input
@@ -19,16 +29,14 @@ module QB
         @input = input
         @matches = matches
         
-        super <<-END
-multiple roles match input #{ @input.inspect }:\
-
-#{
-  @matches.map { |role|
-    "-   #{ role.to_s } (#{ role.path.to_s })"
-  }.join("\n")
-}
-
-END
+        super binding.erb <<-END
+          multiple roles match input <%= @input.inspect %>:
+          
+          <% @matches.map do |role| %>
+            -   <%= role.to_s %> (<%= role.path.to_s %>)
+          <% end %>
+          
+        END
       end
     end
     

data/lib/qb/role/name.rb

@@ -0,0 +1,139 @@
+##
+# {QB::Role} methods for dealing with role names.
+# 
+# Broken out from the main `//lib/qb/role.rb` file because it was starting to 
+# get long and unwieldy.
+# 
+##
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+require 'qb/util'
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+
+# Declarations
+# =======================================================================
+
+
+# Definitions
+# =======================================================================
+
+class QB::Role
+  
+  # Class Methods
+  # ======================================================================
+  # 
+  # Actual functionality is implemented as static methods so that it can be
+  # used in cases where we don't have a {QB::Role} instantiated, especially
+  # in roles themselves like `//roles/qb/role` with:
+  # 
+  #     role_role_name: >-
+  #       {{ 'QB::Role' | qb_send_const( 'default_name_for', role_dest ) }}
+  #     
+  #     role_namespaceless: >-
+  #       {{ 'QB::Role' | qb_send_const( 'namespaceless_for', role_role_name ) }}
+  # 
+  
+  
+  # Do our best to figure out a role name from a path (that might not exist).
+  # 
+  # We needs this when we're creating a role.
+  # 
+  # @param [String | Pathname] path
+  #   
+  # 
+  # @return [String]
+  # 
+  def self.default_name_for path
+    resolved_path = QB::Util.resolve path
+    
+    # Find the first directory in the search path that contains the path,
+    # if any do.
+    # 
+    # It *could* be in more than one in funky situations like overlapping 
+    # search paths or link silliness, but that doesn't matter - we consider 
+    # the first place we find it to be the relevant once, since the search
+    # path is most-important-first.
+    # 
+    search_dir = search_path.find { |pathname|
+      resolved_path.fnmatch? ( pathname / '**' ).to_s
+    }
+    
+    if search_dir.nil?
+      # It's not in any of the search directories
+      # 
+      # If it has 'roles' as a segment than use what's after the last occurrence
+      # of that (unless there isn't anything).
+      # 
+      segments = resolved_path.to_s.split File::SEPARATOR
+      
+      if index = segments.rindex( 'roles' )
+        name_segs = segments[( index + 1 )..( -1 )]
+        
+        unless name_segs.empty?
+          return File.join name_segs
+        end
+      end
+      
+      # Ok, that didn't work... just return the basename I guess...
+      return File.basename resolved_path
+      
+    end
+    
+    # it's in the search path, return the relative path from the containing
+    # search dir to the resolved path (string version of it).
+    resolved_path.relative_path_from( search_dir ).to_s
+
+  end # #default_name_for
+  
+  # Old depreciated name
+  singleton_class.send :alias_method, :default_role_name, :default_name_for
+  
+  
+  def self.namespace_for name
+    *namespace_segments, last = name.split File::Separator
+    
+    namespace_segments << last.split('.').first if last.include?('.')
+     
+    if namespace_segments.empty?
+      nil
+    else
+      File.join *namespace_segments
+    end
+  end
+  
+  
+  def self.namespaceless_for name
+    File.basename( name ).split('.', 2).last
+  end
+  
+  
+  # Instance Methods
+  # ============================================================================
+  
+  def namespace
+    self.class.namespace_for @name
+  end
+  
+  
+  def namespaceless
+    self.class.namespaceless_for @name
+  end
+  
+end # class QB::Role

data/lib/qb/util/logging.rb

@@ -158,8 +158,6 @@ module QB::Util::Logging
   end # module Formatters
   
   
-
-  
   # Module (Class) Methods
   # =====================================================================
   
@@ -208,8 +206,3 @@ module QB::Util::Logging
   
   
 end # module QB::Util::Logging
-
-
-
-# Post-Processing
-# =======================================================================

data/lib/qb/version.rb

@@ -4,7 +4,7 @@ module QB
   
   GEM_NAME = 'qb'
   
-  VERSION = "0.3.12"
+  VERSION = "0.3.13"
   
   MIN_ANSIBLE_VERSION = Gem::Version.new '2.1.2'
   

data/library/stream

@@ -23,6 +23,11 @@ class Stream < QB::Ansible::Module
             "Must supply `template` or `cmd` argument."
     end
     
+    if @args['creates'] && File.exists?( @args['creates'] )
+      debug "File #{ @args['creates'] } exists, skipping"
+      return nil
+    end
+    
     opts = {}
     
     [:args, :kwds, :input, :assert, :env, :chdir].each { |key|

data/plugins/filter_plugins/string_plugins.py

@@ -62,7 +62,6 @@ def cap(string):
     'DoSomething'
     '''
     return string[0].upper() + string[1:]
-    
 
 
 def camel_case(string):
@@ -80,8 +79,8 @@ def camel_case(string):
     >>> camel_case("qb.DoSomething")
     'qbDoSomething'
     '''
-    w = words(string)
-    return w[0] + "".join(cap(s) for s in w[1:])
+    words = qb.strings.words(string)
+    return words[0] + "".join(cap(s) for s in words[1:])
 
 
 def cap_camel_case(string):

data/plugins/filter_plugins/version_plugins.py

@@ -34,7 +34,18 @@ def semver_inc(version, level = None, preid = None):
     
         semver --increment <level> [--preid <preid>] <version>
     
+    
+    This does **not** do what you probably want... `preid` is ignored:
+    
+    >>> semver_inc('1.0.0', 'patch', preid = 'dev')
+    '1.0.1'
+    
     >>> semver_inc('1.0.0', 'minor', preid = 'dev')
+    '1.1.0'
+    
+    The only way to get the `preid` appended is to increment the prerelease:
+    
+    >>> semver_inc('1.0.0', 'prerelease', preid = 'dev')
     '1.0.1-dev.0'
     
     '''

data/qb.gemspec

@@ -1,13 +1,35 @@
 # coding: utf-8
+
+# WARNING!!!
+#
+# This file gets executed every time Bundler sets up, so we want it to be
+# fast, fast, *fast*... or every command execution in development will be
+# painfully slow.
+#
+# This comes into play because you're dealing with potentially large lists of
+# files, and how you handle them makes a difference.
+#
+
 require 'pathname'
 
-GEM_ROOT = File.expand_path(File.dirname(__FILE__))
-lib = File.join(GEM_ROOT, 'lib')
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# gem_root = File.expand_path(File.dirname(__FILE__))
+gem_root = Pathname.new( __FILE__ ).dirname.expand_path
+lib = File.join gem_root, 'lib'
+
+$LOAD_PATH.unshift( lib ) unless $LOAD_PATH.include?( lib )
+
 require 'qb/version'
 
-# things not to package (String | Regexp)
-OMIT_FILES = [
+
+# "Constants"
+# ============================================================================
+#
+# Though they're implemented as local variables because I don't want to
+# pollute the global namespace.
+#
+
+# Things not to package (String | Regexp)
+omit_files = [
   # standard gem ignores (test files)
   %r{^(test|spec|feature)/},
   # all the development files
@@ -29,90 +51,163 @@ OMIT_FILES = [
   'node_modules/.yarn-integrity',
   # nrser.blockinfile tests carried over from fork
   %r{^roles/nrser.blockinfile/tests/},
-  # temp playbook used in development
-  'temp.yml',
   # don't think we need the Rakefile
   'Rakefile',
+  
+  # Omit the ansible devel checkout for now
+  %r{^packages/python/ansible/},
 ]
 
-Gem::Specification.new do |spec|
-  spec.name          = QB::GEM_NAME
-  spec.version       = QB::VERSION
-  spec.authors       = ["nrser"]
-  spec.email         = ["neil@ztkae.com"]
-
-  spec.summary       = %q{qb is all about projects. named after everyone's favorite projects.}
-  # spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = "https://github.com/nrser/qb"
-  spec.license       = "MIT"
-  
-  checked_in_files = `git ls-files -z`.split("\x0")
-  
-  node_modules_files = Dir.glob(
-    File.join(GEM_ROOT, 'node_modules/**/*'), File::FNM_DOTMATCH
-  ).map {|abs_path|
-    Pathname.new(abs_path).relative_path_from(Pathname.new(GEM_ROOT)).to_s
+
+# Helpers
+# ============================================================================
+#
+# Again, implemented as local variables pointing to lambdas to not pollute.
+#
+
+get_rel_path = ->( path ) {
+  Pathname.new( path ).relative_path_from( gem_root ).to_s
+}
+
+should_omit = ->( rel_path ) {
+  omit_files.any? {|pattern|
+    case pattern
+    when String
+      rel_path == pattern
+    when Regexp
+      pattern.match rel_path
+    else
+      raise "bad pattern: #{ pattern.inspect }"
+    end
   }
+}
+
+filter_files = ->( rel_paths ) {
+  rel_paths.reject { |rel_path| should_omit.call rel_path }
+}
+
+
+# Spec
+# ============================================================================
+
+Gem::Specification.new do |spec|
+  spec.name           = QB::GEM_NAME
+  spec.version        = QB::VERSION
+  spec.authors        = ["nrser"]
+  spec.email          = ["neil@ztkae.com"]
+
+  spec.summary = \
+    %q{qb is all about projects. named after everyone's favorite projects.}
   
-  spec.files         = (checked_in_files + node_modules_files).reject {|fp|
-    OMIT_FILES.any? {|pattern|
-      case pattern
-      when String
-        fp == pattern
-      when Regexp
-        pattern.match fp
-      else
-        raise "bad pattern: #{ pattern.inspect }"
-      end
-    }
-  }
+  # spec.description = \
+  #   %q{TODO: Write a longer description or delete this line.}
+  
+  spec.homepage       = "https://github.com/nrser/qb"
+  spec.license        = "MIT"
+  
+  
+  # Files
+  # ============================================================================
   
-  # get an array of submodule dirs by executing 'pwd' inside each submodule
-  gem_dir = File.expand_path(File.dirname(__FILE__)) + "/"
-  `git submodule --quiet foreach pwd`.split($\).each do |submodule_path|
-    Dir.chdir(submodule_path) do
-      submodule_relative_path = submodule_path.sub gem_dir, ""
+  # Start with all the checked-in files that are not omitted
+  spec.files          = filter_files.call `git ls-files -z`.split( "\x0" )
+  
+  # Add files from `//node_modules` that are not omitted
+  spec.files          += filter_files.call Dir.glob(
+    (gem_root / 'node_modules' / '**' / '*'), File::FNM_DOTMATCH
+  ).map { |abs_path| get_rel_path.call abs_path }
+  
+  # Add all files from Git submodules that are not omitted
+  `git submodule --quiet foreach --recursive pwd`.
+    split( $\ ).
+    each do |submod_abs_path|
+      submod_rel_path = get_rel_path.call submod_abs_path
       
-      # don't bundle dev submods
-      unless submodule_relative_path.start_with? 'dev/'
-        # issue git ls-files in submodule's directory and
-        # prepend the submodule path to create absolute file paths
-        `git ls-files`.split($\).each do |filename|
-          spec.files << "#{submodule_relative_path}/#{filename}"
+      # Only deal with the submodule at all if it isn't totally omitted
+      #
+      # Need to add the `/` on the end 'cause that's how they're matched in the
+      # regexps
+      #
+      unless should_omit.call( submod_rel_path + '/' )
+        Dir.chdir submod_abs_path do
+          # Issue git ls-files in submodule's directory and
+          # prepend the submodule path to create absolute file paths
+          #
+          # WARNING!!!  Do **NOT** `<<` to `spec.files` in the loop, it's shit
+          #             slow (lots of files -> prob resizing array tons of
+          #             times)
+          #
+          spec.files += filter_files.call `git ls-files -z`.
+            split( "\x0" ).
+            map { |filename|
+              File.join( submod_rel_path, filename)
+            }
         end
       end
-    end
-  end
+    end # each submod_abs_path
   
+  # ****************************************************************************
+  
+  # Latest (as of 2018-01-6) `bundle gem` setup uses `//exe` as the gem
+  # binaries (that are shipped) and `//bin` as the development binaries, so
+  # I've just stuck to that
   spec.bindir        = "exe"
   
-  # All files in //exe that *do not* start with `.`:
-  spec.executables   = spec.files.grep(%r{^exe/[^\.]}) { |f| File.basename(f) }
+  # Executables to install in system path with gem
+  #
+  # All files in the bindir that *do not* start with `.`
+  #
+  spec.executables   = spec.files.grep  %r{^#{ spec.bindir }/[^\.]},
+                                        &File.method( :basename )
   
   spec.require_paths = ["lib"]
+  
+  
+  # Dependencies
+  # ============================================================================
+  
+  # Development Dependencies
+  # ----------------------------------------------------------------------------
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.7.0"
-  spec.add_development_dependency "yard"
+  spec.add_development_dependency "yard", '~> 0.9.12'
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "github-markup"
   spec.add_development_dependency "pry"
   
-  spec.add_dependency "cmds", '~> 0.0', ">= 0.2.4"
-  spec.add_dependency "nrser", '~> 0.0', ">= 0.0.29"
-  spec.add_dependency "nrser-extras", '~> 0.0', ">= 0.0.3"
-  spec.add_dependency "state_mate", '~> 0.0', ">= 0.0.9"
-  spec.add_dependency 'parseconfig', '~> 1.0', '>= 1.0.8'
-  spec.add_dependency "octokit", "~> 4.0"
+  
+  # Runtime Dependencies
+  # ----------------------------------------------------------------------------
+  
+  spec.add_dependency "cmds",             '~> 0.0', ">= 0.2.4"
+  spec.add_dependency "nrser",            '~> 0.0', ">= 0.0.30"
+  spec.add_dependency "nrser-extras",     '~> 0.0', ">= 0.0.3"
+  spec.add_dependency "state_mate",       '~> 0.0', ">= 0.1.0"
+  
+  # Used to parse `ansible.cfg` files
+  spec.add_dependency 'parseconfig',      '~> 1.0', '>= 1.0.8'
+  
+  # GitHub API client
+  spec.add_dependency "octokit",          "~> 4.0"
   
   # Much better logging
-  spec.add_dependency 'semantic_logger', '~> 4.2'
+  spec.add_dependency 'semantic_logger',  '~> 4.2'
+  
   # With much more awesome printing!
-  spec.add_dependency 'awesome_print', '~> 1.8'
+  spec.add_dependency 'awesome_print',    '~> 1.8'
   
   # Ruby lib wrapping `git` binary system calls for use in {QB::Repo::Git}
   spec.add_dependency 'git', '~> 1.3.0'
   
   
+  # Development-Only Extra Metadata
+  # ============================================================================
+  #
+  # We dump this in CLI output header in local dev.
+  #
+  
   if QB::VERSION.end_with? '.dev'
     commit = `git rev-parse HEAD`.strip
     
@@ -122,5 +217,6 @@ Gem::Specification.new do |spec|
       "commit" => commit,
       "browse" => "https://github.com/nrser/qb/tree/#{ commit }",
     }
-  end
-end
+  end # if dev version
+  
+end # spec