captain_config 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5493e2fcb8ce58f2bc41f302ea1f4ffddffaa3b5ed47a140a0224e8b684d0ca
-  data.tar.gz: 1f01c90101896d6703b97fb98d48fce1fb69e8b1640bf1fa372194f9c9cfbecb
+  metadata.gz: 0e24dce3bbbadb28e2e3272c6456ef39dc6730ffe403dde2d26d986daf9c699a
+  data.tar.gz: 868c2655ca58fb22442b03768ccf089bdc9d6b8cdafa4c059a6eb7490a294c7e
 SHA512:
-  metadata.gz: 4877a1a5d325b23775c32fae6b48fd6462781aff286e4b06398d68b81d3f6eae541cd32e7fb5d7f22d5631b6e10e017f4a5a7ad7faf671e932aba803ccc1bdad
-  data.tar.gz: bf9d708d0e801b2dd39c2b975c06ea674a84be9d7a7317cf2ffde8b95d1159116f5ba496d31d2ba35827a3aa7e64d6445be7039555a16816dad9cae6305fe341
+  metadata.gz: e9f3406b4cb80f2a0d4172ae4edbe5f2c728039e70540677a076e7ba358b03c536537764848dea6f3c497fc048444d8deda04759edf44df0fe1d5d8d72f3def5
+  data.tar.gz: a4f4d2f3318bd6ceb5c04455792ac70e2d233bb31e763307725528ebc4ec1661c4261e4dbaf275347a8eb50dac6cd234f074e24f4bb5e09f446d1e77feb55309

data/README.md

@@ -1,5 +1,7 @@
 # CaptainConfig
 
+[![Build Status](https://travis-ci.org/dirk/captain_config.svg?branch=master)](https://travis-ci.org/dirk/captain_config)
+
 `CaptainConfig` makes it easy to add developer-friendly configuration to control your application's behavior.
 
 ## Getting Started
@@ -18,7 +20,7 @@ bundle exec rails generate captain_config
 
 **Not on Rails?** Check out the [template](https://github.com/dirk/captain_config/blob/master/lib/generators/templates/create_captain_configs.rb.tt) for the ActiveRecord migration that would have been generated; that describes how this gem expects that table to look.
 
-Then—assuming you're using Rails—set up some configuration in your config:
+Then—assuming you're using Rails—set up some configuration in your `config/initializers`:
 
 ```rb
 # config/initializers/captain_config.rb
@@ -55,8 +57,39 @@ end
 <% end >
 ```
 
+### Sidekiq
+
+There is a Sidekiq middleware to automatically reload configuration.
+
+```rb
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add CaptainConfig::SidekiqMiddlewareFactory.build
+
+    # By default it only reloads every 1 second. Use the `interval:` argument
+    # to change this frequency:
+    #
+    # chain.add CaptainConfig::SidekiqMiddlewareFactory.build(interval: 5.0)
+  end
+end
+```
+
 ## Contributing
 
+Clone the repo and run `bundle install` to get started developing locally.
+
+There are integration specs which set up a sample Rails application and run tests against it. As that takes some time (more than a few seconds), there is a script to run just the non-integration specs:
+
+```sh
+./script/rspec-without-integration
+```
+
+Arguments are forwarded to RSpec, so if you want to run an individual spec file:
+
+```sh
+./script/rspec-without-integration spec/captain_config_spec.rb
+```
+
 Bug reports and pull requests are welcome on [the GitHub repository](https://github.com/dirk/captain_config).
 
 ## Code of Conduct

data/captain_config.gemspec

@@ -46,5 +46,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'timecop', '~> 0.9'
   spec.add_development_dependency 'wait_for_it', '~> 0.2'
 end

data/lib/captain_config.rb

@@ -10,6 +10,7 @@ module CaptainConfig
 
   autoload_under 'middlewares' do
     autoload :PumaMiddleware
+    autoload :SidekiqMiddlewareFactory
   end
 
   autoload_under 'models' do

data/lib/captain_config/middlewares/sidekiq_middleware_factory.rb

@@ -0,0 +1,54 @@
+module CaptainConfig::SidekiqMiddlewareFactory
+  # Since Sidekiq calls `.new` on the middleware class for every job we cannot
+  # store state in the instance between jobs like we would with a Rack
+  # middleware. Therefore we need to build a new class to hold that state.
+  #
+  # interval: - Minimum time (in seconds) that must pass between reloading
+  #             configuration.
+  def self.build(interval: 1.0)
+    klass = Class.new do
+      include SidekiqMiddleware
+    end
+    klass.setup(interval: interval)
+    klass
+  end
+
+  module SidekiqMiddleware
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_reader :interval, :last_loaded_at
+
+      def setup(interval:)
+        @interval = interval
+        @mutex = Mutex.new
+        @last_loaded_at = Time.at(0)
+      end
+
+      def needs_load?
+        (Time.now - @last_loaded_at) >= @interval
+      end
+
+      def load
+        @mutex.synchronize do
+          # The instances of the middleware on each thread call `#needs_load?`
+          # unsynchronized, so they may think a reload is needed when it isn't.
+          return unless needs_load?
+
+          service = CaptainConfig::Service.last_created_service
+          service&.load
+
+          @last_loaded_at = Time.now
+        end
+      end
+    end
+
+    def call(_worker, _job, _queue)
+      self.class.load if self.class.needs_load?
+
+      yield
+    end
+  end
+end

data/lib/captain_config/models/boolean_config.rb

@@ -26,6 +26,10 @@ class CaptainConfig::BooleanConfig < CaptainConfig::BaseConfig
       true
     when 'false'
       false
+    when true
+      true
+    when false
+      false
     else
       raise ArgumentError.new("Cannot coerce value: #{value.inspect}")
     end

data/lib/captain_config/service.rb

@@ -40,7 +40,7 @@ class CaptainConfig::Service
     configs.value.fetch key
   end
 
-  def set(key, new_value, coerce: false)
+  def set(key, new_value, coerce: true)
     assert_loaded!
 
     record = configured_entries.fetch(key).model.find_or_create_by!(key: key)

data/lib/captain_config/version.rb

@@ -1,3 +1,3 @@
 module CaptainConfig
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/script/rspec-without-integration

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec --exclude-pattern "spec/integration/**/*" $@

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: captain_config
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dirk Gadsden
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: wait_for_it
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,7 @@ files:
 - lib/captain_config.rb
 - lib/captain_config/configured_entry.rb
 - lib/captain_config/middlewares/puma_middleware.rb
+- lib/captain_config/middlewares/sidekiq_middleware_factory.rb
 - lib/captain_config/models/base_config.rb
 - lib/captain_config/models/boolean_config.rb
 - lib/captain_config/models/integer_config.rb
@@ -159,6 +174,7 @@ files:
 - lib/captain_config/version.rb
 - lib/generators/captain_config_generator.rb
 - lib/generators/templates/create_captain_configs.rb.tt
+- script/rspec-without-integration
 homepage: https://github.com/dirk/captain_config
 licenses: []
 metadata: