qb 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58d2c1fbf4d57fdd1b607cf1c8716104b61a9909
-  data.tar.gz: 0b845dc2f323e3fb3e0f00a006af1f04f5d1a6a9
+  metadata.gz: aecaf8f95cd10cc55b8193bc77ffff7fd0d1010e
+  data.tar.gz: eb52aa099c5e8b7fa1131799cbf536a5b3b20783
 SHA512:
-  metadata.gz: b3491012bb23264bc31f2f7c52f655f9b4a5a30e26c5efcaca05ed83f8240bad2402e8b1d14700be7433a30f14bbd2b990997b9b0a960b2244803117ac972f29
-  data.tar.gz: 2386308ce3bb76e0eea32a7dc6f6f9ca44c85d9cf90ef035b86e8cb3bd4f638d7b0bdf8b01e7653d601c775df4ffa73081fa8c6f27652754a65319b5a8fd2413
+  metadata.gz: 6e6a2772f752a0118d218cb84c31f220d3f3ccbe6dc09da03052c9a381a33fba2bb1532e23f73d70cf4f6fd0b8e64f61512ce779ec9c7ea99e5aa47a81d1ee40
+  data.tar.gz: d31d2a6d530cca5f201a0a366590110966dcef054195529cde8b56a44aece10220f4d55da9c803e54dd42f2a19f28b46c39ea2f59ba81b54779ff1a7ef3c7099

data/exe/qb

@@ -10,6 +10,13 @@ require 'cmds'
 
 require 'qb'
 
+require 'nrser/refinements'
+using NRSER
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
 # constants
 # =========
 
@@ -98,7 +105,21 @@ def main args
       # 
       # in some cases (like projects) the dir can be figured out in other ways:
       # 
-      role.default_dir cwd, options.role_options
+      
+      if options.ask?
+        default = begin
+          role.default_dir cwd, options.role_options
+        rescue QB::UserInputError => e
+          NRSER::NO_ARG
+        end
+        
+        QB::CLI.ask name: "target directory (`qb_dir`)",
+                    type: t.non_empty_str,
+                    default: default
+        
+      else
+        role.default_dir cwd, options.role_options
+      end
       
     when 1
       # there is a single positional arg, which is used as dir
@@ -159,6 +180,23 @@ def main args
     end
   end # unless default_dir == false
   
