configify-rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d801d49720de0faae6fc1f2da71e67902269dea
+  data.tar.gz: 97d08fecc8b651ef72ea7bc5138dd6ac69c09b47
+SHA512:
+  metadata.gz: 46c660469d9a2b087380e39b1a70461b44855096d8e5200a3f9e0476c3c5aab41a5addfdd20acd202ab59583f0f53d820febe2c7de604225269afa243412a243
+  data.tar.gz: 4e7e109aa1ecac30e16016b17fff67bd86a8746394c9b70481b988e5bdfd31a4d73427d2a02d0e0815abc24aab657a1977ecdd7f14c06387bbf7a76a3d5d4032

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.ruby-version

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    configify (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  configify!
+  rake (~> 10.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 soloman
+
+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,80 @@
+# Configify
+
+Configify captures a simple pattern for setting up configuration properties, as well as enable loading configurations from environment variables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'configify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install configify
+
+## Usage
+
+The following shows how to `Configify` a service class:
+
+```ruby
+  class TestService
+    include Configify
+
+    configuration do
+      env_variable_prefix 'TEST'
+
+      property :base_url, default: 'localhost:8080'
+      property :init_count
+    end
+
+    def initialize config: config
+      @base_url = config.base_url
+      @init_count = config.init_count
+    end
+  end
+```
+
+With configified service class above, `TestService.configuration` can be used to access the configuration class for the `TestService`. For example:
+
+```ruby
+  config = TestService.configuration.new
+  config.init_count = 100
+
+  servcie = TestService.new config: config
+```
+
+`Configify` also supports loading properties from environment variables:
+
+```ruby
+  # Assume the following environment variables
+  # TEST_INIT_COUNT = 100
+  # TEST_BASE_URL = 127.0.0.1:1234
+
+  config = TestService.configuration.new
+  config.load_from_env
+
+  servcie = TestService.new config: config
+```
+
+The preferred way to initialise a instance is to utilize the `with_config`:
+
+```ruby
+  service = TestService.with_config do |config|
+    config.load_from_env
+    config.init_count = 100
+  end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/everydayhero/configify/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,2 @@
+require "bundler/gem_tasks"
+

data/configify.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'configify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "configify-rb"
+  spec.version       = Configify::VERSION
+  spec.authors       = ["soloman"]
+  spec.email         = ["soloman1124@gmail.com"]
+  spec.summary       = %q{Simple utility to set config properties}
+  spec.description   = %q{Simple utility to set config properties}
+  spec.homepage      = 'https://github.com/everydayhero/configify'
+  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.required_ruby_version = '~> 2.1'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/configify.rb

@@ -0,0 +1,25 @@
+require 'configify/version'
+require 'configify/base'
+
+module Configify
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def configuration &block
+      @configuration_class = Class.new Base, &block if block_given?
+
+      @configuration_class
+    end
+
+    def with_config
+      return unless configuration
+
+      new_config = configuration.new
+      yield new_config if block_given?
+
+      new config: new_config
+    end
+  end
+end

data/lib/configify/base.rb

@@ -0,0 +1,36 @@
+module Configify
+  class Base
+    def initialize
+      self.class.properties.each do |key, value|
+        send "#{key}=", value
+      end
+    end
+
+    def load_from_env prefix: self.class.env_variable_prefix
+      self.class.properties.each do |key, _|
+        env_var_name = "#{prefix}_#{key.upcase}"
+        self.send "#{key}=", ENV[env_var_name] if ENV.has_key? env_var_name
+      end
+
+      self
+    end
+
+    class << self
+      def env_variable_prefix prefix = nil
+        @env_variable_prefix = prefix if prefix
+
+        @env_variable_prefix
+      end
+
+      def property key, default: nil
+        attr_accessor key.to_sym
+
+        properties[key.to_sym] = default
+      end
+
+      def properties
+        @properties ||= Hash.new
+      end
+    end
+  end
+end

data/lib/configify/version.rb

@@ -0,0 +1,3 @@
+module Configify
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: configify-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- soloman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-08 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'
+description: Simple utility to set config properties
+email:
+- soloman1124@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- configify.gemspec
+- lib/configify.rb
+- lib/configify/base.rb
+- lib/configify/version.rb
+homepage: https://github.com/everydayhero/configify
+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.1'
+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: Simple utility to set config properties
+test_files: []