binda 0.0.6 → 0.0.7

data/app/controllers/binda/field_groups_controller.rb

@@ -32,27 +32,10 @@ module Binda
     end
 
     def update
-      # Create new fields if any
-      new_params[:new_field_settings].each do |field_setting|
-        unless field_setting[:name].blank?
-          new_field_setting = @field_group.field_settings.create( field_setting )
-          unless new_field_setting
-            return redirect_to edit_structure_field_group_path( @structure.slug, @field_group.slug ), flash: { error: new_field_setting.errors }
-          end
-        end
-      end
 
-      # Create new fields if any
-      unless new_params[:new_choices].nil? 
-        new_params[:new_choices].each do |choice|
-          unless choice[:label].blank? || choice[:value].blank?
-            new_choice = Choice.create( choice )
-            unless new_choice
-              return redirect_to edit_structure_field_group_path( @structure.slug, @field_group.slug ), flash: { error: new_choice.errors }
-            end
-          end
-        end
-      end 
+      # Add nested classes
+      add_new_field_settings
+      add_new_choices
 
       # Update the other ones
       if @field_group.update(field_group_params)
@@ -100,11 +83,12 @@ module Binda
               :required, 
               :default_text, 
               :ancestry, 
-              :default_choice_id_id, 
+              :default_choice_id, 
               :allow_null, 
               choices: [], 
               choices_attributes: 
-              [ :field_setting_id, 
+              [ :id, 
+                :field_setting_id, 
                 :label, 
                 :value 
               ]
@@ -115,7 +99,8 @@ module Binda
       def new_params
         params.require(:field_group).permit( 
           new_field_settings:
-            [ :field_group_id, 
+            [ :id,
+              :field_group_id, 
               :field_setting_id, 
               :name, 
               :slug, 
@@ -129,7 +114,8 @@ module Binda
               choices: [] 
             ],
           new_choices: 
-            [ :field_setting_id, 
+            [ :id,
+              :field_setting_id, 
               :label, 
               :value 
             ]
@@ -140,5 +126,31 @@ module Binda
         FieldSetting.reset_field_settings_array
       end
 
+      def add_new_field_settings
+        # Create new fields if any
+        new_params[:new_field_settings].each do |field_setting|
+          unless field_setting[:name].blank?
+            new_field_setting = @field_group.field_settings.create( field_setting )
+            unless new_field_setting
+              return redirect_to edit_structure_field_group_path( @structure.slug, @field_group.slug ), flash: { error: new_field_setting.errors }
+            end
+          end
+        end
+      end
+
+      def add_new_choices
+        # Create new fields if any
+        unless new_params[:new_choices].nil? 
+          new_params[:new_choices].each do |choice|
+            unless choice[:label].blank? || choice[:value].blank?
+              new_choice = Choice.create( choice )
+              unless new_choice
+                return redirect_to edit_structure_field_group_path( @structure.slug, @field_group.slug ), flash: { error: new_choice.errors }
+              end
+            end
+          end
+        end 
+      end
+
   end
 end

data/app/controllers/binda/field_settings_controller.rb

@@ -25,23 +25,23 @@ module Binda
       @field_setting = @field_group.field_settings.build(field_setting_params)
 
       if @field_setting.save
-        redirect_to structure_field_group_field_setting_path( @structure.slug, @field_group.slug, @field_setting.slug ), notice: 'Field setting was successfully created.'
+        redirect_to structure_field_group_field_setting_path( @structure, @field_group, @field_setting ), notice: 'Field setting was successfully created.'
       else
-        redirect_to new_structure_field_group_field_setting_path( @structure.slug, @field_group.slug ), flash: { alert: @field_setting.errors }
+        redirect_to new_structure_field_group_field_setting_path( @structure, @field_group ), flash: { alert: @field_setting.errors }
       end
     end
 
     def update
       if @field_setting.update(field_setting_params)
-        redirect_to structure_field_group_field_setting_path( @structure.slug, @field_group.slug, @field_setting.slug ), notice: 'Field setting was successfully updated.'
+        redirect_to structure_field_group_field_setting_path( @structure, @field_group, @field_setting ), notice: 'Field setting was successfully updated.'
       else
-        redirect_to edit_structure_field_group_field_setting_path( @structure.slug, @field_group.slug, @field_setting.slug ), flash: { alert: @field_setting.errors }
+        redirect_to edit_structure_field_group_field_setting_path( @structure, @field_group, @field_setting ), flash: { alert: @field_setting.errors }
       end
     end
 
     def destroy
       @field_setting.destroy
-      redirect_to structure_field_group_path( @structure.slug, @field_group.slug ), notice: 'Field setting and all dependent content were successfully destroyed.'
+      redirect_to structure_field_group_path( @structure, @field_group ), notice: 'Field setting and all dependent content were successfully destroyed.'
     end
 
     private

data/app/controllers/binda/manage/users_controller.rb

@@ -3,7 +3,6 @@ require_dependency "binda/application_controller"
 module Binda
   class Manage::UsersController < ApplicationController
     before_action :set_user, only: [:show, :edit, :update, :destroy]
-    before_action :check_if_is_superadmin, only: [:update, :destroy]
 
     def index
       @users = User.all
@@ -38,7 +37,7 @@ module Binda
 
     def update
       if @user.is_superadmin && !current_user.is_superadmin
-        redirect_to manage_users_url, notice: 'Sorry, you cannot edit a administrator.'
+        redirect_to manage_users_url, notice: 'Sorry, you cannot edit a super administrator.'
       else
         respond_to do |format|
           if @user.update(user_params)
@@ -57,7 +56,7 @@ module Binda
     def destroy
       if current_user.email == @user.email
         redirect_to manage_users_url, flash: { alert: 'Sorry, you cannot delete your own account.' }
-      elsif !current_user.is_superadmin
+      elsif @user.is_superadmin && !current_user.is_superadmin
         redirect_to manage_users_url, flash: { alert: 'Sorry, you cannot delete an administrator.' }
       else
         @user.destroy
@@ -87,11 +86,5 @@ module Binda
           params[:user].delete(:password_confirmation)
         end
       end
-
-      def check_if_is_superadmin
-        if current_user.is_superadmin
-          redirect_to manage_users_url, alert: 'Sorry, it\'s forbidden to modify this account.'
-        end
-      end
   end
 end

data/app/controllers/binda/structures_controller.rb

@@ -5,7 +5,7 @@ module Binda
     before_action :set_structure, only: [:show, :edit, :update, :destroy, :fields_update ]
 
     def index
-      @structures = Structure.order('position').all
+      @structures = Structure.order('position').all.page params[:page]
     end
 
     def show
@@ -23,14 +23,7 @@ module Binda
       @structure = Structure.new(structure_params)
 
       if @structure.save
-        # Creates a default empty field group 
-        @field_group = @structure.field_groups.build( name: 'General Details', position: 1 )
-        # Unless there is a problem...
-        unless @field_group.save
-          return redirect_to structure_path( @structure.slug ), flash: { error: 'General Details group hasn\'t been created' }
-        end
-        # ... redirect to the new structure path
-        redirect_to structure_path( @structure.slug ), notice: "#{ @structure.name } structure was successfully created."
+        redirect_to structure_path( @structure.slug ), notice: "#{ @structure.name.capitalize } structure was successfully created."
       else
         render :new
       end
@@ -49,7 +42,7 @@ module Binda
 
       # Update the other ones
       if @structure.update(structure_params)
-        redirect_to structure_path( @structure.slug ), notice: "#{ @structure.name } structure was successfully updated."
+        redirect_to structure_path( @structure.slug ), notice: "#{ @structure.name.capitalize } structure was successfully updated."
       else
         render :edit
       end
@@ -57,11 +50,11 @@ module Binda
 
     def destroy
       @structure.destroy
-      redirect_to structures_url, notice: "#{ @structure.name } structure was successfully destroyed."
+      redirect_to structures_url, notice: "#{ @structure.name.capitalize } structure was successfully destroyed."
     end
 
     def fields_update
-      redirect_to :back, notice: "#{ @structure.name } structure was successfully updated."
+      redirect_to :back, notice: "#{ @structure.name.capitalize } structure was successfully updated."
     end
 
     def sort
@@ -79,7 +72,7 @@ module Binda
 
       # Only allow a trusted parameter "white list" through.
       def structure_params
-        params.require(:structure).permit(:name, :slug, :position, :has_categories, field_groups_attributes: [ :id, :name, :structure_id, :slug ] )
+        params.require(:structure).permit(:name, :slug, :position, :has_categories, :instance_type, field_groups_attributes: [ :id, :name, :structure_id, :slug ] )
       end
 
       def new_params

data/app/controllers/concerns/binda/default_helpers.rb

@@ -0,0 +1,226 @@
+module Binda
+	# Binda comes with a bunch of helpers to make life easier.
+	module DefaultHelpers
+		extend ActiveSupport::Concern
+
+	  # Get components
+	  # 
+		# This method retrieves **all components** belonging to a specific structure. 
+		#   With this method you can optimize the query in order to avoid the infamous 
+		#   [N+1 issue](https://youtu.be/oJ4Ur5XPAF8) by specifing what field types
+		#   you are going to request in the view. The list of field types available 
+		#   can be found in the [official documentation](https://github.com/lacolonia/binda/wiki/Fields).
+		#   Field types must be listed as separated strings, lowercase and plural.
+		#   See the following examples.
+		#   
+		# @example Get all components belonging to `page` structure:
+		#   get_components('page')
+		#   # return all published pages sorted by position
+		#   
+		#   get_components('page', { published: false })
+		#   # return all published and draft pages sorted by position
+		#   
+		#   get_components('page', { custom_order: 'created_at DESC' })
+		#   # return all published pages sorted chronologically
+		#   
+		#   get_components('page', { fields: ['strings'] })
+		#   get_components('page', { fields: ['strings', 'dates', 'assets'] })
+		#   # it optimizes the query in order to avoid the N+1 issue 
+		#   # useful if you are going to request any field from these components
+		#   # or from any repeaters
+		#   
+		#   get_components('page', { published: true, custom_order: 'name', fields: ['string', 'repeaters'] })
+		#   # it's then possible to create any sort of combination
+		#   
+		# @param slug [string] The slug of the structure to which the components belong
+		# @param args [hash] A hash containing the options used to customize the query.
+		# 
+		#   The hash parameters are: 
+		#   
+		#   - `published` (boolean) - Set to true to gather just published components, 
+		#   false to get them all
+		#   - `custom_order` (string) - Set the order parameter. Default is `position`, 
+		#   but you can use any of the following `created_at`, `updated_at`, `id`, `name`, `slug`.
+		#   Append `DESC` if you want to reverse the order, e.g. `position DESC`
+		#   - `fields` (array) - Include related field classes to the query. The list of field types available 
+		#   can be found in the [official documentation](https://github.com/lacolonia/binda/wiki/Fields).
+		#   Field types must be listed as separated strings, lowercase and plural.
+		#   
+		# @return [ActiveRecord Object]  
+	  def get_components( slug, args = { published: true, custom_order: 'position', fields: [] })
+			
+			validate_provided_arguments( args )
+
+	  	# Sets defaults
+			args[:published]    = 'true'     if args[:published].nil?
+			args[:custom_order] = 'position' if args[:custom_order].nil?
+			args[:fields] = [] if args[:fields].nil?
+
+			validate_provided_fields( args )
+			validate_provided_custom_order( args )
+
+			# Generate query
+			if args[:published]
+				if args[:fields].any?
+					Component.where( structure_id: Structure.where( slug: slug ) ).published.includes( args[:fields] )
+				else
+					Component.where( structure_id: Structure.where( slug: slug ) ).published
+				end
+			else
+				if args[:fields].any?
+					Component.where( structure_id: Structure.where( slug: slug ) ).order( args[:custom_order] ).includes( args[:fields] )
+				else
+					Component.where( structure_id: Structure.where( slug: slug ) ).order( args[:custom_order] )
+				end
+			end
+		end
+
+		# This method retrieves a **single component**.
+		#   With this method you can optimize the query in order to avoid the infamous 
+		#   [N+1 issue](https://youtu.be/oJ4Ur5XPAF8) by specifing what field types
+		#   you are going to request in the view. The list of field types available 
+		#   can be found in the [official documentation](https://github.com/lacolonia/binda/wiki/Fields).
+		#   Field types must be listed as separated strings, lowercase and plural.
+		#   See the following examples.
+		#   
+		# @example Get a component with slug `my-first-post`
+		#   get_component('my-first-post')
+		#   # return the component
+		#   
+		#   get_component('my-first-post', { fields: ['strings', 'texts', 'assets', 'selections'] })
+		#   # return the component and optimize the query for any of the listed fields related to it
+		#   
+		#   
+		# @param slug [string] The slug of the component
+		# @param args [hash] A hash containing the options used to customize the query.
+		# 
+		#   The hash parameters are: 
+		#   
+		#   - `fields` (array) - Include related field classes to the query. The list of field types available 
+		#   can be found in the [official documentation](https://github.com/lacolonia/binda/wiki/Fields).
+		#   Field types must be listed as separated strings, lowercase and plural.
+		#   
+		# @return [ActiveRecord Object]  
+		def get_component( slug, args = { fields: [] })
+
+			validate_provided_arguments( args )
+
+	  	# Sets defaults
+			args[:fields] = [] if args[:fields].nil?
+
+			validate_provided_fields( args )
+
+			if args[:fields].any?
+				Component.where(slug: slug).first.inlcudes( args[:fields] )
+			else
+				Component.where(slug: slug).first
+			end
+		end
+
+		# This method retrieves a **board**.
+		#   With this method you can optimize the query in order to avoid the infamous 
+		#   [N+1 issue](https://youtu.be/oJ4Ur5XPAF8) by specifing what field types
+		#   you are going to request in the view. The list of field types available 
+		#   can be found in the [official documentation](https://github.com/lacolonia/binda/wiki/Fields).
+		#   Field types must be listed as separated strings, lowercase and plural.
+		#   See the following examples.
+		#   
+		# @example Get a board with slug `my-dashboard`
+		#   get_board('my-dashboard')
+		#   # return the board
+		#   
+		#   get_board('my-dashboard', { fields: ['strings', 'texts', 'assets', 'selections'] })
+		#   # return the board and optimize the query for any of the listed fields related to it
+		#   
+		#   
+		# @param slug [string] The slug of the board
+		# @param args [hash] A hash containing the options used to customize the query.
+		# 
+		#   The hash parameters are: 
+		#   
+		#   - `fields` (array) - Include related field classes to the query. The list of field types available 
+		#   can be found in the [official documentation](https://github.com/lacolonia/binda/wiki/Fields).
+		#   Field types must be listed as separated strings, lowercase and plural.
+		#   
+		# @return [ActiveRecord Object]  
+		def get_board( slug, args = { fields: [] })
+			
+			validate_provided_arguments( args )
+
+	  	# Sets defaults
+			args[:fields] = [] if args[:fields].nil?
+			
+			check_provided_fields( args )
+
+			if args[:fields].any?
+				Board.where(slug: slug).first.inlcudes( args[:fields] )
+			else
+				Board.where(slug: slug).first
+			end
+		end
+
+		# This method retrieves a **repeater**.
+		#   With this method you can optimize the query in order to avoid the infamous 
+		#   [N+1 issue](https://youtu.be/oJ4Ur5XPAF8) by specifing what field types
+		#   you are going to request in the view. The list of field types available 
+		#   can be found in the [official documentation](https://github.com/lacolonia/binda/wiki/Fields).
+		#   Field types must be listed as separated strings, lowercase and plural.
+		#   See the following examples.
+		#   
+		# @example Get a repeater with slug `slideshow`
+		#   get_repeater('slideshow')
+		#   # return the repeater
+		#   
+		#   get_repeater('slideshow', { fields: ['strings', 'assets'] })
+		#   # return the repeater and optimize the query for any of the listed fields related to it
+		#   
+		#   
+		# @param slug [string] The slug of the repeater
+		# @param args [hash] A hash containing the options used to customize the query.
+		# 
+		#   The hash parameters are: 
+		#   
+		#   - `fields` (array) - Include related field classes to the query. The list of field types available 
+		#   can be found in the [official documentation](https://github.com/lacolonia/binda/wiki/Fields).
+		#   Field types must be listed as separated strings, lowercase and plural.
+		#   
+		# @return [ActiveRecord Object]  
+		def get_repeater( slug, args = { fields: [] })
+			
+			validate_provided_arguments( args )
+
+	  	# Sets defaults
+			args[:fields] = [] if args[:fields].nil?
+			
+			check_provided_fields( args )
+
+			if args[:fields].any?
+				Repeater.where(slug: slug).first.inlcudes( args[:fields] )
+			else
+				Repeater.where(slug: slug).first
+			end
+		end
+
+		private 
+
+			# Check if provided `fields` are ok, otherwise raise an error
+			def validate_provided_fields( args )
+				raise ArgumentError, "Argument error in get_components(): fields should be an Array, not a #{args[:fields].class.to_s}.", caller unless args[:fields].instance_of? Array
+				args[:fields].each do |f|
+					raise ArgumentError, "Argument error in get_components(): #{f.to_s} is not a valid field type.", caller unless FieldSetting.get_field_classes.map{ |fc| fc.underscore.pluralize }.include? f.to_s
+				end
+			end
+
+			# Check if provided `custom_order` is ok, otherwise raise an error
+			def validate_provided_custom_order( args )
+				raise ArgumentError, "Argument error in get_components(): custom_order should be a String, not a #{args[:custom_order].class.to_s}.", caller unless args[:custom_order].instance_of? ::String
+			end
+
+			# Check if provided arguments are ok, otherwise raise an error
+			def validate_provided_arguments( args )
+				args.each do |key, value|
+					raise ArgumentError, "Argument error in get_components(): #{key.to_s} is not a valid key.", caller unless ['published', 'custom_order', 'fields'].include? key.to_s
+				end
+			end
+	end
+end

data/app/controllers/concerns/binda/fieldable_helpers.rb

@@ -0,0 +1,44 @@
+module Binda
+  module FieldableHelpers
+    
+    extend ActiveSupport::Concern
+
+      # Only allow a trusted parameter "white list" through.
+      def fieldable_params 
+        [ texts_attributes:      [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :content ], 
+          strings_attributes:    [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :content ], 
+          assets_attributes:     [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :image ], 
+          dates_attributes:      [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :date ], 
+          galleries_attributes:  [ :id, :field_setting_id, :fieldable_type, :fieldable_id ],
+          radios_attributes:     [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :choice_ids ],
+          selections_attributes: [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :choice_ids ],
+          checkboxes_attributes: [ :id, :field_setting_id, :fieldable_type, :fieldable_id, choice_ids: [] ],
+          repeaters_attributes:  [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :field_group_id,
+            texts_attributes:      [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :content ], 
+            assets_attributes:     [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :image ], 
+            dates_attributes:      [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :date ], 
+            galleries_attributes:  [ :id, :field_setting_id, :fieldable_type, :fieldable_id ], 
+            repeaters_attributes:  [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :field_group_id ],
+            radios_attributes:     [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :choice_ids ],
+            selections_attributes: [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :choice_ids ],
+            checkboxes_attributes: [ :id, :field_setting_id, :fieldable_type, :fieldable_id, choice_ids: [] ]
+          ]]
+      end
+
+      def repeater_params
+        params.require(:repeater).permit( 
+          new_repeaters_attributes: [ :id, :field_setting_id, :field_group_id, :fieldable_type, :fieldable_id,
+            texts_attributes:         [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :content ], 
+            strings_attributes:       [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :content ], 
+            assets_attributes:        [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :image ], 
+            dates_attributes:         [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :date ], 
+            galleries_attributes:     [ :id, :field_setting_id, :fieldable_type, :fieldable_id ], 
+            repeaters_attributes:     [ :id, :field_setting_id, :field_group_id, :fieldable_type, :fieldable_id ],
+            radios_attributes:        [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :choice_ids ],
+            selections_attributes:    [ :id, :field_setting_id, :fieldable_type, :fieldable_id, :choice_ids ],
+            checkboxes_attributes:    [ :id, :field_setting_id, :fieldable_type, :fieldable_id, choice_ids: [] ]
+          ])
+      end
+
+  end
+end