command_model 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9c234ff1d2187845e8ddfb8519dea6b8720ba3f1
-  data.tar.gz: f4cedf7d82ad147e6fbb03c78dd726adad00e60a
+SHA256:
+  metadata.gz: 8af8e3bf9074e89aafc9b7e880eb7c99780a9189f822a6a030c8867a3429b0c7
+  data.tar.gz: 225ab899fa949b25dcbda27e9dac739227f8992d68ea0109afa99e36726f08bd
 SHA512:
-  metadata.gz: 290dee4afb160dedcc680b854089fb9ffc287a78253716c28b748e643f32a672fc88efa2e4a5e368e72eb5e6c30e10dd9ed28c3871f06671fd64e7906760d630
-  data.tar.gz: 71a368f028369951e5df902ee599dd5df37f17c14bcbc412496040a043b8a47c9073dd0f8b38cf71024f9e41dbd384f5af624f06ae762ad256dc4edd8f0ef2f7
+  metadata.gz: 1d01d13237af6fda7df4e9002a71fb029558bd1bc114dc7bdfa1f54f288f80fdf76e744550f0a49292f2bd94fd9f13cf9c65870ab0be75af23f041ff148ae8a3
+  data.tar.gz: 43a0c62d7d985aff56a7875c84eafb862e9b92e40e0728ae67e468021590e5e4cdb3f6454d05cd27647432312e5bb197ed259d7b0c640f602715b1d0d7ff801b

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 1.9.3
+  - 2.5.0
+  - 2.4.3
 gemfile:
-  - gemfiles/3.2.gemfile
-  - gemfiles/4.0.gemfile
-  - gemfiles/4.1.gemfile
+  - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/jackc/command_model.svg)](https://travis-ci.org/jackc/command_model)
+
 # CommandModel
 
 CommandModel is an ActiveModel based class that encapsulates the user
@@ -13,15 +15,15 @@ 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
-    
+
 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. 
-    
+know if the command succeeded? CommandModel solves these problems.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -47,7 +49,7 @@ request.
         presence: true,
         numericality: { greater_than: 0, less_than_or_equal_to: 500 }
     end
-    
+
 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 block is free to do
@@ -57,7 +59,7 @@ failed. Finally, the call method will return self.
 
     class Account
       # ...
-      
+
       def withdraw(args)
         WithdrawCommand.new(args).call do |command|
           if balance >= command.amount
@@ -67,14 +69,14 @@ failed. Finally, the call method will return self.
           end
         end
       end
-      
+
       # ...
     end
-    
+
 Use example:
 
     response = account.withdraw amount: 50
-    
+
     if response.success?
       puts "Success!"
     else
@@ -128,6 +130,10 @@ integration of Rails form helpers and validations with CommandModel.
 
 ## Version History
 
+* 1.3 - February 13, 2018
+    * Add decimal type cast
+* 1.2 - October 24, 2014
+    * Suport Rails 4
 * 1.1 - November 13, 2012
     * Updated documentation and example application
     * Refactored Model to support internal domain logic easier with #call and #execute.

data/command_model.gemspec

@@ -15,12 +15,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CommandModel::VERSION
 
-  gem.add_dependency 'activemodel', "> 3.2"
+  gem.add_dependency 'activemodel', "> 4.2"
 
-  gem.add_development_dependency 'rake', "~> 10.1.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'
+  gem.add_development_dependency 'rake', "~> 11.3.0"
+  gem.add_development_dependency 'rspec', "~> 2.14.1"
+  gem.add_development_dependency 'guard', "~> 2.14.2"
+  gem.add_development_dependency 'guard-rspec', "~> 3.1.0"
+  gem.add_development_dependency 'rb-fsevent', '~> 0.10.2'
 
 end

data/gemfiles/{4.0.gemfile → 4.2.gemfile}

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem "activemodel", "~> 4.0.0"
+gem "activemodel", "~> 4.2.0"
 
 gemspec :path=>"../"

data/gemfiles/{4.1.gemfile → 5.0.gemfile}

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem "activemodel", "~> 4.1.0"
+gem "activemodel", "~> 5.0.0"
 
 gemspec :path=>"../"

data/gemfiles/{3.2.gemfile → 5.1.gemfile}

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem "activemodel", "~> 3.2.13"
+gem "activemodel", "~> 5.1.0"
 
 gemspec :path=>"../"

data/lib/command_model/model.rb

@@ -5,7 +5,7 @@ module CommandModel
     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.
     #
@@ -32,7 +32,7 @@ module CommandModel
 
       args.each do |name|
         attr_reader name
-        
+
         if typecast
           attr_typecasting_writer name, typecast
         else
@@ -47,10 +47,10 @@ module CommandModel
     def self.parameters
       @parameters ||= []
     end
-    
+
     def self.attr_typecasting_writer(name, target_type) #:nodoc
       eval <<-END_EVAL
-        def #{name}=(value)
+        public def #{name}=(value)
           typecast_value = typecast_#{target_type}(value)
           if typecast_value
             @typecast_errors.delete("#{name}")
@@ -59,12 +59,12 @@ module CommandModel
             @typecast_errors["#{name}"] = "#{target_type}"
             @#{name} = value
           end
-          
+
           @#{name}
         end
       END_EVAL
     end
-    
+
     # Executes a block of code if the command model is valid.
     #
     # Accepts either a command model or a hash of attributes with which to
@@ -85,10 +85,10 @@ module CommandModel
       else
         new(attributes_or_command)
       end
-      
+
       command.call &block
     end
-    
+
     # Quickly create a successful command object. This is used when the
     # command takes no parameters to want to take advantage of the success?
     # and errors properties of a command object.
@@ -97,7 +97,7 @@ module CommandModel
         instance.execution_attempted!
       end
     end
-    
+
     # Quickly create a failed command object. Requires one parameter with
     # the description of what went wrong. This is used when the
     # command takes no parameters to want to take advantage of the success?
@@ -108,7 +108,7 @@ module CommandModel
         instance.errors.add(:base, error)
       end
     end
-    
+
     # 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.
@@ -139,12 +139,12 @@ module CommandModel
     def execution_attempted! #:nodoc:
       @execution_attempted = true
     end
-    
+
     # True if execution has been attempted on this command
     def execution_attempted?
       @execution_attempted
     end
-    
+
     # Command has been executed without errors
     def success?
       execution_attempted? && errors.empty?
@@ -164,15 +164,15 @@ module CommandModel
         send "#{k}=", v
       end
     end
-    
+
     #:nodoc:
     def persisted?
       false
     end
-    
+
     private
       def extract_parameters_from_hash_or_instance(hash_or_instance)
-        if hash_or_instance.respond_to?(:parameters) 
+        if hash_or_instance.respond_to?(:parameters)
           hash_or_instance.parameters
         else
           hash_or_instance
@@ -182,11 +182,15 @@ module CommandModel
       def typecast_integer(value)
         Integer(value) rescue nil
       end
-      
+
+      def typecast_decimal(value)
+        BigDecimal(value, 16) rescue nil
+      end
+
       def typecast_float(value)
         Float(value) rescue nil
       end
-      
+
       def typecast_date(value)
         return value if value.kind_of? Date
         value = value.to_s
@@ -196,7 +200,7 @@ module CommandModel
           Date.strptime(value, "%m/%d/%Y") rescue nil
         end
       end
-      
+
       def include_typecasting_errors
         @typecast_errors.each do |attribute, target_type|
           unless errors[attribute].present?
@@ -204,7 +208,7 @@ module CommandModel
           end
         end
       end
-      
+
       # overriding this to make typecasting errors run at the end so they will
       # not run if there is already an error on the column. Otherwise, when
       # typecasting to an integer and using validates_numericality_of two

data/lib/command_model/version.rb

@@ -1,3 +1,3 @@
 module CommandModel
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/model_spec.rb

@@ -8,27 +8,27 @@ 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)
@@ -36,7 +36,7 @@ describe CommandModel::Model do
       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)
@@ -44,7 +44,7 @@ describe CommandModel::Model do
       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)
@@ -52,7 +52,7 @@ describe CommandModel::Model do
       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"
@@ -60,12 +60,12 @@ describe CommandModel::Model do
       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
   end
 
   describe "self.parameters" do
@@ -87,44 +87,44 @@ describe CommandModel::Model 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)       
+      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
@@ -132,7 +132,7 @@ describe CommandModel::Model do
       response.should be_success
     end
   end
-  
+
   describe "self.failure" do
     it "creates a command model with an error" do
       response = ExampleCommand.failure "something broke"
@@ -141,7 +141,7 @@ describe CommandModel::Model do
       response.errors[:base].should eq(["something broke"])
     end
   end
-  
+
 
   describe "initialize" do
     it "assigns parameters from hash" do
@@ -190,25 +190,25 @@ describe CommandModel::Model do
       expect(block_arg).to eq(example_command)
     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)
@@ -240,12 +240,12 @@ describe CommandModel::Model do
       expect(example_command.title).to eq("Boss")
     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
@@ -253,32 +253,53 @@ describe CommandModel::Model do
       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_decimal" do
+    it "converts to BigDecimal when valid string" do
+      example_command.send(:typecast_decimal, "42").should eq(BigDecimal("42"))
+      example_command.send(:typecast_decimal, "42.5").should eq(BigDecimal("42.5"))
+    end
+
+    it "converts to BigDecimal when float" do
+      example_command.send(:typecast_decimal, 42.0).should eq(BigDecimal("42"))
+    end
+
+    it "converts to BigDecimal when int" do
+      example_command.send(:typecast_decimal, 42).should eq(BigDecimal("42"))
+    end
+
+    it "returns nil when invalid string" do
+      example_command.send(:typecast_decimal, "asdf").should be_nil
+      example_command.send(:typecast_decimal, nil).should be_nil
+      example_command.send(:typecast_decimal, "").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
@@ -286,19 +307,19 @@ describe CommandModel::Model do
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_model
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jack Christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,84 +16,84 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 11.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 11.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 2.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 2.14.2
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.2
 description: CommandModel - when update_attributes isn't enough.
 email:
 - jack@jackchristensen.com
@@ -170,9 +170,9 @@ files:
 - examples/bank/vendor/assets/javascripts/.gitkeep
 - examples/bank/vendor/assets/stylesheets/.gitkeep
 - examples/bank/vendor/plugins/.gitkeep
-- gemfiles/3.2.gemfile
-- gemfiles/4.0.gemfile
-- gemfiles/4.1.gemfile
+- gemfiles/4.2.gemfile
+- gemfiles/5.0.gemfile
+- gemfiles/5.1.gemfile
 - lib/command_model.rb
 - lib/command_model/model.rb
 - lib/command_model/version.rb
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: CommandModel integrates Rails validations with command objects. This allows