challah 0.7.1 → 0.8.0.pre

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Challah 0.8.0 (Unreleased)
+
+* Enabled plugin abilties through `Challah.register_plugin`. This restores the ability to use permissions and roles through the [challah-rolls gem](https://github.com/jdtornow/challah-rolls).
+
 ## Challah 0.7.1
 
 * Ensure users can be looked up by username as case insensitive value. Allows logins posted from iOS devices (with initial caps) to be valid usernames even when stored as caps.

data/lib/challah.rb

@@ -8,6 +8,8 @@ module Challah
 
   autoload :Controller,                       'challah/controller'
   autoload :Encrypter,                        'challah/encrypter'
+  autoload :Techniques,                       'challah/techniques'
+  autoload :Plugins,                          'challah/plugins'
   autoload :Random,                           'challah/random'
   autoload :Session,                          'challah/session'
   autoload :Techniques,                       'challah/techniques'
@@ -41,6 +43,9 @@ module Challah
   # Default registered authentication techiques.
   register_technique :api_key,        ApiKeyTechnique
   register_technique :password,       PasswordTechnique
+
+  extend Plugins
+  @plugins ||= {}
 end
 
 require 'challah/railtie' if defined?(Rails)

data/lib/challah/plugins.rb

@@ -0,0 +1,41 @@
+module Challah
+  # Plugins are used to extend the functionality of Challah.
+  module Plugins
+    # A simple DSL for registering a plugin
+    class Plugin
+      attr_reader :active_record, :action_controller, :user_extensions, :user_init_methods
+
+      def initialize
+        @active_record ||= []
+        @action_controller ||= []
+        @user_extensions ||= []
+        @user_init_methods ||= []
+      end
+
+      # When active_record or action_controller is loaded, run the given block
+      def on_load(framework, &block)
+        return unless [ :active_record, :action_controller ].include?(framework)
+        instance_variable_get("@#{framework}") << block
+      end
+
+      # Pass a module name to include it in the base User model after challah_user
+      # is run
+      def extend_user(module_name, init_method = nil)
+        @user_extensions << module_name
+        @user_init_methods << init_method unless init_method.nil?
+      end
+    end
+
+    # Register a new plugin.
+    def register_plugin(name, &block)
+      plugin = Plugin.new
+      plugin.instance_eval(&block)
+      @plugins[name] = plugin
+    end
+
+    # Get the list of all plugins
+    def plugins
+      @plugins
+    end
+  end
+end

data/lib/challah/railtie.rb

@@ -30,6 +30,13 @@ module Challah
             :logged_in?,
             :signed_in?
           )
+
+          # Load any ActionController/Challah plugins
+          Challah.plugins.values.each do |plugin|
+            plugin.action_controller.each do |proc|
+              proc.call
+            end
+          end
         end
       end
 
@@ -40,6 +47,13 @@ module Challah
 
           ActiveRecord::Base.send(:extend, Challah::User)
           ActiveRecord::Base.send(:include, Challah::Audit)
+
+          # Load any ActiveRecord/Challah plugins
+          Challah.plugins.values.each do |plugin|
+            plugin.active_record.each do |proc|
+              proc.call
+            end
+          end
         end
       end
     end

data/lib/challah/user.rb

@@ -1,4 +1,19 @@
 module Challah
+  class << self
+    # Loop through all registered plugins and extend User functionality.
+    def include_user_plugins!
+      Challah.plugins.values.each do |plugin|
+        plugin.user_extensions.each do |mod|
+          ::User.send(:extend, mod)
+        end
+
+        plugin.user_init_methods.each do |method_name|
+          ::User.send(method_name)
+        end
+      end
+    end
+  end
+
   module User
     def challah_user
       unless included_modules.include?(InstanceMethods)
@@ -59,6 +74,8 @@ module Challah
                             :session_count,
                             :updated_by
       end
+
+      Challah.include_user_plugins!
     end
 
     module ClassMethods

data/lib/challah/version.rb

@@ -1,3 +1,3 @@
 module Challah
-  VERSION = "0.7.1" unless defined?(::Challah::VERSION)
+  VERSION = "0.8.0.pre" unless defined?(::Challah::VERSION)
 end

data/test/plugins_test.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+class TestPlugins < ActiveSupport::TestCase
+  include Challah
+
+  class PluginContext
+    def self.setup_active_record
+    end
+
+    def self.setup_controllers
+    end
+  end
+
+  module UserStuff
+    def set_me_up
+      include AndMore
+    end
+
+    module AndMore
+      def hey_baller
+        "whatsup"
+      end
+    end
+  end
+
+  context "The plugin loader" do
+    should "be able to load a plugin and any dependencies" do
+      assert_equal false, Challah.plugins.has_key?(:tester)
+
+      Challah.register_plugin :tester do
+        on_load :active_record do
+          PluginContext.setup_active_record
+        end
+
+        on_load :action_controller do
+          PluginContext.setup_controllers
+        end
+      end
+
+      assert_equal true, Challah.plugins.has_key?(:tester)
+      assert_equal 1, Challah.plugins[:tester].active_record.size
+      assert_equal 1, Challah.plugins[:tester].action_controller.size
+
+      PluginContext.expects(:setup_active_record).once
+      PluginContext.expects(:setup_controllers).once
+
+      Challah::Engine.setup_active_record!
+      Challah::Engine.setup_action_controller!
+    end
+
+    should "be able to include a module when loading Challah::User" do
+      assert_equal false, ::User.included_modules.include?(UserStuff::AndMore)
+
+      Challah.register_plugin :user_mods do
+        extend_user UserStuff, :set_me_up
+      end
+
+      Challah.include_user_plugins!
+
+      assert_equal true, ::User.included_modules.include?(UserStuff::AndMore)
+
+      assert_equal "whatsup", ::User.new().hey_baller
+    end
+  end
+end

data/vendor/bundle/bin/convert_to_should_syntax

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'shoulda-context', version

data/vendor/bundle/bin/erubis

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'erubis', version

data/vendor/bundle/bin/rackup

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'rack', version

data/vendor/bundle/bin/rails

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'railties', version

data/vendor/bundle/bin/rake

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'rake', version

data/vendor/bundle/bin/rake2thor

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'thor', version

data/vendor/bundle/bin/rdiscount

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'rdiscount', version

data/vendor/bundle/bin/rdoc

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'rdoc', version

data/vendor/bundle/bin/ri

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'rdoc', version

data/vendor/bundle/bin/thor

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'thor', version

data/vendor/bundle/bin/tilt

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'tilt', version

data/vendor/bundle/bin/tt

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'treetop', version

data/vendor/bundle/bin/yard

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'yard', version

data/vendor/bundle/bin/yardoc

@@ -10,9 +10,13 @@ require 'rubygems'
 
 version = ">= 0"
 
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
 end
 
 gem 'yard', version