dry-configurable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39217854850d56cee715e92520f5861a2523bf80
+  data.tar.gz: 5ddd51d321b5b85646d4b85c74e8bdbd446c2bab
+SHA512:
+  metadata.gz: 4e550fbe606b298cdb69cca90629cf83feb5aaada297f617803b6fa255a430f47be9562044f8e522aea8c9c0ec55f09857c03804e8209f57e3dbd625fdcd3698
+  data.tar.gz: ec8339404b10d09b36fb1e06d46087590df1fda88e2a9758082ac50eb2072abf3f63e0a0988390b4d9e9bdc58d54322b3657da8cc31b359f41b855cbddcf45fc

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+coverage
+/.bundle
+vendor/bundle
+bin/
+tmp/
+.idea/
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,12 @@
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Exclude:
+    - rakelib/*.rake

data/.rubocop_todo.yml

@@ -0,0 +1,6 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-06-10 18:54:14 +0100 using RuboCop version 0.26.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: --without console
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+  - ruby-head
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :tools do
+  gem 'rubocop'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ruby Object Mapper
+
+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.
+s

data/README.md

@@ -0,0 +1,33 @@
+# dry-configurable <a href="https://gitter.im/dryrb/chat" target="_blank">![Join the chat at https://gitter.im/dryrb/chat](https://badges.gitter.im/Join%20Chat.svg)</a>
+
+<a href="https://rubygems.org/gems/dry-configurable" target="_blank">![Gem Version](https://badge.fury.io/rb/dry-configurable.svg)</a>
+<a href="https://travis-ci.org/dryrb/dry-configurable" target="_blank">![Build Status](https://travis-ci.org/dryrb/dry-configurable.svg?branch=master)</a>
+<a href="http://inch-ci.org/github/dryrb/dry-configurable" target="_blank">![Inline docs](http://inch-ci.org/github/dryrb/dry-configurable.svg?branch=master&style=flat)</a>
+
+## Synopsis
+
+```ruby
+class App
+  extend Dry::Configurable
+
+  # Pass a block for nested configuration (works to any depth)
+  setting :database do
+    # Can pass a default value
+    setting :dsn, 'sqlite:memory'
+  end
+  # Defaults to nil if no default value is given
+  setting :adapter
+end
+
+App.configure do |config|
+  config.database.dsn = 'jdbc:sqlite:memory'
+end
+
+App.config.database.dsn
+# => 'jdbc:sqlite:memory'
+App.config.adapter # => nil
+```
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs in spec directory'
+RSpec::Core::RakeTask.new(:spec)

data/dry-configurable.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+require File.expand_path('../lib/dry/configurable/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-configurable'
+  spec.version       = Dry::Configurable::VERSION
+  spec.authors       = ['Andy Holland']
+  spec.email         = ['andyholland1991@aol.com']
+  spec.summary       = 'A mixin to add configuration functionality to your classes'
+  spec.homepage      = 'https://github.com/dryrb/dry-configurable'
+  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_runtime_dependency 'thread_safe'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/dry/configurable.rb

@@ -0,0 +1,86 @@
+require 'thread_safe'
+require 'dry/configurable/config'
+require 'dry/configurable/version'
+
+module Dry
+  # A simple configuration mixin
+  #
+  # @example
+  #
+  #   class App
+  #     extend Dry::Configurable
+  #
+  #     setting :database do
+  #       setting :dsn, 'sqlite:memory'
+  #     end
+  #   end
+  #
+  #   App.confiure do |config|
+  #     config.database.dsn = 'jdbc:sqlite:memory'
+  #   end
+  #
+  #   App.config.database.dsn
+  #     # => "jdbc:sqlite:memory'"
+  #
+  # @api public
+  module Configurable
+    # @private
+    def self.extended(base)
+      base.instance_variable_set(:@_config_mutex, Mutex.new)
+      base.instance_variable_set(:@_settings_mutex, Mutex.new)
+    end
+    # Return configuration
+    #
+    # @return [Dry::Configurable::Config]
+    #
+    # @api public
+    def config
+      @_config_mutex.synchronize do
+        return @_config if defined?(@_config)
+        @_config = Config.new(*_settings.keys).new(*_settings.values) unless _settings.empty?
+      end
+    end
+    # Return configuration
+    #
+    # @yield [Dry::Configuration::Config]
+    #
+    # @return [Dry::Configurable::Config]
+    #
+    # @api public
+    def configure
+      yield(config) if block_given?
+    end
+    # Add a setting to the configuration
+    #
+    # @param [Mixed] key
+    #   The accessor key for the configuration value
+    # @param [Mixed] default
+    #   The default config value
+    #
+    # @yield
+    #   If a block is given, it will be evaluated in the context of
+    #   and new configuration class, and bound as the default value
+    #
+    # @return [Dry::Configurable::Config]
+    #
+    # @api public
+    def setting(key, default = nil, &block)
+      default = _config_for(&block) if block_given?
+      _settings[key] = default
+    end
+
+    private
+
+    # @private
+    def _settings
+      @_settings_mutex.synchronize { @_settings ||= ThreadSafe::Cache.new }
+    end
+
+    # @private
+    def _config_for(&block)
+      config_klass = Class.new { extend Dry::Configurable }
+      config_klass.instance_eval(&block)
+      config_klass.config
+    end
+  end
+end

data/lib/dry/configurable/config.rb

@@ -0,0 +1,7 @@
+module Dry
+  module Configurable
+    # @private
+    class Config < Struct
+    end
+  end
+end

data/lib/dry/configurable/version.rb

@@ -0,0 +1,6 @@
+module Dry
+  module Configurable
+    # @api public
+    VERSION = '0.1.0'.freeze
+  end
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+begin
+  require 'rubocop/rake_task'
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << '--display-cop-names'
+  end
+
+  namespace :rubocop do
+    desc 'Generate a configuration file acting as a TODO list.'
+    task :auto_gen_config do
+      exec 'bundle exec rubocop --auto-gen-config'
+    end
+  end
+
+rescue LoadError
+end

data/spec/integration/configurable_spec.rb

@@ -0,0 +1,91 @@
+RSpec.describe Dry::Configurable do
+  describe 'settings' do
+    context 'without default value' do
+      let(:configuration) do
+        Class.new do
+          extend Dry::Configurable
+
+          setting :dsn
+        end
+      end
+
+      it 'returns nil' do
+        expect(configuration.config.dsn).to be(nil)
+      end
+    end
+
+    context 'with default value' do
+      let(:configuration) do
+        Class.new do
+          extend Dry::Configurable
+
+          setting :dsn, 'sqlite:memory'
+        end
+      end
+
+      it 'returns the default value' do
+        expect(configuration.config.dsn).to eq('sqlite:memory')
+      end
+    end
+
+    context 'nested configuration' do
+      let(:configuration) do
+        Class.new do
+          extend Dry::Configurable
+
+          setting :database do
+            setting :dsn, 'sqlite:memory'
+          end
+        end
+      end
+
+      it 'returns the default value' do
+        expect(configuration.config.database.dsn).to eq('sqlite:memory')
+      end
+    end
+  end
+
+  describe 'configuration' do
+    context 'without nesting' do
+      let(:configuration) do
+        Class.new do
+          extend Dry::Configurable
+
+          setting :dsn, 'sqlite:memory'
+        end
+      end
+
+      before do
+        configuration.configure do |config|
+          config.dsn = 'jdbc:sqlite:memory'
+        end
+      end
+
+      it 'updates the config value' do
+        expect(configuration.config.dsn).to eq('jdbc:sqlite:memory')
+      end
+    end
+
+    context 'with nesting' do
+      let(:configuration) do
+        Class.new do
+          extend Dry::Configurable
+
+          setting :database do
+            setting :dsn, 'sqlite:memory'
+          end
+        end
+      end
+
+      before do
+        configuration.configure do |config|
+          config.database.dsn = 'jdbc:sqlite:memory'
+        end
+      end
+
+      it 'updates the config value' do
+        expect(configuration.config.database.dsn).to eq('jdbc:sqlite:memory')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'dry/configurable'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: dry-configurable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Holland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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:
+- andyholland1991@aol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dry-configurable.gemspec
+- lib/dry/configurable.rb
+- lib/dry/configurable/config.rb
+- lib/dry/configurable/version.rb
+- rakelib/rubocop.rake
+- spec/integration/configurable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dryrb/dry-configurable
+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.6
+signing_key: 
+specification_version: 4
+summary: A mixin to add configuration functionality to your classes
+test_files:
+- spec/integration/configurable_spec.rb
+- spec/spec_helper.rb