qb 0.3.25 → 0.4.0

data/lib/qb/package/version/leveled.rb

@@ -76,7 +76,7 @@ class QB::Package::Version::Leveled < QB::Package::Version
   #   If the values do have a level.
   # 
   def self.level_for prerelease: [], build: [], **etc
-    return RELEASE if prerelease.empty? && build.empty?
+    return RELEASE if prerelease.empty?
     
     return DEV if prerelease[0] == DEV
     

data/lib/qb/path.rb

@@ -8,6 +8,8 @@ require 'pathname'
 # Deps
 # -----------------------------------------------------------------------
 require 'nrser'
+require 'nrser/refinements/types'
+require 'nrser/props/immutable/instance_variables'
 
 # Package
 # -----------------------------------------------------------------------
@@ -17,7 +19,6 @@ require 'qb/repo/git'
 # Refinements
 # =======================================================================
 
-using NRSER
 using NRSER::Types
 
 
@@ -32,7 +33,7 @@ class QB::Path < Pathname
   # Mixins
   # =====================================================================
   
-  include NRSER::Meta::Props
+  include NRSER::Props::Immutable::InstanceVariables
   
   
   # Props

data/lib/qb/repo/git.rb

@@ -17,17 +17,9 @@ require 'qb/util/resource'
 # Refinements
 # =======================================================================
 
-using NRSER
 using NRSER::Types
 
 
-# Declarations
-# =======================================================================
-
-module QB; end
-class QB::Repo < QB::Util::Resource; end
-
-
 # Definitions
 # =======================================================================
 
@@ -36,6 +28,8 @@ class QB::Repo < QB::Util::Resource; end
 # 
 # The main entry point is {QB::Repo::Git.from_path}, which creates a
 # 
+module QB
+class QB::Repo < QB::Util::Resource
 class QB::Repo::Git < QB::Repo
   autoload :User, 'qb/repo/git/user'
   autoload :GitHub, 'qb/repo/git/github'
@@ -60,78 +54,6 @@ class QB::Repo::Git < QB::Repo
   prop :is_clean,   type: t.bool,         source: :clean?
   
   
-
-  
-  
-  # class GitHubRemote < NRSER::Meta::Props::Base
-  #   SSH_URL_RE = /^git@github\.com\:(?<owner>.*)\/(?<name>.*)\.git$/
-  #   HTTPS_URL_RE = /^https:\/\/github\.com\/(?<owner>.*)\/(?<name>.*)\.git$/
-  #   
-  #   prop :owner,  type: t.str
-  #   prop :name,   type: t.str
-  #   prop :api_response, type: t.maybe(t.hash)
-  #   
-  #   prop :full_name,    type: t.str,  source: :full_name
-  #   
-  #   
-  #   # Class Methods
-  #   # =====================================================================
-  #   
-  #   # Test if a Git SSH or HTTPS remote url points to GitHub.
-  #   #
-  #   # @param [String] url
-  #   #
-  #   # @return [Boolean]
-  #   #
-  #   def self.url? url
-  #     SSH_URL_RE.match(url) || HTTPS_URL_RE.match(url)
-  #   end # .url?
-  #   
-  #   
-  #   # Instantiate an instance from a Git SSH or HTTPS remote url that points
-  #   # to GitHub.
-  #   #
-  #   # @param [type] arg_name
-  #   #   @todo Add name param description.
-  #   #
-  #   # @return [QB::Repo::Git::GitHubRemote]
-  #   #   @todo Document return value.
-  #   #
-  #   def self.from_url url, use_api: false
-  #     match = SSH_URL_RE.match(git.origin) ||
-  #             HTTPS_URL_RE.match(git.origin)
-  #             
-  #     unless match
-  #       raise ArgumentError.new NRSER.squish <<-END
-  #         url #{ url.inspect } does not match GitHub SSH or HTTPS patterns.
-  #       END
-  #     end
-  #     
-  #     owner = match['owner']
-  #     name = match['name']
-  #     
-  #     if use_api
-  #       
-  #     end
-  #   end # .from_url
-  #   
-  #   
-  #   
-  #   # @todo Document full_name method.
-  #   #
-  #   # @param [type] arg_name
-  #   #   @todo Add name param description.
-  #   #
-  #   # @return [return_type]
-  #   #   @todo Document return value.
-  #   #
-  #   def full_name arg_name
-  #     "#{ owner }/#{ name }"
-  #   end # #full_name
-  #   
-  # end
-  
-  
   # Class Methods
   # =====================================================================
   
@@ -194,7 +116,7 @@ class QB::Repo::Git < QB::Repo
       
       root_path = Pathname.new root_result.out.chomp
       
