gas 0.1.8 → 1.0.0

data/bin/gas

@@ -1,53 +1,88 @@
 #!/usr/bin/env ruby
 
-require 'thor'
-require 'gas'
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib/')
 
-class GasRunner < Thor
+require 'fileutils'
 
-  default_task :list
+# Migrates old files to the new file structure
+# @depricated in version 2.0.0
+def migrate_to_new_file_structure!
+  gas_directory = File.expand_path '~/.gas'
+  old_gas_users_filename = 'gas.authors'
+  gas_users_filename = 'users'
 
-  desc "list", "Lists your authors"
-  def list
-    Gas.list
-  end
+  oldest_config_file = File.expand_path '~/.gas'
+  old_config_file = File.join gas_directory, old_gas_users_filename
+  new_config_file = File.join gas_directory, gas_users_filename
 
-  desc "show", "Shows your current user"
-  def show
-    Gas.show
-  end
+  # Check for first structure
+  if File.file? oldest_config_file
+    contents = File.read oldest_config_file
 
-  desc "use AUTHOR", "Uses author"
-  def use(nickname)
-    Gas.use nickname
-  end
+    File.delete oldest_config_file
+    Dir::mkdir(gas_directory)
 
-  desc "add NICKNAME NAME EMAIL", "Adds author to gasconfig"
-  def add(nickname, name, email)
-    Gas.add nickname, name, email
+    file = File.new(old_config_file, "w")
+    file.puts contents
+    file.close
   end
 
-  desc "import NICKNAME", "Imports current user to gasconfig"
-  def import(nickname)
-    Gas.import nickname
+  # Check for second structure
+  if File.file? old_config_file
+    FileUtils.mv old_config_file, File.join(gas_directory, gas_users_filename)
   end
+end
 
-  desc "delete AUTHOR", "Deletes author"
-  def delete(nickname)
-    Gas.delete nickname
-  end
-  
-  desc "ssh", "Creates a new ssh key for an existing gas author"
-  def ssh(nickname=nil)
-    Gas.ssh nickname
+migrate_to_new_file_structure! # Run migrate to ensure the latest file structure is used
+
+require 'gas'
+
+# Cross-platform way of finding an executable in the $PATH.
+def which(cmd)
+  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+    exts.each { |ext|
+      exe = "#{path}/#{cmd}#{ext}"
+      return exe if File.executable? exe
+    }
   end
+  return nil
+end
 
-  desc "version", "Prints Gas's version"
-  def version
-    Gas.version
+# List all gas commands available
+def plugins
+  plugins = []
+  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+    Dir.glob("#{path}/gas-*").each do |cmd|
+      plugins << cmd.split('/').last.scan(/gas-([^-]+).*/).flatten.first
+    end
   end
-  map %w(-v --version) => :version
+  return plugins
+end
+
+arguments = ARGV
+command = arguments.shift
+command = 'list' if command.nil?
 
+if command == 'version' || command == '-v' || command == '--version'
+  Gas.print_version
+  exit 0
+elsif command == 'plugins'
+  puts plugins
+  exit 0
 end
 
-GasRunner.start
+bin = "gas-#{command}"
+
+if which(bin)
+  system "#{bin} #{arguments.join(' ')}"
+
+  plugins.each do |plugin|
+    plugin_bin = "gas-#{plugin}-#{command}"
+    if which(plugin_bin)
+      system "#{plugin_bin} #{arguments.join(' ')}"
+    end
+  end
+else
+  Gas.print_usage
+end

data/bin/gas-add

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib/')
+require 'gas'
+
+Gas.check_parameters 3, 'Usage: gas add NICKNAME NAME EMAIL'
+Gas.add ARGV[0], ARGV[1], ARGV[2]

data/bin/gas-delete

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib/')
+require 'gas'
+
+Gas.check_parameters 1, 'Usage: gas delete NICKNAME'
+Gas.delete ARGV[0]

data/bin/gas-import

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib/')
+require 'gas'
+
+Gas.check_parameters 1, 'Usage: gas import NICKNAME'
+Gas.import ARGV[0]

data/bin/gas-list

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib/')
+require 'gas'
+
+Gas.list

data/bin/gas-show

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib/')
+require 'gas'
+
+Gas.show

data/bin/gas-use

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib/')
+require 'gas'
+
+Gas.check_parameters 1, 'Usage: gas use NICKNAME'
+Gas.use ARGV[0]

data/lib/gas.rb

@@ -1,40 +1,66 @@
-require 'rbconfig'
+require 'gas/version'
+require 'gas/user'
+require 'gas/users'
+require 'gas/git_config'
 
-GAS_DIRECTORY = "#{ENV['HOME']}/.gas" # File.expand_path('~/.gas')
-SSH_DIRECTORY = "#{ENV['HOME']}/.ssh" # File.expand_path('~/.ssh')
-GITHUB_SERVER = 'api.github.com'
-IS_WINDOWS = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
+GAS_DIRECTORY = File.expand_path '~/.gas'
+OLD_GAS_USERS_FILENAME = 'gas.authors'
+GAS_USERS_FILENAME = 'users'
 
+module Gas
 
-require 'sshkey' #external
+  @users = Users.new(File.join GAS_DIRECTORY, GAS_USERS_FILENAME)
 
-require 'gas/version'
-require 'gas/prompter'
-require 'gas/ssh'
-require 'gas/user'
-require 'gas/config'
-require 'gas/gitconfig'
-require 'gas/settings'
-require 'gas/github_speaker'
+  # Print version information to stdout
+  def self.print_version
+    puts Gas::VERSION
+  end
 
+  # Print usage information to stdout
+  def self.print_usage
+    puts "Usage: command [parameters]\n\nBuilt-in commands:\n   add NICKNAME NAME EMAIL - adds a new user to gas\n   delete NICKNAME - deletes a user from gas\n   import NICKNAME - imports the user from .gitconfig into NICKNAME\n   list - lists all users\n   show - shows the current user\n use NICKNAME - sets the user with NICKNAME as the current user"
+  end
 
-module Gas
+  # Checks the number of parameters and exits with a message if wrong number of parameters is supplied
+  # @param [Integer] number_of_parameters_required
+  # @param [String] message
+  def self.check_parameters(number_of_parameters_required, message)
+    unless ARGV.length == number_of_parameters_required
+      puts message
+      exit
+    end
+  end
+
+  # Checks if the user exists and gives error and exit if not
+  # @param [String] nickname
+  def self.check_if_user_does_not_exist(nickname)
+    if !users.exists? nickname
+      puts "Nickname #{nickname} does not exist"
+      exit
+    end
+  end
 
-  @config = Config.new
-  @gitconfig = Gitconfig.new
+  # Checks if the user exists and gives error and exit if so
+  # @param [String] nickname
+  def self.check_if_user_already_exists(nickname)
+    if users.exists? nickname
+      puts "Nickname #{nickname} already exists"
+      exit
+    end
+  end
 
   # Lists all authors
   def self.list
     puts
     puts 'Available users:'
     puts
-    puts @config
+    puts users
     puts
   end
 
   # Shows the current user
   def self.show
-    user = @gitconfig.current_user
+    user = GitConfig.current_user
 
     if user
       puts 'Current user:'
@@ -47,11 +73,10 @@ module Gas
   # Sets _nickname_ as current user
   # @param [String] nickname The nickname to use
   def self.use(nickname)
-    return false unless self.no_user?(nickname)
-    user = @config[nickname]
-
-    @gitconfig.change_user user        # daring change made here!  Heads up Walle
+    check_if_user_does_not_exist(nickname)
 
+    user = users.get nickname
+    GitConfig.change_user user
     self.show
   end
 
@@ -59,69 +84,31 @@ module Gas
   # @param [String] nickname The nickname of the author
   # @param [String] name The name of the author
   # @param [String] email The email of the author
-  def self.add(nickname, name, email, github_speaker = nil)
-    return false if self.has_user?(nickname)
-    user = User.new name, email, nickname
-    @config.add user
-    @config.save!
+  def self.add(nickname, name, email)
+    check_if_user_already_exists(nickname)
 
-    using_ssh = Ssh.setup_ssh_keys user
-    
-    Ssh.upload_public_key_to_github(user, github_speaker) if using_ssh
+    user = User.new name, email, nickname
+    users.add user
+    users.save!
 
     puts 'Added new author'
     puts user
   end
 
-
-  # Adds an ssh key for the specified user
-  def self.ssh(nickname)
-    if nickname.nil?
-      puts "Oh, so you'd like an elaborate explanation on how ssh key juggling works?  Well pull up a chair!"
-      puts
-      puts "Gas can juggle ssh keys for you.  It works best in a unix based environment (so at least use git bash or cygwin on a windows platform)."
-      puts "You will be prompted if you would like to handle SSH keys when you create a new user."
-      puts "If you are a long time user of gas, you can add ssh to an author by the command..."
-      puts "\$  gas ssh NICKNAME"
-      puts
-      puts "Your ssh keys will be stored in ~/.gas/NICKNAME_id_rsa and automatically copied to ~/.ssh/id_rsa when you use the command..."
-      puts "\$  gas use NICKNAME"
-      puts "If ~/.ssh/id_rsa already exists, you will be prompted UNLESS that rsa file is already backed up in the .gas directory (I'm so sneaky, huh?)"
-      puts
-      puts "The unix command ssh-add is used in order to link up your rsa keys when you attempt to make an ssh connection (git push uses ssh keys of course)"
-      puts
-      puts "The ssh feature of gas offers you and the world ease of use, and even marginally enhanced privacy against corporate databases.  Did you know that IBM built one of the first automated database systems?  These ancient database machines (called tabulators) were used to facilitate the holocaust =("
-    else
-      user = @config[nickname]
-
-
-      # Prompt Remake this user's ssh keys?
-
-      # check for ssh keys
-      if !Ssh.corresponding_rsa_files_exist?(nickname)
-        Ssh.setup_ssh_keys user
-        Ssh.upload_public_key_to_github user
-      else
-        Ssh.setup_ssh_keys user
-        Ssh.upload_public_key_to_github user
-      end
-    end
-  end
-
-
   # Imports current user from .gitconfig to .gas
   # @param [String] nickname The nickname to give to the new user
   def self.import(nickname)
-    return false if self.has_user?(nickname)
-    user = @gitconfig.current_user
+    check_if_user_already_exists(nickname)
+
+    user = GitConfig.current_user
 
     if user
       user = User.new user.name, user.email, nickname
 
-      @config.add user
-      @config.save!
+      users.add user
+      users.save!
 
-      puts 'Added author'
+      puts 'Imported author'
       puts user
     else
       puts 'No current user to import'
@@ -131,41 +118,18 @@ module Gas
   # Deletes an author from the config using nickname
   # @param [String] nickname The nickname of the author
   def self.delete(nickname)
+    check_if_user_does_not_exist(nickname)
 
-    return false unless self.no_user? nickname        # I re-engineered this section so I could use Gas.delete in a test even when that author didn't exist
-                                                      # TODO: The name no_user? is now very confusing.  It should be changed to something like "user_exists?" now maybe?
-    Ssh.delete nickname
-
-    @config.delete nickname
-    @config.save!
+    users.delete nickname
+    users.save!
 
     puts "Deleted author #{nickname}"
     return true
   end
 
-  # Prints the current version
-  def self.version
-    puts Gas::VERSION
+  # Returns the users object so we don't use it directly
+  # @return [Gas::Users]
+  def self.users
+    @users
   end
-
-  # Checks if the user exists and gives error and exit if not
-  # @param [String] nickname
-  def self.no_user?(nickname)
-    if !@config.exists? nickname
-      puts "Nickname #{nickname} does not exist"
-      return false
-    end
-    return true
-  end
-
-  # Checks if the user exists and gives error and exit if so
-  # @param [String] nickname
-  def self.has_user?(nickname)
-    if @config.exists? nickname
-      puts "Nickname #{nickname} already exists"
-      return true
-    end
-    return false
-  end
-
-end
+end

data/lib/gas/git_config.rb

@@ -0,0 +1,25 @@
+module Gas
+
+  # Module that class that interacts with the git config
+  module GitConfig
+
+    # Parse out the current user from the gitconfig
+    # @param [String] gitconfig The git configuration
+    # @return [Gas::User] The current user or nil if not present
+    def self.current_user
+      name = `git config --global --get user.name`
+      email = `git config --global --get user.email`
+
+      return nil if name.nil? && email.nil?
+
+      User.new name.delete("\n"), email.delete("\n")   # git cli returns the name and email with \n at the end
+    end
+
+    # Changes the user
+    # @param [Gas::User] user The new user
+    def self.change_user(user)
+      `git config --global user.name "#{user.name}"`
+      `git config --global user.email "#{user.email}"`
+    end
+  end
+end

data/lib/gas/user.rb

@@ -4,7 +4,6 @@ module Gas
   class User
     attr_reader :name, :email, :nickname
 
-
     # @param [String] name The name of the user
     # @param [String] email The email of the user
     # @param [String] nickname A nickname for the user, not used when parsing from gitconfig
@@ -12,7 +11,6 @@ module Gas
       @name = name
       @email = email
       @nickname = nickname
-
     end
 
     # Returns the git format of user
@@ -28,6 +26,15 @@ module Gas
       "      [#{use_nickname ? @nickname : 'user'}]\n         name = #{@name}\n         email = #{@email}"
     end
 
-
+    # Define the equality operator to test if two user objects are the same
+    # @param [Object] the object to test against
+    # @return [boolean]
+    def ==(user)
+      return false unless user.is_a? User
+      unless nickname.empty? || user.nickname.empty? # Don't test equallity in nickname if any of the nicknames is not used
+        return false unless nickname == user.nickname
+      end
+      return (name == user.name && email == user.email)
+    end
   end
-end
+end