firebolt 0.13.0 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0065c480c50f012bb42b0721eea423e5900870b0
-  data.tar.gz: 94eb5045e18dd501a20edf20a81c3223b4346b48
+  metadata.gz: c5f6d3818aa3574b3122735bda4c7687ed19bdf4
+  data.tar.gz: 04fd500afdae9d599e22f6599b3ec5ab2ab743e0
 SHA512:
-  metadata.gz: ffa7d19032757582ecdc2bc0fa16254cafd8853f83ea74c67a99eb681e2fc5930df49b18043522a451f915b38b788af2d0150f11068fb1e7dc7d2de13b5e6a4d
-  data.tar.gz: 6aed00633b8315bdead63914601d285d1d04f66bc141a72d931a2305959288c48e5975897b78c8a253851f20e5cf0a34c8cfd7ac4983be75c235708d0be21809
+  metadata.gz: 96299bfa9cf4729757264a178ea7c1981e86ffc194a3f1e9851da4805be9f7aebf13b716166e25ef82207e95f72634ae237855e9adb402d5cc97930df14d6fb1
+  data.tar.gz: 01844bf0b93e6b574da623e140f8b25edbf83cf7c910b8b0ddae452d3f1723b4e41aef044a45bfc19b511f2fd16c5c18890d3df3c0ba4487d21b9c9d50a3bc6b

data/firebolt.gemspec

@@ -24,9 +24,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json"
   spec.add_dependency "rufus-scheduler", "~> 3.0"
   spec.add_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_dependency "activesupport"
 
   ##
   # Development Dependencies
   #
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/firebolt/cache.rb

@@ -3,36 +3,36 @@ module Firebolt
     include ::Firebolt::Keys
 
     def delete(key_suffix, options = nil)
-      salted_key = self.cache_key_with_salt(key_suffix, salt)
+      salted_key = cache_key_with_salt(key_suffix, salt)
       return nil if salted_key.nil?
 
       ::Firebolt.config.cache.delete(salted_key, options)
     end
 
-    def fetch(suffix, options = nil, &block)
-      salted_key = self.cache_key_with_salt(key_suffix, salt)
+    def fetch(key_suffix, options = nil, &block)
+      salted_key = cache_key_with_salt(key_suffix, salt)
       return nil if salted_key.nil?
 
       ::Firebolt.config.cache.fetch(salted_key, options, &block)
     end
 
     def read(key_suffix, options = nil)
-      salted_key = self.cache_key_with_salt(key_suffix, salt)
+      salted_key = cache_key_with_salt(key_suffix, salt)
       return nil if salted_key.nil?
 
       ::Firebolt.config.cache.read(salted_key, options)
     end
 
     def reset_salt!(new_salt)
-      ::Firebolt.config.cache.write(self.salt_key, new_salt)
+      ::Firebolt.config.cache.write(salt_key, new_salt)
     end
 
     def salt
-      ::Firebolt.config.cache.read(self.salt_key)
+      ::Firebolt.config.cache.read(salt_key)
     end
 
     def write(key_suffix, value, options = {})
-      salted_key = self.cache_key_with_salt(key_suffix, salt)
+      salted_key = cache_key_with_salt(key_suffix, salt)
       return nil if salted_key.nil?
 
       options.merge!(:expires_in => ::Firebolt.config.warming_frequency + 1.hour)

data/lib/firebolt/config.rb

@@ -78,7 +78,7 @@ module Firebolt
 
     def warmer=(value)
       raise ArgumentError, "Warmer must include the ::Firebolt::Warmer module." unless value.ancestors.include?(::Firebolt::Warmer)
-      raise ArgumentError, "Warmer must respond to `perform`." unless value.instance_methods.include?(:perform)
+      raise ArgumentError, "Warmer must respond to #perform." unless value.instance_methods.include?(:perform)
 
       self[:warmer] = value
     end

data/lib/firebolt/file_warmer.rb

@@ -7,7 +7,7 @@ module Firebolt
     def perform
       return nil unless cache_file_exists?
 
-      return parsed_contents
+      parsed_contents
     end
 
   private

data/lib/firebolt/version.rb

@@ -1,3 +1,3 @@
 module Firebolt
-  VERSION = "0.13.0"
+  VERSION = "0.13.2"
 end

data/lib/firebolt.rb

@@ -1,3 +1,6 @@
+require "active_support"
+require "active_support/core_ext/numeric"
+
 require "json"
 require "securerandom"
 require "concurrent"
@@ -17,20 +20,21 @@ module Firebolt
   extend ::Firebolt::Cache
 
   # Using a mutex to control access while creating a ::Firebolt::Config
-  @firebolt_mutex = ::Mutex.new
+  FIREBOLT_MUTEX = ::Mutex.new
+  CONFIGURE_MUTEX = ::Mutex.new
 
   def self.config
     return @config unless @config.nil?
 
-    @firebolt_mutex.synchronize do
-      @config = ::Firebolt::Config.new if @config.nil?
+    FIREBOLT_MUTEX.synchronize do
+      @config ||= ::Firebolt::Config.new
     end
 
-    return @config
+    @config
   end
 
   def self.configure
-    ::Thread.exclusive do
+    CONFIGURE_MUTEX.synchronize do
       yield(config)
     end
   end
@@ -42,7 +46,7 @@ module Firebolt
 
     scheduler = ::Rufus::Scheduler.new
     scheduler.every(warming_frequency) do
-      ::Firebolt::WarmCacheJob.new.async.perform(config.warmer)
+      ::Firebolt::WarmCacheJob.new.perform(config.warmer)
     end
   end
 
@@ -66,11 +70,11 @@ module Firebolt
   def self.initialized!
     return @initialized unless @initialized.nil?
 
-    @firebolt_mutex.synchronize do
-      @initialized = true if @initialized.nil?
+    FIREBOLT_MUTEX.synchronize do
+      @initialized ||= true
     end
 
-    return @initialized
+    @initialized
   end
 
   def self.initialized?

data/spec/lib/firebolt/cache_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+describe ::Firebolt::Cache do
+  mock_firebolt_cache!
+  subject { klass.new }
+  let(:klass) { ::Class.new { include ::Firebolt::Cache } }
+
+  let(:key_suffix) { "test" }
+  let(:options) { { :some => :thing } }
+  let(:salt) { "1234" }
+  let(:salt_key) { "firebolt.mx.salt" }
+  let(:salted_key) { "yolo" }
+
+  before do
+    ::Firebolt.config.namespace = "mx"
+    ::Firebolt.config.warming_frequency = 1000
+  end
+
+  context "with a valid salt key" do
+    before do
+      allow(subject).to receive(:salt_key).and_return(salt_key)
+      allow(subject).to receive(:salt).and_return(salt)
+      allow(subject).to receive(:cache_key_with_salt).with(key_suffix, salt).and_return(salted_key)
+    end
+
+    describe "#delete" do
+      it "deletes the key" do
+        expect(::Firebolt.config.cache).to receive(:delete).with(salted_key, options)
+        subject.delete(key_suffix, options)
+      end
+    end
+
+    describe "#fetch" do
+      it "fetches out the key" do
+        expect(::Firebolt.config.cache).to receive(:fetch).with(salted_key, options)
+        subject.fetch(key_suffix, options)
+      end
+    end
+
+    describe "#read" do
+      it "reads out the key" do
+        expect(::Firebolt.config.cache).to receive(:read).with(salted_key, options)
+        subject.read(key_suffix, options)
+      end
+    end
+
+    describe "#write" do
+      let(:merged_options) { options.merge(:expires_in => 4600) }
+      let(:value) { "idk" }
+
+      it "write the key" do
+        expect(::Firebolt.config.cache).to receive(:write).with(salted_key, value, merged_options)
+        subject.write(key_suffix, value, options)
+      end
+    end
+  end
+
+  describe "#reset_salt!" do
+    let(:new_salt_key) { "new_salt_key" }
+
+    it "can reset the salt key" do
+      expect(::Firebolt.config.cache).to receive(:write).with(salt_key, new_salt_key)
+      subject.reset_salt!(new_salt_key)
+    end
+  end
+
+  describe "#salt" do
+    it "can get the salt key" do
+      expect(::Firebolt.config.cache).to receive(:read).with(salt_key)
+      subject.salt
+    end
+  end
+end

data/spec/lib/firebolt/config_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe ::Firebolt::Config do
+  subject { described_class.new(options) }
+
+  let(:options) { { :namespace => "mx" } }
+
+  describe ".hash_accessor" do
+    it "creates a reader and writer" do
+      described_class.hash_accessor :thing
+      expect { subject.thing = :no_way }.to_not raise_error
+      expect(subject.thing).to eq(:no_way)
+      expect(subject[:thing]).to eq(:no_way)
+    end
+  end
+
+  describe "#namespace" do
+    it "can build a namespace" do
+      expect(subject.namespace).to eq("firebolt.mx")
+    end
+  end
+
+  describe "#warmer=" do
+    context "when does not include ::Firebolt::Warmer" do
+      it "raises an error" do
+        expect { subject.warmer = ::String }.to raise_error(::ArgumentError, /must include the ::Firebolt::Warmer/)
+      end
+    end
+
+    context "when does not have a #perform method" do
+      let(:warmer) { ::Class.new { include ::Firebolt::Warmer } }
+
+      it "raises an error" do
+        expect { subject.warmer = warmer }.to raise_error(::ArgumentError, /must respond to #perform/)
+      end
+    end
+
+    context "when includes ::Firebolt::Warmer and responsd to #perform" do
+      let(:warmer) do
+        ::Class.new do
+          include ::Firebolt::Warmer
+
+          def perform
+          end
+        end
+      end
+
+      it "does not raise an error" do
+        expect { subject.warmer = warmer }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/lib/firebolt/key_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe ::Firebolt::Keys do
+  let(:klass) { ::Class.new { include ::Firebolt::Keys } }
+  subject { klass.new }
+
+  before { ::Firebolt.config.namespace = "mx" }
+
+  describe "#cache_key" do
+    it "creates a cache key via a namespace" do
+      expect(subject.cache_key("yolo")).to eq("firebolt.mx.yolo")
+    end
+  end
+
+  describe "#cache_key_with_salt" do
+    it "creates a cache key with key suffix" do
+      expect(subject.cache_key_with_salt("yolo", "test")).to eq("firebolt.mx.test.yolo")
+    end
+  end
+
+  describe "#namespace" do
+    it "gets the namespace from the config" do
+      expect(subject.namespace).to eq("firebolt.mx")
+    end
+  end
+
+  describe "#salt_key" do
+    it "creates a salt key" do
+      expect(subject.salt_key).to eq("firebolt.mx.salt")
+    end
+  end
+end

data/spec/lib/firebolt/warmer_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe ::Firebolt::Warmer do
+  mock_firebolt_cache!
+
+  let(:klass) do
+    ::Class.new do
+      include ::Firebolt::Warmer
+
+      def initialize(results)
+        @results = results
+      end
+
+      def perform
+        @results
+      end
+    end
+  end
+  subject { klass.new(results) }
+  let(:results) { { "some" => "thing" } }
+
+  before do
+    ::Firebolt.config.namespace = "mx"
+    ::Firebolt.config.warming_frequency = 1000
+  end
+
+  describe "#warm" do
+    it "calls #perform on the warmer class" do
+      expect(subject).to receive(:perform).and_return(results)
+      expect(subject).to receive(:_warmer_reset_salt!)
+      expect(subject).to receive(:_warmer_write_results_to_cache).with(results)
+      subject.warm
+    end
+
+    it "writes the results of #perform to the cache" do
+      allow(subject).to receive(:_warmer_salt).and_return("test")
+      expect(subject).to receive(:_warmer_expires_in).and_return(4600)
+      expect(subject).to receive(:_warmer_salted_cache_key).with("some").and_return("firebolt.mx.test.some")
+      expect(::Firebolt.config.cache).to receive(:write).with("firebolt.mx.test.some", "thing", :expires_in => 4600)
+      subject.warm
+    end
+
+    context "when an  result that does not respond to #each_pair is returned from #perform" do
+      let(:results) { nil }
+
+      it "raises an error" do
+        expect { subject.warm }.to raise_error("Warmer must return an object that responds to #each_pair.")
+      end
+    end
+  end
+end

data/spec/lib/firebolt_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe ::Firebolt do
+  mock_firebolt_cache!
+
+  describe ".config" do
+    it "creates a config" do
+      expect(described_class.config).to be_a(Firebolt::Config)
+    end
+  end
+
+  describe ".configure" do
+    it "can be configured via a block" do
+      described_class.configure do |config|
+        expect(config).to eq(described_class.config)
+      end
+    end
+  end
+
+  describe ".initialize_rufus_scheduler" do
+    let(:scheduler) { ::Rufus::Scheduler.new }
+
+    before { ::Firebolt.config.warming_frequency = 1000 }
+
+    it "creates an instance of rufus scheduler" do
+      # TODO: Test the config.warmer call.
+      allow(::Rufus::Scheduler).to receive(:new).and_return(scheduler)
+      expect(scheduler).to receive(:every).with("1000")
+      described_class.initialize_rufus_scheduler
+    end
+  end
+
+  describe ".initialize!" do
+    let(:warmer) do
+      ::Class.new do
+        include ::Firebolt::Warmer
+
+        def perform
+          {}
+        end
+      end
+    end
+    let(:warmer_instance) { warmer.new }
+
+    before do
+      ::Firebolt.config.warming_frequency = 1000
+      ::Firebolt.config.warmer = warmer
+    end
+
+    it "calls the warmer" do
+      expect(warmer).to receive(:new).and_return(warmer_instance)
+      expect(warmer_instance).to receive(:warm)
+      described_class.initialize!
+      sleep 0.1 # Await async future to complete
+    end
+  end
+
+  describe ".skip_warming?" do
+    context "when firebolt set to skip" do
+      before { ENV["FIREBOLT_SKIP_WARMING"] = "true" }
+      after { ENV["FIREBOLT_SKIP_WARMING"] = nil }
+
+      it "skips the warming" do
+        expect(described_class).to be_skip_warming
+      end
+    end
+
+    context "when rails testing mode" do
+      before { ENV["RAILS_ENV"] = "test" }
+      after { ENV["RAILS_ENV"] = nil }
+
+      it "skips the warming" do
+        expect(described_class).to be_skip_warming
+      end
+    end
+
+    context "when no skip flags are set" do
+      before { ENV["FIREBOLT_SKIP_WARMING"] = nil }
+      after { ENV["FIREBOLT_SKIP_WARMING"] = "true" }
+
+      it "does not skip the warming" do
+        expect(described_class).to_not be_skip_warming
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require "firebolt"
+require "pry"
+
+RSpec.configure do
+  def mock_firebolt_cache!
+    let(:_mock_firebolt_cache) { double(:write => nil, :fetch => nil, :delete => nil, :read => nil) }
+
+    before { ::Firebolt.config.cache = _mock_firebolt_cache }
+    after { ::Firebolt.config.cache = nil }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firebolt
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.2
 platform: ruby
 authors:
 - Adam Hutchison
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -53,6 +53,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Simple little cache warmer.
 email:
 - liveh2o@gmail.com
@@ -91,6 +133,12 @@ files:
 - lib/firebolt/version.rb
 - lib/firebolt/warm_cache_job.rb
 - lib/firebolt/warmer.rb
+- spec/lib/firebolt/cache_spec.rb
+- spec/lib/firebolt/config_spec.rb
+- spec/lib/firebolt/key_spec.rb
+- spec/lib/firebolt/warmer_spec.rb
+- spec/lib/firebolt_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/moneydesktop/firebolt
 licenses:
 - MIT
@@ -116,4 +164,10 @@ signing_key:
 specification_version: 4
 summary: Firebolt is a simple cache warmer. It warms the cache using a specially defined
   warmer class.
-test_files: []
+test_files:
+- spec/lib/firebolt/cache_spec.rb
+- spec/lib/firebolt/config_spec.rb
+- spec/lib/firebolt/key_spec.rb
+- spec/lib/firebolt/warmer_spec.rb
+- spec/lib/firebolt_spec.rb
+- spec/spec_helper.rb