faalis 2.0.8 → 2.1.0

data/lib/faalis/configuration.rb

@@ -1,56 +1,83 @@
-module Faalis::Configuration
-
-  # Configure logger
-  mattr_accessor :logger
-  @@logger = Logger.new(STDOUT)
-
-  # Dashboard url prefix
-  mattr_accessor :dashboard_namespace
-  @@dashboard_namespace = :dashboard
-
-  # ==> ORM configuration
-  # Load and configure the ORM. Supports :active_record (default) and
-  # :mongoid (bson_ext recommended) by default. Other ORMs may be
-  # available as additional gems.
-  # ORM name to use. either 'active_record' or 'mongoid'
-  mattr_accessor :orm
-
-  def orm=(orm_name)
-    @@orm = orm_name
-    require "devise/orm/#{orm_name}"
-  end
+module Faalis
+  module Configuration
+
+    @@modules_to_load = {}
 
-  # We have to move this method somewhere else
-  def collect_i18n_missing_keys=(value)
-    if value
-      ::I18n.exception_handler = Faalis::I18n::MissingKeyHandler.new
+    # Configure logger
+    mattr_accessor :logger do
+      Logger.new(STDOUT)
+    end
+
+    # Dashboard url prefix
+    mattr_accessor :dashboard_namespace do
+      :dashboard
+    end
+
+    # ==> ORM configuration
+    # Load and configure the ORM. Supports :active_record (default) and
+    # :mongoid (bson_ext recommended) by default. Other ORMs may be
+    # available as additional gems.
+    # ORM name to use. either 'active_record' or 'mongoid'
+    mattr_accessor :orm
+
+    def orm=(orm_name)
+      @@orm = orm_name
+      require "devise/orm/#{orm_name}"
+    end
+
+    # We have to move this method somewhere else
+    def collect_i18n_missing_keys=(value)
+      if value
+        ::I18n.exception_handler = Faalis::I18n::MissingKeyHandler.new
+      end
+    end
+
+    # Site Title
+    attr_accessor :site_title do
+      'Faalis'
+    end
+
+    mattr_accessor :slug
+
+    # Dashboard default javascript manifest
+    mattr_accessor :dashboard_js_manifest do
+      'dashboard/application.js'
     end
-  end
 
-  # Site Title
-  attr_accessor :site_title
-  @site_title = 'Faalis'
-
-  mattr_accessor :slug
-
-  # Dashboard default javascript manifest
-  mattr_accessor :dashboard_js_manifest
-  @@dashboard_js_manifest = 'dashboard/application.js'
-
-  # Devise options
-  # Include default devise modules. Others available are:
-  # :token_authenticatable, :confirmable,
-  # :lockable, :timeoutable and :omniauthable
-  mattr_accessor :devise_options
-  @@devise_options = [:database_authenticatable,
-                      :registerable,
-                      :recoverable,
-                      :rememberable,
-                      :trackable,
-                      :lockable,
-                      :timeoutable,
-                      :validatable]
-
-  mattr_accessor :devise_for
-  @@devise_for = {}
+    # Devise options
+    # Include default devise modules. Others available are:
+    # :token_authenticatable, :confirmable,
+    # :lockable, :timeoutable and :omniauthable
+    mattr_accessor :devise_options do
+      [:database_authenticatable, :registerable,
+        :recoverable, :rememberable, :trackable,
+        :lockable, :timeoutable, :validatable]
+    end
+
+    mattr_accessor :devise_for do
+      {}
+    end
+
+    mattr_accessor :amd_dir do
+      'amd'
+    end
+
+    mattr_accessor :amd do
+      true
+    end
+
+    @@modules_to_load[:amd] = ['amd']
+
+    def load_dependencies_based_on_configuration
+
+      @@modules_to_load.each do |k, v|
+        v.map { |mod| require mod } if send(k)
+      end
+    end
+
+    def enabled?(configuration)
+      puts "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<", configuration, @@modules_to_load.include?(configuration)
+      @@modules_to_load.include? configuration
+    end
+  end
 end

data/lib/faalis/dashboard/dsl.rb

@@ -8,6 +8,7 @@ require_dependency 'faalis/dashboard/sections/sidebar'
 
 module Faalis::Dashboard
   module DSL
+
     extend ActiveSupport::Concern
 
     include Faalis::Dashboard::Sections::Resource

data/lib/faalis/dashboard/models/sidebar.rb

@@ -1,7 +1,7 @@
 module Faalis::Dashboard::Models
   class Item
 
-    attr_reader :title, :url, :icon, :model
+    attr_reader :title, :url, :icon, :model, :members_only
     def initialize(title, options)
       @title = title
       @model = nil
@@ -28,11 +28,11 @@ module Faalis::Dashboard::Models
     end
 
     private
-      def extract_options(options)
-        options.each do |key, value|
-          instance_variable_set("@#{key}", value)
-        end
+    def extract_options(options)
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
       end
+    end
   end
 
   class Menu < Item
@@ -45,6 +45,15 @@ module Faalis::Dashboard::Models
       @children << child
     end
 
+    def initialize(title, options)
+      children = options.delete :children
+      if children
+        @children = children.map do |child|
+          Item.new(child.delete(:title), child)
+        end
+      end
+      super
+    end
   end
 
   class RootMenu < Array
@@ -91,23 +100,40 @@ module Faalis::Dashboard::Models
 
     def faalis_entries
       menu(t('faalis.dashboard.user_management'),
-           icon: 'fa fa-users',
-           model: 'Faalis::User') do
+        icon: 'fa fa-users',
+        model: 'Faalis::User') do
         item(I18n.t('faalis.dashboard.users'),
-             model: 'Faalis::User',
-             url: Faalis::Engine.routes.url_helpers.dashboard_auth_users_path)
+          model: 'Faalis::User',
+          url: Faalis::Engine.routes.url_helpers.dashboard_auth_users_path)
 
         item(I18n.t('faalis.dashboard.groups'),
-             model: 'Faalis::Group',
-             url: Faalis::Engine.routes.url_helpers.dashboard_auth_groups_path)
+          model: 'Faalis::Group',
+          url: Faalis::Engine.routes.url_helpers.dashboard_auth_groups_path)
+
+      end
+
+      menu(t('faalis.dashboard.user_messages'),
+        icon: 'fa fa-envelope-o',
+        model: 'Faalis::UserMessage') do
+
+        item(I18n.t('faalis.dashboard.user_messages.inbox'),
+          model: 'Faalis::UserMessage',
+          url: Faalis::Engine.routes.url_helpers.dashboard_user_messages_path)
+        item(I18n.t('faalis.dashboard.user_messages.sent'),
+          model: 'Faalis::UserMessage',
+          url: Faalis::Engine.routes.url_helpers.dashboard_user_messages_path)
+        item(I18n.t('faalis.dashboard.user_messages.draft'),
+          model: 'Faalis::UserMessage',
+          url: Faalis::Engine.routes.url_helpers.dashboard_user_messages_path)
+
       end
     end
 
     private
-      def extract_options(options)
-        @icon  = options.delete(:icon)
-        @id    = options.delete(:id)
-        @class = options.delete(:class)
-      end
+    def extract_options(options)
+      @icon  = options.delete(:icon)
+      @id    = options.delete(:id)
+      @class = options.delete(:class)
+    end
   end
 end

data/lib/faalis/dashboard/sections/resource.rb

@@ -13,176 +13,175 @@ module Faalis::Dashboard::Sections
 
     protected
 
-      def _resources
-        instance_variable_get("@{plural_name")
-      end
+    def _resources
+      instance_variable_get("@{plural_name")
+    end
 
-      def plural_name
-        controller_name.underscore
-      end
+    def plural_name
+      controller_name.underscore
+    end
 
-      def model_name
-        controller_path.gsub('dashboard/', '').classify
-      end
+    def model_name
+      "::#{controller_path.gsub('dashboard/', '').classify}"
+    end
 
-      def model
-        "::#{model_name}".constantize
-      rescue
-        msg = "Can't find model '::#{model_name}'. Please override \
-              'model' method in your dashboard controller."
-        fail NameError, msg
-      end
+    def model
+      model_name.constantize
+    rescue
+      msg = "Can't find model '#{model_name}'. Please override 'model' method in your dashboard controller."
+      fail NameError, msg
+    end
 
-      def namespace
-        pieces = controller_path.gsub('dashboard/', '').split('/')
-        return '' if pieces.length == 1
+    def namespace
+      pieces = controller_path.gsub('dashboard/', '').split('/')
+      return '' if pieces.length == 1
 
-        pieces.pop
-        pieces.join('/')
-      end
+      pieces.pop
+      pieces.join('/')
+    end
 
-      def _route_engine
-        if namespace.empty?
-          Rails.application
+    def _route_engine
+      if namespace.empty?
+        Rails.application
+      else
+        engine = "#{namespace.split('/')[0]}::Engine".classify
+        if Object.const_defined? engine
+          engine.constantize
         else
-          engine = "#{namespace.split('/')[0]}::Engine".classify
-          if Object.const_defined? engine
-            engine.constantize
-          else
-            logger.info 'You are using locale modules please define route_engine in your controller'
-            Rails.application
-          end
+          logger.info 'You are using locale modules please define route_engine in your controller'
+          Rails.application
         end
       end
+    end
 
-      # Return the array of action buttons in given `property_object`.
-      # `property_object` is an instance of once of DSL classes.
-      def action_buttons(property_object)
-        @_action_buttons = property_object.action_buttons || []
-      end
+    # Return the array of action buttons in given `property_object`.
+    # `property_object` is an instance of once of DSL classes.
+    def action_buttons(property_object)
+      @_action_buttons = property_object.action_buttons || []
+    end
 
-      def _engine
-        nil
-      end
+    def _engine
+      nil
+    end
 
     private
 
-      def _route_name
-        nil
-      end
-
-      def attachment_fields
-        if model.respond_to? :attachment_definitions
-          return model.attachment_definitions.keys
-        end
+    def _route_name
+      nil
+    end
 
-        []
+    def attachment_fields
+      if model.respond_to? :attachment_definitions
+        return model.attachment_definitions.keys
       end
 
-      def has_attachment?
-        !attachment_fields.empty?
-      end
+      []
+    end
 
-      def guess_index_route(scope  = 'dashboard')
-        scope_ = "#{scope}_"
-        scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
+    def has_attachment?
+      !attachment_fields.empty?
+    end
 
-        name   = controller_name
-        if name.singularize == name.pluralize
-          "#{scope_}#{name}_index_path"
-        else
-          "#{scope_}#{name}_path"
-        end
+    def guess_index_route(scope  = 'dashboard')
+      scope_ = "#{scope}_"
+      scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
+
+      name   = controller_name
+      if name.singularize == name.pluralize
+        "#{scope_}#{name}_index_path"
+      else
+        "#{scope_}#{name}_path"
       end
+    end
 
-      def guess_show_route(scope  = 'dashboard')
-        scope_        = "#{scope}_"
-        scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
+    def guess_show_route(scope  = 'dashboard')
+      scope_        = "#{scope}_"
+      scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
 
-        resource_name = controller_name.singularize.underscore
-        "#{scope_}#{resource_name}_path".gsub('/', '_')
-      end
+      resource_name = controller_name.singularize.underscore
+      "#{scope_}#{resource_name}_path".gsub('/', '_')
+    end
 
-      def guess_edit_route(scope  = 'dashboard')
-        scope_        = "#{scope}_"
-        scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
+    def guess_edit_route(scope  = 'dashboard')
+      scope_        = "#{scope}_"
+      scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
 
-        resource_name = controller_name.singularize.underscore
-        "edit_#{scope_}#{resource_name}_path".gsub('/', '_')
-      end
+      resource_name = controller_name.singularize.underscore
+      "edit_#{scope_}#{resource_name}_path".gsub('/', '_')
+    end
 
-      def guess_new_route(scope  = 'dashboard')
-        scope_        = "#{scope}_"
-        scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
+    def guess_new_route(scope  = 'dashboard')
+      scope_        = "#{scope}_"
+      scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
 
-        resource_name = controller_name.singularize.underscore
-        "new_#{scope_}#{resource_name}_path".gsub('/', '_')
-      end
+      resource_name = controller_name.singularize.underscore
+      "new_#{scope_}#{resource_name}_path".gsub('/', '_')
+    end
 
-      def guess_edit_route(scope  = 'dashboard')
-        scope_        = "#{scope}_"
-        scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
+    def guess_edit_route(scope  = 'dashboard')
+      scope_        = "#{scope}_"
+      scope_ = "#{scope_}#{namespace}_" if !namespace.blank? && _engine.nil?
 
-        resource_name = controller_name.singularize.underscore
-        "edit_#{scope_}#{resource_name}_path".gsub('/', '_')
-      end
+      resource_name = controller_name.singularize.underscore
+      "edit_#{scope_}#{resource_name}_path".gsub('/', '_')
+    end
 
-      def setup_named_routes
-        @engine        = _engine || _route_engine
-        @index_route   = guess_index_route
-        @new_route     = guess_new_route
-        @show_route    = guess_show_route
-        @edit_route    = guess_edit_route
-      end
+    def setup_named_routes
+      @engine        = _engine || _route_engine
+      @index_route   = guess_index_route
+      @new_route     = guess_new_route
+      @show_route    = guess_show_route
+      @edit_route    = guess_edit_route
+    end
 
-      def successful_response(section, msg = nil)
-        @_msg = msg
+    def successful_response(section, msg = nil)
+      @_msg = msg
 
-        respond_to do |f|
-          if _override_views.include? section.to_sym
-            f.js
-            f.html
-          else
-            flash[:success] = msg
-            # Engine to fetch the route from
-            engine = _engine || Rails.application
-            path   = engine.routes.url_helpers.send(@index_route)
-            # TODO: We really need to put setup routed on top of this method
-            f.js { render "faalis/dashboard/resource/#{section}" }
-            f.html { redirect_to path }
-          end
+      respond_to do |f|
+        if _override_views.include? section.to_sym
+          f.js
+          f.html
+        else
+          flash[:success] = msg
+          # Engine to fetch the route from
+          engine = _engine || Rails.application
+          path   = engine.routes.url_helpers.send(@index_route)
+          # TODO: We really need to put setup routed on top of this method
+          f.js { render "faalis/dashboard/resource/#{section}" }
+          f.html { redirect_to path }
         end
       end
+    end
 
-      def errorful_resopnse(section, msg = nil, &block)
-        @_msg = msg
+    def errorful_resopnse(section, msg = nil, &block)
+      @_msg = msg
+
+      respond_to do |f|
+        if _override_views.include? section.to_sym
+          f.js { render :errors }
+          f.html { render :errors }
+        else
+          flash[:error] = msg
 
-        respond_to do |f|
-          if _override_views.include? section.to_sym
-            f.js { render :errors }
-            f.html { render :errors }
+          # Engine to fetch the route from
+          engine = _engine || Rails.application
+          path   = engine.routes.url_helpers.send(@index_route)
+          # TODO: We really need to put setup routed on top of this method
+
+          f.js { render 'faalis/shared/errors' }
+          if block_given?
+            f.html(&block)
           else
-            flash[:error] = msg
-
-            # Engine to fetch the route from
-            engine = _engine || Rails.application
-            path   = engine.routes.url_helpers.send(@index_route)
-            # TODO: We really need to put setup routed on top of this method
-
-            f.js { render 'faalis/shared/errors' }
-            if block_given?
-              f.html(&block)
-            else
-              f.html { redirect_to path }
-            end
+            f.html { redirect_to path }
           end
         end
       end
+    end
 
-      # TODO: Move this method to a suitable place
-      def symbolify_keys(hash)
-        hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-      end
+    # TODO: Move this method to a suitable place
+    def symbolify_keys(hash)
+      hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+    end
 
     # The actual DSL for resource ages
     module ClassMethods
@@ -214,6 +213,29 @@ module Faalis::Dashboard::Sections
           name.constantize
         end
       end
+
+      # Specify the model name of controller. This method overrides the
+      # `model_class` **class method** and `model_name` instance method.
+      def model_name(name)
+        define_singleton_method :model_class do
+          name.constantize
+        end
+
+        define_method :model_name do
+          name
+        end
+      end
+
+      # Returns the actual model class by looking at `controller_name` and
+      # and `controller_path`. If user uses the `model_name` **class method**
+      # (the `model_name` DSL) then this method will override by the
+      # `model_name` defination of `model_class`
+      def model_class
+        name  = controller_name
+        path  = controller_path.gsub(name, '').gsub(/dashboard\//, '')
+
+        "#{path}#{name}".classify.constantize
+      end
     end
 
   end