virtual_proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75d55a58f59bfc88a3814d04f153a5232c8cebafa5a88212e76ec25da487ab64
+  data.tar.gz: e729d9223bfa3a32bb53466ac5e8eccf5ff753da5f58519550600601384edc47
+SHA512:
+  metadata.gz: 8dcfc43deb77f2b237379c83d763bc778619367225de029844f08d3feabd36c59e0611296856fbaed44f3431fa096f7af56bb2f049733b533896b98834932e84
+  data.tar.gz: 4a5ab48aec48a59811f4b3a97b9f58b67e003fbd31c3f77faf18dce99a57bb4fd136c9d1e4d8c7f0ac65d6869ab7612320bffbe6c6d047023d040cbc8f749a60

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in virtual_proxy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    virtual_proxy (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  virtual_proxy!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 John Careaga
+
+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,91 @@
+# VirtualProxy
+
+- Quickly build virtual proxies.
+- Messages sent to these proxies are forwarded to custom lazily-evaluated subjects.
+- Based on the GoF [proxy pattern](https://en.wikipedia.org/wiki/Proxy_pattern).
+- Uses Ruby's [Delegator library](http://ruby-doc.org/stdlib-2.6/libdoc/delegate/rdoc/Delegator.html) to avoid [`method_missing` gotchas](https://github.com/rubocop-hq/ruby-style-guide#no-method-missing).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'virtual_proxy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install virtual_proxy
+
+## Usage
+
+```ruby
+# Create a proxy to some subject
+proxy = VirtualProxy.to { ExpensiveObject.new } # => VirtualProxy::Proxy
+proxy.expensive_object_method
+
+# Get the subject directly
+proxy.__getobj__ # => ExpensiveObject instance
+
+# Dynamically set a new subject
+proxy.__setobj__ { OtherExpensiveObject.new }
+proxy.other_expensive_object_method
+
+# Extend any class or object with proxy construction capabilities
+class ExpensiveObject
+  extend VirtualProxy
+
+  attr_reader :name
+  def initialize(name:)
+    @name = name
+  end
+end
+
+proxy = ExpensiveObject.build_lazy(name: 'fubar')
+proxy.foo # => 'fubar'
+
+# Use it for any expensive code
+proxy = VirtualProxy.to { perform_intensive_task }
+proxy.generate_report
+
+# Avoid method_missing gotchas
+proxy = VirtualProxy.to { [1, 2, 3] }
+proxy == [1, 2, 3] # => true
+proxy.methods # => [..., :push, :append, :pop, :shift, ...]
+proxy.respond_to?(:sort) # => true
+# NOTE: introspective methods such as :respond_to? require the subject to be evaluated
+```
+
+## Performance
+
+Note that the Ruby Delegator class uses `method_missing` under the hood.
+
+[This](./bin/benchmark) benchmark suggests that the `Delegator` approach taken in this gem, when compared against a simpler but more limited approach, incurs a %1.28 performance penalty:
+```
+                   user     system      total        real
+virtual_proxy  6.834716   0.000324   6.835040 (  6.849857)
+simple_proxy   6.754349   0.000008   6.754357 (  6.763423)
+```
+To run this benchmark,
+```bash
+chmod +x ./bin/benchmark
+./bin/benchmark
+```
+
+## 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/johnc219/virtual_proxy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/benchmark

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "virtual_proxy"
+require "benchmark"
+
+class SimpleProxy
+  def initialize(&block)
+    @block = block
+  end
+
+  def subject
+    @subject ||= @block.call
+  end
+
+  def run
+    subject.run # no method_missing
+  end
+end
+
+class Subject
+  def run
+    1000.times { |i| i % 5 }
+  end
+end
+
+virtual_proxy = VirtualProxy.to { Subject.new }
+simple_proxy  = SimpleProxy.new { Subject.new }
+
+n = 100_000
+
+Benchmark.bm do |x|
+  x.report('virtual_proxy') { n.times { virtual_proxy.run } }
+  x.report('simple_proxy')  { n.times { simple_proxy.run } }
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "virtual_proxy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/virtual_proxy/proxy.rb

@@ -0,0 +1,17 @@
+module VirtualProxy
+  # Forward messages to a lazily-evaluated subject
+  class Proxy < Delegator
+    def initialize(&block)
+      @block = block
+    end
+
+    def __getobj__
+      @__getobj__ ||= @block.call
+    end
+
+    def __setobj__(&block)
+      @block = block
+      @__getobj__ = nil
+    end
+  end
+end

data/lib/virtual_proxy/version.rb

@@ -0,0 +1,3 @@
+module VirtualProxy
+  VERSION = "0.1.0"
+end

data/lib/virtual_proxy.rb

@@ -0,0 +1,13 @@
+require "virtual_proxy/version"
+require "virtual_proxy/proxy"
+
+# Quickly build virtual proxies.
+module VirtualProxy
+  def self.to(&block)
+    Proxy.new(&block)
+  end
+
+  def build_lazy(*args, &block)
+    Proxy.new { new(*args, &block) }
+  end
+end

data/virtual_proxy.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "virtual_proxy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "virtual_proxy"
+  spec.version       = VirtualProxy::VERSION
+  spec.authors       = ["John Careaga"]
+  spec.email         = ["johnc219dev@gmail.com"]
+
+  spec.summary       = %q{Quickly build virtual proxies.}
+  spec.description   = %q{Forward messages to lazily-evaluated subjects.}
+  spec.homepage      = "https://github.com/johnc219/virtual_proxy"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: virtual_proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Careaga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Forward messages to lazily-evaluated subjects.
+email:
+- johnc219dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/benchmark
+- bin/console
+- bin/setup
+- lib/virtual_proxy.rb
+- lib/virtual_proxy/proxy.rb
+- lib/virtual_proxy/version.rb
+- virtual_proxy.gemspec
+homepage: https://github.com/johnc219/virtual_proxy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Quickly build virtual proxies.
+test_files: []