has_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ff4a936f1e2bb34db9f906368df5cc8e1933f03
+  data.tar.gz: f29d5a2372cc3ca6abecf6d4d0fc543467f94ca2
+SHA512:
+  metadata.gz: 9154daeeedbc0ca628ab5e3a2ee87a6685eef73a492f35ebdefec323f13d69cfff7524c2845d203da3a77826ae3e7974c4be90765f93d031edd02afa9a994783
+  data.tar.gz: 57b678e8f2e67a71139e884c236b9c0027189c6fe1fa83dc9f9abc4bca8bd23419e492e4fda12a94753112fbe418d148e42955ea94692822423882c05ea5478d

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_STORE
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+gemfile:
+  - gemfiles/4.0.gemfile
+  - gemfiles/4.1.gemfile
+  - gemfiles/4.2.gemfile
+addons:
+  postgresql: '9.3'
+before_script:
+  - psql -c 'create database has_config_test;' -U postgres
+script:
+  - bundle exec rake test
+sudo: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (6/20/2015)
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tony Drake
+
+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,135 @@
+# HasConfig
+
+[![Build Status](https://travis-ci.org/t27duck/has_config.svg?branch=master)](https://travis-ci.org/t27duck/has_config)
+
+Tested against Ruby 2.0 - 2.2 with ActiveRecord 4.0 - 4.2
+
+When working with models in a large Rails project, you sometimes end up with "god objects" which start to be loaded down with several booleans, integers, and strings from select boxes that act as configuration options. As time goes on, you add more and more columns. As your database and user-base grows, adding even a single column more can bring your app to a hault during a deploy due to table locking or a slew of exceptions due to [issues and gotchas like this](https://github.com/rails/rails/issues/12330).
+
+In an attempt to cut down on cluttering your model with boolean columns, `has_config` allows you to have a single column contain all configuration switches you could ever want. Adding another configuration option to a model no longer requires a migration to add a column. You can also contiue writing code as if the model had all of those indiviual attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_config
+
+## Usage
+
+Let's say we have a model called `Client` whose job is to hold the general information configuration for a client in a multi-tenant application. First, we need to add one column to the model to hold the configuration information. By default, the gem assumes the column's name is `configuration`, but you can change that (more on that later).
+
+```ruby
+class AddConfigurationToClients < ActiveRecord::Migration
+  add_column :clients, :configuration, :text
+end
+```
+
+We now want to make that column a serialized hash in our model and include the `HasConfig` module.
+
+```ruby
+class Client < ActiveRecord::Base
+  serialize :configuration, Hash
+  include HasConfig
+end
+```
+
+If you are using PostgreSQL 9.2 or later, you can use the JSON data-type for the configuration column and not have to declare it as a serilaized attribute in the model as `ActiveRecord` will take care of that for you.
+
+If you want to use a different column name, you may override the default by setting `self.configuration_column = 'other_column_name'` in the model.
+
+Finally, we're going to tell our model what configuration it'll hold. We do this via the `has_config` method the module provides. For now, here's a sensory overload example. We'll go into detail in the next part.
+
+```ruby
+class Client < ActiveRecord::Base
+  serialize :configuration, Hash
+  include HasConfig
+  has_config :primary_color, :string, default: 'green', group: :style
+  has_config :secondary_color, :string, group: :style
+  has_config :rate_limit, :integer, validations: { numericality: { only_integer: true } }
+  has_config :category, :string, validations: { inclusion: { in: CATEGORIES } }
+  has_config :active, :boolean, default: false
+end
+```
+
+Let's look at the `has_config` signature first before we go any further:
+
+```ruby
+  has_config(key, type, default:nil, group:nil, validations:{})
+```
+
+At minimum, you must provide a `key` and `type`. The `key` is what you'll call this configuraiton item. The `type` can be either `:string`, `:integer`, or `:boolean`.
+
+If a configuration item doesn't have a value, `nil` is returned by default. Or, you may provide your own default value with the `default` option.
+
+If you have a series of configuraiton items are are related, you can organize them together with the `group` option.
+
+To the app, each configuraiton item is like a pseudo attribute on the model. Modle attributes can have validations. Use the `validations` option to pass in a hash of options you'd normally pass into the `validates` method for a regular attribute on the model.
+
+Ok, still with me? Back to our example...
+
+Here, the `Client` model has five configuration items on it: `primary_color`, `secondary_color`, `rate_limit`, `category`, and `active`. So, knowing what you just learned above...
+
+`primary_color` is a string with a default value of green and grouped in the "style" group of configuration options.
+
+`secondary_color` is a string without a default. It too is in the "style" group.
+
+`rate_limit` is an integer that validates its value is in fact, an integer.
+
+`category` is a string that must be a value in the array `CATEGORIES`.
+
+`active` is a boolean value with a default of `false`.
+
+We can now access these configuration settings as if they were regular attributes on the model:
+
+```irb
+client = Client.new
+client.default_color
+=> "green"
+client.secondary_color
+=> nil
+client.active
+=> false
+client.active?
+=> false
+client.active = '1' # Like if this was submitted from a form
+=> '1'
+client.active?
+=> true
+client.rate_limit = 3
+=> 3
+client.valid?
+=> false
+client.errors.full_messages
+=> ["Category is not in the list"]
+```
+
+Everything acts pretty much as you'd expect it too do. Configurations that fail validations make the record invalid. Passing in '1', 'true', `true`, etc casts boolean values. Passing in an empty string for an integer config casts as `nil`.
+
+Finally, you can access all configuration values under a specific group with the `configuration_for_group` method.
+
+```irb
+client.configuration_for_group(:style)
+=> {primary_color: 'green', secondary_color: nil}
+```
+
+## Testing
+
+Tests run using a PostgreSQL database called `has_config_test`. You should be able to just create a database named that and run `bundle exec rake test`.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/has_config/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+task default: :test
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  #t.pattern = "test/**/*_test.rb"
+  t.pattern = "test/test*.rb"
+end
+
+desc "Run a console with the environment loaded"
+task :console do
+  require 'has_config'
+
+require 'active_record'
+require 'pg'
+  require 'irb'
+  require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "has_config"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/4.0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path=>"../"

data/gemfiles/4.1.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path=>"../"

data/gemfiles/4.2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+
+gemspec :path=>"../"

data/has_config.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_config"
+  spec.version       = HasConfig::VERSION
+  spec.authors       = ["Tony Drake"]
+  spec.email         = ["t27duck@gmail.com"]
+
+  spec.summary       = %q{Quick record-specific configuration for your models}
+  spec.description   = <<-DESC
+    Allows you to include and organize configuration options for each record in
+    a model without the need of complex joins to settings tables or constantly
+    adding random boolean and string columns
+  DESC
+  spec.homepage      = "http://github.com/t27duck/has_config"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activerecord", ">= 4.0"
+  spec.add_development_dependency "pg"
+end

data/lib/has_config.rb

@@ -0,0 +1,93 @@
+require "has_config/version"
+
+module HasConfig
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def configuration_for_group(group_name)
+    group_config = {}
+    (self.class.configuration_groups[group_name.to_s] || {}).each do |config_name|
+      group_config[config_name.to_sym] = public_send(config_name)
+    end
+    group_config
+  end
+
+  module ClassMethods
+    def has_config(key, type, default:nil, group:nil, validations:{})
+      raise ArgumentError, "Invalid type #{type}" unless [:string, :integer, :boolean].include?(type)
+
+      define_configuration_getter(key, default, type == :boolean)
+      define_configuration_setter(key, type)
+      set_configuration_group(key, group) if group.present?
+      set_configuration_validations(key, validations) if validations.present?
+    end
+
+    def configuration_groups
+      @configuration_groups ||= {}
+    end
+
+    def configuration_column
+      @configuration_column ||= 'configuration'
+    end
+
+    def configuration_column=(column_name)
+      @configuration_column = column_name.to_s
+    end
+
+    private ####################################################################
+
+    def define_configuration_getter(key, default, include_boolean=false)
+      define_method(key) do
+        config = (attributes[self.class.configuration_column] || {})
+        config[key.to_s].nil? ? default : config[key.to_s]
+      end
+
+      if include_boolean
+        define_method("#{key}?") do
+          config = (attributes[self.class.configuration_column] || {})
+          config[key.to_s].nil? ? default : config[key.to_s]
+        end
+      end
+    end
+
+    def define_configuration_setter(key, type)
+      define_method("#{key}=") do |input|
+        config = (attributes[self.class.configuration_column] || {})
+        original_value = config[key.to_s]
+        parsed_value = nil
+
+        if !input.nil?
+          parsed_value = case type
+          when :string
+            input.to_s
+          when :integer
+            input.present? ? input.to_i : nil
+          when :boolean
+            ([true,1].include?(input) || input =~ (/(true|t|yes|y|1)$/i)) ? true : false
+          end
+        end
+
+        if original_value != parsed_value
+          config[key.to_s] = parsed_value
+          write_attribute(self.class.configuration_column, config)
+          public_send("#{self.class.configuration_column}_will_change!")
+        end
+
+        input
+      end
+    end
+
+    def set_configuration_group(key, group)
+      @configuration_groups ||= {}
+      @configuration_groups[group.to_s] ||= []
+      @configuration_groups[group.to_s] << key.to_s
+    end
+
+    def set_configuration_validations(key, validation_config)
+      validates key, validation_config
+    end
+
+  end
+
+end

data/lib/has_config/version.rb

@@ -0,0 +1,3 @@
+module HasConfig
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: has_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony Drake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
+    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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: |2
+      Allows you to include and organize configuration options for each record in
+      a model without the need of complex joins to settings tables or constantly
+      adding random boolean and string columns
+email:
+- t27duck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/4.0.gemfile
+- gemfiles/4.1.gemfile
+- gemfiles/4.2.gemfile
+- has_config.gemspec
+- lib/has_config.rb
+- lib/has_config/version.rb
+homepage: http://github.com/t27duck/has_config
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Quick record-specific configuration for your models
+test_files: []