-      user = User.new **NRSER.map_values(User.props.keys) {|key, _|
+      user = User.new **User.props.keys.assoc_to { |key|
         begin
           Cmds.chomp! "git config user.#{ key }"
         rescue
@@ -340,8 +262,10 @@ class QB::Repo::Git < QB::Repo
   end
   
   
-  def api
-    @api ||= ::Git.open root_path
+  def lib
+    lazy_var :@lib do
+      ::Git.open root_path
+    end
   end
   
   
@@ -374,7 +298,7 @@ class QB::Repo::Git < QB::Repo
   
   
   def tags
-    api.tags.map &:name
+    lib.tags.map &:name
   end
   
-end # class QB::Repo::Git
+end; end; end # class QB::Repo::Git

data/lib/qb/role/default_dir.rb

@@ -70,8 +70,8 @@ class QB::Role
   # 
   def default_dir cwd, options
     logger.debug "CALLING default_dir",
-      role: self.instance_variables.map_values { |k, v|
-        self.instance_variable_get k
+      role: self.instance_variables.assoc_to { |key|
+        self.instance_variable_get key
       },
       cwd: cwd,
       options: options

data/lib/qb/role/errors.rb

@@ -1,9 +1,3 @@
-# Refinements
-# =======================================================================
-
-require 'nrser/refinements'
-using NRSER
-
 
 # Definitions
 # =======================================================================
@@ -40,8 +34,8 @@ module QB
       end
     end
     
-    # raised when there's bad metadata 
+    # raised when there's bad metadata
     class MetadataError < QB::StateError
     end
   end # Role
-end # QB
+end # QB

data/lib/qb/util.rb

@@ -1,9 +1,8 @@
-require_relative './util/stdio'
 require_relative './util/interop'
 require_relative './util/bundler'
+require_relative './util/decorators'
 
 require 'nrser'
-using NRSER
 
 module QB
   module Util

data/lib/qb/util/bundler.rb

@@ -1,56 +1,86 @@
 module QB; end
 module QB::Util; end
 
-module QB::Util::Bundler 
-  # needed for to clean the env if using bundler (like in dev).
+module QB::Util::Bundler
+  
+  # Are we running inside `bundler exec`?
   # 
-  # this is because the ansible gem module doesn't work right with the bundler
-  # env vars set, so we need to remove them, but when running in dev we want
-  # modules written in ruby like nrser.state_mate's `state` script to have
-  # access to them so it can fire up bundler and get the right libraries.
+  # @return [Boolean]
   # 
-  # to accomplish this, we detect Bundler, and when it's present we copy the
-  # bundler-related env vars (which i found by looking at 
-  # https://github.com/bundler/bundler/blob/master/lib/bundler.rb#L257)
-  # into a hash to pass around the env sanitization, then copy them into
-  # corresponding 'QB_DEV_ENV_<NAME>' vars that modules can restore.
+  def self.bundled?
+    defined? ::Bundler
+  end # .bundled?
+  
+  
+  # Wrapper around {Bundler.with_clean_env} that copies the Bundler ENV vars
+  # to other keys, allowing that Bundler ENV to be re-instated later,
+  # specifically by child processes like Ansible module scripts that inherit
+  # the ENV.
   # 
-  # we also set a 'QB_DEV_ENV=true' env var for modules to easily detect that
-  # we're running in dev and restore the variables.
+  # We execute Ansible commands in this context because any Ruby processes it
+  # starts want the system environment, not the Bundler environment that QB
+  # may be running in. In particular, Ansible's `gem` module fails if the
+  # Bundler ENV vars are still in place, which totally make sense.
+  # 
+  # Instead, we let programs that want to boot up the possibly separate
+  # environment that QB is running in (so they can require it - again,
+  # Ansible module scripts, specifically those using {QB::Ansible::Module})
+  # can load `//load/rebundle.rb`, which will restore the Bundler ENV vars
+  # (and `require 'bundler/setup'`).
+  # 
+  # We make the absolute path to `//load/rebundle.rb` available in the "clean"
+  # ENV as the `QB_REBUNDLE_PATH` var, so child Ruby programs can drop a
+  # single line at the top of the file:
+  # 
+  #     load ENV['QB_REBUNDLE_PATH'] if ENV['QB_REBUNDLE_PATH']
+  # 
+  # and be set up to require QB files.
+  # 
+  # If QB is *not* running in Bundler ({#bundled?} returns `false`) then
+  # this method simply calls `&block` and returns the value.
+  # 
+  # @param [Proc<() => RESULT>] &block
+  #   Block to execute in the "clean" env.
+  # 
+  # @return [RESULT]
+  #   Whatever `&block` returns when called.
   # 
   def self.with_clean_env &block
-    if defined? ::Bundler
-      # copy the Bundler env vars into a hash
-      dev_env = ENV.select {|k, v|
-        k.start_with?("BUNDLE_") ||
-        [
-          'GEM_HOME',
-          'GEM_PATH',
-          'MANPATH',
-          'RUBYOPT',
-          'RUBYLIB',
-        ].include?(k)
-      }
+    # If we're not running "bundled" then just call the block and return
+    return block.call unless bundled?
+  
+    # copy the Bundler env vars into a hash
+    dev_env = ENV.select {|k, v|
+      k.start_with?("BUNDLE_") ||
+      [
+        'GEM_HOME',
+        'GEM_PATH',
+        'MANPATH',
+        'RUBYOPT',
+        'RUBYLIB',
+      ].include?(k)
+    }
+    
+    qb_env = ENV.select { |k, v| k.start_with? 'QB_' }
+    
+    ::Bundler.with_clean_env do
+      # Now that we're in a clean env, copy the Bundler env vars into
+      # 'QB_BUNDLER_ENV_<NAME>' vars.
+      dev_env.each { |k, v| ENV["QB_BUNDLER_ENV_#{ k }"] = v }
+      
+      # Set the path to the `//load/rebundle.rb` script in an ENV var.
+      # 
+      # Child Ruby processes that want to load up the environment QB was run
+      # in look for this and load it if they find it, restoring the Bundler /
+      # Ruby Gems ENV vars, allowing them to `require 'qb'`, etc.
+      # 
+      ENV['QB_REBUNDLE_PATH'] = (QB::ROOT / 'load' / 'rebundle.rb').to_s
       
-      qb_env = ENV.select {|k, v| k.start_with? 'QB_'}
+      qb_env.each { |k, v| ENV[k] = v }
       
-      ::Bundler.with_clean_env do
-        # now that we're in a clean env, copy the Bundler env vars into 
-        # 'QB_DEV_ENV_<NAME>' vars.
-        dev_env.each {|k, v| ENV["QB_DEV_ENV_#{ k }"] = v}
-        
-        # set the flag that will be used by modules to know to restore the 
-        # variables
-        ENV['QB_DEV_ENV'] = 'true'
-        
-        qb_env.each {|k, v| ENV[k] = v}
-        
-        # invoke the block
-        block.call
-      end
-    else
-      # bundler isn't loaded, so no env var silliness to deal with 
+      # invoke the block
       block.call
-    end
+    end # ::Bundler.with_clean_env
   end # .with_clean_env
+  
 end # module QB::Util::Bundler

data/lib/qb/util/decorators.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Deps
+# -----------------------------------------------------------------------
+
+require 'method_decorators'
+
+
+# Definitions
+# =======================================================================
+
+# Python-style decorators using the `method_decorators` gem.
+# 
+# @see https://rubygems.org/gems/method_decorators
+# 
+# @example Usage
+#   class A
+#     extend MethodDecorators
+#     
+#     +QB::Util::Decorators::EnumFor
+#     def get_stuff
+#       yield 1
+#       yield 2
+#       yield 3
+#     end
+#     
+#   end
+#   
+#   A.new.get_stuff.class
+#   # => Enumerator
+#   
+module QB; module Util; module Decorators
+  
+  # Wrap a method that yields, returning an {Enumerator} if no block is
+  # given.
+  # 
+  # Implements the common "enum_for" pattern:
+  #   
+  #   def f
+  #     return enum_for( __method__ ) unless block_given?
+  #     yield 1
+  #     # ...
+  #   end
+  # 
+  class EnumFor < MethodDecorators::Decorator
+    # @param [Method] target
+    #   The decorated method, already bound to the receiver.
+    #   
+    #   The `method_decorators` gem calls this `orig`, but I thought `target`
+    #   made more sense.
+    # 
+    # @param [*] receiver
+    #   The object that will receive the call to `target`.
+    #   
+    #   The `method_decorators` gem calls this `this`, but I thought `receiver`
+    #   made more sense.
+    #   
+    #   It's just `target.receiver`, but the API is how it is.
+    # 
+    # @param [Array] *args
+    #   Any arguments the decorated method was called with.
+    # 
+    # @param [Proc?] &block
+    #   The block the decorated method was called with (if any).
+    # 
+    def call target, receiver, *args, &block
+      if block
+        target.call *args, &block
+      else
+        receiver.enum_for target.name, *args
+      end
+    end
+  end # EnumFor
+  
+  
+  # Don't all {NRSER::Props} arguments in last position to become keyword
+  # options.
+  # 
+  # Since {NRSER::Props} objects can be subclasses of {Hash}, etc., they can
+  # erroneously end up being considered keyword options.
+  # 
+  # This decorator prevents that. If you want to pass an {NRSER::Props} as the
+  # keywords, calling `#to_h` or something on it first should work.
+  # 
+  class NoPropsInKwds < MethodDecorators::Decorator
+    def call target, receiver, *args, &block
+      if args.last.is_a? NRSER::Props
+        target.call *args, {}, &block
+      else
+        target.call *args, &block
+      end
+    end
+  end # class NoPropsInKwds
+  
+end; end; end # module QB::Util::Decorators

data/lib/qb/util/interop.rb

@@ -1,12 +1,11 @@
-require 'nrser/refinements'
+require 'nrser'
+require 'nrser/props'
 
-using NRSER
-
-module QB 
-module Util 
+module QB
+module Util
 
 module Interop
-  include SemanticLogger::Loggable
+  include NRSER::Log::Mixin
   
   class << self
     
@@ -14,8 +13,8 @@ module Interop
       logger.debug "Starting #send_to_instance..."
       
       obj = if  data.is_a?( Hash ) &&
-                data.key?( NRSER::Meta::Props::DEFAULT_CLASS_KEY )
-        NRSER::Meta::Props.UNSAFE_load_instance_from_data data
+                data.key?( NRSER::Props::DEFAULT_CLASS_KEY )
+        NRSER::Props.UNSAFE_load_instance_from_data data
       else
         data
       end