control 0.9.0 → 0.9.1

data/test/lib/control/state_test.rb

@@ -0,0 +1,80 @@
+require(File.expand_path(File.join('.','test/test_helper')))
+
+class StateTest < Test::Unit::TestCase
+  def test_state_can_define_next_states
+    assert Box.respond_to? 'next_states'
+  end
+  
+  def test_correct_next_states
+    assert Validate.next_states.include?(Box)
+    assert Validate.next_states.include?(Reject)
+    assert !Validate.next_states.include?(Validate)
+    assert !Validate.next_states.include?(Assembly)
+  end
+
+  def test_next_state_is_valid_state
+    InvalidState.next_states :state_that_does_not_exist
+    assert_raise NameError do
+      InvalidState.next_states
+    end
+  end
+  
+  def test_infer_workflow_to_which_i_belong
+    p = Product.new
+    
+    box = Box.new
+    box.product = p
+    
+    assert box.workflow
+    assert box.workflow == box.product
+    assert Product == box.workflow.class
+  end
+  
+  def test_state_change_complies_with_defined_next_states
+    p = Product.new
+    
+    validate = Validate.new
+    validate.product = p
+    validate.save
+    
+    assembly = Assembly.new
+    assembly.product = p
+    
+    assert_raise Control::InvalidTransition do
+      assembly.save  
+    end
+  end
+  
+  def test_previous_state
+    p = Product.new
+    p.save
+    
+    assembly = Assembly.new
+    assembly.product = p
+    assembly.save
+    
+    validate = Validate.new
+    validate.product = p
+    validate.save
+
+    assert assembly.previous.nil?
+    assert validate.previous == assembly
+  end
+  
+  def test_next_state
+    p = Product.new
+    p.save
+    
+    assembly = Assembly.new
+    assembly.product = p
+    assembly.save
+    
+    validate = Validate.new
+    validate.product = p
+    validate.save
+
+    assert assembly.next == validate
+    assert validate.next.nil?
+  end
+  
+end

data/test/lib/control/transition_test.rb

@@ -0,0 +1,84 @@
+require(File.expand_path(File.join('.','test/test_helper')))
+
+class TransitionTest < Test::Unit::TestCase  
+  def test_after_state_save_transition_must_be_saved
+    p = Product.new
+    p.save
+  
+    assert p.transitions.count == 0
+  
+    a = Assembly.new
+    a.product = p
+    a.save
+    
+    assert p.transitions.count == 1
+    assert p.transitions.first.to_class == Assembly.to_s
+    assert p.transitions.first.created_at < Time.current
+    
+    v = Validate.new
+    v.product = p
+    v.save
+    
+    assert p.transitions.count == 2
+    assert p.transitions.last.from_class == Assembly.to_s
+    assert p.transitions.last.to_class == Validate.to_s
+    assert p.transitions.first.created_at < p.transitions.last.created_at
+  end
+  
+  # TODO: Check for correct exception raised, not just valid object
+  def test_correct_class_names
+    t = Control::Transition.new
+    t.workflow_class = Product.to_s
+    t.workflow_id = 1
+    t.from_class = Validate.to_s
+    t.from_id = 1
+    t.to_class = Assembly.to_s
+    t.to_id = 1
+    
+    assert t.valid?
+  end
+  
+  def test_empty_transition
+    t = Control::Transition.new
+    assert !t.valid?
+  end
+  
+  # TODO: Check for correct exception raised, not just valid object
+  def test_incorrect_workflow
+    t = Control::Transition.new
+    t.workflow_class = "Prudoct"
+    t.workflow_id = 1
+    t.from_class = Validate.to_s
+    t.from_id = 1
+    t.to_class = Assembly.to_s
+    t.to_id = 1
+    
+    assert !t.valid?
+  end
+  
+  # TODO: Check for correct exception raised, not just valid object
+  def test_incorrect_from
+    t = Control::Transition.new
+    t.workflow_class = Product.to_s
+    t.workflow_id = 1
+    t.from_class = 'Valideta'
+    t.from_id = 1
+    t.to_class = Assembly.to_s
+    t.to_id = 1
+    
+    assert !t.valid?
+  end
+  
+  # TODO: Check for correct exception raised, not just valid object
+  def test_incorrect_to
+    t = Control::Transition.new
+    t.workflow_class = Product.to_s
+    t.workflow_id = 1
+    t.from_class = Validate.to_s
+    t.from_id = 1
+    t.to_class = 'Assembli'
+    t.to_id = 1
+    
+    assert !t.valid?
+  end
+end

data/test/lib/control/workflow_test.rb

@@ -0,0 +1,107 @@
+require(File.expand_path(File.join('.','test/test_helper')))
+
+class WorkflowTest < Test::Unit::TestCase
+
+  def test_state_belongs_to_workflow
+    p = Product.new
+    p.save
+  
+    a = Assembly.new
+    a.product = p       
+    
+    assert_nothing_raised Control::NoAssociationToWorkflow do
+      a.save   
+    end 
+  end
+  
+  def test_state_does_not_belong_to_workflow
+    workflowless_state = WorkflowlessState.new
+    assert_raise Control::NoAssociationToWorkflow do
+      workflowless_state.save   
+    end
+  end  
+  
+  def test_state_must_have_workflow_associated
+    
+    p = Product.new    
+    p.save
+    
+    a = Assembly.new
+    
+    assert_raise Control::NoAssociationToWorkflow do
+      a.save
+    end  
+    
+  end
+
+  def test_workflow_is_enabled_by_default
+    assert Product.new.enabled
+  end
+  
+  def test_state_list
+    assert Product.new.class.states.count == 4
+    assert Product.new.class.states.include?(Box)
+    assert Product.new.class.states.include?(Assembly)
+    assert Product.new.class.states.include?(Reject)
+    assert Product.new.class.states.include?(Validate)
+  end
+  
+  def test_initially_current_state_is_not_defined
+    assert Product.new.current_state == nil
+  end
+  
+  def test_after_transition_current_state_must_change
+    p = Product.new
+    p.save
+  
+    a = Assembly.new
+    a.product = p
+    a.save
+        
+    assert p.current_state == a
+    
+    v = Validate.new
+    v.product = p
+    v.save
+    
+    assert p.current_state == v
+  end
+  
+  def test_transition_to_same_state
+    p = Product.new
+    p.save
+  
+    b1 = Box.new
+    b1.product = p
+    b1.save
+    
+    b2 = Box.new
+    b2.product = p
+    b2.save
+    
+    assert p.transitions.count == 2
+    assert p.current_state == b2
+    assert p.current_state.class == p.current_state.previous.class
+    assert p.transitions.last.from_class == p.transitions.last.to_class
+    assert p.transitions.last.from != p.transitions.last.to
+  end
+  
+  def test_final_state_means_workflow_blocked
+    p = Product.new
+    p.save
+ 
+    r = Reject.new
+    r.product = p
+    
+    assert_nothing_raised Control::FinalState do
+      r.save
+    end
+    
+    a = Assembly.new
+    a.product = p
+
+    assert_raise Control::FinalState do
+      a.save
+    end
+  end
+end

data/test/rails_app/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gem 'rails'
+gem 'sqlite3'
+
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  gem 'therubyracer'
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+gem 'thin'
+gem 'control', :path => '../../'

data/test/rails_app/Gemfile.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: ../../
+  specs:
+    control (0.7.1)
+      activerecord (>= 3.0.0)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.1)
+      actionpack (= 3.2.1)
+      mail (~> 2.4.0)
+    actionpack (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.0)
+    builder (3.0.0)
+    coffee-rails (3.2.2)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.2.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.2.0)
+    daemons (1.1.8)
+    erubis (2.7.0)
+    eventmachine (0.12.10)
+    execjs (1.3.0)
+      multi_json (~> 1.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.1)
+    jquery-rails (2.0.0)
+      railties (>= 3.2.0.beta, < 5.0)
+      thor (~> 0.14)
+    json (1.6.5)
+    libv8 (3.3.10.4)
+    mail (2.4.1)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.1)
+      actionmailer (= 3.2.1)
+      actionpack (= 3.2.1)
+      activerecord (= 3.2.1)
+      activeresource (= 3.2.1)
+      activesupport (= 3.2.1)
+      bundler (~> 1.0)
+      railties (= 3.2.1)
+    railties (3.2.1)
+      actionpack (= 3.2.1)
+      activesupport (= 3.2.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sass (3.1.14)
+    sass-rails (3.2.4)
+      railties (~> 3.2.0)
+      sass (>= 3.1.10)
+      tilt (~> 1.3)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    therubyracer (0.9.9)
+      libv8 (~> 3.3.10)
+    thin (1.3.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    uglifier (1.2.3)
+      execjs (>= 0.3.0)
+      multi_json (>= 1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 3.2.1)
+  control!
+  jquery-rails
+  rails
+  sass-rails (~> 3.2.3)
+  sqlite3
+  therubyracer
+  thin
+  uglifier (>= 1.0.3)

data/test/rails_app/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.