captain_config 1.0.0

checksums.yaml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dirk@esherido.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2019, Dirk Gadsden
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+# CaptainConfig
+
+`CaptainConfig` makes it easy to add developer-friendly configuration to control your application's behavior.
+
+## Getting Started
+
+Add the gem to your application's Gemfile:
+
+```rb
+gem 'captain_config'
+```
+
+Run the generator to create the migration for the `captain_configs` table:
+
+```sh
+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:
+
+```rb
+# config/initializers/captain_config.rb
+CONFIG = CaptainConfig::Service.new do
+  new_feature_enabled :boolean, default: false
+  important_user_points_threshold :integer, default: 9000
+end
+```
+
+Add the Puma middleware so that the configuration is reloaded out-of-band in between requests:
+
+```rb
+# config.ru
+require_relative 'config/environment'
+
+use CaptainConfig::PumaMiddleware
+
+run Rails.application
+```
+
+Now you can read the configuration anywhere! The configuration will be reloaded in between requests, so reading it in your application is a fast hash lookup.
+
+```rb
+class User < Application
+  def met_threshold?
+    points >= CONFIG[:important_user_points_threshold]
+  end
+end
+```
+
+```erb
+<% if CONFIG[:new_feature_enabled] %>
+  <%= link_to 'New Stuff!', new_feature_path %>
+<% end >
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [the GitHub repository](https://github.com/dirk/captain_config).
+
+## Code of Conduct
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dirk/captain_config/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+Released under the Modified BSD license, see [LICENSE](LICENSE) for details.

data/captain_config.gemspec

@@ -0,0 +1,50 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "captain_config/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "captain_config"
+  spec.version = CaptainConfig::VERSION
+  spec.authors = ["Dirk Gadsden"]
+  spec.email = ["dirk@esherido.com"]
+
+  spec.summary = 'Fast, safe configuration for Ruby on Rails applications.'
+  spec.homepage = 'https://github.com/dirk/captain_config'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/dirk/captain_config'
+    # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject do |file|
+      file.match(%r{^(bin|spec)/}) ||
+        file.match(%r{^\.[.\w]+$}) ||
+        %[Gemfile Rakefile].include?(file)
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '>= 4.0.0'
+  spec.add_dependency 'concurrent-ruby', '>= 1.0.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'httparty', '~> 0.16'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  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 'wait_for_it', '~> 0.2'
+end

data/lib/captain_config.rb

@@ -0,0 +1,21 @@
+require 'active_support/dependencies/autoload'
+
+require 'captain_config/version'
+
+module CaptainConfig
+  extend ActiveSupport::Autoload
+
+  autoload :ConfiguredEntry
+  autoload :Service
+
+  autoload_under 'middlewares' do
+    autoload :PumaMiddleware
+  end
+
+  autoload_under 'models' do
+    autoload :BaseConfig
+    autoload :BooleanConfig
+    autoload :IntegerConfig
+    autoload :StringConfig
+  end
+end

data/lib/captain_config/configured_entry.rb

@@ -0,0 +1,20 @@
+class CaptainConfig::ConfiguredEntry
+  attr_reader :key
+  # Class of the model (eg. `CaptainConfig::BooleanConfig`).
+  attr_reader :model
+  attr_accessor :default
+
+  def initialize(key, model)
+    @key = key
+    @model = model
+    @default = nil
+  end
+
+  def default_value
+    if default.respond_to?(:call)
+      default.call
+    else
+      default
+    end
+  end
+end

data/lib/captain_config/middlewares/puma_middleware.rb

@@ -0,0 +1,23 @@
+# Using the `rack.after_reply` hook provided by Puma for running code after
+# the response has been sent to the client.
+class CaptainConfig::PumaMiddleware
+  RACK_AFTER_REPLY = ::Puma::Const::RACK_AFTER_REPLY
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    service = CaptainConfig::Service.last_created_service
+
+    if service
+      # Load if it hasn't already been loaded (eg. first request).
+      service.load unless service.loaded?
+
+      # Then reload after every request.
+      env[RACK_AFTER_REPLY] << lambda { service.load }
+    end
+
+    @app.call env
+  end
+end

data/lib/captain_config/models/base_config.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+class CaptainConfig::BaseConfig < ActiveRecord::Base
+  self.table_name = 'captain_configs'
+
+  validates_presence_of :key
+end

data/lib/captain_config/models/boolean_config.rb

@@ -0,0 +1,33 @@
+require 'captain_config/models/base_config'
+
+class CaptainConfig::BooleanConfig < CaptainConfig::BaseConfig
+  def value
+    case self.text
+    when 'true'
+      true
+    when 'false'
+      false
+    else
+      raise "Invalid text: #{text.inspect}"
+    end
+  end
+
+  def value=(new_value)
+    if new_value != true && new_value != false
+      raise ArgumentError.new("Invalid value: #{new_value.inspect}")
+    end
+
+    self.text = new_value.to_s
+  end
+
+  def self.coerce(value)
+    case value
+    when 'true'
+      true
+    when 'false'
+      false
+    else
+      raise ArgumentError.new("Cannot coerce value: #{value.inspect}")
+    end
+  end
+end

data/lib/captain_config/models/integer_config.rb

@@ -0,0 +1,19 @@
+require 'captain_config/models/base_config'
+
+class CaptainConfig::IntegerConfig < CaptainConfig::BaseConfig
+  def value
+    Integer(self.text)
+  end
+
+  def value=(new_value)
+    unless new_value.is_a?(Integer)
+      raise ArgumentError.new("Invalid value: #{new_value.inspect}")
+    end
+
+    self.text = new_value.to_s
+  end
+
+  def self.coerce(value)
+    Integer(value)
+  end
+end

data/lib/captain_config/models/string_config.rb

@@ -0,0 +1,15 @@
+require 'captain_config/models/base_config'
+
+class CaptainConfig::StringConfig < CaptainConfig::BaseConfig
+  def value
+    self.text
+  end
+
+  def value=(new_value)
+    self.text = new_value.to_s
+  end
+
+  def self.coerce(value)
+    value.to_s
+  end
+end

data/lib/captain_config/service.rb

@@ -0,0 +1,103 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require 'concurrent/atomic/thread_local_var'
+
+class CaptainConfig::Service
+  extend ActiveSupport::Autoload
+
+  autoload :DSL
+
+  # The statically-defined entries that this service should support.
+  attr_reader :configured_entries
+
+  # The keys and values read from the database (or defaults).
+  attr_reader :configs
+
+  # Used by middlewares to automatically find the configuration service.
+  cattr_accessor :last_created_service,
+    instance_reader: false,
+    instance_writer: false
+
+  def initialize(load_after_initialize: true, &block)
+    @configured_entries = {}
+    @configs = Concurrent::ThreadLocalVar.new(nil)
+
+    DSL.new(self).instance_eval(&block)
+
+    # The last service to be initialized will always win.
+    self.class.last_created_service = self
+
+    # Make the service immediately available after it's declared.
+    load if load_after_initialize
+  end
+
+  def <<(configured_entry)
+    @configured_entries[configured_entry.key] = configured_entry
+  end
+
+  def get(key)
+    assert_loaded!
+
+    configs.value.fetch key
+  end
+
+  def set(key, new_value, coerce: false)
+    assert_loaded!
+
+    record = configured_entries.fetch(key).model.find_or_create_by!(key: key)
+    record.value = coerce ? record.class.coerce(new_value) : new_value
+    record.save!
+
+    # Read the value back out of the record because the model/record
+    # is authoritative.
+    authoritative_new_value = record.value
+    configs.value[key] = authoritative_new_value
+    authoritative_new_value
+  end
+
+  alias_method :[], :get
+  alias_method :[]=, :set
+
+  def loaded?
+    !configs.value.nil?
+  end
+
+  # Load new values from the database (or default values from the
+  # configured entries).
+  def load
+    new_configs = {}
+
+    records = CaptainConfig::BaseConfig
+      .where(key: configured_entries.keys)
+      .map { |record| [record.key.to_sym, record] }
+      .to_h
+
+    configured_entries.each do |key, configured_entry|
+      record = records[key]
+
+      value = if record
+        # Check that it's the type we're expecting.
+        actual = record.class
+        expected = configured_entry.model
+        if expected != actual
+          raise(
+            "Error loading #{key}: record class from database doesn't match " \
+            "configured class (expected: #{expected}, got: #{actual})",
+          )
+        end
+        record.value
+      else
+        configured_entry.default_value.dup
+      end
+
+      new_configs[key] = value
+    end
+
+    @configs.value = new_configs
+  end
+
+  private
+
+  def assert_loaded!
+    raise 'Not loaded' unless loaded?
+  end
+end

data/lib/captain_config/service/dsl.rb

@@ -0,0 +1,33 @@
+require 'active_support/proxy_object'
+
+class CaptainConfig::Service::DSL < ActiveSupport::ProxyObject
+  attr_reader :service
+
+  def initialize(service)
+    @service = service
+  end
+
+  def method_missing(key, *args)
+    type, opts, *_rest = args
+
+    model = case type
+    when :boolean
+      ::CaptainConfig::BooleanConfig
+    when :integer
+      ::CaptainConfig::IntegerConfig
+    when :string
+      ::CaptainConfig::StringConfig
+    else
+      raise ArgumentError.new("Unrecognized type: #{type.inspect}")
+    end
+
+    entry = ::CaptainConfig::ConfiguredEntry.new(key, model)
+    if opts
+      opts.each do |opt, value|
+        entry.send("#{opt}=", value)
+      end
+    end
+
+    service << entry
+  end
+end

data/lib/captain_config/version.rb

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

data/lib/generators/captain_config_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/active_record/migration'
+
+class CaptainConfigGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "Creates the migration for the `captain_configs' table."
+
+  def create_captain_configs_migration
+    migration_template 'create_captain_configs.rb.tt', "#{db_migrate_path}/create_captain_configs.rb"
+  end
+end

data/lib/generators/templates/create_captain_configs.rb.tt

@@ -0,0 +1,11 @@
+class CreateCaptainConfigs < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :captain_configs do |t|
+      t.string :type, null: false
+      t.string :key, null: false
+      t.text :text
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: captain_config
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dirk Gadsden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: wait_for_it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email:
+- dirk@esherido.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- captain_config.gemspec
+- lib/captain_config.rb
+- lib/captain_config/configured_entry.rb
+- lib/captain_config/middlewares/puma_middleware.rb
+- lib/captain_config/models/base_config.rb
+- lib/captain_config/models/boolean_config.rb
+- lib/captain_config/models/integer_config.rb
+- lib/captain_config/models/string_config.rb
+- lib/captain_config/service.rb
+- lib/captain_config/service/dsl.rb
+- lib/captain_config/version.rb
+- lib/generators/captain_config_generator.rb
+- lib/generators/templates/create_captain_configs.rb.tt
+homepage: https://github.com/dirk/captain_config
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dirk/captain_config
+  source_code_uri: https://github.com/dirk/captain_config
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Fast, safe configuration for Ruby on Rails applications.
+test_files: []