zfinifile 1.0.0

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bones'
+rescue LoadError
+  abort '### please install the "bones" gem ###'
+end
+
+ensure_in_path 'lib'
+require 'zfinifile'
+
+task :default => 'test:run'
+task 'gem:release' => 'test:run'
+
+Bones {
+  name         'zfinifile'
+  summary      'INI file reader that supports the inheritance available in Zend Framework'
+  authors      'Brett Mack'
+  email        'brett.mack@bauermedia.co.uk'
+  url          'http://rubygems.org/gems/zfinifile'
+  version      ZFIniFile::VERSION
+
+  use_gmail
+  depend_on    'bones-git', :development => true
+}

data/lib/zfinifile.rb

@@ -0,0 +1,131 @@
+#
+# This class is used to load and parse the ini file. Much has been borrowed from the existing gem
+# 'inifile' (https://github.com/TwP/inifile) which I would suggest using if you don't need section 
+# inheritance.
+#
+
+#encoding: UTF-8
+
+class ZFIniFile
+
+	# :stopdoc:
+	class Error < StandardError; end
+	VERSION = '1.0.0'
+	# :startdoc:
+
+	#
+	# call-seq:
+	# 	ZFIniFile.load( filename )
+	# 	ZFIniFile.load( filename, options )
+	#
+	# Open the given _filename_ and load the contents of the INI file.
+	# The following _options_ can be passed to this method:
+	#
+	# 	:comment => ';'		The line comment character
+	# 	:parameter => '='	The parameter / value seperator
+	# 	:encoding => nil	The encoding to use when reading a file (RUBY 1.9)
+	# 	:inheritance => ':'	The character within a section that denotes inheritance
+	#
+	def self.load( filename, opts = {} )
+		new(filename, opts)
+	end
+
+	#
+	# call-seq:
+	# 	ZFIniFile.new( filename )
+	# 	ZFIniFile.new( filename, options )
+	#
+	# Open the given _filename_ and load the contents of the INI file.
+	# The following _options_ can be passed to this method:
+	#
+	# 	:comment => ';'		The line comment character
+	# 	:parameter => '='	The parameter / value seperator
+	# 	:encoding => nil	The encoding to use when reading a file (RUBY 1.9)
+	# 	:inheritance => ':'	The character within a section that denotes inheritance
+	#
+	def initialize( filename, opts = {} )
+		@fn = filename
+		@comment = opts.fetch(:comment, ';')
+		@param = opts.fetch(:parameter, '=')
+		@encoding = opts.fetch(:encoding, nil)
+		@inheritance = opts.fetch(:inheritance, ':')
+		@ini = Hash.new { |h,k| h[k] = Hash.new }
+		@inheritsfrom = Hash.new { |h,k| h[k] = [] }
+
+		@rgxp_comment = %r/\A\s*\z|\A\s*[#{@comment}]/
+		@rgxp_section = %r/\A\s*\[([^\]]+)\]/
+		@rgxp_param   = %r/[^\\]#{@param}/
+
+		parse
+	end
+
+	#
+	# call-seq:
+	# 	get_section( section )
+	#
+	# Return the _section_ of the inifile as a Hash.
+	#
+	def get_section( section )
+		return unless @ini[section]
+		@ini[section]
+	end
+
+	private
+
+	# Parse tge ini file contents.
+	#
+	def parse
+		raise Error, "Unable to open file: #{@fn}" unless File.file?(@fn)
+
+		@_current_section = nil
+		@_current_value = nil
+		@_current_param = nil
+
+		fd = (RUBY_VERSION >= '1.9' && @encoding) ?
+			File.open(@fn, 'r', :encoding => @encoding) :
+			File.open(@fn, 'r')
+
+		while line = fd.gets
+			line = line.chomp
+
+			if line =~ @rgxp_comment
+				next
+			end
+
+			if line =~ @rgxp_section
+				section = $1.split("#{@inheritance}")
+				@_current_section = @ini[section[0].strip]
+				if section.length == 2
+					@inheritsfrom[section[1].strip].unshift(section[0].strip)
+				end
+				next
+			end
+
+			#So it't not a comment and it's not a section. Process the line as param = value
+			parse_property line
+		end
+
+		@inheritsfrom.each { |key, val|
+			next unless @ini[key]
+			@_inherit_base = @ini[key]
+			val.each do |d|
+				next unless @ini[d]
+				@ini[d] = @_inherit_base.merge(@ini[d])
+			end
+		}
+	ensure
+		fd.close if defined? fd and fd
+		@_current_section = nil
+		@_current_param = nil
+		@_current_value = nil
+	end
+
+	# Parse the ini file line as param = value
+	#
+	def parse_property( line )
+		return unless @_current_section
+		param, value = line.split("#{@param}")
+		@_current_section[param.strip] = value.strip.gsub(/["']/, '')
+	end
+
+end

data/test/data/application.ini

@@ -0,0 +1,99 @@
+[production]
+phpSettings.display_startup_errors = 0
+phpSettings.display_errors = 0
+includePaths.library = APPLICATION_PATH "/../library"
+bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
+bootstrap.class = "Bootstrap"
+appnamespace = "Application"
+
+resources.frontController.params.displayExceptions = 0
+
+resources.frontController.defaultModule = "v1"
+resources.frontController.moduleDirectory = APPLICATION_PATH "/modules"
+resources.frontController.moduleControllerDirectoryName = "controllers"
+
+resources.modules[] = ""
+
+; ------------------------------------------------------------------------------
+; Autoload Namespaces
+; ------------------------------------------------------------------------------
+autoloaderNamespaces[] = "Bisna"
+autoloaderNamespaces[] = "Symfony"
+autoloaderNamespaces[] = "Doctrine"
+
+;; added for Doctrine2 Integration
+pluginPaths.Bisna\Application\Resource\ = "Bisna/Application/Resource"
+
+; ------------------------------------------------------------------------------
+; Doctrine Cache Configuration
+; ------------------------------------------------------------------------------
+
+; Points to default cache instance to be used. Optional is only one cache is defined
+resources.doctrine.cache.defaultCacheInstance = default
+
+; Cache Instance configuration for "default" cache
+resources.doctrine.cache.instances.default.adapterClass = "Doctrine\Common\Cache\MemcacheCache"
+resources.doctrine.cache.instances.default.namespace    = "TestService_"
+resources.doctrine.cache.instances.default.options.servers.0.host = localhost
+resources.doctrine.cache.instances.default.options.servers.0.port = 11211
+
+; ------------------------------------------------------------------------------
+; Doctrine DBAL Configuration
+; ------------------------------------------------------------------------------
+
+; Points to default connection to be used. Optional if only one connection is defined
+resources.doctrine.dbal.defaultConnection = default
+
+; Database configuration
+;resources.doctrine.dbal.connections.default.parameters.wrapperClass = ""
+resources.doctrine.dbal.connections.default.parameters.driver   = "pdo_mysql"
+resources.doctrine.dbal.connections.default.parameters.dbname   = "[DATABASE_NAME]"
+resources.doctrine.dbal.connections.default.parameters.host = "localhost"
+resources.doctrine.dbal.connections.default.parameters.port = 3306
+resources.doctrine.dbal.connections.default.parameters.user = "[DATABASE_USERNAME]"
+resources.doctrine.dbal.connections.default.parameters.password = "[DATABASE_PASSWORD]"
+
+; ------------------------------------------------------------------------------
+; Doctrine ORM Configuration
+; ------------------------------------------------------------------------------
+
+; Points to default EntityManager to be used. Optional if only one EntityManager is defined
+resources.doctrine.orm.defaultEntityManager = default
+
+; EntityManager configuration for "default" manager
+resources.doctrine.orm.entityManagers.default.connection     = default
+resources.doctrine.orm.entityManagers.default.proxy.autoGenerateClasses = true
+resources.doctrine.orm.entityManagers.default.proxy.dir                 = APPLICATION_PATH "/../library/Bauer/Entity/Proxy"
+resources.doctrine.orm.entityManagers.default.metadataDrivers.annotationRegistry.annotationFiles[]     = APPLICATION_PATH "/../library/Doctrine/ORM/Mapping/Driver/DoctrineAnnotations.php"
+resources.doctrine.orm.entityManagers.default.metadataDrivers.drivers.0.adapterClass          = "Doctrine\ORM\Mapping\Driver\AnnotationDriver"
+resources.doctrine.orm.entityManagers.default.metadataDrivers.drivers.0.mappingDirs[]         = APPLICATION_PATH "/../library/Bauer/Entity"
+resources.doctrine.orm.entityManagers.default.metadataDrivers.drivers.0.annotationReaderClass = "Doctrine\Common\Annotations\AnnotationReader"
+resources.doctrine.orm.entityManagers.default.metadataDrivers.drivers.0.annotationReaderCache = default
+
+[staging : production]
+app.url.base = "Should be overwritten in testing"
+app.url.tester = "Should still exist in testing"
+
+[testing : staging]
+phpSettings.display_startup_errors = 1
+phpSettings.display_errors = 1
+
+; Database configuration
+;resources.doctrine.dbal.connections.default.parameters.driver   = "pdo_sqlite"
+;resources.doctrine.dbal.connections.default.parameters.path   = APPLICATION_PATH "/../tests/data/test.db"
+resources.doctrine.dbal.connections.default.parameters.dbname   = "test_testservice_testing"
+resources.doctrine.dbal.connections.default.parameters.user = "root"
+resources.doctrine.dbal.connections.default.parameters.password = "rootpwd"
+
+app.url.base = 'http://testservice.testing.mydomain.co.uk'
+
+[development : production]
+phpSettings.display_startup_errors = 1
+phpSettings.display_errors = 1
+
+; Database configuration
+resources.doctrine.dbal.connections.default.parameters.dbname   = "test_testservice_development"
+resources.doctrine.dbal.connections.default.parameters.user = "root"
+resources.doctrine.dbal.connections.default.parameters.password = "devpwd"
+
+app.url.base = 'http://testservice.development.mydomain.co.uk'

data/test/test_zfinifile.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+libpath = File.expand_path '../../lib', __FILE__
+require File.join(libpath, 'zfinifile')
+
+
+class ZFIniFileTest < Test::Unit::TestCase
+
+	def test_no_file_given
+		assert_raise ArgumentError do 
+			ZFIniFile.load()
+		end
+	end
+
+	def test_ini_file_not_exists
+		assert_raise ZFIniFile::Error do
+			ZFIniFile.load('filenotexists.ini')
+		end
+	end
+
+	def test_instances
+		inifile = ZFIniFile.load('test/data/application.ini')
+		assert_instance_of ZFIniFile, inifile
+		assert_instance_of Hash, inifile.get_section( 'testing' )
+		assert_instance_of Hash, inifile.get_section( 'nosuchsection' )
+	end
+
+	def test_inheritance
+		inifile = ZFIniFile.load('test/data/application.ini')
+		testing = inifile.get_section('testing')
+		staging = inifile.get_section('staging')
+		production = inifile.get_section('production')
+		# Make sure dbname has been overwritten in each section
+		testkey = "resources.doctrine.dbal.connections.default.parameters.dbname"
+		assert_nil [ testing[testkey], production[testkey] ].uniq!
+
+		# Make sure the tester val from staging still exists in testing
+		assert_equal "Should still exist in testing", testing["app.url.tester"]
+
+		# Make sure the url.base val from staging was overwritten in testing
+		assert_not_equal staging["app.url.base"], testing["app.url.base"]
+	end
+
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: zfinifile
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brett Mack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-13 00:00:00.000000000 Z
+dependencies: []
+description: A ruby gem to pass ini files with inheritance such as those used by the
+  Zend Framework
+email: brett.mack@bauermedia.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zfinifile.rb
+- Rakefile
+- test/test_zfinifile.rb
+- test/data/application.ini
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: ZFIniFile
+test_files: []
+has_rdoc: