brainsome_typus 4.0.0.beta1

data/app/controllers/admin/resources_controller.rb

@@ -0,0 +1,256 @@
+class Admin::ResourcesController < Admin::BaseController
+
+  include Admin::Navigation
+  include Admin::Actions
+  include Admin::Filters
+  include Admin::Format
+  include Admin::Headless
+
+  Whitelist = [:edit, :update, :destroy, :toggle]
+
+  before_filter :get_model
+  before_filter :set_context
+  before_filter :get_object, :only => Whitelist + [:show]
+  before_filter :check_resource_ownership, :only => Whitelist
+  before_filter :check_if_user_can_perform_action_on_resources
+
+  def index
+    get_objects
+
+    custom_actions_for(:index).each do |action|
+      prepend_resources_action(action.titleize, {:action => action, :id => nil})
+    end
+
+    respond_to do |format|
+      format.html do
+        set_default_action
+        add_resource_action("Destroy", {:action => "destroy"}, { :data => { :confirm => "#{Typus::I18n.t("Trash")}?" }, :method => 'delete'})
+        get_paginated_data
+      end
+
+      format.csv { generate_csv }
+      format.json { export(:json) }
+      format.xml { export(:xml) }
+    end
+  end
+
+  def new
+    @item = @resource.new(item_params_for_new)
+
+    respond_to do |format|
+      format.html
+      format.json { render :json => @item }
+    end
+  end
+
+  def create
+    @item = @resource.new
+    args = [item_params_for_create]
+    args << {as: current_role} if defined?(ProtectedAttributes)
+    @item.assign_attributes(*args)
+
+    set_attributes_on_create
+
+    respond_to do |format|
+      if @item.save
+        format.html { redirect_on_success }
+        format.json { render :json => @item, :status => :created, :location => @item }
+      else
+        format.html { render :action => "new", :status => :unprocessable_entity }
+        format.json { render :json => @item.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  def edit
+    set_default_action
+    add_resource_action("Destroy", {:action => "destroy"}, { :data => { :confirm => "#{Typus::I18n.t("Trash")}?" }, :method => 'delete'})
+    custom_actions_for(:edit).each do |action|
+      prepend_resources_action(action.titleize, {:action => action, :id => @item})
+    end
+  end
+
+  def show
+    check_resource_ownership if @resource.typus_options_for(:only_user_items)
+
+    if admin_user.can?('edit', @resource)
+      prepend_resources_action("Edit", {:action => 'edit', :id => @item})
+    end
+
+    custom_actions_for(:show).each do |action|
+      prepend_resources_action(action.titleize, {:action => action, :id => @item})
+    end
+
+    respond_to do |format|
+      format.html
+      format.xml { render :xml => @item }
+      format.json { render :json => @item }
+    end
+  end
+
+  def update
+    respond_to do |format|
+      args = [item_params_for_update]
+      args << {as: current_role} if defined?(ProtectedAttributes)
+      if @item.update_attributes(*args)
+        set_attributes_on_update
+        format.html { redirect_on_success }
+        format.json { render :json => @item }
+      else
+        format.html { render :edit, :status => :unprocessable_entity }
+        format.json { render :json => @item.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  def destroy
+    if @item.destroy
+      notice = Typus::I18n.t("%{model} successfully removed.", :model => @resource.model_name.human)
+    else
+      alert = @item.errors.full_messages
+    end
+    redirect_to :back, :notice => notice, :alert => alert
+  end
+
+  def toggle
+    @item.toggle(params[:field])
+
+    respond_to do |format|
+      if @item.save
+        format.html do
+          notice = Typus::I18n.t("%{model} successfully updated.", :model => @resource.model_name.human)
+          redirect_to :back, :notice => notice
+        end
+        format.json { render :json => @item }
+      else
+        format.html { render :edit }
+        format.json { render :json => @item.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  private
+
+  def get_model
+    @resource = resource
+    @object_name = ActiveModel::Naming.singular(@resource)
+  end
+
+  def resource
+    params[:controller].extract_class
+  rescue
+    params[:controller].extract_singular_class
+  end
+  helper_method :resource
+
+  def set_context
+    @resource
+  end
+  helper_method :set_context
+
+  def get_object
+    @item = @resource.find(params[:id])
+  end
+
+  def get_objects
+    set_scope
+    set_wheres
+    set_joins
+    check_resources_ownership if @resource.typus_options_for(:only_user_items)
+    set_order if @resource.respond_to?(:order)
+    set_eager_loading
+  end
+
+  def fields
+    @resource.typus_fields_for(params[:action])
+  end
+  helper_method :fields
+
+  def set_scope
+    return unless params[:scope]
+
+    if @resource.typus_scopes.include?(params[:scope])
+      @resource = @resource.send(params[:scope])
+    else
+      not_allowed("Not allowed! Requested scope not defined on your whitelist.")
+    end
+  end
+
+  def set_wheres
+    @resource.build_conditions(params).each do |condition|
+      @resource = @resource.where(condition)
+    end
+  end
+
+  def set_joins
+    @resource.build_my_joins(params).each do |join|
+      @resource = @resource.joins(join)
+    end
+  end
+
+  def set_order
+    params[:sort_order] ||= "desc"
+
+    if (order = params[:order_by] ? "#{@resource.table_name}.#{params[:order_by]} #{params[:sort_order]}" : @resource.typus_order_by).present?
+      @resource = @resource.reorder(order)
+    end
+  end
+
+  def set_eager_loading
+    if (eager_loading = @resource.reflect_on_all_associations(:belongs_to).reject { |i| i.options[:polymorphic] }.map(&:name)).any?
+      @resource = @resource.includes(eager_loading)
+    end
+  end
+
+  def redirect_on_success
+    path = params.dup.cleanup
+
+    options = if params[:_addanother]
+      { :action => 'new', :id => nil }
+    elsif params[:_continue]
+      { :action => 'edit', :id => @item.id }
+    else
+      { :action => nil, :id => nil }
+    end
+
+    message = params[:action].eql?('create') ? "%{model} successfully created." : "%{model} successfully updated."
+    notice = Typus::I18n.t(message, :model => @resource.model_name.human)
+
+    redirect_to path.merge!(options).compact, :notice => notice
+  end
+
+  def set_default_action
+    default_action = @resource.typus_options_for(:default_action_on_item)
+    action = admin_user.can?('edit', @resource.model_name.to_s) ? default_action : "show"
+    prepend_resource_action(action.titleize, {:action => action})
+  end
+
+  def custom_actions_for(action)
+    return [] if headless_mode?
+    @resource.typus_actions_on(action).reject { |a| admin_user.cannot?(a, @resource.model_name) }
+  end
+
+  def item_params_for_new
+    if params[:resource]
+      params[@object_name] = params.delete(:resource)
+      permit_params!
+    end
+  end
+
+  def item_params_for_create
+    permit_params!
+  end
+
+  def item_params_for_update
+    if (attr = params[:_nullify])
+      params[@object_name] = { attr => nil }
+    end
+
+    permit_params!
+  end
+
+  def permit_params!
+    params[@object_name].permit!
+  end
+
+end

data/app/controllers/admin/session_controller.rb

@@ -0,0 +1,42 @@
+class Admin::SessionController < Admin::BaseController
+
+  skip_before_filter :reload_config_and_roles, :authenticate
+
+  before_filter :create_an_account?, :only => [:new, :create]
+
+  def new; end
+
+  def create
+    email, password = admin_user_params[:email], admin_user_params[:password]
+    user = user_scope.authenticate(email, password)
+
+    path = if user
+      session[:typus_user_id] = user.id
+      params[:return_to] || admin_dashboard_index_path
+    else
+      new_admin_session_path(:return_to => params[:return_to])
+    end
+
+    redirect_to path
+  end
+
+  def destroy
+    deauthenticate
+  end
+
+  private
+
+  def create_an_account?
+    redirect_to new_admin_account_path if zero_users
+  end
+
+  def set_locale
+    I18n.locale = Typus::I18n.default_locale
+  end
+
+  def user_scope
+    klass = Typus.user_class
+    klass.respond_to?(:in_domain) ? klass.in_domain(request.host) : klass
+  end
+
+end

data/app/controllers/concerns/admin/actions.rb

@@ -0,0 +1,88 @@
+require 'active_support/concern'
+
+module Admin
+  module Actions
+
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :resource_actions
+      helper_method :resources_actions
+    end
+
+    def resource_actions
+      @resource_actions ||= []
+    end
+
+    def resources_actions
+      @resources_actions ||= []
+    end
+
+    protected
+
+    ##
+    # @resource_actions is used to customize the actions which appear under
+    # each item on the tables. This is really a nice feature because allows
+    # us to enable actions for items without much effort. For example adding
+    # a "Recover from Trash" action:
+    #
+    #     def index
+    #       add_resource_action('Recover', {:action => 'untrash'}, {:confirm => Typus::I18n.t("Recover %{resource}?", :resource => @resource.model_name.human)})
+    #       super
+    #     end
+    #
+    # Additionally you can set a condition to each action passing a Proc as
+    # 4th parameter. If the proc return true the item will be showed and if
+    # return false will be hidden.
+    #
+    #     def index
+    #       add_resource_action('Recover', {:action => 'untrash'}, {}, Proc.new {|item| item.is_trash? })
+    #       super
+    #     end
+    #
+
+    def add_resource_action(*args)
+      @resource_actions ||= []
+      @resource_actions << args unless args.empty?
+    end
+
+    def prepend_resource_action(*args)
+      @resource_actions ||= []
+      @resource_actions = @resource_actions.unshift(args) unless args.empty?
+    end
+
+    def append_resource_action(*args)
+      @resource_actions ||= []
+      @resource_actions = @resource_actions.concat([args]) unless args.empty?
+    end
+
+    ##
+    # @resources_actions is used to build a list of custom actions which will
+    # be appended beside "<h2></h2>" all the actions.
+    #
+    # Let's say for example that I want to be able to run the application
+    # without sidebars and headers (headless mode). In this case I need to
+    # somehow add custom actions to the page so I can navigate.
+    #
+    # Instead of having this code here, maybe it's better to duplicate the
+    # actions on the pages. So for example: Admin::PostsController#index will
+    # show a link to add new in the sidebar and beside the "<h2>" header.
+    #
+
+    def add_resources_action(*args)
+      @resources_actions ||= []
+      @resources_actions << args unless args.empty?
+    end
+
+    def prepend_resources_action(*args)
+      @resources_actions ||= []
+      @resources_actions = @resources_actions.unshift(args) unless args.empty?
+    end
+
+    def append_resources_action(*args)
+      @resources_actions ||= []
+      @resources_actions = @resources_actions.concat([args]) unless args.empty?
+    end
+
+  end
+end

data/app/controllers/concerns/admin/acts_as_list.rb

@@ -0,0 +1,26 @@
+# Module designed to work with `acts_as_list`.
+
+require 'active_support/concern'
+
+module Admin
+  module ActsAsList
+
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :get_object, :only => [:position]
+      before_filter :check_resource_ownership, :only => [:position]
+    end
+
+    def position
+      if %w(move_to_top move_higher move_lower move_to_bottom).include?(params[:go])
+        @item.send(params[:go])
+        notice = Typus::I18n.t("%{model} successfully updated.", :model => @resource.model_name.human)
+        redirect_to :back, :notice => notice
+      else
+        not_allowed
+      end
+    end
+
+  end
+end

data/app/controllers/concerns/admin/ancestry.rb

@@ -0,0 +1,26 @@
+module Admin
+  module Ancestry
+
+    def index
+      @items = []
+
+      @resource.roots.each do |item|
+        @items << item
+        if item.has_children?
+          item.children.each do |child|
+            @items << child
+            if child.has_children?
+              child.children.each do |child|
+                @items << child
+              end
+            end
+          end
+        end
+      end
+
+      set_default_action
+      add_resource_action("Trash", {:action => "destroy"}, {:confirm => "#{Typus::I18n.t("Trash")}?", :method => 'delete'})
+    end
+
+  end
+end

data/app/controllers/concerns/admin/autocomplete.rb

@@ -0,0 +1,11 @@
+module Admin
+  module Autocomplete
+
+    def autocomplete
+      get_objects
+      @items = @resource.limit(20)
+      render :json => @items.map { |i| { "id" => i.id, "name" => i.to_label } }
+    end
+
+  end
+end

data/app/controllers/concerns/admin/bulk.rb

@@ -0,0 +1,76 @@
+require 'active_support/concern'
+
+module Admin
+  module Bulk
+
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :bulk_actions
+      before_filter :set_bulk_action, :only => [:index]
+      before_filter :set_bulk_action_for_trash, :only => [:trash]
+    end
+
+    def set_bulk_action
+      add_bulk_action("Move to Trash", "bulk_destroy")
+    end
+    private :set_bulk_action
+
+    # This only happens if we try to access the trash, which won't happen
+    # if trash module is not loaded.
+    def set_bulk_action_for_trash
+      add_bulk_action("Restore from Trash", "bulk_restore")
+    end
+    private :set_bulk_action_for_trash
+
+    def bulk
+      if (ids = params[:selected_item_ids]) && (action = params[:batch_action]).present?
+        send(params[:batch_action], ids)
+      else
+        notice = if action.empty?
+          Typus::I18n.t("No bulk action selected.")
+        else
+          Typus::I18n.t("Items must be selected in order to perform actions on them. No items have been changed.")
+        end
+        redirect_to :back, :notice => notice
+      end
+    end
+
+    def bulk_destroy(ids)
+      ids.each { |id| @resource.destroy(id) }
+      notice = Typus::I18n.t("Successfully deleted #{ids.count} entries.")
+      redirect_to :back, :notice => notice
+    end
+    private :bulk_destroy
+
+    def bulk_restore(ids)
+      ids.each { |id| @resource.deleted.find(id).restore }
+      notice = Typus::I18n.t("Successfully restored #{ids.count} entries.")
+      redirect_to :back, :notice => notice
+    end
+    private :bulk_restore
+
+    def add_bulk_action(*args)
+      bulk_actions
+      @bulk_actions << args unless args.empty?
+    end
+    protected :add_bulk_action
+
+    def prepend_bulk_action(*args)
+      bulk_actions
+      @bulk_actions = @bulk_actions.unshift(args) unless args.empty?
+    end
+    protected :prepend_bulk_action
+
+    def append_bulk_action(*args)
+      bulk_actions
+      @bulk_actions = @bulk_actions.concat([args]) unless args.empty?
+    end
+    protected :append_bulk_action
+
+    def bulk_actions
+      @bulk_actions ||= []
+    end
+
+  end
+end

data/app/controllers/concerns/admin/featured_image.rb

@@ -0,0 +1,22 @@
+module Admin
+  module FeaturedImage
+
+    def set_featured_image
+      attachment = Attachment.find(params[:id])
+
+      item = params[:resource].constantize.unscoped.find(params[:resource_id])
+      item.set_featured_image(attachment.id)
+
+      options = { :controller => params[:resource].tableize, :action => 'edit', :id => item.id }
+      redirect_to options, :notice => Typus::I18n.t("Featured image set")
+    end
+
+    def remove_featured_image
+      item = @resource.unscoped.find(params[:id])
+      item.try(:remove_featured_image)
+      options = { :action => 'edit', :id => item.id }
+      redirect_to options, :notice => Typus::I18n.t("Featured image removed")
+    end
+
+  end
+end

data/app/controllers/concerns/admin/filters.rb

@@ -0,0 +1,57 @@
+# How to setup a predefined filter?
+# ---------------------------------
+#
+# On your controllers:
+#
+#     def index
+#       # Added predefined filter takes any argument, but in the views we
+#       # expected the following:
+#       #
+#       #     add_predefined_filter(filter_name, action, scope)
+#       #
+#       ...
+#       add_predefined_filter("Trash", "trash", "deleted")
+#       ...
+#     end
+#
+# On your views:
+#
+#     <% predefined_filters.each do |filter_name, action, scope| %>
+#       ...
+#     <% end %>
+#
+
+require 'active_support/concern'
+
+module Admin
+  module Filters
+
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :predefined_filters
+    end
+
+    protected
+
+    def add_predefined_filter(*args)
+      predefined_filters
+      @predefined_filters << args unless args.empty?
+    end
+
+    def prepend_predefined_filter(*args)
+      predefined_filters
+      @predefined_filters = @predefined_filters.unshift(args) unless args.empty?
+    end
+
+    def append_predefined_filter(*args)
+      predefined_filters
+      @predefined_filters = @predefined_filters.concat([args]) unless args.empty?
+    end
+
+    def predefined_filters
+      @predefined_filters ||= []
+    end
+
+  end
+end

data/app/controllers/concerns/admin/format.rb

@@ -0,0 +1,48 @@
+require 'csv'
+
+module Admin
+  module Format
+
+    protected
+
+    def get_paginated_data
+      items_per_page = params[:per_page] || @resource.typus_options_for(:per_page)
+      offset = params[:offset] || 0
+      @items = @resource.limit(items_per_page).offset(offset)
+    end
+
+    def generate_csv
+      fields = @resource.typus_fields_for(:csv)
+
+      data = ::CSV.generate do |csv|
+        csv << fields.keys.map { |k| @resource.human_attribute_name(k) }
+        @resource.find_each do |record|
+          csv << fields.map do |key, value|
+                   case value
+                   when :transversal
+                     a, b = key.split(".")
+                     record.send(a).send(b)
+                   when :belongs_to
+                     record.send(key).try(:to_label)
+                   else
+                     record.send(key)
+                   end
+                 end
+        end
+      end
+
+      send_data data, :filename => "export-#{@resource.to_resource}-#{Time.zone.now.to_s(:number)}.csv"
+    end
+
+    def export(format)
+      fields = @resource.typus_fields_for(format).map(&:first)
+      methods = fields - @resource.column_names
+      except = @resource.column_names - fields
+
+      get_paginated_data
+
+      render format => @items.send("to_#{format}", :methods => methods, :except => except)
+    end
+
+  end
+end

data/app/controllers/concerns/admin/headless.rb

@@ -0,0 +1,23 @@
+require 'active_support/concern'
+
+module Admin
+  module Headless
+
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :headless_mode?
+      layout :headless_layout
+    end
+
+    def headless_layout
+      headless_mode? ? "admin/headless" : "admin/base"
+    end
+    private :headless_layout
+
+    def headless_mode?
+      params[:_popup]
+    end
+
+  end
+end

data/app/controllers/concerns/admin/hooks.rb

@@ -0,0 +1,4 @@
+module Admin
+  module Hooks
+  end
+end

data/app/controllers/concerns/admin/multisite.rb

@@ -0,0 +1,10 @@
+module Admin
+  module Multisite
+
+    def set_context
+      @resource = admin_user.site.send(@object_name.pluralize)
+    end
+    private :set_context
+
+  end
+end