action_controller-parents 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8971a4188ec77e694b85ba6bcc8b716f0e2a3ae2
+  data.tar.gz: bbbd2f28eaa82115a4809f9af0bc2f0702d72363
+SHA512:
+  metadata.gz: 832cb24c7816516c1e9b1a30ab8d2244d1b062bf278e848eb619edfc1ce8a3564ed4da8e50dbf5b2cc97a6416e03fc7dd6a2f195d4fc54ed1b6823f425476041
+  data.tar.gz: 080a58489983e0b8fe582f58c952a436616a32e460555a729293f7a23a96fe8ce3846c50b3793f5c7dcbcec5f1de1b97a71da292e51d140cc9f60fd349c15181

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+

data/.rspec

@@ -0,0 +1 @@
+--color

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Maarten Claes
+
+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,41 @@
+# ActionController::Parents
+
+Easily access parent resources.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action_controller-parents'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_controller-parents
+
+## Usage
+
+Example: 
+
+```ruby
+  class MembersController < ActionController::Base
+    include Parents.new(Organization, Group)
+
+    # GET /organizations/:organization_id/members
+    # GET /groups/:group_id/members
+    def index
+      @members = parent_resource.members
+    end
+  end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc 'Run mutation tests'
+task :mutant do
+  system 'bundle exec mutant --include lib --require "action_controller/parent" --use rspec ::ActionController::Parent*'
+end

data/action_controller-parents.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_controller/parents/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_controller-parents"
+  spec.version       = ActionController::Parents::VERSION
+  spec.authors       = ["Maarten Claes"]
+  spec.email         = ["maartencls@gmail.com"]
+  spec.description   = %q{Easily access parent resources}
+  spec.summary       = %q{Easily access parent resources}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mutant"
+
+  spec.add_dependency "activesupport", ">= 3.0.0"
+end

data/lib/action_controller/parents/version.rb

@@ -0,0 +1,5 @@
+module ActionController
+  class Parents < Module
+    VERSION = "0.0.1"
+  end
+end

data/lib/action_controller/parents.rb

@@ -0,0 +1,82 @@
+require "action_controller/parents/version"
+
+module ActionController
+  # To be included in a controller.
+  #
+  # Creates a `parent_resource` method, which will call `find_by_id!` using an id
+  # found in the params hash.
+  #
+  # @example Organization and Group as parents
+  #
+  #   class MembersController < ActionController::Base
+  #     include Parents.new(Organization, Group)
+  #
+  #     def index
+  #       @members = parent_resource.members
+  #     end
+  #   end
+  #
+  # @!method parent_resource()
+  #   Fetches the parent resource.
+  #
+  #   @return [ActiveRecord::Base, nil] The result or `nil` if no matching key
+  #     has been found.
+  #
+  #   @raise [ActiveRecord::RecordNotFound] When a parent resource key is
+  #     present, but no parent resource is found for it.
+  #
+  class Parents < Module
+    private
+
+    def initialize(*resource_classes)
+      @finder = Finder.new(resource_classes)
+    end
+
+    def included(base)
+      finder = @finder
+      base.class_eval do
+        define_method :parent_resource do
+          finder.parent_resource(params)
+        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

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'active_support/all'
+require 'action_controller/parents'
+

data/spec/unit/action_controller-parents_spec.rb

@@ -0,0 +1,79 @@
+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 }
+
+    before(:each) do
+      class DummyController; include(ActionController::Parents.new); end
+    end
+
+    it "create the #parent_resource" do
+      expect(dummy).to respond_to(:parent_resource)
+    end
+
+    describe '#parent_resource' do
+      it 'deletegates to an instance of Finder' do
+        args = []
+        allow(dummy).to receive(:params) { args }
+        expect_any_instance_of(described_class::Finder).to receive(:parent_resource).with(args)
+        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

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: action_controller-parents
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maarten Claes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mutant
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Easily access parent resources
+email:
+- maartencls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_controller-parents.gemspec
+- lib/action_controller/parents.rb
+- lib/action_controller/parents/version.rb
+- spec/spec_helper.rb
+- spec/unit/action_controller-parents_spec.rb
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Easily access parent resources
+test_files:
+- spec/spec_helper.rb
+- spec/unit/action_controller-parents_spec.rb
+has_rdoc: