action_controller-parents 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9f3dc097efe51fe77aa33b7b4ad3c0c611f64b4
-  data.tar.gz: a0a01b028d0a2e45d040724461deaeec8319318d
+  metadata.gz: 4a9f2bdc1c4e85e3c0d39e223566ee29b1ec14cd
+  data.tar.gz: 8788d5de3a3a647774347603be67f560e46f9a5a
 SHA512:
-  metadata.gz: 98ca811ff7ae5d0a203dd92de929394b8fc4731cc1f29db014444401fd0ab4362fabb8c7fa8606f066d426a668474cd8dc0ee0712a27c60e72667e33cacdd82b
-  data.tar.gz: 27a6e714af635f1abfc34bff53f349a46688c184ff5f677c8a71483d225afbb32bd78d14634e316ce94492674eb28614df4a30b916ce7cef6268539985b80bbb
+  metadata.gz: 0d81e8a1697bb974675e72a4a5e0aa2e75ab209a25ceed5931c76cd68866fa052fd297065d78fbdb527438f086a1898c51616f0366cb9c7f68139f857f7f6ba8
+  data.tar.gz: fe34b89177ceb2248ec54f25c2c6341ca097e80ded2216575198c6df09b58204d78ab541d23468f65d4e8d4db27a26912bc02c29bf2d2ff5637f2af98ed9b170

data/README.md

@@ -1,5 +1,7 @@
 # ActionController::Parents
 
+[![Gem
+Version](https://badge.fury.io/rb/action_controller-parents.png)](http://badge.fury.io/rb/action_controller-parents)
 [![Build
 Status](https://travis-ci.org/mcls/action_controller-parents.png?branch=master)](https://travis-ci.org/mcls/action_controller-parents)
 
@@ -21,7 +23,26 @@ Or install it yourself as:
 
 ## Usage
 
-Example: 
+Extend your `ApplicationController` with the 
+`ActionController::Parents::Methods` module and use `parent_resources`:
+
+```ruby
+  class ApplicationController < ActionController::Base
+    extend ActionController::Parents::Methods
+  end
+
+  class MembersController < ApplicationController
+    parent_resources Group, Organization
+
+    # GET /organizations/:organization_id/members
+    # GET /groups/:group_id/members
+    def index
+      @members = parent_resource.members
+    end
+  end
+```
+
+Or use `ActionController::Parents` directly:
 
 ```ruby
   class MembersController < ActionController::Base
@@ -35,6 +56,7 @@ Example:
   end
 ```
 
+
 ## Contributing
 
 1. Fork it

data/gemfiles/activesupport_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    action_controller-parents (0.0.1)
+    action_controller-parents (0.1.0)
       activesupport (>= 3.0.0)
 
 GEM

data/gemfiles/activesupport_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    action_controller-parents (0.0.1)
+    action_controller-parents (0.1.0)
       activesupport (>= 3.0.0)
 
 GEM

data/lib/action_controller/parents.rb

@@ -1,4 +1,6 @@
 require 'active_support/core_ext/string/conversions'
+require 'action_controller/parents/finder'
+require 'action_controller/parents/methods'
 require 'action_controller/parents/version'
 
 module ActionController
@@ -41,43 +43,5 @@ module ActionController
         end
       end
     end
-
-    # Used to find the parent resource
-    #
-    # @api private
-    #
-    class Finder
-      attr_reader :parent_resource_classes, :primary_keys
-
-      # @param [Class<ActiveRecord::Base>] parent_resource_classes
-      def initialize(*parent_resource_classes)
-        @parent_resource_classes = parent_resource_classes.flatten
-        setup_primary_keys
-      end
-
-      def parent_resource(hsh)
-        key = matched_key(hsh)
-        return nil unless key
-        to_resource_class(key).find_by_id!(hsh[key])
-      end
-
-      def to_resource_class(key)
-        key.to_s.sub(/_id$/, '').classify.constantize
-      end
-
-      def matched_key(hsh)
-        hsh.keys.detect { |key| valid_primary_key?(key) }
-      end
-
-      def valid_primary_key?(key)
-        primary_keys.include?(key.to_s)
-      end
-
-      def setup_primary_keys
-        @primary_keys = parent_resource_classes.map { |klass|
-          klass.to_s.underscore.concat('_id')
-        }
-      end
-    end
-  end
+  end # Parents
 end

data/lib/action_controller/parents/finder.rb

@@ -0,0 +1,41 @@
+module ActionController
+  class Parents
+    # Used to find the parent resource
+    #
+    # @api private
+    #
+    class Finder
+      attr_reader :parent_resource_classes, :primary_keys
+
+      # @param [Class<ActiveRecord::Base>] parent_resource_classes
+      def initialize(*parent_resource_classes)
+        @parent_resource_classes = parent_resource_classes.flatten
+        setup_primary_keys
+      end
+
+      def parent_resource(hsh)
+        key = matched_key(hsh)
+        return nil unless key
+        to_resource_class(key).find_by_id!(hsh[key])
+      end
+
+      def to_resource_class(key)
+        key.to_s.sub(/_id$/, '').classify.constantize
+      end
+
+      def matched_key(hsh)
+        hsh.keys.detect { |key| valid_primary_key?(key) }
+      end
+
+      def valid_primary_key?(key)
+        primary_keys.include?(key.to_s)
+      end
+
+      def setup_primary_keys
+        @primary_keys = parent_resource_classes.map { |klass|
+          klass.to_s.underscore.concat('_id')
+        }
+      end
+    end
+  end
+end

data/lib/action_controller/parents/methods.rb

@@ -0,0 +1,33 @@
+module ActionController
+  class Parents
+    # Defines a {#parent_resources} method which can then be used instead of
+    # doing `include ActionController::Parents.new(...)`.
+    #
+    # @example
+    #
+    #   class ApplicationController < ActionController::Base
+    #     extend ActionController::Parents::Methods
+    #   end
+    #
+    #   class MembersController < ApplicationController
+    #     parent_resources Group, Organization
+    #
+    #     def index
+    #       @members = parent_resource.members
+    #     end
+    #   end
+    module Methods
+
+      # Includes new instance of {ActionController::Parents}, defining
+      # `#parent_resource` as a result.
+      #
+      # @param [Class<ActiveRecord::Base>] classes
+      #
+      # @return [undefined]
+      #
+      def parent_resources(*classes)
+        include Parents.new(*classes)
+      end
+    end
+  end
+end

data/lib/action_controller/parents/version.rb

@@ -1,5 +1,5 @@
 module ActionController
   class Parents < Module
-    VERSION = "0.0.2"
+    VERSION = "0.1.0".freeze
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,2 @@
 require 'action_controller/parents'
+require_relative 'support/dummy_model'

data/spec/support/dummy_model.rb

@@ -0,0 +1,5 @@
+class DummyModel
+  def self.find_by_id!(id)
+    DummyModel.new
+  end
+end

data/spec/unit/action_controller-parents/finder_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe ActionController::Parents::Finder do
+  let(:nested_resource) { described_class.new(parent_resources) }
+  let(:parent_resources) { [] }
+
+  describe '#parent_resource' do
+    subject { described_class.new(DummyModel).parent_resource(params) }
+    let(:params) { { :dummy_model_id => 1 } }
+
+    it 'calls find_by_id! on the found class' do
+      expect(DummyModel).to receive(:find_by_id!).with(1)
+      subject
+    end
+
+    context 'when class not found' do
+      let(:params) { { :random_model_id => 1 } }
+      it 'returns nil' do
+        expect(subject).to be_nil
+      end
+    end
+  end
+
+  describe '#to_resource_class' do
+    subject { described_class.new(DummyModel).to_resource_class(param_key) }
+    let(:param_key) { :dummy_model_id }
+
+    it 'transforms the key to a class' do
+      expect(subject).to eq DummyModel
+    end
+  end
+
+  describe '#primary_keys' do
+    subject { nested_resource.primary_keys }
+    let(:parent_resources) { [String, Integer] }
+
+    it 'sets the keys based on the parent resources' do
+      expect(subject).to eq %w(string_id integer_id)
+    end
+  end
+end

data/spec/unit/action_controller-parents/methods_spec.rb

@@ -0,0 +1,33 @@
+describe ActionController::Parents::Methods do
+  context 'when extended' do
+    subject do
+      mod = described_class
+      @controller ||= Class.new { extend mod }
+    end
+
+    it { should respond_to(:parent_resources) }
+  end
+
+  context 'when parent_resources is called' do
+    subject do
+      mod = described_class
+      @controller ||= Class.new do
+        extend mod
+        parent_resources DummyModel
+      end
+    end
+
+    it 'includes new ActionController::Parents' do
+      expect(subject.ancestors.map(&:class)).to include(ActionController::Parents)
+    end
+
+    it 'the Parents module is instantiated with the same arguments of parent_resources' do
+      expect(ActionController::Parents).to receive(:new).with(DummyModel).and_call_original
+      mod = described_class
+      Class.new do
+        extend mod
+        parent_resources DummyModel
+      end
+    end
+  end
+end

data/spec/unit/action_controller-parents_spec.rb

@@ -1,24 +1,13 @@
 require 'spec_helper'
 
-class DummyController
-  attr_accessor :params
-  def params
-    @params || {}
-  end
-end
-
-class DummyModel
-  def self.find_by_id!(id)
-    DummyModel.new
-  end
-end
-
 describe ActionController::Parents do
   describe 'when included' do
-    let(:dummy) { DummyController.new }
+    let(:dummy) { @controller_class.new }
 
     before(:each) do
-      class DummyController; include(ActionController::Parents.new); end
+      @controller_class = Class.new do
+        include ActionController::Parents.new
+      end
     end
 
     it "create the #parent_resource" do
@@ -33,47 +22,5 @@ describe ActionController::Parents do
         dummy.parent_resource
       end
     end
-
-  end
-end
-
-describe ActionController::Parents::Finder do
-  let(:nested_resource) { described_class.new(parent_resources) }
-  let(:parent_resources) { [] }
-
-  describe '#parent_resource' do
-    subject { described_class.new(DummyModel).parent_resource(params) }
-    let(:params) { { :dummy_model_id => 1 } }
-
-    it 'calls find_by_id! on the found class' do
-      expect(DummyModel).to receive(:find_by_id!).with(1)
-      subject
-    end
-
-    context 'when class not found' do
-      let(:params) { { :random_model_id => 1 } }
-      it 'returns nil' do
-        expect(subject).to be_nil
-      end
-    end
   end
-
-  describe '#to_resource_class' do
-    subject { described_class.new(DummyModel).to_resource_class(param_key) }
-    let(:param_key) { :dummy_model_id }
-
-    it 'transforms the key to a class' do
-      expect(subject).to eq DummyModel
-    end
-  end
-
-  describe '#primary_keys' do
-    subject { nested_resource.primary_keys }
-    let(:parent_resources) { [String, Integer] }
-
-    it 'sets the keys based on the parent resources' do
-      expect(subject).to eq %w(string_id integer_id)
-    end
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_controller-parents
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Maarten Claes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,8 +116,13 @@ files:
 - gemfiles/activesupport_4.gemfile
 - gemfiles/activesupport_4.gemfile.lock
 - lib/action_controller/parents.rb
+- lib/action_controller/parents/finder.rb
+- lib/action_controller/parents/methods.rb
 - lib/action_controller/parents/version.rb
 - spec/spec_helper.rb
+- spec/support/dummy_model.rb
+- spec/unit/action_controller-parents/finder_spec.rb
+- spec/unit/action_controller-parents/methods_spec.rb
 - spec/unit/action_controller-parents_spec.rb
 homepage: ''
 licenses:
@@ -145,4 +150,7 @@ specification_version: 4
 summary: Easily access parent resources
 test_files:
 - spec/spec_helper.rb
+- spec/support/dummy_model.rb
+- spec/unit/action_controller-parents/finder_spec.rb
+- spec/unit/action_controller-parents/methods_spec.rb
 - spec/unit/action_controller-parents_spec.rb