power_converter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bd5e2306a30c044d98fadc15a1a330cd485f34f
-  data.tar.gz: ebc9c3bed3649bd24f11fa6564e52a088a766d5a
+  metadata.gz: 93f5ce27cd391f22fbebc0a5b98318ebb5e12f79
+  data.tar.gz: 3f45e0e53f6af3fc363577aaa02007095b90bfeb
 SHA512:
-  metadata.gz: 53124e4dc414751702a99c3b8be7d61dc31cc275141ddc9a5a9fe0fa192a9890580c022e8190675932ea1406dbc362fa8b0877b8201f4b6f34f74aedb4b22a84
-  data.tar.gz: 93dae5155d1d25aaecac0c218d75a7fa9b734a3e7cf61663d4a427bf0e546d4a9d6a2e1b72c18dfa312debb6853a87a8c034c21582bf3503faf8628e57d19f0b
+  metadata.gz: 628a695ed189d9ed1b4922c053a42b538ae930bf049b1dd5c7eafa913bbe0b2251affc88a3c2c7731fa4a57836ac2660fb15c0e014d61877b4c8b9ae9737de23
+  data.tar.gz: 58735d7bc79fd56f652cd87f605d48fb931668502e7bccc91f599fed168b75283fefa638928aba38f004010a469ebcb0a0714f1aff5f6de16e9ff1770cbb0006

data/README.md

@@ -2,6 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/power_converter.svg)](http://badge.fury.io/rb/power_converter)
 [![Build Status](https://travis-ci.org/jeremyf/power_converter.png?branch=master)](https://travis-ci.org/jeremyf/power_converter)
+[![Code Climate](https://codeclimate.com/github/jeremyf/power_converter/badges/gpa.svg)](https://codeclimate.com/github/jeremyf/power_converter)
+[![Test Coverage](https://codeclimate.com/github/jeremyf/power_converter/badges/coverage.svg)](https://codeclimate.com/github/jeremyf/power_converter)
 [![Documentation Status](http://inch-ci.org/github/jeremyf/power_converter.svg?branch=master)](http://inch-ci.org/github/jeremyf/power_converter)
 [![APACHE 2 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 

data/lib/power_converter/version.rb

@@ -1,5 +1,5 @@
 # :nodoc:
 module PowerConverter
   # :nodoc:
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/power_converter.rb

@@ -41,8 +41,10 @@ module PowerConverter
     #
     # @example
     #   raise ConversionError.new(:boolean, [:hello, :world])
-    def initialize(value, named_converter)
-      super("Unable to convert #{value.inspect} to '#{named_converter}'.")
+    def initialize(value, options)
+      named_converter = options[:to]
+      scope = options[:scope]
+      super("Unable to convert #{value.inspect} to '#{named_converter}' (scope: #{scope.inspect}.")
     end
   end
 
@@ -127,13 +129,14 @@ module PowerConverter
   #
   def convert(value, options = {})
     named_converter = options.fetch(:to)
+    scope = options.fetch(:scope, nil)
     return value.public_send("to_#{named_converter}") if value.respond_to?("to_#{named_converter}", false)
-    returning_value = converter_for(named_converter).call(value)
+    returning_value = converter_for(named_converter).call(value, *scope)
     return returning_value unless returning_value.nil?
-    fail ConversionError.new(value, named_converter)
+    fail ConversionError.new(value, options)
   end
 
-  # :nodoc:
+  # When building a dynamic conversion method this is its prefix.
   CONVERSION_METHOD_PREFIX = "convert_to_".freeze
 
   # @api public
@@ -196,15 +199,30 @@ module PowerConverter
   # A convenience method for seeing the names of all converters that have been
   # defined.
   #
-  # @return [Array] of the registered converter's names
+  # @return [Array] of the defined converter's names
   def defined_converter_names
     @defined_conversions.keys
   end
 
-  # :nodoc:
-  CONVERSION_METHOD_REGEXP = /\A#{CONVERSION_METHOD_PREFIX}(.*)\Z/.freeze
+  # Useful for when you want to know if a method name is a valid conversion
+  # method name.
+  CONVERSION_METHOD_REGEXP = /\A#{CONVERSION_METHOD_PREFIX}(.+)\Z/.freeze
 
-  # :nodoc:
+  # @api private
+  # @since 0.0.2
+  #
+  # Handle attempts to call module level conversions directly off of the
+  # PowerConverter module.
+  #
+  # @example
+  #   PowerConverter.define_conversion_for(:boolean) { |input| ... }
+  #   PowerConverter.convert_to_boolean(a_value)
+  #
+  # @param method_name [Symbol]
+  # @param args [Array] splat arguements that would be passed on-ward
+  # @param block [#call]
+  #
+  # @see PowerConverter::CONVERSION_METHOD_PREFIX
   def method_missing(method_name, *args, &block)
     named_converter = extract_named_converter_from(method_name)
     if named_converter
@@ -215,14 +233,37 @@ module PowerConverter
   end
   private_class_method :method_missing
 
-  # :nodoc:
+  # @api private
+  # @since 0.0.2
+  #
+  # Based on the given method_name extract the name of a defined converter.
+  #
+  # @param method_name [#to_s] a method name that could be in a named conversion
+  #   method format
+  #
+  # @return [String, nil] Will return the named_converter a match is found,
+  #   otherwise nil
   def extract_named_converter_from(method_name)
     match = method_name.to_s.match(CONVERSION_METHOD_REGEXP)
     match.captures[0] if match
   end
   private_class_method :extract_named_converter_from
 
-  # :nodoc:
+  # @api private
+  # @since 0.0.2
+  #
+  # Determine if the conversion module responds to a potentially registered
+  # conversion method.
+  #
+  # @example
+  #   PowerConverter.define_conversion_for(:boolean) { |input| ... }
+  #   PowerConverter.respond_to?(:convert_to_boolean)
+  #   => true
+  #
+  # @param method_name [Symbol] the name of the method that the object might
+  #   respond to
+  # @param include_private [Boolean] if true skip private/protected methods
+  #   otherwise include them
   def respond_to_missing?(method_name, include_private = false)
     named_converter = extract_named_converter_from(method_name)
     if named_converter

data/power_converter.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.5"
   spec.add_development_dependency "rubocop", "~> 0.2"
+  spec.add_development_dependency "simplecov", "~> 0.9"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_converter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: A lightweight library to define object conversion methods/modules.
 email:
 - jeremy.n.friesen@gmail.com