faalis 2.1.1 → 2.2.0.pre.rc1

data/db/migrate/20140613120923_add_users_groups_table.rb

@@ -1,8 +1,13 @@
 class AddUsersGroupsTable < ActiveRecord::Migration
   def change
     create_table :faalis_groups_users do |t|
-      t.belongs_to :user
-      t.belongs_to :group
+      if Faalis::Engine.use_uuid
+        t.uuid :user_id
+        t.uuid :group_id
+      else
+        t.belongs_to :user
+        t.belongs_to :group
+      end
     end
   end
 end

data/db/migrate/20160310105736_create_faalis_user_messages.rb

@@ -1,8 +1,17 @@
 class CreateFaalisUserMessages < ActiveRecord::Migration
   def change
-    create_table :faalis_user_messages do |t|
-      t.integer :sender_id
-      t.integer :reciver_id
+    args = {}
+    args[:id] = :uuid if Faalis::Engine.use_uuid
+
+    create_table :faalis_user_messages, **args do |t|
+      if Faalis::Engine.use_uuid
+        t.uuid :sender_id
+        t.uuid :receiver_id
+      else
+        t.integer :sender_id
+        t.integer :receiver_id
+      end
+
       t.boolean :read_only
       t.text :content
       t.text :raw_content
@@ -11,6 +20,6 @@ class CreateFaalisUserMessages < ActiveRecord::Migration
     end
 
     add_index :faalis_user_messages, :sender_id
-    add_index :faalis_user_messages, :reciver_id
+    add_index :faalis_user_messages, :receiver_id
   end
 end

data/lib/faalis.rb

@@ -11,17 +11,24 @@ require 'amd'
 
 # Faalis Module
 module Faalis
-
+  autoload :Helpers,      'faalis/helpers/autoload_helper'
+  autoload :Routes,       'faalis/routes'
+  autoload :RouteHelpers, 'faalis/routes'
+  autoload :Liquid,       'faalis/liquid'
+#  autoload :Engine,       'faalis/engine'
+  autoload :Dashboard,    'faalis/dashboard'
+  autoload :Concerns,     'faalis/concerns'
+  autoload :ORM,          'faalis/orm'
 end
 
 require 'faalis/engine'
-require 'faalis/orm'
-require 'faalis/concerns'
-require 'faalis/dashboard'
+#require 'faalis/orm'
+#require 'faalis/concerns'
+#require 'faalis/dashboard'
 require 'faalis/extension'
 require 'faalis/omniauth'
 require 'faalis/i18n'
-require 'faalis/route'
+#require 'faalis/route'
 require 'faalis/action_dispatch'
 require 'faalis/discovery'
 require 'faalis/fake_assets'

data/lib/faalis/concerns/authorizable.rb

@@ -26,16 +26,19 @@ module Faalis
           strings = []
           model_name = model.to_s
           humanize_name = ActiveModel::Name.new(model).human
+
           if model.respond_to? :model_name
             model_name = model.model_name
             humanize_name = model_name.human
           end
+
           @@permissions.each do |key, value|
             strings << {
               name: "#{key}|#{model_name}",
               string: t("faalis.permission_string", action: key.to_s, model: humanize_name)
             }
           end
+
           strings
         end
 
@@ -45,7 +48,6 @@ module Faalis
 
         # Define permissions using this method
         def permissions(*args)
-
           args.each do |permission|
             if permission.class == Symbol
               if not @@permissions.include? permission

data/lib/faalis/configuration.rb

@@ -1,4 +1,6 @@
 module Faalis
+  # This module contains all the configuration of `Faalis::Engine`
+  # which can be setup in `config/initializer/faalis.rb`
   module Configuration
 
     @@modules_to_load = {}
@@ -32,6 +34,10 @@ module Faalis
       end
     end
 
+    mattr_accessor :i18n_debug do
+      false
+    end
+
     # Site Title
     attr_accessor :site_title do
       'Faalis'
@@ -58,6 +64,11 @@ module Faalis
       {}
     end
 
+    # Whether using UUID with models or not.
+    mattr_accessor :use_uuid do
+      false
+    end
+
     mattr_accessor :amd_dir do
       'amd'
     end
