yip 0.8.2

data/CHANGES

@@ -0,0 +1,13 @@
+= Version 0.8
+
+Initial release
+
+= Version 0.8.1
+
+Bugfix release.
+
+= Version 0.8.2
+
+Repackaging, extra documentation & examples
+
+Renamed YAML::load_and_interpolate to YAML::interpolate

data/README

@@ -0,0 +1,58 @@
+INSTALLATION
+
+	 sudo ruby install.rb
+
+LICENSE
+
+(c) 2003-2004 Bruce Williams <wbruce@gmail.com>
+
+Free software; modify and redistribute it under 
+the same terms as Ruby itself
+
+ABOUT
+
+yip is a library which adds interpolation to whytheluckystiff's
+(http://whytheluckystiff.net) YAML implementation, Syck (included with Ruby 1.8).
+
+This library is designed primarily for use in configuration
+files, but may be useful elsewhere.
+
+HOW TO USE IT
+
+yip uses YPATHs to find nodes referenced for interpolation.  See
+http://yaml.freepan.org/index.cgi?YpathBrainstorm for more
+information on YPATH.
+
+Here's a small example:
+
+---
+author: Bruce Williams
+message: %author% wrote this.
+
+=> { 'author' => 'Bruce Williams', 'message' => 'Bruce Williams
+wrote this.' }
+
+Simple interpolation is done using %YPATH% notation, as is done
+above. You can also use a sprintf variant:
+
+  ---
+  author: Bruce Williams
+  version: 0.8
+  message: >
+    %author% says, "Here's the version with two extra zeros %(version)1.3f"
+
+The sprintf notation is the standard notation %1.3f, but the
+YPATH is included in parenthesis after the '%'.  This may look
+eerily familiar to people with Python experience.
+
+Note: In the event a YPATH resolves to a complex datatype, the data is
+interpolated as YAML (without the document separator).
+
+Take a look at the examples/ subdirectory for additional examples.
+
+TODO
+
+YAML::INTERPOLATION_PATTERN
+  I'd like to spruce up the sprintf-matching part of the Regexp
+  before releasing v1.0; at the moment it's a hack.
+

data/examples/example1.yml

@@ -0,0 +1,6 @@
+---
+# An example configuration file using yip
+arch: i686
+optimize: 3
+cflags: &cf -O%optimize% -mcpu=%arch% -funroll-loops -pipe
+cxxflags: *cf

data/examples/example2.yml

@@ -0,0 +1,15 @@
+---
+project: yip; YAML/YPATH Interpolation
+author:
+  name: Bruce Williams
+  email:
+    - wbruce@gmail.com
+    - bruce@codedbliss.com
+version: 0.8.2
+description: |
+  %project% v%version% by %author/name%
+  Feel free to contact the author at one of the following
+  e-mail addresses for support:
+  %(author/email/0)20s  primary
+  %(author/email/1)20s  secondary
+

data/lib/yip.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+# yip; YAML + YPATH Interpolation
+#
+# (c) 2003-2004 Bruce Williams <wbruce@gmail.com>
+# Free software; modify and redistribute it under 
+# the same terms as Ruby itself
+#
+
+module YAML
+
+  INTERPOLATION_PATTERN = /(%\((.+?)\)([^[:alpha:]]*[[:alpha:]]+)\b|%(.+?)%)/
+
+  # For circular YPATH references
+  class RecursiveInterpolationError < Exception; end
+
+  # For the attempted interpolation of nodes that don't exist
+  class MissingInterpolationError < Exception; end
+
+  # Interpolation method
+  # * Works similar to YAML::load
+  #
+  # Interpolation of values occurs within all YAML strings.
+  # Interpolation is done using one of two formats:
+  #
+  #   %<YPATH ADDRESS>%
+  #   %(<YPATH ADDRESS>)<Kernel::printf FORMAT STRING>
+  #
+  # Examples:
+  #
+  #  %general/server description%
+  #  %(general/server description)10s
+  #
+  # For more examples, see examples/
+  #
+  # Note: YPATH addresses that resolve to collections
+  #       interpolate as YAML (sans document separator)
+  #
+  # Resources: http://yaml.freepan.org/index.cgi?YpathBrainstorm
+  def YAML::interpolate( data )
+    # get the node tree
+    nodes = YAML::parse( data )
+    # give the DefaultLoader access to the node tree
+    YAML::Syck::DefaultLoader.instance_eval{ @nodes = nodes }
+    # do the deed
+    nodes.transform
+  rescue SystemStackError
+    raise YAML::RecursiveInterpolationError::new( "Circular YPATH references found; could not interpolate" )
+  end
+
+
+  module Syck
+      
+    class Loader
+    
+      alias_method :old_transfer, :transfer
+
+      # A redefinition of Syck::Loader#transfer to allow
+      # for interpolation of nodes
+      def transfer( yaml_type, value )
+        new_value = value.dup
+        # If a node tree has been given (second pass), and it's a string, interpolate
+        if @nodes and yaml_type =~ /str$/
+          value.scan(YAML::INTERPOLATION_PATTERN) do |field,sprintf_ypath,sprintf_format,plain_ypath|
+            ypath = sprintf_ypath || plain_ypath
+            format = "%#{sprintf_format || 's'}"
+            results = @nodes.select!( ypath )
+            replace = /#{Regexp::escape field}/
+            case results[0]
+              when nil
+                raise YAML::MissingInterpolationError::new( "Could not find any nodes matching YPATH '#{ypath}'" )
+              when String
+                new_value.gsub!( replace, format % results[0].to_s )
+              when Numeric
+                new_value.gsub!( replace, format % results[0].to_s )
+            else
+                new_value.gsub!( replace, format % results[0].to_yaml.sub(/^---\s*/, "\n") )
+            end
+          end
+        end
+        old_transfer( yaml_type, new_value )
+      end
+      
+    end
+    
+  end
+  
+end
+
+if $0 == __FILE__ and File::exists?( ARGV[0].to_s )
+  data = File::read ARGV[0]
+   puts YAML::interpolate( data ).to_yaml
+end

data/tests/test_yip.rb

@@ -0,0 +1,39 @@
+require 'test/unit'
+require 'yaml'
+
+$: << File::join(File::dirname(__FILE__),'../lib')
+require 'yip'
+
+class TestYIP < Test::Unit::TestCase
+
+  YML_SERVER = YAML::interpolate(<<EOY)
+---
+server:
+  port: 2020
+  host: localhost
+motd: the host is %server/host%
+full_motd: the server is %server%
+port5: %(server/port)05d
+bad_port5: %(server/port)05d%
+EOY
+  
+  def test_plain
+    assert_equal(
+                 YAML::interpolate("---\na: ok\nb: %a%"),
+                 {'a'=>'ok','b'=>'ok'} )
+    assert_equal( YML_SERVER['motd'], "the host is localhost" )
+  end
+
+  def test_sprintf
+    assert_equal( YML_SERVER['port5'], '02020',
+                  "sprintf-style behavior (w/ digit interpolation) failed")
+    assert_not_equal( YML_SERVER['bad_port5'], '02020',
+                  "sprintf-style w/ trailing '%' behavior failed" )
+  end
+
+  def test_sequence
+    assert_equal(YML_SERVER['full_motd'], "the server is \nport: 2020\nhost: localhost",
+                 "Interpolation of sequences behavior failed")
+  end
+
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.1
+specification_version: 1
+name: yip
+version: !ruby/object:Gem::Version 
+  version: 0.8.2
+date: 2004-10-02
+summary: Adds interpolation to YAML; primarily for use in configuration files
+require_paths: 
+  - lib
+author: Bruce Williams
+email: wbruce@gmail.com
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: yip
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+  version: 
+platform: ruby
+files: 
+  - lib/yip.rb
+  - examples/example1.yml
+  - examples/example2.yml
+  - examples/examples
+  - tests/test_yip.rb
+  - README
+  - CHANGES
+test_files: 
+  - tests/test_yip.rb
+rdoc_options: []
+extra_rdoc_files: 
+  - README
+  - CHANGES
+executables: []
+extensions: []
+requirements: []
+dependencies: []