restforce-db 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 407cce0ebad34c7bc0ae9f7be7ddc30a447946e0
-  data.tar.gz: f3a011122809e8f20fc187c8fb3f304b1316d14d
+  metadata.gz: a2214ab04231e0cbbc83e59248f3f3ec794c01c4
+  data.tar.gz: 560a485242bce00d2b9d219c8775c6854736bb59
 SHA512:
-  metadata.gz: 2468e281554a0b657f18bada83b0ba75f8ffa1cdd8368a7dd04333274443d79d474aab6562effea8cd8444e793c11408915c5d57e7b4c01144bc66a9320b5e9c
-  data.tar.gz: 88e9bd543a9ce246eee0074abec601b997f582c66cd63d4052b3e6a6c2340f346679f059662c5ca1eecc95eb1d05a4cad3fc455f92299320b87ed58316ae1cf8
+  metadata.gz: cbde0d9e95daf9e7eace6492aa9fb3a552bc766c807b34db2ea24ef369b8471651784244b767024db2b8d3e1f904b4e2d3cb4325d85b8a6c325515a0233fbf87
+  data.tar.gz: 928e76319b07d113d6d551a4128307ed4d63bc77c3fcf104201fff6fe2aa25167fbd49f508640ae166b97ae4d1e464718ccff23948eafd63a92353626dc584db

data/README.md

@@ -224,6 +224,18 @@ For additional information and a full set of options, you can run:
 
     $ bundle exec bin/restforce-db -h
 
+#### Configuring the daemon's runtime environment
+
+Restforce::DB allows you to configure up a block of code which will execute when the daemon process forks. In an initializer (or any other piece of code which will run as your application spins up), you can use `config.after_fork` to set up this hook:
+
+```ruby
+Restforce::DB.configure do |config|
+  config.after_fork { ActiveRecord::Base.logger = nil }
+end
+```
+
+The example above would disable the default ActiveRecord logging specifically for activity triggered by the Restforce::DB daemon.
+
 ## System Caveats
 
 - **API Usage.** 

data/lib/restforce/db/command.rb

@@ -56,9 +56,16 @@ module Restforce
       def run(options = {})
         Dir.chdir(Rails.root)
 
-        Restforce::DB::Worker.after_fork
         Restforce::DB.logger = logger
 
+        # This hook comes from the FileDaemon module, and keeps file descriptors
+        # opened after the process forks.
+        Restforce::DB::Worker.after_fork
+
+        # This hook can be configured in an initializer, and allows changes to
+        # the runtime environment after the process forks.
+        Restforce::DB.after_fork
+
         worker = Restforce::DB::Worker.new(options)
         worker.logger = logger
         worker.tracker = tracker

data/lib/restforce/db/configuration.rb

@@ -18,8 +18,31 @@ module Restforce
         client_secret
         host
         api_version
+        logger
       ))
 
+      # Public: Allow an after_fork callback to be configured or run. Runs the
+      # previously-configured block if called without arguments.
+      #
+      # block - A block of code to execute after process forking.
+      #
+      # Returns nothing.
+      def after_fork(&block)
+        if block_given?
+          @after_fork ||= block
+        else
+          @after_fork.call if @after_fork
+        end
+      end
+
+      # Public: Get the configured logger. Returns a null logger if no logger
+      # has been configured yet.
+      #
+      # Returns a Logger.
+      def logger
+        @logger ||= Logger.new("/dev/null")
+      end
+
       # Public: Parse a supplied YAML file for a set of credentials, and use
       # them to populate the attributes on this configuraton object.
       #

data/lib/restforce/db/version.rb

@@ -3,7 +3,7 @@ module Restforce
   # :nodoc:
   module DB
 
-    VERSION = "2.1.4"
+    VERSION = "2.1.5"
 
   end
 

data/lib/restforce/db.rb

@@ -57,7 +57,15 @@ module Restforce
     class << self
 
       attr_accessor :last_run
-      attr_writer :configuration, :logger
+      attr_writer :configuration
+
+      extend Forwardable
+      def_delegators(
+        :configuration,
+        :logger,
+        :logger=,
+        :after_fork,
+      )
 
     end
 
@@ -68,13 +76,6 @@ module Restforce
       @configuration ||= Configuration.new
     end
 
-    # Public: Get the current logger for Restforce::DB.
-    #
-    # Returns a Logger instance.
-    def self.logger
-      @logger ||= Logger.new("/dev/null")
-    end
-
     # Public: Get a Restforce client based on the currently configured settings.
     #
     # Returns a Restforce::Data::Client instance.

data/test/lib/restforce/db/configuration_test.rb

@@ -8,6 +8,39 @@ describe Restforce::DB::Configuration do
   let(:secrets_file) { File.expand_path("../../../../config/secrets.yml", __FILE__) }
   let(:configuration) { Restforce::DB::Configuration.new }
 
+  describe "#after_fork" do
+
+    it "does nothing if invoked without a block" do
+      # NOTE: We're asserting that this invocation doesn't raise an error.
+      configuration.after_fork
+    end
+
+    it "does not invoke the block on configuration" do
+      a = 1
+
+      configuration.after_fork { a += 1 }
+
+      expect(a).to_equal 1
+    end
+
+    it "invokes the configured block when called without arguments" do
+      a = 1
+
+      configuration.after_fork { a += 1 }
+      configuration.after_fork
+
+      expect(a).to_equal 2
+    end
+  end
+
+  describe "#logger" do
+
+    it "defaults to a null logger" do
+      log_device = configuration.logger.instance_variable_get("@logdev")
+      expect(log_device.dev.path).to_equal "/dev/null"
+    end
+  end
+
   describe "#load" do
 
     describe "when all configurations are supplied" do

data/test/lib/restforce/db_test.rb

@@ -4,20 +4,6 @@ describe Restforce::DB do
 
   configure!
 
-  describe "#logger" do
-
-    it "defaults to a null logger" do
-      log_device = Restforce::DB.logger.instance_variable_get("@logdev")
-      expect(log_device.dev.path).to_equal "/dev/null"
-    end
-
-    it "allows assignment of a new logger" do
-      logger = Logger.new("/dev/null")
-      Restforce::DB.logger = logger
-      expect(Restforce::DB.logger).to_equal logger
-    end
-  end
-
   describe "#configure" do
 
     it "yields a Configuration" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Andrew Horner
@@ -193,7 +193,6 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop/custom/method_documentation.rb"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.0