dotconfig 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Version 0.0.1
+
+* Initial release
+
+## Version 0.0.1
+
+* Correcting the summary of the gem

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dot_config.gemspec
+gemspec
+
+# Gems used in develpment.
+group :development do
+  # Generates better documentation.
+  gem 'redcarpet'
+  gem 'yard'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Geoffrey Roguelon
+
+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,67 @@
+# DotConfig
+
+The DotConfig gem give you access to your configuration via the dot syntax. You instantiate DotConfig::Configuration with a Hash and you will retrieve the values in calling the key as method name.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dot_config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dot_config
+
+## Usage
+
+```ruby
+# Instantiate the configuration with the shortcut:
+app_config = DotConfig.new(language: 'Ruby', framework: 'Ruby on Rails')
+
+app_config.language  #=> 'Ruby'
+app_config.framework #=> 'Ruby on Rails'
+app_config.version   #=> NoMethodError: undefined method `version' for #<DotConfig::Configuration:0x007fb1fed55dd8>
+
+# Instantiate the configuration without the shortcut:
+app_config = DotConfig::Configuration.new(config: { language: 'Ruby', framework: 'Ruby on Rails' })
+
+# Instantiate the configuration with an instance of DotConfig::Configuration:
+app_config = DotConfig::Configuration.new
+app_config.config = { language: 'Ruby', framework: 'Ruby on Rails' }
+
+# Instantiate the configuration with a YAML file:
+app_config = DotConfig.new('PATH/TO/YOUR/FILE.yml')
+
+# Use a nested Hash:
+app_config = DotConfig.new(language: { ruby: 'Ruby on Rails' })
+
+app_config.language      #=> #<DotConfig::Configuration:0x007fb1fed55dd8>
+app_config.language.ruby #=> 'Ruby on Rails'
+
+# Enable the modification:
+app_config = DotConfig.new({ language: 'Ruby', framework: 'Ruby on Rails' }, true)
+# or
+app_config = DotConfig.new(true)
+app_config.config = { language: 'Ruby', framework: 'Ruby on Rails' }
+
+app_config.language  #=> 'Ruby'
+app_config.language = 'Python'
+app_config.language  #=> 'Python'
+
+# Export the configuration:
+app_config = DotConfig.new(language: { ruby: 'Ruby on Rails' })
+
+app_config.to_hash #=> { language: { ruby: 'Ruby on Rails' } }
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose    = false
+  t.warning    = true
+end
+
+desc 'Run tests'
+task :default => :test

data/dotconfig.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'dot_config/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'dotconfig'
+  gem.version       = DotConfig::Version::STRING
+  gem.authors       = 'Geoffrey Roguelon'
+  gem.email         = 'geoffrey.roguelon@gmail.com'
+  gem.description   = %q{Simplify your configuration with: DotConfig.new(language: :ruby).language #=> 'Ruby'.}
+  gem.summary       = %q{The DotConfig gem give you access to your configuration via the dot syntax. You instantiate DotConfig::Configuration with a Hash and you will retrieve the values in calling the key as method name.}
+  gem.license       = 'MIT'
+  gem.homepage      = 'http://github.com/GRoguelon/DotConfig'
+  gem.has_rdoc      = false
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w{lib}
+
+  gem.add_development_dependency 'activesupport', '~> 3.0'
+
+  gem.required_ruby_version = '>= 1.9.1'
+end

data/lib/dot_config.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require 'dot_config/configuration'
+require 'dot_config/version'
+require 'yaml'
+
+# This module provides a way to define a set of configuration with read access
+# only.
+#
+# @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+module DotConfig
+
+  # Returns an instance of +Configuration+.
+  #
+  # @param [Hash] config The +Hash+ to convert in configuration or a +String+
+  #  which represent the YAML file to load.
+  # @param [Boolean] writing Determines if the +Configuration+ is mutable.
+  # @return [Configuration] The +Configuration+ instance.
+  def self.new(config, writing = false)
+    if config.is_a?(Hash)
+      Configuration.new(config: config, writing: writing)
+    elsif config.is_a?(String) && File.exists?(config)
+      Configuration.new(config: YAML.load(File.read(config)), writing: writing)
+    else
+      raise ArgumentError, 'Unable to process the config argument'
+    end
+  end
+end

data/lib/dot_config/configuration.rb

@@ -0,0 +1,78 @@
+# -*- encoding: utf-8 -*-
+
+module DotConfig
+
+  # This class gives you access to the configuration with dot syntax.
+  #
+  # @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+  class Configuration
+
+    # @!attribute config [r]
+    #   @return [Hash] Stores the configuration like a +Hash+.
+    # @!attribute writing [r]
+    #   @return [Hash] Determines if the configuration is mutable.
+    attr_reader :config, :writing
+
+    # Class constructor.
+    #
+    # @return [self]
+    def initialize(options = {})
+      raise ArgumentError, 'Invalid argument' if !options.is_a?(Hash)
+
+      @writing    = options[:writing] ? true : false
+      self.config = options[:config] if options[:config].is_a?(Hash)
+    end
+
+    # Assigns the configuration to the instance.
+    #
+    # @param [Hash] hash The +Hash+ configuration.
+    # @return [Hash] The +Hash+ configuration.
+    def config=(hash)
+      raise ArgumentError, 'Invalid argument' if !hash.is_a?(Hash) || hash.empty?
+
+      keys   = (hash.keys + hash.keys.map { |key| "#{key}=" }).map(&:to_sym)
+      system = self.instance_variables + self.class.instance_methods(true)
+
+      if (conflict = keys & system).empty?
+        @config = Hash.new
+        hash.each do |key, value|
+          if value.is_a?(Hash)
+            @config[key.to_sym] = self.class.new(config: value, writing: @writing)
+          else
+            @config[key.to_sym] = value
+          end
+        end
+      else
+        raise "The key(s) (#{conflict.join(', ')}) is already used by Ruby"
+      end
+    end
+
+    # Post treatment of call method which have failed.
+    #
+    # @param [Symbol] name The name of the method called.
+    # @param [Array] arguments The arguments provided with the call.
+    # @return [Object] The value of the config or call the super method.
+    def method_missing(name, *arguments)
+      if name[-1, 1] == '=' && @config.key?(name[0..-2].to_sym)
+        if @writing
+          @config[name[0..-2].to_sym] = arguments.first
+        else
+          raise 'The configuration is not allowed in writing'
+        end
+      elsif @config.key?(name)
+        @config[name]
+      else
+        super
+      end
+    end
+
+    # Returns the config like a +Hash+.
+    #
+    # @return [Hash] The original hash with keys symbolized.
+    def to_hash
+      hash = Hash.new
+      @config.each { |k, v| hash[k] = v.is_a?(self.class) ? v.to_hash : v }
+      hash
+    end
+  end
+end

data/lib/dot_config/version.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+module DotConfig
+
+  # This module defines the version of the gem.
+  #
+  # @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+  module Version
+
+    # The major number version.
+    MAJOR  = 0
+    # The minor number version.
+    MINOR  = 0
+    # The tiny number version.
+    TINY   = 2
+    # The pre realese number version.
+    PRE    = nil
+    # The complete number version.
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/test/dot_config/configuration_test.rb

@@ -0,0 +1,85 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+
+class DotConfig::ConfigurationTest < ActiveSupport::TestCase
+
+  test 'class is defined' do
+    assert DotConfig.const_defined?(:Configuration), 'Class undefined'
+  end
+
+  test 'default writing value' do
+    assert_equal false, Configuration.new.writing
+    assert_equal false, Configuration.new(writing: false).writing
+    assert_equal true,  Configuration.new(writing: true).writing
+  end
+
+  test 'has new method' do
+    assert_respond_to Configuration, :new, 'Method undefined'
+
+    assert_nothing_raised(ArgumentError) do
+      Configuration.new
+      Configuration.new(writing: true)
+      Configuration.new(config: { hello: :world })
+      Configuration.new(config: { hello: :world }, writing: true)
+    end
+  end
+
+  test 'new with config' do
+    simple_hash = { language: 'Ruby', framework: 'Ruby on Rails' }
+    config = Configuration.new(config: simple_hash)
+
+    assert_equal simple_hash.keys, config.config.keys, 'Loosen keys'
+    simple_hash.each { |key, value| assert_equal value, config.send(key.to_sym) }
+  end
+
+  test 'has config= method' do
+    assert_respond_to Configuration.new, :config=, 'Method undefined'
+
+    assert_nothing_raised(ArgumentError) do
+      Configuration.new.config = { hello: :world }
+      Configuration.new(writing: true).config = { hello: :world }
+    end
+  end
+
+  test 'with nested config' do
+    nested_hash = { language: 'Ruby',
+                   framework: { rails: [:active_record, :active_support] } }
+    config = Configuration.new(config: nested_hash)
+
+    assert_instance_of Configuration, config.framework, 'Not a Configuration'
+    assert_equal nested_hash[:framework][:rails], config.framework.rails
+  end
+
+  test 'getter method' do
+    nested_hash = { language: 'Ruby',
+                   framework: { rails: [:active_record, :active_support] } }
+    config = Configuration.new(config: nested_hash)
+
+    assert_instance_of nested_hash[:language].class, config.language
+    assert_instance_of Configuration, config.framework
+    assert_instance_of nested_hash[:framework][:rails].class, config.framework.rails
+  end
+
+  test 'setter method' do
+    nested_hash = { language: 'Ruby',
+                   framework: { rails: [:active_record, :active_support] } }
+
+    config = Configuration.new(config: nested_hash)
+    assert_raise(RuntimeError) { config.language = 'Python' }
+    assert_equal nested_hash[:language], config.language
+
+    config = Configuration.new(config: nested_hash, writing: true)
+    config.language = 'Python'
+    assert_equal 'Python', config.language
+  end
+
+  test 'to_hash method' do
+    assert_respond_to Configuration.new, :to_hash, 'Method undefined'
+
+    nested_hash = { language: 'Ruby',
+                   framework: { rails: [:active_record, :active_support] } }
+    config = Configuration.new(config: nested_hash)
+    assert_equal config.to_hash, nested_hash
+  end
+end

data/test/dot_config/version_test.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+
+class DotConfig::VersionTest < ActiveSupport::TestCase
+
+  test 'Version is defined' do
+    assert DotConfig.const_defined?(:Version), 'Module undefined'
+  end
+
+  test 'version constants is defined' do
+    assert Version.const_defined?(:MAJOR),  'MAJOR undefined'
+    assert Version.const_defined?(:MINOR),  'MINOR undefined'
+    assert Version.const_defined?(:TINY),   'TINY undefined'
+    assert Version.const_defined?(:PRE),    'PRE undefined'
+    assert Version.const_defined?(:STRING), 'STRING undefined'
+  end
+
+  test 'version string is equal' do
+    major, minor, tiny, pre = Version::STRING.split('.')
+
+    assert_equal Version::MAJOR.to_s, major, 'Major not equal'
+    assert_equal Version::MINOR.to_s, minor, 'Minor not equal'
+    assert_equal Version::TINY.to_s,  tiny,  'Tiny not equal'
+    assert_equal Version::PRE,        pre,   'Pre not equal'
+  end
+end

data/test/dot_config_test.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+
+class DotConfigTest < ActiveSupport::TestCase
+
+  test 'module is defined' do
+    assert Object.const_defined?(:DotConfig), 'Module undefined'
+  end
+
+  test 'has new method' do
+    assert_respond_to DotConfig, :new, 'Method undefined'
+    assert_instance_of DotConfig::Configuration, DotConfig.new(world: 'hello')
+    assert_raise(ArgumentError) { DotConfig.new(:world) }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+
+require 'dot_config'
+require 'active_support/test_case'
+require 'test/unit'
+
+# Add extra methods to ActiveSupport::TestCase.
+#
+# @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
+class ActiveSupport::TestCase
+  include DotConfig
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: dotconfig
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Geoffrey Roguelon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ! 'Simplify your configuration with: DotConfig.new(language: :ruby).language
+  #=> ''Ruby''.'
+email: geoffrey.roguelon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dotconfig.gemspec
+- lib/dot_config.rb
+- lib/dot_config/configuration.rb
+- lib/dot_config/version.rb
+- test/dot_config/configuration_test.rb
+- test/dot_config/version_test.rb
+- test/dot_config_test.rb
+- test/test_helper.rb
+homepage: http://github.com/GRoguelon/DotConfig
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: The DotConfig gem give you access to your configuration via the dot syntax.
+  You instantiate DotConfig::Configuration with a Hash and you will retrieve the values
+  in calling the key as method name.
+test_files:
+- test/dot_config/configuration_test.rb
+- test/dot_config/version_test.rb
+- test/dot_config_test.rb
+- test/test_helper.rb
+has_rdoc: false