decouple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26a5008be5d896e8dbd276ff7d37616b8195460d
+  data.tar.gz: e2d79c11d93de57ff509af2c4ab1a0881e53cdeb
+SHA512:
+  metadata.gz: d894c8eba20e0904d6b02927b35f8b34b781064159819645e67c9c47804850fd074b83e1b89199e654196c52cdb9a4cab0e46aea704550e5bc395806eefb49ad
+  data.tar.gz: f206104c9626789f754e13a70581da3702fdabc77d4acb514b72bd60e4e46113e77b06405576e2a8e9a292c675c240ecaafe900d92458594bb07284d8b1be8de

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.yardoc
+rdoc
+coverage
+.bundle
+.ruby-version
+.rvmrc
+.idea
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "2.0.0"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gemspec
+gem 'rake'

data/README.md

@@ -0,0 +1,51 @@
+# Decouple FTW!
+[![Gem Version](https://badge.fury.io/rb/decouple.png)](http://badge.fury.io/rb/decouple)
+[![Build Status](http://travis-ci.org/einzige/decouple.png?branch=master)](https://travis-ci.org/einzige/decouple)
+[![Dependency Status](https://gemnasium.com/einzige/decouple.png)](https://gemnasium.com/einzige/decouple)
+
+Decouples long methods in a pretty weird unnatural way. Please use _PRIVATE_ methods instead, extract classes, objects, do whatever is possible not to use it. That's a really bad idea, NEVER use it. I DO ALWAYS USE NATURAL LANGUAGE CONSTRUCTIONS.
+
+## Anyways... :)
+
+```ruby
+class MyClass
+  include Decouple
+
+  def send_email
+    # 100 lines of code
+    proceed_action
+  end
+
+  def send_letter
+    # ...
+    # Another thougsand lines code
+    # ...
+    proceed_action :to_grandma
+  end
+
+  private
+
+  def burn_paper
+    # bazillion lines of code
+  end
+end
+
+# app/callbacks/safe_actions.rb
+MyClass.decouple do
+  on :send_email do
+    Mailer.notify
+  end
+
+  on :send_letter do |receiver|
+    Mailer.notify(receipient: receiver)
+  end
+end
+
+# app/callbacks/burn_paper.rb
+MyClass.decouple do
+  on :send_email do
+    burn_paper
+  end
+end
+```
+

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+task :default => :spec

data/decouple.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{decouple}
+  s.version = "0.0.1"
+
+  s.date = %q{2014-03-10}
+  s.authors = ["Sergei Zinin (einzige)"]
+  s.email = %q{szinin@gmail.com}
+  s.homepage = %q{http://github.com/einzige/decouple}
+
+  s.licenses = ["MIT"]
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.extra_rdoc_files = ["README.md"]
+
+  s.description = %q{Decouples long methods in a pretty weird unnatural way. Please use PRIVATE methods instead. That's a really bad idea, NEVER use it.}
+  s.summary = %q{Organizes your code by decoupling long methods into separate declarations}
+
+  s.add_development_dependency 'rspec'
+end
+

data/lib/decouple.rb

@@ -0,0 +1,40 @@
+require 'decouple/decoupler'
+
+module Decouple
+  VERSION = '0.0.1'
+
+  # @param base [Class]
+  def self.included(base)
+    base.extend(Decouple::ClassMethods)
+  end
+
+  # Runs callbacks for calling context (decoupled method is a context)
+  # @param arguments [Array]
+  def proceed_action(*arguments)
+    self.class.decouplings.each { |decoupler| decoupler.run(self, *arguments) }
+  end
+
+  # Runs callbacks for a specific method
+  # @param action [String] Method name to proceed with
+  # @param arguments [Array]
+  def proceed_with(action, *arguments)
+    self.class.decouplings.each do |decoupler|
+      decoupler.run_on(self, action, *arguments)
+    end
+  end
+
+  module ClassMethods
+
+    # Attaches callbacks
+    # @yield
+    def decouple(&block)
+      decouplings << Decouple::Decoupler.new(self, &block)
+    end
+
+    # Returns a list of attached callback containers
+    # @return [Array<Decouple::Decoupler>]
+    def decouplings
+      @decouplings ||= []
+    end
+  end
+end

data/lib/decouple/decoupler.rb

@@ -0,0 +1,53 @@
+module Decouple
+  class Decoupler < Hash
+
+    # @param klass [Class] A class to decouple
+    # @yield Decoupling block
+    def initialize(klass, &block)
+      @klass = klass
+      instance_eval(&block) if block
+    end
+
+    # @param action [Symbol] Name of the method being decoupled
+    # @yield Method body extension
+    def on(action, &block)
+      if has_key?(action)
+        raise ArgumentError, "#{action} action is already callbacked"
+      end
+
+      unless @klass.instance_methods.include?(action)
+        raise ArgumentError, "No such action #{action}"
+      end
+
+      self[action] = block
+    end
+
+    # Runs callbacks (decouplings) attached to decoupling methods
+    # @param klass_instance [Object] An object where the decoupling will be called
+    # @param arguments [Array]
+    def run(klass_instance, *arguments)
+      unless klass_instance.is_a?(@klass)
+        raise ArgumentError, "Running #{klass_instance.class.name} on #{@klass.name} Decoupler"
+      end
+
+      action = nil
+      depth = 0 # Can be optimized by seeting to 3
+
+      while action.nil?
+        location = caller_locations(depth+=1, 1)[0] or raise "No action to proceed (invalid context) [#{depth}]"
+        location = location.label.to_sym
+        action = location if self[location]
+      end
+
+      run_on(klass_instance, action, *arguments)
+    end
+
+    # Runs callback attached to method
+    # @param klass_instance [Object] An object where the decoupling will be called
+    # @param action [Symbol, String] Name of decoupled method
+    def run_on(klass_instance, action, *arguments)
+      block = self[action.to_sym] or raise ArgumentError, "No callback for #{action}"
+      klass_instance.instance_exec(*arguments, &block)
+    end
+  end
+end

data/spec/lib/decouple/decoupler_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe Decouple::Decoupler do
+  subject(:decoupler) { Decouple::Decoupler.new(klass) }
+
+  let(:klass) do
+    Class.new do
+      def action
+        proceed_action :argument
+      end
+
+      private
+
+      def perform_job(param)
+      end
+    end
+  end
+
+  describe '#run' do
+    context 'calling in a correct context' do
+      let(:klass) do
+        Class.new do
+          def action
+            decoupler = Decouple::Decoupler.new(self.class) do
+              on(:action) { |param| perform_job(param) }
+            end
+            decoupler.run(self, :argument)
+          end
+
+          private
+
+          def perform_job(param)
+          end
+        end
+      end
+
+      let(:klass_instance) { klass.new }
+
+      specify do
+        expect(klass_instance).to receive(:perform_job).with(:argument)
+        klass_instance.action
+      end
+    end
+
+    context 'context is invalid' do
+      let(:random_context) { 'random_context' }
+
+      specify do
+        expect(random_context).not_to receive(:perform_job)
+        expect { decoupler.run(random_context) }.to raise_error(ArgumentError, /Running String/)
+      end
+    end
+
+    context 'calling out of context' do
+      before do
+        decoupler.on :action do
+          perform_job(:param)
+        end
+      end
+
+      let(:klass_instance) { klass.new }
+
+      specify do
+        expect(klass_instance).not_to receive(:perform_job)
+        expect { decoupler.run(klass_instance) }.to raise_error /No action to proceed/
+      end
+    end
+  end
+
+  describe '#run_on' do
+    context 'registered action' do
+      before do
+        decoupler.on :action do
+          perform_job(:param)
+        end
+      end
+
+      let(:klass_instance) { klass.new }
+
+      specify do
+        expect(klass_instance).to receive(:perform_job).with(:param)
+        decoupler.run_on(klass_instance, :action, :param)
+      end
+    end
+
+    context 'unregistered action' do
+      specify do
+        expect { decoupler.run_on(:anything, :unregistered_action) }.to raise_error ArgumentError, /No callback/
+      end
+    end
+  end
+end

data/spec/lib/decouple_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Decouple do
+  let(:klass) do
+    Class.new do
+      include Decouple
+
+      def action
+        proceed_action :param, :another_param
+      end
+
+      private
+
+      def perform_job(param)
+      end
+
+      def perform_another_job(another_param)
+      end
+    end
+  end
+
+  before do
+    klass.decouple do
+      on :action do |param, another_param|
+        perform_job param
+      end
+    end
+  end
+
+  before do
+    klass.decouple do
+      on :action do |param, another_param|
+        perform_another_job another_param
+      end
+    end
+  end
+
+  let(:klass_instance) { klass.new }
+
+  it 'calls all registered callbacks on method call' do
+    expect(klass_instance).to receive(:perform_job).with(:param)
+    expect(klass_instance).to receive(:perform_another_job).with(:another_param)
+    klass_instance.action
+  end
+
+  context 'registering the same callback twice' do
+    specify do
+      expect {
+        klass.decouple do
+          on(:action) {}
+          on(:action) {}
+        end
+      }.to raise_error(ArgumentError, /already callbacked/)
+    end
+  end
+
+  context 'registering callback on unexisting method' do
+    specify do
+      expect {
+        klass.decouple do
+          on(:unexisting_action) {}
+        end
+      }.to raise_error(ArgumentError, /No such action/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'decouple'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.color_enabled = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: decouple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergei Zinin (einzige)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Decouples long methods in a pretty weird unnatural way. Please use PRIVATE
+  methods instead. That's a really bad idea, NEVER use it.
+email: szinin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- decouple.gemspec
+- lib/decouple.rb
+- lib/decouple/decoupler.rb
+- spec/lib/decouple/decoupler_spec.rb
+- spec/lib/decouple_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/einzige/decouple
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Organizes your code by decoupling long methods into separate declarations
+test_files: []