code_error 0.9.3 → 1.0.0

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: code_error
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Sibevin Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
-dependencies: []
+date: 2014-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: A code-based customized error.
 email:
 - sibevin@gmail.com
@@ -17,18 +31,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - code_error.gemspec
 - lib/code_error.rb
-- lib/code_error/random_token_error.rb
 - lib/code_error/version.rb
 - test/test_all.rb
-- test/test_code_in_msg.rb
 - test/test_config.rb
+- test/test_gen.rb
 - test/test_helper.rb
 - test/test_masked.rb
-- test/test_new.rb
+- test/test_pos.rb
 homepage: https://github.com/sibevin/code_error
 licenses:
 - MIT
@@ -39,36 +53,36 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: 'Inherit CodeError::Base to create your own code-based error. You need to
-  implement the "error_codes" method which provides a hash to define your own error
-  code map.  class MyError < CodeError::Base  private  def error_codes { 20001 =>
-  { status: :failed, msg: ''Purchase information format is incorrect.'' }, 20002 =>
-  { status: :failed, msg: ''Device information format is incorrect.'' }, 20003 =>
-  { status: :failed, msg: ''Unknown store.'' }, 20100 => { status: :duplicated, msg:
-  ''A duplicated IAP request is sent.'' }, 20200 => { status: :retry, msg: ''Client
-  should send the IAP request again.'' } } end end  Raise an error with a code when
-  you need.  raise MyError.new(20001)  Rescue and handle it.  begin #... raise MyError.new(20001)
-  #... rescue MyError => e raise e if e.internal? msg = e.msg code = e.code info =
-  e.info data = e.data case(e.status) when :failed #... when :duplicated #... else
-  #... end #... end  Please see "README" to get more details.'
+  assign "error_codes" with a hash to define your own error code map.  class MyError
+  < CodeError::Base  error_codes({ purchase_info_incorrect: { status: :failed, msg:
+  ''Purchase information format is incorrect.'' }, device_info_incorrect: { status:
+  :failed, msg: ''Device information format is incorrect.'' }, unknown_store: { status:
+  :failed, msg: ''Unknown store.'' }, duplicated_request: { status: :duplicated, msg:
+  ''A duplicated IAP request is sent.'' }, resend_iap: { status: :retry, msg: ''Client
+  should send the IAP request again.'' } })  end  Raise an error with a code when
+  you need.  raise MyError.gen(:purchase_info_incorrect)  Rescue and handle it.  begin
+  #... raise MyError.gen(:purchase_info_incorrect) #... rescue MyError => e raise
+  e if e.internal? msg = e.msg code = e.code info = e.info data = e.data case(e.status)
+  when :failed #... when :duplicated #... else #... end #... end  Please see "README"
+  to get more details.'
 test_files:
 - test/test_all.rb
-- test/test_code_in_msg.rb
 - test/test_config.rb
+- test/test_gen.rb
 - test/test_helper.rb
 - test/test_masked.rb
-- test/test_new.rb
-has_rdoc: 
+- test/test_pos.rb

data/lib/code_error/random_token_error.rb

@@ -1,75 +0,0 @@
-module RandomToken
-
-  # A customized exception for RandomToken
-  class RandomTokenError < StandardError
-
-    # Errors used in RandomToken
-    ERRORS = {
-      :unknown_seed => {
-        :value => 1,
-        :msg => "Unknown given seed"
-      },
-      :not_support_case => {
-        :value => 2,
-        :msg => "Case feature is not supported in this case, but the case option is given."
-      },
-      :not_support_friendly => {
-        :value => 3,
-        :msg => "Friendly feature is not supported in this case, but the friendly option is true."
-      },
-      :false_friendly_with_given_mask => {
-        :value => 4,
-        :msg => "The mask is given but the friendly option is false."
-      },
-      :invalid_strf_pattern => {
-        :value => 5,
-        :msg => "The given pattern is invalid."
-      },
-      :invalid_gen_arg => {
-        :value => 6,
-        :msg => "The given arg is invalid."
-      },
-      :mask_remove_all_seeds => {
-        :value => 7,
-        :msg => "The friendly mask removes all seeds."
-      },
-      :duplicated_option => {
-        :value => 8,
-        :msg => "The same options are given."
-      },
-      :invalid_option_value => {
-        :value => 9,
-        :msg => "The given option value is invalid."
-      },
-    }
-
-    attr_reader :code, :value, :msg, :info
-
-    # The RandomTokenError constructor.
-    # @param error [Fixnum, String]
-    #   You can give a error number defined in the keys of {RandomToken::RandomTokenError::ERRORS} or a string message for internal usage.
-    # @param info [Hash]
-    #   Anything you want to put in the info attribute of RandomTokenError.
-    def initialize(error, info = {})
-      @code = error
-      @info = info
-      if ERRORS.keys.include?(error)
-        @value = ERRORS[error][:value]
-        @msg = ERRORS[error][:msg]
-      elsif error.class.name == 'String'
-        @code = :internal
-        @value = 90000
-        @msg = error
-      else
-        @code = :internal
-        @value = 99999
-        @msg = "Internal Error"
-      end
-    end
-
-    # Override the message method to show more information in RandomTokenError
-    def message
-      "RandomTokenError(#{@code.to_s}): value = #{@value}, msg = #{@msg}, info = #{@info.inspect}"
-    end
-  end
-end

data/test/test_code_in_msg.rb

@@ -1,85 +0,0 @@
-require "test/unit"
-
-$LOAD_PATH.unshift("#{File.dirname(__FILE__)}")
-require "test_helper"
-require "code_error"
-
-class TestCodeInMsg < Test::Unit::TestCase
-
-  ERROR_CODE_1 = 1
-  ERROR_MSG_1 = 'The error message for code 1.'
-  ERROR_STATUS_1 = :failed
-
-  class AppendError < CodeError::Base
-    def error_codes
-      {
-        ERROR_CODE_1 => {
-          status: ERROR_STATUS_1,
-          msg: ERROR_MSG_1,
-        }
-      }
-    end
-
-    def config
-      super.merge({
-        :code_in_msg => :append
-      })
-    end
-  end
-
-  class PrependError < CodeError::Base
-    def error_codes
-      {
-        ERROR_CODE_1 => {
-          status: ERROR_STATUS_1,
-          msg: ERROR_MSG_1,
-        }
-      }
-    end
-
-    def config
-      super.merge({
-        :code_in_msg => :prepand
-      })
-    end
-  end
-
-  class NoneError < CodeError::Base
-    def error_codes
-      {
-        ERROR_CODE_1 => {
-          status: ERROR_STATUS_1,
-          msg: ERROR_MSG_1,
-        }
-      }
-    end
-
-    def config
-      super.merge({
-        :code_in_msg => :none
-      })
-    end
-  end
-
-  def test_code_in_msg_should_return_a_message_with_the_code_appended_after_it_if_append_config_is_given
-    e = AppendError.new(ERROR_CODE_1)
-    assert(e.msg == "#{ERROR_MSG_1}(#{ERROR_CODE_1})")
-  end
-
-  def test_code_in_msg_should_return_a_message_with_the_code_prepended_before_it_if_prepend_config_is_given
-    e = PrependError.new(ERROR_CODE_1)
-    assert(e.msg == "(#{ERROR_CODE_1})#{ERROR_MSG_1}")
-  end
-
-  def test_code_in_msg_should_return_a_message_without_the_code_if_none_config_is_given
-    e = NoneError.new(ERROR_CODE_1)
-    assert(e.msg == "#{ERROR_MSG_1}")
-  end
-
-  def test_code_in_msg_should_return_a_message_without_the_code_if_it_is_a_success_error
-    e = AppendError.new(CodeError::SUCCESS_CODE)
-    assert(e.msg == "#{CodeError::SUCCESS_MSG}")
-    e = PrependError.new(CodeError::SUCCESS_CODE)
-    assert(e.msg == "#{CodeError::SUCCESS_MSG}")
-  end
-end

data/test/test_new.rb

@@ -1,100 +0,0 @@
-require "test/unit"
-
-$LOAD_PATH.unshift("#{File.dirname(__FILE__)}")
-require "test_helper"
-require "code_error"
-
-class TestNew < Test::Unit::TestCase
-
-  class InvalidError < CodeError::Base; end;
-
-  ERROR_CODE_1 = 1
-  ERROR_MSG_1 = 'The error message for code 1.'
-  ERROR_STATUS_1 = :failed
-
-  ERROR_CODE_2 = 2
-  ERROR_MSG_2 = 'The error message for code 2.'
-  ERROR_STATUS_2 = :failed
-
-  ERROR_CODE_UNDEFINED = 55688
-
-  class TestError < CodeError::Base
-    def error_codes
-      {
-        ERROR_CODE_1 => {
-          :status => ERROR_STATUS_1,
-          :msg => ERROR_MSG_1,
-        },
-        ERROR_CODE_2 => {
-          :status => ERROR_STATUS_2,
-          :msg => ERROR_MSG_2,
-          :masked => true
-        }
-      }
-    end
-  end
-
-  def test_new_should_raise_an_exception_if_the_error_codes_is_undefined
-    assert_raise(RuntimeError) { InvalidError.new }
-  end
-
-  def test_new_should_return_the_correspond_data_if_given_code_is_defined
-    e = TestError.new(ERROR_CODE_1)
-    assert(e.code == ERROR_CODE_1)
-    assert(e.status == ERROR_STATUS_1)
-    assert(e.msg == "#{ERROR_MSG_1}(#{ERROR_CODE_1})")
-    assert(e.data == { :code => ERROR_CODE_1,
-                       :status => ERROR_STATUS_1,
-                       :msg => "#{ERROR_MSG_1}(#{ERROR_CODE_1})",
-                       :info => {} })
-    assert(e.message == e.data.inspect)
-    assert(!e.internal?)
-  end
-
-  def test_new_should_return_an_internal_error_with_given_code_if_given_code_is_undefined
-    e = TestError.new(ERROR_CODE_UNDEFINED)
-    assert(e.code == ERROR_CODE_UNDEFINED)
-    assert(e.status == CodeError::INTERNAL_STATUS)
-    assert(e.msg == "#{CodeError::INTERNAL_MSG}(#{ERROR_CODE_UNDEFINED})")
-    assert(e.internal?)
-  end
-
-  def test_new_should_return_an_internal_error_with_given_msg_if_given_code_is_a_string
-    msg = 'An error message.'
-    e = TestError.new(msg)
-    assert(e.code == CodeError::INTERNAL_CODE)
-    assert(e.status == CodeError::INTERNAL_STATUS)
-    assert(e.msg == "#{msg}(#{CodeError::INTERNAL_CODE})")
-    assert(e.internal?)
-  end
-
-  def test_new_should_return_an_success_error_if_given_code_is_a_success_code
-    e = TestError.new(CodeError::SUCCESS_CODE)
-    assert(e.code == CodeError::SUCCESS_CODE)
-    assert(e.status == CodeError::SUCCESS_STATUS)
-    assert(e.msg == "#{CodeError::SUCCESS_MSG}")
-    assert(!e.internal?)
-  end
-
-  def test_new_should_mask_the_msg_if_given_msg_is_masked
-    e = TestError.new(ERROR_CODE_1, :masked)
-    assert(e.code == ERROR_CODE_1)
-    assert(e.status == ERROR_STATUS_1)
-    assert(e.msg == "#{CodeError::MASKED_MSG}(#{ERROR_CODE_1})")
-    assert(!e.internal?)
-  end
-
-  def test_new_should_mask_the_msg_by_default_if_true_masked_config_is_given
-    e = TestError.new(ERROR_CODE_2)
-    assert(e.code == ERROR_CODE_2)
-    assert(e.status == ERROR_STATUS_2)
-    assert(e.msg == "#{CodeError::MASKED_MSG}(#{ERROR_CODE_2})")
-    assert(!e.internal?)
-  end
-
-  def test_new_should_contain_the_info_if_an_info_is_given
-    info = 'some information'
-    e = TestError.new(ERROR_CODE_1, nil, info)
-    assert(e.info == info)
-  end
-end