command_model 1.0.0

data/lib/command_model/version.rb

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

data/spec/model_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+
+class ExampleCommand < CommandModel::Model
+  parameter :name, :presence => true
+end
+
+describe CommandModel::Model do
+  let(:example_command) { ExampleCommand.new :name => "John" }
+  let(:invalid_example_command) { ExampleCommand.new }
+  
+  describe "self.parameter" do
+    let(:klass) { Class.new(CommandModel::Model) }
+    
+    it "creates an attribute reader" do
+      klass.parameter :foo
+      klass.new.methods.should include(:foo)
+    end
+    
+    it "creates an attribute writer" do
+      klass.parameter :foo
+      klass.new.methods.should include(:foo=)
+    end
+    
+    it "round trips values through writing and reading" do
+      klass.parameter :foo
+      instance = klass.new
+      instance.foo = 42
+      instance.foo.should eq(42)
+    end
+    
+    it "accepts multiple attributes" do
+      klass.parameter :foo, :bar
+      klass.new.methods.should include(:foo)
+      klass.new.methods.should include(:foo=)
+      klass.new.methods.should include(:bar)
+      klass.new.methods.should include(:bar=)
+    end
+    
+    it "accepts multiple attributes with typecast" do
+      klass.parameter :foo, :bar, :typecast => "integer"
+      klass.new.methods.should include(:foo)
+      klass.new.methods.should include(:foo=)
+      klass.new.methods.should include(:bar)
+      klass.new.methods.should include(:bar=)
+    end
+    
+    it "accepts multiple attributes with validation" do
+      klass.parameter :foo, :bar, :presence => true
+      klass.new.methods.should include(:foo)
+      klass.new.methods.should include(:foo=)
+      klass.new.methods.should include(:bar)
+      klass.new.methods.should include(:bar=)
+    end
+    
+    it "creates typecasting writer" do
+      klass.send(:define_method, :typecast_42) { |value| 42 }
+      klass.parameter :answer, :typecast => "42"
+      instance = klass.new
+      instance.answer = "foo"
+      instance.answer.should eq(42)
+    end
+    
+    it "creates validations" do
+      instance = ExampleCommand.new
+      instance.should_not be_valid
+      instance.errors[:name].should be_present
+    end    
+  end
+  
+
+  describe "self.execute" do
+    it "accepts object of same kind and returns it" do
+      ExampleCommand.execute(example_command) {}.should eq(example_command)
+    end
+    
+    it "accepts attributes, creates object, and returns it" do
+      c = ExampleCommand.execute(:name => "John") {}
+      c.should be_kind_of(ExampleCommand)
+      c.name.should eq("John")
+    end
+    
+    it "calls passed block when there are no validation errors on Model" do
+      block_ran = false
+      ExampleCommand.execute(example_command) { block_ran = true }
+      block_ran.should eq(true)       
+    end
+    
+    it "does not call passed block when there are validation errors on Model" do
+      block_ran = false
+      ExampleCommand.execute(invalid_example_command) { block_ran = true }
+      block_ran.should eq(false)
+    end
+    
+    it "records execution attempt when there not no validation errors on Model" do
+      ExampleCommand.execute(example_command) {}
+      example_command.execution_attempted?.should eq(true)
+    end
+    
+    it "records execution attempt when there are validation errors on Model" do
+      ExampleCommand.execute(invalid_example_command) {}
+      invalid_example_command.execution_attempted?.should eq(true)
+    end
+    
+    it "is not successful if block adds error to Model" do
+      ExampleCommand.execute(example_command) do |command|
+        command.errors.add :base, "foo"
+      end
+      
+      example_command.should_not be_success
+    end
+  end
+  
+  describe "self.success" do
+    it "creates a successful command model" do
+      response = ExampleCommand.success
+      response.should be_kind_of(ExampleCommand)
+      response.should be_success
+    end
+  end
+  
+  describe "self.failure" do
+    it "creates a command model with an error" do
+      response = ExampleCommand.failure "something broke"
+      response.should be_kind_of(ExampleCommand)
+      response.should_not be_success
+      response.errors[:base].should eq(["something broke"])
+    end
+  end
+  
+
+  describe "initialize" do
+    it "assigns attributes" do
+      m = ExampleCommand.new :name => "John"
+      m.name.should eq("John")
+    end
+  end
+  
+  describe "execution_attempted!" do
+    it "sets execution_attempted? to true" do
+      example_command.execution_attempted!
+      example_command.execution_attempted?.should eq(true)
+    end
+  end
+  
+  describe "success?" do
+    it "is false before execution" do
+      example_command.should_not be_success
+    end
+    
+    it "is false after execution with errors" do
+      example_command.execution_attempted!
+      example_command.errors.add :base, "foo"
+      example_command.success?.should eq(false)
+    end
+    
+    it "is true after execution without errors" do
+      example_command.execution_attempted!
+      example_command.success?.should eq(true)
+    end
+  end
+  
+  describe "typecast_integer" do
+    it "casts to integer when valid string" do
+      example_command.send(:typecast_integer, "42").should eq(42)
+    end
+    
+    it "returns nil when invalid string" do
+      example_command.send(:typecast_integer, "asdf").should be_nil
+      example_command.send(:typecast_integer, nil).should be_nil
+      example_command.send(:typecast_integer, "").should be_nil
+      example_command.send(:typecast_integer, "0.1").should be_nil
+    end
+  end
+  
+  describe "typecast_float" do
+    it "casts to float when valid string" do
+      example_command.send(:typecast_float, "42").should eq(42.0)
+      example_command.send(:typecast_float, "42.5").should eq(42.5)
+    end
+    
+    it "returns nil when invalid string" do
+      example_command.send(:typecast_float, "asdf").should be_nil
+      example_command.send(:typecast_float, nil).should be_nil
+      example_command.send(:typecast_float, "").should be_nil
+    end
+  end
+  
+  describe "typecast_date" do
+    it "casts to date when valid string" do
+      example_command.send(:typecast_date, "01/01/2000").should eq(Date.civil(2000,1,1))
+      example_command.send(:typecast_date, "1/1/2000").should eq(Date.civil(2000,1,1))
+      example_command.send(:typecast_date, "2000-01-01").should eq(Date.civil(2000,1,1))
+    end
+    
+    it "returns existing date unchanged" do
+      date = Date.civil(2000,1,1)
+      example_command.send(:typecast_date, date).should eq(date)
+    end
+    
+    it "returns nil when invalid string" do
+      example_command.send(:typecast_date, "asdf").should be_nil
+      example_command.send(:typecast_date, nil).should be_nil
+      example_command.send(:typecast_date, "").should be_nil
+      example_command.send(:typecast_date, "3/50/1290").should be_nil
+    end
+  end
+  
+  it "includes typecasting errors in validations" do
+    example_command.instance_variable_get(:@typecast_errors)["name"] = "integer"
+    example_command.should_not be_valid
+    example_command.errors["name"].should be
+  end
+  
+  it "does not include typecasting error in validations if the attribute already has an error" do
+    invalid_example_command.instance_variable_get(:@typecast_errors)["name"] = "integer"
+    invalid_example_command.should_not be_valid
+    invalid_example_command.errors["name"].should be
+    invalid_example_command.errors["name"].find { |e| e =~ /integer/ }.should_not be
+  end
+  
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'command_model'
+require 'rspec'

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: command_model
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jack Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &15163980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15163980
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &15163060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *15163060
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &15162120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *15162120
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &15161240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *15161240
+description: CommandModel - when update_attributes isn't enough.
+email:
+- jack@jackchristensen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- command_model.gemspec
+- examples/bank/.gitignore
+- examples/bank/Gemfile
+- examples/bank/README.rdoc
+- examples/bank/Rakefile
+- examples/bank/app/assets/images/rails.png
+- examples/bank/app/assets/javascripts/accounts.js.coffee
+- examples/bank/app/assets/javascripts/application.js
+- examples/bank/app/assets/stylesheets/accounts.css.scss
+- examples/bank/app/assets/stylesheets/application.css
+- examples/bank/app/controllers/accounts_controller.rb
+- examples/bank/app/controllers/application_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/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/config.ru
+- examples/bank/config/application.rb
+- examples/bank/config/boot.rb
+- examples/bank/config/environment.rb
+- examples/bank/config/environments/development.rb
+- examples/bank/config/environments/production.rb
+- examples/bank/config/environments/test.rb
+- examples/bank/config/initializers/accounts.rb
+- examples/bank/config/initializers/backtrace_silencers.rb
+- examples/bank/config/initializers/inflections.rb
+- examples/bank/config/initializers/mime_types.rb
+- examples/bank/config/initializers/secret_token.rb
+- examples/bank/config/initializers/session_store.rb
+- examples/bank/config/initializers/wrap_parameters.rb
+- examples/bank/config/locales/en.yml
+- examples/bank/config/routes.rb
+- examples/bank/db/seeds.rb
+- examples/bank/lib/assets/.gitkeep
+- examples/bank/lib/tasks/.gitkeep
+- examples/bank/log/.gitkeep
+- examples/bank/public/404.html
+- examples/bank/public/422.html
+- examples/bank/public/500.html
+- examples/bank/public/favicon.ico
+- examples/bank/public/robots.txt
+- examples/bank/script/rails
+- examples/bank/test/fixtures/.gitkeep
+- examples/bank/test/functional/.gitkeep
+- examples/bank/test/functional/accounts_controller_test.rb
+- examples/bank/test/integration/.gitkeep
+- examples/bank/test/performance/browsing_test.rb
+- examples/bank/test/test_helper.rb
+- examples/bank/test/unit/.gitkeep
+- examples/bank/test/unit/helpers/accounts_helper_test.rb
+- examples/bank/vendor/assets/javascripts/.gitkeep
+- examples/bank/vendor/assets/stylesheets/.gitkeep
+- examples/bank/vendor/plugins/.gitkeep
+- lib/command_model.rb
+- lib/command_model/model.rb
+- lib/command_model/version.rb
+- spec/model_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/JackC/command_model
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: CommandModel integrates Rails validations with command objects. This allows
+  errors from command execution to easily be handled with the familiar Rails validation
+  system.
+test_files:
+- spec/model_spec.rb
+- spec/spec_helper.rb