hutch 0.21.0 → 0.22.1

data/spec/hutch/config_spec.rb

@@ -4,23 +4,37 @@ require 'tempfile'
 describe Hutch::Config do
   let(:new_value) { 'not-localhost' }
 
+  before do
+    Hutch::Config.initialize
+  end
+
   describe '.get' do
     context 'for valid attributes' do
       subject { Hutch::Config.get(:mq_host) }
 
       context 'with no overridden value' do
-        it { is_expected.to eq('localhost') }
+        it { is_expected.to eq('127.0.0.1') }
       end
 
       context 'with an overridden value' do
-        before  { allow(Hutch::Config).to receive_messages(user_config: { mq_host: new_value }) }
+        before do
+          allow(Hutch::Config).to receive_messages(
+            user_config: { mq_host: new_value }
+          )
+        end
+
         it { is_expected.to eq(new_value) }
       end
     end
 
     context 'for invalid attributes' do
-      let(:invalid_get) { ->{ Hutch::Config.get(:invalid_attr) } }
-      specify { expect(invalid_get).to raise_error Hutch::UnknownAttributeError }
+      let(:invalid_get) do
+        -> { Hutch::Config.get(:invalid_attr) }
+      end
+
+      specify do
+        expect(invalid_get).to raise_error Hutch::UnknownAttributeError
+      end
     end
   end
 
@@ -35,8 +49,13 @@ describe Hutch::Config do
     end
 
     context 'for invalid attributes' do
-      let(:invalid_set) { ->{ Hutch::Config.set(:invalid_attr, new_value) } }
-      specify { expect(invalid_set).to raise_error Hutch::UnknownAttributeError }
+      let(:invalid_set) do
+        -> { Hutch::Config.set(:invalid_attr, new_value) }
+      end
+
+      specify do
+        expect(invalid_set).to raise_error Hutch::UnknownAttributeError
+      end
     end
   end
 
@@ -49,9 +68,33 @@ describe Hutch::Config do
     end
 
     context 'for an invalid attribute' do
-      let(:invalid_getter) { ->{ Hutch::Config.invalid_attr } }
+      let(:invalid_getter) { -> { Hutch::Config.invalid_attr } }
       specify { expect(invalid_getter).to raise_error NoMethodError }
     end
+
+    context 'for an ENV-overriden value attribute' do
+      around do |example|
+        ENV['HUTCH_MQ_HOST'] = 'example.com'
+        ENV['HUTCH_MQ_PORT'] = '10001'
+        ENV['HUTCH_MQ_TLS'] = 'true'
+        example.run
+        ENV.delete('HUTCH_MQ_HOST')
+        ENV.delete('HUTCH_MQ_PORT')
+        ENV.delete('HUTCH_MQ_TLS')
+      end
+
+      it 'returns the override' do
+        expect(Hutch::Config.mq_host).to eq 'example.com'
+      end
+
+      it 'returns the override for integers' do
+        expect(Hutch::Config.mq_port).to eq 10_001
+      end
+
+      it 'returns the override for booleans' do
+        expect(Hutch::Config.mq_tls).to eq true
+      end
+    end
   end
 
   describe 'a magic setter' do
@@ -63,7 +106,7 @@ describe Hutch::Config do
     end
 
     context 'for an invalid attribute' do
-      let(:invalid_setter) { ->{ Hutch::Config.invalid_attr = new_value } }
+      let(:invalid_setter) { -> { Hutch::Config.invalid_attr = new_value } }
       specify { expect(invalid_setter).to raise_error NoMethodError }
     end
   end
@@ -81,9 +124,9 @@ describe Hutch::Config do
     context 'when an attribute is invalid' do
       let(:config_data) { { random_attribute: 'socks' } }
       it 'raises an error' do
-        expect {
+        expect do
           Hutch::Config.load_from_file(file)
-        }.to raise_error(NoMethodError)
+        end.to raise_error(NoMethodError)
       end
     end
 
@@ -96,26 +139,21 @@ describe Hutch::Config do
         expect(Hutch::Config.mq_username).to eq username
       end
     end
-  end
 
-  describe '.load_from_file' do
-    let(:host) { 'localhost' }
-    let(:username) { 'calvin' }
-    let(:file) do
-      Tempfile.new('configs.yaml').tap do |t|
-        t.write(config_contents)
-        t.rewind
+    context 'when using ERB' do
+      let(:host) { 'localhost' }
+      let(:file) do
+        Tempfile.new('configs.yaml').tap do |t|
+          t.write(config_contents)
+          t.rewind
+        end
       end
