run_time_settings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0547302343cffb55114807f167926c1dda688718f572b985e56605c9020ae155
+  data.tar.gz: d0abf2cb43695acb5f42fca3d82e1417a7943ec163f3b27430f536f4ab48af31
+SHA512:
+  metadata.gz: 8f3d032ed5789b10d4616e0029bba210e940b1066ad8752395ec911e669a94d1c7cc84bb5b00c1d00016412e4cd9c06f05af498cd1f66182c0c739de91b52c37
+  data.tar.gz: dfae24669973f55748e23e69c89203fc722d98084a0479a86ed7833d018397d03b1776680770ada5149e1efae2a9898c4434e1d6c5cf5d0cc7e04eae5ab6b5b2

data/README.md

@@ -0,0 +1,120 @@
+![RSpec](https://github.com/RockSolt/run_time_settings/workflows/RSpec/badge.svg)
+![RuboCop](https://github.com/RockSolt/run_time_settings/workflows/RuboCop/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/73c3c733ef1f3173fff3/maintainability)](https://codeclimate.com/github/RockSolt/run_time_settings/maintainability)
+
+# RunTimeSettings
+
+Run time is the most important part. If you're okay with doing a deployment to update a setting, then that sounds like an environment variable (for which there are lots of good solutions). However, if you find yourself wanting to change a value more frequently, or you want someone without the ability to do a deployment to be able to change a value, then run-time settings might be for you.
+
+In the end these are just namespaced key-value pairs stored in the database. You could create a settings model (and we do!) with a key attribute and a value attribute and you'd have just about the same thing. But it's ruby and it's rails, so you want a few more features from your settings:
+
+- type castings so that 'true' returns true and '42' return 42
+- default values
+- predicate methods for boolean settings
+
+## Usage
+
+Settings can be declared on any class—a PORO or an ActiveRecord can declare settings.
+
+```ruby
+class BatchJob
+  setting :last_run, :date
+  setting :enabled, :boolean, default: false
+  setting :percentage, :float
+end
+```
+
+The settings are then available via accessors on the class:
+
+```ruby
+BatchJob.last_run = Date.today
+BatchJob.enabled?
+BatchJob.percentage
+```
+
+### Types
+
+The following types are available to use:
+- big_integer
+- boolean
+- date
+- datetime
+- decimal
+- float
+- integer
+- string
+- time
+
+Note: The <tt>time</tt> type does not store milliseconds.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'run_time_settings'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install run_time_settings
+
+### Migration for `run_time_settings` Table
+
+The table must be created before settings can be used. Run the following command to generate a migration for the `run_time_settings` table:
+
+    rails g migration CreateRunTimeSettings namespace:string key_name:string db_value:string
+
+It should generate a migration that looks something like this:
+
+```ruby
+class CreateRunTimeSettings < ActiveRecord::Migration[6.0]
+  def change
+    create_table :run_time_settings do |t|
+      t.string :namespace
+      t.string :key_name
+      t.string :db_value
+      t.timestamps
+    end
+  end
+end
+```
+
+
+## Development
+
+Guard runs both [RuboCop](https://docs.rubocop.org/en/stable/) and [RSpec](https://relishapp.com/rspec). Rubocop is
+configured to auto-correct safe issues.
+
+Start [Guard](https://github.com/guard/guard) at the command line: `bundle exec guard`
+
+Both can be run manually from the command line:
+
+`rubocop`
+
+`bundle exec rspec`
+
+Run the console with the following:
+
+`bundle exec rake console`
+
+### Database
+
+The tests (and the console) use an in-memory database, so there is no prior setup required. It gets created each time.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RockSolt/run_time_settings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/RockSolt/run_time_settings/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RunTimeSettings project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/RockSolt/run_time_settings/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'run_time_settings'
+  require_relative 'spec/database'
+  ARGV.clear
+  IRB.start
+end

data/lib/run_time_settings.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'run_time_settings/version'
+
+require 'run_time_settings/persistent_attributes'
+require 'run_time_settings/settings'
+
+module RunTimeSettings
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/run_time_settings/persistent_attributes.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'run_time_settings/type/time'
+
+module RunTimeSettings
+  # = Persistent Attributes
+  module PersistentAttributes
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Specifies a class-level, persistent attribute. The class (not the
+      # instance) receives getter and setter methods for the setting.
+      # Additionally, boolean settings add predicate methods.
+      #
+      # +setting_name+ The name of the setting.
+      #
+      # +type+ A symbol such as +:string+ or +:integer+, or a type object to be
+      # used for this attribute. See ActiveModel::Type for list of symbols /
+      # delivered types.
+      #
+      # === Options
+      # The following options are accepted:
+      #
+      # +default+ The default value to use when no value is provided.
+      #
+      # When using a symbol for +cast_type+, extra options are forwarded to the
+      # constructor of the type object.
+      #
+      # === Examples
+      #
+      # A BatchJob class declares <tt>setting :last_run, :date</tt>, which will
+      # add the following:
+      # * <tt>BatchJob.last_run</tt>
+      # * <tt>BatchJob.last_run=(date)</tt>
+      #
+      # A BatchJob class declares <tt>setting :enabled, :boolean, default: false</tt>,
+      # which will add the following:
+      # * <tt>BatchJob.enabled</tt>
+      # * <tt>BatchJob.enabled=(boolean)</tt>
+      # * <tt>BatchJob.enabled?</tt>
+      def setting(setting_name, type = ActiveModel::Type::Value.new, **options)
+        setting_name = setting_name.to_s
+        type = RunTimeSettings::Type::Time.new if type == :time
+        type = ActiveModel::Type.lookup(type, **options.except(:default)) if type.is_a?(Symbol)
+
+        RunTimeSettings::Settings.add_setting_type(name, setting_name, type)
+        define_setting_accessors(setting_name, options[:default], type.is_a?(ActiveModel::Type::Boolean))
+      end
+
+      private
+
+      def define_setting_accessors(setting_name, default, boolean)
+        define_singleton_method(setting_name) do
+          value = RunTimeSettings::Settings.read(name, setting_name)
+          value.nil? ? default : value
+        end
+
+        define_singleton_method("#{setting_name}?") { public_send(setting_name) } if boolean
+
+        define_singleton_method("#{setting_name}=") do |value|
+          RunTimeSettings::Settings.write(name, setting_name, value)
+        end
+      end
+    end
+  end
+end

data/lib/run_time_settings/settings.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module RunTimeSettings
+  # Settings
+  #
+  # Model settings holds namespaced key-value pairs. This acts as the data store for the PersistentAttributes mixin.
+  # See RunTimeSettings::PersistentAttributes.settings for information.
+  class Settings < ActiveRecord::Base
+    self.table_name = :run_time_settings
+
+    class << self
+      def add_setting_type(namespace, key, type)
+        setting_types[[namespace, key]] = type
+      end
+
+      def read(namespace, key)
+        value = RunTimeSettings::Settings.find_by(namespace: namespace, key_name: key)&.db_value
+        type_for(namespace, key).deserialize(value) if value.present?
+      end
+
+      def write(namespace, key, value)
+        setting = RunTimeSettings::Settings.find_or_initialize_by(namespace: namespace, key_name: key)
+        setting.update!(db_value: type_for(namespace, key).serialize(value))
+      end
+
+      private
+
+      def type_for(namespace, key)
+        setting_types[[namespace, key]]
+      end
+
+      def setting_types
+        @setting_types ||= {}
+      end
+    end
+  end
+end

data/lib/run_time_settings/type/time.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RunTimeSettings
+  module Type
+    # = Time
+    #
+    # Custom type caster for Time. Values are converted to an integer representing seconds since epoch for storage in
+    # the database, then converted back to Time on the way out.
+    #
+    # This is only accurate to the second; milliseconds are lost.
+    class Time
+      # called by read, should return Time instance
+      def deserialize(value)
+        ::Time.at(value.to_i)
+      end
+
+      # called by write, should convert to unix epoch for storage in database
+      def serialize(value)
+        value.to_i
+      end
+    end
+  end
+end

data/lib/run_time_settings/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RunTimeSettings
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: run_time_settings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Todd Kummer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description: Easily add and manage application-level settings
+email:
+- todd@rockridgesolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/run_time_settings.rb
+- lib/run_time_settings/persistent_attributes.rb
+- lib/run_time_settings/settings.rb
+- lib/run_time_settings/type/time.rb
+- lib/run_time_settings/version.rb
+homepage: https://github.com/RockSolt/run_time_settings
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Persistent, run-time application settings
+test_files: []