tg_config 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,8 @@
+script: "rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+notifications:
+  recipients:
+    - wael.nasreddine@gmail.com

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tg_config/errors.rb

@@ -0,0 +1,12 @@
+module TechnoGate
+  module TgConfig
+    TgConfigError = Class.new Exception
+
+    NotReadableError = Class.new TgConfigError
+    NotDefinedError = Class.new TgConfigError
+    NotWritableError = Class.new TgConfigError
+    NotValidError = Class.new TgConfigError
+    IsEmptyError = Class.new TgConfigError
+    ConfigFileNotSetError = Class.new TgConfigError
+  end
+end

data/lib/tg_config/version.rb

@@ -0,0 +1,17 @@
+module TechnoGate
+  module TgConfig
+    MAJOR = 0
+    MINOR = 0
+    TINY = 1
+    PRE = ''
+
+    def self.version
+      # Init the version
+      version = [MAJOR, MINOR, TINY]
+      # Add the pre if available
+      version << PRE unless PRE.nil? || PRE !~ /\S/
+      # Return the version joined by a dot
+      version.join('.')
+    end
+  end
+end

data/lib/tg_config.rb

@@ -0,0 +1,102 @@
+require "yaml"
+require "active_support/core_ext/hash/indifferent_access"
+require "tg_config/errors"
+require "tg_config/version"
+
+module TechnoGate
+  module TgConfig
+    extend self
+
+    # Define the config class variable
+    @@config = nil
+
+    # Define the config file
+    @@config_file = nil
+
+    # Return a particular config variable from the parsed config file
+    #
+    # @param [String|Symbol] config
+    # @return mixed
+    # @raise [Void]
+    def [](config)
+      if @@config.nil?
+        check_config_file
+        @@config ||= parse_config_file
+      end
+
+      @@config.send(:[], config)
+    end
+
+    # Update the config file
+    #
+    # @param [String] config
+    # @param [Mixed] Values
+    def []=(config, value)
+      if @@config.nil?
+        check_config_file
+        @@config ||= parse_config_file
+      end
+
+      @@config.send(:[]=, config, value)
+    end
+
+    # Get the config file
+    #
+    # @return [String] Absolute path to the config file
+    def config_file
+      raise ConfigFileNotSetError unless @@config_file
+
+      @@config_file
+    end
+
+    # Set the config file
+    #
+    # @param [String] Absolute path to the config file
+    def config_file=(config_file)
+      @@config_file = config_file
+    end
+
+    # Save the config file
+    def save
+      # Make sure the config file is writable
+      check_config_file(true)
+      # Write the config file
+      write_config_file
+    end
+
+    protected
+    # Initialize the configuration file
+    def initialize_config_file
+      File.open(config_file, 'w') do |f|
+        f.write ""
+      end
+    end
+
+    # Check the config file
+    def check_config_file(writable = false)
+      # Check that config_file is defined
+      raise NotDefinedError unless config_file
+      # Check that the config file exists
+      initialize_config_file unless ::File.exists?(config_file)
+      # Check that the config file is readable?
+      raise NotReadableError unless ::File.readable?(config_file)
+      # Checl that the Config file is writable?
+      raise NotWritableError unless ::File.writable?(config_file) if writable
+    end
+
+    # Parse the config file
+    #
+    # @return [HashWithIndifferentAccess] The config
+    def parse_config_file
+      YAML.load_file(config_file).with_indifferent_access
+    end
+
+    # Write the config file
+    def write_config_file
+      raise IsEmptyError unless @@config
+      File.open config_file, 'w' do |f|
+        f.write(@@config.to_hash.to_yaml)
+      end
+    end
+  end
+end

data/spec/lib/tg_config_spec.rb

@@ -0,0 +1,231 @@
+require 'spec_helper'
+
+describe TgConfig do
+  before(:each) do
+    @config = {:submodules => [:pathogen]}
+    @config_path = '/valid/path'
+    @invalid_config_path = '/invalid/path'
+    YAML.stubs(:load_file).with(@config_path).returns(@config)
+    TgConfig.send(:class_variable_set, :@@config_file, @config_path)
+
+    ::File.stubs(:exists?).with(@config_path).returns(true)
+    ::File.stubs(:readable?).with(@config_path).returns(true)
+    ::File.stubs(:writable?).with(@config_path).returns(true)
+
+    ::File.stubs(:exists?).with(@invalid_config_path).returns(false)
+    ::File.stubs(:readable?).with(@invalid_config_path).returns(false)
+    ::File.stubs(:writable?).with(@invalid_config_path).returns(false)
+
+    @file_handler = mock "file handler"
+    @file_handler.stubs(:write)
+
+    ::File.stubs(:open).with(@config_path, 'w').yields(@file_handler)
+  end
+
+  describe "@@config" do
+    it "should have a class_variable @@config" do
+      lambda { subject.send(:class_variable_get, :@@config) }.should_not raise_error NameError
+    end
+  end
+
+  describe "@@config_file" do
+    it "should have a class_variable @@config_file" do
+      lambda {subject.send(:class_variable_get, :@@config_file) }.should_not raise_error NameError
+    end
+  end
+
+  describe "#config_file" do
+    it { should respond_to :config_file }
+
+    it "should return @@config_file" do
+      subject.send(:class_variable_set, :@@config_file, @invalid_config_path)
+
+      subject.config_file.should == @invalid_config_path
+    end
+
+    it "should raise ConfigFileNotSetError if @@config_file is not set" do
+      subject.send(:class_variable_set, :@@config_file, nil)
+
+      lambda { subject.config_file }.should raise_error TgConfig::ConfigFileNotSetError
+    end
+  end
+
+  describe "#config_file=" do
+    it { should respond_to :config_file= }
+
+    it "should set @@config_file" do
+      subject.config_file = @invalid_config_path
+      subject.config_file.should == @invalid_config_path
+    end
+  end
+
+  describe "#check_config_file" do
+    before(:each) do
+      TgConfig.stubs(:initialize_config_file)
+    end
+
+    it { should respond_to :check_config_file }
+
+    it "should call File.exists?" do
+      ::File.expects(:exists?).with(@config_path).returns(true).once
+
+      subject.send(:check_config_file)
+    end
+
+    it "should call File.readable?" do
+      ::File.expects(:readable?).with(@config_path).returns(true).once
+
+      subject.send(:check_config_file)
+    end
+
+    it "should call File.writable?" do
+      ::File.expects(:writable?).with(@config_path).returns(true).once
+
+      subject.send(:check_config_file, true)
+    end
+
+    it "should not call File.writable? if no arguments were passed" do
+      ::File.expects(:writable?).with(@config_path).returns(true).never
+
+      subject.send(:check_config_file)
+    end
+
+    it "should raise TgConfig::NotReadableError if config not readable" do
+      TgConfig.stubs(:config_file).returns(@invalid_config_path)
+      ::File.stubs(:readable?).with(@invalid_config_path).returns(false)
+
+      lambda { subject.send(:check_config_file) }.should raise_error TgConfig::NotReadableError
+    end
+
+    it "should raise TgConfig::NotWritableError if config not readable" do
+      TgConfig.stubs(:config_file).returns(@config_path)
+      ::File.stubs(:writable?).with(@config_path).returns(false)
+
+      lambda { subject.send(:check_config_file, true) }.should raise_error TgConfig::NotWritableError
+    end
+
+  end
+
+  describe "#initialize_config_file" do
+    it { should respond_to :initialize_config_file }
+
+    it "should be able to create the config file from the template" do
+      config_file = mock
+      config_file.expects(:write).once
+      File.expects(:open).with(TgConfig.config_file, 'w').yields(config_file).once
+
+      subject.send :initialize_config_file
+    end
+  end
+
+  describe "#parse_config_file" do
+    before(:each) do
+      TgConfig.send(:class_variable_set, :@@config, nil)
+      TgConfig.stubs(:initialize_config_file)
+    end
+
+    it { should respond_to :parse_config_file }
+
+    it "should parse the config file and return an instance of HashWithIndifferentAccess" do
+      subject.send(:parse_config_file).should be_instance_of HashWithIndifferentAccess
+    end
+  end
+
+  describe "#[]" do
+    before(:each) do
+      TgConfig.send(:class_variable_set, :@@config, nil)
+      TgConfig.stubs(:initialize_config_file)
+    end
+
+    it "should call check_config_file" do
+      TgConfig.expects(:check_config_file).once
+
+      subject[:submodules]
+    end
+
+    it "should call parse_config_file" do
+      TgConfig.expects(:parse_config_file).returns(@config).once
+
+      subject[:submodules]
+    end
+  end
+
+  describe "#[]=" do
+    after(:each) do
+      TgConfig.send(:class_variable_set, :@@config, nil)
+    end
+
+    it { should respond_to :[]= }
+
+    it "should set the new config in @@config" do
+      subject[:submodules] = [:pathogen, :github]
+      subject.send(:class_variable_get, :@@config)[:submodules].should ==
+        [:pathogen, :github]
+    end
+  end
+
+  describe "#write_config_file" do
+    before(:each) do
+      subject.send(:class_variable_set, :@@config, @config)
+      subject.send(:class_variable_get, :@@config).stubs(:to_hash).returns(@config)
+    end
+
+    it { should respond_to :write_config_file }
+
+    it "should call to_hash on @@config" do
+      subject.send(:class_variable_get, :@@config).expects(:to_hash).returns(@config).once
+
+      subject.send :write_config_file
+    end
+
+    it "should call to_yaml on @@config.to_hash" do
+      @config.expects(:to_yaml).returns(@config.to_yaml).twice # => XXX: Why twice ?
+      subject.send(:class_variable_get, :@@config).stubs(:to_hash).returns(@config)
+
+      subject.send :write_config_file
+    end
+
+    it "should call File.open with config_file" do
+      ::File.expects(:open).with(@config_path, 'w').yields(@file_handler).once
+
+      subject.send :write_config_file
+    end
+
+    it "should write the yaml contents to the config file" do
+      @file_handler.expects(:write).with(@config.to_yaml).once
+      ::File.stubs(:open).with(@config_path, 'w').yields(@file_handler)
+
+      subject.send :write_config_file
+    end
+
+    it "should raise TgConfig::IsEmptyError" do
+      subject.send(:class_variable_set, :@@config, nil)
+
+      lambda { subject.send :write_config_file }.should raise_error TgConfig::IsEmptyError
+    end
+  end
+
+  describe "#save" do
+    before(:each) do
+      subject.send(:class_variable_set, :@@config, @config)
+      subject.send(:class_variable_get, :@@config).stubs(:to_hash).returns(@config)
+    end
+
+    it { should respond_to :save }
+
+    it "should call check_config_file to make sure it is writable" do
+      TgConfig.expects(:check_config_file).with(true).once
+
+      subject.save
+    end
+
+    it "should call write_config_file" do
+      TgConfig.expects(:write_config_file).once
+
+      subject.save
+    end
+
+    it "should clear the cache" do
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.push File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
+require 'tg_config'
+
+include TechnoGate
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  # config.mock_with :rspec
+end

data/tg_config.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tg_config/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tg_config"
+  s.version     = TechnoGate::TgConfig.version
+  s.authors     = ["Wael Nasreddine"]
+  s.email       = ["wael.nasreddine@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A simple YAML configuration reader and writer}
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
+
+  ####
+  # Run-time dependencies
+  ####
+
+  # Active Support
+  s.add_dependency 'activesupport', '~>3.1.1'
+
+  ####
+  # Development dependencies
+  ####
+
+  # Guard
+  s.add_development_dependency 'guard', '~>0.8.4'
+  s.add_development_dependency 'guard-bundler', '~>0.1.3'
+  s.add_development_dependency 'guard-rspec', '~>0.4.5'
+
+  # Documentation
+  s.add_development_dependency 'yard', '~>0.7.2'
+
+  ####
+  # Development / Test dependencies
+  ####
+
+  # RSpec / Capybara
+  s.add_development_dependency 'rspec', '~>2.6.0'
+
+  # Mocha
+  s.add_development_dependency 'mocha', '~>0.10.0'
+
+  ####
+  # Debugging
+  ####
+  s.add_development_dependency 'pry', '~>0.9.6.2'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: tg_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Wael Nasreddine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &14181700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *14181700
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &14177540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *14177540
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &14175700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: *14175700
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &14185340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :development
+  prerelease: false
+  version_requirements: *14185340
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &14204580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: *14204580
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &14200620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *14200620
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &14233720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *14233720
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &14231720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *14231720
+description: A simple YAML configuration reader and writer
+email:
+- wael.nasreddine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- Rakefile
+- lib/tg_config.rb
+- lib/tg_config/errors.rb
+- lib/tg_config/version.rb
+- spec/lib/tg_config_spec.rb
+- spec/spec_helper.rb
+- tg_config.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2304515669427187554
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A simple YAML configuration reader and writer
+test_files:
+- spec/lib/tg_config_spec.rb
+- spec/spec_helper.rb
+has_rdoc: