faalis 1.0.0 → 2.0.0.rc2

data/config/locales/faalis.fa.yml

@@ -0,0 +1,37 @@
+---
+fa:
+  faalis:
+    faalis_version: نسخه فالیس
+    copyright_html: |
+      &copy; 2013-2015 <a href="http://yellowen.com">Yellowen</a>.
+
+    page_not_found: آدرس پیدا نشد.
+    page_not_found_desc: آدرس که دنبال آن می گردید پیدا نشد
+
+    select_a_language: یک زبان را انتخاب کیند
+    en: English
+    fa: فارسی
+    actions: فرامین
+    home: 'خانه'
+    email: ایمیل
+    password: گذرواژه
+    remember_me: مرا بخاطر بسپار
+
+    member_since: "عضو از %{date}"
+    not_authorized: شما مجاز به انجام این فعالیت نیستید.
+    engine_name: فالیس
+    sign_in: ورود
+    sign_out: خروج
+
+    errors:
+      fix_errors: ابتدا این خطا ها را رفع کنید
+    dashboard:
+      index_view:
+        new_button: '%{title} جدید'
+      users: کاربران
+      groups: گروه ها
+      user_management: مدیریت کاربران
+      dashboard: داشبرد
+      sidebar:
+        online: آنلاین
+        search: جستوجو

data/config/routes.rb

@@ -15,25 +15,43 @@ Faalis::Engine.routes.draw do
     }
   end
 
-  scope '(:locale)', locale: Regexp.new(::I18n.available_locales.join('|')) do
-    scope Faalis::Engine.dashboard_namespace.to_sym do
-      get '' => 'dashboard#index', :as => 'dashboard'
-      get 'modules' => 'dashboard#modules'
+  localized_scope do
+    in_dashboard do
+      scope :auth do
+        resources :groups, as: 'auth_groups'
+        resources :users, as: 'auth_users' do
+          member do
+            get   'password', to: 'users#edit_password', as: 'auth_users_edit_password'
+            patch 'password', to: 'users#update_password'
+          end
+        end
+      end
+      get '', to: '/faalis/dashboard#index', as: 'index'
+      get '/404', to: '/faalis/dashboard#not_found', as: 'not_found'
     end
 
     devise_for :users, devise_config
   end
 
-  match('/users/auth/:provider',
-        constraints: { provider: /#{Devise.omniauth_configs.keys.join("|")}/ },
-        to: "devise/omniauth_callbacks#passthru",
-        as: :user_omniauth_authorize,
-        via: [:get, :post])
-
-  match('/users/auth/:action/callback',
-        constraints: { action: /#{Devise.omniauth_configs.keys.join("|")}/ },
-        to: 'devise/omniauth_callbacks',
-        as: :user_omniauth_callback,
-        via: [:get, :post])
+  #scope '(:locale)', locale: Regexp.new(::I18n.available_locales.join('|')) do
+  #  scope Faalis::Engine.dashboard_namespace.to_sym do
+      #get '' => 'dashboard#index', :as => 'dashboard'
+  #    get 'modules' => 'dashboard#modules'
+  #  end
+
+  #devise_for :users, devise_config
+  #end
+
+  # match('/users/auth/:provider',
+  #       constraints: { provider: /#{Devise.omniauth_configs.keys.join("|")}/ },
+  #       controller: "devise/omniauth_callbacks#passthru",
+  #       as: :user_omniauth_authorize,
+  #       via: [:get, :post])
+
+  # match('/users/auth/:action/callback',
+  #       constraints: { action: /#{Devise.omniauth_configs.keys.join("|")}/ },
+  #       controller: 'devise/omniauth_callbacks',
+  #       as: :user_omniauth_callback,
+  #       via: [:get, :post])
 
 end

data/db/seeds.rb

@@ -1,5 +1,4 @@
 # Database initial data
-
 ModelDiscovery::Engine.load_seed
 
 #Faalis::Workflows::Discovery.build_table_list
@@ -13,8 +12,8 @@ when 'active_record'
   admin_group.permissions = Faalis::Permission.all
 
   admin = Faalis::User.create(email: 'admin@example.com',
-                              password: '123123123',
-                              password_confirmation: '123123123')
+                              password: 'changeme',
+                              password_confirmation: 'changeme')
   admin.groups << admin_group
 
 
@@ -33,8 +32,8 @@ when 'mongoid'
   guest_group = Faalis::Group.create(name: 'Guest', role: 'guest')
 
   admin = Faalis::User.new(email: 'admin@example.com',
-                           password: '123123123',
-                           password_confirmation: '123123123')
+                           password: 'changeme',
+                           password_confirmation: 'changeme')
 
 
   admin.groups << admin_group

data/lib/faalis.rb

@@ -17,7 +17,15 @@
 #    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 # -----------------------------------------------------------------------------
 
+require 'i18n'
 require 'devise'
+require 'turbolinks'
+require 'modernizr-rails'
+require 'model_discovery'
+require 'pundit'
+require 'slim-rails'
+require 'formtastic'
+require 'kaminari'
 
 # Faalis Module
 module Faalis

data/lib/faalis/concerns/authorizable.rb

@@ -31,7 +31,7 @@ module Faalis
           @@permissions.each do |key, value|
             strings << {
               name: "#{key}|#{model_name}",
-              string: _("can %s %s") % [_(key.to_s), humanize_name]
+              string: t("faalis.permission_string", action: key.to_s, model: humanize_name)
             }
           end
           strings

data/lib/faalis/dashboard.rb

@@ -1,60 +1,9 @@
-# -----------------------------------------------------------------------------
-#    Faalis - Basic website skel engine
-#    Copyright (C) 2012-2013 Yellowen
-#
-#    This program is free software; you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published by
-#    the Free Software Foundation; either version 2 of the License, or
-#    (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU General Public License for more details.
-#
-#    You should have received a copy of the GNU General Public License along
-#    with this program; if not, write to the Free Software Foundation, Inc.,
-#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-# -----------------------------------------------------------------------------
+require_dependency 'faalis/dashboard/dsl'
 
-module Faalis
-
-  # This Module is the base module for dashboard
-  class Dashboard
-    include Singleton
-
-    @@modules = {}
-    @@sections = {}
-
-    def register_module(section, dashboard_module)
-
-      if not @@modules.include? dashboard_module.name
-        @@modules[dashboard_module.name.to_sym] = dashboard_module
-
-        if not @@sections.include? section.to_sym
-          @@sections[section.to_sym] = []
-        end
-        @@sections[section.to_sym] << dashboard_module.name
-      end
-    end
-
-    # Return content for given section by calling related
-    # method in each registered module which registered to
-    # specified section
-    def content_for(section)
+module Faalis::Dashboard
+  module DSL
+  end
 
-      result = []
-      if @@sections.include? section
-        @@sections[section].each do |module_name|
-          # Get module object form @@modules
-          result << [@@modules[module_name].priority,
-                     @@modules[modue_name].send("content_for_#{section}")]
-        end
-      end
-      result.sort.reverse.join("\n").html_safe
-    end
+  module Sections
   end
 end
-
-require "faalis/dashboard/module"
-require "faalis/dashboard/controller"

data/lib/faalis/dashboard/dsl.rb

@@ -0,0 +1,41 @@
+require_dependency 'faalis/dashboard/dsl/form_fields_properties'
+require_dependency 'faalis/dashboard/sections/resource'
+require_dependency 'faalis/dashboard/sections/resources_index'
+require_dependency 'faalis/dashboard/sections/resource_create'
+require_dependency 'faalis/dashboard/sections/resource_show'
+require_dependency 'faalis/dashboard/sections/resource_destroy'
+require_dependency 'faalis/dashboard/sections/sidebar'
+
+module Faalis::Dashboard
+  module DSL
+    extend ActiveSupport::Concern
+
+    include Faalis::Dashboard::Sections::Resource
+    include Faalis::Dashboard::Sections::ResourcesIndex
+    include Faalis::Dashboard::Sections::ResourceCreate
+    include Faalis::Dashboard::Sections::ResourceShow
+    include Faalis::Dashboard::Sections::ResourceDestroy
+    include Faalis::Dashboard::Sections::Sidebar
+
+    attr_accessor :_override_views
+
+    def _override_views
+      @_override_views ||= []
+    end
+
+    module ClassMethods
+      # 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 || []
+          result.concat(block.call) if block_given?
+          result
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+require 'set'
+
+module Faalis::Dashboard::DSL
+  class Base
+    attr_reader :action_buttons, :fields, :model
+
+    # Base class for all the DSL property classes to be
+    # used as the yielded object inside each section DSL
+    # scope.
+    #
+    # For example the below code will yield an instance of
+    # one of this class children.
+    #
+    #  in_index do
+    #    # This will yield an instance of this class child
+    #  end
+    #
+    # The most important note in this class is that all the public
+    # methods that their name starts with an underscore (_) not meant to
+    # be used as DSL.
+    def initialize(model)
+      @action_buttons = {}
+      @model          = model
+      @fields         = resolve_model_reflections
+      @fields_type    = {}
+    end
+
+    # Define a new action button to be added to the
+    # action_buttons list on the corresponding view.
+    def action_button(name, **options, &block)
+      button = { name: name }
+      button.merge! options
+      button.merge!(block.call) if block_given?
+      @action_buttons[name] = button
+    end
+
+    # Allow user to specify an array of model attributes to be used
+    # in respected section. For example attributes to show as header
+    # columns in index section
+    def attributes(*fields_name, **options, &block)
+      if options.include? :except
+        @fields = resolve_model_reflections.reject do |field|
+          options[:except].include? field.to_sym
+        end
+      else
+
+        # Check for valid field names
+        fields_name.each do |name|
+          unless @fields.include? name.to_s
+            raise ArgumentError, "can't find '#{name}' field for model '#{model}'."
+          end
+        end
+        # set new value for fields
+        @fields = fields_name.map(&:to_s) unless fields_name.empty?
+      end
+
+      @fields.concat(block.call.map(&:to_s)) if block_given?
+    end
+
+    # Return the default scope for current properties object.
+    # scope will be used to fetch all the records for the given
+    # section. The Default implementation belongs to index section
+    # and return a page aware list of all the objects.
+    #
+    # You can easily change it via the corresponding section dsl.
+    # For example in case of `index` section:
+    #
+    #  in_index do
+    #    scope do |params|
+    #      YourModel.all
+    #    end
+    #  end
+    #
+    # Arguments:
+    # * **params**: Is the same params passed to controller action.
+    def scope(&block)
+      @_default_scope = block
+    end
+
+    def default_scope(params)
+      return @_default_scope.call(params) if defined? @_default_scope
+      model.page(params[:page])
+    end
+
+  private
+
+    # Replace foreign key names with their reflection names
+    # and create an array of model fields
+    def resolve_model_reflections
+      # TODO: cach the result using and instance_var or something
+      reflections = model.reflections
+      columns     = Set.new model.column_names
+      new_fields  = Set.new
+      fields_to_remove = Set.new
+
+      reflections.each do |name, column|
+        has_many = ActiveRecord::Reflection::HasManyReflection
+        has_and_belongs_to_many = ActiveRecord::Reflection::HasAndBelongsToManyReflection
+
+        if !column.is_a?(has_many) && !column.is_a?(has_and_belongs_to_many)
+          new_fields << name.to_s
+          fields_to_remove << column.foreign_key.to_s
+        end
+      end
+
+      if model.respond_to? :attachment_definitions
+        # Paperclip is installed and model contains attachments
+        model.attachment_definitions.each do |name, _|
+          new_fields << name.to_s
+          ["file_name", "content_type", "file_size", "updated_at"].each do |x|
+            fields_to_remove << "#{name}_#{x}"
+          end
+        end
+      end
+
+      columns.union(new_fields) - fields_to_remove
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+require_dependency 'faalis/dashboard/dsl/base'
+
+module Faalis::Dashboard::DSL
+  class Create < Base
+
+    def initialize(model)
+      super
+      @field_details = {}
+    end
+
+    # Specify attributes details, for example if you want to change a datetime
+    # field type to string you need to do like this:
+    #
+    #  in_form do
+    #    attributes_properties date: { as: :string }
+    #  end
+    def attributes_properties(**options)
+      options_set = Set.new options.keys.map(&:to_s)
+
+      unless options_set.subset? Set.new(@fields)
+        fail "You have to provide correct attribute names in" +
+             "'attributes_properties' for '#{@model}'."
+      end
+
+      # TODO: Check for valid value for each key
+      @field_details = options || {}
+    end
+
+    def _field_details
+      details = @field_details.dup
+
+      fields_for_form.each do |field|
+        if !details.include? field.to_sym
+
+          type = guess_field_type(field)
+          details[field.to_sym] = initialize_field(field.to_sym, type)
+        end
+      end
+
+      details
+    end
+
+    def fields_for_form
+      fields_name = @fields.dup
+
+      fields_name.delete('id')
+      fields_name.delete('created_at')
+      fields_name.delete('updated_at')
+
+      fields_name
+    end
+
+    private
+
+      def guess_field_type(field)
+        column = model.columns_hash[field.to_s]
+        return column.type.to_sym unless column.nil?
+
+        return :file if has_attachment? field.to_sym
+
+        has_many                = ActiveRecord::Reflection::HasManyReflection
+        has_and_belongs_to_many = ActiveRecord::Reflection::HasAndBelongsToManyReflection
+        reflection              = model.reflections[field.to_s]
+
+        unless reflection.nil?
+          return nil if reflection.is_a? has_many
+          return :multiple_select if reflection.is_a? has_and_belongs_to_many
+          :select
+        end
+      end
+
+      def has_attachment?(name)
+        if model.respond_to? :attachment_definitions
+          return true if model.attachment_definitions.keys.include? name
+        end
+
+        false
+      end
+
+      def initialize_field(name, type)
+        if respond_to?("setup_#{type}".to_sym, true)
+          return send("setup_#{type}", name)
+        end
+
+        { as: type.to_sym }
+      end
+
+      def setup_datetime(name)
+        { as: :string,
+          input_html: { class: 'datetimepicker' }
+        }
+      end
+
+      def setup_time(name)
+        { as: :string,
+          input_html: { class: 'timepicker' }
+        }
+      end
+
+      def setup_date(name)
+        { as: :string,
+          input_html: { class: 'datepicker1' }
+        }
+      end
+
+      def setup_multiple_select(name)
+        { as: :select,
+          input_html: { class: 'multiple select' }
+        }
+      end
+
+      def setup_integer(name)
+        { as: nil }
+      end
+
+  end
+end