charlatan 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in proxy_object.gemspec
+gemspec
+
+gem 'devtools', git: 'https://github.com/rom-rb/devtools', branch: 'master'
+
+# Added by devtools
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.1.0'
+  gem 'rspec', '~> 2.14.1'
+  gem 'yard',  '~> 0.8.7'
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.2.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'
+
+  # file system change event handling
+  gem 'listen',     '~> 1.3.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
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.6.7'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.1.1'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.12.0'
+  gem 'simplecov', '~> 0.7.1'
+  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 'yard-spellcheck', '~> 0.1.5'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/Guardfile

@@ -0,0 +1,19 @@
+guard :rspec do
+  #run all specs if configuration is modified
+  watch('Guardfile')           { 'spec' }
+  watch('Gemfile.lock')        { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+
+  # run all specs if supporting files files are modified
+  watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+  # run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z})                                         { |m| Dir["spec/unit/#{m[1]}"]         }
+  watch(%r{\Alib/(.+)/support/(.+)\.rb\z})                            { |m| Dir["spec/unit/#{m[1]}/#{m[2]}"] }
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { 'spec'                               }
+
+  # run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+
+  notification :tmux, :display_message => true
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Piotr Solnica
+
+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,51 @@
+# Charlatan
+
+Turn any object into a proxy delegating to another object. Like that:
+
+``` ruby
+require 'charlatan'
+
+class ArrayProxy
+  include Charlatan.new(:array)
+end
+
+array_proxy = ArrayProxy.new([])
+
+array_proxy << 'Hello'
+array_proxy << 'World'
+
+array_proxy.size # => 2
+array_proxy.join(' ') # => 'Hello World'
+
+# always wraps responses with the proxy class
+other = array_proxy + ['Oh Hai']
+other.class # => ArrayProxy
+```
+
+## Why?
+
+I dunno, you tell me. I just like it. Which I cannot say about SimpleDelegator.
+
+### TODO: explain why
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'charlatan'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install charlatan
+
+## 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,5 @@
+require "bundler/gem_tasks"
+
+# Added by devtools
+require 'devtools'
+Devtools.init_rake_tasks

data/charlatan.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'charlatan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "charlatan"
+  spec.version       = Charlatan::VERSION
+  spec.authors       = ["Piotr Solnica"]
+  spec.email         = ["piotr.solnica@gmail.com"]
+  spec.description   = %q{Neat delegation for ruby objects}
+  spec.summary       = spec.summary
+  spec.homepage      = "https://github.com/solnic/charlatan"
+  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"
+end

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.1

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 0
+total_score: 0

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 0

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: charlatan
+namespace: Charlatan

data/config/reek.yml

@@ -0,0 +1,103 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 2
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 2
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - each
+  max_statements: 2
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessControl:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/lib/charlatan.rb

@@ -0,0 +1,62 @@
+require "charlatan/version"
+
+# Charlatan turns your object into a proxy which will forward all method missing
+# calls to object it's wrapping
+#
+# @example
+#
+#   class UserPresenter
+#     include Charlatan.new(:user)
+#   end
+#
+#   user      = OpenStruct.new(:name => "Jane")
+#   presenter = UserPresenter.new(user)
+#
+#   user.name # => "Jane"
+#   presenter.user == user # => true
+#
+class Charlatan < Module
+  attr_reader :name
+
+  def initialize(name, options = {})
+    attr_reader name
+    ivar = "@#{name}"
+
+    define_method(:initialize) do |*args, &block|
+      instance_variable_set(ivar, args.first)
+      @__proxy_args = args[1..args.size] || []
+    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
+
+  module Methods
+    def respond_to_missing?(method_name, include_private)
+      __proxy_target__.respond_to?(method_name, include_private)
+    end
+
+    def method_missing(method_name, *args, &block)
+      if __proxy_target__.respond_to?(method_name)
+        response = __proxy_target__.public_send(method_name, *args, &block)
+
+        if response.equal?(__proxy_target__)
+          self
+        elsif response.kind_of?(__proxy_kind__)
+          self.class.new(*[response]+@__proxy_args)
+        else
+          response
+        end
+      else
+        super(method_name, *args, &block)
+      end
+    end
+  end
+end

data/lib/charlatan/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+# SimpleCov MUST be started before require 'rom-relation'
+#
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec:unit'
+
+    add_filter 'config'
+    add_filter 'spec'
+  end
+end
+
+require 'charlatan'
+require 'devtools/spec_helper'

data/spec/unit/charlatan_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Charlatan do
+  let(:other) { [1, 2, 3] }
+  let(:charlatan) { klass.new(other, 'stuff') }
+
+  let(:klass) do
+    Class.new {
+      include Charlatan.new(:other)
+
+      def initialize(other, extra, &block)
+        super(other, extra, &block)
+      end
+    }
+  end
+
+  it 'adds reader method for target object' do
+    expect(charlatan.other).to be(other)
+  end
+
+  it 'forwards method calls to target that returns other objects' do
+    expect(charlatan.size).to be(3)
+  end
+
+  it 'forwards method calls to target that returns equal object and returns self' do
+    expect(charlatan.concat([])).to equal(charlatan)
+  end
+
+  it 'forwards method calls to target that returns a new instance of itself' do
+    expect((charlatan + [4]).other).to eql(klass.new([1, 2, 3, 4], 'stuff').other)
+  end
+
+  it 'forwards method calls with a block' do
+    expect(charlatan.map(&:to_s).other).to eql(%w(1 2 3))
+  end
+
+  it 'does not mutate original args from the constructor' do
+    2.times do
+      expect((charlatan + [4]).other).to eql(klass.new([1, 2, 3, 4], 'stuff').other)
+    end
+  end
+
+  it 'responds to methods defined on the target object' do
+    expect(charlatan).to respond_to(:concat)
+  end
+
+  it 'does not respond to private methods defined on the target object' do
+    expect(charlatan).not_to respond_to(:Integer)
+  end
+
+  it 'does not respond to unknown method names' do
+    expect(charlatan).not_to respond_to(:no_idea_what_you_want)
+  end
+
+  it 'raises no method error when method is not defined' do
+    expect { charlatan.not_here}.to raise_error(NoMethodError)
+  end
+
+  it 'forwards multiple levels down to the last target' do
+    charlatan1 = Class.new { include Charlatan.new(:arr) }
+    charlatan2 = Class.new { include Charlatan.new(:charlatan1) }
+    charlatan3 = Class.new { include Charlatan.new(:charlatan2) }
+
+    object = charlatan3.new(charlatan2.new(charlatan1.new([1, 2, 3])))
+
+    expect(object.size).to be(3)
+  end
+
+  context 'when target kind is provided' do
+    subject(:charlatan) { klass.new(other_class.new) }
+
+    let(:klass) do
+      Class.new { include Charlatan.new(:other, :kind => Enumerable) }
+    end
+
+    let(:other_class) do
+      Class.new {
+        include Enumerable
+
+        def to_set
+          Set[1, 2]
+        end
+      }
+    end
+
+    it 'forwards to target and returns charlatan for return value that matches the kind' do
+      expect(charlatan.to_set).to be_instance_of(charlatan.class)
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: charlatan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Piotr Solnica
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-12 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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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
+email:
+- piotr.solnica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.devtools
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- charlatan.gemspec
+- config/devtools.yml
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/reek.yml
+- config/rubocop.yml
+- config/yardstick.yml
+- lib/charlatan.rb
+- lib/charlatan/version.rb
+- spec/spec_helper.rb
+- spec/unit/charlatan_spec.rb
+homepage: https://github.com/solnic/charlatan
+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: '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
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/spec_helper.rb
+- spec/unit/charlatan_spec.rb
+has_rdoc: