power_converter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9af949b836d81ad21409034d5ed9c4afc7a4ba78
-  data.tar.gz: 3ceae004ad7dfe14efec14805ead1e8434cddd24
+  metadata.gz: 46a424e45fa5ebb32f2e1557980b89967c9a6db3
+  data.tar.gz: 7ccecfc19c6d9e779d7b4e50e0e67139d6a98373
 SHA512:
-  metadata.gz: e87246d16e6875e248e7bea55fa7f8dd8634781bff0d1e50a09b849e6302c351b4005c3ef912c257fbee71571d8eb3289b00ccd7ae21f2dfb0b87a5e95f6144e
-  data.tar.gz: eb093b614b5385916db8e2307945e076403ccf246453972a40cdc71f52b594b4fc291f8e9a5948967e7b5fe1b5ec7b02e8dcd7f747221a2956a898f82c28db07
+  metadata.gz: 9cf362ee48fa1d258a795a84136502e547237edd0324e1f645d6fa7e8e282cbb4815f8f22715bf8ac628e279f84fe8240945f1153c0d2eb1840600f4804ad043
+  data.tar.gz: f2cbd9f9eac056c661dfed996fb9cd94616703dab897d4e85b8aa385bafe19eed3d4eb9b07bcc743df69b4ea5201539c9961a79dd454425319d63b1abf7705fc

data/README.md

@@ -11,6 +11,26 @@
 
 **PowerConverter** exposes a means for defining a named conversion method.
 
+## Brief Example
+
+```ruby
+PowerConverter.define_conversion_for(:boolean) do |input|
+  case input
+  when false, 0, '0', /\A(false|no)\Z/i, nil then false
+  when String
+    input.empty? ? nil : true
+  else
+    true
+  end
+end
+
+expect(PowerConverter.convert('no', to: :boolean)).to eq(false)
+expect(PowerConverter.convert('yes', to: :boolean)).to eq(true)
+expect { PowerConverter.convert('', to: :boolean) }.to raise_error(PowerConverter::ConversionError)
+```
+
+## Details
+
 *What is a conversion method?*
 
 > A well-established Ruby idiom for methods which "do the right thing" to
@@ -44,18 +64,63 @@ reduces the number surprises when interacting with conversion methods.
 
 ## Usage
 
+Name and define conversions via a block.
+
+```ruby
+PowerConverter.define_conversion_for(:always_true) { true }
+PowerConverter.define_conversion_for(:always_nil) { nil }
+PowerConverter.define_conversion_for(:boolean) { |value| !!value }
+```
+
+Call the conversions via a couple of methods:
+
+```ruby
+PowerConverter.convert(nil, to: :always_true)
+# or
+PowerConverter.convert_to_always_true(nil)
+```
+
+When you call a conversion, if the conversion block evaluates to `nil`, PowerConverter will fail with a `PowerConverter::ConversionError` exception.
+
 ```ruby
-PowerConverter.define_conversion_for :boolean do |input|
+assert_raises(PowerConverter::ConversionError) { PowerConverter.convert(true, to: :always_nil) }
+```
+
+If you call the conversion and pass a block, the block will be the fallback for an evaluated `nil`.
+
+```ruby
+assert_equal('FALLBACK', PowerConverter.convert(true, to: :always_nil) { 'FALLBACK'} )
+```
+
+If the object you are attempting to convert responds to the `to_<conversion_name>` method, that method will be called.
+
+```ruby
+Thing = Struct.new(:to_always_nil)
+thing = Thing.new("result of to_always_nil")
+assert_equal("result of to_always_nil", PowerConverter.convert(thing, to: :always_nil))
+```
+
+You can also declare an alias for a registered `PowerConverter`.
+
+```ruby
+PowerConverter.define_alias(:true_or_false, is_alias_of: :boolean)
+PowerConverter.convert("Hello", to: :boolean)
+```
+
+At times, a conversion may need additional information to be successful.
+
+```ruby
+PowerConverter.define_conversion_for(:user_action) do |input, user|
   case input
-  when false, 0, '0', 'false', 'no', nil then false
-  else
-    true
+  when String, Symbol then user.actions.find_by(name: input)
+  when Model::Action
+    input.user == user ? input : nil
   end
 end
 
-PowerConverter.convert(object, to: :boolean)
+PowerConverter.convert('start', to: :user_action, scope: a_user)
+```
 
-# OR
+### TODO
 
-PowerConverter.convert_to_boolean(object)
-```
+* Write about module declaration

data/lib/power_converter.rb

@@ -159,7 +159,7 @@ module PowerConverter
     returning_value = converter_for(named_converter).call(value, *scope)
     return returning_value unless returning_value.nil?
     return yield if block_given?
-    fail ConversionError.new(value, options)
+    raise ConversionError.new(value, options)
   end
 
   # When building a dynamic conversion method this is its prefix.
@@ -219,7 +219,7 @@ module PowerConverter
     key = named_conversion.to_s
     return defined_conversions[key] if defined_conversions.key?(key)
     return converter_for(aliased_conversions[key]) if aliased_conversions.key?(key)
-    fail ConverterNotFoundError.new(named_conversion, defined_converter_names)
+    raise ConverterNotFoundError.new(named_conversion, defined_converter_names)
   end
 
   # @api public
@@ -249,13 +249,14 @@ module PowerConverter
   #
   # @param method_name [Symbol]
   # @param args [Array] splat arguements that would be passed on-ward
+  # @param kwargs [Hash] keyword arguements
   # @param block [#call]
   #
   # @see PowerConverter::CONVERSION_METHOD_PREFIX
-  def method_missing(method_name, *args, &block)
+  def method_missing(method_name, *args, **kwargs, &block)
     named_converter = extract_named_converter_from(method_name)
     if named_converter
-      convert(*args, to: named_converter, &block)
+      convert(*args, kwargs.merge(to: named_converter), &block)
     else
       super
     end

data/lib/power_converter/version.rb

@@ -2,5 +2,5 @@
 # :nodoc:
 module PowerConverter
   # :nodoc:
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_converter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A lightweight library to define object conversion methods/modules.