-    end
-
-    context 'when using ERb' do
       let(:config_contents) do
         <<-YAML
 mq_host: 'localhost'
 mq_username: '<%= "calvin" %>'
 YAML
       end
-
       it 'loads in the config data' do
         Hutch::Config.load_from_file(file)
         expect(Hutch::Config.mq_host).to eq host

data/spec/hutch/error_handlers/sentry_spec.rb

@@ -13,7 +13,7 @@ describe Hutch::ErrorHandlers::Sentry do
     end
 
     it "logs the error to Sentry" do
-      expect(Raven).to receive(:capture_exception).with(error)
+      expect(Raven).to receive(:capture_exception).with(error, extra: { payload: "{}" })
       error_handler.handle("1", "{}", double, error)
     end
   end

data/spec/hutch/logger_spec.rb

@@ -3,24 +3,30 @@ require 'spec_helper'
 describe Hutch::Logging do
   let(:dummy_object) do
     class DummyObject
-      include Hutch::Logging
+      include described_class
     end
   end
 
   describe '#logger' do
+    around do |example|
+      old_logger = described_class.logger
+      described_class.setup_logger
+      example.run
+      described_class.logger = old_logger
+    end
+
     context 'with the default logger' do
-      subject { Hutch::Logging.logger }
+      subject { described_class.logger }
 
       it { is_expected.to be_instance_of(Logger) }
     end
 
     context 'with a custom logger' do
-      let(:dummy_logger) { double("Dummy logger", warn: true, info: true) }
-      after { Hutch::Logging.setup_logger }
+      let(:dummy_logger) { double("Dummy logger") }
 
       it "users the custom logger" do
-        Hutch::Logging.logger = dummy_logger
-        expect(Hutch::Logging.logger).to eq(dummy_logger)
+        described_class.logger = dummy_logger
+        expect(described_class.logger).to eq(dummy_logger)
       end
     end
   end

data/spec/hutch/waiter_spec.rb

@@ -0,0 +1,33 @@
+require 'hutch/waiter'
+
+RSpec.describe Hutch::Waiter do
+  describe '.wait_until_signaled' do
+    let(:pid) { Process.pid }
+    def start_kill_thread(signal)
+      Thread.new do
+        # sleep allows the worker time to set up the signal handling
+        # before the kill signal is sent.
+        sleep 0.001
+        Process.kill signal, pid
+      end
+    end
+
+    %w(QUIT TERM INT).each do |signal|
+      context "a #{signal} signal is received" do
+        it "logs that hutch is stopping" do
+          expect(Hutch::Logging.logger).to receive(:info)
+            .with("caught sig#{signal.downcase}, stopping hutch...")
+
+          start_kill_thread(signal)
+          described_class.wait_until_signaled
+        end
+      end
+    end
+  end
+
+  describe described_class::SHUTDOWN_SIGNALS do
+    it "includes only things in Signal.list.keys" do
+      expect(described_class).to eq(described_class & Signal.list.keys)
+    end
+  end
+end

data/spec/hutch/worker_spec.rb

@@ -7,7 +7,19 @@ describe Hutch::Worker do
                           get_serializer: nil) }
   let(:consumers) { [consumer, double('Consumer')] }
   let(:broker) { Hutch::Broker.new }
-  subject(:worker) { Hutch::Worker.new(broker, consumers) }
+  let(:setup_procs) { Array.new(2) { Proc.new {} } }
+  subject(:worker) { Hutch::Worker.new(broker, consumers, setup_procs) }
+
+  describe ".#run" do
+    it "calls each setup proc" do
+      setup_procs.each { |prc| expect(prc).to receive(:call) }
+      allow(worker).to receive(:setup_queues)
+      allow(Hutch::Waiter).to receive(:wait_until_signaled)
+      allow(broker).to receive(:stop)
+
+      worker.run
+    end
+  end
 
   describe '#setup_queues' do
     it 'sets up queues for each of the consumers' do
@@ -20,7 +32,6 @@ describe Hutch::Worker do
 
   describe '#setup_queue' do
     let(:queue) { double('Queue', bind: nil, subscribe: nil) }
-    before { allow(worker).to receive_messages(consumer_queue: queue) }
     before { allow(broker).to receive_messages(queue: queue, bind_queue: nil) }
 
     it 'creates a queue' do

data/spec/spec_helper.rb

@@ -13,8 +13,10 @@ require 'raven'
 require 'hutch'
 require 'logger'
 
+# set logger to be a null logger
+Hutch::Logging.logger = Logger.new(File::NULL)
+
 RSpec.configure do |config|
-  config.before(:all) { Hutch::Config.log_level = Logger::FATAL }
   config.raise_errors_for_deprecations!
 
   if defined?(JRUBY_VERSION)
@@ -22,6 +24,10 @@ RSpec.configure do |config|
   else
     config.filter_run_excluding adapter: :march_hare
   end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
 end
 
 # Constants (classes, etc) defined within a block passed to this method
@@ -34,7 +40,3 @@ ensure
     Object.send(:remove_const, constant)
   end
 end
-
-def deep_copy(obj)
-  Marshal.load(Marshal.dump(obj))
-end

data/templates/default/class/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.push :settings
+end

data/templates/default/fulldoc/html/css/hutch.css

@@ -0,0 +1,13 @@
+.settings {
+  border-spacing: 2.5rem;
+  border-collapse: collapse;
+}
+
+.settings thead th {
+  text-align: left;
+}
+
+.settings thead th,
+.settings tbody td {
+  padding: .5em 1em;
+}

data/templates/default/layout/html/setup.rb

@@ -0,0 +1,7 @@
+def init
+  super
+end
+
+def stylesheets
+  super + %w(css/hutch.css)
+end

data/templates/default/method_details/html/settings.erb

@@ -0,0 +1,5 @@
+<% if object['custom_field'] %>
+<p>
+  <%= object['custom_field'] %>
+</p>
+<% end %>

data/templates/default/method_details/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.last.place(:settings).after(:source)
+end

data/templates/default/module/html/settings.erb

@@ -0,0 +1,40 @@
+<% if object['setting_rows'] %>
+  <h2>
+    Configuration
+  </h2>
+
+  <div class="tags">
+    <table border="1" class="settings">
+      <thead>
+        <tr>
+          <th>
+            Setting name
+          </th>
+          <th>
+            Default value
+          </th>
+          <th>
+            Type
+          </th>
+          <th>
+            ENV variable
+          </th>
+          <th>
+            Description
+          </th>
+        </tr>
+      </thead>
+      <tbody>
+      <% for setting in object['setting_rows'] %>
+        <tr>
+          <td><tt><%= resolve_links "{Hutch::Config##{setting[:name]} #{setting[:name]}}" %></tt></td>
+          <td><%= setting[:default_value] %></td>
+          <td><%= setting[:type] %></td>
+          <td><tt>HUTCH_<%= setting[:name].upcase %></tt></td>
+          <td><%= html_markup_markdown setting[:first_line_of_description] %></td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

data/templates/default/module/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.place(:settings).before(:children)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.1
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-07 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: carrot-top
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Hutch is a Ruby library for enabling asynchronous inter-service communication
   using RabbitMQ.
 email:
@@ -105,6 +147,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -133,13 +176,17 @@ files:
 - lib/hutch/exceptions.rb
 - lib/hutch/logging.rb
 - lib/hutch/message.rb
+- lib/hutch/publisher.rb
 - lib/hutch/serializers/identity.rb
 - lib/hutch/serializers/json.rb
 - lib/hutch/tracers.rb
 - lib/hutch/tracers/newrelic.rb
 - lib/hutch/tracers/null_tracer.rb
 - lib/hutch/version.rb
+- lib/hutch/waiter.rb
 - lib/hutch/worker.rb
+- lib/yard-settings/handler.rb
+- lib/yard-settings/yard-settings.rb
 - spec/hutch/broker_spec.rb
 - spec/hutch/cli_spec.rb
 - spec/hutch/config_spec.rb
@@ -151,9 +198,19 @@ files:
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
 - spec/hutch/serializers/json_spec.rb
+- spec/hutch/waiter_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb
+- templates/default/class/html/settings.erb
+- templates/default/class/setup.rb
+- templates/default/fulldoc/html/css/hutch.css
+- templates/default/layout/html/setup.rb
+- templates/default/method_details/html/settings.erb
+- templates/default/method_details/setup.rb
+- templates/default/method_details/text/settings.erb
+- templates/default/module/html/settings.erb
+- templates/default/module/setup.rb
 homepage: https://github.com/gocardless/hutch
 licenses:
 - MIT
@@ -174,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.
@@ -190,6 +247,7 @@ test_files:
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
 - spec/hutch/serializers/json_spec.rb
+- spec/hutch/waiter_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb