command_model 1.0.0 → 1.1.0

data/README.md

@@ -1,19 +1,26 @@
 # CommandModel
 
-Domain models usually have richer behavior than can be represented with a
-typical ActiveRecord style update_attributes.
+CommandModel is an ActiveModel based class that encapsulates the user
+interaction logic that wraps a domain operation. This user interaction
+typically may include sanitizing, validating, normalizing, and typecasting
+input. It also will include the response from the domain operation.
+
+There are three major concerns when handling a user request: input handling,
+domain logic, and persistence. ActiveRecord mixes all three of these concerns
+together. While this is very convenient for simple CRUD, it becomes difficult
+to work with once your domain operations become more complex. Domain models
+usually have richer behavior than can be represented with a typical
+ActiveRecord style update_attributes.
 
     # yuck!
-    account.update_attributes :balance => account.balance - 50 
+    account.update_attributes balance: account.balance - 50 
     
     # much better
-    account.withdraw :amount => 50
+    account.withdraw amount: 50
     
 But there are multiple complications with the OO approach. How do we integrate
 Rails style validations? How are user-supplied strings typecast? How do we
-know if the command succeeded? CommandModel solves these problems. CommandModel
-is an ActiveModel based class that encapsulates validations and typecasting
-for command execution.
+know if the command succeeded? CommandModel solves these problems. 
     
 ## Installation
 
@@ -36,25 +43,23 @@ request.
 
     class WithdrawCommand < CommandModel::Model
       parameter :amount,
-        :typecast => :integer,
-        :presence => true,
-        :numericality => { :greater_than => 0, :less_than_or_equal_to => 500 }
+        typecast: :integer,
+        presence: true,
+        numericality: { greater_than: 0, less_than_or_equal_to: 500 }
     end
     
-Create the method to run the command. This method should call the class method
-execute on the command class and pass it the options it received. It will
-accept either a command object or a hash of attributes. It must pass execute
+Create the method to run the command. This method should instantiate and call a new command object. It must pass call
 a block that actually does the work. The block will only be called if
-the validations in the command object pass. The execute block is free to do
+the validations in the command object pass. The block is free to do
 any further validations that only can be done during execution. If it adds
 any errors to the command object then the command will be considered to have
-failed. Finally the execute method will return the command object.
+failed. Finally, the call method will return self.
 
     class Account
       # ...
       
-      def withdraw(options)
-        WithdrawCommand.execute(options) do |command|
+      def withdraw(args)
+        WithdrawCommand.new(args).call do |command|
           if balance >= command.amount
             @balance -= command.amount
           else
@@ -68,7 +73,7 @@ failed. Finally the execute method will return the command object.
     
 Use example:
 
-    response = account.withdraw :amount => 50
+    response = account.withdraw amount: 50
     
     if response.success?
       puts "Success!"
@@ -76,7 +81,38 @@ Use example:
       puts "Errors:"
       puts response.errors.full_messages
     end
-    
+
+## Mixing in Domain Logic
+
+In a pure OO world the domain logic for actually executing a command may
+belong in another class. However, it is possible to mix in that logic directly
+into the command object. This can easily be done by overriding the execute
+method. The execute method is called by the call method if all validations
+succeed. The following is a reimplementation of the previous example with
+internal domain logic.
+
+    class WithdrawCommand < CommandModel::Model
+      parameter :amount,
+        typecast: :integer,
+        presence: true,
+        numericality: { greater_than: 0, less_than_or_equal_to: 500 }
+      parameter :account_id, presence: true
+
+      def execute
+        account = Account.find_by_id account_id
+        unless account
+          errors.add :account_id, "not found"
+          return
+        end
+
+        if account.balance >= amount
+          account.balance -= amount
+        else
+          errors.add :amount, "is more than account balance"
+        end
+      end
+    end
+
 ## Other uses
 
 This could be used to wrap database generated errors into normal Rails
@@ -85,11 +121,22 @@ show up in errors the same as validates_uniqueness_of. validates_uniqueness_of
 could even be removed for a marginal performance boost as the database should
 be doing a uniqueness check anyway.
 
-# Examples
+## Examples
 
 There is a simple Rails application in examples/bank that demonstrates the
 integration of Rails form helpers and validations with CommandModel.
 
+## Version History
+
+* 1.1 - November 13, 2012
+** Updated documentation and example application
+** Refactored Model to support internal domain logic easier with #call and #execute.
+** Model#initialize can now copy another model
+** Added Model#set_parameters
+** Added Model.parameters
+* 1.0 - April 14, 2012
+** Initial public release
+
 ## Contributing
 
 1. Fork it

data/command_model.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |gem|
   
   gem.add_dependency 'activemodel', "~> 3.2"
   
-  gem.add_development_dependency 'rspec', "~> 2.9.0"
-  gem.add_development_dependency 'guard', "~> 1.0.0"
-  gem.add_development_dependency 'guard-rspec', "~> 0.7.0"   
+  gem.add_development_dependency 'rspec', "~> 2.11.0"
+  gem.add_development_dependency 'guard', "~> 1.5.3"
+  gem.add_development_dependency 'guard-rspec', "~> 2.1.1"
+  gem.add_development_dependency 'rb-fsevent', '~> 0.9.1'  
+  
 end

data/examples/bank/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '3.2.3'
+gem 'rails', '3.2.8'
 
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'

data/examples/bank/README.md

@@ -0,0 +1,7 @@
+# Bank
+
+This is an example application that gives several different uses of
+CommandModel in a Rails application.
+
+Withdrawals and deposits are modeled as instance methods of Account. Transfers
+are modeled as their own entity. CommandModel easily supports both.

data/examples/bank/app/controllers/accounts_controller.rb

@@ -1,15 +1,15 @@
-class AccountsController < ApplicationController
+  class AccountsController < ApplicationController
   def index
-    @accounts = ACCOUNTS
+    @accounts = Account.all
   end
 
   def deposit_form
-    @account = find_account_by_name params[:id]
+    @account = Account.find_by_name params[:id]
     @deposit = Account::DepositCommand.new
   end
   
   def deposit
-    @account = find_account_by_name params[:id]
+    @account = Account.find_by_name params[:id]
     @deposit = @account.deposit params[:deposit]
     
     if @deposit.success?
@@ -20,12 +20,12 @@ class AccountsController < ApplicationController
   end
   
   def withdraw_form
-    @account = find_account_by_name params[:id]
+    @account = Account.find_by_name params[:id]
     @withdraw = Account::WithdrawCommand.new
   end  
   
   def withdraw
-    @account = find_account_by_name params[:id]
+    @account = Account.find_by_name params[:id]
     @withdraw = @account.withdraw params[:withdraw]
     
     if @withdraw.success?
@@ -36,27 +36,18 @@ class AccountsController < ApplicationController
   end
 
   def transfer_form
-    @accounts = ACCOUNTS
+    @accounts = Account.all
     @transfer = Account::TransferCommand.new
   end
   
   def transfer
-    @accounts = ACCOUNTS
-    @transfer = Account::TransferCommand.new
-    @transfer.to = find_account_by_name params[:transfer][:to]
-    @transfer.from = find_account_by_name params[:transfer][:from]
-    @transfer.amount = params[:transfer][:amount]
-    Account.transfer @transfer
+    @transfer = Account::TransferCommand.new(params[:transfer])
     
-    if @transfer.success?
+    if @transfer.call.success?
       redirect_to root_path, :notice => "Transferred #{@transfer.amount} from #{@transfer.from.name}'s account to #{@transfer.to.name}'s account."
     else
+      @accounts = Account.all
       render "transfer_form"
     end
   end
-  
-  private
-    def find_account_by_name(name)
-      ACCOUNTS.find { |a| a.name == name }
-    end
 end

data/examples/bank/app/controllers/transfers_controller.rb

@@ -0,0 +1,17 @@
+class TransfersController < ApplicationController
+  def new
+    @accounts = Account.all
+    @transfer = Account::Transfer.new
+  end
+  
+  def create
+    @transfer = Account::Transfer.new(params[:transfer])
+    
+    if @transfer.call.success?
+      redirect_to root_path, :notice => "Transferred #{@transfer.amount} from #{@transfer.from.name}'s account to #{@transfer.to.name}'s account."
+    else
+      @accounts = Account.all
+      render :new
+    end
+  end
+end

data/examples/bank/app/models/account.rb

@@ -1,29 +1,17 @@
 class Account
   class WithdrawCommand < CommandModel::Model
     parameter :amount,
-      :typecast => :integer,
-      :presence => true,
-      :numericality => { :greater_than => 0, :less_than_or_equal_to => 500 }
+      typecast: :integer,
+      presence: true,
+      numericality: { greater_than: 0, less_than_or_equal_to: 500 }
   end
   
   class DepositCommand < CommandModel::Model
     parameter :amount,
-      :typecast => :integer,
-      :presence => true,
-      :numericality => { :greater_than => 0 }
-  end
-  
-  class TransferCommand < CommandModel::Model
-    parameter :from, :to, :presence => true
-    parameter :amount,
-      :typecast => :integer,
-      :presence => true,
-      :numericality => { :greater_than => 0 }
-      
-    validate do |model|
-      errors.add :base, "From and to accounts cannot be the same" if model.from == model.to
-    end
-  end    
+      typecast: :integer,
+      presence: true,
+      numericality: { greater_than: 0 }
+  end  
 
   attr_reader :name, :balance
   
@@ -32,8 +20,8 @@ class Account
     @balance = balance
   end
   
-  def withdraw(options)
-    WithdrawCommand.execute(options) do |command|
+  def withdraw(args)
+    WithdrawCommand.new(args).call do |command|
       if balance >= command.amount
         @balance -= command.amount
       else
@@ -42,24 +30,21 @@ class Account
     end
   end
   
-  def deposit(options)
-    DepositCommand.execute(options) do |command|
+  def deposit(args)
+    DepositCommand.new(args).call do |command|
       @balance += command.amount
     end
   end
   
-  def self.transfer(options)
-    TransferCommand.execute(options) do |command|
-      if command.from.balance >= command.amount
-        command.from.withdraw :amount => command.amount
-        command.to.deposit :amount => command.amount
-      else
-        command.errors.add :amount, "is more than account balance"
-      end
-    end
-  end
-  
   def to_param
     name
   end
+
+  def self.all
+    ACCOUNTS
+  end
+
+  def self.find_by_name(name)
+    all.find { |a| a.name == name }
+  end
 end

data/examples/bank/app/models/transfer.rb

@@ -0,0 +1,34 @@
+class Transfer < CommandModel::Model
+  parameter :from_name, :to_name, presence: true
+  parameter :amount,
+    typecast: :integer,
+    presence: true,
+    numericality: { greater_than: 0 }
+
+  validate do |model|
+    { from_name: from, to_name: to }.each do |key, value|
+      errors.add key, "is not a valid account name" unless value
+    end
+  end
+    
+  validate do |model|
+    errors.add :base, "From and to accounts cannot be the same" if model.from == model.to
+  end
+
+  def call
+    if from.balance >= amount
+      from.withdraw amount: amount
+      to.deposit amount: amount
+    else
+      errors.add :amount, "is more than account balance"
+    end
+  end
+
+  def from
+    Account.find_by_name from_name
+  end
+
+  def to
+    Account.find_by_name to_name
+  end
+end

data/examples/bank/app/views/accounts/index.html.erb

@@ -19,4 +19,4 @@
   <% end %>
 </table>
 
-<%= link_to "Transfer", account_transfer_path %>
+<%= link_to "Transfer", new_transfer_path %>

data/examples/bank/app/views/transfers/new.html.erb

@@ -0,0 +1,32 @@
+<p><%= link_to "Back to all accounts", root_path %></p>
+
+<h1>Transfer Between Accounts</h1>
+
+
+<% if @transfer.errors.present? %>
+  <ul>
+    <% @transfer.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+  </ul>
+<% end %>
+
+<%= form_for @transfer do |f| %>
+  <div>
+    <%= f.label :from_name %><br />
+    <%= f.select :from_name, @accounts.map { |a| ["#{a.name} - #{a.balance}", a.name] }, :selected => f.object.from_name, :include_blank => true %>
+  </div>
+  <div>
+    <%= f.label :to_name %><br />
+    <%= f.select :to_name, @accounts.map { |a| ["#{a.name} - #{a.balance}", a.name] }, :selected => f.object.to_name, :include_blank => true %>
+  </div>
+  <div>
+    <%= f.label :amount %><br />
+    <%= f.text_field :amount %>
+  </div>
+  <%= f.submit "Transfer" %>
+<% end %>
+
+
+
+

data/examples/bank/config/routes.rb

@@ -5,8 +5,7 @@ Bank::Application.routes.draw do
   get "accounts/:id/deposit" => "accounts#deposit_form", :as => :account_deposit_form
   post "accounts/:id/deposit" => "accounts#deposit", :as => :account_deposit
 
-  get "accounts/transfer" => "accounts#transfer_form", :as => :account_transfer_form
-  post "accounts/transfer" => "accounts#transfer", :as => :account_transfer
-  
+  resources :transfers, only: %w[new create]
+
   root :to => "accounts#index"
 end

data/lib/command_model/model.rb

@@ -3,6 +3,8 @@ module CommandModel
     include ActiveModel::Validations
     include ActiveModel::Conversion
     extend ActiveModel::Naming
+
+    Parameter = Struct.new(:name, :typecast, :validations)
     
     # Parameter requires one or more attributes as its first parameter(s).
     # It accepts an options hash as its last parameter.
@@ -37,8 +39,14 @@ module CommandModel
           attr_writer name
         end
         validates name, options.clone if options.present? # clone options because validates mutates the hash :(
+        parameters.push Parameter.new name, typecast, options
       end
     end
+
+    # Returns array of all parameters defined for class
+    def self.parameters
+      @parameters ||= []
+    end
     
     def self.attr_typecasting_writer(name, target_type) #:nodoc
       eval <<-END_EVAL
@@ -71,16 +79,14 @@ module CommandModel
     #       command.errors.add :base, "not allowed to rename"
     #     end
     #   end
-    def self.execute(attributes_or_command)
+    def self.execute(attributes_or_command, &block)
       command = if attributes_or_command.kind_of? self
         attributes_or_command
       else
         new(attributes_or_command)
       end
       
-      yield command if command.valid?
-      command.execution_attempted!   
-      command
+      command.call &block
     end
     
     # Quickly create a successful command object. This is used when the
@@ -103,15 +109,31 @@ module CommandModel
       end
     end
     
-    # Accepts an attributes hash
-    def initialize(attributes={})
+    # Accepts a parameters hash or another of the same class. If another
+    # instance of the same class is passed in then the parameters are copied
+    # to the new object.
+    def initialize(parameters={})
       @typecast_errors = {}
-      
-      attributes.each do |k,v|
-        send "#{k}=", v
-      end
+      set_parameters parameters
     end
-    
+
+    # Executes the command by calling the method +execute+ if the validations
+    # pass.
+    def call(&block)
+      execute(&block) if valid?
+      execution_attempted!
+      self
+    end
+
+    # Performs the actual command execution. It does not test if the command
+    # parameters are valid. Typically, +call+ should be called instead of
+    # calling +execute+ directly.
+    #
+    # +execute+ should be overridden in descendent classes
+    def execute
+      yield self if block_given?
+    end
+
     # Record that an attempt was made to execute this command whether or not
     # it was successful.
     def execution_attempted! #:nodoc:
@@ -127,6 +149,21 @@ module CommandModel
     def success?
       execution_attempted? && errors.empty?
     end
+
+    # Returns hash of all parameter names and values
+    def parameters
+      self.class.parameters.each_with_object({}) do |parameter, hash|
+        hash[parameter.name] = send(parameter.name)
+      end
+    end
+
+    # Sets parameter(s) from hash or instance of same class
+    def set_parameters(hash_or_instance)
+      parameters = extract_parameters_from_hash_or_instance(hash_or_instance)
+      parameters.each do |k,v|
+        send "#{k}=", v
+      end
+    end
     
     #:nodoc:
     def persisted?
@@ -134,6 +171,14 @@ module CommandModel
     end
     
     private
+      def extract_parameters_from_hash_or_instance(hash_or_instance)
+        if hash_or_instance.respond_to?(:parameters) 
+          hash_or_instance.parameters
+        else
+          hash_or_instance
+        end
+      end
+
       def typecast_integer(value)
         Integer(value) rescue nil
       end

data/lib/command_model/version.rb

@@ -1,3 +1,3 @@
 module CommandModel
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/model_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 class ExampleCommand < CommandModel::Model
   parameter :name, :presence => true
+  parameter :title
 end
 
 describe CommandModel::Model do
@@ -66,7 +67,21 @@ describe CommandModel::Model do
       instance.errors[:name].should be_present
     end    
   end
-  
+
+  describe "self.parameters" do
+    it "returns all parameters in class" do
+      klass = Class.new(CommandModel::Model)
+      klass.parameter :name, presence: true
+      klass.parameter :birthdate, typecast: :date, presence: true
+
+      expected = [
+        CommandModel::Model::Parameter.new(:name, nil, { presence: true }),
+        CommandModel::Model::Parameter.new(:birthdate, :date, { presence: true })
+      ]
+
+      expect(klass.parameters).to eq(expected)
+    end
+  end
 
   describe "self.execute" do
     it "accepts object of same kind and returns it" do
@@ -129,10 +144,51 @@ describe CommandModel::Model do
   
 
   describe "initialize" do
-    it "assigns attributes" do
+    it "assigns parameters from hash" do
       m = ExampleCommand.new :name => "John"
       m.name.should eq("John")
     end
+
+    it "assigns parameters from other CommandModel" do
+      other = ExampleCommand.new :name => "John"
+      m = ExampleCommand.new other
+      expect(m.name).to eq(other.name)
+    end
+  end
+
+  describe "call" do
+    context "when valid" do
+      it "calls execute" do
+        example_command.should_receive(:execute)
+        example_command.call
+      end
+
+      it "returns self" do
+        expect(example_command.call).to eq(example_command)
+      end
+    end
+
+    context "when invalid" do
+      it "does not call execute" do
+        invalid_example_command.should_not_receive(:execute)
+        invalid_example_command.call
+      end
+
+      it "returns self" do
+        expect(invalid_example_command.call).to eq(invalid_example_command)
+      end
+    end
+  end
+
+  describe "execute" do
+    it "yields to block with self as argument" do
+      block_arg = nil
+      example_command.execute do |command|
+        block_arg = command
+      end
+
+      expect(block_arg).to eq(example_command)
+    end
   end
   
   describe "execution_attempted!" do
@@ -158,6 +214,32 @@ describe CommandModel::Model do
       example_command.success?.should eq(true)
     end
   end
+
+  describe "parameters" do
+    it "is a hash of all parameter name and values" do
+      klass = Class.new(CommandModel::Model)
+      klass.parameter :name, presence: true
+      klass.parameter :birthdate, typecast: :date, presence: true
+
+      expected = { name: "John", birthdate: Date.new(1980,1,1) }
+      instance = klass.new expected
+      expect(instance.parameters).to eq(expected)
+    end
+  end
+
+  describe "set_parameters" do
+    it "sets parameters from hash with symbol keys" do
+      example_command.set_parameters name: "Bill", title: "Boss"
+      expect(example_command.name).to eq("Bill")
+      expect(example_command.title).to eq("Boss")
+    end
+
+    it "sets parameters from hash with string keys" do
+      example_command.set_parameters "name" => "Bill", "title" => "Boss"
+      expect(example_command.name).to eq("Bill")
+      expect(example_command.title).to eq("Boss")
+    end
+  end
   
   describe "typecast_integer" do
     it "casts to integer when valid string" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_model
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-14 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &15163980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,40 +21,76 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *15163980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15163060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *15163060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &15162120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.5.3
   type: :development
   prerelease: false
-  version_requirements: *15162120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &15161240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.9.1
   type: :development
   prerelease: false
-  version_requirements: *15161240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 description: CommandModel - when update_attributes isn't enough.
 email:
 - jack@jackchristensen.com
@@ -72,7 +108,7 @@ files:
 - command_model.gemspec
 - examples/bank/.gitignore
 - examples/bank/Gemfile
-- examples/bank/README.rdoc
+- examples/bank/README.md
 - examples/bank/Rakefile
 - examples/bank/app/assets/images/rails.png
 - examples/bank/app/assets/javascripts/accounts.js.coffee
@@ -81,16 +117,18 @@ files:
 - examples/bank/app/assets/stylesheets/application.css
 - examples/bank/app/controllers/accounts_controller.rb
 - examples/bank/app/controllers/application_controller.rb
+- examples/bank/app/controllers/transfers_controller.rb
 - examples/bank/app/helpers/accounts_helper.rb
 - examples/bank/app/helpers/application_helper.rb
 - examples/bank/app/mailers/.gitkeep
 - examples/bank/app/models/.gitkeep
 - examples/bank/app/models/account.rb
+- examples/bank/app/models/transfer.rb
 - examples/bank/app/views/accounts/deposit_form.html.erb
 - examples/bank/app/views/accounts/index.html.erb
-- examples/bank/app/views/accounts/transfer_form.html.erb
 - examples/bank/app/views/accounts/withdraw_form.html.erb
 - examples/bank/app/views/layouts/application.html.erb
+- examples/bank/app/views/transfers/new.html.erb
 - examples/bank/config.ru
 - examples/bank/config/application.rb
 - examples/bank/config/boot.rb
@@ -153,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: CommandModel integrates Rails validations with command objects. This allows

data/examples/bank/README.rdoc

@@ -1,261 +0,0 @@
-== 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.

data/examples/bank/app/views/accounts/transfer_form.html.erb

@@ -1,32 +0,0 @@
-<p><%= link_to "Back to all accounts", root_path %></p>
-
-<h1>Transfer Between Accounts</h1>
-
-
-<% if @transfer.errors.present? %>
-  <ul>
-    <% @transfer.errors.full_messages.each do |msg| %>
-      <li><%= msg %></li>
-    <% end %>
-  </ul>
-<% end %>
-
-<%= form_for @transfer, :as => :transfer, :url => account_transfer_path do |f| %>
-  <div>
-    <%= f.label :from %><br />
-    <%= f.select :from, @accounts.map { |a| ["#{a.name} - #{a.balance}", a.name] }, :selected => f.object.from.try(:name), :include_blank => true %>
-  </div>
-  <div>
-    <%= f.label :to %><br />
-    <%= f.select :to, @accounts.map { |a| ["#{a.name} - #{a.balance}", a.name] }, :selected => f.object.to.try(:name), :include_blank => true %>
-  </div>
-  <div>
-    <%= f.label :amount %><br />
-    <%= f.text_field :amount %>
-  </div>
-  <%= f.submit "Transfer" %>
-<% end %>
-
-
-
-