delegate_to_instance 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca5a1577bae3ab3b06810c177705ee6f00fc53aa
+  data.tar.gz: bc5325b4b8c3f1324c3ccea3675c7bbc149859f6
+SHA512:
+  metadata.gz: 0ca3644eef96e3e6c0135a56abac93dd003d03be750051e794715cf3a25cde8f6a5e588802b6eb83a26e4ef7b3f0d5bbe5a3c0f04fed00f4c377ccfe57d64ba5
+  data.tar.gz: e9585e17ad60d0b4e872a0edb18bd7f8ac2039d8c33b32cc630dee0af78b9f636ddaa36d6e92438663fd5c2cbe0c28e4f64ded42eb58f644c4d2265dd2472ef4

data/.gitignore

@@ -0,0 +1,15 @@
+.rspec
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec.example

@@ -0,0 +1,2 @@
+--color
+--require pry

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nisanth Chunduru
+
+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,95 @@
+# delegate_to_instance
+
+Helper for single purpose objects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delegate_to_instance'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delegate_to_instance
+
+## Usage
+
+Write
+```ruby
+class SendInvoiceJob
+  extend DelegateToInstance
+  delegate_to_instance :perform
+  
+  def initialize(invoice_id, recipients)
+    @invoice_id, @recipients = invoice_id, recipients
+  end
+  
+  def perform
+    send_invoice(invoice_id, recipients)
+  end
+end
+```
+
+instead of
+```ruby
+class SendInvoiceJob
+  def self.perform(invoice_id, recipients)
+    new(invoice_id, recipients).perform
+  end
+  
+  def initialize(invoice_id, recipients)
+    @invoice_id, @recipients = invoice_id, recipients
+  end
+  
+  def perform
+    send_invoice(invoice_id, recipients)
+  end
+end
+```
+
+## Why
+
+When I write single purpose objects, like
+```ruby
+class HTMLSanitizer
+  def self.sanitize(html)
+    new(html).sanitize
+  end
+  
+  def initialize(html)
+    @html = html
+  end
+  
+  def sanitize
+    sanitize_html(html)
+  end
+end
+```
+I often find myself writing a class level delegator (and corresponding tests for it)
+```ruby
+class HTMLSanitizer
+  def self.sanitize(html)
+    new(html).sanitize
+  end
+
+  # ...
+```
+
+Instead, just write
+```ruby
+class HTMLSanitizer
+  include DelegateToInstance
+  delegate_to_instance :sanitize
+  
+  # ...
+```
+
+## TODO
+
+1. Add a RSpec matcher

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/delegate_to_instance.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delegate_to_instance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "delegate_to_instance"
+  spec.version       = DelegateToInstance::VERSION
+  spec.authors       = ["Nisanth Chunduru"]
+  spec.email         = ["nisanth074@gmail.com"]
+  spec.summary       = 'Helper for single purpose objects'
+  spec.homepage      = 'https://github.com/nisanth074/delegate_to_instance'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'rspec', '~> 3.1'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/delegate_to_instance.rb

@@ -0,0 +1,9 @@
+require "delegate_to_instance/version"
+
+module DelegateToInstance
+  def delegate_to_instance(method)
+    define_singleton_method(method) do |*args|
+      new(*args).public_send(method)
+    end
+  end
+end

data/lib/delegate_to_instance/version.rb

@@ -0,0 +1,3 @@
+module DelegateToInstance
+  VERSION = '1.0.0'
+end

data/spec/delegate_to_instance_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'delegate_to_instance'
+
+class DummyHTMLSanitizer
+  extend DelegateToInstance
+  delegate_to_instance :sanitize
+
+  def initialize(html)
+    @html = html
+  end
+
+  def sanitize
+    @html
+  end
+end
+
+describe DelegateToInstance do
+  let(:html) { '<p>Overpriced coffee, awesome!</p>' }
+  let(:sanitizer) { DummyHTMLSanitizer.new(html) }
+
+  it 'creates an instance' do
+    expect(DummyHTMLSanitizer).to receive(:new).with(html).once.and_return(sanitizer)
+    DummyHTMLSanitizer.sanitize(html)
+  end
+
+  it 'delegates method to that instance' do
+    expect(DummyHTMLSanitizer).to receive(:new).with(html).once.and_return(sanitizer)
+    expect(sanitizer).to receive(:sanitize).once
+    DummyHTMLSanitizer.sanitize(html)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: delegate_to_instance
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nisanth Chunduru
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- nisanth074@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec.example"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- delegate_to_instance.gemspec
+- lib/delegate_to_instance.rb
+- lib/delegate_to_instance/version.rb
+- spec/delegate_to_instance_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nisanth074/delegate_to_instance
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Helper for single purpose objects
+test_files:
+- spec/delegate_to_instance_spec.rb
+- spec/spec_helper.rb