toolshed 1.0.2 → 1.0.3

data/lib/toolshed/client.rb

@@ -1,308 +1,102 @@
+require 'singleton'
 require 'toolshed/version'
 require 'yaml'
 
 module Toolshed
+  # This is responsible for loading .toolshedrc file
   class Client
-    GITHUB_BASE_API_URL  = "https://api.github.com/"
-    PIVOTAL_TRACKER_BASE_API_URL = "https://www.pivotaltracker.com/services/v5/"
-
-    # debugging options
-    def self.debug?
-      @debug
-    end
-
-    def self.debug=(debug)
-      @debug = debug
-    end
-
-    def self.git_quiet
-      @git_quiet
-    end
-
-    def self.git_quiet=(git_quiet)
-      @git_quiet = git_quiet
-    end
-
-    def self.use_defaults
-      @use_defaults
-    end
-
-    def self.use_defaults=(use_defaults)
-      @use_defaults = use_defaults
-    end
-
-
-    # github config settings
-    def self.github_username
-      @github_username
-    end
-
-    def self.github_username=(username)
-      @github_username = username
-    end
-
-    def self.github_password
-      @github_password
-    end
-
-    def self.github_password=(password)
-      @github_password = password
-    end
-
-    def self.github_token
-      @github_token
-    end
-
-    def self.github_token=(token)
-      @github_token = token
-    end
-
-    def self.pull_from_remote_name
-      @pull_from_remote_name
-    end
-
-    def self.pull_from_remote_name=(pull_from_remote_name)
-      @pull_from_remote_name = pull_from_remote_name
-    end
-
-    def self.pull_from_repository_user
-      @pull_from_repository_user
-    end
-
-    def self.pull_from_repository_user=(pull_from_repository_user)
-      @pull_from_repository_user = pull_from_repository_user
-    end
-
-    def self.pull_from_repository_name
-      @pull_from_repository_name
-    end
-
-    def self.pull_from_repository_name=(pull_from_repository_name)
-      @pull_from_repository_name = pull_from_repository_name
-    end
-
-    def self.push_to_repository_user
-      @push_to_repository_user
-    end
-
-    def self.push_to_repository_user=(push_to_repository_user)
-      @push_to_repository_user = push_to_repository_user
-    end
-
-    def self.push_to_remote_name
-      @push_to_remote_name
-    end
-
-    def self.push_to_remote_name=(push_to_remote_name)
-      @push_to_remote_name = push_to_remote_name
-    end
-
-    def self.use_git_submodules
-      @use_git_submodules
-    end
-
-    def self.use_git_submodules=(use_git_submodules)
-      @use_git_submodules = use_git_submodules
-    end
-
-    def self.git_tool
-      (@git_tool.nil?) ? Toolshed::Git::DEFAULT_GIT_TOOL : @git_tool
-    end
-
-    def self.git_tool=(git_tool)
-      @git_tool = git_tool
-    end
-
-
-    # ticket tracking information
-
-    def self.pivotal_tracker_username
-      @pivotal_tracker_username
-    end
-
-    def self.pivotal_tracker_username=(username)
-      @pivotal_tracker_username = username
-    end
-
-    def self.pivotal_tracker_password
-      @pivotal_tracker_password
-    end
-
-    def self.pivotal_tracker_password=(password)
-      @pivotal_tracker_password = password
-    end
-
-    def self.default_pivotal_tracker_project_id
-      @default_pivotal_tracker_project_id
-    end
-
-    def self.default_pivotal_tracker_project_id=(default_pivotal_tracker_project_id)
-      @default_pivotal_tracker_project_id = default_pivotal_tracker_project_id
-    end
-
-    def self.ticket_tracker_username
-      @ticket_tracker_username
-    end
-
-    def self.ticket_tracker_username=(username)
-      @ticket_tracker_username = username
-    end
-
-    def self.ticket_tracker_password
-      @ticket_tracker_password
-    end
-
-    def self.ticket_tracker_password=(password)
-      @ticket_tracker_password = password
-    end
-
-    def self.default_ticket_tracker_project
-      @default_ticket_tracker_project
-    end
-
-    def self.default_ticket_tracker_project=(default_ticket_tracker_project)
-      @default_ticket_tracker_project = default_ticket_tracker_project
-    end
-
-    def self.ticket_tracking_tool
-      @ticket_tracking_tool
-    end
-
-    def self.ticket_tracking_tool=(ticket_tracking_tool)
-      @ticket_tracking_tool = ticket_tracking_tool
-    end
-
-    def self.ticket_tracker_owner
-      @ticket_tracker_owner
-    end
-
-    def self.ticket_tracker_owner=(owner)
-      @ticket_tracker_owner = owner
-    end
-
-    def self.ticket_status_for_complete
-      @ticket_status_for_complete
-    end
-
-    def self.ticket_status_for_complete=(status)
-      @ticket_status_for_complete = status
-    end
-
-    def self.default_pull_request_title_format
-      @default_pull_request_title_format
-    end
-
-    def self.default_pull_request_title_format=(default_pull_request_title_format)
-      @default_pull_request_title_format = default_pull_request_title_format
-    end
-
-    # time tracking configuration
-
-    def self.time_tracking_tool
-      @time_tracking_tool
-    end
-
-    def self.time_tracking_tool=(time_tracking_tool)
-      @time_tracking_tool = time_tracking_tool
-    end
-
-    def self.time_tracking_username
-      @time_tracking_username
-    end
-
-    def self.time_tracking_username=(time_tracking_username)
-      @time_tracking_username = time_tracking_username
-    end
-
-    def self.time_tracking_password
-      @time_tracking_password
-    end
-
-    def self.time_tracking_password=(time_tracking_password)
-      @time_tracking_password = time_tracking_password
-    end
-
-    def self.time_tracking_owner
-      @time_tracking_owner
-    end
-
-    def self.time_tracking_owner=(time_tracking_owner)
-      @time_tracking_owner = time_tracking_owner
-    end
-
-    def self.time_tracking_default_project_id
-      @time_tracking_default_project_id
-    end
-
-    def self.time_tracking_default_project_id=(time_tracking_default_project_id)
-      @time_tracking_default_project_id = time_tracking_default_project_id
-    end
-
-    def self.load_credentials_if_necessary
-      load_credentials unless credentials_loaded?
-    end
-
-    def self.config_path
-      ENV['TOOLSHED_CONFIG'] || '~/.toolshedrc'
-    end
+    include Singleton
+
+    attr_accessor :debug,
+                  :git_quiet,
+                  :use_defaults,
+                  :github_username,
+                  :github_password,
+                  :github_token,
+                  :use_defaults,
+                  :pull_from_repository_user,
+                  :pull_from_repository_name,
+                  :pull_from_remote_name,
+                  :push_to_repository_user,
+                  :push_to_remote_name,
+                  :use_git_submodules,
+                  :git_tool,
+                  :pivotal_tracker_username,
+                  :pivotal_tracker_password,
+                  :default_pivotal_tracker_project_id,
+                  :ticket_tracker_username,
+                  :ticket_tracker_password,
+                  :default_ticket_tracker_project,
+                  :ticket_tracking_tool,
+                  :ticket_tracker_owner,
+                  :ticket_status_for_complete,
+                  :default_pull_request_title_format,
+                  :time_tracking_tool,
+                  :time_tracking_username,
+                  :time_tracking_password,
+                  :time_tracking_owner,
+                  :time_tracking_default_project_id,
+                  :load_credentials_if_necessary,
+                  :log_path,
+                  :credentials_loaded_from
+
+    GITHUB_BASE_API_URL  = 'https://api.github.com/'
+    PIVOTAL_TRACKER_BASE_API_URL = 'https://www.pivotaltracker.com/services/v5/'
+
+    class << self
+      def config_path
+        ENV['TOOLSHED_CONFIG'] || '~/.toolshedrc'
+      end
 
-    def self.load_credentials(path = config_path)
-      credentials = Client.read_credenials(config_path)
-      self.github_username                    ||= credentials['github_username']
-      self.github_password                    ||= credentials['github_password']
-      self.github_token                       ||= credentials['github_token']
-      self.pivotal_tracker_username           ||= credentials['pivotal_tracker_username']
-      self.pivotal_tracker_password           ||= credentials['pivotal_tracker_password']
-      self.default_pivotal_tracker_project_id ||= credentials['default_pivotal_tracker_project_id']
-      self.ticket_tracker_username            ||= credentials['ticket_tracker_username']
-      self.ticket_tracker_password            ||= credentials['ticket_tracker_password']
-      self.ticket_tracker_owner               ||= credentials['ticket_tracker_owner']
-      self.ticket_status_for_complete         ||= credentials['ticket_status_for_complete']
-      self.default_ticket_tracker_project     ||= credentials['default_ticket_tracker_project']
-      self.pull_from_remote_name              ||= credentials['pull_from_remote_name']
-      self.pull_from_repository_user          ||= credentials['pull_from_repository_user']
-      self.pull_from_repository_name          ||= credentials['pull_from_repository_name']
-      self.push_to_repository_user            ||= credentials['push_to_repository_user']
-      self.push_to_remote_name                ||= credentials['push_to_remote_name']
-      self.ticket_tracking_tool               ||= credentials['ticket_tracking_tool']
-      self.use_git_submodules                 ||= credentials['use_git_submodules']
-      self.git_tool                           ||= credentials['git_tool']
-      self.time_tracking_username             ||= credentials['time_tracking_username']
-      self.time_tracking_password             ||= credentials['time_tracking_password']
-      self.time_tracking_owner                ||= credentials['time_tracking_owner']
-      self.time_tracking_default_project_id   ||= credentials['time_tracking_default_project_id']
-      self.time_tracking_tool                 ||= credentials['time_tracking_tool']
-      self.git_quiet                          ||= (credentials['git_quiet']) ? '&> /dev/null' : ''
-      self.use_defaults                       ||= credentials['use_defaults']
-      self.default_pull_request_title_format  ||= credentials['default_pull_request_title_format']
-      @credentials_loaded = true
-    end
+      def load_credentials # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        credentials = Client.read_credenials
+        instance.github_username ||= credentials['github_username']
+        instance.github_password ||= credentials['github_password']
+        instance.github_token ||= credentials['github_token']
+        instance.pivotal_tracker_username ||= credentials['pivotal_tracker_username']
+        instance.pivotal_tracker_password ||= credentials['pivotal_tracker_password']
+        instance.default_pivotal_tracker_project_id ||= credentials['default_pivotal_tracker_project_id'] # rubocop:disable Metrics/LineLength
+        instance.ticket_tracker_username ||= credentials['ticket_tracker_username']
+        instance.ticket_tracker_password ||= credentials['ticket_tracker_password']
+        instance.ticket_tracker_owner ||= credentials['ticket_tracker_owner']
+        instance.ticket_status_for_complete ||= credentials['ticket_status_for_complete']
+        instance.default_ticket_tracker_project ||= credentials['default_ticket_tracker_project'] # rubocop:disable Metrics/LineLength
+        instance.pull_from_remote_name ||= credentials['pull_from_remote_name']
+        instance.pull_from_repository_user ||= credentials['pull_from_repository_user']
+        instance.pull_from_repository_name ||= credentials['pull_from_repository_name']
+        instance.push_to_repository_user ||= credentials['push_to_repository_user']
+        instance.push_to_remote_name ||= credentials['push_to_remote_name']
+        instance.ticket_tracking_tool ||= credentials['ticket_tracking_tool'] # rubocop:disable Metrics/LineLength
+        instance.use_git_submodules ||= credentials['use_git_submodules']
+        instance.git_tool ||= credentials['git_tool']
+        instance.time_tracking_username ||= credentials['time_tracking_username']
+        instance.time_tracking_password ||= credentials['time_tracking_password']
+        instance.time_tracking_owner ||= credentials['time_tracking_owner']
+        instance.time_tracking_default_project_id ||= credentials['time_tracking_default_project_id'] # rubocop:disable Metrics/LineLength
+        instance.time_tracking_tool ||= credentials['time_tracking_tool']
+        instance.git_quiet ||= (credentials['git_quiet']) ? '&> /dev/null' : ''
+        instance.use_defaults ||= credentials['use_defaults']
+        instance.default_pull_request_title_format ||= credentials['default_pull_request_title_format'] # rubocop:disable Metrics/LineLength
+        instance.log_path ||= credentials['log_path']
+        instance.credentials_loaded_from ||= load_credentials_from
+      end
 
