necromancer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9c37da594bf2020bd875ad6a46514c1d20b7d23
+  data.tar.gz: f351c2bbbd62d9f4780306897ea5f09983607af7
+SHA512:
+  metadata.gz: 71b242fd171277c210324744d09d80702af4f718c675f747b997bfb8ec1bb9525c2f9a4bb4de5c6a5de6a2605248e02b576956a31cfd3cc7fb51ea2bb6bf1988
+  data.tar.gz: 2a0cfcb08fb44936ad433903a2d12024d31f615b8fafcbc3100c2a0ab56c253e6d96c9432373ce1c9cd74a47bab2ab948bcae886874824936885641fbeeb54f8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--warnings

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+bundler_args: --without yard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - jruby-19mode
+  - rbx-2
+matrix:
+  include:
+    - rvm: jruby-head
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+branches:
+  only: master

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake',  '~> 10.3.2'
+  gem 'rspec', '~> 3.1.0'
+  gem 'yard',  '~> 0.8.7'
+  gem 'benchmark-ips', '~> 2.0.0'
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.7.0'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.9'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotr Murach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,141 @@
+# Necromancer
+[![Gem Version](https://badge.fury.io/rb/necromancer.png)][gem]
+[![Build Status](https://secure.travis-ci.org/peter-murach/necromancer.png?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/peter-murach/necromancer.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/peter-murach/necromancer/badge.png)][coverage]
+
+[gem]: http://badge.fury.io/rb/necromancer
+[travis]: http://travis-ci.org/peter-murach/necromancer
+[codeclimate]: https://codeclimate.com/github/peter-murach/necromancer
+[coverage]: https://coveralls.io/r/peter-murach/necromancer
+
+> Conversion from one object type to another with a bit of black magic.
+
+**Necromancer** provides independent type conversion component for [TTY](https://github.com/peter-murach/tty) toolkit.
+
+## Features
+
+* Simple and expressive API
+* Ability to specify own converters
+* Support conversion of custom defined types
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'necromancer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install necromancer
+
+## Contents
+
+* [1. Usage](#1-usage)
+* [2. Interface](#2-interface)
+  * [2.1 convert](#21-convert)
+  * [2.1 can?](#22-can)
+* [3. Converters](#3-converters)
+
+## 1. Usage
+
+**Necromancer** requires you to instatiate it like so:
+
+```ruby
+converter = Necromancer.new
+```
+
+Once initialize **Necromancer** knows how to handle numerous conversions.
+
+For example, to convert a string to a range type:
+
+```ruby
+converter.convert('1-10').to(:range)  # => 1..10
+```
+
+In order to handle boolean conversions:
+
+```ruby
+converter.convert('t').to(:boolean)   # => true
+```
+
+or get array elements into numeric type:
+
+```ruby
+converter.convert(['1', '2.3', '3.0']).to(:numeric)  # => [1, 2.3, 3.0]
+```
+
+However, if you want to tell **Necromancer** about source type use `from`:
+
+```ruby
+converter.convert(['1', '2.3', '3.0']).from(:array).to(:numeric) # => [1, 2.3, 3.0]
+```
+
+## 2. Interaface
+
+### 2.1 convert
+
+### 2.2 can?
+
+To verify that a a given conversion can be handled by **Necormancer** call `can?` with the `source` and `target` of the desired conversion.
+
+```ruby
+converter = Necromancer.new
+converter.can?(:string, :integer)   # => true
+converter.can?(:unknown, :integer)  # => false
+```
+
+## 3. Converters
+
+### 3.1 Custom
+
+### 3.2 Array
+
+```ruby
+converter.convert(['1', '2.3', '3.0']).to(:numeric)
+```
+
+```ruby
+converter.convert(['1', '2.3', '3.0']).from(:array).to(:numeric)
+```
+
+Raises error when in strict mode
+
+```ruby
+converter.convert(['1', '2.3', false]).from(:array).to(:numeric)
+# => Necromancer::ConversionError: false cannot be converter to numeric value
+```
+
+Returns value when in non strict mode
+
+```ruby
+converter.convert(['1', '2.3', false]).from(:array).to(:numeric)
+# => [1, 2.3, false]
+```
+
+### 3.3 Range
+
+### 3.4 Hash
+
+```ruby
+converter.convert({ x: '27.5', y: '4', z: '11'}).to(:numeric)
+# => { x: 27.5, y: 4, z: 11}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/peter-murach/necromancer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+
+Copyright (c) 2014 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+require 'bundler/gem_tasks'
+
+FileList['tasks/**/*.rake'].each(&method(:import))
+
+desc 'Run all specs'
+task ci: %w[ spec ]

data/lib/necromancer.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'necromancer/conversions'
+require 'necromancer/context'
+require 'necromancer/converter'
+require 'necromancer/null_converter'
+require 'necromancer/converters/array'
+require 'necromancer/converters/boolean'
+require 'necromancer/converters/float'
+require 'necromancer/converters/integer'
+require 'necromancer/converters/range'
+require 'necromancer/conversion_target'
+require 'necromancer/version'
+
+module Necromancer
+  # Raised when cannot conver to a given type
+  ConversionTypeError = Class.new(StandardError)
+
+  # Raised when conversion type is not available
+  NoTypeConversionAvailableError = Class.new(StandardError)
+
+  def new
+    Context.new
+  end
+
+  module_function :new
+end # Necromancer

data/lib/necromancer/context.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+module Necromancer
+  # A class used by Necromancer to provide user interace
+  #
+  # @api public
+  class Context
+    # Create a context
+    #
+    # @api private
+    def initialize
+      @conversions = Conversions.new
+      @conversions.load
+    end
+
+    # Converts the object
+    # @param [Object] value
+    #   any object to be converted
+    #
+    # @api public
+    def convert(object = ConversionTarget::UndefinedValue, &block)
+      ConversionTarget.for(conversions, object, block)
+    end
+
+    # Check if this converter can convert source to target
+    #
+    # @param [Object] source
+    #   the source class
+    # @param [Object] target
+    #   the target class
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def can?(source, target)
+      !conversions[source, target].nil?
+    rescue NoTypeConversionAvailableError
+      false
+    end
+
+    protected
+
+    attr_reader :conversions
+  end # Context
+end # Necromancer

data/lib/necromancer/conversion_target.rb

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+module Necromancer
+  # A class responsible for wrapping conversion target
+  #
+  # @api private
+  class ConversionTarget
+    # Used as a stand in for lack of value
+    # @api private
+    UndefinedValue = Module.new
+
+    # @api private
+    def initialize(conversions, object)
+      @object = object
+      @conversions = conversions
+    end
+
+    # @api private
+    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`.'
+        end
+        new(context, block.call)
+      elsif block
+        fail ArgumentError,
+             'You cannot pass both an argument and a block to `convert`.'
+      else
+        new(context, value)
+      end
+    end
+
+    # Allows to specify conversion source type
+    #
+    # @example
+    #   converter.convert('1').from(:string).to(:numeric)  # => 1
+    #
+    # @return [ConversionType]
+    #
+    # @api public
+    def from(source)
+      @source = source
+      self
+    end
+
+    # Runs a given conversion
+    #
+    # @example
+    #   converter.convert('1').to(:numeric)  # => 1
+    #
+    # @return [Object]
+    #   the converted target type
+    #
+    # @api public
+    def to(target, options = {})
+      conversion = conversions[source || detect(object), detect(target)]
+      conversion.call(object, options)
+    end
+
+    protected
+
+    # Detect object type
+    #
+    # @api private
+    def detect(object)
+      case object
+      when TrueClass, FalseClass then :boolean
+      when Fixnum, Bignum then :integer
+      when Symbol then object
+      else
+        object.class.name.downcase
+      end
+    end
+
+    attr_reader :object
+
+    attr_reader :conversions
+
+    attr_reader :source
+  end # ConversionTarget
+end # Necromancer

data/lib/necromancer/conversions.rb

@@ -0,0 +1,75 @@
+# coding: utf-8
+
+module Necromancer
+  # Represents the context used to configure various converters
+  # and facilitate type conversion
+  #
+  # @api public
+  class Conversions
+    DELIMITER = '->'.freeze
+
+    # TODO: allow to register converters as just simple proc objects
+    #
+    # register "integer->string", { |value| value.to_s }
+    # if block present then take it as converter class
+    #
+
+    # Creates a new conversions map
+    #
+    # @example
+    #   conversion = Necromancer::Conversions.new
+    #
+    # @api public
+    def initialize
+      @converter_map = {}
+    end
+
+    # Load converters
+    #
+    # @api private
+    def load
+      ArrayConverters.load(self)
+      BooleanConverters.load(self)
+      IntegerConverters.load(self)
+      RangeConverters.load(self)
+    end
+
+    def [](source, target)
+      key = "#{source}#{DELIMITER}#{target}"
+      converter_map[key] || fail(NoTypeConversionAvailableError)
+    end
+
+    # @example with simple object
+    #
+    #
+    # @example with block
+    #
+    #
+    # @api public
+    def register(converter = nil, &block)
+      converter ||= Converter.create(&block)
+      key = generate_key(converter)
+      return false if converter_map.key?(key)
+      converter_map[key] = converter
+      true
+    end
+
+    def to_hash
+      converter_map.dup
+    end
+
+    protected
+
+    def generate_key(converter)
+      parts = []
+      parts << (converter.source ? converter.source.to_s : 'none')
+      parts << (converter.target ? converter.target.to_s : 'none')
+      parts.join(DELIMITER)
+    end
+
+    # Map of type and conversion
+    #
+    # @api private
+    attr_reader :converter_map
+  end # Conversions
+end # Necromancer