hutch 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd5acc300bddafcfd792e4c75e5b811a48f629fd
-  data.tar.gz: a95a2cd5d6f68eef43366f41a944a97d0ecd69b5
+  metadata.gz: 7796c2e714b41d75ba0dac9b55b51e2aa45e2c44
+  data.tar.gz: 53e10daaf146ea25c39b374249040e0a2eb3281b
 SHA512:
-  metadata.gz: 98826378b6171757012a15807bc0e52b88a692a88aa9c14e864969c5dbef49ea45890c50372e58a5dbb4b5179ee9cd12b992e00a4cb16108134d0603b56a0162
-  data.tar.gz: 009ec3387f697af8dd6ea279bbf1260a945d5063d012b7a0970ad7d99a3b5d5a60ca7abc33473f2f494584a77c3a7f63946bea123c7a195e30ef65608dd7c674
+  metadata.gz: 864361f79c19d277caaa6fada23e6a9b8dd750b7731e279a6ffc95d06f2bacd239e8cdffb62cb7e3dbb8caf3e1c0f06df2bf72da91b8a33cf1d29af6dd0e74df
+  data.tar.gz: 5b00698982dfb82b7a837d7207c79e9afd84fdfdceca3804cd60b0d9a7e231186d12ef5a8c0a4a5d42582902eebc40956105a37aff8fe51742c5401aa0824377

data/README.md

@@ -102,6 +102,8 @@ usage: hutch [options]
         --mq-api-host HOST           Set the RabbitMQ API host
         --mq-api-port PORT           Set the RabbitMQ API port
         --mq-api-ssl                 Use SSL for the RabbitMQ API
+        --config FILE                Load Hutch configuration from a file
+
         --require PATH               Require a Rails app or path
     -q, --quiet                      Quiet logging
     -v, --verbose                    Verbose logging
@@ -110,7 +112,20 @@ usage: hutch [options]
 ```
 
 The first three are for configuring which RabbitMQ instance to connect to.
-`--require` is covered in the next section. The remainder are self-explanatory.
+`--require` is covered in the next section. Configurations can also be
+specified in a YAML file for convenience by passing the file location
+to the --config option.  The file should look like:
+
+```yaml
+mq_username: peter
+mq_password: rabbit
+mq_host: broker.yourhost.com
+```
+
+Passing a setting as a command-line option will overwrite what's specified
+in the config file, allowing for easy customization.
+
+
 
 ### Loading Consumers
 

data/lib/hutch/cli.rb

@@ -2,6 +2,7 @@ require 'optparse'
 
 require 'hutch/logging'
 require 'hutch/exceptions'
+require 'hutch/config'
 
 module Hutch
   class CLI
@@ -84,7 +85,7 @@ module Hutch
       :error
     end
 
-    def parse_options
+    def parse_options(args = ARGV)
       OptionParser.new do |opts|
         opts.banner = 'usage: hutch [options]'
 
@@ -131,6 +132,14 @@ module Hutch
           Hutch::Config.mq_api_ssl = api_ssl
         end
 
+        opts.on('--config FILE', 'Load Hutch configuration from a file') do |file|
+          begin
+            File.open(file) { |fp| Hutch::Config.load_from_file(fp) }
+          rescue Errno::ENOENT
+            abort "Config file '#{file}' not found"
+          end
+        end
+
         opts.on('--require PATH', 'Require a Rails app or path') do |path|
           Hutch::Config.require_paths << path
         end
@@ -156,7 +165,7 @@ module Hutch
           puts opts
           exit 0
         end
-      end.parse!
+      end.parse!(args)
     end
   end
 end

data/lib/hutch/config.rb

@@ -1,9 +1,12 @@
+require 'hutch/error_handlers/logger'
 require 'logger'
 
 module Hutch
   class UnknownAttributeError < StandardError; end
 
   module Config
+    require 'yaml'
+
     def self.initialize
       @config = {
         mq_host: 'localhost',
@@ -49,6 +52,12 @@ module Hutch
       @config
     end
 
+    def self.load_from_file(file)
+      YAML.load(file).each do |attr, value|
+        Hutch::Config.send("#{attr}=", value)
+      end
+    end
+
     def self.method_missing(method, *args, &block)
       attr = method.to_s.sub(/=$/, '').to_sym
       return super unless user_config.key?(attr)

data/lib/hutch/logging.rb

@@ -1,6 +1,5 @@
 require 'logger'
 require 'time'
-require 'hutch/config'
 
 module Hutch
   module Logging
@@ -11,6 +10,7 @@ module Hutch
     end
 
     def self.setup_logger(target = $stdout)
+      require 'hutch/config'
       @logger = Logger.new(target)
       @logger.level = Hutch::Config.log_level
       @logger.formatter = HutchFormatter.new

data/lib/hutch/version.rb

@@ -1,4 +1,4 @@
 module Hutch
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end
 

data/spec/hutch/cli_spec.rb

@@ -0,0 +1,32 @@
+require 'hutch/cli'
+require 'tempfile'
+
+describe Hutch::CLI do
+  let(:cli) { Hutch::CLI.new }
+
+  describe "#parse_options" do
+    context "--config" do
+      context "when the config file does not exist" do
+        let(:file) { "/path/to/nonexistant/file" }
+        before { STDERR.stub(:write) }
+
+        it "bails" do
+          expect {
+            cli.parse_options(["--config=#{file}"])
+          }.to raise_error SystemExit
+        end
+      end
+
+      context "when the config file exists" do
+        let(:file) do
+          Tempfile.new("hutch-test-config.yaml").to_path
+        end
+
+        it "parses the config" do
+          Hutch::Config.should_receive(:load_from_file)
+          cli.parse_options(["--config=#{file}"])
+        end
+      end
+    end
+  end
+end

data/spec/hutch/config_spec.rb

@@ -1,4 +1,5 @@
 require 'hutch/config'
+require 'tempfile'
 
 describe Hutch::Config do
   let(:new_value) { 'not-localhost' }
@@ -66,4 +67,34 @@ describe Hutch::Config do
       specify { invalid_setter.should raise_error NoMethodError }
     end
   end
+
+  describe '.load_from_file' do
+    let(:host) { 'broker.yourhost.com' }
+    let(:username) { 'calvin' }
+    let(:file) do
+      Tempfile.new('configs.yaml').tap do |t|
+        t.write(YAML.dump(config_data))
+        t.rewind
+      end
+    end
+
+    context 'when an attribute is invalid' do
+      let(:config_data) { { random_attribute: 'socks' } }
+      it 'raises an error' do
+        expect {
+          Hutch::Config.load_from_file(file)
+        }.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'when attributes are valid' do
+      let(:config_data) { { mq_host: host, mq_username: username } }
+
+      it 'loads in the config data' do
+        Hutch::Config.load_from_file(file)
+        Hutch::Config.mq_host.should eq host
+        Hutch::Config.mq_username.should eq username
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -100,6 +100,7 @@ files:
 - lib/hutch/version.rb
 - lib/hutch/worker.rb
 - spec/hutch/broker_spec.rb
+- spec/hutch/cli_spec.rb
 - spec/hutch/config_spec.rb
 - spec/hutch/consumer_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
@@ -135,6 +136,7 @@ specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.
 test_files:
 - spec/hutch/broker_spec.rb
+- spec/hutch/cli_spec.rb
 - spec/hutch/config_spec.rb
 - spec/hutch/consumer_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb