@@ -1,4 +1,4 @@ -== 0.0.1 2008-11-05 +== 1.0.0 2008-11-28 * 1 major enhancement: * Initial release History.txt @@ -2,6 +2,7 @@ History.txt Manifest.txt PostInstall.txt README.rdoc +State_Design_Pattern_UML_Class_Diagram.png Rakefile TODO assertions.rb Manifest.txt @@ -1,6 +1,6 @@ -= states += AlterEgo -* FIX (url) +* http://alter-ego.rubyforge.org == DESCRIPTION: @@ -92,7 +92,7 @@ behavior. This file only scratches the surface of AlterEgo functionality. For complete tutorial documentation, see the file -spec/states_spec.rb. It contains the annotated specification, +spec/alter_ego_spec.rb. It contains the annotated specification, written in the style of a step-by-step tutorial. === Terminology: @@ -121,7 +121,7 @@ written in the style of a step-by-step tutorial. == INSTALL: -* sudo gem install states +* sudo gem install alter-ego == LICENSE: README.rdoc @@ -6,7 +6,6 @@ require File.dirname(__FILE__) + '/lib/alter_ego' $hoe = Hoe.new('alter-ego', AlterEgo::VERSION) do |p| p.developer('Avdi Grimm', 'avdi@avdi.org') p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n") - p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required p.rubyforge_name = p.name # TODO this is default value # p.extra_deps = [ # ['activesupport','>= 2.0.2'], Rakefile @@ -1,11 +1,102 @@ -<html> - <head> - <meta http-equiv="Content-type" content="text/html; charset=utf-8"> - <title>alter-ego</title> - - </head> - <body id="body"> - This page has not yet been created for RubyGem <code>alter-ego</code> - To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file. - </body> -</html> \ No newline at end of file +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" +"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" /> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title> + alter ego + </title> + <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script> +<style> + +</style> + <script type="text/javascript"> + window.onload = function() { + settings = { + tl: { radius: 10 }, + tr: { radius: 10 }, + bl: { radius: 10 }, + br: { radius: 10 }, + antiAlias: true, + autoPad: true, + validTags: ["div"] + } + var versionBox = new curvyCorners(settings, document.getElementById("version")); + versionBox.applyCornersToAll(); + } + </script> +</head> +<body> +<div id="main"> + + <h1>alter ego</h1> + <div class="sidebar"> + <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/alter-ego"; return false'> + Get Version + <a href="http://rubyforge.org/projects/alter-ego" class="numbers">1.0.0</a> + </div> + </div> + <h2>What</h2> +AlterEgo is a Ruby implementation of the <a href="http://en.wikipedia.org/wiki/State_pattern">State pattern</a> as described by the Gang of Four. It differs from other Ruby state machine libraries in that it focuses on providing polymorphic behavior based on object state. In effect, it makes it easy to give an object different “personalities” depending on the state it is in. +<h2>Installing</h2> +<pre class='syntax'>sudo gem install alter-ego</pre> +<h2>Rationale</h2> +Sometimes you want a single object to behave differently depending on what state it’s in. For instance, a traffic light has a different color depending on whether it is informing people that they should stop, slow down, or proceed. Or a user account object might behave differently depending on whether the account is in the “confirmed” state. AlterEgo can help you set up these state-based object “personalities”. +AlterEgo will help you to define a set of valid states for your objects, and to define the allowable transitions between states. The real strength of AlterEgo, however, is in defining separate behaviors for each state that the object is in. Underneath the covers, AlterEgo will arrange for your object to delegate to a different state object depending on what state it is in. You can either explicitly define these state objects as classes, or use a concise DSL provided by AlterEgo. +<h2>Synopsis</h2> +<pre class='syntax'> + class TrafficLight + include AlterEgo + + state :proceed, :default => true do + handle :color do + "green" + end + transition :to => :caution, :on => :cycle! + end + + state :caution do + handle :color do + "yellow" + end + transition :to => :stop, :on => :cycle! + end + + state :stop do + handle :color do + "red" + end + transition :to => :proceed, :on => :cycle! + end + end + + light = TrafficLight.new + light.color # => "green" + light.cycle! + light.color # => "yellow" + light.cycle! + light.color # => "red" + light.cycle! + light.color # => "green" +</pre> +<h2>Documentation</h2> +See the project’s <a href="http://alter-ego.rubyforge.org/rdoc/">RDoc</a> +<h2>Development</h2> +You can fetch the source from RubyForge using Git: +<a href="http://rubyforge.org/scm/?group_id=7389">http://rubyforge.org/scm/?group_id=7389</a> +<pre>git clone git://rubyforge.org/alter-ego.git</pre> +<h2>License</h2> +This code is free to use under the terms of the MIT license. +<h2>Contact</h2> +Questions, comments, suggestions: Email <a href="mailto:avdi@avdi.org">Avdi Grimm</a> + + <a href="mailto:avdi@avdi.org">Avdi Grimm</a>, 28th November 2008 + Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> + +</div> + + + +</body> +</html> website/index.html @@ -1,41 +1,68 @@ h1. alter ego - h2. What +AlterEgo is a Ruby implementation of the "State pattern":http://en.wikipedia.org/wiki/State_pattern as described by the Gang of Four. It differs from other Ruby state machine libraries in that it focuses on providing polymorphic behavior based on object state. In effect, it makes it easy to give an object different "personalities" depending on the state it is in. h2. Installing <pre syntax="ruby">sudo gem install alter-ego</pre> -h2. The basics - +h2. Rationale -h2. Demonstration of usage +Sometimes you want a single object to behave differently depending on what state it's in. For instance, a traffic light has a different color depending on whether it is informing people that they should stop, slow down, or proceed. Or a user account object might behave differently depending on whether the account is in the "confirmed" state. AlterEgo can help you set up these state-based object "personalities". +AlterEgo will help you to define a set of valid states for your objects, and to define the allowable transitions between states. The real strength of AlterEgo, however, is in defining separate behaviors for each state that the object is in. Underneath the covers, AlterEgo will arrange for your object to delegate to a different state object depending on what state it is in. You can either explicitly define these state objects as classes, or use a concise DSL provided by AlterEgo. +h2. Synopsis -h2. Forum +<pre syntax="ruby"> + class TrafficLight + include AlterEgo -"http://groups.google.com/group/alter-ego":http://groups.google.com/group/alter-ego + state :proceed, :default => true do + handle :color do + "green" + end + transition :to => :caution, :on => :cycle! + end -TODO - create Google Group - alter-ego + state :caution do + handle :color do + "yellow" + end + transition :to => :stop, :on => :cycle! + end -h2. How to submit patches + state :stop do + handle :color do + "red" + end + transition :to => :proceed, :on => :cycle! + end + end -Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above. + light = TrafficLight.new + light.color # => "green" + light.cycle! + light.color # => "yellow" + light.cycle! + light.color # => "red" + light.cycle! + light.color # => "green" +</pre> -TODO - pick SVN or Git instructions +h2. Documentation -The trunk repository is <code>svn://rubyforge.org/var/svn/alter-ego/trunk</code> for anonymous access. +See the project's "RDoc":http://alter-ego.rubyforge.org/rdoc/ -OOOORRRR +h2. Development -You can fetch the source from either: +You can fetch the source from RubyForge using Git: <% if rubyforge_project_id %> -* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %> +"http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %> <pre>git clone git://rubyforge.org/alter-ego.git</pre> @@ -52,30 +79,11 @@ Or you can hack website/index.txt and make it all go away!! <% end %> -* github: "http://github.com/GITHUB_USERNAME/alter-ego/tree/master":http://github.com/GITHUB_USERNAME/alter-ego/tree/master - -<pre>git clone git://github.com/GITHUB_USERNAME/alter-ego.git</pre> - - -TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects. - - -* gitorious: "git://gitorious.org/alter-ego/mainline.git":git://gitorious.org/alter-ego/mainline.git - -<pre>git clone git://gitorious.org/alter-ego/mainline.git</pre> - -h3. Build and test instructions - -<pre>cd alter-ego -rake test -rake install_gem</pre> - - h2. License This code is free to use under the terms of the MIT license. h2. Contact -Comments are welcome. Send an email to "TODO":mailto:TODO via the "forum":http://groups.google.com/group/alter-ego +Questions, comments, suggestions: Email "Avdi Grimm":mailto:avdi@avdi.org website/index.txt @@ -39,7 +39,7 @@ </div> <%= body %> - <a href="TODO">TODO</a>, <%= modified.pretty %> + <a href="mailto:avdi@avdi.org">Avdi Grimm</a>, <%= modified.pretty %> Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> </div> website/template.html.erb 63c2730d343b06cad1322040205bd22ddb32e96e Avdi Grimm avdi@avdi.org http://github.com/avdi/alter-ego/commit/9114859a49f4358aab2d5809acb305348ec41dee 9114859a49f4358aab2d5809acb305348ec41dee

2008-11-28T08:11:23-08:00

Updated website 2bf38dc069def0818bae416baba67c9e1f289c66 Avdi Grimm avdi@avdi.org