upcastable 0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at takeshi.arabiki@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 abicky
+
+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,92 @@
+# Upcastable [![Build Status](https://travis-ci.org/abicky/upcastable.svg?branch=master)](https://travis-ci.org/abicky/upcastable)
+
+Upcastable provides the feature to emulate upcasting in Ruby.
+
+Duck typing sometimes results in `NoMethodError` unexpectedly by calling methods some classes don't have even if the code pass a test using other classes which have the methods. We can avoid such situations by upcasting. All we have to do is implementing methods defined in the super class or module and we don't have to care about whether or not methods defined only in some subclasses are called.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'upcastable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install upcastable
+
+## Usage
+
+We define `Animal` module and `Cat` class to explain the usage like below:
+
+```ruby
+module Animal
+  def talk; end
+end
+
+class Cat
+  include Animal
+
+  def talk
+    'Meow!'
+  end
+
+  def run
+    'Running...'
+  end
+end
+```
+
+Upcastable defines `Object#upcast_to` and you can use `Animal` like a interface by upcasting `Cat` object to `Animal`.
+
+```ruby
+cat = Cat.new
+animal = cat.upcast_to(Animal)
+animal.class #=> Cat
+animal.talk  #=> "Meow!"
+animal.run   #=> NoMethodError: `run' is not defined in Animal
+```
+
+Internally, the upcasted object is a `Upcastable::UpcastedObject` instance which delegates almost all methods to the original object. Therefore the value of `#object_id` is not changed.
+
+```ruby
+cat.object_id == animal.object_id #=> true
+```
+
+
+You can also downcast the upcasted object to the original class by calling `Object#downcast`.
+
+```ruby
+animal.downcast.run #=> "Running..."
+```
+
+There are two additional methods,  `Object#upcasting` and `Object#upcasted?`. `Object#upcasting` returns the ancestor to which the object have been upcasted and `Object#upcasted?` returns `true` if the object is upcasted.
+
+```ruby
+cat.upcasted?    #=> false
+cat.upcasting    #=> nil
+animal.upcasted? #=> true
+animal.upcasting #=> Animal
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abicky/upcastable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :benchmark do
+  ruby 'benchmark/upcasting.rb'
+end

data/benchmark/upcasting.rb

@@ -0,0 +1,35 @@
+require 'upcastable'
+require 'benchmark/ips'
+
+module Animal
+  def talk; end
+end
+
+class Cat
+  include Animal
+
+  def talk
+    'Meow!'
+  end
+
+  def run
+    'Running...'
+  end
+end
+
+cat    = Cat.new
+animal = cat.upcast_to(Animal)
+
+puts 'Object instance methods (#object_id)'
+Benchmark.ips do |x|
+  x.report('baseline') { cat.object_id }
+  x.report('upcasting') { animal.object_id }
+  x.compare!
+end
+
+puts 'Animal instance methods (#talk)'
+Benchmark.ips do |x|
+  x.report('baseline') { cat.talk }
+  x.report('upcasting') { animal.talk }
+  x.compare!
+end

data/examples/upcasting.rb

@@ -0,0 +1,30 @@
+module Animal
+  def talk; end
+end
+
+class Cat
+  include Animal
+
+  def talk
+    'Meow!'
+  end
+
+  def run
+    'Running...'
+  end
+end
+
+cat = Cat.new
+cat.class           #=> Cat
+cat.upcasted?       #=> false
+cat.upcasting       #=> nil
+cat.talk            #=> "Meow!"
+cat.run             #=> "Running..."
+
+animal = cat.upcast_to(Animal)
+animal.class        #=> Cat
+animal.upcasted?    #=> true
+animal.upcasting    #=> Animal
+animal.talk         #=> "Meow!"
+animal.run          #=> NoMethodError: `run' is not defined in Animal
+animal.downcast.run #=> "Running..."

data/lib/upcastable.rb

@@ -0,0 +1,9 @@
+require 'upcastable/version'
+require 'upcastable/upcasted_object'
+require 'upcastable/hooks'
+require 'upcastable/core_ext/object/upcasting'
+require 'upcastable/core_ext/basic_object/upcasting'
+require 'upcastable/core_ext/kernel/upcasting'
+
+module Upcastable
+end

data/lib/upcastable/core_ext/basic_object/upcasting.rb

@@ -0,0 +1,3 @@
+class BasicObject
+  extend ::Upcastable::Hooks
+end

data/lib/upcastable/core_ext/kernel/upcasting.rb

@@ -0,0 +1,3 @@
+module Kernel
+  extend ::Upcastable::Hooks
+end

data/lib/upcastable/core_ext/object/upcasting.rb

@@ -0,0 +1,56 @@
+class Object
+
+  # Upcasts the object to the specified class or module.
+  # Internally, the upcasted object is a Upcastable::UpcastedObject instance which
+  # delegates almost all methods to the original object.
+  #
+  # @param [Class, Module] ancestor the ancestor to which the object is upcasted
+  # @return the upcasted object
+  # @raise [ArgumentError] if +ancestor+ is not an ancestor
+  #
+  # @example
+  #
+  #   module Animal
+  #     def talk; end
+  #   end
+  #
+  #   class Cat
+  #     include Animal
+  #
+  #     def talk
+  #       'Meow!'
+  #     end
+  #
+  #     def run
+  #       'Running...'
+  #     end
+  #   end
+  #
+  #   animal = Cat.new.upcast_to(Animal)
+  #   animal.class #=> Cat
+  #   animal.talk  #=> "Meow!"
+  #   animal.run   #=> NoMethodError: `run' is not defined in Animal
+  #
+  def upcast_to(ancestor)
+    ::Upcastable::UpcastedObject.new(self, ancestor)
+  end
+
+  # @return [Class, Module, nil] the ancestor to which the object have been upcasted
+  def upcasting
+    nil
+  end
+
+  # Returns true if the object is upcasted
+  #
+  # @return [true, false]
+  def upcasted?
+    false
+  end
+
+  # Downcasts the object to the original class
+  #
+  # @return the downcasted object (the original object)
+  def downcast
+    self
+  end
+end

data/lib/upcastable/hooks.rb

@@ -0,0 +1,23 @@
+module Upcastable
+  module Hooks
+    def self.extended(base)
+      if base < Object
+        raise ArgumentError, 'extended class or module must be an ancestor of Object'
+      end
+
+      base.class_eval do
+        class << self
+          alias_method :__upcastable_orig_method_added, :method_added
+
+          private
+
+            def method_added(name)
+              return unless Object <= self
+              ::Upcastable::UpcastedObject.define_delegate_method(name)
+              __upcastable_orig_method_added(name)
+            end
+        end
+      end
+    end
+  end
+end

data/lib/upcastable/upcasted_object.rb

@@ -0,0 +1,64 @@
+module Upcastable
+  class UpcastedObject
+    def self.define_delegate_method(m)
+      define_method(m) do |*args, &block|
+        @object.send(m, *args, &block)
+      end
+    end
+
+    def initialize(object, ancestor, base = object.class)
+      unless base <= ancestor
+        raise ArgumentError, "#{ancestor} is not an ancestor of #{base}"
+      end
+      @object   = object
+      @ancestor = ancestor
+    end
+
+    (instance_methods - [:public_send, :clone]).each do |m|
+      define_delegate_method(m)
+    end
+
+    def initialize_clone(other)
+      @object = @object.clone
+    end
+
+    def send(m, *args, &block)
+      unless @ancestor.method_defined?(m) && @ancestor.private_method_defined?(m)
+        raise NoMethodError, "`#{m}' is not defined in #{@ancestor}"
+      end
+      @object.send(m, *args, &block)
+    end
+
+    def respond_to?(m, private = false)
+      if private
+        @ancestor.private_method_defined?(m) || @ancestor.method_defined?(m)
+      else
+        @ancestor.method_defined?(m)
+      end
+    end
+
+    def upcast_to(ancestor)
+      return self if ancestor == @ancestor
+      UpcastedObject.new(@object, ancestor, @ancestor)
+    end
+
+    def upcasting
+      @ancestor
+    end
+
+    def upcasted?
+      true
+    end
+
+    def downcast
+      @object
+    end
+
+    def method_missing(m, *args, &block)
+      unless @ancestor.method_defined?(m)
+        raise NoMethodError, "`#{m}' is not defined in #{@ancestor}"
+      end
+      @object.send(m, *args, &block)
+    end
+  end
+end

data/lib/upcastable/version.rb

@@ -0,0 +1,3 @@
+module Upcastable
+  VERSION = '0.1.0'
+end

data/upcastable.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'upcastable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'upcastable'
+  spec.version       = Upcastable::VERSION
+  spec.authors       = ['abicky']
+  spec.email         = ['takeshi.arabiki@gmail.com']
+
+  spec.summary       = %q{Upcastable provides the feature to emulate upcasting in Ruby}
+  spec.description   = <<-DESC
+Duck typing sometimes results in `NoMethodError` unexpectedly by calling methods
+some classes don't have even if the code pass a test using other classes which
+have the methods. We can avoid such situations by upcasting.
+All we have to do is implementing methods defined in the super class or module
+and we don't have to care about whether or not methods defined only in some
+subclasses are called.
+  DESC
+  spec.homepage      = 'https://github.com/abicky/upcastable'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 1.9'
+
+  all_files          = `git ls-files -z`.split("\x0")
+  spec.files         = all_files.reject { |f| f.match(%r{^\.|(bin|spec)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',       '~> 1.11'
+  spec.add_development_dependency 'rake',          '~> 10.0'
+  spec.add_development_dependency 'rspec',         '~> 3.0'
+  spec.add_development_dependency 'pry',           '~> 0.10'
+  spec.add_development_dependency 'pry-doc',       '~> 0.8'
+  spec.add_development_dependency 'benchmark-ips', '~> 2.3'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: upcastable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- abicky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: ! 'Duck typing sometimes results in `NoMethodError` unexpectedly by calling
+  methods
+
+  some classes don''t have even if the code pass a test using other classes which
+
+  have the methods. We can avoid such situations by upcasting.
+
+  All we have to do is implementing methods defined in the super class or module
+
+  and we don''t have to care about whether or not methods defined only in some
+
+  subclasses are called.
+
+'
+email:
+- takeshi.arabiki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/upcasting.rb
+- examples/upcasting.rb
+- lib/upcastable.rb
+- lib/upcastable/core_ext/basic_object/upcasting.rb
+- lib/upcastable/core_ext/kernel/upcasting.rb
+- lib/upcastable/core_ext/object/upcasting.rb
+- lib/upcastable/hooks.rb
+- lib/upcastable/upcasted_object.rb
+- lib/upcastable/version.rb
+- upcastable.gemspec
+homepage: https://github.com/abicky/upcastable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Upcastable provides the feature to emulate upcasting in Ruby
+test_files: []
+has_rdoc: