oh_delegator 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2VkNDdlZTA4M2QwMWM5MTM3ZjY2ZmNjMDJkMmNjYjM3ZWQzZTMzZA==
+  data.tar.gz: !binary |-
+    NWY1ZThhODUxMTQxNTRmZjQzNTdhMWM0Yzc1ZmQ4ODhkNDk2NjMwOA==
+SHA512:
+  metadata.gz: !binary |-
+    ZjViZWY0OWIxNDdiZWIzZjY5N2MwZGZhY2E1NmYxNjFiZjM0YTkwODEwMGNh
+    ZjlhOTZkZjA4NTEzMmEwODE2NWRmMzEzN2Y1N2Q2NzllNGZjNGI1ZmYzZDQw
+    NmVmMDRhZjNhZjM2MjUzMTM3NDU3Nzc4MjQ5ZmViNGEyZjIwY2E=
+  data.tar.gz: !binary |-
+    ZjJiMTM5ZDRkYjQzMTVjYWE4YmMxNmQ1YTljNDk1ODQ4MmVkMzc3MWFiMTNm
+    OThhNzE2ZDQyMjRlMTM0MzM2YWVmNWRkNTJmOTRhNmRlODcwMmIwZTk4Y2Mx
+    NjAzNmU2N2QzMjMwOTU4MGVjNTE4ODhmM2NhN2E3YjcyMDMyY2Q=

data/Readme.md

@@ -0,0 +1,90 @@
+## Inspiration
+
+From [Wikipedia](http://en.wikipedia.org/wiki/Don%27t_repeat_yourself):
+
+> The DRY principle is stated as “Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.”
+
+## Delegators vs Concerns
+
+ActiveSupport::Concern is a convenient solution for splitting ActiveRecord models. It can serve as a single and authoritative feature representation, but it is ambiguous. Consider the following example:
+
+```ruby
+# app/models/concerns/account_profile.rb
+module AccountProfile
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :profiles
+
+    validates :has_profile, inclusion: { in: [true, false] }
+  end
+
+  def active_profile
+    profiles.find_by(active: true)
+  end
+end
+
+# app/models/account.rb
+class Account < ActiveRecord::Base
+  include AccountProfile
+end
+
+# app/controllers/accounts_controller.rb
+...
+  def index
+    @profile = @account.active_profile
+  end
+...
+```
+
+When viewing the controller, the location of `@account.active_profile` seems ambiguous. The first thing that most developers would do is look at the `Account` model. Tools like ctags can help, but they have other limitations(e.g. cannot deal with duplicate method names in separate modules).
+
+Delegators are more ideal as they comply with all three requirements of DRY. Also, it makes way for editor plugins to accurately track source location. However it lacks any convenient wrapper like `ActiveSupport::Concern` for working with ActiveRecord. This gem serves to fill that gap.
+
+## Usage
+
+The delegators can be placed anywhere in your application's load path, the only requirement is that it must be nested under the delegatee object.
+
+```ruby
+# app/delegators/account/profile_delegator.rb
+class Account::ProfileDelegator < OhDelegator::Base
+  parent_scope do
+    has_many :profiles
+
+    validates :has_profile, inclusion: { in: [true, false] }
+  end
+
+  def active
+    profiles.find_by(active: true)
+  end
+end
+
+# app/models/account.rb
+class Account < ActiveRecord::Base
+  oh_delegators :profile_delegator
+end
+
+# app/controllers/accounts_controller.rb
+...
+  def index
+    @profile = @account.profile_delegator.active
+  end
+...
+```
+
+As we see, migrating code from an **ActiveRecord** model to a delegator is as simple as migrating a concern.
+
+## Extras
+
+The delegatee object will be available inside the delegator. The name is inferred from the `parent` scope.
+
+```ruby
+# app/delegators/account/profile_delegator.rb
+class Account::ProfileDelegator < OhDelegator::Base
+  ...
+
+  def create_profile
+    Profile.create(account: account)         # Account::ProfileDelegator.parent.name.downcase == 'account'
+  end
+end
+```

data/lib/oh_delegator.rb

@@ -0,0 +1,8 @@
+require 'oh_delegator/parent_scope'
+require 'oh_delegator/base'
+require 'oh_delegator/delegatee'
+require 'oh_delegator/orm'
+require 'oh_delegator/railtie'
+
+module OhDelegator
+end

data/lib/oh_delegator/base.rb

@@ -0,0 +1,14 @@
+require 'delegate'
+
+module OhDelegator
+  class Base < SimpleDelegator
+    extend ParentScope
+
+    class << self
+      def inherited(subclass)
+        delegatee_name = subclass.parent.name.downcase
+        define_method(delegatee_name, -> { __getobj__ })
+      end
+    end
+  end
+end

data/lib/oh_delegator/delegatee.rb

@@ -0,0 +1,19 @@
+module OhDelegator
+  module Delegatee
+    def oh_delegators(*attributes)
+      attributes.each do |attribute|
+        # Read the delegator class alongwith the delegatee.
+        klass = "#{ name }::#{ attribute.to_s.classify }".constantize
+
+        define_method attribute do
+          instance_variable_name = "@#{ attribute }"
+          instance_variable = instance_variable_get(instance_variable_name)
+
+          return instance_variable if instance_variable
+
+          instance_variable_set(instance_variable_name, klass.new(self))
+        end
+      end
+    end
+  end
+end

data/lib/oh_delegator/orm.rb

@@ -0,0 +1,11 @@
+module OhDelegator
+  class ORM
+    class << self
+      def setup(base)
+        base.class_eval do
+          extend OhDelegator::Delegatee
+        end
+      end
+    end
+  end
+end

data/lib/oh_delegator/parent_scope.rb

@@ -0,0 +1,7 @@
+module OhDelegator
+  module ParentScope
+    def parent_scope(&block)
+      parent.class_exec(&block)
+    end
+  end
+end

data/lib/oh_delegator/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/railtie'
+
+module OhDelegator
+  class Railtie < Rails::Railtie
+    initializer 'oh_delegator.orm.setup' do |app|
+      ActiveSupport.on_load(:active_record) do
+        OhDelegator::ORM.setup(self)
+      end
+    end
+  end
+end

data/lib/oh_delegator/version.rb

@@ -0,0 +1,5 @@
+module OhDelegator
+  module Version
+    STRING = '0.1.0'
+  end
+end

data/oh_delegator.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'oh_delegator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'oh_delegator'
+  gem.version       = OhDelegator::Version::STRING
+  gem.authors       = ["BlackDuck Software"]
+  gem.email         = ["info@blackducksoftware.com"]
+  gem.summary       = %q{ActiveRecord model delegation}
+  gem.description   = %q{Use delegators just like concerns}
+  gem.homepage      = "https://github.com/blackducksw/oh_delegator"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = ["lib"]
+end

data/test/lib/oh_delegator/base_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+describe OhDelegator::Base do
+  before do
+    class User
+      class ProfileCore < OhDelegator::Base
+      end
+    end
+
+    class User
+      extend OhDelegator::Delegatee
+      oh_delegators :profile_core
+
+      def type
+        :user
+      end
+    end
+  end
+
+  it 'must make the delegatee object available to the delegator' do
+    user = User.new
+    user.profile_core.user.must_equal user
+  end
+
+  it 'must delegate all instance methods to the delegatee' do
+    User.new.profile_core.type.must_equal :user
+  end
+end

data/test/lib/oh_delegator/delegatee_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+describe OhDelegator::Delegatee do
+  it 'must add an oh_delegators method when extended' do
+    class Person
+      extend OhDelegator::Delegatee
+    end
+
+    Person.methods.must_include :oh_delegators
+  end
+
+  describe 'oh_delegators' do
+    before do
+      class User
+        class ProfileCore < OhDelegator::Base
+        end
+      end
+
+      class User
+        extend OhDelegator::Delegatee
+        oh_delegators :profile_core
+      end
+    end
+
+    it 'must add a accessor for given delegators' do
+      User.new.profile_core.must_be :present?
+    end
+
+    it 'must make the accessor return a delegator object' do
+      User.new.profile_core.class.ancestors.first.must_equal User::ProfileCore
+    end
+  end
+end

data/test/lib/oh_delegator/parent_scope_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+describe OhDelegator::ParentScope do
+  before do
+    class User
+      class << self
+        attr_reader :class_name
+
+        def set_class_name
+          @class_name = name
+        end
+      end
+
+      class ProfileCore < OhDelegator::Base
+        parent_scope do
+          set_class_name
+        end
+      end
+    end
+
+    class User
+      extend OhDelegator::Delegatee
+      oh_delegators :profile_core
+    end
+  end
+
+  describe 'any method defined in parent_scope' do
+    it 'must be called at compile time' do
+      User.class_name.must_be :present?
+    end
+
+    it 'must be called using delegatee\'s context' do
+      User.class_name.must_equal 'User'
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'oh_delegator'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: oh_delegator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BlackDuck Software
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-11 00:00:00.000000000 Z
+dependencies: []
+description: Use delegators just like concerns
+email:
+- info@blackducksoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- lib/oh_delegator.rb
+- lib/oh_delegator/base.rb
+- lib/oh_delegator/delegatee.rb
+- lib/oh_delegator/orm.rb
+- lib/oh_delegator/parent_scope.rb
+- lib/oh_delegator/railtie.rb
+- lib/oh_delegator/version.rb
+- oh_delegator.gemspec
+- test/lib/oh_delegator/base_test.rb
+- test/lib/oh_delegator/delegatee_test.rb
+- test/lib/oh_delegator/parent_scope_test.rb
+- test/test_helper.rb
+homepage: https://github.com/blackducksw/oh_delegator
+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.7
+signing_key: 
+specification_version: 4
+summary: ActiveRecord model delegation
+test_files:
+- test/lib/oh_delegator/base_test.rb
+- test/lib/oh_delegator/delegatee_test.rb
+- test/lib/oh_delegator/parent_scope_test.rb
+- test/test_helper.rb