confinicky 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 810dc913005260bb414ed9c84763ddcf8e561007
-  data.tar.gz: 4484a749864bcd14c413268cf145fd86c8b816f4
+  metadata.gz: 52e95dfcb20d5391899a9c04733f21b0b948fb7b
+  data.tar.gz: d4c2cba419829d5c87704dcd99a4b950024cd132
 SHA512:
-  metadata.gz: c4c68cf8114e165ebe6c694e5c2faa4077396dbbc26fa64f3369b034cbb61dcd3c678e540c24b21d3910fa47e1a6165c4190a19bf2b87e9d756c6538da35a3c9
-  data.tar.gz: bde297945fc154d22f1b51661bde4946417f3f25531899f5384f9e8be9de309421976fb17c1e524d2b9ce05348f08131ef3e5c1467073fc30943567841fdb90b
+  metadata.gz: e3923507641c3767fe97f20cb853eec13b1c36539b6046e7e32126186612e9029672ea088704e9489c48f3d843cfe82fad2ed21c2834f941fbdb69ab4f3f2b2c
+  data.tar.gz: 33e5fb03f7fc9ebc07b1f0e7cb814b266d3498453707cfcff16181c0e6e6d554465da1a9fa4a5293e528fa09ee4fd4bdcdc12b922e156dda551de1d7f8e4f5d4

data/README.md

@@ -2,7 +2,7 @@
 
 A simple CLI to manage your environment variables.
 
-Run `conficky --help` for a current list of useable commands.
+Run `cfy --help` for a current list of useable commands.
 
 ## Setup Confinicky
 
@@ -58,7 +58,7 @@ You can easily add or adjust an environment variable using `cfy remove` or `cfy
 ```
 → cfy remove MY_VAR
 Successfully removed 'MY_VAR'.
-Run 'source /Users/jim/bin/dotfiles/bash/env' or open a new terminal/shell window.
+Open a new terminal/shell window for this change to take affect.
 ```
 
 ## Detecting Duplicate Exports

data/confinicky.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: confinicky 0.1.6 ruby lib
+# stub: confinicky 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "confinicky"
-  s.version = "0.1.6"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Jim Jeffers"]
-  s.date = "2014-08-11"
+  s.date = "2014-08-24"
   s.description = "A simple CLI to manage environment variables on your local machine. Perform basic CRUD for your environment variables all in the command line."
   s.email = "jim@sumocreations.com"
   s.executables = ["cfy"]
@@ -33,17 +33,25 @@ Gem::Specification.new do |s|
     "lib/confinicky/commands.rb",
     "lib/confinicky/commands/clean.rb",
     "lib/confinicky/commands/duplicates.rb",
+    "lib/confinicky/commands/inspect.rb",
     "lib/confinicky/commands/list.rb",
     "lib/confinicky/commands/remove.rb",
     "lib/confinicky/commands/set.rb",
-    "lib/confinicky/commands/use.rb",
+    "lib/confinicky/commands/setup.rb",
     "lib/confinicky/config.rb",
+    "lib/confinicky/configuration_file.rb",
+    "lib/confinicky/controllers/aliases.rb",
+    "lib/confinicky/controllers/commands.rb",
+    "lib/confinicky/controllers/exports.rb",
+    "lib/confinicky/parsers/command.rb",
+    "lib/confinicky/parsers/expression.rb",
     "lib/confinicky/shell_file.rb",
     "lib/confinicky/version.rb",
     "test/helper.rb",
     "test/sample_bash_file.sh",
-    "test/test_confinicky.rb",
-    "test/test_file_writing.rb"
+    "test/test_command_parser.rb",
+    "test/test_controllers.rb",
+    "test/test_shell_file_parsing.rb"
   ]
   s.homepage = "http://github.com/jimjeffers/confinicky"
   s.licenses = ["MIT"]

data/lib/confinicky/commands/clean.rb

@@ -5,20 +5,38 @@ command :clean do |c|
   c.example 'description', 'cfy clean'
 
   c.action do |args, options|
-    if Confinicky::ShellFile.has_path?
-      say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'cfy use' for more info."
+
+    # Abort if not yet setup.
+    if !Confinicky::ConfigurationFile.setup?
+      say_error "Confinicky's configuration is not valid or has not been setup."
+      puts "Try running 'cfy setup'."
+      abort
+    end
+
+    # Abort if missing arguments.
+    if args.length < 1
+      say_error "You must specify environment `cfy clean env` or aliases `cfy clean alias`."
       abort
     end
-    shell_file = Confinicky::ShellFile.new
-    duplicate_count = shell_file.find_duplicates.length
+
+    # Use the appropriate command group controller.
+    command = args[0]
+    command_group = Confinicky::Controllers::Exports.new if command == Confinicky::Arguments::ENVIRONMENT
+    command_group = Confinicky::Controllers::Aliases.new if command == Confinicky::Arguments::ALIAS
+
+    duplicate_count = command_group.duplicates.length
     say_ok "Your file is clean. No processing was required." and abort if duplicate_count < 1
 
     if agree "Backup your existing file before continuuing? (y/n)"
-      say_ok "Backup saved to: "+Confinicky::ShellFile.backup!
+      say_ok "Backup saved to: "+command_group.backup!
+    end
+
+    if command_group.clean! && command_group.save!
+      say_ok "Your file is clean. #{duplicate_count} duplicate statements have been reduced."
+    else
+      say_error "There was a problem cleaning the file."
+      puts "Please try editing it manually: #{command_group.path}"
     end
 
-    shell_file.clean!
-    say_ok "Your file is clean. #{duplicate_count} duplicate statements have been reduced."
   end
 end

data/lib/confinicky/commands/duplicates.rb

@@ -6,17 +6,39 @@ command :duplicates do |c|
 
   c.action do |args, options|
 
-    if Confinicky::ShellFile.has_path?
-      say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'cfy use' for more info."
+    # Abort if not yet setup.
+    if !Confinicky::ConfigurationFile.setup?
+      say_error "Confinicky's configuration is not valid or has not been setup."
+      puts "Try running 'cfy setup'."
       abort
     end
 
-    shell_file = Confinicky::ShellFile.new
-    duplicates = shell_file.find_duplicates.map{|key, value| [key, value]}
-    table = Terminal::Table.new :rows => duplicates
-    puts table
-    say_ok "Identified #{duplicates.length} variables with multiple 'export' statements in #{Confinicky::ShellFile.file_path}"
-    puts "Run 'confinicky clean' to reduce these statements."
+    # Abort if missing arguments.
+    if args.length < 1
+      say_error "You must specify environment `cfy duplicates env` or aliases `cfy duplicates alias`."
+      abort
+    end
+
+    # Use the appropriate command group controller.
+    command = args[0]
+    command_group = Confinicky::Controllers::Exports.new if command == Confinicky::Arguments::ENVIRONMENT
+    command_group = Confinicky::Controllers::Aliases.new if command == Confinicky::Arguments::ALIAS
+
+    # Print out any duplicates.
+    duplicates = command_group.duplicates.map{|key, value| [key, value]}
+
+    if duplicates.length > 0
+      table = Terminal::Table.new :rows => duplicates
+      puts table
+      if command == Confinicky::Arguments::ENVIRONMENT
+        say_ok "Identified #{duplicates.length} variables with multiple 'export' statements in #{command_group.path}"
+      elsif command == Confinicky::Arguments::ALIAS
+        say_ok "Identified #{duplicates.length} alias statements in #{command_group.path}"
+      end
+      puts "Run 'confinicky clean' to reduce these statements."
+    else
+      puts "No duplicate statements found."
+    end
+
   end
 end

data/lib/confinicky/commands/inspect.rb

@@ -0,0 +1,26 @@
+command :inspect do |c|
+  c.syntax = 'cfy inspect'
+  c.summary = 'Generates a list of all values for a specified environment variable.'
+  c.description = ''
+  c.example 'Inspect your shell path.', 'cfy inspect PATH'
+
+  c.action do |args, options|
+
+    # Abort if not yet setup.
+    if !Confinicky::ConfigurationFile.setup?
+      say_error "Confinicky's configuration is not valid or has not been setup."
+      puts "Try running 'cfy setup'."
+      abort
+    end
+
+    # Abort if missing arguments.
+    if args.length < 1
+      say_error "You must supply a variable name such as: `cfy inspect MY_VAR`"
+      abort
+    end
+
+    command_group = Confinicky::Controllers::Exports.new
+    puts command_group.inspect(name:args[0], separator:":")
+
+  end
+end

data/lib/confinicky/commands/list.rb

@@ -1,31 +1,36 @@
 command :list do |c|
   c.syntax = 'cfy list'
-  c.summary = 'Generates a list of all environment variables set in your configuration file.'
+  c.summary = 'Generates a list of all environment variables and/or aliases set in your configuration file(s).'
   c.description = ''
-  c.example 'description', 'cfy list'
+  c.example 'default', 'cfy list'
+  c.example 'environment variables', 'cfy list env'
+  c.example 'aliases', 'cfy list alias'
 
   c.action do |args, options|
 
-    if Confinicky::ShellFile.has_path?
-      say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'cfy use' for more info."
+    # Abort if not yet setup.
+    if !Confinicky::ConfigurationFile.setup?
+      say_error "Confinicky's configuration is not valid or has not been setup."
+      puts "Try running 'cfy setup'."
       abort
     end
 
-    shell_file = Confinicky::ShellFile.new
+    # Use the appropriate command group controller.
+    exports = Confinicky::Controllers::Exports.new
+    aliases = Confinicky::Controllers::Aliases.new
 
-    table = Terminal::Table.new do |t|
-      for export in shell_file.exports
-        if export[1].length > 100
-          t.add_row [export[0], export[1][0...100]+"..."]
-        else
-          t.add_row export
-        end
-      end
+    if args.first.nil? || args.first == Confinicky::Arguments::ENVIRONMENT
+      puts exports.to_table unless exports.to_table.nil?
+      say_ok "Identified #{exports.length} exports in #{exports.path}"
+    end
+
+    puts "" if args.first.nil?
+
+    if args.first.nil? || args.first == Confinicky::Arguments::ALIAS
+      puts aliases.to_table unless aliases.to_table.nil?
+      say_ok "Identified #{aliases.length} aliases in #{aliases.path}"
     end
-    puts table
 
-    say_ok "Identified #{shell_file.exports.length} exports in #{Confinicky::ShellFile.file_path}"
   end
 end
 

data/lib/confinicky/commands/remove.rb

@@ -1,33 +1,47 @@
 command :remove do |c|
   c.syntax = 'cfy remove'
-  c.summary = 'Removes an environment variable in your configuration file.'
+  c.summary = 'Removes an alias or environment variable in your configuration.'
   c.description = ''
-  c.example 'description', 'cfy remove MY_VAR'
+  c.example 'Remove an environment variable', 'cfy remove export MY_VAR'
+  c.example 'Remove an alias', 'cfy remove alias my_alias'
 
   c.action do |args, options|
-    if Confinicky::ShellFile.has_path?
-      say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'cfy use' for more info."
+
+    # Abort if not yet setup.
+    if !Confinicky::ConfigurationFile.setup?
+      say_error "Confinicky's configuration is not valid or has not been setup."
+      puts "Try running 'cfy setup'."
+      abort
+    end
+
+    # Abort if missing arguments.
+    if args.length < 2
+      say_error "You must supply an expression such as: `cfy remove export MY_VAR`"
       abort
     end
 
-    shell_file = Confinicky::ShellFile.new
+    # Use the appropriate command group controller.
+    command, expression = args[0], args[1]
+    command_group = Confinicky::Controllers::Exports.new if command == Confinicky::Arguments::ENVIRONMENT
+    command_group = Confinicky::Controllers::Aliases.new if command == Confinicky::Arguments::ALIAS
 
-    duplicate_count = shell_file.find_duplicates.length
-    if duplicate_count > 0
-      say_error "Your configuration cannot be managed because it currently has duplicate export statements."
+    # Abort if duplicate commands have been found.
+    if command_group.duplicates.length > 0
+      say_error "Your configuration cannot be managed because it currently has duplicate statements."
       puts "You must run 'cfy clean' before you can manage your configuration."
       abort
     end
 
-    if shell_file.remove!(args.first)
+    # Set the variable and save changes to disk.
+    if command_group.remove!(expression) and command_group.save!
       say_ok "Successfully removed '#{args.first}'."
-      puts "Open a new terminal/shell window for this change to take affect."
-      shell_file.write!
+      puts "Open a new terminal/shell window for these changes to take affect."
     else
-      say_error "Could not remove '#{args.first}' please double check to ensure you used the appropriate syntax."
+      say_error "Could not remove '#{expression}' please double check to ensure you used the appropriate syntax."
     end
+
   end
+
 end
 
 alias_command :rm, :remove

data/lib/confinicky/commands/set.rb

@@ -1,33 +1,44 @@
 command :set do |c|
   c.syntax = 'cfy set'
-  c.summary = 'Sets an environment variable in your configuration file.'
+  c.summary = 'Sets an alias or environment variable in your configuration.'
   c.description = ''
-  c.example 'description', 'cfy set MY_VAR="some value"'
+  c.example 'Set an environment variable', 'cfy set export MY_VAR="some value"'
+  c.example 'Set an environment alias', 'cfy set alias home="cd ~"'
 
   c.action do |args, options|
-    if Confinicky::ShellFile.has_path?
-      say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'cfy use' for more info."
+
+    # Abort if not yet setup.
+    if !Confinicky::ConfigurationFile.setup?
+      say_error "Confinicky's configuration is not valid or has not been setup."
+      puts "Try running 'cfy setup'."
       abort
     end
 
-    shell_file = Confinicky::ShellFile.new
-
-    duplicate_count = shell_file.find_duplicates.length
-    if duplicate_count > 0
-      say_error "Your configuration cannot be managed because it currently has duplicate export statements."
-      puts "You must run 'cfy clean' before you can manage your configuration."
+    # Abort if missing arguments.
+    if args.length < 2
+      say_error "You must supply an expression such as: `cfy set export MY_VAR=\"some value\"`"
       abort
     end
 
-    say_error "You must supply an expression such as: MY_VAR=\"some value\"" and about if args.first.nil?
+    # Use the appropriate command group controller.
+    command, expression = args[0], args[1]
+    command_group = Confinicky::Controllers::Exports.new if command == Confinicky::Arguments::ENVIRONMENT
+    command_group = Confinicky::Controllers::Aliases.new if command == Confinicky::Arguments::ALIAS
+
+    # Abort if duplicate commands have been found.
+    if command_group.duplicates.length > 0
+      say_error "Your configuration cannot be managed because it currently has duplicate statements."
+      puts "You must run 'cfy clean #{command}' before you can manage your configuration."
+      abort
+    end
 
-    if shell_file.set!(args.first)
-      shell_file.write!
+    # Set the variable and save changes to disk.
+    if command_group.set!(expression) and command_group.save!
       say_ok "Successfully set '#{args.first}'."
-      puts "Run 'source #{Confinicky::ShellFile.file_path}' or open a new terminal/shell window."
+      puts "Open a new terminal/shell window for these changes to take affect."
     else
-      say_error "Could not set '#{args.first}' please double check to ensure you used the appropriate syntax."
+      say_error "Could not set '#{expression}' please double check to ensure you used the appropriate syntax."
     end
+
   end
 end

data/lib/confinicky/commands/setup.rb

