Skip to content

Commit e5c0dcd

Browse files
obrieobrie
committed
Simplify YARD integration by using state_machine itself to manage parsed states / events / transitions
Fix 'same' loopback matcher not being handled properly Fix NilClass possibly being used for return types of state methods Don't document methods that get inherited; only those that are generated Don't document states / events that are inherited from parent machines
1 parent ff2799b commit e5c0dcd

16 files changed

Lines changed: 446 additions & 1793 deletions

File tree

‎examples/doc/AutoShop.html‎

Lines changed: 57 additions & 409 deletions
Large diffs are not rendered by default.

‎examples/doc/Car.html‎

Lines changed: 16 additions & 18 deletions
Large diffs are not rendered by default.

‎examples/doc/TrafficLight.html‎

Lines changed: 44 additions & 370 deletions
Large diffs are not rendered by default.

‎examples/doc/Vehicle.html‎

Lines changed: 122 additions & 608 deletions
Large diffs are not rendered by default.

‎examples/doc/_index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h2>Namespace Listing A-Z</h2>
127127
</div>
128128

129129
<div id="footer">
130-
Generated on Sun Feb 12 22:47:09 2012 by
130+
Generated on Tue Feb 14 08:03:02 2012 by
131131
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
132132
0.7.5 (ruby-1.9.2).
133133
</div>

‎examples/doc/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h2>Namespace Listing A-Z</h2>
127127
</div>
128128

129129
<div id="footer">
130-
Generated on Sun Feb 12 22:47:09 2012 by
130+
Generated on Tue Feb 14 08:03:02 2012 by
131131
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
132132
0.7.5 (ruby-1.9.2).
133133
</div>

‎examples/doc/method_list.html‎

Lines changed: 44 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -208,54 +208,6 @@ <h1 id="full_list_header">Method List</h1>
208208
</li>
209209

210210

211-
<li class="r2 ">
212-
<span class='object_link'><a href="Vehicle.html#fire_events-instance_method" title="Vehicle#fire_events (method)">#fire_events</a></span>
213-
214-
<small>Vehicle</small>
215-
216-
</li>
217-
218-
219-
<li class="r1 ">
220-
<span class='object_link'><a href="TrafficLight.html#fire_events-instance_method" title="TrafficLight#fire_events (method)">#fire_events</a></span>
221-
222-
<small>TrafficLight</small>
223-
224-
</li>
225-
226-
227-
<li class="r2 ">
228-
<span class='object_link'><a href="AutoShop.html#fire_events-instance_method" title="AutoShop#fire_events (method)">#fire_events</a></span>
229-
230-
<small>AutoShop</small>
231-
232-
</li>
233-
234-
235-
<li class="r1 ">
236-
<span class='object_link'><a href="AutoShop.html#fire_events%21-instance_method" title="AutoShop#fire_events! (method)">#fire_events!</a></span>
237-
238-
<small>AutoShop</small>
239-
240-
</li>
241-
242-
243-
<li class="r2 ">
244-
<span class='object_link'><a href="Vehicle.html#fire_events%21-instance_method" title="Vehicle#fire_events! (method)">#fire_events!</a></span>
245-
246-
<small>Vehicle</small>
247-
248-
</li>
249-
250-
251-
<li class="r1 ">
252-
<span class='object_link'><a href="TrafficLight.html#fire_events%21-instance_method" title="TrafficLight#fire_events! (method)">#fire_events!</a></span>
253-
254-
<small>TrafficLight</small>
255-
256-
</li>
257-
258-
259211
<li class="r2 ">
260212
<span class='object_link'><a href="AutoShop.html#fire_state_event-instance_method" title="AutoShop#fire_state_event (method)">#fire_state_event</a></span>
261213

@@ -321,49 +273,49 @@ <h1 id="full_list_header">Method List</h1>
321273

322274

323275
<li class="r2 ">
324-
<span class='object_link'><a href="AutoShop.html#human_state_event_name-class_method" title="AutoShop.human_state_event_name (method)">human_state_event_name</a></span>
276+
<span class='object_link'><a href="TrafficLight.html#human_state_event_name-class_method" title="TrafficLight.human_state_event_name (method)">human_state_event_name</a></span>
325277

326-
<small>AutoShop</small>
278+
<small>TrafficLight</small>
327279

328280
</li>
329281

330282

331283
<li class="r1 ">
332-
<span class='object_link'><a href="TrafficLight.html#human_state_event_name-class_method" title="TrafficLight.human_state_event_name (method)">human_state_event_name</a></span>
284+
<span class='object_link'><a href="AutoShop.html#human_state_event_name-class_method" title="AutoShop.human_state_event_name (method)">human_state_event_name</a></span>
333285

334-
<small>TrafficLight</small>
286+
<small>AutoShop</small>
335287

336288
</li>
337289

338290

339291
<li class="r2 ">
340-
<span class='object_link'><a href="AutoShop.html#human_state_name-class_method" title="AutoShop.human_state_name (method)">human_state_name</a></span>
292+
<span class='object_link'><a href="Vehicle.html#human_state_name-class_method" title="Vehicle.human_state_name (method)">human_state_name</a></span>
341293

342-
<small>AutoShop</small>
294+
<small>Vehicle</small>
343295

344296
</li>
345297

346298

347299
<li class="r1 ">
348-
<span class='object_link'><a href="TrafficLight.html#human_state_name-instance_method" title="TrafficLight#human_state_name (method)">#human_state_name</a></span>
300+
<span class='object_link'><a href="Vehicle.html#human_state_name-instance_method" title="Vehicle#human_state_name (method)">#human_state_name</a></span>
349301

350-
<small>TrafficLight</small>
302+
<small>Vehicle</small>
351303

352304
</li>
353305

354306

355307
<li class="r2 ">
356-
<span class='object_link'><a href="Vehicle.html#human_state_name-instance_method" title="Vehicle#human_state_name (method)">#human_state_name</a></span>
308+
<span class='object_link'><a href="TrafficLight.html#human_state_name-instance_method" title="TrafficLight#human_state_name (method)">#human_state_name</a></span>
357309

358-
<small>Vehicle</small>
310+
<small>TrafficLight</small>
359311

360312
</li>
361313

362314

363315
<li class="r1 ">
364-
<span class='object_link'><a href="Vehicle.html#human_state_name-class_method" title="Vehicle.human_state_name (method)">human_state_name</a></span>
316+
<span class='object_link'><a href="TrafficLight.html#human_state_name-class_method" title="TrafficLight.human_state_name (method)">human_state_name</a></span>
365317

366-
<small>Vehicle</small>
318+
<small>TrafficLight</small>
367319

368320
</li>
369321

@@ -377,9 +329,9 @@ <h1 id="full_list_header">Method List</h1>
377329

378330

379331
<li class="r1 ">
380-
<span class='object_link'><a href="TrafficLight.html#human_state_name-class_method" title="TrafficLight.human_state_name (method)">human_state_name</a></span>
332+
<span class='object_link'><a href="AutoShop.html#human_state_name-class_method" title="AutoShop.human_state_name (method)">human_state_name</a></span>
381333

382-
<small>TrafficLight</small>
334+
<small>AutoShop</small>
383335

384336
</li>
385337

@@ -593,9 +545,9 @@ <h1 id="full_list_header">Method List</h1>
593545

594546

595547
<li class="r2 ">
596-
<span class='object_link'><a href="Vehicle.html#state-instance_method" title="Vehicle#state (method)">#state</a></span>
548+
<span class='object_link'><a href="TrafficLight.html#state-instance_method" title="TrafficLight#state (method)">#state</a></span>
597549

598-
<small>Vehicle</small>
550+
<small>TrafficLight</small>
599551

600552
</li>
601553

@@ -609,29 +561,13 @@ <h1 id="full_list_header">Method List</h1>
609561

610562

611563
<li class="r2 ">
612-
<span class='object_link'><a href="TrafficLight.html#state-instance_method" title="TrafficLight#state (method)">#state</a></span>
613-
614-
<small>TrafficLight</small>
615-
616-
</li>
617-
618-
619-
<li class="r1 ">
620-
<span class='object_link'><a href="Vehicle.html#state%3D-instance_method" title="Vehicle#state= (method)">#state=</a></span>
564+
<span class='object_link'><a href="Vehicle.html#state-instance_method" title="Vehicle#state (method)">#state</a></span>
621565

622566
<small>Vehicle</small>
623567

624568
</li>
625569

626570