+  
+  # Interactive Input
+  # =====================================================================
+  
+  if options.ask?
+    # Incomplete
+    raise "COMING SOON!!!...?"
+    QB::CLI.ask_for_options role: role, options: options
+  end
+  
+  
+  # Validation
+  # =====================================================================
+  # 
+  # Should have already been taken care of if we used interactive input.
+  # 
+  
   # check that required options are present
   missing = options.role_options.values.select {|option|
     option.required? && option.value.nil?

data/lib/qb/cli.rb

@@ -1,4 +1,107 @@
+require 'nrser/refinements'
+using NRSER
+
+
 module QB; end
-module QB::CLI; end 
+module QB::CLI
+  
+  # Eigenclass (Singleton Class)
+  # ========================================================================
+  # 
+  class << self
+    
+    
+    # @todo Document ask method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def ask name:,
+            description: nil,
+            type:,
+            default: NRSER::NO_ARG
+      puts
+        
+      value = loop do
+        
+        puts "Enter value for #{ name }"
+        
+        if description
+          puts description.indent
+        end
+        
+        puts "TYPE #{ type.to_s }".indent
+        
+        if default
+          puts "DEFAULT #{ default.to_s }".indent
+        end
+        
+        $stdout.write '> '
+        
+        value = gets.chomp
+        
+        QB.debug "User input", value
+        
+        if value == '' && default != NRSER::NO_ARG
+          puts <<-END.dedent
+            
+            Using default value #{ default.to_s }
+            
+          END
+          
+          return default
+        end
+        
+        begin
+          type.from_s value
+        rescue TypeError => e
+          puts <<-END.dedent
+            Input value #{ value.inspect } failed to satisfy type
+            
+                #{ type.to_s }
+            
+          END
+        else
+          break value
+        end
+        
+      end # loop
+      
+      puts "Using value #{ value.inspect }"
+      
+      return value
+      
+    end # #ask
+    
+    
+    def ask_for_option role:, option:
+      default = if role.defaults.key?(option.var_name)
+        role.defaults[option.var_name]
+      elsif option.required?
+        NRSER::NO_ARG
+      else
+        nil
+      end
+      
+      ask name: option.name,
+          description: option.description,
+          default: default
+          # type: 
+    end
+    
+    
+    def ask_for_options role:, options:
+      options.select { |opt| opt.value.nil? }.each { |option|
+        ask_for_option role: role, option: option
+      }
+    end # #ask_for_options
+    
+    
+  end # class << self (Eigenclass)
+  
+end 
 
 require_relative './cli/play'

data/lib/qb/errors.rb

@@ -2,8 +2,20 @@ module QB
   # Base class for QB errors.
   class Error < StandardError; end
   
+  
+  # State Errors
+  # =====================================================================
+  # 
+  # Raised when something - a role, the file system, etc. - is in a state 
+  # that we can't deal with.
+  # 
+  
+  # Raised when something is in a bad state and no more specific error 
+  # subclass applies.
+  class StateError < Error; end
+  
   # Raised when a version mismatch occurs.
-  class VersionError < Error; end
+  class VersionError < StateError; end
   
   # Raised when the current Ansible version doesn't satisfy:
   # 
@@ -19,5 +31,16 @@ module QB
   
   # Raised when the file system is in a state that doesn't work for what we're
   # trying to do.
-  class FSStateError < Error; end
+  class FSStateError < StateError; end
+  
+  
+  # User Input Errors
+  # =====================================================================
+  # 
+  # Raised when we got bad user input.
+  # 
+  
+  # Raised when we got bad user input and no more specific error applies.
+  class UserInputError < Error; end
+  
 end # module QB

data/lib/qb/options.rb

@@ -19,6 +19,7 @@ module QB
       'print' => ['cmd'],
       'verbose' => false,
       'run' => true,
+      'ask' => false,
     }
     
     # appended on the end of an `opts.on` call to create a newline after
@@ -310,10 +311,27 @@ module QB
     def initialize role, argv
       @role = role
       @argv = argv
+      @qb = QB_DEFAULTS.clone
       
       parse!
     end
     
+    
+    
+    # @todo Document ask? method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def ask?
+      @qb['ask']
+    end # #ask?
+    
+    
+    
     private
     # =======================================================================
     
@@ -324,8 +342,6 @@ module QB
       
       @role_options = {}
       
-      @qb = QB_DEFAULTS.clone
-      
       if @role.meta['default_user']
         @qb['user'] = @role.meta['default_user']
       end
@@ -426,6 +442,21 @@ module QB
           @qb['run'] = false
         end
         
+        opts.on(
+          '-A',
+          '--ASK',
+          "interactively ask for argument and option values",
+          SPACER
+        ) do |value|
+          if value && !$stdin.isatty
+            raise ArgumentError.squished <<-END
+              Interactive args & options only works with TTY $stdin.
+            END
+          end
+          
+          @qb['ask'] = value
+        end
+        
         self.class.add opts, @role_options, @role
         
         opts.on_tail("-h", "--help", "Show this message") do

data/lib/qb/options/option.rb

@@ -108,6 +108,7 @@ module QB
         if value.is_a? String then [value] else value end
       end
       
+      
       private
       
       # get the value at the first found of the keys or the default.

data/lib/qb/role.rb

@@ -1,10 +1,11 @@
 require 'yaml'
 require 'cmds'
 require 'parseconfig'
-require 'nrser/refinements'
 
 require_relative 'role/errors'
 
+require 'nrser/refinements'
+
 using NRSER
 
 module QB
@@ -373,6 +374,7 @@ module QB
       end
     end
     
+    
     # the path we display in the CLI, see {#display_path}.
     # 
     # @param [Pathname | String] path
