maintenance_mode 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2896353d3d28297a736ece0c8db187ea37fd1902
+  data.tar.gz: 6186d898dc13994dfdf53e2253a53327847d6b57
+SHA512:
+  metadata.gz: 2fe2567bda7e6d787e7143841c9cefd451ae04eebae92d48bbc3333f84bfc8c83f459bb695cfaad5c767d697bdc52452288e6c9df23552c2fed120f79cb19c81
+  data.tar.gz: de1b522889974b205e9fb66048101a45052d7a7b6a37257d431a9713524894ccd5f60aefb86b86e0c0d0de1cfc3b015af31f766ac3b41005ec8c8528e9ff27b3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in maintenance-mode.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 GoodGuide
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# MaintenanceMode
+
+This provides a simple interface to a "maintenance mode" toggle with optional
+maintenance message. It's not specific to maintenance mode, really, and could be
+used whenever a similar switch is needed.
+
+## Usage
+
+```ruby
+MaintenanceMode.enable
+MaintenanceMode.as_json # => { "enabled": true, "message": null }
+MaintenanceMode.enable "we'll be back soon"
+MaintenanceMode.as_json # => { "enabled": true, "message": "we'll be back soon" }
+MaintenanceMode.enabled? # => true
+MaintenanceMode.message # => "we'll be back soon"
+MaintenanceMode.disable
+MaintenanceMode.enabled? # => false
+```
+
+There are also rake tasks to toggle MaintenanceMode:
+
+```shell
+rake maintenance:enable
+rake maintenance:enable MESSAGE="Oh Noes!"
+rake 'maintenance:enable[Oh Noes!]' # also works
+rake maintenance:disable
+```
+
+To get these tasks, you'll have to add this line to your `Rakefile`:
+
+```ruby
+# Rakefile
+require 'maintenance_mode/rake_tasks'
+```
+
+## Configuration
+
+The persistence mechanism is configurable. Currently, the only one which ships with this gem just uses a file on disk.
+
+Without configuration, the library will act on memory only (which of course means rake tasks have no effect on a server process). To configure the file-based persistence, use the following:
+
+```ruby
+MaintenanceMode.persist_with :file, Rails.root.join('config/maintenance-mode')
+# equivalent to
+MaintenanceMode.persistence = MaintenanceMode::FilePersistence.new(
+    Rails.root.join('config/maintenance-mode'))
+```
+
+n.b. The argument to `FilePersistence` must be a `Pathname` instead of merely a string.
+
+### Custom logic
+
+You can set `MaintenanceMode.persistence` to any object which responds to the
+correct interface.
+
+- `enable(message=nil)`
+- `disable`
+- `enabled?`
+- `message`
+
+Here's an example using Redis for persistence (this is untested; just for example):
+
+```ruby
+class MyRedisMaintenancePersistence
+  NULL = '__null__'
+
+  def initialize(redis, key)
+    @redis = redis
+    @key = key
+  end
+
+  def enable(message=NULL)
+    @redis.set @key, message
+  end
+
+  def disable
+    @redis.del @key
+  end
+
+  def enabled?
+    !!@redis.get(@key)
+  end
+
+  def message
+    v = @redis.get(@key)
+    v == NULL ? nil : v
+  end
+end
+
+r = MyRedisMaintenancePersistence.new(Redis.new, 'maintenance-mode')
+MaintenanceMode.persistence = r
+
+# If writing as a separately distributed library, you could have your code
+# register itself:
+MaintenanceMode.register_persistence_method :redis, MyRedisMaintenancePersistence
+
+# then people can use it via:
+MaintenanceMode.persist_with :redis, Redis.new, 'maintenance-mode'
+```
+
+## Contributing
+
+Pull requests welcome.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/lib/maintenance_mode.rb

@@ -0,0 +1,48 @@
+require 'forwardable'
+require 'maintenance_mode/version'
+require 'maintenance_mode/file_persistence'
+require 'maintenance_mode/null_persistence'
+
+class MaintenanceMode
+  class << self
+    extend Forwardable
+    def_delegator :persistence, :enable
+    def_delegator :persistence, :disable
+    def_delegator :persistence, :message
+    def_delegator :persistence, :enabled?
+
+    def as_json
+      {
+        enabled: enabled?,
+        message: message,
+      }
+    end
+
+    attr_writer :persistence
+
+    def persistence
+      @persistence || NullPersistence.new
+    end
+
+    def persist_with(persistence_method, *args, &block)
+      self.persistence = persistence_methods.fetch(persistence_method).new(*args, &block)
+    end
+
+    def register_persistence_method(name, persistence_method_class)
+      persistence_methods[name] = persistence_method_class
+    end
+
+    def reset
+      @persistence_methods = nil
+      @persistence = nil
+    end
+
+    private
+
+    def persistence_methods
+      @persistence_methods ||= {
+        file: FilePersistence
+      }
+    end
+  end
+end

data/lib/maintenance_mode/file_persistence.rb

@@ -0,0 +1,28 @@
+class MaintenanceMode
+  class FilePersistence
+    def initialize(pathname)
+      @pathname = pathname
+    end
+
+    attr_reader :pathname
+
+    def enabled?
+      @pathname.file?
+    end
+
+    def enable(message='')
+      @pathname.write(message)
+    end
+
+    def disable
+      return unless enabled?
+      @pathname.unlink
+    end
+
+    def message
+      return unless enabled?
+      contents = @pathname.read.to_s
+      contents == '' ? nil : contents
+    end
+  end
+end

data/lib/maintenance_mode/null_persistence.rb

@@ -0,0 +1,13 @@
+class MaintenanceMode
+  class NullPersistence
+    def enabled?
+      false
+    end
+
+    def enable(message=nil); end
+
+    def disable; end
+
+    def message; end
+  end
+end

data/lib/maintenance_mode/rake_tasks.rb

@@ -0,0 +1,26 @@
+require 'maintenance_mode'
+
+class MaintenanceMode
+  class RakeTasks
+    extend Rake::DSL
+
+    def self.install
+      namespace :maintenance do
+        desc 'Enable MaintenanceMode - optional message can be passed as only argument or use $MESSAGE'
+        task :enable, [:message] => [:configure] do |_, args|
+          MaintenanceMode.enable(ENV.fetch('MESSAGE', args[:message]))
+        end
+
+        desc 'Disable MaintenanceMode'
+        task :disable => [:configure] do
+          MaintenanceMode.disable
+        end
+
+        desc 'Empty hook to configure MaintenanceMode before enable/disable'
+        task :configure
+      end
+    end
+  end
+end
+
+MaintenanceMode::RakeTasks.install

data/lib/maintenance_mode/version.rb

@@ -0,0 +1,3 @@
+class MaintenanceMode
+  VERSION = '0.0.2'
+end

data/maintenance_mode.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'maintenance_mode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "maintenance_mode"
+  spec.version       = MaintenanceMode::VERSION
+  spec.authors       = ["Ryan Taylor Long"]
+  spec.email         = ["ryan.long@goodguide.com"]
+  spec.summary       = "This provides a simple interface to a 'maintenance mode' toggle with optional maintenance message."
+  spec.homepage      = "http://github.com/goodguide/maintenance_mode"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/test/maintenance_mode/file_persistence_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+require 'pathname'
+require 'tempfile'
+
+class MaintenanceMode::FilePersistenceTest < Minitest::Test
+  def _file
+    @tempfile ||= Tempfile.new('MaintenanceMode').tap { |f| f.close }
+    Pathname.new(@tempfile.path)
+  end
+
+  def setup
+    _file.unlink
+  end
+
+  def subject
+    MaintenanceMode::FilePersistence.new(_file)
+  end
+
+  def test_enable
+    assert !_file.file?, 'file should not exist'
+    subject.enable
+
+    assert _file.file?, 'file should exist'
+  end
+
+  def test_enable_with_message
+    assert !_file.file?, 'file should not exist'
+    subject.enable 'foo'
+
+    assert _file.file?, 'file should exist'
+    assert_equal 'foo', _file.read.to_s
+  end
+
+  def test_enable_when_enabled
+    assert !_file.file?, 'file should not exist'
+    subject.enable 'foo'
+    subject.enable
+
+    assert _file.file?, 'file should exist'
+    assert_equal '', _file.read.to_s
+  end
+
+  def test_disable
+    _file.write('foo')
+    assert _file.file?, 'file should exist'
+    subject.disable
+
+    assert !_file.file?, 'file should not exist'
+  end
+
+  def test_disable_when_not_enabled
+    subject.disable
+
+    assert !_file.file?, 'file should not exist'
+  end
+
+  def test_enabled?
+    _file.write('foo')
+    assert subject.enabled?
+    _file.unlink
+    assert !subject.enabled?
+  end
+
+  def test_message
+    _file.write('foobar')
+
+    assert_equal 'foobar', subject.message
+  end
+
+  def test_message_when_empty
+    _file.write('')
+
+    assert_equal nil, subject.message
+  end
+
+  def test_message_when_not_enabled
+    assert_equal nil, subject.message
+  end
+end

data/test/maintenance_mode/null_persistence_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class MaintenanceMode::NullPersistenceTest < Minitest::Test
+  def subject
+    MaintenanceMode::NullPersistence.new
+  end
+
+  def test_enable
+    subject.enable
+    assert !subject.enabled?
+  end
+
+  def test_enable_with_message
+    subject.enable 'foo'
+    assert_nil subject.message
+    assert !subject.enabled?
+  end
+
+  def test_enable_when_enabled
+    subject.enable 'foo'
+    subject.enable
+
+    assert !subject.enabled?
+  end
+
+  def test_disable
+    subject.disable
+  end
+
+  def test_enabled?
+    assert !subject.enabled?
+  end
+
+  def test_message
+    assert_nil subject.message
+  end
+end

data/test/maintenance_mode_test.rb

@@ -0,0 +1,85 @@
+class MaintenanceModeTest
+  class Delegation < Minitest::Test
+    def persistence_method_stub
+      @persistence_method_stub ||= Minitest::Mock.new
+    end
+
+    def setup
+      MaintenanceMode.persistence = persistence_method_stub
+    end
+
+    def teardown
+      @persistence_method_stub = nil
+    end
+
+    def test_enable
+      persistence_method_stub.expect :enable, nil
+      MaintenanceMode.enable
+
+      persistence_method_stub.verify
+    end
+
+    def test_enable_with_message
+      persistence_method_stub.expect :enable, nil, ['foo']
+      MaintenanceMode.enable 'foo'
+
+      persistence_method_stub.verify
+    end
+
+    def test_disable
+      persistence_method_stub.expect :disable, nil
+      MaintenanceMode.disable
+
+      persistence_method_stub.verify
+    end
+
+    def test_enabled?
+      persistence_method_stub.expect :enabled?, :foobar
+
+      assert_equal :foobar, MaintenanceMode.enabled?
+      persistence_method_stub.verify
+    end
+
+    def test_message
+      persistence_method_stub.expect :message, :foobarbaz
+
+      assert_equal :foobarbaz, MaintenanceMode.message
+      persistence_method_stub.verify
+    end
+
+    def test_as_json
+      persistence_method_stub.expect :message, 'foo'
+      persistence_method_stub.expect :enabled?, true
+
+      assert_equal({ enabled: true, message: 'foo' }, MaintenanceMode.as_json)
+      persistence_method_stub.verify
+    end
+  end
+
+  class PersistenceRegistration < Minitest::Test
+    def setup
+      MaintenanceMode.reset
+    end
+
+    def test_persistence_default
+      assert_kind_of MaintenanceMode::NullPersistence, MaintenanceMode.persistence
+    end
+
+    def test_persist_with
+      MaintenanceMode.persist_with :file, 'tmp/foo'
+      assert_kind_of MaintenanceMode::FilePersistence, MaintenanceMode.persistence
+      assert_equal 'tmp/foo', MaintenanceMode.persistence.pathname
+    end
+
+    def test_persist_with_not_registered
+      assert_raises(KeyError) { MaintenanceMode.persist_with :foo }
+    end
+
+    def test_register_persistence_method
+      fake_persistence_method_class = Class.new(Object)
+      MaintenanceMode.register_persistence_method :foo, fake_persistence_method_class
+      MaintenanceMode.persist_with :foo
+      assert_kind_of fake_persistence_method_class, MaintenanceMode.persistence
+    end
+  end
+end

data/test/rake_task_test_env/.gitignore

@@ -0,0 +1 @@
+maintenance.enabled

data/test/rake_task_test_env/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'maintenance_mode', path: '../../'
+gem 'rake'

data/test/rake_task_test_env/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: ../../
+  specs:
+    maintenance_mode (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  maintenance_mode!
+  rake

data/test/rake_task_test_env/Rakefile

@@ -0,0 +1,5 @@
+require 'maintenance_mode/rake_tasks'
+
+task 'maintenance:configure' do
+  require_relative './maintenance_mode_config'
+end

data/test/rake_task_test_env/current_state.rb

@@ -0,0 +1,5 @@
+require 'json'
+require 'maintenance_mode'
+require_relative './maintenance_mode_config'
+
+puts MaintenanceMode.as_json.to_json

data/test/rake_task_test_env/maintenance_mode_config.rb

@@ -0,0 +1,5 @@
+require 'maintenance_mode'
+require 'pathname'
+
+path = Pathname.new(File.expand_path('../maintenance.enabled', __FILE__))
+MaintenanceMode.persist_with :file, path

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'maintenance_mode'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: maintenance_mode
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ryan Taylor Long
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: 
+email:
+- ryan.long@goodguide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/maintenance_mode.rb
+- lib/maintenance_mode/file_persistence.rb
+- lib/maintenance_mode/null_persistence.rb
+- lib/maintenance_mode/rake_tasks.rb
+- lib/maintenance_mode/version.rb
+- lib/tasks/maintenance_mode.rake
+- maintenance_mode.gemspec
+- test/maintenance_mode/file_persistence_test.rb
+- test/maintenance_mode/null_persistence_test.rb
+- test/maintenance_mode_test.rb
+- test/rake_task_test_env/.gitignore
+- test/rake_task_test_env/Gemfile
+- test/rake_task_test_env/Gemfile.lock
+- test/rake_task_test_env/Rakefile
+- test/rake_task_test_env/current_state.rb
+- test/rake_task_test_env/maintenance_mode_config.rb
+- test/test_helper.rb
+homepage: http://github.com/goodguide/maintenance_mode
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This provides a simple interface to a 'maintenance mode' toggle with optional
+  maintenance message.
+test_files:
+- test/maintenance_mode/file_persistence_test.rb
+- test/maintenance_mode/null_persistence_test.rb
+- test/maintenance_mode_test.rb
+- test/rake_task_test_env/.gitignore
+- test/rake_task_test_env/Gemfile
+- test/rake_task_test_env/Gemfile.lock
+- test/rake_task_test_env/Rakefile
+- test/rake_task_test_env/current_state.rb
+- test/rake_task_test_env/maintenance_mode_config.rb
+- test/test_helper.rb
+has_rdoc: