doodoo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1319c292b242343da75d9e62ed590111d475553e
+  data.tar.gz: fce9490b875dc6e900834312b0b4475ec4cf0f47
+SHA512:
+  metadata.gz: 451de26fbd52f97d54179e18c99faec95d7a02dac23b3c60f5a2d3ceadff7dfb2f3ca3e10481c9c8e9272d061923e9fada11109af1f79f67a1e01e7df568797f
+  data.tar.gz: b7e0f144843e070956c7da7043d84c683895e16ad9b607e27d3db46aff37207f3595d166d355b800956dc3f7f4268e9de282d674cfac549dc2a09ce1bc968b15

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# RubyMine IDE:
+.idea/
+
+# Mac:
+.DS_Store
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matt Connolly
+
+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,64 @@
+# Doodoo
+
+A set of tools to help with CanCan. Doodoo provides a module for use with Rails controllers that assists with
+authorisation, especially with nested routes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doodoo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doodoo
+
+## Usage
+
+Add to ApplicationController:
+
+    include Doodoo::NestedLoadAndAuthorize
+
+And then in controllers (For example a TasksController, nested under ProjectsController):
+
+    before_action do
+      # load task nested under project, only if params[:project_id] exists:
+      load_and_authorize_if_present :project do
+        load_and_authorize :task
+      end
+
+      # enforce nested load:
+      load_and_authorize :project do
+        load_and_authorize :task
+      end
+
+      # and for a shallow route:
+      load_and_authorize :task
+
+      # load without authorisation:
+      load_resource :task
+
+      # only specific actions
+      load_and_authorize :task, :only => [:show]
+
+      # supply a condition in should_load_task? method (can use a proc here too)
+      load_and_authorize :task, :if => :should_load_task?
+
+      # specific id parameter for another action:
+      load_and_authorize :task, :id_param => :task_id, :only => [:other_action]
+
+      # only load if parameter present in menu:
+    end
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/doodoo/fork )
+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,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc "Run the specs."
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/doodoo.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doodoo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doodoo"
+  spec.version       = Doodoo::VERSION
+  spec.authors       = ["Matt Connolly"]
+  spec.email         = ["matt.connolly@tworedkites.com"]
+  spec.summary       = %q{A set of tools to help with CanCan.}
+  spec.description   = <<EOF
+A set of tools to help with CanCan.
+
+Doodoo provides a module for use with Rails controllers that assists with authorisation,
+especially with nested routes.
+EOF
+  spec.homepage      = ""
+  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_dependency 'rails', '>= 3.2'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/lib/doodoo.rb

@@ -0,0 +1,7 @@
+require "doodoo/version"
+require "doodoo/nested_load_and_authorize"
+
+module Doodoo
+  # Your code goes here...
+end
+

data/lib/doodoo/nested_load_and_authorize.rb

@@ -0,0 +1,91 @@
+require 'active_support/concern'
+require 'active_record'
+
+module Doodoo
+  module NestedLoadAndAuthorize
+    extend ActiveSupport::Concern
+
+    included do
+      # make the loaded_resources array accessible in views.
+      helper_method :loaded_resources
+    end
+
+    # An array of the resources loaded by +load_and_authorize+. This may be useful for constructing
+    # breadcrumbs or for views to determine what context they are being rendered in.
+    def loaded_resources
+      @_loaded_resources ||= []
+    end
+
+    # load and authorise the resource with the same parameters as the Can Can controller additions class macro
+    # load_and_authorize_resource.
+    #
+    # This differs in that it is an instance method, so you must call it in a before_filter (or from another instance
+    # method).
+    #
+    # This method has no effect if the resource is already loaded.
+    #
+    # Any block passed to this method will be executed if the resource was successfully loaded by this call. Nested
+    # calls automatically supply the +:through+ parameter. To bypass this, set :through => nil.
+    def load_and_authorize(name, options={})
+      @_through_stack ||= []
+
+      # only touch can can if the instance variable is nil
+      resource = instance_variable_get("@#{name}") || instance_variable_get("@#{name.to_s.pluralize}")
+
+      if resource.nil?
+        # apply if, only and except behaviours just is if this was done by before_filter
+        proceed = true
+        proceed &&= [*options[:only]].include?(action_name.to_sym) if options[:only]
+        proceed &&= ![*options[:except]].include?(action_name.to_sym) if options[:except]
+        proceed &&= case options[:if]
+                      when Symbol
+                        send(options[:if])
+                      when Proc
+                        options[:if].call
+                      when nil
+                        true
+                    end
+
+        if proceed
+          # automatically load this resource through a nested one unless manually specified
+          options[:through] = @_through_stack.last unless @_through_stack.empty? || options.include?(:through)
+          # create the can can resource class
+          cancan = self.class.cancan_resource_class.new(self, name, options.except(:if, :only, :except, :param))
+          resource = cancan.load_resource
+          cancan.authorize_resource unless options[:skip_authorize]
+
+          if resource
+            # If the resource was a scope (query/collection-proxy) simply add the result class into the loaded_resources
+            loaded_resources << ((resource.is_a? ActiveRecord::Relation) ? resource.klass : resource)
+          end
+
+          if resource && block_given?
+            # only call block if we got an instance variable set
+            begin
+              @_through_stack.push(name)
+              yield
+            ensure
+              @_through_stack.pop
+            end
+          end
+        end
+      end
+      resource
+    end
+
+    # syntactic sugar for adding the :skip_authorize option
+    def load_resource(name, options={}, &block)
+      options[:skip_authorize] = true
+      load_and_authorize(name, options, &block)
+    end
+
+    # load the resource only if its request parameter is present. This allows for optional nesting to
+    # work like shallow routes with the before_filter way of doing things.
+    def load_and_authorize_if_present(name, options={}, &block)
+      key = options[:id_param] || "#{name}_id"
+      if params[key]
+        load_and_authorize(name, options, &block)
+      end
+    end
+  end
+end

data/lib/doodoo/version.rb

@@ -0,0 +1,3 @@
+module Doodoo
+  VERSION = "0.0.1"
+end

data/spec/lib/nested_load_and_authorize_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'action_controller'
+
+describe Doodoo::NestedLoadAndAuthorize do
+
+  class ChildController < ActionController::Base
+    include Doodoo::NestedLoadAndAuthorize
+  end
+
+  class ToyController < ActionController::Base
+    include Doodoo::NestedLoadAndAuthorize
+  end
+
+  context "loading a model" do
+    let(:can_can_class) { double("CanCan class") }
+    let(:child_controller) { ChildController.new }
+    let(:toy_controller) { ToyController.new }
+    let(:child) { double("Amelia") }
+    let(:toy) { double("Peppa Pig doll") }
+    before { ActionController::Base.stub(:cancan_resource_class => can_can_class) }
+
+    it "loads a model" do
+      can_can_resource = double("can can resource")
+      can_can_class.should_receive(:new).with(child_controller, :child, {}).and_return(can_can_resource)
+      can_can_resource.should_receive(:load_resource).and_return(child)
+      can_can_resource.should_receive(:authorize_resource)
+      child_controller.load_and_authorize :child
+      expect(child_controller.loaded_resources).to match_array([child])
+    end
+
+    it "loads a nested model" do
+      can_can_resource = double("can can resource")
+      can_can_resource_2 = double("can can resource")
+      can_can_class.should_receive(:new).with(toy_controller, :child, {}).and_return(can_can_resource)
+      can_can_class.should_receive(:new).with(toy_controller, :toy, {:through => :child}).and_return(can_can_resource_2)
+      can_can_resource.should_receive(:load_resource).and_return(child)
+      can_can_resource.should_receive(:authorize_resource)
+      can_can_resource_2.should_receive(:load_resource).and_return(toy)
+      can_can_resource_2.should_receive(:authorize_resource)
+
+      toy_controller.load_and_authorize :child do
+        toy_controller.load_and_authorize :toy
+      end
+      expect(toy_controller.loaded_resources).to match_array([child, toy])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'bundler/setup'
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'doodoo'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: doodoo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Connolly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: |
+  A set of tools to help with CanCan.
+
+  Doodoo provides a module for use with Rails controllers that assists with authorisation,
+  especially with nested routes.
+email:
+- matt.connolly@tworedkites.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doodoo.gemspec
+- lib/doodoo.rb
+- lib/doodoo/nested_load_and_authorize.rb
+- lib/doodoo/version.rb
+- spec/lib/nested_load_and_authorize_spec.rb
+- spec/spec_helper.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.2
+signing_key: 
+specification_version: 4
+summary: A set of tools to help with CanCan.
+test_files:
+- spec/lib/nested_load_and_authorize_spec.rb
+- spec/spec_helper.rb