ruby-ext 0.2.16 → 0.4.0

data/old/spec/state_machine_spec.rb

@@ -2,200 +2,200 @@ require 'RubyExt/require'
 require 'spec'
 
 module RubyExt
-	describe "State Mashine" do
-		class Meta < StateMashine
-			initial_state :Creation
-			transitions [:Creation, :create, :View],
-			[:View, :edit, :Edit],
-			[:Edit, :save, :View],
-			[:Edit, :cancel, :View],
-			[:View, :delete, :Deleted]
-		end
-		
-		class BareMeta < StateMashine
-			initial_state :Created
-			transitions [:Created, :delete, :Deleted]
-		end
-		
-		class MetadataTest < StateMashine
-			transitions [:s1, :fun, :s2], [:s3, :fun, :s4]
-		end
-		
-		before :each do
-			@state = Meta.new
-		end
-		
-		it "Initial State" do
-			@state.should == :Creation
-		end
-		
-		it "Exceptions in event processing should cause rollback in state change" do
-			@state.on_event :Creation, :create do
-				raise
-			end
-			lambda{@state.event :create}.should raise_error
-			@state.state.should == :Creation
-		end
-		
-		it "Should properly process events inside another event (from error)" do
-			@state.on_event :Creation, :create do
-				@state.event :edit
-			end
-			@state.event :create
-			@state.state.should == :Edit
-		end
-		
-		it "Transfer function" do
-			@state.event :create
-			@state.should == :View
-		end
-		
-		it "==" do
-			state2 = Meta.new
-			@state.should == state2
-			@state.should == :Creation
-		end
-		
-		it "before & after" do
-			@state.on_entry :View, :entry
-			@state.on_exit :View, :_exit
-			
-			mock = mock("Events")
-			@state.object = mock
-			
-			mock.should_receive(:entry).twice
-			@state.event :create
-			mock.should_receive(:_exit)
-			@state.event :edit
-			
-			@state.event :cancel
-			@state.on_entry :View, nil
-			@state.on_exit :View, nil
-			
-			@state.event :edit
-		end
-		
-		it "on_event" do
-			mock = mock("Events")
-			mock.should_receive :create
-			@state.on_event :Creation, :create do
-				mock.create
-			end
-			@state.event :create
-		end
-		
-		it "should also use block as action" do
-			mock = mock("Events")
-			@state.on_entry :View do
-				mock.entry
-			end                
-			
-			mock.should_receive(:entry)
-			@state.event :create
-		end
-		
-		it "Invalid method" do
-			lambda{@state.event :invalid}.should raise_error(/There is no :invalid Event in :Creation State/)
-		end
-		
-		it "Invalid state" do
-			lambda{@state.event :delete}.should raise_error(/There is no :delete Event in :Creation State!/)
-		end
-		
-		it "Bare State" do
-			s = BareMeta.new        
-			s.state = :Deleted
-		end
-		
-		# (Waiting) - begin -> (Action) - begin -> (NestedAction) - begin n-times -> (NestedAction)
-		#           <- end   -          <- end   -                < end n-times    -
-		#           <- cancel                    - 
-		it "Custom Recursive State" do
-			class NestedAction          
-				def initialize
-					@nesting_level = 0
-				end
-				
-				def begin
-						@nesting_level += 1
-						:NestedAction
-					end
-					
-					def end
-					if @nesting_level == 0
-						return :Action
-					else
-						@nesting_level -= 1  
-						return :NestedAction
-					end
-				end
-				
-				def cancel
-					@nesting_level = 0
-					return :Waiting
-				end
-				
-				# Not required, can be omited
-				def state state
-					case state
-						when :Action
-						@nesting_level = 0
-						return :Action
-					else nil
-					end
-				end
-			end
-			
-			class CustomState < StateMashine
-				initial_state :Waiting
-				transitions [:Waiting, :begin, :Action],
-				[:Action, :end, :Waiting],
-				[:Action, :begin, :NestedAction]
-				custom_state :NestedAction, NestedAction
-			end
-			
-			sm = CustomState.new
-			sm.event :begin
-			sm.state.should == :Action
-			sm.event :begin
-			sm.state.should == :NestedAction
-			
-			# Nested :begin/:end
-			sm.event :begin
-			sm.state.should == :NestedAction
-			sm.event :begin
-			sm.state.should == :NestedAction
-			
-			sm.event :end
-			sm.state.should == :NestedAction
-			sm.event :end
-			sm.state.should == :NestedAction
-			lambda{sm.event :invalid}.should raise_error(/There is no :invalid Event in :NestedAction State/)
-			
-			sm.event :end
-			sm.state.should == :Action
-			
-			# Nested :cancel
-			sm.event :begin
-			sm.state.should == :NestedAction
-			sm.event :begin
-			sm.state.should == :NestedAction
-			sm.event :cancel
-			sm.state.should == :Waiting
-			
-			# Correct working after :cancel
-			sm.event :begin
-			sm.state.should == :Action
-			sm.event :begin
-			sm.state.should == :NestedAction
-			sm.event :end
-			sm.state.should == :Action
-			
-			# Should also works with "state= ..."
-			sm.event :begin
-			sm.state.should == :NestedAction
-			sm.state = :Action
-			sm.state.should == :Action
-		end
-	end
+  describe "State Mashine" do
+    class Meta < StateMashine
+      initial_state :Creation
+      transitions [:Creation, :create, :View],
+      [:View, :edit, :Edit],
+      [:Edit, :save, :View],
+      [:Edit, :cancel, :View],
+      [:View, :delete, :Deleted]
+    end
+    
+    class BareMeta < StateMashine
+      initial_state :Created
+      transitions [:Created, :delete, :Deleted]
+    end
+    
+    class MetadataTest < StateMashine
+      transitions [:s1, :fun, :s2], [:s3, :fun, :s4]
+    end
+    
+    before :each do
+      @state = Meta.new
+    end
+    
+    it "Initial State" do
+      @state.should == :Creation
+    end
+    
+    it "Exceptions in event processing should cause rollback in state change" do
+      @state.on_event :Creation, :create do
+        raise
+      end
+      lambda{@state.event :create}.should raise_error
+      @state.state.should == :Creation
+    end
+    
+    it "Should properly process events inside another event (from error)" do
+      @state.on_event :Creation, :create do
+        @state.event :edit
+      end
+      @state.event :create
+      @state.state.should == :Edit
+    end
+    
+    it "Transfer function" do
+      @state.event :create
+      @state.should == :View
+    end
+    
+    it "==" do
+      state2 = Meta.new
+      @state.should == state2
+      @state.should == :Creation
+    end
+    
+    it "before & after" do
+      @state.on_entry :View, :entry
+      @state.on_exit :View, :_exit
+      
+      mock = mock("Events")
+      @state.object = mock
+      
+      mock.should_receive(:entry).twice
+      @state.event :create
+      mock.should_receive(:_exit)
+      @state.event :edit
+      
+      @state.event :cancel
+      @state.on_entry :View, nil
+      @state.on_exit :View, nil
+      
+      @state.event :edit
+    end
+    
+    it "on_event" do
+      mock = mock("Events")
+      mock.should_receive :create
+      @state.on_event :Creation, :create do
+        mock.create
+      end
+      @state.event :create
+    end
+    
+    it "should also use block as action" do
+      mock = mock("Events")
+      @state.on_entry :View do
+        mock.entry
+      end                
+      
+      mock.should_receive(:entry)
+      @state.event :create
+    end
+    
+    it "Invalid method" do
+      lambda{@state.event :invalid}.should raise_error(/There is no :invalid Event in :Creation State/)
+    end
+    
+    it "Invalid state" do
+      lambda{@state.event :delete}.should raise_error(/There is no :delete Event in :Creation State!/)
+    end
+    
+    it "Bare State" do
+      s = BareMeta.new        
+      s.state = :Deleted
+    end
+    
+    # (Waiting) - begin -> (Action) - begin -> (NestedAction) - begin n-times -> (NestedAction)
+    #           <- end   -          <- end   -                < end n-times    -
+    #           <- cancel                    - 
+    it "Custom Recursive State" do
+      class NestedAction          
+        def initialize
+          @nesting_level = 0
+        end
+        
+        def begin
+            @nesting_level += 1
+            :NestedAction
+          end
+          
+          def end
+          if @nesting_level == 0
+            return :Action
+          else
+            @nesting_level -= 1  
+            return :NestedAction
+          end
+        end
+        
+        def cancel
+          @nesting_level = 0
+          return :Waiting
+        end
+        
+        # Not required, can be omited
+        def state state
+          case state
+            when :Action
+            @nesting_level = 0
+            return :Action
+          else nil
+          end
+        end
+      end
+      
+      class CustomState < StateMashine
+        initial_state :Waiting
+        transitions [:Waiting, :begin, :Action],
+        [:Action, :end, :Waiting],
+        [:Action, :begin, :NestedAction]
+        custom_state :NestedAction, NestedAction
+      end
+      
+      sm = CustomState.new
+      sm.event :begin
+      sm.state.should == :Action
+      sm.event :begin
+      sm.state.should == :NestedAction
+      
+      # Nested :begin/:end
+      sm.event :begin
+      sm.state.should == :NestedAction
+      sm.event :begin
+      sm.state.should == :NestedAction
+      
+      sm.event :end
+      sm.state.should == :NestedAction
+      sm.event :end
+      sm.state.should == :NestedAction
+      lambda{sm.event :invalid}.should raise_error(/There is no :invalid Event in :NestedAction State/)
+      
+      sm.event :end
+      sm.state.should == :Action
+      
+      # Nested :cancel
+      sm.event :begin
+      sm.state.should == :NestedAction
+      sm.event :begin
+      sm.state.should == :NestedAction
+      sm.event :cancel
+      sm.state.should == :Waiting
+      
+      # Correct working after :cancel
+      sm.event :begin
+      sm.state.should == :Action
+      sm.event :begin
+      sm.state.should == :NestedAction
+      sm.event :end
+      sm.state.should == :Action
+      
+      # Should also works with "state= ..."
+      sm.event :begin
+      sm.state.should == :NestedAction
+      sm.state = :Action
+      sm.state.should == :Action
+    end
+  end
 end

data/readme.md

@@ -0,0 +1,102 @@
+# Ruby standard library extensions
+**ruby-ext** is a collection of various utility classes and standard library extensions for the Ruby language.
+
+## must - assertion tool, kind of RSpec assertions in runtime code
+
+	1.must_be.in 1..2
+	"a".must_be.in 'a', 'b', 'c'
+	key.must_be.a String
+	value.must_not_be.nil
+	must_be.never_called	
+	a.must_be.== b
+
+## inherit - combines include & extend in one
+Do you remember this *def self.included(base) ... end* hack? You don't need it anymore.
+
+	module Feature
+		def cool_method; end				
+		module ClassMethods
+			def cool_class_method; end
+		end
+	end						
+	
+	class TheClass
+		inherit Feature
+	end
+	
+	TheClass.new.cool_method
+	TheClass.cool_class_method	
+	
+## cache_method & synchronize_method
+
+	def complex_calculation
+		2 * 2
+	end
+	cache_method :complex_calculation
+
+	def money_transfer amount
+		@from -= amount
+		@to += amount
+	end
+	synchronize_method :money_transfer
+
+## OpenConstructor - adds mass assignment to any class
+	
+	class TheClass
+		include OpenConstructor
+		attr_accessor :a, :b
+	end
+
+	o = TheClass.new.set :a => 'a', :b => 'b'
+	o.a => 'a'
+	o.to_hash => {:a => 'a', :b => 'b'}
+	
+## VResource - Auto ClassLoader, forget about the 'require'
+Use direct mapping between your code and filesystem, define your class in the "/TheNamespace/.../TheClass.rb" file.
+And then just name it and ClassLoader will find and load it automatically.
+
+## Micon - Micro Container, assembles and manages pieces of your application
+Very small and handy [IoC][ioc] container with scopes and bijections (injection + outjection), borrowed from JBoss Seam.
+
+	class Logger
+		scope :application
+	end	
+	
+	class Session
+		scope :request
+	end
+	
+	class Application
+		inject :session => Session, :logger => Logger
+		
+		def do_business
+			session[:key] = 'value'
+			logger.log 'well done'
+		end
+	end
+	
+	Micon.activate :request, {} do
+		Application.new.do_business
+	end
+
+## More
+
+These are just a small part of all handy methods and extensions, for more details please go to specs.
+
+# Usage
+
+sudo gem install ruby-ext
+	
+	require 'ruby_ext'
+
+If you also need ClassLoader and Micon add following:
+
+	require 'vresource'
+	VResource.hook!
+	
+	require 'micon'
+	Micon.hook! Module
+
+Copyright (c) 2009 Alexey Petrushin [http://bos-tec.com](http://bos-tec.com), released under the MIT license.
+
+[ioc]: http://en.wikipedia.org/wiki/Inversion_of_control

data/spec/micon/custom_scope_spec.rb

@@ -0,0 +1,72 @@
+dir = File.expand_path(File.dirname(__FILE__))
+require "#{dir}/../micon_spec_helper"
+
+describe "Micon custom scope" do
+  before :each do
+    Micon.clear
+    Micon.clear_registry
+  end
+  
+  it "activate" do
+    container = {}    
+    Micon.should_not be_active(:custom)
+    Micon.activate :custom, container
+    Micon.should be_active(:custom)
+
+    lambda{Micon.activate :custom, container}.should raise_error(/active/)
+
+    Micon.deactivate :custom
+    lambda{Micon.deactivate :custom}.should raise_error(/not active/)
+    
+    Micon.should_not be_active(:custom)
+    Micon.activate :custom, container do
+      Micon.should be_active(:custom)
+    end
+  end
+  
+  it "check" do
+    Micon.register(:value, :custom){"The Object"}
+    lambda{Micon[:value]}.should raise_error(/not started/)
+    lambda{Micon[:value] = nil}.should raise_error(/not started/)
+  end
+  
+  it "get" do
+    Micon.register(:value, :custom){"The Object"}
+    container, the_object = {}, nil
+    
+    Micon.activate :custom, container do
+      Micon[:value].should == "The Object"
+      the_object = Micon[:value]
+    end
+    
+    Micon.activate :custom, {} do
+      Micon[:value].object_id.should_not == the_object.object_id
+    end
+    
+    Micon.activate :custom, container do
+      Micon[:value].object_id.should == the_object.object_id
+    end
+    
+    container.size.should == 1
+    container[:value].should == the_object
+  end
+  
+  it "set" do
+    Micon.register(:value, :custom){"The Object"}
+    container = {}
+    
+    Micon.activate :custom, container do
+      Micon[:value].should == "The Object"
+      Micon[:value] = "Another Object"
+      the_object = Micon[:value]
+    end
+    
+    Micon.activate :custom, {} do
+      Micon[:value].should == "The Object"
+    end
+    
+    Micon.activate :custom, container do
+      Micon[:value].should == "Another Object"
+    end
+  end
+end

data/spec/micon/managed_spec.rb

@@ -0,0 +1,47 @@
+dir = File.expand_path(File.dirname(__FILE__))
+require "#{dir}/../micon_spec_helper"
+
+describe "Micon Managed" do
+  before :all do
+    Micon.clear_registry
+    
+    class ManagedObject
+      inherit Micon::Managed
+      scope :application
+      inject :object => :object_key
+
+      class << self
+        inherit Micon::Managed
+        inject :object => :object_key
+      end
+    end
+  end
+  
+  before :each do
+    Micon.clear
+  end
+
+  it "scope" do
+    scope, initializer = Micon.registry_get(ManagedObject)
+    scope.should == :application
+    initializer.call.should be_a(ManagedObject)
+  end
+
+  it "injection" do
+    the_object = "The Object"
+    Micon.register(:object_key, :application){the_object}
+
+    ManagedObject.object.should == the_object
+    o = ManagedObject.new
+    o.object.should == the_object
+  end
+  
+  it "outjection" do
+    the_object = "The Object"
+    Micon.register(:object_key, :application)
+
+    ManagedObject.object.should be_nil    
+    ManagedObject.object = the_object
+    ManagedObject.object.should == the_object
+  end
+end

data/spec/micon/static_scope_spec.rb

@@ -0,0 +1,61 @@
+dir = File.expand_path(File.dirname(__FILE__))
+require "#{dir}/../micon_spec_helper"
+
+describe "Application and Instance scopes" do  
+  before :each do
+    Micon.clear
+    Micon.clear_registry
+  end
+  
+  it "instance scope" do    
+    Micon.register(:value, :instance){"The Object"}
+    
+    Micon[:value].should == "The Object"
+    Micon[:value].object_id.should_not == Micon[:value].object_id
+  end
+  
+  it "application scope" do
+    Micon.register(:value, :application){"The Object"}
+    
+    Micon[:value].should == "The Object"
+    Micon[:value].object_id.should == Micon[:value].object_id
+  end
+
+  it "application scope, outjection" do
+    the_object = "The Object"
+    Micon.register :value, :application
+    
+    Micon[:value].should be_nil
+    Micon[:value] = the_object
+    Micon[:value].object_id.should == the_object.object_id
+  end
+  
+  it "cycle reference" do
+    class CycleB; end
+  
+    class CycleA
+      inherit Micon::Managed
+      scope :application
+      inject :b => CycleB
+    end
+  
+    class CycleB
+      inherit Micon::Managed
+      scope :application
+      inject :a => CycleA
+    end
+    
+    a = Micon[CycleA]
+    b = Micon[CycleB]
+    a.b.equal?(b).should be_true
+    b.a.equal?(a).should be_true
+  end        
+    
+  it "unregister" do      
+    Micon.register(:value, :application){"The Object"}
+    Micon[:value].should == "The Object"
+    
+    Micon.unregister :value
+    lambda{Micon[:value]}.should raise_error(/Name is not Managed/)
+  end
+end

data/spec/micon_spec_helper.rb

@@ -0,0 +1,8 @@
+require 'spec'
+
+ruby_ext_dir = File.expand_path("#{File.dirname(__FILE__)}/..")
+$LOAD_PATH << "#{ruby_ext_dir}/lib"
+
+require "ruby_ext"
+
+require "micon"