contextually 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-10-16
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/contextually.rb
+lib/contextually/definition.rb
+lib/contextually/example_extension.rb
+script/console
+script/destroy
+script/generate
+spec/application_controller.rb
+spec/contextually_spec.rb
+spec/spec_helper.rb
+spec/spec_spec.rb

data/README.rdoc

@@ -0,0 +1,44 @@
+= contextually
+
+* http://github.com/jnicklas/contextually
+
+== Description:
+
+Contextually is a gem for running Rails controller tests under different user contexts in a convenient way. So you can test your authorization without much effort.
+
+== Features/Problems:
+
+* FIX (list of features or problems)
+
+== Synopsis:
+
+  FIX (code sample of usage)
+
+== Install:
+
+  
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2009 Jonas Nicklas
+
+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/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+
+$:.unshift(File.expand_path('lib', File.dirname(__FILE__)))
+require 'contextually'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'contextually' do
+  self.developer 'Jonas Nicklas', 'jonas.nicklas@gmail.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['remarkable_rails','>= 3.1.10']]
+  self.version = Contextually::VERSION
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/contextually.rb

@@ -0,0 +1,8 @@
+module Contextually
+  VERSION = '0.0.1'
+  
+  class UndefinedContext < StandardError; end
+end
+
+require 'contextually/example_extension'
+require 'contextually/definition'

data/lib/contextually/definition.rb

@@ -0,0 +1,57 @@
+module Contextually
+  class Role < Struct.new(:name, :before, :deny_access); end
+
+  class Definition
+    def self.define(&block)
+      self.new.instance_eval(&block)
+    end
+  
+    def roles(*roles)
+      Contextually.roles = roles.inject({}) { |hash, role| hash[role] = Contextually::Role.new(role); hash }
+    end
+  
+    def group(*roles, &block)
+      as = roles.pop[:as]
+      Contextually.groups[as] = roles
+    end
+  
+    def before(name, &block)
+      Contextually.roles[name].before = block
+    end
+  
+    def deny_access_to(name, &block)
+      Contextually.roles[name].deny_access = block
+    end
+  
+    def deny_access(&block)
+      Contextually.deny_access_to_all = block
+    end
+  end
+  
+  class << self
+    attr_accessor :roles, :deny_access_to_all
+    
+    def groups
+      @groups ||= {}
+    end
+    
+    def role(role)
+      unless roles and roles.has_key?(role)
+        raise Contextually::UndefinedContext, "no role called #{role.inspect} exists"
+      end
+      roles[role]
+    end
+    
+    def before(role)
+      role(role).before
+    end
+    
+    def deny_access(role)
+      role(role).deny_access || deny_access_to_all
+    end
+    
+    def define(&block)
+      Contextually::Definition.define(&block)
+    end
+  end
+end

data/lib/contextually/example_extension.rb

@@ -0,0 +1,51 @@
+module Contextually
+  module ExampleExtension
+    def only_as(*args, &block)
+      as(*args, &block)
+      roles, params = extract_params(args)
+      deny_params = Contextually.roles.keys - roles
+      deny_params.push(params)
+      deny_access_to(*deny_params)
+    end
+  
+    def as(*args, &block)
+      roles, params = extract_params(args)
+      roles.each do |role|
+        context "as #{role}" do
+          before(&Contextually.before(role))
+          describe(params.dup, &block)
+        end
+      end
+    end
+  
+    def deny_access_to(*args)
+      roles, params = extract_params(args)
+      roles.each do |role|
+        block = Contextually.deny_access(role)
+        if block
+          context "as #{role}" do
+            before(&Contextually.before(role))
+            describe(params.dup, &block)
+          end
+        else
+          raise Contextually::UndefinedContext, "don't know how to deny access to a #{role}"
+        end
+      end
+    end
+  
+  private
+
+    def extract_params(args)
+      if args.blank? or args.last.is_a?(Symbol) 
+        params = ""
+      else
+        params = args.pop
+      end
+      args = args.inject([]) { |array, role| array.push(*Contextually.groups[role] || role); array }
+      return args, params
+    end
+
+  end
+end
+
+Spec::Rails::Example::ControllerExampleGroup.send(:extend, Contextually::ExampleExtension) if defined?(Spec)

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/contextually.rb'}"
+puts "Loading contextually gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/application_controller.rb

@@ -0,0 +1,3 @@
+# this file is a workaround for a bug in rspec-rails
+class ApplicationController < ActionController::Base
+end

data/spec/contextually_spec.rb

