charlatan 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 929b8622fb574a9a9d020ff4ff647275dca2a2b8
+  data.tar.gz: 9ac59a5d71b381fcbebc6a611c2ed09cbab23e4e
+SHA512:
+  metadata.gz: 6929d2756772933b28a5dad3bea59c4ec6a50c458dfa38c7ceb7de6851b94dfe308ef4caac961034586795fd444a3126a67fb36ccb62354f0a8ff1f7ade159ff
+  data.tar.gz: 9c79031f5e8fafafbfdce47d00f14c472a708fe298b4c0b28bf758a5919b6c95bb68571240501902fe8ef68865f97f04b063758ca867baad2c1491ad42ad2765

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+before_install: gem install bundler
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake metrics:coverage"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx
+notifications:
+  email:
+    - piotr.solnica@gmail.com

data/Gemfile.devtools

@@ -4,21 +4,24 @@ group :development do
   gem 'rake',  '~> 10.1.0'
   gem 'rspec', '~> 2.14.1'
   gem 'yard',  '~> 0.8.7'
+
+  platform :rbx do
+    gem 'rubysl-singleton', '~> 2.0.0'
+  end
 end
 
 group :yard do
-  gem 'kramdown', '~> 1.2.0'
+  gem 'kramdown', '~> 1.3.0'
 end
 
 group :guard do
-  gem 'guard',         '~> 1.8.1'
-  gem 'guard-bundler', '~> 1.0.0'
-  gem 'guard-rspec',   '~> 3.0.2'
-  gem 'guard-rubocop', '~> 0.2.0'
-  gem 'guard-mutant',  '~> 0.0.1'
+  gem 'guard',         '~> 2.2.4'
+  gem 'guard-bundler', '~> 2.0.0'
+  gem 'guard-rspec',   '~> 4.2.0'
+  gem 'guard-rubocop', '~> 1.0.0'
 
   # file system change event handling
-  gem 'listen',     '~> 1.3.0'
+  gem 'listen',     '~> 2.4.0'
   gem 'rb-fchange', '~> 0.0.6', require: false
   gem 'rb-fsevent', '~> 0.9.3', require: false
   gem 'rb-inotify', '~> 0.9.0', require: false
@@ -30,18 +33,27 @@ group :guard do
 end
 
 group :metrics do
-  gem 'coveralls', '~> 0.6.7'
+  gem 'coveralls', '~> 0.7.0'
   gem 'flay',      '~> 2.4.0'
-  gem 'flog',      '~> 4.1.1'
+  gem 'flog',      '~> 4.2.0'
   gem 'reek',      '~> 1.3.2'
-  gem 'rubocop',   '~> 0.12.0'
-  gem 'simplecov', '~> 0.7.1'
+  gem 'rubocop',   '~> 0.16.0'
+  gem 'simplecov', '~> 0.8.2'
   gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
 
   platforms :ruby_19, :ruby_20 do
-    gem 'mutant', git: 'https://github.com/mbj/mutant.git'
+    gem 'mutant',          '~> 0.3.0', git: 'https://github.com/mbj/mutant.git'
+    gem 'unparser',        '~> 0.1.5', git: 'https://github.com/mbj/unparser.git'
     gem 'yard-spellcheck', '~> 0.1.5'
   end
+
+  platform :rbx do
+    gem 'json',               '~> 1.8.1'
+    gem 'racc',               '~> 1.4.10'
+    gem 'rubysl-logger',      '~> 2.0.0'
+    gem 'rubysl-open-uri',    '~> 2.0.0'
+    gem 'rubysl-prettyprint', '~> 2.0.2'
+  end
 end
 
 group :benchmarks do

data/README.md

@@ -1,5 +1,17 @@
 # Charlatan
 
+[![Gem Version](https://badge.fury.io/rb/charlatan.png)][gem]
+[![Build Status](https://secure.travis-ci.org/solnic/charlatan.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/solnic/charlatan.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/solnic/charlatan.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/solnic/charlatan/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/charlatan
+[travis]: https://travis-ci.org/solnic/charlatan
+[gemnasium]: https://gemnasium.com/solnic/charlatan
+[codeclimate]: https://codeclimate.com/github/solnic/charlatan
+[coveralls]: https://coveralls.io/r/solnic/charlatan
+
 Turn any object into a proxy delegating to another object. Like that:
 
 ``` ruby
@@ -22,11 +34,22 @@ other = array_proxy + ['Oh Hai']
 other.class # => ArrayProxy
 ```
 
+Planned features:
+
+* optional support for equality methods
+* optional support for kind_of? and ===
+* transparent vs restricted delegation (as in, allow all calls or explicitly specify what should be delegated)
+
 ## Why?
 
-I dunno, you tell me. I just like it. Which I cannot say about SimpleDelegator.
+The idea is that a delegator object wrapping another object delegates method calls but it preserves the original type for return values which match the wrapped object's kind. This means if you decorate an array object and you call concat on the decorator you will get an instance of the decorator back rather than an array.
+
+Other cool aspects of this library:
 
-### TODO: explain why
+* You get a constructor for free which plays well with your own, just remember to call super if you override it
+* You get attr reader for the wrapped object
+* Your object correctly handles method missing and respond_to? - something that is really easy to break accidentely in an ad-hoc custom implementation
+* You don't need to inherit from any superclass, just mix it in and call it a day
 
 ## Installation
 
@@ -42,6 +65,18 @@ Or install it yourself as:
 
     $ gem install charlatan
 
+## Credits
+
+* [Dan Kubb](https://github.com/dkubb) for the original idea behind a proxy
+wrapping another object.
+* [Don Morrison](https://github.com/elskwid) for the awesome name that happened
+to be available on github and rubygems *at the same time*
+
+## Similar libraries
+
+* [casting](https://github.com/saturnflyer/casting)
+* simple_delegator in ruby stdlib
+
 ## Contributing
 
 1. Fork it

data/lib/charlatan.rb

@@ -22,19 +22,19 @@ class Charlatan < Module
     attr_reader name
     ivar = "@#{name}"
 
-    define_method(:initialize) do |*args, &block|
-      instance_variable_set(ivar, args.first)
-      @__proxy_args = args[1..args.size] || []
+    attr_reader :__proxy_kind__, :__proxy_args__
+
+    define_method(:initialize) do |proxy_target, *args, &block|
+      instance_variable_set(ivar, proxy_target)
+
+      @__proxy_kind__ = options.fetch(:kind) { proxy_target.class }
+      @__proxy_args__ = args
     end
 
     define_method(:__proxy_target__) do
       instance_variable_get(ivar)
     end
 
-    define_method(:__proxy_kind__) do
-      options[:kind] || __proxy_target__.class
-    end
-
     include Methods
   end
 
@@ -50,12 +50,12 @@ class Charlatan < Module
         if response.equal?(__proxy_target__)
           self
         elsif response.kind_of?(__proxy_kind__)
-          self.class.new(*[response]+@__proxy_args)
+          self.class.new(*[response]+__proxy_args__)
         else
           response
         end
       else
-        super(method_name, *args, &block)
+        super
       end
     end
   end

data/lib/charlatan/version.rb

@@ -1,3 +1,3 @@
 class Charlatan < Module
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/unit/charlatan_spec.rb

@@ -8,6 +8,10 @@ describe Charlatan do
     Class.new {
       include Charlatan.new(:other)
 
+      def inspect
+        '#<TestClass>'
+      end
+
       def initialize(other, extra, &block)
         super(other, extra, &block)
       end
@@ -53,7 +57,10 @@ describe Charlatan do
   end
 
   it 'raises no method error when method is not defined' do
-    expect { charlatan.not_here}.to raise_error(NoMethodError)
+    expect { charlatan.not_here}.to raise_error(
+      NoMethodError,
+      /undefined method `not_here' for #<TestClass>/
+    )
   end
 
   it 'forwards multiple levels down to the last target' do

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: charlatan
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,17 +27,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Neat delegation for ruby objects
@@ -52,6 +47,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.devtools
 - Guardfile
@@ -73,27 +69,26 @@ files:
 homepage: https://github.com/solnic/charlatan
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ''
 test_files:
 - spec/spec_helper.rb