cantango 0.8.0

data/lib/cantango/permit_engine/role_permit.rb

@@ -0,0 +1,38 @@
+module CanTango
+  module PermitEngine
+    class RolePermit < CanTango::PermitEngine::Permit
+
+      autoload_modules :Builder, :Finder
+
+      def role
+        self.class.name.demodulize.gsub(/(.*)(RolePermit)/, '\1').underscore.to_sym
+      end
+
+      # creates the permit
+      # @param [Permits::Ability] the ability
+      # @param [Hash] the options
+      def initialize ability
+        super
+      end
+
+
+      # In a specific Role based Permit you can use 
+      #   def permit? user, options = {}
+      #     ... permission logic follows
+      #
+      # This will call the Permit::Base#permit? instance method (the method below)
+      # It will only return true if the user matches the role of the Permit class and the
+      #
+      # If these confitions are not met, it will return false and thus the outer permit 
+      # will not run the permission logic to follow
+      #
+      # Normally super for #permit? should not be called except for this case, 
+      # or if subclassing another Permit than Permit::Base
+      #
+      def permit?
+        super
+      end
+    end
+
+  end
+end

data/lib/cantango/permit_engine/role_permit/builder.rb

@@ -0,0 +1,46 @@
+module CanTango
+  module PermitEngine
+    class RolePermit < CanTango::PermitEngine::Permit
+      class Builder < CanTango::PermitEngine::Builder::Base
+        # class NoAvailableRoles < StandardError; end
+
+        # builds a list of Permits for each role of the current ability user (or account)
+        # @return [Array<RoleGroupPermit::Base>] the role permits built for this ability
+        def build
+          # raise NoAvailableRoles, "no available roles are defined" if available_roles.empty?
+          roles.inject([]) do |permits, role|
+            (permits << create_permit(role)) if valid?(role.to_sym)
+            permits
+          end.compact
+        end
+
+        def finder
+          CanTango::PermitEngine::RolePermit::Finder
+        end
+
+        protected
+
+        def valid? role
+          return false if not_only_role?(role)
+          !excluded? role
+        end
+
+        def not_only_role? role
+          !only_roles.empty? && !only_roles.include?(role)
+        end
+
+        def excluded? role
+          excluded_roles.include? role
+        end
+
+        def only_roles
+          CanTango.config.roles.onlies
+        end
+
+        def excluded_roles
+          CanTango.config.roles.excluded
+        end
+      end
+    end
+  end
+end

data/lib/cantango/permit_engine/role_permit/finder.rb

@@ -0,0 +1,19 @@
+module CanTango
+  module PermitEngine
+    class RolePermit < CanTango::PermitEngine::Permit
+      class Finder < CanTango::PermitEngine::Finder
+        def initialize account, name
+          super
+        end
+
+        def type
+          :role
+        end
+
+        def permit_class
+          "#{name.to_s.camelize}RolePermit"
+        end
+      end
+    end
+  end
+end

data/lib/cantango/permit_engine/user_permit.rb

@@ -0,0 +1,40 @@
+module CanTango
+  module PermitEngine
+    class UserPermit < CanTango::PermitEngine::Permit
+
+      autoload_modules :Builder, :Finder
+
+      # fx for User user class, becomes simply UserPermit
+      def user_type
+        self.class.name.demodulize.gsub(/(.*)(Permit)/, '\1').underscore.to_sym
+      end
+
+      # creates the permit
+      # @param [Permits::Ability] the ability
+      # @param [Hash] the options
+      def initialize ability
+        super
+      end
+
+
+      # In a specific Role based Permit you can use 
+      #   def permit? user, options = {}
+      #     ... permission logic follows
+      #
+      # This will call the Permit::Base#permit? instance method (the method below)
+      # It will only return true if the user matches the role of the Permit class and the
+      #
+      # If these confitions are not met, it will return false and thus the outer permit 
+      # will not run the permission logic to follow
+      #
+      # Normally super for #permit? should not be called except for this case, 
+      # or if subclassing another Permit than Permit::Base
+      #
+      def permit?
+        super
+      end
+    end
+
+  end
+end
+

data/lib/cantango/permit_engine/user_permit/builder.rb

@@ -0,0 +1,21 @@
+module CanTango
+  module PermitEngine
+    class UserPermit < CanTango::PermitEngine::Permit
+      class Builder < CanTango::PermitEngine::Builder::Base
+        # class NoAvailableRoles < StandardError; end
+
+        # builds a list of Permits for each role of the current ability user (or account)
+        # @return [Array<RoleGroupPermit::Base>] the role permits built for this ability
+        def build
+          # raise NoAvailableRoles, "no available roles are defined" if available_roles.empty?
+          [] << create_permit(user.class.to_s)
+        end
+
+        def finder
+          CanTango::PermitEngine::UserPermit::Finder
+        end
+      end
+    end
+  end
+end
+

data/lib/cantango/permit_engine/user_permit/finder.rb

@@ -0,0 +1,20 @@
+module CanTango
+  module PermitEngine
+    class UserPermit < CanTango::PermitEngine::Permit
+      class Finder < CanTango::PermitEngine::Finder
+        def initialize account, name
+          super
+        end
+
+        def type
+          :user
+        end
+
+        def permit_class
+          "#{name.to_s.camelize}Permit"
+        end
+      end
+    end
+  end
+end
+

data/lib/cantango/permit_engine/util.rb

@@ -0,0 +1,19 @@
+require 'active_support/inflector'
+
+module CanTango
+  module PermitEngine
+    module Util
+      def permit_name clazz
+        @name ||= clazz.to_s.demodulize.gsub(/Role/,'').gsub(/Permit$/, '').gsub(/Group/,'').underscore.to_sym
+      end
+
+      def role
+        @role ||= permit_name(self.class)
+      end
+
+      def localhost_manager?
+        Permits::Configuration.localhost_manager
+      end
+    end
+  end
+end

data/lib/cantango/rails.rb

@@ -0,0 +1,5 @@
+module CanTango
+  module Rails
+    autoload_modules :ControllerHelpers, :ViewHelpers, :BaseHelpers
+  end
+end

data/lib/cantango/rails/base_helpers.rb

@@ -0,0 +1,26 @@
+module CanTango
+  module Rails
+    module BaseHelpers
+      def self.included(base)
+        include_apis(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def include_apis(clazz)
+          return if !respond_to?(:apis) || !apis
+          apis.each do |api|
+            clazz.send :include, "CanTango::Api::User::#{api}".constantize
+            clazz.send :include, "CanTango::Api::UserAccount::#{api}".constantize
+          end
+        end
+
+        def apis
+          [:Can, :Scope]
+        end
+      end
+      extend ClassMethods
+    end
+  end
+end
+

data/lib/cantango/rails/controller_helpers.rb

@@ -0,0 +1,15 @@
+module CanTango
+  module Rails
+    module ControllerHelpers
+      include CanTango::Rails::BaseHelpers
+
+      def self.included(base)
+        include_apis(self)
+      end
+
+      def self.apis
+        [] # [:Can, :Active, :Scope]
+      end
+    end
+  end
+end

data/lib/cantango/rails/engine.rb

@@ -0,0 +1,47 @@
+module CanTango
+  # Include helpers in the given scope to AC and AV.
+  # "Borrowed" from devise
+  def self.include_helpers(scope)
+    ActiveSupport.on_load(:action_controller) do
+
+      include scope::Rails::ControllerHelpers
+    end
+
+    ActiveSupport.on_load(:action_view) do
+
+      include scope::Rails::ViewHelpers
+    end
+  end
+
+  class Engine < ::Rails::Engine
+    initializer "cantango.helpers" do
+      CanTango.include_helpers(CanTango)
+
+      # load all models
+      # this is needed in order to register all users and accounts with CanTango using the user/account macros!
+      RailsAutoLoader.load_models! if CanTango.config.autoload.models?
+
+      # load all permits
+      RailsAutoLoader.load_permits! if CanTango.config.autoload.permits?
+    end
+  end
+
+  module RailsAutoLoader
+    def self.load_models!
+      load_files! :models
+    end
+
+    def self.load_permits!
+      load_files! :permits
+    end
+
+    private
+
+    def self.load_files! path
+      Dir[::Rails.root + "app/#{path}/**/*.rb"].each do |path|
+        require path
+      end
+    end
+  end
+end
+

data/lib/cantango/rails/railtie.rb

@@ -0,0 +1,7 @@
+module CanTango
+  class Railtie < Rails::Railtie
+    initializer "cantango" do |app|
+      puts "initializing CanTango..."
+    end
+  end
+end

data/lib/cantango/rails/view_helpers.rb

@@ -0,0 +1,15 @@
+module CanTango
+  module Rails
+    module ViewHelpers
+      include CanTango::Rails::BaseHelpers
+
+      def self.included(base)
+        include_apis(self)
+      end
+
+      def self.apis
+        [] # [:Can, :Active, :Scope]
+      end
+    end
+  end
+end

data/lib/cantango/rspec.rb

@@ -0,0 +1 @@
+require 'cantango/rspec/config'

data/lib/cantango/rspec/config.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'code-spec'
+require 'cantango/rspec/matchers'
+
+RSpec.configure do |config|
+  config.include RSpec::RubyContentMatchers::License
+  config.include RSpec::RubyContentMatchers::LicenseClass
+  config.include RSpec::RubyContentMatchers::LicenseFile  
+end

data/lib/cantango/rspec/matchers.rb

@@ -0,0 +1,9 @@
+module RSpec
+  module RubyContentMatchers
+    autoload :License,       'cantango/rspec/matchers/have_license'
+    autoload :LicenseClass,  'cantango/rspec/matchers/have_license_class'
+    autoload :LicenseFile,   'cantango/rspec/matchers/have_license_file'
+  end
+end
+
+require 'cantango/rspec/matchers/be_allowed_to'

data/lib/cantango/rspec/matchers/be_allowed_to.rb

@@ -0,0 +1,26 @@
+# http://solnic.eu/2011/01/14/custom-rspec-2-matchers.html
+
+
+RSpec::Matchers.define :be_allowed_to do |action, objects|
+  chain :with_options do |options|
+    @options = options
+  end
+  
+  match do |subject|
+    @options ? subject.can?(action, objects, @options) : subject.can?(action, objects)
+  end
+
+  failure_message_for_should do |subject|
+    "expected that #{subject} could a #{action} the #{objects}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "did not expect that #{subject} could a #{action} the #{objects}"
+  end
+
+  description do
+    "be allowed to #{action} the #{objects}"
+  end
+end
+
+

data/lib/cantango/rspec/matchers/have_license.rb

@@ -0,0 +1,11 @@
+module RSpec::RubyContentMatchers
+  module License
+    def have_license name
+      have_call :licenses, :args => [name.to_sym]
+    end
+
+    def have_licenses *names
+      have_call :licenses, :args => names.to_symbols
+    end
+  end
+end

data/lib/cantango/rspec/matchers/have_license_class.rb

@@ -0,0 +1,14 @@
+module RSpec::RubyContentMatchers
+  module LicenseClass
+    def have_license_class name, superclass = 'License::Base'
+      superclass ? have_subclass(name.to_s + 'License', superclass) : have_class(name)
+    end
+
+    def have_license_classes *names
+      names.each do |name|
+        return false if !have_license_class(name)
+      end
+      true
+    end
+  end
+end

data/lib/cantango/rspec/matchers/have_license_file.rb

@@ -0,0 +1,82 @@
+require 'rails-app-spec'
+
+module RSpec::RubyContentMatchers
+  module LicenseFile
+    class HaveLicenseFile
+      include ::RailsAssist::Artifact::Directory
+      include ::RailsAssist::Directory
+
+      attr_reader :name
+
+      def initialize name
+        @name = name
+      end
+
+      def license_dir
+        File.join(app_dir, 'licenses')
+      end
+
+      def license_file name
+        File.join(license_dir, "#{name}_license.rb")
+      end
+
+      def matches? obj, &block
+        file_name = license_file(name)
+        found = File.file? file_name
+        yield File.read(file_name) if block && found
+        found
+      end
+
+      def failure_message
+        "No license file found for #{name} in #{license_dir} as expected"
+      end
+
+      def negative_failure_message
+        "License file #{name} found in #{license_dir} but was not expected"
+      end
+
+    end
+
+    def have_license_file name
+      HaveLicenseFile.new name
+    end
+
+    class HaveLicenseFiles
+      include ::RailsAssist::Artifact::Directory
+      include ::RailsAssist::Directory
+
+      attr_reader :names
+
+      def initialize *names
+        @names = names.flatten
+      end
+
+      def license_dir
+        File.join(app_dir, 'licenses')
+      end
+
+      def license_file name
+        File.join(license_dir, "#{name}_license.rb")
+      end
+
+      def matches? obj, &block
+        names.flatten.each do |name|
+          return false if !File.file? license_file(name)
+        end
+        true
+      end
+
+      def failure_message
+        "License files #{names} not found in #{license_dir} as expected"
+      end
+
+      def negative_failure_message
+        "License files #{names} found in #{license_dir} but was not expected"
+      end
+    end
+
+    def have_license_files *names
+      HaveLicenseFiles.new names
+    end
+  end
+end