@@ -65,11 +76,15 @@ module Faalis
     mattr_accessor :amd do
       true
     end
-
+    # This hash map contains all the features as keys and
+    # the required dependencies of each feature in form of
+    # an array as value
     @@modules_to_load[:amd] = ['amd']
 
+    # Load all the features dependencies based on their configuration
+    # value. For example if `amd` class method returns true all of its
+    # dependencies will be loaded.
     def load_dependencies_based_on_configuration
-
       @@modules_to_load.each do |k, v|
         v.map { |mod| require mod } if send(k)
       end

data/lib/faalis/dashboard.rb

@@ -1,12 +1,11 @@
-require_dependency 'faalis/dashboard/dsl'
+#require_dependency 'faalis/dashboard/dsl'
 
 module Faalis::Dashboard
-  module DSL
-  end
+  autoload :DSL, 'faalis/dashboard/dsl'
 
   module Helpers
   end
 
-  module Sections
-  end
+  autoload :Models,   'faalis/dashboard/models'
+  autoload :Sections, 'faalis/dashboard/sections.rb'
 end

data/lib/faalis/dashboard/dsl.rb

@@ -28,7 +28,6 @@ module Faalis::Dashboard
       # override the default view for given views or the result
       # of the given block, by the one from the application
       def override_views(*views, &block)
-        views.concat(block.call) if block_given?
 
         define_method(:_override_views) do
           result = views || []

data/lib/faalis/dashboard/dsl/base.rb

@@ -34,6 +34,9 @@ module Faalis::Dashboard::DSL
         @fields = resolve_model_reflections.reject do |field|
           options[:except].include? field.to_sym
         end
+      elsif options.include? :append
+
+        @fields += options[:append]
       else
 
         # Check for valid field names
@@ -57,8 +60,8 @@ module Faalis::Dashboard::DSL
     # You can easily change it via the corresponding section dsl.
     # For example in case of `index` section:
     #
-    #  in_index do
-    #    scope do |params|
+    #  in_index do |index|
+    #    index.scope do |params|
     #      YourModel.all
     #    end
     #
@@ -83,7 +86,7 @@ module Faalis::Dashboard::DSL
     # Define a new action on the `action` place of the current section
     # **options**: Is a hash which contains the action button properties.
     #
-    # `label`: Label to use with the button.
+    # `name`: Label to use with the button.
     # `href`: The link href to use in the `a` tag
     # `class`:  classes of the button.
     # `icon_class`: font awesome icon to use in button.

data/lib/faalis/dashboard/dsl/create.rb

@@ -81,7 +81,6 @@ module Faalis::Dashboard::DSL
         if respond_to?("setup_#{type}".to_sym, true)
           return send("setup_#{type}", name)
         end
-
         { as: type.to_sym }
       end
 

data/lib/faalis/dashboard/dsl/index.rb

@@ -12,6 +12,8 @@ module Faalis::Dashboard::DSL
         @fields = resolve_model_reflections.reject do |field|
           options[:except].include? field.to_sym
         end
+      elsif options.include? :append
+         @fields += options[:append]
       else
         # set new value for fields
         @fields = fields_name.map(&:to_s) unless fields_name.empty?

data/lib/faalis/dashboard/models.rb

@@ -0,0 +1,2 @@
+module Faalis::Dashboard::Models
+end

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

@@ -112,7 +112,7 @@ module Faalis::Dashboard::Models
 
       end
 
-      menu(t('faalis.dashboard.user_messages'),
+      menu(t('faalis.dashboard.user_message'),
         icon: 'fa fa-envelope-o',
         model: 'Faalis::UserMessage') do
 

data/lib/faalis/dashboard/sections.rb

@@ -0,0 +1,2 @@
+module Faalis::Dashboard::Sections
+end

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

@@ -1,4 +1,6 @@
 module Faalis::Dashboard::Sections
+  # This module contains several helpers method which would
+  # be useful for the rest of faalis dashboard operation.
   module Resource
 
     extend ActiveSupport::Concern
@@ -32,7 +34,7 @@ module Faalis::Dashboard::Sections
       fail NameError, msg
     end
 
-    def namespace
+    def _namespace
       pieces = controller_path.gsub('dashboard/', '').split('/')
       return '' if pieces.length == 1
 
@@ -41,10 +43,10 @@ module Faalis::Dashboard::Sections
     end
 
     def _route_engine
-      if namespace.empty?
+      if _namespace.empty?
         Rails.application
       else
-        engine = "#{namespace.split('/')[0]}::Engine".classify
+        engine = "#{_namespace.split('/')[0]}::Engine".classify
         if Object.const_defined? engine
           engine.constantize
         else
@@ -82,56 +84,41 @@ module Faalis::Dashboard::Sections
       !attachment_fields.empty?
     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"
+    def _index_route
+      if respond_to? :index
+        url_for(controller: params[:controller],
+                action: :index)
       end
     end
 
-    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
-
-    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('/', '_')
+    def _show_route(id)
+      if respond_to? :show
+        url_for(controller: params[:controller],
+                action: :show,
+                id: id)
+      end
     end
 
-    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('/', '_')
+    def _edit_route(id)
+      if respond_to? :edit
+        url_for(controller: params[:controller],
+                action: :edit,
+                id: id)
+      end
     end
 
-    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('/', '_')
+    def _new_route
+      if respond_to? :new
+        url_for(controller: params[:controller], action: :new)
+      end
     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
+      @index_route   = method(:_index_route)
+      @new_route     = method(:_new_route)
+      @show_route    = method(:_show_route)
+      @edit_route    = method(:_edit_route)
     end
 
     def successful_response(section, msg = nil)
@@ -143,12 +130,9 @@ module Faalis::Dashboard::Sections
           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 }
+          f.html { redirect_to _index_route }
         end
       end
     end
@@ -163,16 +147,11 @@ module Faalis::Dashboard::Sections
         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' }
+          f.js { render 'faalis/dashboard/shared/errors' }
           if block_given?
             f.html(&block)
           else
-            f.html { redirect_to path }
+            f.html { redirect_to _index_route }
           end
         end
       end
@@ -205,6 +184,14 @@ module Faalis::Dashboard::Sections
         end
       end
 
+      # Using this method user can override the route namespace guessed by
+      # Faalis.
+      def route_namespace(name, &block)
+        define_method(:_namespace) do
+          return block.call if block_given?
+          name
+        end
+      end
       # Set the engine name of current controller. It's necessary to provide and
       # engine name if the controller belongs to an engine other than Faalis or
       # Rails.application.

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

@@ -47,7 +47,7 @@ module Faalis::Dashboard::Sections
       new_params = creation_params
       new_params.merge(reflections_hash) if reflections_hash
 
-      # Customize update behaviour
+      # Customize update behaviour before updating resource
       before_update_hook(@resource)
 
       # TODO: Move this method to a suitable place instead of controller
@@ -57,6 +57,8 @@ module Faalis::Dashboard::Sections
       @resource.assign_attributes(**new_params)
 
       if @resource.save
+        # Customize update behaviour after updating resource
+        after_update_hook(@resource)
         successful_response(:update)
       else
         errorful_resopnse(:update, @resource.errors) do
@@ -77,6 +79,7 @@ module Faalis::Dashboard::Sections
 
       # TODO: Handle M2M relations in here
       if @resource.save
+        after_create_hook(@resource)
         successful_response(:create)
       else
         errorful_resopnse(:create, @resource.errors) do
@@ -132,15 +135,26 @@ module Faalis::Dashboard::Sections
     private
 
       # You can override this method to change the behaviour of `create`
-      # action
+      # action before save resource
       def before_create_hook(resource)
       end
 
+      # You can override this method to change the behaviour of `create`
+      # action afer save resource
+      def after_create_hook(resource)
+      end
+
       # You can override this method to change the behaviour of `update`
-      # action
+      # action before save resource
       def before_update_hook(resource)
       end
 
+
+      # You can override this method to change the behaviour of `update`
+      # action after save resource
+      def after_update_hook(resource)
+      end
+
       # You can override this method to change the behaviour of `new`
       # action
       def new_hook(resource)