@@ -0,0 +1,25 @@
+require 'yaml'
+
+command :setup do |c|
+  c.syntax = 'cfy setup'
+  c.summary = 'Generates a ".confinicky" configuration YAML doc in your home directory.'
+  c.description = ''
+  c.example 'description', 'cfy setup'
+
+  c.action do |args, options|
+
+    puts Confinicky::ConfigurationFile.table
+
+    { env: "\nWhat file do you want to store your environment vars in?\n(leave blank to keep current)",
+      aliases: "\nWhat file do you want to store your aliases in?\n(leave blank to keep current)"
+    }.each do |key, question|
+      Confinicky::ConfigurationFile.set_path_for_key(path: ask(question), key: key)
+      say_ok "Using: #{Confinicky::ConfigurationFile.path_for_key(key: key)}"
+    end
+
+    Confinicky::ConfigurationFile.write!
+
+    say_ok "\nWrote the following configuration to:\n#{Confinicky::ConfigurationFile::PATH}"
+    puts Confinicky::ConfigurationFile.table
+  end
+end

data/lib/confinicky/commands.rb

@@ -2,7 +2,8 @@ $:.push File.expand_path('../', __FILE__)
 
 require 'commands/clean'
 require 'commands/duplicates'
+require 'commands/inspect'
 require 'commands/list'
-require 'commands/use'
+require 'commands/setup'
 require 'commands/set'
 require 'commands/remove'

data/lib/confinicky/config.rb

@@ -1,4 +1,17 @@
 module Confinicky
-  FILE_PATH_VAR = "CONFINICKY_FILE_PATH"
-  MANAGED_COMMENT_TEXT = "EXPORTS MANAGED BY CONFINICKY"
+
+  ##
+  # Paths to dependencies used primarily for configuration.
+  module Paths
+    CONFIG = "#{ENV['HOME']}/.Confinicky"
+  end
+
+  ##
+  # Constants representing arguments which can be passed
+  # to the command line interface.
+  module Arguments
+    ENVIRONMENT = "env"
+    ALIAS = "alias"
+  end
+
 end

data/lib/confinicky/configuration_file.rb

@@ -0,0 +1,89 @@
+module Confinicky
+
+  ##
+  # A singleton model representing the configuration YAML utilized
+  # by Confinicky.
+  class ConfigurationFile
+
+    SUPPORTED_KEYS = [:aliases, :env]
+    PATH = Confinicky::Paths::CONFIG
+
+    @@configuration = nil
+
+    ##
+    # Retrieves the value of the environment variables file path.
+    def self.path_for_key(key: nil)
+      self.raise_if_key_not_supported(key)
+      self.get_configuration[:files][key]
+    end
+
+    ##
+    # Set's the aliases file path.
+    def self.set_path_for_key(path: "", key: nil)
+      self.raise_if_key_not_supported(key)
+      self.get_configuration[:files][key] = path if self.valid_path?(path)
+    end
+
+    ##
+    # Writes the output to the appropriate YAML file.
+    def self.write!
+      File.open(PATH, 'w') {|f| f.write self.get_configuration.to_yaml }
+    end
+
+    ##
+    # Returns a terminal table displaying the current configuration.
+    def self.table
+      Terminal::Table.new(title: "Configuration", headings: ['type', 'path']) do |t|
+        self.get_configuration[:files].each {|k,v| t.add_row [k.to_s,v]}
+      end
+    end
+
+    ##
+    # Returns true if the configuration file exists along with
+    # all specified paths.
+    def self.setup?
+      File.exists?(PATH) &&
+      File.exists?(self.get_configuration[:files][:env]) &&
+      File.exists?(self.get_configuration[:files][:aliases])
+    end
+
+    ##
+    # Forces a configuration, primarily for testing purposes.
+    def self.force_config!(configuration)
+      @@configuration = configuration
+    end
+
+    private
+
+      ##
+      # Raises an error if a specified key is not supported.
+      def self.raise_if_key_not_supported(key)
+        raise "Unsupported key supplied to configuration: "+key.to_s unless SUPPORTED_KEYS.include?(key)
+      end
+
+      ##
+      # Returns false if the path is blank and raises an error if the
+      # supplied path does not point to an existing file.
+      def self.valid_path?(path)
+        if (!path.nil? && path.length > 0)
+          raise "File does not exist at: #{path}" unless File.exists?(path)
+          return true
+        end
+        false
+      end
+
+      ##
+      # Lazy loading to retrieve the contents of the configuration file.
+      def self.get_configuration
+        @@configuration || self.load_configuration
+      end
+
+      ##
+      # Loads the configuration file or generates a default hash.
+      def self.load_configuration
+        return @@configuration = YAML::load_file(PATH) if File.exists?(PATH)
+        @@configuration = {files: {aliases: "#{ENV['HOME']}/aliases", env: "#{ENV['HOME']}/env"}}
+      end
+
+  end
+end

data/lib/confinicky/controllers/aliases.rb

@@ -0,0 +1,23 @@
+module Confinicky
+  module Controllers
+
+    ##
+    # A subclass of the command group controller specifically
+    # for managing alias statements.
+    class Aliases < Commands
+      def initialize
+        super(file_type_key: :aliases)
+        @commands = @shell_file.aliases
+        @table_title = "Aliases"
+      end
+
+      ##
+      # Updates the actual shell file on disk.
+      def save!
+        @shell_file.aliases = @commands
+        @shell_file.write!
+      end
+    end
+
+  end
+end