mayi 1.0.2 → 2.0.0

data/Gemfile.lock

@@ -8,9 +8,9 @@ GEM
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.5)
-    rake (0.9.2.2)
-    rdoc (3.12)
+    json (1.8.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
       json (~> 1.4)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)

data/README.markdown

@@ -2,41 +2,44 @@
 
 A plugable access rights API. Meant to make integrations easier. Verry useful as an integration point for blog,forum and CMS components. Also its much nicer to read than the basic stuff i usually do.
 
-Before without MayI.
+An example basic way to do rights handeling
 
 ```ruby
 if user_object.is_admin?
-
+...
 end
 ```
 
-Now with MayI.
+With mayi this changes to method with an explicit mening to it.
 
 ```ruby
 access.may_add_user! do
-
+...
 end
 ```
 
 
 
 
-## Basics
+## An example
 
-You have a class that implements boolean questions.
+Your rights implements with boolean questions.
 
 ```ruby
-class MyBasicAccess
-  def initialize(data)
-    @data = data
+class MyAccessHandler
+
+  include MayI
+  
+  def initialize(user)
+    @user = user
   end
   
-  def may_view_secret_stuff(stuff)
-    stuff.owner_id ==  data[:session][:user_id]
+  def may_view_secret_project(project)
+    stuff.owner_id ==  @user.id
   end
   
   def may_create_new_record
-    data[:session][:user_type] == "admin"
+    @user.type == "admin"
   end
 end
 ```
@@ -45,7 +48,8 @@ This can then be used with the MayI::Access class.
 
 
 ```ruby
-access = MayI::Access.new(MyBasicAccess)
+
+access = MyAccessHandler.new(user)
 
 # Simple boolean
 if access.may_create_new_record?
@@ -56,84 +60,41 @@ end
 access.may_create_new_record? do
   # You do stuff here
 end
-```
 
-Now with exceptions. On failure the MayI::AccessDeniedError error is raised.
+# Raise errors on false
+access.may_view_secret_project!(project)
+# or
+access.error_message("A custom error message").may_view_secret_project!(project)
 
-```ruby
-access = MayI::Access.new(MyBasicAccess)
-
-# Simple boolean
-if access.may_create_new_record!
-  # You do stuff here
-end
-
-# With a block
-access.may_create_new_record! do
-  # You do stuff here
-end
-```
-
-With custom error message
-
-```ruby
-access.error_message("Sorry but you are not allowed to do this!").may_create_new_record! do
-  # You do stuff here
-end
 ```
 
-
-
-
-
 ## A Rails example
 
-On each request we create a new instance of MyBasicAccess with the current session.
-
 ```ruby
 class ApplicationController < ActionController::Base
-  before_filter :init_access
-  
-  def init_access 
-    # Create a new instance of MyBasicAccess with the current session
-    ApplicationController.access.refresh({:session => session})
-  end
-  
-  def self.access
-    @@access_cache
+
+  helper_method :current_user
+  def current_user 
+    ...
   end
   
+  helper_method :access
   def access
-    @@access_cache
+    @@access_cache ||= MyAccessHandler.new(current_user)
   end
   
-  @@access_cache = MayI::Access.new
-  @@access_cache.implementation = MyBasicAccess
 end
 ```
 
-We use the API to check if a user should be able to view some secret stuff.
+Check if a user should be able to view some secret stuff.
 
 ```ruby
-class SecretStuffController < ApplicationController
+class StuffController < ApplicationController
 
   def show
     stuff = Stuff.find(params[:id])
-    access.may_view_secret_stuff?(stuff) do
     
-    end
-  end
-  
-end
-```
-
-We can also use it in a model.
-
-```ruby
-class ShortUrl < ActiveRecord::Base
-
-  def method_that_requires_special_access
-    ApplicationController.access.may_create_new_record! do
+    access.may_view_secret_stuff?(stuff) do
     
     end
   end

data/VERSION

@@ -1 +1 @@
-1.0.2
+2.0.0

data/lib/mayi.rb

@@ -2,8 +2,11 @@
 # Add the directory containing this file to the start of the load path if it
 # isn't there already.
 $:.unshift(File.dirname(__FILE__)) unless
-    $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module MayI
+  
+end
 
-require 'mayi/proxy'
 require 'mayi/access_denied_error'
-require 'mayi/access'
+require 'mayi/methods'

data/lib/mayi/access_denied_error.rb

@@ -1,9 +1,8 @@
-module MayI
-  class AccessDeniedError < RuntimeError
 
-    def initialize(message = 'Access Denied')
-      super message
-    end
+class MayI::AccessDeniedError < RuntimeError
 
+  def initialize(message = 'Access Denied')
+    super message
   end
-end
+
+end

data/lib/mayi/methods.rb

@@ -0,0 +1,42 @@
+
+module MayI
+  
+  def method_missing(meth, *args, &block)
+    if is_a_may_i_method?(meth)
+      if self.send(meth.to_s[0..-2].to_sym,*args)
+        yield if block_given?
+        true
+      else
+        meth.to_s.end_with?("!") ? raise_may_i_error(meth) : false
+      end
+    else
+      super(meth,*args,&block)  
+    end
+  ensure
+    @may_i_error_message = nil
+  end
+
+  def respond_to?(meth)
+    if is_a_may_i_method?(meth)
+      super(meth.to_s[0..-2].to_sym)
+    else
+      super(meth)  
+    end
+  end
+
+  def error_message(message)
+    @custom_may_i_error_message = message
+    self
+  end
+
+  private
+  
+  def is_a_may_i_method?(sym)
+    sym.to_s.match(/^(may)_.*(\?|!)$/)
+  end
+
+  def raise_may_i_error(meth)
+    raise MayI::AccessDeniedError.new(@custom_may_i_error_message || meth.to_s[0..-2].gsub("_", " ").gsub("may","may not"))
+  end
+  
+end

data/mayi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mayi"
-  s.version = "1.0.2"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Darwin"]
-  s.date = "2012-08-23"
+  s.date = "2013-05-16"
   s.description = " A plugable access rights API. Meant to make integrations easier. Werry useful as an integration point for blog,forum and CMS components. Also its much nicer to read than the basic stuff i usually do. "
   s.email = "darwin@bits2life.com"
   s.extra_rdoc_files = [
@@ -26,10 +26,10 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/mayi.rb",
-    "lib/mayi/access.rb",
     "lib/mayi/access_denied_error.rb",
-    "lib/mayi/proxy.rb",
+    "lib/mayi/methods.rb",
     "mayi.gemspec",
+    "spec/lib/test_helper.rb",
     "spec/mayi_spec.rb",
     "spec/spec_helper.rb"
   ]

data/spec/lib/test_helper.rb

@@ -0,0 +1,6 @@
+
+class TestHelper
+  
+  include MayI
+  
+end

data/spec/mayi_spec.rb

@@ -1,7 +1,77 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "MayI" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe "MayI::Methods" do
+  
+  subject { TestHelper.new }
+  
+  context "call a may method with question mark" do
+    
+    it 'should call the map_do_something method' do
+      subject.should_receive(:may_do_something).and_return(true)
+      subject.may_do_something?.should be_true
+    end
+    
+    it 'should yield to the block when true' do
+      
+      subject.should_receive(:may_do_something).and_return(true)
+      has_yielded = false
+      subject.may_do_something? do 
+        has_yielded = true
+      end
+      
+      has_yielded.should be_true
+      
+    end
+    
+    it 'should not yield to the block when false' do
+      
+      subject.should_receive(:may_do_something).and_return(false)
+      has_yielded = false
+      subject.may_do_something? do 
+        has_yielded = true
+      end
+      
+      has_yielded.should be_false
+      
+    end
+    
   end
+  
+  context "call a may method with exclimation point " do
+    
+    it 'should call the map_do_something method' do
+      subject.should_receive(:may_do_something).and_return(true)
+      subject.may_do_something!.should be_true
+    end
+    
+    it 'should raise an error on false' do
+      subject.should_receive(:may_do_something).and_return(false)
+      lambda{ subject.may_do_something! }.should raise_error(MayI::AccessDeniedError)
+    end
+    
+    it 'should yield to the block' do
+      
+      subject.should_receive(:may_do_something).and_return(true)
+      has_yielded = false
+      subject.may_do_something! do 
+        has_yielded = true
+      end
+      
+      has_yielded.should be_true
+      
+    end
+    
+  end
+  
+  describe "call a may method with an error message" do
+    
+    it 'should set the error message for the exception' do
+      
+      subject.should_receive(:may_do_something).and_return(false)
+      lambda{ subject.error_message("A error message").may_do_something! }.should raise_error(MayI::AccessDeniedError, "A error message")
+      
+    end
+    
+  end
+  
 end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
-require 'may-i'
+require 'mayi'
+require_relative 'lib/test_helper'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mayi
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,10 +94,10 @@ files:
 - Rakefile
 - VERSION
 - lib/mayi.rb
-- lib/mayi/access.rb
 - lib/mayi/access_denied_error.rb
-- lib/mayi/proxy.rb
+- lib/mayi/methods.rb
 - mayi.gemspec
+- spec/lib/test_helper.rb
 - spec/mayi_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/bjornblomqvist/mayi
@@ -115,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -398463573678793695
+      hash: -3855034540096933122
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/mayi/access.rb

@@ -1,79 +0,0 @@
-module MayI
-  class Access
-    
-    attr_accessor :implementation
-    
-    def initialize(implementation = nil)
-      self.implementation = implementation
-    end
-    
-    def refresh(data = {})
-      raise "You have not set any implementation yet" unless self.implementation
-      if self.implementation.is_a?(Class)
-        Thread.current["mayi_access_implementation_#{self.object_id}"] = self.implementation.new(data)
-      else
-        instance = self.implementation.to_s.split('::').reduce(Object){|cls, c| cls.const_get(c) }.new(data)
-        Thread.current["mayi_access_implementation_#{self.object_id}"] = instance
-      end
-      
-    end
-    
-    def clear
-      Thread.current["mayi_access_implementation_#{self.object_id}"] = nil
-    end
-    
-    def current_instance
-      raise "You must call refresh to create a new instance of your Access implementation before being able to use the access object." unless Thread.current["mayi_access_implementation_#{self.object_id}"]
-        
-      Thread.current["mayi_access_implementation_#{self.object_id}"]
-    end
-    
-    def method_missing(meth, *args, &block)
-      if meth.to_s =~ /^(may)_.*(\?|!)$/
-        if meth.to_s.end_with?("!")
-          if current_instance.send(meth.to_s[0..-2].to_sym,*args)
-            yield if block_given?
-            true
-          else
-            raise_error(meth)
-          end
-        elsif meth.to_s.end_with?("?")
-          if current_instance.send(meth.to_s[0..-2].to_sym,*args)
-            yield if block_given?
-            true
-          else
-            false
-          end
-        end
-      else
-        super(meth,*args,&block)  
-      end
-    end
-
-    def respond_to?(meth)
-      if meth.to_s =~ /^(may)_.*(\?|!)$/
-        super(meth.to_s[0..-2].to_sym)
-      else
-        super(meth)  
-      end
-    end
-    
-    def error_message(message)
-      Proxy.new(self) do |state|
-        if state == :before
-          @error_message = message
-        else
-          @error_message = nil
-        end
-      end 
-    end
-    
-    private
-    
-    def raise_error(meth)
-      error_message = meth.to_s[0..-2].gsub("_", " ").gsub("may","may not")
-      raise AccessDeniedError.new(@error_message || error_message)
-    end
-    
-  end
-end

data/lib/mayi/proxy.rb

@@ -1,19 +0,0 @@
-module MayI
-  class Proxy
-    instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$)/ }
-
-    def initialize(target,&block)
-      @target = target
-      @block = block
-    end
-
-    protected
-    
-    def method_missing(name, *args, &block)
-      @block.call(:before)
-      @target.send(name, *args, &block)
-    ensure
-      @block.call(:after)
-    end
-  end
-end