stockpile 1.1 → 2.0

data/Manifest.txt

@@ -1,10 +1,14 @@
 .autotest
 .gemtest
 .minitest.rb
+.rubocop.yml
+.simplecov-prelude.rb
 .travis.yml
+.workenv
+Code-of-Conduct.md
 Contributing.rdoc
 Gemfile
-History.rdoc
+History.md
 Licence.rdoc
 Manifest.txt
 README.rdoc

data/README.rdoc

@@ -2,7 +2,7 @@
 
 code :: https://github.com/halostatue/stockpile/
 bugs :: https://github.com/halostatue/stockpile/issues
-continuous integration :: {<img src="https://travis-ci.org/halostatue/stockpile.png" />}[https://travis-ci.org/halostatue/stockpile]
+continuous integration :: {<img src="https://travis-ci.org/halostatue/stockpile.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/halostatue/stockpile]
 
 == Description
 
@@ -14,11 +14,10 @@ implemented connection managers. So far, only Redis has been implemented
 Stockpile also provides an adapter so that its functionality can be accessed
 from within a module.
 
-Release 1.1 fixes an issue with early initialization of an injected Stockpile
-instance during adaptation
-({stockpile#2}[https://githbub.com/halostatue/stockpile/issues/2]). Several
-small improvements to Stockpile.new, Stockpile#connect, and
-Stockpile#connection_for have been documented.
+Release 2.0 fixes an issue when Stockpile options are provided with an
+OpenStruct, originally reported as
+{stockpile-redis#1}[https://github.com/halostatue/stockpile-redis/issues/1].
+Support for Ruby 1.9 has been dropped.
 
 == Features
 

data/Rakefile

@@ -1,53 +1,61 @@
 # -*- ruby -*-
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'hoe'
 require 'rake/clean'
 
 Hoe.plugin :doofus
+Hoe.plugin :email unless ENV['CI'] || ENV['TRAVIS']
 Hoe.plugin :gemspec2
 Hoe.plugin :git
 Hoe.plugin :minitest
 Hoe.plugin :travis
-Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
 
 spec = Hoe.spec 'stockpile' do
   developer('Austin Ziegler', 'halostatue@gmail.com')
 
-  self.history_file = 'History.rdoc'
+  self.history_file = 'History.md'
   self.readme_file = 'README.rdoc'
-  self.extra_rdoc_files = FileList["*.rdoc"].to_a
-
-  license "MIT"
-
-  self.need_tar = true
-  self.require_ruby_version '>= 1.9.2'
-
-  self.extra_dev_deps << ['hoe-doofus', '~> 1.0']
-  self.extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
-  self.extra_dev_deps << ['hoe-git', '~> 1.5']
-  self.extra_dev_deps << ['hoe-travis', '~> 1.2']
-  self.extra_dev_deps << ['minitest', '~> 5.4']
-  self.extra_dev_deps << ['minitest-around', '~> 0.3']
-  self.extra_dev_deps << ['minitest-autotest', '~> 1.0']
-  self.extra_dev_deps << ['minitest-bisect', '~> 1.2']
-  self.extra_dev_deps << ['minitest-focus', '~> 1.1']
-  self.extra_dev_deps << ['minitest-moar', '~> 0.0']
-  self.extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
-  self.extra_dev_deps << ['rake', '>= 10.0']
-  self.extra_dev_deps << ['simplecov', '~> 0.7']
+
+  license 'MIT'
+
+  require_ruby_version '>= 2.0'
+
+  extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  extra_dev_deps << ['hoe-git', '~> 1.5']
+  extra_dev_deps << ['hoe-travis', '~> 1.2']
+  extra_dev_deps << ['minitest', '~> 5.4']
+  extra_dev_deps << ['minitest-autotest', '~> 1.0']
+  extra_dev_deps << ['minitest-bisect', '~> 1.2']
+  extra_dev_deps << ['minitest-bonus-assertions', '~> 2.0']
+  extra_dev_deps << ['minitest-focus', '~> 1.1']
+  extra_dev_deps << ['minitest-moar', '~> 0.0']
+  extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
+  extra_dev_deps << ['rake', '>= 10.0']
+  extra_dev_deps << ['simplecov', '~> 0.7']
+end
+
+module Hoe::Publish
+  alias_method :original_make_rdoc_cmd, :make_rdoc_cmd
+
+  def make_rdoc_cmd(*extra_args) # :nodoc:
+    spec.extra_rdoc_files.reject! { |f| f == 'Manifest.txt' }
+    original_make_rdoc_cmd(*extra_args)
+  end
 end
 
 namespace :test do
   task :coverage do
-    spec.test_prelude = [
-      'require "simplecov"',
-      'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
-      'gem "minitest"'
-    ].join('; ')
+    spec.test_prelude = %q(load ".simplecov-prelude.rb")
+
     Rake::Task['test'].execute
   end
+
   CLOBBER << 'coverage'
 end
 
+CLOBBER << 'tmp'
+
 # vim: syntax=ruby

data/lib/stockpile.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'forwardable'
 
@@ -14,7 +14,7 @@ require 'forwardable'
 class Stockpile
   extend Forwardable
 
-  VERSION = "1.1" # :nodoc:
+  VERSION = '2.0' # :nodoc:
 
   @default_manager = nil
 
@@ -75,7 +75,7 @@ class Stockpile
     #   LastRunTime.last_run_time('adaptable_application')
     def inject!(mod, options = {})
       unless mod.kind_of?(Module)
-        raise ArgumentError, "#{mod} is not a class or module"
+        fail ArgumentError, "#{mod} is not a class or module"
       end
 
       name    = options.fetch(:method, :cache).to_sym
@@ -174,7 +174,7 @@ class Stockpile
     default = options.delete(:default_manager) || self.class.default_manager
 
     unless manager || default
-      raise ArgumentError, "No connection manager provided or set as default."
+      fail ArgumentError, 'No connection manager provided or set as default.'
     end
 
     manager ||= default

data/lib/stockpile/base.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'stockpile'
 
@@ -28,6 +28,7 @@ class Stockpile
     #               manager.
     def initialize(options = {})
       @options    = options.dup
+      @options    = options.to_h unless @options.kind_of?(Hash)
       @narrow     = !!@options.fetch(:narrow, ::Stockpile.narrow?)
       @connection = nil
       @clients    = {}
@@ -121,6 +122,7 @@ class Stockpile
     end
 
     private
+
     # Converts +client_names+ into a hash of client names to options.
     #
     # * A Hash object, mapping client names to client options.
@@ -169,18 +171,18 @@ class Stockpile
     end
 
     # Performs a client connect action. Must be implemented by a client.
-    def client_connect(name = nil, options = {})
-      raise NotImplementedError
+    def client_connect(_name = nil, _options = {})
+      fail NotImplementedError
     end
 
     # Performs a client reconnect action. Must be implemented by a client.
-    def client_reconnect(client = connect())
-      raise NotImplementedError
+    def client_reconnect(_client = connect)
+      fail NotImplementedError
     end
 
     # Performs a client disconnect action. Must be implemented by a client.
-    def client_disconnect(client = connect())
-      raise NotImplementedError
+    def client_disconnect(_client = connect)
+      fail NotImplementedError
     end
   end
 end

data/lib/stockpile/memory.rb

@@ -1,4 +1,4 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
 require 'stockpile/base'
 
@@ -49,18 +49,19 @@ class Stockpile
       end
 
       def hget(key, field)
-        raise unless connected?
+        fail unless connected?
         valid_hkey!(key)[field]
       end
 
       def hset(key, field, value)
-        raise unless connected?
+        fail unless connected?
         valid_hkey!(key)[field] = value
       end
 
       private
+
       def check_valid!
-        raise unless connected?
+        fail unless connected?
       end
 
       def valid_hkey!(key)
@@ -71,7 +72,7 @@ class Stockpile
         when Hash
           nil
         else
-          raise
+          fail
         end
         h
       end
@@ -153,17 +154,19 @@ class Stockpile
     # which disconnects all connections implicitly.
 
     ##
+
     private
-    def client_connect(name = nil, options = {})
+
+    def client_connect(_name = nil, options = {})
       return connection if connection && narrow?
       Data.new(@options.merge(options))
     end
 
-    def client_reconnect(client = connection())
+    def client_reconnect(client = connection)
       client.reconnect if client
     end
 
-    def client_disconnect(client = connection())
+    def client_disconnect(client = connection)
       client.disconnect if client
     end
   end

data/test/minitest_config.rb

@@ -1,4 +1,4 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
 gem 'minitest'
 require 'minitest/autorun'
@@ -18,11 +18,7 @@ module Minitest::ENVStub
   def stub_env env, options = {}, *block_args, &block
     mock = lambda { |key|
       env.fetch(key) { |k|
-        if options[:passthrough]
-          ENV.send(:"__minitest_stub__[]", k)
-        else
-          nil
-        end
+        ENV.send(:"__minitest_stub__[]", k) if options[:passthrough]
       }
     }
 

data/test/test_stockpile.rb

@@ -1,22 +1,23 @@
+# frozen_string_literal: true
 require 'minitest_config'
 require 'time'
 
 describe Stockpile do
-  describe ".narrow?" do
-    it "is wide by default" do
+  describe '.narrow?' do
+    it 'is wide by default' do
       stub_env({}) do
         refute Stockpile.narrow?
       end
     end
 
-    it "is narrow when $STOCKPILE_CONNECTION_WIDTH = 'narrow'" do
-      stub_env({ 'STOCKPILE_CONNECTION_WIDTH' => 'narrow' }) do
+    it %q(is narrow when $STOCKPILE_CONNECTION_WIDTH = 'narrow') do
+      stub_env('STOCKPILE_CONNECTION_WIDTH' => 'narrow') do
         assert Stockpile.narrow?
       end
     end
   end
 
-  describe ".inject!" do
+  describe '.inject!' do
     let(:cls) { Class.new }
     let(:mod) { Module.new }
     let(:lrt) {
@@ -40,86 +41,86 @@ describe Stockpile do
       end
     }
 
-    it "throws an ArgumentError unless it's a class or module" do
+    it %q(throws an ArgumentError unless it's a class or module) do
       assert_raises ArgumentError do
         ::Stockpile.inject!(Object.new)
       end
     end
 
-    describe "Stockpile.inject!(Module):" do
+    describe 'Stockpile.inject!(Module):' do
       before { ::Stockpile.inject!(mod) }
 
-      it "defines Mod.cache" do
+      it 'defines Mod.cache' do
         assert_respond_to mod, :cache
       end
 
-      it "defines Mod.cache_adapter" do
+      it 'defines Mod.cache_adapter' do
         assert_respond_to mod, :cache_adapter
       end
 
-      it "defines Mod.cache_adapter!" do
+      it 'defines Mod.cache_adapter!' do
         assert_respond_to mod, :cache_adapter!
       end
 
-      it "Fails cache initialization" do
+      it 'Fails cache initialization' do
         assert_raises ArgumentError do
           mod.cache
         end
       end
     end
 
-    describe "Stockpile.inject!(Mod, adaptable: false)" do
+    describe 'Stockpile.inject!(Mod, adaptable: false)' do
       before { ::Stockpile.inject!(mod, adaptable: false) }
 
-      it "defines Mod.cache" do
+      it 'defines Mod.cache' do
         assert_respond_to mod, :cache
       end
 
-      it "does not define Mod.cache_adapter or Mod.cache_adapter!" do
+      it 'does not define Mod.cache_adapter or Mod.cache_adapter!' do
         refute_respond_to mod, :cache_adapter
         refute_respond_to mod, :cache_adapter!
       end
     end
 
-    describe "Stockpile.inject!(Mod, method: stockpile)" do
+    describe 'Stockpile.inject!(Mod, method: stockpile)' do
       before { ::Stockpile.inject!(mod, method: :stockpile) }
 
-      it "defines Mod.stockpile" do
+      it 'defines Mod.stockpile' do
         assert_respond_to mod, :stockpile
       end
 
-      it "defines Mod.stockpile_adapter" do
+      it 'defines Mod.stockpile_adapter' do
         assert_respond_to mod, :stockpile_adapter
       end
 
-      it "defines Mod.stockpile_adapter!" do
+      it 'defines Mod.stockpile_adapter!' do
         assert_respond_to mod, :stockpile_adapter!
       end
     end
 
-    describe "Stockpile.inject!(Mod, method: :stockpile, adaptable: false)" do
+    describe 'Stockpile.inject!(Mod, method: :stockpile, adaptable: false)' do
       before do
         ::Stockpile.inject!(mod, method: :stockpile, adaptable: false)
       end
 
-      it "defines Mod.stockpile" do
+      it 'defines Mod.stockpile' do
         assert_respond_to mod, :stockpile
       end
 
-      it "does not define Mod.stockpile_adapter or Mod.stockpile_adapter!" do
+      it 'does not define Mod.stockpile_adapter or Mod.stockpile_adapter!' do
         refute_respond_to mod, :stockpile_adapter
         refute_respond_to mod, :stockpile_adapter!
       end
     end
 
-    describe "Mod.cache_adapter" do
+    describe 'Mod.cache_adapter' do
       let(:now) { Time.now }
       let(:iso) { now.utc.iso8601 }
       before do
         ::Stockpile.inject!(mod, default_manager: Stockpile::Memory)
       end
 
-      it "queues adaptation until Stockpile has been initialized" do
+      it 'queues adaptation until Stockpile has been initialized' do
         stub Stockpile, :new do
           mod.cache_adapter(lrt)
           refute_called Stockpile, :new
@@ -127,13 +128,12 @@ describe Stockpile do
           refute_empty mod.instance_variable_get(:@__stockpile_triggers__)
         end
 
-        assert_equal({ namespace: 'n' },
-                     mod.cache(namespace: 'n').connection.options)
+        assert_equal({ namespace: 'n' }, mod.cache(namespace: 'n').connection.options)
         assert_respond_to mod.cache, :last_run_time
         assert_respond_to mod.cache, :job_ran
       end
 
-      it "adapts an initialized Stockpile immediately" do
+      it 'adapts an initialized Stockpile immediately' do
         mod.cache
         mod.cache_adapter(lrt)
         assert_respond_to mod.cache, :last_run_time
@@ -141,42 +141,42 @@ describe Stockpile do
         assert_empty mod.instance_variable_get(:@__stockpile_triggers__)
       end
 
-      it "adapts the cache with last_run_time" do
+      it 'adapts the cache with last_run_time' do
         mod.cache_adapter(lrt)
         assert_nil mod.cache.last_run_time('foo')
         assert_equal iso, mod.cache.last_run_time('foo', now)
         assert_equal now.to_i, mod.cache.last_run_time('foo').to_i
       end
 
-      it "adapts the module with last_run_time" do
+      it 'adapts the module with last_run_time' do
         mod.cache_adapter(lrt, mod)
         assert_nil mod.last_run_time('foo')
         assert_equal iso, mod.last_run_time('foo', now)
         assert_equal now.to_i, mod.last_run_time('foo').to_i
       end
 
-      it "adapts the lrt module with last_run_time" do
+      it 'adapts the lrt module with last_run_time' do
         mod.cache_adapter!(lrt)
         assert_nil lrt.last_run_time('foo')
         assert_equal iso, lrt.last_run_time('foo', now)
         assert_equal now.to_i, lrt.last_run_time('foo').to_i
       end
 
-      it "adapts the cache with job_ran" do
+      it 'adapts the cache with job_ran' do
         mod.cache_adapter(lrt)
         refute mod.cache.job_ran('foo')
         assert mod.cache.job_ran('foo', true)
         assert mod.cache.job_ran('foo')
       end
 
-      it "adapts the module with last_run_time" do
+      it 'adapts the module with last_run_time' do
         mod.cache_adapter(lrt, mod)
         refute mod.job_ran('foo')
         assert mod.job_ran('foo', true)
         assert mod.job_ran('foo')
       end
 
-      it "adapts the lrt module with last_run_time" do
+      it 'adapts the lrt module with last_run_time' do
         mod.cache_adapter!(lrt)
         refute lrt.job_ran('foo')
         assert lrt.job_ran('foo', true)
@@ -184,22 +184,22 @@ describe Stockpile do
       end
     end
 
-    describe "Stockpile.inject!(Class):" do
+    describe 'Stockpile.inject!(Class):' do
       before { ::Stockpile.inject!(cls) }
 
-      it "defines cls.cache" do
+      it 'defines cls.cache' do
         assert_respond_to cls, :cache
       end
 
-      it "defines cls.cache_adapter" do
+      it 'defines cls.cache_adapter' do
         assert_respond_to cls, :cache_adapter
       end
 
-      it "defines cls.cache_adapter!" do
+      it 'defines cls.cache_adapter!' do
         assert_respond_to cls, :cache_adapter!
       end
 
-      it "Fails cache initialization" do
+      it 'Fails cache initialization' do
         assert_raises ArgumentError do
           cls.cache
         end