= RubyCLR -- Ruby to CLR Bridge

Supporting: RubyCLR Drop 4

This package contains RubyCLR, a Ruby to CLR interop layer that enables seamless integration of Ruby and .NET objects in the same Win32 process.

New features in Drop 4:

• Experimental integration of Rails ActiveRecord with seamless data binding support
• Extensive data binding support with two-way data binding of Ruby Structs and Arrays of Structs
• Support for implementing non-generic CLR interfaces in Ruby
• Inlining of C#, VB.NET and JScript.NET code in Ruby programs
• Many bug fixes related to boxing and unboxing of value types

Features from Drop 3:

• Reference .NET assemblies by assembly name or by filename
• Create and manipulate .NET reference and value types
• Automatically marshal .NET reference and value types to / from Ruby
• Dynamic generation of interop code using CIL instructions
• Create and manipulate generic .NET reference types
• Discover and consume .NET interfaces on a .NET object
• Implement .NET event handlers using Ruby blocks
• Map .NET member names to Ruby names (e.g. WordCount becomes word_count)
• Mix in Ruby Enumerable support for .NET IEnumerable types
• Dynamically access .NET XML documentation from irb (requires text/format - to make it work uncomment require in rubyclr.rb)

== Download

The latest version of RubyCLR can be found at http://www.rubyclr.com/

== Installation

This drop requires setting the RUBY_LIB environment variable. You must run setup.cmd in the top project directory of RubyCLR to correctly setup this environment variable. Future versions will be gem-ified for a better user experience.

=== Running the Rake Test Suite

If you wish to run the unit and functional tests that come with RubyCLR:

• CD to the top project directory of RubyCLR and type:

  rake tests

=== Seeing project statistics

If you want to see the project statistics (# non-blank lines) broken out by category, CD to the top project directory of RubyCLR and type:

rake stats

== Samples

The RSS Reader sample has been extensively updated in this release to demonstrate integrating a user interface that was created in Visual Studio with code written in Ruby. The UI is compiled and referenced from Ruby - the only real change is making all of the control properties public to support the experimental containment model. This is likely to change in the near future, but it works right now.

== Online Resources

http://www.rubyclr.com is the home for all things RubyCLR.

See John Lam's blog at http://www.iunknown.com to follow the progress of RubyCLR. The RSS feed can be found at http://feeds.feedburner.com/LessIsBetter/.

== Road Map

The next release of RubyCLR will be Beta 1.

== Credits

A big thanks to the members of the RubyCLR community for your support and encouragement in the early stages of this project. Thanks to Gertjan Schuuurmans, Mark Miller, Justin Bailey, Thibaut Barrere, Valentin Iliescu, Scott Hanselman, Mahesh Prakriya, and Gunter Szoldaris for contributing code, patches, users and ideas.

== License

RubyCLR is available under an MIT-style license.

:include: MIT-LICENSE.TXT

= Administrivia

Author:: John Lam [email protected] Requires:: Ruby 1.8.2 (others have been using 1.8.4, without any reported problems but development is done on 1.8.2 today) .NET Framework 2.0 WinFX Beta2 only if you want to run the WPF samples text-format gem for Type.help feature (disabled by default) License:: Copyright 2005, 2006 by John Lam. Released under an MIT-style license. See the MIT-LICENSE.TXT file included in the distribution.