tg_config 0.0.1 → 0.1.0

data/Rakefile

@@ -3,4 +3,38 @@ require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
+# Monkey patch Bundler::GemHelper
+#
+# Git flow create the tag after finishing a release however this breaks
+# <b>rake release</b> because it expects that no tag for the current version
+# is present, this patch overrides this behaviour to skip version tagging if
+# the tag already exists instead of raising an exception
+Bundler::GemHelper.class_eval <<-END, __FILE__, __LINE__ + 1
+  # Tag the current version
+  def tag_version
+    unless already_tagged?
+      sh %(git tag -a -m "Version \#{version}" \#{version_tag})
+      Bundler.ui.confirm "Tagged \#{version_tag}"
+    end
+    yield if block_given?
+  rescue
+    Bundler.ui.error "Untagged \#{version_tag} due to error"
+    sh_with_code "git tag -d \#{version_tag}"
+    raise
+  end
+
+  # The original method raises an exception, we should override it
+  def guard_already_tagged
+  end
+
+  # This method check if the tag has already been tagged
+  def already_tagged?
+    if sh('git tag').split(/\n/).include?(version_tag)
+      true
+    else
+      false
+    end
+  end
+END
+
 task :default => :spec

data/lib/tg_config/errors.rb

@@ -1,5 +1,5 @@
 module TechnoGate
-  module TgConfig
+  class TgConfig
     TgConfigError = Class.new Exception
 
     NotReadableError = Class.new TgConfigError

data/lib/tg_config/version.rb

@@ -1,8 +1,8 @@
 module TechnoGate
-  module TgConfig
+  class TgConfig
     MAJOR = 0
-    MINOR = 0
-    TINY = 1
+    MINOR = 1
+    TINY = 0
     PRE = ''
 
     def self.version

data/lib/tg_config.rb

@@ -4,14 +4,15 @@ require "tg_config/errors"
 require "tg_config/version"
 
 module TechnoGate
-  module TgConfig
-    extend self
+  class TgConfig
 
-    # Define the config class variable
-    @@config = nil
+    attr_reader :config_file
 
-    # Define the config file
-    @@config_file = nil
+    def initialize(config_file)
+      @config_file = config_file
+      check_config_file
+      @config = parse_config_file
+    end
 
     # Return a particular config variable from the parsed config file
     #
@@ -19,12 +20,7 @@ module TechnoGate
     # @return mixed
     # @raise [Void]
     def [](config)
-      if @@config.nil?
-        check_config_file
-        @@config ||= parse_config_file
-      end
-
-      @@config.send(:[], config)
+      @config.send(:[], config)
     end
 
     # Update the config file
@@ -32,28 +28,7 @@ module TechnoGate
     # @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
+      @config.send(:[]=, config, value)
     end
 
     # Save the config file
@@ -67,9 +42,8 @@ module TechnoGate
     protected
     # Initialize the configuration file
     def initialize_config_file
-      File.open(config_file, 'w') do |f|
-        f.write ""
-      end
+      @config = HashWithIndifferentAccess.new
+      write_config_file
     end
 
     # Check the config file
@@ -93,9 +67,9 @@ module TechnoGate
 
     # Write the config file
     def write_config_file
-      raise IsEmptyError unless @@config
+      raise IsEmptyError unless @config
       File.open config_file, 'w' do |f|
-        f.write(@@config.to_hash.to_yaml)
+        f.write(@config.to_hash.to_yaml)
       end
     end
   end

data/spec/lib/tg_config_spec.rb

@@ -1,105 +1,75 @@
 require 'spec_helper'
 
 describe TgConfig do
+  let(:config) { {:submodules => [:pathogen]} }
+  let(:config_path) { '/valid/path' }
+  let(:invalid_config_path) { '/invalid/path' }
+
+  subject { TgConfig.new config_path }
+
   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)
+    YAML.stubs(:load_file).with(config_path).returns(config)
+    TgConfig.send(:instance_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(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.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
+    ::File.stubs(:open).with(config_path, 'w').yields(@file_handler)
   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 return @config_file" do
+      subject.send(:instance_variable_set, :@config_file, invalid_config_path)
 
-    it "should set @@config_file" do
-      subject.config_file = @invalid_config_path
-      subject.config_file.should == @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
+      ::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
+      ::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
+      ::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
+      ::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)
+      ::File.stubs(:readable?).with(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)
+      ::File.stubs(:writable?).with(config_path).returns(false)
 
       lambda { subject.send(:check_config_file, true) }.should raise_error TgConfig::NotWritableError
     end
@@ -109,19 +79,23 @@ describe TgConfig do
   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
+    it "should set @config to an empty HashWithIndifferentAccess" do
+      subject.send(:instance_variable_set, :@config, nil)
+      subject.send(:initialize_config_file)
+      subject.send(:instance_variable_get, :@config).should == HashWithIndifferentAccess.new
+    end
 
-      subject.send :initialize_config_file
+    it "should call :write_config_file" do
+      subject.expects(:write_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)
+      subject.send(:instance_variable_set, :@config, nil)
     end
 
     it { should respond_to :parse_config_file }
@@ -132,74 +106,63 @@ describe TgConfig do
   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
+    it { should respond_to :[] }
 
-      subject[:submodules]
-    end
-
-    it "should call parse_config_file" do
-      TgConfig.expects(:parse_config_file).returns(@config).once
-
-      subject[:submodules]
+    it "should return [:pathogen] for submodules" do
+      subject[:submodules].should == [:pathogen]
     end
   end
 
   describe "#[]=" do
     after(:each) do
-      TgConfig.send(:class_variable_set, :@@config, nil)
+      subject.send(:instance_variable_set, :@config, nil)
     end
 
     it { should respond_to :[]= }
 
-    it "should set the new config in @@config" do
+    it "should set the new config in @config" do
       subject[:submodules] = [:pathogen, :github]
-      subject.send(:class_variable_get, :@@config)[:submodules].should ==
+      subject.send(:instance_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)
+      subject.send(:instance_variable_set, :@config, config)
+      subject.send(:instance_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
+    it "should call to_hash on @config" do
+      subject.send(:instance_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)
+    it "should call to_yaml on @config.to_hash" do
+      config.expects(:to_yaml).returns(config.to_yaml).twice # => XXX: Why twice ?
+      subject.send(:instance_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
+      ::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)
+      @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)
+      subject.send(:instance_variable_set, :@config, nil)
 
       lambda { subject.send :write_config_file }.should raise_error TgConfig::IsEmptyError
     end
@@ -207,25 +170,22 @@ describe TgConfig do
 
   describe "#save" do
     before(:each) do
-      subject.send(:class_variable_set, :@@config, @config)
-      subject.send(:class_variable_get, :@@config).stubs(:to_hash).returns(@config)
+      subject.send(:instance_variable_set, :@config, config)
+      subject.send(:instance_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
+      TgConfig.any_instance.expects(:check_config_file).with(true).once
 
       subject.save
     end
 
     it "should call write_config_file" do
-      TgConfig.expects(:write_config_file).once
+      TgConfig.any_instance.expects(:write_config_file).once
 
       subject.save
     end
-
-    it "should clear the cache" do
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tg_config
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &14181700 !ruby/object:Gem::Requirement
+  requirement: &21161080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *14181700
+  version_requirements: *21161080
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &14177540 !ruby/object:Gem::Requirement
+  requirement: &21174660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.4
   type: :development
   prerelease: false
-  version_requirements: *14177540
+  version_requirements: *21174660
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &14175700 !ruby/object:Gem::Requirement
+  requirement: &21172060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.1.3
   type: :development
   prerelease: false
-  version_requirements: *14175700
+  version_requirements: *21172060
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &14185340 !ruby/object:Gem::Requirement
+  requirement: &21169760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.4.5
   type: :development
   prerelease: false
-  version_requirements: *14185340
+  version_requirements: *21169760
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &14204580 !ruby/object:Gem::Requirement
+  requirement: &21197220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *14204580
+  version_requirements: *21197220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14200620 !ruby/object:Gem::Requirement
+  requirement: &21195700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *14200620
+  version_requirements: *21195700
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &14233720 !ruby/object:Gem::Requirement
+  requirement: &21193100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *14233720
+  version_requirements: *21193100
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &14231720 !ruby/object:Gem::Requirement
+  requirement: &21217660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.9.6.2
   type: :development
   prerelease: false
-  version_requirements: *14231720
+  version_requirements: *21217660
 description: A simple YAML configuration reader and writer
 email:
 - wael.nasreddine@gmail.com
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2304515669427187554
+      hash: -2039472653472340343
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11