-    def self.credentials_loaded?
-      (@credentials_loaded ||= false)
-    end
+      def read_credenials
+        YAML.load_file(File.expand_path(load_credentials_from))
+      end
 
-    def self.read_credenials(path = Client.config_path)
-      begin
+      def load_credentials_from
         dir = Dir.pwd
-        while File.expand_path(dir) != '/' do
-          if (File.exists? "#{dir}/.toolshedrc")
-            loaded_from_path = "#{dir}/.toolshedrc"
-            break
-          elsif (File.exists? "#{dir}/.toolshed")
-            loaded_from_path = "#{dir}/.toolshed"
-            warn "[DEPRECATION] `.toolshed` file is being deprecated.  Please use a `.toolshedrc` file instead."
-            break
+        while File.expand_path(dir) != '/'
+          unless File.exist?("#{dir}/.toolshedrc")
+            dir = File.join dir, '..'
+            next
           end
-
-          dir = File.join dir, '..'
+          credentials_loaded_from = "#{dir}/.toolshedrc"
+          break
         end
 
-        puts "Credentials loaded from #{File.absolute_path(loaded_from_path)}"
-        credentials = YAML.load_file(File.expand_path(loaded_from_path))
-      rescue => error
-        puts "Error loading your credentials: #{error.message}"
-        exit 1
+        credentials_loaded_from
       end
     end
   end

data/lib/toolshed/commands/base.rb

@@ -1,66 +1,108 @@
+require 'toolshed/cli'
+require 'optparse'
+
 module Toolshed
   module Commands
+    # Base class for all commands responsible for common methods
     class Base
-      def initialize(options={})
+      def initialize(_options = {})
+      end
+
+      def self.parse(command, cli_options = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength, Metrics/CyclomaticComplexity
+        options = {}
+        options_parser = OptionParser.new do |opts|
+          opts.banner = cli_options[:banner] if cli_options[:banner]
+          cli_options[:options].each do |option_name, option_variables|
+            letter_map = ('a'..'z').map { |letter| letter }
+            short_on = (option_variables[:short_on]) ? option_variables[:short_on] : letter_map[rand(letter_map.length)] # rubocop:disable Metrics/LineLength
+            on = (option_variables[:on]) ? option_variables[:on] : "--#{option_name.to_s.split('_').join('-')} [ARG]" # rubocop:disable Metrics/LineLength
+            opts.on(short_on, on) do |opt|
+              value = (option_variables[:default].nil?) ? opt : option_variables[:default]
+              options.merge!(option_name => value)
+            end
+          end
+        end
+        options_parser.order! if options_parser
+        begin
+          cli = Toolshed::CLI.new
+          cli.execute(command, ARGV, options)
+        rescue Toolshed::CommandNotFound => e
+          Toolshed.logger.fatal e.message
+          Toolshed.die
+        end
       end
 
-      def read_user_input(message, options={})
-        return options[:default] if Toolshed::Client.use_defaults
-        prompt_user_input(message, options)
+      def read_user_input(message, options = {})
+        return options[:default] if Toolshed::Client.instance.use_defaults
+        required = options[:required] || false
+        value = ''
+        if required
+          value = prompt_user_input(message, options) while value.empty?
+        else
+          value = prompt_user_input(message, options)
+        end
+        value
       end
 
-      def read_user_input_title(message, options={})
-        return options[:title] if options.has_key?(:title)
+      def read_user_input_title(message, options = {})
+        return options[:title] if options.key?(:title)
         read_user_input(message, options)
       end
 
-      def read_user_input_body(message, options={})
-        return options[:body] if options.has_key?(:body)
+      def read_user_input_body(message, options = {})
+        return options[:body] if options.key?(:body)
         read_user_input(message, options)
       end
 
       def use_ticket_tracker_project_id(options)
-        options
-        options.merge!({
+        options.merge!(
           ticket_tracker_const: 'USE_PROJECT_ID',
           type: :project_id,
           default_method: 'default_pivotal_tracker_project_id',
-          default_message: "Project ID (Default: #{Toolshed::Client.default_pivotal_tracker_project_id}):",
-        })
-        options = use_ticket_tracker_by_type(options)
+          default_message: "Project ID (Default: #{Toolshed::Client.instance.default_pivotal_tracker_project_id}):" # rubocop:disable Metrics/LineLength
+        )
+        use_ticket_tracker_by_type(options)
       end
 
       def use_ticket_tracker_project_name(options)
-        options.merge!({
+        options.merge!(
           ticket_tracker_const: 'USE_PROJECT_NAME',
           type: :project,
           default_method: 'default_ticket_tracker_project',
-          default_message: "Project Name (Default: #{Toolshed::Client.default_ticket_tracker_project}):",
-        })
+          default_message: "Project Name (Default: #{Toolshed::Client.instance.default_ticket_tracker_project}):" # rubocop:disable Metrics/LineLength
+        )
         use_ticket_tracker_by_type(options)
       end
 
       def use_ticket_tracker_by_type(options)
-        use_field = Object.const_get("#{ticket_tracker_class}::#{options[:ticket_tracker_const]}") rescue false
+        use_field = Object.const_get("#{ticket_tracker_class}::#{options[:ticket_tracker_const]}") rescue false # rubocop:disable Metrics/LineLength, Style/RescueModifier
         if use_field
-          ticket_tracker_response = read_user_input(options[:default_message],
-            options.merge!({ default: Toolshed::Client.send(options[:default_method]) })
+          ticket_tracker_response = read_user_input(
+            options[:default_message],
+            options.merge!(
+              default: Toolshed::Client.instance.send(options[:default_method])
+            )
           )
-          options.merge!({ options[:type] => ticket_tracker_response })
+          options.merge!(options[:type] => ticket_tracker_response)
         end
         options
       end
 
       def use_project_id
-        Object.const_get("#{ticket_tracker_class}::USE_PROJECT_ID") rescue false
+        Object.const_get("#{ticket_tracker_class}::USE_PROJECT_ID") rescue false # rubocop:disable Style/RescueModifier, Metrics/LineLength
       end
 
       private
 
-        def prompt_user_input(message, options)
+        def prompt_user_input(message, options) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+          required = options[:required] || false
           puts message
           value = $stdin.gets.chomp
-          value.empty? ? options[:default] : value
+          if required && value.nil? || value.empty?
+            puts 'Value is required please try again.'
+            return value
+          end
+          (value.nil? || value.empty?) ? options[:default] : value
         end
     end
   end