necromancer 0.3.0 → 0.4.0

data/lib/necromancer.rb

@@ -1,21 +1,7 @@
-# coding: utf-8
+# encoding: utf-8
 
-require 'forwardable'
-require 'date'
-require 'set'
-
-require 'necromancer/conversions'
-require 'necromancer/configuration'
-require 'necromancer/context'
-require 'necromancer/converter'
-require 'necromancer/null_converter'
-require 'necromancer/converters/array'
-require 'necromancer/converters/boolean'
-require 'necromancer/converters/date_time'
-require 'necromancer/converters/numeric'
-require 'necromancer/converters/range'
-require 'necromancer/conversion_target'
-require 'necromancer/version'
+require_relative 'necromancer/context'
+require_relative 'necromancer/version'
 
 module Necromancer
   # Raised when cannot conver to a given type
@@ -35,6 +21,18 @@ module Necromancer
   def new(&block)
     Context.new(&block)
   end
-
   module_function :new
+
+  # Convenience to directly call conversion
+  #
+  # @example
+  #   Necromancer.convert('1').to(:integer)
+  #
+  # @return [ConversionTarget]
+  #
+  # @api public
+  def convert(*args, &block)
+    Context.new.convert(*args, &block)
+  end
+  module_function :convert
 end # Necromancer

data/lib/necromancer/context.rb

@@ -1,4 +1,10 @@
-# coding: utf-8
+# encoding: utf-8
+
+require 'forwardable'
+
+require_relative 'configuration'
+require_relative 'conversions'
+require_relative 'conversion_target'
 
 module Necromancer
   # A class used by Necromancer to provide user interace
@@ -71,6 +77,13 @@ module Necromancer
       false
     end
 
+    # Inspect this context
+    #
+    # @api public
+    def inspect
+      %(#<#{self.class}@#{object_id} @config=#{configuration}>)
+    end
+
     protected
 
     attr_reader :conversions

data/lib/necromancer/conversion_target.rb

@@ -19,13 +19,13 @@ module Necromancer
     def self.for(context, value, block)
       if UndefinedValue.equal?(value)
         unless block
-          fail ArgumentError,
-               'You need to pass either argument or a block to `convert`.'
+          raise ArgumentError,
+                'You need to pass either argument or a block to `convert`.'
         end
         new(context, block.call)
       elsif block
-        fail ArgumentError,
-             'You cannot pass both an argument and a block to `convert`.'
+        raise ArgumentError,
+              'You cannot pass both an argument and a block to `convert`.'
       else
         new(context, value)
       end
@@ -49,27 +49,44 @@ module Necromancer
     # @example
     #   converter.convert('1').to(:numeric)  # => 1
     #
+    # @example
+    #   converter.convert('1') >> Integer # => 1
+    #
     # @return [Object]
     #   the converted target type
     #
     # @api public
     def to(target, options = {})
-      conversion = conversions[source || detect(object), detect(target)]
+      conversion = conversions[source || detect(object, false), detect(target)]
       conversion.call(object, options)
     end
+    alias >> to
+
+    # Inspect this conversion
+    #
+    # @api public
+    def inspect
+      %(#<#{self.class}@#{object_id} @object=#{object}, @source=#{detect(object)}>)
+    end
 
     protected
 
-    # Detect object type
+    # Detect object type and coerce into known key type
+    #
+    # @param [Object] object
     #
     # @api private
-    def detect(object)
+    def detect(object, symbol_as_object = true)
       case object
       when TrueClass, FalseClass then :boolean
-      when Fixnum, Bignum then :integer
-      when Symbol then object
+      when Integer then :integer
+      when Class   then object.name.downcase
       else
-        object.class.name.downcase
+        if object.is_a?(Symbol) && symbol_as_object
+          object
+        else
+          object.class.name.downcase
+        end
       end
     end
 

data/lib/necromancer/conversions.rb

@@ -1,4 +1,12 @@
-# coding: utf-8
+# encoding: utf-8
+
+require_relative 'configuration'
+require_relative 'converter'
+require_relative 'converters/array'
+require_relative 'converters/boolean'
+require_relative 'converters/date_time'
+require_relative 'converters/numeric'
+require_relative 'converters/range'
 
 module Necromancer
   # Represents the context used to configure various converters
@@ -14,9 +22,9 @@ module Necromancer
     #   conversion = Necromancer::Conversions.new
     #
     # @api public
-    def initialize(configuration = Configuration.new)
+    def initialize(configuration = Configuration.new, map = {})
       @configuration = configuration
-      @converter_map = {}
+      @converter_map = map.dup
     end
 
     # Load converters
@@ -45,22 +53,22 @@ module Necromancer
     def [](source, target)
       key = "#{source}#{DELIMITER}#{target}"
       converter_map[key] ||
-      converter_map["object->#{target}"] ||
-      fail_no_type_conversion_available(key)
+        converter_map["object#{DELIMITER}#{target}"] ||
+        raise_no_type_conversion_available(key)
     end
+    alias fetch []
 
-    # Fail with conversion error
+    # Register a converter
     #
-    # @api private
-    def fail_no_type_conversion_available(key)
-      fail NoTypeConversionAvailableError, "Conversion '#{key}' unavailable."
-    end
-
     # @example with simple object
-    #
+    #   conversions.register NullConverter.new(:array, :array)
     #
     # @example with block
-    #
+    #   conversions.register do |c|
+    #     c.source = :array
+    #     c.target = :array
+    #     c.convert = -> { |val, options| val }
+    #   end
     #
     # @api public
     def register(converter = nil, &block)
@@ -72,12 +80,24 @@ module Necromancer
       true
     end
 
+    # Export all the conversions as hash
+    #
+    # @return [Hash[String, String]]
+    #
+    # @api public
     def to_hash
       converter_map.dup
     end
 
     protected
 
+    # Fail with conversion error
+    #
+    # @api private
+    def raise_no_type_conversion_available(key)
+      raise NoTypeConversionAvailableError, "Conversion '#{key}' unavailable."
+    end
+
     # @api private
     def generate_key(converter)
       parts = []

data/lib/necromancer/converter.rb

@@ -1,4 +1,6 @@
-# coding: utf-8
+# encoding: utf-8
+
+require_relative 'configuration'
 
 module Necromancer
   # Abstract converter used internally as a base for other converters

data/lib/necromancer/converters/array.rb

@@ -1,4 +1,8 @@
-# coding: utf-8
+# encoding: utf-8
+
+require 'set'
+
+require_relative '../converter'
 
 module Necromancer
   # Container for Array converter classes

data/lib/necromancer/converters/boolean.rb

@@ -1,4 +1,7 @@
-# coding: utf-8
+# encoding: utf-8
+
+require_relative '../converter'
+require_relative '../null_converter'
 
 module Necromancer
   # Container for Boolean converter classes

data/lib/necromancer/converters/date_time.rb

@@ -1,10 +1,25 @@
-# coding: utf-8
+# encoding: utf-8
+
+require 'date'
+require 'time'
+
+require_relative '../converter'
+require_relative '../null_converter'
 
 module Necromancer
   # Container for Date converter classes
   module DateTimeConverters
     # An object that converts a String to a Date
     class StringToDateConverter < Converter
+      # Convert a string value to a Date
+      #
+      # @example
+      #   converter.call("1-1-2015")    # => "2015-01-01"
+      #   converter.call("01/01/2015")  # => "2015-01-01"
+      #   converter.call("2015-11-12")  # => "2015-11-12"
+      #   converter.call("12/11/2015")  # => "2015-11-12"
+      #
+      # @api public
       def call(value, options = {})
         strict = options.fetch(:strict, config.strict)
         Date.parse(value)
@@ -15,6 +30,13 @@ module Necromancer
 
     # An object that converts a String to a DateTime
     class StringToDateTimeConverter < Converter
+      # Convert a string value to a DateTime
+      #
+      # @example
+      #  converer.call("1-1-2015")           # => "2015-01-01T00:00:00+00:00"
+      #  converer.call("1-1-2015 15:12:44")  # => "2015-01-01T15:12:44+00:00"
+      #
+      # @api public
       def call(value, options = {})
         strict = options.fetch(:strict, config.strict)
         DateTime.parse(value)
@@ -23,11 +45,33 @@ module Necromancer
       end
     end
 
+    class StringToTimeConverter < Converter
+      # Convert a String value to a Time value
+      #
+      # @param [String] value
+      #   the value to convert
+      #
+      # @example
+      #   converter.call("01-01-2015")       # => 2015-01-01 00:00:00 +0100
+      #   converter.call("01-01-2015 08:35") # => 2015-01-01 08:35:00 +0100
+      #   converter.call("12:35")            # => 2015-01-04 12:35:00 +0100
+      #
+      # @api public
+      def call(value, options = {})
+        strict = options.fetch(:strict, config.strict)
+        Time.parse(value)
+      rescue
+        strict ? fail_conversion_type(value) : value
+      end
+    end
+
     def self.load(conversions)
       conversions.register StringToDateConverter.new(:string, :date)
       conversions.register NullConverter.new(:date, :date)
       conversions.register StringToDateTimeConverter.new(:string, :datetime)
       conversions.register NullConverter.new(:datetime, :datetime)
+      conversions.register StringToTimeConverter.new(:string, :time)
+      conversions.register NullConverter.new(:time, :time)
     end
   end # DateTimeConverters
 end # Necromancer

data/lib/necromancer/converters/numeric.rb

@@ -1,4 +1,7 @@
-# coding: utf-8
+# encoding: utf-8
+
+require_relative '../converter'
+require_relative '../null_converter'
 
 module Necromancer
   # Container for Numeric converter classes

data/lib/necromancer/converters/range.rb

@@ -1,4 +1,7 @@
-# coding: utf-8
+# encoding: utf-8
+
+require_relative '../converter'
+require_relative '../null_converter'
 
 module Necromancer
   # Container for Range converter classes

data/lib/necromancer/null_converter.rb

@@ -1,4 +1,6 @@
-# coding: utf-8
+# encoding: utf-8
+
+require_relative 'converter'
 
 module Necromancer
   # A pass through converter

data/lib/necromancer/version.rb

@@ -1,5 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
 
 module Necromancer
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end # Necromancer

data/necromancer.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['']
   spec.summary       = %q{Conversion from one object type to another with a bit of black magic.}
   spec.description   = %q{Conversion from one object type to another with a bit of black magic.}
-  spec.homepage      = 'https://github.com/peter-murach/necromancer'
+  spec.homepage      = 'https://github.com/piotrmurach/necromancer'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,4 +18,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
 end

data/spec/unit/can_spec.rb

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-require 'spec_helper'
+# encoding: utf-8
 
 RSpec.describe Necromancer, 'can?' do
   it "checks if conversion is possible" do

data/spec/unit/config_spec.rb

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-require 'spec_helper'
+# encoding: utf-8
 
 RSpec.describe Necromancer, 'config' do
   it "configures global settings per instance" do

data/spec/unit/configuration/new_spec.rb

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-require 'spec_helper'
+# encoding: utf-8
 
 RSpec.describe Necromancer::Configuration, '.new' do
 

data/spec/unit/conversions/fetch_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+RSpec.describe Necromancer::Conversions, '#fetch' do
+  it "retrieves conversion given source & target" do
+    converter = double(:converter)
+    conversions = described_class.new nil, {'string->array' => converter}
+    expect(conversions['string', 'array']).to eq(converter)
+  end
+
+  it "fails to find conversion" do
+    conversions = described_class.new
+    expect {
+      conversions['string', 'array']
+    }.to raise_error(Necromancer::NoTypeConversionAvailableError)
+  end
+end

data/spec/unit/conversions/register_spec.rb

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-require 'spec_helper'
+# encoding: utf-8
 
 RSpec.describe Necromancer::Conversions, '.register' do
   it "allows to register converter" do
@@ -35,6 +33,17 @@ RSpec.describe Necromancer::Conversions, '.register' do
     expect(conversions[:string, :upcase].call('magic')).to eq('MAGIC')
   end
 
+  it "allows to register anonymous converter with class names" do
+    conversions = described_class.new
+
+    conversions.register do |c|
+      c.source= String
+      c.target= Array
+      c.convert = proc { |value| Array(value) }
+    end
+    expect(conversions[String, Array].call('magic')).to eq(['magic'])
+  end
+
   it "allows to register custom converter" do
     conversions = described_class.new
     UpcaseConverter = Struct.new(:source, :target) do