627-
<li class="r2 ">
628-
<span class='object_link'><a href="AutoShop.html#state%3D-instance_method" title="AutoShop#state= (method)">#state=</a></span>
629-
630-
<small>AutoShop</small>
631-
632-
</li>
633-
634-
635571
<li class="r1 ">
636572
<span class='object_link'><a href="TrafficLight.html#state%3D-instance_method" title="TrafficLight#state= (method)">#state=</a></span>
637573

@@ -641,15 +577,15 @@ <h1 id="full_list_header">Method List</h1>
641577

642578

643579
<li class="r2 ">
644-
<span class='object_link'><a href="TrafficLight.html#state%3F-instance_method" title="TrafficLight#state? (method)">#state?</a></span>
580+
<span class='object_link'><a href="AutoShop.html#state%3D-instance_method" title="AutoShop#state= (method)">#state=</a></span>
645581

646-
<small>TrafficLight</small>
582+
<small>AutoShop</small>
647583

648584
</li>
649585

650586

651587
<li class="r1 ">
652-
<span class='object_link'><a href="Vehicle.html#state%3F-instance_method" title="Vehicle#state? (method)">#state?</a></span>
588+
<span class='object_link'><a href="Vehicle.html#state%3D-instance_method" title="Vehicle#state= (method)">#state=</a></span>
653589

654590
<small>Vehicle</small>
655591

@@ -665,73 +601,73 @@ <h1 id="full_list_header">Method List</h1>
665601

666602

667603
<li class="r1 ">
668-
<span class='object_link'><a href="AutoShop.html#state_events-instance_method" title="AutoShop#state_events (method)">#state_events</a></span>
604+
<span class='object_link'><a href="TrafficLight.html#state%3F-instance_method" title="TrafficLight#state? (method)">#state?</a></span>
669605

670-
<small>AutoShop</small>
606+
<small>TrafficLight</small>
671607

672608
</li>
673609

674610

675611
<li class="r2 ">
676-
<span class='object_link'><a href="Vehicle.html#state_events-instance_method" title="Vehicle#state_events (method)">#state_events</a></span>
612+
<span class='object_link'><a href="Vehicle.html#state%3F-instance_method" title="Vehicle#state? (method)">#state?</a></span>
677613

678614
<small>Vehicle</small>
679615

680616
</li>
681617

682618

683619
<li class="r1 ">
684-
<span class='object_link'><a href="TrafficLight.html#state_events-instance_method" title="TrafficLight#state_events (method)">#state_events</a></span>
620+
<span class='object_link'><a href="AutoShop.html#state_events-instance_method" title="AutoShop#state_events (method)">#state_events</a></span>
685621

686-
<small>TrafficLight</small>
622+
<small>AutoShop</small>
687623

688624
</li>
689625

690626

691627
<li class="r2 ">
692-
<span class='object_link'><a href="AutoShop.html#state_machines-class_method" title="AutoShop.state_machines (method)">state_machines</a></span>
628+
<span class='object_link'><a href="TrafficLight.html#state_events-instance_method" title="TrafficLight#state_events (method)">#state_events</a></span>
693629

694-
<small>AutoShop</small>
630+
<small>TrafficLight</small>
695631

696632
</li>
697633

698634

699635
<li class="r1 ">
700-
<span class='object_link'><a href="TrafficLight.html#state_machines-class_method" title="TrafficLight.state_machines (method)">state_machines</a></span>
636+
<span class='object_link'><a href="Vehicle.html#state_events-instance_method" title="Vehicle#state_events (method)">#state_events</a></span>
701637

702-
<small>TrafficLight</small>
638+
<small>Vehicle</small>
703639

704640
</li>
705641

706642

707643
<li class="r2 ">
708-
<span class='object_link'><a href="Vehicle.html#state_machines-class_method" title="Vehicle.state_machines (method)">state_machines</a></span>
644+
<span class='object_link'><a href="AutoShop.html#state_name-instance_method" title="AutoShop#state_name (method)">#state_name</a></span>
709645

710-
<small>Vehicle</small>
646+
<small>AutoShop</small>
711647

712648
</li>
713649

714650

715651
<li class="r1 ">
716-
<span class='object_link'><a href="TrafficLight.html#state_name-instance_method" title="TrafficLight#state_name (method)">#state_name</a></span>
652+
<span class='object_link'><a href="Vehicle.html#state_name-instance_method" title="Vehicle#state_name (method)">#state_name</a></span>
717653

718-
<small>TrafficLight</small>
654+
<small>Vehicle</small>
719655

720656
</li>
721657

722658

723659
<li class="r2 ">
724-
<span class='object_link'><a href="AutoShop.html#state_name-instance_method" title="AutoShop#state_name (method)">#state_name</a></span>
660+
<span class='object_link'><a href="TrafficLight.html#state_name-instance_method" title="TrafficLight#state_name (method)">#state_name</a></span>
725661

726-
<small>AutoShop</small>
662+
<small>TrafficLight</small>
727663

728664
</li>
729665

730666

731667
<li class="r1 ">
732-
<span class='object_link'><a href="Vehicle.html#state_name-instance_method" title="Vehicle#state_name (method)">#state_name</a></span>
668+
<span class='object_link'><a href="AutoShop.html#state_paths-instance_method" title="AutoShop#state_paths (method)">#state_paths</a></span>
733669

734-
<small>Vehicle</small>
670+
<small>AutoShop</small>
735671

736672
</li>
737673

@@ -753,70 +689,62 @@ <h1 id="full_list_header">Method List</h1>
753689

754690

755691
<li class="r2 ">
756-
<span class='object_link'><a href="AutoShop.html#state_paths-instance_method" title="AutoShop#state_paths (method)">#state_paths</a></span>
757-
758-
<small>AutoShop</small>
759-
760-
</li>
761-
762-
763-
<li class="r1 ">
764692
<span class='object_link'><a href="Vehicle.html#state_transitions-instance_method" title="Vehicle#state_transitions (method)">#state_transitions</a></span>
765693

766694
<small>Vehicle</small>
767695

768696
</li>
769697

770698

771-
<li class="r2 ">
699+
<li class="r1 ">
772700
<span class='object_link'><a href="TrafficLight.html#state_transitions-instance_method" title="TrafficLight#state_transitions (method)">#state_transitions</a></span>
773701

774702
<small>TrafficLight</small>
775703

776704
</li>
777705

778706

779-
<li class="r1 ">
707+
<li class="r2 ">
780708
<span class='object_link'><a href="AutoShop.html#state_transitions-instance_method" title="AutoShop#state_transitions (method)">#state_transitions</a></span>
781709

782710
<small>AutoShop</small>
783711

784712
</li>
785713

786714

787-
<li class="r2 ">
715+
<li class="r1 ">
788716
<span class='object_link'><a href="TrafficLight.html#stop%3F-instance_method" title="TrafficLight#stop? (method)">#stop?</a></span>
789717

790718
<small>TrafficLight</small>
791719

792720
</li>
793721

794722

795-
<li class="r1 ">
723+
<li class="r2 ">
796724
<span class='object_link'><a href="Vehicle.html#third_gear%3F-instance_method" title="Vehicle#third_gear? (method)">#third_gear?</a></span>
797725

798726
<small>Vehicle</small>
799727

800728
</li>
801729

802730

803-
<li class="r2 ">
731+
<li class="r1 ">
804732
<span class='object_link'><a href="AutoShop.html#tow_vehicle-instance_method" title="AutoShop#tow_vehicle (method)">#tow_vehicle</a></span>
805733

806734
<small>AutoShop</small>
807735

808736
</li>
809737

810738

811-
<li class="r1 ">
739+
<li class="r2 ">
812740
<span class='object_link'><a href="AutoShop.html#tow_vehicle%21-instance_method" title="AutoShop#tow_vehicle! (method)">#tow_vehicle!</a></span>
813741

814742
<small>AutoShop</small>
815743

816744
</li>
817745

818746

819-
<li class="r2 ">
747+
<li class="r1 ">
820748
<span class='object_link'><a href="AutoShop.html#tow_vehicle_transition-instance_method" title="AutoShop#tow_vehicle_transition (method)">#tow_vehicle_transition</a></span>
821749

822750
<small>AutoShop</small>

‎examples/doc/top-level-namespace.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h2>Defined Under Namespace</h2>
9696
</div>
9797

9898
<div id="footer">
99-
Generated on Sun Feb 12 22:47:11 2012 by
99+
Generated on Tue Feb 14 08:03:03 2012 by
100100
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
101101
0.7.5 (ruby-1.9.2).
102102
</div>

0 commit comments

Comments
 (0)