pythonconfig 1.0.0

data/History.txt

@@ -0,0 +1,7 @@
+=== 1.0.0 / 2009-03-28
+
+* First release
+
+  * Multiple sections are parsed
+  * Interpolation using %(key) supported
+  * Multiline values supported

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/pythonconfig
+lib/pythonconfig.rb
+test/test_pythonconfig.rb

data/README.txt

@@ -0,0 +1,95 @@
+= pythonconfig
+
+* http://www.carboni.ca/
+
+== DESCRIPTION:
+
+Class for parsing and writing Python configuration files created by the
+ConfigParser classes in Python. These files are structured like this:
+   [Section Name]
+   key = value
+   otherkey: othervalue
+   
+   [Other Section]
+   key: value3
+   otherkey = value4
+
+Leading whitespace before values are trimmed, and the key must be the at the
+start of the line - no leading whitespace there. You can use : or = .
+
+Multiline values are supported, as long as the second (or third, etc.) lines
+start with whitespace:
+
+   [Section]
+   bigstring: This is a very long string, so I'm not sure I'll be
+     able to fit it on one line, but as long as
+    there is one space before each line, I'm ok. Tabs work too.
+
+Also, this class supports interpolation:
+   [Awards]
+   output: Congratulations for winning %(prize)!
+   prize: the lottery
+Will result in:
+   config.sections["Awards"]["output"] == "Congratulations for winning the lottery!"
+
+You can also access the sections with the dot operator, but only with all-lowercase:
+   [Awards]
+   key:value
+   [prizes]
+   lottery=3.2 million
+
+   config.awards["key"] #=> "value"
+   config.prizes["lottery"] #=> "3.2 million" 
+
+You can modify any values you want, though to add sections, you should use the add_section
+method.
+   config.sections["prizes"]["lottery"] = "100 dollars" # someone hit the jackpot
+   config.add_section("Candies")
+   config.candies["green"] = "tasty"
+When you want to output a configuration, just call its +to_s+ method.
+   File.open("output.ini","w") do |out|
+     out.write config.to_s
+   end
+
+== FEATURES/PROBLEMS:
+
+* Multiple sections are parsed
+* Interpolation using %(key) supported
+* Multiline values supported
+
+== SYNOPSIS:
+
+See the Description.
+
+== REQUIREMENTS:
+
+* none
+
+== INSTALL:
+
+* sudo gem install pythonconfig
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIX
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/pythonconfig.rb'
+
+Hoe.new('pythonconfig', PythonConfig::VERSION) do |p|
+  # p.rubyforge_name = 'pythonconfigx' # if different than lowercase project name
+  p.developer('FIX', 'FIX@example.com')
+end
+
+# vim: syntax=Ruby

data/bin/pythonconfig

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/lib/pythonconfig.rb

@@ -0,0 +1,156 @@
+require 'delegate'
+# = PythonConfig
+# Class for parsing and writing Python configuration files created by the
+# ConfigParser classes in Python. These files are structured like this:
+#    [Section Name]
+#    key = value
+#    otherkey: othervalue
+#    
+#    [Other Section]
+#    key: value3
+#    otherkey = value4
+#
+# Leading whitespace before values are trimmed, and the key must be the at the
+# start of the line - no leading whitespace there. You can use : or = .
+#
+# Multiline values are supported, as long as the second (or third, etc.) lines
+# start with whitespace:
+#
+#    [Section]
+#    bigstring: This is a very long string, so I'm not sure I'll be
+#      able to fit it on one line, but as long as
+#     there is one space before each line, I'm ok. Tabs work too.
+#
+# Also, this class supports interpolation:
+#    [Awards]
+#    output: Congratulations for winning %(prize)!
+#    prize: the lottery
+# Will result in:
+#    config.sections["Awards"]["output"] == "Congratulations for winning the lottery!"
+#
+# You can also access the sections with the dot operator, but only with all-lowercase:
+#    [Awards]
+#    key:value
+#    [prizes]
+#    lottery=3.2 million
+#
+#    config.awards["key"] #=> "value"
+#    config.prizes["lottery"] #=> "3.2 million" 
+# 
+# You can modify any values you want, though to add sections, you should use the add_section
+# method.
+#    config.sections["prizes"]["lottery"] = "100 dollars" # someone hit the jackpot
+#    config.add_section("Candies")
+#    config.candies["green"] = "tasty"
+# When you want to output a configuration, just call its +to_s+ method.
+#    File.open("output.ini","w") do |out|
+#      out.write config.to_s
+#    end
+module PythonConfig
+  VERSION = '1.0.0'
+  MAX_INTERPOLATION_DEPTH = 200
+  # Don't make recursive interpolating values!
+  class InterpolationTooDeepError < StandardError; end
+  # This is the main class that handles configurations. You parse, modify, and output
+  # through this class. See the README for tons of examples.
+  class ConfigParser
+    attr_reader :sections
+    
+    SECTION_REGEXP = /\[([^\[\]]*)\]/
+    ASSIGNMENT_REGEXP = /([^:=\s]+)\s*[:=]\s*([^\n]*?)$/
+    LONG_HEADER_REGEXP = /^([ \t]+)([^\n]+)$/
+    # Creates a new ConfigParser. If +io+ is provided, the configuraiton file is read
+    # from the io.
+    def initialize(io = nil)
+      @sections = {}
+      io.each do |line|
+        parse_line line
+      end unless io.nil?
+    end
+    
+    def parse_line line #:nodoc:
+    
+      if line =~ SECTION_REGEXP
+        section_name = $1
+        @cursection = add_section section_name
+      elsif line =~ ASSIGNMENT_REGEXP
+        @cursection[$1] = $2
+        @cur_assignment = $1
+      elsif line =~ LONG_HEADER_REGEXP
+        @cursection[@cur_assignment] += " " + $2
+      end
+    end
+    
+    # Returns the names of all the sections, which can be used for keys into the sections
+    def section_names
+      @sections.keys
+    end
+    
+    # Creates a new section, with the values as provided by the (optional) values parameter
+    def add_section(section_name, values={})
+      newsection = ConfigSection.new(values)
+      @sections[section_name] = newsection
+      self.instance_eval %Q{
+        def #{section_name.downcase}
+          @sections["#{section_name}"]
+        end
+      }
+      newsection
+    end
+    
+    # Returns the section given by +section+
+    def [](section)
+      @sections[section]
+    end
+    
+    # Returns the configuration as a string that can be output to a file. Does not perform
+    # interpolation before writing.
+    def to_s
+      output = ""
+      @sections.each do |k,v|
+        output << "[#{k}]\n"
+        output << v.to_s
+      end
+      output
+    end
+        
+  end
+  # = ConfigSection
+  # This is a simple section in a config document - treat it exactly like a hash,
+  # whose keys are the keys in the config, and whose value are the values in the config.
+  #
+  # This is a separate class entirely because it has to handle the magical interpolation
+  # that allows this ini file:
+  #    [Awards]
+  #    output: Congratulations for winning %(prize)!
+  #    prize: the lottery
+  # To result in:
+  #    config.sections["Awards"]["output"] == "Congratulations for winning the lottery!"
+  #
+  class ConfigSection < DelegateClass(Hash)
+    def initialize(source)
+      @source_hash = source
+      super(@source_hash)
+    end
+    def [](key) #:nodoc:
+      str = @source_hash[key]
+      interpolate(str)
+    end
+    
+    def interpolate(str, cur_depth=0) #:nodoc:
+      raise InterpolationTooDeepError.new("Interpolation too deep!") if cur_depth > PythonConfig::MAX_INTERPOLATION_DEPTH
+      nextval = str
+      nextval = str.gsub(/\%\((.*)\)/,@source_hash[$1]) if str =~ /%\((.*)\)/
+      nextval = interpolate(nextval,cur_depth+1) if nextval =~ /%\((.*)\)/
+      nextval
+    end
+    
+    def to_s #:nodoc:
+      output = ""
+      @source_hash.each do |k,v|
+        output << "#{k} = #{v.gsub(/\n/,"\n ")}" << "\n"
+      end
+      output
+    end
+  end
+end

data/test/test_pythonconfig.rb

@@ -0,0 +1,82 @@
+require "test/unit"
+require "pythonconfig"
+
+class TestConfigParser < Test::Unit::TestCase
+  include PythonConfig
+  def test_sections
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    assert_equal(["cool_section", "evil", "other_stuff"],cfg.sections.keys.sort)
+  end
+  
+  def test_basic_assignments
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    assert_equal("true",cfg.sections["cool_section"]["lame"])
+    assert_equal("8.7",cfg.sections["other_stuff"]["sweetness"])
+    assert_equal("false",cfg.sections["cool_section"]["cool"])
+  end
+  
+  def test_multiline
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    assert_equal("super good stuff that i bet you didn't think was possible did you now?", cfg.sections["cool_section"]["multiline"])
+  end
+  
+  def test_dot_accessor
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    assert_equal(cfg.sections["cool_section"], cfg.cool_section)
+  end
+  
+  def test_array_accessor
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    assert_equal(cfg.sections["cool_section"], cfg["cool_section"])
+  end
+  
+  def test_allow_empty
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    assert_equal("", cfg.sections["cool_section"]["empty"])
+  end
+  
+  def test_interpolation
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    assert_equal("your sweetness is 8.7!", cfg.sections["other_stuff"]["output"])
+  end
+  
+  def test_interpolation_recursion_exception
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    assert_raises InterpolationTooDeepError do
+      cfg.sections["evil"]["firstone"]
+    end
+  end
+  
+  def test_add_section
+    cfg = nil
+    File.open(File.join(File.dirname(__FILE__),"inputfile.ini"), "r") do |inp|
+      cfg = ConfigParser.new(inp)
+    end
+    cfg.add_section "new_section"
+    assert_equal(["cool_section", "evil","new_section", "other_stuff"],cfg.sections.keys.sort)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: pythonconfig
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- FIX
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+    version: 
+description: "Class for parsing and writing Python configuration files created by the ConfigParser classes in Python. These files are structured like this: [Section Name] key = value otherkey: othervalue  [Other Section] key: value3 otherkey = value4  Leading whitespace before values are trimmed, and the key must be the at the start of the line - no leading whitespace there. You can use : or = .  Multiline values are supported, as long as the second (or third, etc.) lines start with whitespace:  [Section] bigstring: This is a very long string, so I'm not sure I'll be able to fit it on one line, but as long as there is one space before each line, I'm ok. Tabs work too.  Also, this class supports interpolation: [Awards] output: Congratulations for winning %(prize)! prize: the lottery Will result in: config.sections[\"Awards\"][\"output\"] == \"Congratulations for winning the lottery!\"  You can also access the sections with the dot operator, but only with all-lowercase: [Awards] key:value [prizes] lottery=3.2 million  config.awards[\"key\"] #=> \"value\" config.prizes[\"lottery\"] #=> \"3.2 million\"   You can modify any values you want, though to add sections, you should use the add_section method. config.sections[\"prizes\"][\"lottery\"] = \"100 dollars\" # someone hit the jackpot config.add_section(\"Candies\") config.candies[\"green\"] = \"tasty\" When you want to output a configuration, just call its +to_s+ method. File.open(\"output.ini\",\"w\") do |out| out.write config.to_s end"
+email: 
+- FIX@example.com
+executables: 
+- pythonconfig
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/pythonconfig
+- lib/pythonconfig.rb
+- test/test_pythonconfig.rb
+has_rdoc: true
+homepage: http://www.carboni.ca/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: pythonconfig
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Class for parsing and writing Python configuration files created by the ConfigParser classes in Python
+test_files: 
+- test/test_pythonconfig.rb