@@ -0,0 +1,102 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+Contextually.define do
+  roles :user, :visitor, :monkey
+
+  group :user, :monkey, :as => :member
+  group :visitor, :monkey, :as => :idiot
+
+  before :user do
+    controller.stub!(:current_user).and_return(:user)
+  end
+  before :visitor do
+    controller.stub!(:current_user).and_return(nil)
+  end
+  before :monkey do
+    controller.stub!(:current_user).and_return(:monkey)
+  end
+
+  deny_access_to :visitor do
+    it("should deny access") { should redirect_to(new_session_url) }
+  end
+  deny_access do
+    it("should deny access") { should redirect_to(root_url) }
+  end
+end
+
+ActionController::Routing::Routes.draw do |map|
+  map.root :controller => 'monkey'
+  map.new_session 'session', :controller => 'session'
+  map.index 'tests', :controller => 'tests', :action => 'index'
+  map.index 'test', :controller => 'tests', :action => 'show'
+  map.index 'foo', :controller => 'tests', :action => 'foo'
+end
+
+class TestsController < ApplicationController
+  def index
+    if not current_user
+      redirect_to new_session_url
+    elsif not current_user == :user
+      redirect_to root_url
+    end    
+  end
+  
+  def foo
+    if not current_user
+      redirect_to new_session_url
+    end
+  end
+  
+  def show
+    
+  end
+end
+
+describe TestsController, :type => :controller do
+  context "with simple contexts" do
+    as :user, :get => :index do
+      it { should respond_with(:success) }
+    end
+  
+    as :visitor, :get => :index do
+      it("should deny access") { should redirect_to(new_session_url) }
+    end
+  end
+  
+  context "with multiple roles" do
+    as :visitor, :monkey, :user, :get => :show do
+      it { should respond_with(:success) }
+    end
+    
+    as :visitor, :monkey, :user, "GET /test" do
+      describe :get => :show do
+        it { should respond_with(:success) }
+      end
+    end
+
+    as :visitor, :monkey, :user do
+      describe :get => :show do
+        it { should respond_with(:success) }
+      end
+    end
+  end
+  
+  context "with only_as" do
+    only_as :user, :get => :index do
+      it { should respond_with(:success) }
+    end
+  end
+  
+  context "with deny access" do
+    deny_access_to :monkey, :visitor, :get => :index
+  end
+  
+  context "with groups" do
+    deny_access_to :idiot, :get => :index
+  
+    only_as :member, :get => :foo do
+      it { should respond_with(:success) }
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+
+require 'action_pack'
+require 'action_controller'
+require 'active_support'
+require 'initializer'
+
+require 'spec'
+require 'spec/autorun'
+require 'spec/rails'
+
+require 'remarkable_rails'
+
+require 'contextually'

data/spec/spec_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+require 'base64'
+
+describe 'running the specs' do
+  it "should yield the currect output" do
+    out = `spec #{File.expand_path('contextually_spec.rb', File.dirname(__FILE__))} --format specdoc`
+    expected = File.read(__FILE__).split(Base64.decode64("X19FTkRfXw==\n")).second.strip
+    out.should =~ Regexp.new(Regexp.escape(expected))
+  end
+end
+
+__END__
+
+TestsController with simple contexts as user responding to #GET index
+- should respond with success
+
+TestsController with simple contexts as visitor responding to #GET index
+- should deny access
+
+TestsController with multiple roles as visitor responding to #GET show
+- should respond with success
+
+TestsController with multiple roles as monkey responding to #GET show
+- should respond with success
+
+TestsController with multiple roles as user responding to #GET show
+- should respond with success
+
+TestsController with multiple roles as visitor GET /test responding to #GET show
+- should respond with success
+
+TestsController with multiple roles as monkey GET /test responding to #GET show
+- should respond with success
+
+TestsController with multiple roles as user GET /test responding to #GET show
+- should respond with success
+
+TestsController with multiple roles as visitor  responding to #GET show
+- should respond with success
+
+TestsController with multiple roles as monkey  responding to #GET show
+- should respond with success
+
+TestsController with multiple roles as user  responding to #GET show
+- should respond with success
+
+TestsController with only_as as user responding to #GET index
+- should respond with success
+
+TestsController with only_as as visitor responding to #GET index
+- should deny access
+
+TestsController with only_as as monkey responding to #GET index
+- should deny access
+
+TestsController with deny access as monkey responding to #GET index
+- should deny access
+
+TestsController with deny access as visitor responding to #GET index
+- should deny access
+
+TestsController with groups as visitor responding to #GET index
+- should deny access
+
+TestsController with groups as monkey responding to #GET index
+- should deny access
+
+TestsController with groups as user responding to #GET foo
+- should respond with success
+
+TestsController with groups as monkey responding to #GET foo
+- should respond with success
+
+TestsController with groups as visitor responding to #GET foo
+- should deny access

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: contextually
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jonas Nicklas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-16 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: remarkable_rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.1.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: Contextually is a gem for running Rails controller tests under different user contexts in a convenient way. So you can test your authorization without much effort.
+email: 
+- jonas.nicklas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/contextually.rb
+- lib/contextually/definition.rb
+- lib/contextually/example_extension.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/application_controller.rb
+- spec/contextually_spec.rb
+- spec/spec_helper.rb
+- spec/spec_spec.rb
+has_rdoc: true
+homepage: http://github.com/jnicklas/contextually
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: contextually
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Contextually is a gem for running Rails controller tests under different user contexts in a convenient way
+test_files: []
+