flex_coerce 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24baca495e6e4c9a7f8d1da2f74de3166751db50
+  data.tar.gz: 7707c8373d1dd02a1d2f4a3e387752c3036e16fc
+SHA512:
+  metadata.gz: 6f8bf58b33f181f6060d97d6d3f6cb802c7b1f96cf23cd6b59ce30214b216edc5069f23c15b830f7b8b830baeb9f2ddd2dca51d66a246f0bb14d88640748337e
+  data.tar.gz: c987e94f52aeadd3b2dbf2da9856ff41accbacfc65bf71204467e08d67d490f27abf9d56eec4255a422496c54f6f12530732f957cd045648a0869bbf0dd3be81

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flex_coerce.gemspec
+gemspec
+
+ruby '2.0.0'
+
+group :development do
+  gem 'rspec', '>= 2.0'
+  gem 'rspec-given', '>= 2.0.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ilya Vorontsov
+
+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,72 @@
+# FlexCoerce
+
+FlexCoerce - is a gem which allow you create operator-dependent coercion logic. It's useful when your type should be treated in a different way for different binary operations (including arithmetic operators, bitwise operators and comparison operators except equality checks: `==`, `===`).
+
+## Installation
+
+Attention: this gem works only with Ruby 2.0 because it uses Module#prepend which has no analogs in Ruby 1.9. If you have an idea how to realize it on 1.9 without too much mess - your pull-requests are welcome.
+
+Add this line to your application's Gemfile:
+
+    gem 'flex_coerce'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flex_coerce
+
+## Usage
+
+I'll show you an example of (very simplistic) class Unit for physical units. We can multiply numbers with units but can't add them.
+
+```
+require 'flex_coerce'
+class Unit
+  attr_reader :num, :unit
+  def initialize(num, unit)
+    @num, @unit = num, unit
+  end
+  def +(other)
+    raise TypeError, 'Can\'t add Unit to a non-Unit'  unless other.is_a? Unit
+    raise ArgumentError, 'Can\'t sum units of different types'  unless other.unit == unit
+    Unit.new(num + other.num, unit)
+  end
+  def *(other)
+    return self * Unit.new(other, '1')  if other.is_a? Numeric
+    Unit.new(num * other.num, "#{unit}*#{other.unit}")
+  end
+  def coerce(other, meth = nil)
+    raise TypeError, 'Coercion error: can\'t coerce non-numeric class to a Unit'  unless other.is_a? Numeric
+    case meth.to_sym
+    when :*
+      [Unit.new(other,'1'), self]
+    when :+
+      raise TypeError 'Coercion error: can\'t compare Unit to a non-unit anything'
+      [other, self]
+    else
+      raise TypeError, 'Unsupported operation'
+    end
+  end
+  
+  prepend FlexCoerce
+end
+
+5 * Unit.new(3,'cm') #  ==>  Unit(15,'1*cm')
+5 + Unit.new(3,'cm') #  ==>  raises an Error
+```
+
+You define your own `#coerce` with two arguments: standard argument `other` and new argument `meth` which represents the binary operations caused coercion. All the magic is in `prepend FlexCoerce` call.
+It decorates your `#coerce` method with another one, which follow ruby conventions about coerce method. This is done by creating an instance of `CoerceableWrapper` class which takes a reference to left-side object. This intermediate class defines its own methods for binary operators such that they play well with `#coerce` method of right-side object class. I should mention that this method works good for missing, optional or required second argument of `#coerce`, you can find examples in specs.
+
+Possibly this example is too simplistic and can be made in another and more consistent way. But this is a proof of concept that coerce can be made method-specific without touching base ruby classes. You're welcome with more interesting examples and more powerful and clear design.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/flex_coerce.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flex_coerce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flex_coerce"
+  spec.version       = FlexCoerce::VERSION
+  spec.authors       = ["Ilya Vorontsov"]
+  spec.email         = ["prijutme4ty@gmail.com"]
+  spec.description   = %q{FlexCoerce - is a gem which allow you create operator-dependent coercion logic. It's useful when your type should be treated in a different way for different binary operations (including arithmetic operators, bitwise operators and comparison operators except equality checks: `==`, `===`).}
+  spec.summary       = %q{FlexCoerce - is a gem which allow you create operator-dependent coercion logic. It's useful when your type should be treated in a different way for different binary operations (including arithmetic operators, bitwise operators and comparison operators except equality checks: `==`, `===`).}
+  spec.homepage      = "https://github.com/prijutme4ty/flex_coerce"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '>= 2.0'
+  spec.add_development_dependency 'rspec-given', '>= 2.0.0'
+  
+  spec.required_ruby_version = '2.0.0'
+end

data/lib/flex_coerce.rb

@@ -0,0 +1,6 @@
+require "flex_coerce/version"
+require 'flex_coerce/flex_coerce'
+
+module FlexCoerce
+  # Your code goes here...
+end

data/lib/flex_coerce/flex_coerce.rb

@@ -0,0 +1,37 @@
+module FlexCoerce
+  def self.prepend_features(base)
+    base.instance_eval{
+      @__original_coerce_arity ||= base.instance_method(:coerce).arity
+    }
+    super
+  end
+  def coerce(other, meth = nil)
+    if meth
+      case self.class.class_eval{ @__original_coerce_arity }
+      when 1
+        super(other.obj)
+      when 2, -2
+        # coerce(other, meth) or coerce(other, meth = nil)
+        super(other.obj, meth)
+      else
+        raise 'Too many arguments for coerce'
+      end
+    else
+      [CoerceableWrapper.new(other), self]
+    end
+  end
+end
+
+# This class is a wrapper for object which redefines methods leading to coercion
+class CoerceableWrapper
+  attr_reader :obj
+  def initialize(obj)
+    @obj = obj
+  end
+  [:+, :-, :*,  :/, :%, :div, :divmod, :fdiv, :**,    :&, :|, :^,    :>,  :>=,  :<,  :<=,  :<=>].each do |op|
+    define_method(op) do |other|
+      self_coerced, other_coerced = other.coerce(self, op)
+      self_coerced.send(op, other_coerced)
+    end
+  end
+end 

data/lib/flex_coerce/version.rb

@@ -0,0 +1,3 @@
+module FlexCoerce
+  VERSION = "0.0.1"
+end

data/spec/flex_coerce_spec.rb

@@ -0,0 +1,123 @@
+$:.unshift '../lib/'
+require 'flex_coerce'
+require 'rspec/given'
+
+class UnitNoOptionalArgument
+  attr_reader :num
+  def initialize(num)  @num = num;  end
+  def coerce(other) [other, self.num];  end
+end
+
+class UnitBothRequired
+  attr_reader :num
+  def initialize(num)  @num = num;  end
+  def coerce(other, meth)  [other, self.num];  end
+end
+
+class UnitWeakCheck
+  attr_reader :num
+  def initialize(num)  @num = num;  end
+  def coerce(other, meth = nil)  [other, self.num];  end
+end
+
+class UnitStrongCheck
+  attr_reader :num
+  def initialize(num)  @num = num;  end
+  
+  def coerce(other, meth = nil)
+    raise TypeError 'Coercing error'  unless meth
+    case meth.to_sym
+    when :*, :/
+      [other, self.num]
+    when :+, :-
+      raise TypeError, 'Coercing error'
+    end
+  end
+end
+
+
+
+describe FlexCoerce do
+  context 'with #coerce having the only required and no optional arguments' do
+    Given(:unit_class) { UnitNoOptionalArgument }
+    Given(:number){ 3 }
+    Given(:unit) { unit_class.new(2) }
+    context 'before prepending FlexCoerce' do
+      When(:plus_operation) { number + unit }
+      Then{plus_operation.should == 5}
+      When(:mul_operation) { number * unit }
+      Then{mul_operation.should == 6}
+    end
+    context 'after prepending FlexCoerce' do
+      When{ unit_class.send :prepend, FlexCoerce }
+      
+      When(:plus_operation) { number + unit }
+      Then{plus_operation.should == 5}
+      When(:mul_operation) { number * unit }
+      Then{mul_operation.should == 6}
+    end
+  end
+  
+  context 'with #coerce having the only required and no optional arguments' do
+    context 'with coerce not checking method' do
+      Given(:unit_class) { UnitWeakCheck }
+      Given(:number){ 3 }
+      Given(:unit) { unit_class.new(2) }
+      context 'before prepending FlexCoerce' do
+        When(:plus_operation) { number + unit }
+        Then{plus_operation.should == 5}
+        When(:mul_operation) { number * unit }
+        Then{mul_operation.should == 6}
+      end
+      context 'after prepending FlexCoerce' do
+        When { unit_class.send :prepend, FlexCoerce }
+        
+        When(:plus_operation) { number + unit }
+        Then{plus_operation.should == 5}
+        When(:mul_operation) { number * unit }
+        Then{mul_operation.should == 6}
+      end
+    end
+    
+    context 'with coerce checking method' do
+      Given(:unit_class) { UnitStrongCheck }
+      Given(:number){ 3 }
+      Given(:unit) { unit_class.new(2) }
+      context 'before prepending FlexCoerce' do
+        When(:plus_operation) { number + unit }
+        Then{plus_operation.should have_failed}
+        When(:mul_operation) { number * unit }
+        Then{mul_operation.should have_failed}
+      end
+      context 'after prepending FlexCoerce' do
+        When { unit_class.send :prepend, FlexCoerce }
+        
+        When(:plus_operation) { number + unit }
+        Then{plus_operation.should have_failed}
+        When(:mul_operation) { number * unit }
+        Then{mul_operation.should == 6}
+      end
+    end
+  end
+
+  context 'with #coerce having two required arguments' do
+    Given(:unit_class) { UnitBothRequired }
+    Given(:number){ 3 }
+    Given(:unit) { unit_class.new(2) }
+    context 'before prepending FlexCoerce' do
+      When(:plus_operation) { number + unit }
+      Then{plus_operation.should have_failed}
+      When(:mul_operation) { number * unit }
+      Then{mul_operation.should have_failed}
+    end
+    context 'after prepending FlexCoerce' do
+      When { unit_class.send :prepend, FlexCoerce }
+      
+      When(:plus_operation) { number + unit }
+      Then{plus_operation.should == 5}
+      When(:mul_operation) { number * unit }
+      Then{mul_operation.should == 6}
+    end
+  end  
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: flex_coerce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ilya Vorontsov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: 'FlexCoerce - is a gem which allow you create operator-dependent coercion
+  logic. It''s useful when your type should be treated in a different way for different
+  binary operations (including arithmetic operators, bitwise operators and comparison
+  operators except equality checks: `==`, `===`).'
+email:
+- prijutme4ty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flex_coerce.gemspec
+- lib/flex_coerce.rb
+- lib/flex_coerce/flex_coerce.rb
+- lib/flex_coerce/version.rb
+- spec/flex_coerce_spec.rb
+homepage: https://github.com/prijutme4ty/flex_coerce
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: 'FlexCoerce - is a gem which allow you create operator-dependent coercion
+  logic. It''s useful when your type should be treated in a different way for different
+  binary operations (including arithmetic operators, bitwise operators and comparison
+  operators except equality checks: `==`, `===`).'
+test_files:
+- spec/flex_coerce_spec.rb