@@ -390,6 +392,25 @@ module QB
     end
     
     
+    def self.guess_role_name dest
+      path = QB::Util.resolve dest
+      
+      search_dirs = search_path.find_all { |pathname|
+        path.fnmatch? pathname.join('**')
+      }
+      
+      case search_dirs.length
+      when 0
+        # It's not in any of the search directories
+        # 
+        # If it has 'roles' as a segment than use what's after that
+        # 
+        split = path.to_s.split('/roles/')
+        
+      end
+    end
+    
+    
     # Attributes
     # =======================================================================
     
@@ -469,10 +490,6 @@ module QB
     # Instance Methods
     # =====================================================================
     
-    def to_s
-      @display_path.to_s
-    end
-    
     def namespace
       *namespace_segments, last = @name.split File::Separator
       
@@ -698,7 +715,7 @@ module QB
       case value
       when nil
         # there is no get_dir info in meta/qb.yml, can't get the dir
-        raise <<-END.dedent
+        raise QB::UserInputError.dedented <<-END
           unable to infer default directory: no '#{ key }' key in 'meta/qb.yml'
           for role #{ self }
         END
@@ -706,7 +723,9 @@ module QB
       when false
         # this method should not get called when the value is false (an entire
         # section is skipped in exe/qb when `default_dir = false`)
-        raise "role does not use default directory (meta/qb.yml:default_dir = false)"
+        raise QB::StateError.squished <<-END
+          role does not use default directory (meta/qb.yml:default_dir = false)
+        END
       
       when 'git_root'
         QB.debug "returning the git root relative to cwd"
@@ -761,7 +780,9 @@ module QB
           QB::Util.find_up filename
           
         else
-          raise "bad key: #{ hash_key } in #{ self.meta_path.to_s }:default_dir"
+          raise QB::Role::MetadataError.squised <<-END
+            bad key: #{ hash_key } in #{ self.meta_path.to_s }:default_dir
+          END
           
         end
       end
@@ -798,28 +819,39 @@ module QB
       path.realpath.hash
     end
     
+    
     def == other
       other.is_a?(Role) && other.path.realpath == path.realpath
     end
     
     alias_method :eql?, :==
     
+    # @return [String]
+    #   {QB::Role#display_path}
+    # 
+    def to_s
+      @display_path.to_s
+    end
+    
+    
     private
     # -----------------------------------------------------------------------
     
-    # get the value at the first found of the keys or the default.
-    # 
-    # `nil` (`null` in yaml files) are treated like they're not there at
-    # all. you need to use `false` if you want to tell QB not to do something.
-    # 
-    def meta_or keys, default
-      keys = [keys] if keys.is_a? String
-      keys.each do |key|
-        if meta.key?(key) && !meta[key].nil?
-          return meta[key]
+      # get the value at the first found of the keys or the default.
+      # 
+      # `nil` (`null` in yaml files) are treated like they're not there at
+      # all. you need to use `false` if you want to tell QB not to do something.
+      # 
+      def meta_or keys, default
+        keys = [keys] if keys.is_a? String
+        keys.each do |key|
+          if meta.key?(key) && !meta[key].nil?
+            return meta[key]
+          end
         end
-      end
-      default
-    end # meta_or
+        default
+      end # meta_or
+      
+    # end private
   end # Role
 end # QB

data/lib/qb/role/errors.rb

@@ -1,7 +1,7 @@
 module QB
   class Role
     # raised by `.require` when no roles match input
-    class NoMatchesError < QB::Error
+    class NoMatchesError < QB::UserInputError
       attr_accessor :input
       
       def initialize input
@@ -12,7 +12,7 @@ module QB
     end
     
     # raised by `.require` when multiple roles match
-    class MultipleMatchesError < QB::Error
+    class MultipleMatchesError < QB::UserInputError
       attr_accessor :input, :matches
       
       def initialize input, matches
@@ -33,7 +33,7 @@ END
     end
     
     # raised when there's bad metadata 
-    class MetadataError < QB::Error
+    class MetadataError < QB::StateError
     end
   end # Role
 end # QB