auth-assistant 0.4.0

data/lib/generators/migration_helper.rb

@@ -0,0 +1,81 @@
+require 'rails/generators/migration'
+require 'generators/auth_code_refactor'
+
+module AuthAssist
+  module MigrationHelper
+    include Rails::Generators::Migration
+
+    module ClassMethods    
+      def migration_lookup_at(dirname) #:nodoc:
+        Dir.glob("#{dirname}/[0-9]*_*.rb")
+      end
+
+      def migration_exists?(dirname, file_name) #:nodoc:
+        migration_lookup_at(dirname).grep(/\d+_#{file_name}.rb$/).first
+      end
+
+      def current_migration_number(dirname) #:nodoc:
+        migration_lookup_at(dirname).collect do |file|
+          File.basename(file).split("_").first.to_i
+        end.max.to_i
+      end
+
+      def next_migration_number(dirname) #:nodoc:
+        orm = Rails.configuration.generators.options[:rails][:orm]
+        require "rails/generators/#{orm}"
+        "#{orm.to_s.camelize}::Generators::Base".constantize.next_migration_number(dirname)
+      rescue
+        raise NotImplementedError
+      end
+    end         
+
+    def self.included(base) #:nodoc: 
+      puts "MigrationHelper included by #{base}"
+      base.extend ClassMethods      
+    end
+       
+   
+    def migration(options)   
+      # migration_template "migration.rb", "db/migrate/devise_create_#{table_name}"      
+      run "rails g migration #{options}"
+    end
+
+    protected
+
+      include CodeRefactor
+    
+      def model_exists?(name)
+        File.exists?(File.join(Rails.root, "app/models/#{name}.rb"))
+      end
+
+      def remove_model(name)
+        file = File.join(Rails.root, "app/models/#{name}.rb")        
+        FileUtils.rm file if file
+      end
+
+      def remove_role_model 
+        remove_model('role')        
+      end
+
+      def remove_role_assignment_model 
+        remove_model('role_assignment')        
+      end
+
+      def generate_role_model
+        return if model_exists?('role')
+        run 'rails g model Role name:string'
+        write_model_file('role', role_file_content)      
+      end
+
+      def generate_role_assignment_model
+        run 'rails g model RoleAssignment user_id:integer role_id:integer'          
+        return if model_exists?('role_assignment')
+        write_model_file('role_assignment', role_assignment_file_content)      
+      end
+    
+      def model_file(name)                          
+        File.join(Rails.root, "app/models/#{name}.rb")        
+      end    
+  end
+end
+

data/lib/generators/reverse_migrations.rb

@@ -0,0 +1,48 @@
+module AuthAssist
+  module MigrationHelper
+    def migration_dir
+      File.join(Rails.root, 'db/migrate')          
+    end
+    
+    def reverse_migration(mig_name)
+      if migration_exists?(mig_name)
+        new_migration = copy_migration(mig_name, "reverse_#{strategy_name}")
+        reverse_migration_method_names(new_migration)
+      end
+    end
+
+    def find_migration(name, &block)    
+      FileUtils.cd migration_dir do          
+        f = FileList['*.rb'].reject{|f| (f =~ /#{Regexp.escape(name)}/) == nil }.first
+        return block.call(f) if block
+      end
+      f
+    end
+
+    def migration_exists?(name)
+      find_migration(name)      
+    end
+
+    def copy_migration(name, new_name, &block) 
+      # create empty new migration
+      migration new_name
+      new_migration = find_migration(name)          
+      find_migration(name) do |mig|
+        FileUtils.cp mig, new_migration
+      end
+      return block.call(new_migration) if block
+      new_migration      
+    end
+
+    def reverse_migration_methods(new_migration) 
+      file_swap_content(new_migration, 'self.up', 'self.down')
+    end
+
+    def file_reverse(file, str1, str2) 
+      # use thor action          
+      file.replace str1, str2
+      file.replace str2, str1
+    end
+
+  end
+end

data/lib/generators/role_migrations.rb

@@ -0,0 +1,167 @@
+require 'generators/migration_helper'
+
+module AuthAssist
+  module RoleMigrations
+
+    def self.clazz(name)
+      "AuthAssist::RoleMigrations::#{name.camelize}".constantize      
+    end
+
+    class Base 
+      include ::AuthAssist::MigrationHelper
+
+      attr_accessor :generator
+
+      def initialize(generator)
+        @generator = generator
+      end
+                        
+      def generate_reverse_migration 
+        return reverse_migration if respond_to? :reverse_migration
+        generation.reverse_migration(migration_names.first)        
+      end   
+      
+      def setup
+        run_migration if respond_to? :run_migration
+        configure if respond_to? :configure
+      end   
+
+      protected
+        def migration(options)
+          generator.migration options
+        end       
+      
+        def insert_user_relation(relation)
+          generator.insert_user_relation relation        
+        end    
+
+        def remove_user_relation(relation)
+          generator.remove_user_relation(relation)
+        end
+      
+        def generate_role_model
+          generator.generate_role_model        
+        end
+
+        def remove_role_model
+          generator.remove_role_model
+        end
+
+        def remove_role_assignment_model
+          generator.remove_role_model
+        end
+      
+        def generate_role_assignment_model
+          generator.generate_role_assignment_model
+        end
+        
+        def migration_template(source, target)
+          generator.migration_template source, target
+        end  
+                
+    end
+
+    class AdminField < Base
+      def migration_names
+        ['add_admin_field_to_user']
+      end
+
+      def run_migration
+        migration "#{admin_field_migration_name} admin:boolean"
+      end
+    end
+
+
+    class RolesMask < Base
+      def migration_names
+        ['add_roles_mask_to_user']      
+      end        
+
+      def run_migration
+        migration "#{roles_mask_migration_name} roles_mask:integer"
+      end              
+    end
+
+       
+    class RolesField < Base
+      def migration_names
+        ['add_roles_field_to_user']      
+      end
+
+      def run_migration
+        migration "#{roles_field_migration_name} roles:string"
+      end
+            
+    end
+
+       
+    class RoleField < Base
+      def migration_names      
+        ['add_role_field_to_user']      
+      end
+
+      def run_migration
+        migration "#{role_field_migration_name} role:string"
+      end            
+    end
+
+
+    class RoleAssignment < Base
+      def migration_names
+        ['add_role_id_to_user', 'create_roles']
+      end
+
+      def run_migration
+        migration 'add_role_id_to_user role_id:integer'
+        migration 'create_roles name:string'
+      end
+
+      def configure
+        generate_role_model
+        insert_user_relation(has_roles)
+      end        
+
+      def reverse_configure
+        remove_role_model
+        remove_user_relation(has_roles)
+      end        
+      
+      def reverse_migration      
+        migration_template 'remove_role_assignments_migration.rb', 'remove_role_assignments'
+      end                
+    end
+
+    class MultiRoleAssignment < Base
+      def migration_names
+        ['add_role_assignment_id_to_user', 'create_role_assignments', 'create_roles']
+      end
+
+      def run_migration        
+        migration 'add_role_assignment_id_to_user role_assignment_id:integer'
+        migration 'create_role_assignments role_id:integer user_id:integer'      
+        migration 'create_roles name:string'
+      end
+
+      def configure      
+        insert_user_relation(has_role_assignments)
+        insert_user_relation(has_roles_through_assignments)
+
+        generate_role_model
+        generate_role_assignment_model      
+      end
+      
+      def reverse_configure
+        remove_role_model
+        remove_role_assignment_model
+
+        remove_user_relation(has_role_assignments)
+        remove_user_relation(has_roles_through_assignments)
+      end        
+           
+      def reverse_migration      
+        migration_template 'remove_multi_role_assignments_migration.rb', 'remove_multi_role_assignments'
+      end                
+      
+    end
+  end
+end

data/lib/permits.rb

@@ -0,0 +1,92 @@
+module RolePermit
+
+  class Base 
+    attr_accessor :ability
+       
+    def initialize(ability)
+      @ability = ability
+    end
+
+    def can(action, subject, conditions = nil, &block)
+      ability.can(action, subject, conditions, &block)
+    end
+        
+    def cannot(action, subject, conditions = nil, &block)
+      ability.cannot(action, subject, conditions, &block)
+    end
+    
+    def owns(user, clazz)
+      can :manage, clazz do |comment|
+        comment.try(:user) == user || comment.try(:owner) == user
+      end                
+    end 
+    
+    def permit?(user)    
+      user.has ability      
+    end
+  end
+  
+  class Admin < Base
+    def initialize(ability)
+      super
+    end
+
+    def permit?(user)    
+      super
+      return if !user.role? :admin    
+      can :manage, :all    
+    end  
+  end
+
+  class User < Base
+    def initialize(ability)
+      super
+    end
+
+    def permit?(user) 
+      super
+      return if user.role? :admin
+      can :read, :all           
+      
+      # user.owns(Comment)
+      
+      # a user can manage comments he/she created
+      # can :manage, Comment do |comment|
+      #   comment.try(:user) == user
+      # end            
+      
+      # can :create, Comment
+    end  
+  end
+
+  class Moderator < Base
+    def initialize(ability)
+      super
+    end
+    
+    def permit?(user)
+      super
+      return if !user.role?(:moderator)
+      can :read, :all      
+      # owns(user, Comment)
+    end  
+  end
+
+
+  class Author < Base
+    def initialize(ability)
+      super
+    end
+    
+    def permit?(user)     
+      super      
+      return if !user.role? :author
+      # can :create, Post
+
+      # an author can manage posts he/she created      
+      # can :update, Post do |post|
+      #   post.try(:user) == user      
+      # end
+    end  
+  end
+end

data/spec/auth-assistant_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AuthAssistant" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/generators/ability_gen_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'generators/auth_assistant/ability/ability_generator'
+
+describe "DeviseAssistant Ability Generator" do
+  it "works" do
+    puts "it works"
+  end
+end

data/spec/sandbox.rb

@@ -0,0 +1,9 @@
+class Hello
+  def hi
+    puts "hi"
+  end
+  
+  alias_method :hello, :hi
+end
+
+Hello.new.hello

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
+require 'rspec/autorun' 
+require 'rails'
+# require 'auth-assistant'
+
+Rspec.configure do |c|
+  # c.mock_with :rspec
+end
+

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: auth-assistant
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cancan
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id003
+description: Provides assistance for setting up an auth solution using devise and cancan auth frameworks
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .DS_Store
+- .document
+- .gitignore
+- Changelog.txt
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- app/.DS_Store
+- app/views/.DS_Store
+- app/views/auth_assist/menu/_admin_login_items.html.erb
+- app/views/auth_assist/menu/_login_items.html.erb
+- app/views/auth_assist/menu/_registration_items.html.erb
+- auth-assistant.gemspec
+- config/locales/en.yml
+- init.rb
+- lib/.DS_Store
+- lib/auth-assistant.rb
+- lib/auth_assistant/configure.rb
+- lib/auth_assistant/helpers/admin_role.rb
+- lib/auth_assistant/helpers/all.rb
+- lib/auth_assistant/helpers/localhost.rb
+- lib/auth_assistant/helpers/roles.rb
+- lib/auth_assistant/helpers/user_role.rb
+- lib/auth_assistant/model/user_config.rb
+- lib/auth_assistant/role_strategies/admin_field.rb
+- lib/auth_assistant/role_strategies/all.rb
+- lib/auth_assistant/role_strategies/multi_role_assignment.rb
+- lib/auth_assistant/role_strategies/role_assignment.rb
+- lib/auth_assistant/role_strategies/role_field.rb
+- lib/auth_assistant/role_strategies/roles_field.rb
+- lib/auth_assistant/role_strategies/roles_mask.rb
+- lib/auth_assistant/role_strategies/shared.rb
+- lib/auth_assistant/translate/authlabels.rb
+- lib/auth_assistant/view/all.rb
+- lib/auth_assistant/view/auth_menu_item.rb
+- lib/auth_assistant/view/registration_link.rb
+- lib/auth_assistant/view/rest_link.rb
+- lib/auth_assistant/view/session_link.rb
+- lib/generators/.DS_Store
+- lib/generators/auth_assist/.DS_Store
+- lib/generators/auth_assist/clear/clear_generator.rb
+- lib/generators/auth_assist/config/.DS_Store
+- lib/generators/auth_assist/config/config_generator.rb
+- lib/generators/auth_assist/templates/ability.rb
+- lib/generators/auth_assist/templates/auth_assistant.rb
+- lib/generators/auth_assist/templates/permits.rb
+- lib/generators/auth_assist/templates/remove_multi_role_assignments_migration.rb
+- lib/generators/auth_assist/templates/remove_role_assignments_migration.rb
+- lib/generators/auth_assist/templates/role_assignments_migration.rb
+- lib/generators/auth_assist/templates/roles_migration.rb
+- lib/generators/auth_assist/test.rb
+- lib/generators/auth_assist/views/views_generator.rb
+- lib/generators/auth_code_refactor.rb
+- lib/generators/migration_helper.rb
+- lib/generators/reverse_migrations.rb
+- lib/generators/role_migrations.rb
+- lib/permits.rb
+- spec/auth-assistant_spec.rb
+- spec/generators/ability_gen_spec.rb
+- spec/sandbox.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/devise-assistant
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provides assistance for setting up an auth solution
+test_files: 
+- spec/auth-assistant_spec.rb
+- spec/generators/ability_gen_spec.rb
+- spec/sandbox.rb
+- spec/spec_helper.rb