v0.1.5

Author: vladgh

.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
   - 2.1.2
 deploy:
   provider: rubygems

CHANGELOG.md

@@ -1,3 +1,12 @@
+Version 0.1.5
+---
+  * Add configuration file ([Vlad - f928415](https://github.com/vghn/vscripts/commit/f928415a19c4f300566721fcffd14877497de6f1))
+  * Add testing for Ruby 2.0.0 ([Vlad - ba19d81](https://github.com/vghn/vscripts/commit/ba19d817194fe1395ce5d2b3884552004e5e07ef))
+  * Fix command line options ([Vlad - cc6e8ad](https://github.com/vghn/vscripts/commit/cc6e8ad6ee77218cfe4cb8ae80af57a291d36ddb))
+  * Fix test for Ruby 2.0 ([Vlad - 2d32474](https://github.com/vghn/vscripts/commit/2d32474afcd2f1122d0d9deebc4e5c0bae700ff5))
+  * Fix smells ([Vlad - 23283a9](https://github.com/vghn/vscripts/commit/23283a941d356e185364d83832d88b15919c2bf7))
+  * Minor code improvements ([Vlad - b9091e5](https://github.com/vghn/vscripts/commit/b9091e5fbd6a50679c214d4d7db9539965d727e6))
+
 Version 0.1.4
 ---
   * Switch back to previous branch on deployment ([Vlad - 244ac9a](https://github.com/vghn/vscripts/commit/244ac9a6d810abd63a625c88bc0a2efac19a9993))

README.md

@@ -16,6 +16,12 @@ Automation daemon.
 ### Gem installation
 `gem install vscripts`
 
+## Configuration
+
+VScripts looks for a configuration file in the following locations(in order):
+  - a file specified in the `--config` command line option
+  - `.vscripts.yml` in the $HOME directory
+  - `/etc/vscripts/config.yml`
 
 ## Usage
 
@@ -26,8 +32,9 @@ vscripts GLOBAL-OPTIONS COMMAND OPTIONS
 
 ### Global Options
 ```
--h|--help: Displays VScripts help.
--v|--version: Displays the version number.
+--config,  -c <s>: Specify configuration file
+--help,    -h    : Displays VScripts help
+--version, -v    : Displays the version number
 ```
 
 

bin/vscripts

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'vscripts'
-VScripts.run(ARGV)
+VScripts.run

lib/vscripts.rb

@@ -1,12 +1,21 @@
 require 'vscripts/commands'
 require 'vscripts/command_line'
+require 'vscripts/config'
 
 # Main VScripts module
 module VScripts
+  # Reads the command line arguments
+  def self.cli
+    @cli ||= CommandLine.new # Parses command line
+  end
+
+  # Reads the configuration files
+  def self.config
+    @config ||= VScripts::Config.new(cli.global.config) # Parses configuration
+  end
+
   # Reads the arguments and runs the given command
-  def self.run(argv)
-    cli = CommandLine.new(argv)
-    command = VScripts::Commands.const_get(cli.command).new(cli.arguments)
-    command.execute
+  def self.run
+    VScripts::Commands.const_get(cli.command).new(cli.command_options).execute
   end
 end # module VScripts

lib/vscripts/aws/ec2.rb

@@ -38,15 +38,24 @@ def create_tag(resource, key, value)
         ec2.tags.create(resource, key, value)
       end
 
+      # @return [Hash] a correct Hash object with all tags and keys
+      def all_tags_hash
+        hash = {}
+        all_tags.each do |key, value|
+          hash = hash.merge(Hash[key, value])
+        end
+        hash
+      end
+
       # Exclude tags
       # @param list [Array] the list of tag keys to be excluded
       # @return [Hash] the filtered tags
       def tags_without(list = [])
-        all_tags.each_with_object({}) do |tag, hash|
-          key, value = tag[0], tag[1]
-          hash[key] = value unless list.include? key
-          hash
+        hash = all_tags_hash
+        list.each do |key|
+          hash.delete(key)
         end
+        hash
       end
 
       # Looks for the value of the 'Name' tag for the given instance

lib/vscripts/command_line.rb

@@ -5,63 +5,67 @@
 module VScripts
   # Parses the command line arguments
   class CommandLine
-    # @return [Array] all command line arguments
-    attr_accessor :arguments
     # @return [Hash] the global command line arguments.
     attr_reader :global
     # @return [String] the command name
     attr_reader :command
+    # @return [Array] the command specific arguments.
+    attr_reader :command_options
 
-    # Builds command line arguments
-    def initialize(argv = [])
-      @arguments ||= argv
-      @global    ||= parse_cli_options
-      @command   ||= verify_command
+    # @param args [Array] the command line arguments
+    # @return [Hash] the command line options
+    def initialize(args = ARGV)
+      parse_global(args)
     end
 
     # Specifies command line options
     # This method smells of :reek:NestedIterators but ignores them
     # This method smells of :reek:TooManyStatements but ignores them
     def parser # rubocop:disable MethodLength
       available = Commands.list.map { |cmd| cmd.to_s.downcase }
-      @parser ||= Trollop::Parser.new do
+      Trollop::Parser.new do
         version VScripts::VERSION::COPYRIGHT
         banner <<-EOS
 VScripts automation daemon.
 
 Available commands:
         #{available}
 
-Usage:
+USAGE:
   vscripts GLOBAL-OPTIONS COMMAND OPTIONS
 
 For help on an individual command:
   vscripts COMMAND --help
 
-Global Options:
+GLOBAL OPTIONS:
 EOS
+        opt :config, 'Specify configuration file',
+            type: :string, short: '-c'
         stop_on available
+        stop_on_unknown
       end
     end
 
-    # @return [Hash] the command line arguments
-    def parse_cli_options
+    # @param args [Array] the command line arguments
+    # @return [Hash] the command line options
+    def parse_global(args)
       Trollop.with_standard_exception_handling parser do
-        fail Trollop::HelpNeeded if arguments.empty?
-        parser.parse arguments
+        @global = parser.parse args
+        fail Trollop::HelpNeeded if args.empty? || !parse_command(args)
       end
+      @global
     end
 
     # Ensures command is available
     # @return [String] the command name
-    def verify_command
-      command_cli = arguments.shift
-      command_cls = command_cli.capitalize.to_sym
-      if Commands.list.include?(command_cls)
-        return command_cls
-      else
-        abort "Error: unknown subcommand '#{command_cli}'\nTry --help."
-      end
+    # @return [Array] the command specific arguments
+    def parse_command(args)
+      command = args.shift
+      return unless command
+      command_class = command.capitalize.to_sym
+      abort "Error: unknown subcommand '#{command}'\nTry --help." \
+        unless Commands.list.include?(command_class)
+      @command, @command_options = [command_class, args]
     end
   end # class CommandLine
 end # module VScripts

lib/vscripts/config.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+
+module VScripts
+  # VScripts Configuration
+  class Config
+    # User's configuration file
+    DOT_FILE   = "#{File.expand_path('~')}/.vscripts.yml"
+    # Global configuration file
+    SYSTEM_CONFIG_FILE = '/etc/vscripts/config.yml'
+    # Global defaults
+    GLOBAL_DEFAULTS = {}
+
+    # @return [Hash] all configuration options
+    attr_reader :get
+
+    # Loads class
+    # @param cfg_file [String] the path to the configuration file
+    # @return [Hash] the configuration options
+    def initialize(config_file = nil)
+      @file = config_file
+      @get  = GLOBAL_DEFAULTS.merge(options)
+    end
+
+    # Parses the configuration files in order
+    # @return [Hash] the first configuration hash found
+    def options
+      parse(@file) ||
+        parse(DOT_FILE) ||
+        parse(SYSTEM_CONFIG_FILE) ||
+        {}
+    end
+
+    # Parses the configuration
+    # @param file [String] the path to the configuration file
+    # @return [Hash] the configuration hash
+    def parse(file)
+      YAML.load(read(file)) if check_config(file)
+    end
+
+    # @param (see #parse)
+    # @return [String] the contents of the file
+    def read(file)
+      File.read(file)
+    end
+
+    # @param (see #parse)
+    # @return [Boolean] true if the file exists
+    def check_config(file)
+      file && File.exist?(file)
+    end
+  end # class Config
+end # module VScripts

lib/vscripts/version.rb

@@ -2,7 +2,7 @@ module VScripts
   # This module holds the version information.
   module VERSION
     # @return [String] the version number
-    STRING = '0.1.4'
+    STRING = '0.1.5'
 
     # @return [String] the semantic version number
     MAJOR, MINOR, PATCH = STRING.split('.').map(&:to_i)