binda 0.0.6 → 0.0.7

data/app/models/binda/repeater.rb

@@ -1,38 +1,31 @@
 module Binda
   class Repeater < ApplicationRecord
 
-    include ComponentModelHelper
+    include FieldableAssociations
 
   	# Associations
   	belongs_to :fieldable, polymorphic: true
     belongs_to :field_setting
 
-    # Fields Associations 
-    # 
-    # If you add a new field remember to update:
-    #   - get_fieldables (see here below)
-    #   - get_field_types (see here below)
-    #   - component_params (app/controllers/binda/components_controller.rb)
-    has_many :texts,         as: :fieldable, dependent: :delete_all
-    has_many :dates,         as: :fieldable, dependent: :delete_all
-    has_many :galleries,     as: :fieldable, dependent: :delete_all
-    has_many :assets,        as: :fieldable, dependent: :delete_all
-    has_many :radios,        as: :fieldable, dependent: :delete_all 
-    has_many :selects,       as: :fieldable, dependent: :delete_all 
-    has_many :checkboxes,    as: :fieldable, dependent: :delete_all 
-    # Repeaters need destroy_all, not delete_all
-    has_many :repeaters,     as: :fieldable, dependent: :destroy
-
-    accepts_nested_attributes_for :texts, :dates, :assets, :galleries, :repeaters, :radios, :selects, :checkboxes, allow_destroy: true
-
     # The following direct association is used to securely delete associated fields
     # Infact via `fieldable` the associated fields might not be deleted 
     # as the fieldable_id is related to the `component` rather than the `field_setting`
 
     after_create :set_default_position
 
+
+    # Set default position after create
+    # 
+    # This methods ensure that every repeater instance has an explicit position.
+    #   The latest repeater created gets the highest position number.
+    # 
+    # @return [object] Repeater instance
     def set_default_position
-        position = self.fieldable.repeaters.find_all{ |r| r.field_setting_id == self.field_setting.id }.length
+        # apparently `self.fieldable != self.fieldable_type.constantize.find( self.fieldable_id )`
+        # as the former has always one repeater, the latter has all repeaters created so far
+        # that's way we use the longer version
+        instance = self.fieldable_type.constantize.find( self.fieldable_id )
+        position = instance.repeaters.find_all{ |r| r.field_setting_id == self.field_setting.id }.length
         self.update_attribute 'position', position
     end
 

data/app/models/binda/selection.rb

@@ -0,0 +1,17 @@
+module Binda
+	class Selection < ApplicationRecord
+
+		has_and_belongs_to_many :choices
+		belongs_to :field_setting
+
+		after_create :set_choice
+
+		# Set the default choice if the field must have at least one.
+		# This method run after the record is created.
+		def set_choice
+			return if self.field_setting.allow_null
+			self.choices << self.field_setting.default_choice if self.choices.empty?
+		end
+
+	end
+end

data/app/models/binda/string.rb

@@ -0,0 +1,4 @@
+module Binda
+	class String < Text
+	end
+end

data/app/models/binda/structure.rb

@@ -3,29 +3,87 @@ module Binda
 
 		# Associations
 		has_many :components
+		has_one  :board
 		has_many :categories
 		has_many :field_groups
 
 		# Validations
 		validates :name, presence: true
 		validates :slug, uniqueness: true
+		validates :instance_type, presence: true, inclusion: { in: %w(component board), message: "%{value} is not a valid instance" }
 		accepts_nested_attributes_for :field_groups, allow_destroy: true, reject_if: :is_rejected
 
 		# Slug
 		extend FriendlyId
-		friendly_id :name, use: [:slugged, :finders]
+		friendly_id :default_slug, use: [:slugged, :finders]
 
+		after_create :add_default_field_group
+		after_create :add_instance_details
+    after_create :set_default_position
 
-		# CUSTOM METHODS
-		# --------------
-		# https://github.com/norman/friendly_id/issues/436
-		def should_generate_new_friendly_id?
-			slug.blank?
-		end
+		# Friendly id preference on slug generation
+		#
+		# Method inherited from friendly id 
+		# @see https://github.com/norman/friendly_id/issues/436
+	  def should_generate_new_friendly_id?
+	    slug.blank? || name_changed?
+	  end
 
+		#
+		# Sets the validation rules to accept and save an attribute
 		def is_rejected( attributes )
 			attributes['name'].blank?
 		end
 
+		# Set slug name
+		#
+		# It generates 4 possible slugs before falling back to FriendlyId default behaviour
+		def default_slug
+			[ "#{ self.name }",
+				"#{ self.name }-1",
+				"#{ self.name }-2",
+				"#{ self.name }-3" ]
+		end
+
+		# Add a field group as a default
+		# 
+		# In order to speed up the setup process Binda will automatically provide a 
+		#   field group called 'General Details' after the structure is created.
+		# @return [redirect]
+		def add_default_field_group
+      # Creates a default empty field group 
+      field_group = self.field_groups.build( name: 'General Details', position: 1 )
+      # Unless there is a problem...
+      unless field_group.save
+        return redirect_to structure_path( self.slug ), flash: { error: 'General Details group hasn\'t been created' }
+      end
+    end
+
+    # Add details based on instance type
+    # 
+    # If instance_type is set to 'setting' it generates a default Binda::Setting instance after creation. 
+    #   The generated instance will be associated to the structure and named after it.
+    #   It also disable categories (this could be a different method, or method could be more explicit)
+    def add_instance_details
+    	if self.instance_type == 'board'
+    		self.update_attribute 'has_categories', false
+	    	board = self.build_board( name: self.name )
+	      unless board.save
+	        return redirect_to structure_path( self.slug ), flash: { error: 'The board instance hasn\'t been created' }
+	      end
+	    end
+    end
+
+    # Set default position after create
+    # 
+    # This methods ensure that every repeater instance has an explicit position.
+    #   The latest repeater created gets the highest position number.
+    # 
+    # @return [object] Repeater instance
+    def set_default_position
+        position = Structure.all.length
+        self.update_attribute 'position', position
+    end
+
 	end
 end

data/app/models/concerns/binda/{component_model_helper.rb → fieldable_associations.rb}

@@ -1,20 +1,56 @@
 module Binda
-	module ComponentModelHelper
-		# 
-		# Component helpers are supposed to simplify common operation like 
-		#   retrieving data belonging to the component instance (texts, assets, dates and so on)
+	# Fieldable associations are Binda's core feature. 
+	# 
+	# They provide model classes with a collection of fields (texts, assets, dates and so on)
+	#   to store data in a simple yet powerful way. It's possible to make use of a set of helpers to 
+	#   retrieve fields data belonging to each model instance. See the following methods. 
+	module FieldableAssociations
 
 		extend ActiveSupport::Concern
 
+		included do 
+	    # Fieldable Associations 
+	    # 
+	    # If you add a new field remember to update:
+	    #   - get_fieldables (see here below)
+	    #   - get_field_types (see here below)
+	    #   - component_params (app/controllers/binda/components_controller.rb)
+	    has_many :texts,         as: :fieldable, dependent: :delete_all
+	    has_many :strings,       as: :fieldable, dependent: :delete_all
+	    has_many :dates,         as: :fieldable, dependent: :delete_all
+	    has_many :galleries,     as: :fieldable, dependent: :delete_all
+	    has_many :assets,        as: :fieldable, dependent: :delete_all
+	    has_many :radios,        as: :fieldable, dependent: :delete_all 
+	    has_many :selections,    as: :fieldable, dependent: :delete_all 
+	    has_many :checkboxes,    as: :fieldable, dependent: :delete_all 
+	    # Repeaters need destroy_all, not delete_all
+	    has_many :repeaters,     as: :fieldable, dependent: :destroy
+
+			# has_many :bindings
+			# has_many :assets, class_name: 'Admin::Asset', through: :bindings
+
+	    accepts_nested_attributes_for :texts, :strings, :dates, :assets, :galleries, :repeaters, :radios, :selections, :checkboxes, allow_destroy: true
+
+		end
+
 		# Get the object related to that field setting
 		# If the object doesn't exists yet it will return nil
 		# 
 		# @param  field_slug [string] The slug of the field setting
-		# @return [string] Returns the content of the string/text 
-		# @return [nil]    Returns null if it's empty or it doesn't exists
+		# @return [string] Returns the content of the text 
+		# @return [error]  Raise an error if no record is found
 		def get_text field_slug 
-			obj = self.texts.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			obj.content unless obj.nil?
+			obj = self.texts.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) && t.type = 'Binda::Text' }
+			unless obj.nil?
+				obj.content
+			else
+				you_mean_string = !self.strings.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) && t.type = 'Binda::String' }.nil?
+				if you_mean_string
+					raise ArgumentError, "This slug is associated to a string not a text. Use get_string() instead.", caller
+				else
+					raise ArgumentError, "There isn't any text associated to the current slug.", caller
+				end
+			end
 		end
 
 		# Get the object related to that field setting
@@ -22,7 +58,40 @@ module Binda
 		# @param field_slug [string] The slug of the field setting
 		# @return [boolean]
 		def has_text field_slug 
-			obj = self.texts.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
+			obj = self.texts.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) && t.type = 'Binda::Text' }
+			if obj.present?
+				return !obj.content.blank?
+			else
+				return false
+			end
+		end
+
+		# Get the object related to that field setting
+		# If the object doesn't exists yet it will return nil
+		# 
+		# @param  field_slug [string] The slug of the field setting
+		# @return [string] Returns the content of the string 
+		# @return [error]  Raise an error if no record is found
+		def get_string field_slug 
+			obj = self.strings.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) && t.type = 'Binda::String' }
+			unless obj.nil?
+				obj.content
+			else
+				you_mean_text = !self.strings.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) && t.type = 'Binda::Text' }.nil?
+				if you_mean_text
+					raise ArgumentError, "This slug is associated to a text not a string. Use get_text() instead.", caller
+				else
+					raise ArgumentError, "There isn't any string associated to the current slug.", caller
+				end
+			end
+		end
+
+		# Get the object related to that field setting
+		# 
+		# @param field_slug [string] The slug of the field setting
+		# @return [boolean]
+		def has_string field_slug 
+			obj = self.strings.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) && t.type = 'Binda::String' }
 			if obj.present?
 				return !obj.content.blank?
 			else
@@ -121,50 +190,52 @@ module Binda
 			obj.sort_by(&:position) unless obj.nil?
 		end
 
-		# Find or create a field by field setting and field type
-		# This is used in Binda's form
-		# 
-		# @param field_setting_id [string] The field setting id
-		# @param field_type [string] THe field type
-		def find_or_create_a_field_by field_setting_id, field_type
-			if FieldSetting.get_fieldables.include?( field_type.capitalize ) && field_setting_id.is_a?( Integer )
-				self.send( field_type.pluralize ).find_or_create_by( field_setting_id: field_setting_id )
-			else
-				raise ArgumentError, "One parameter of find_or_create_a_field_by() is not correct.", caller
-			end
-		end
-
 		# Get the radio choice
 		# 
 		# If by mistake the Radio instance has many choices associated, 
 		#   only the first one will be retrieved.
 		# 
 		# @param field_slug [string] The slug of the field setting
-		# @return [object] The active record object of the selected choice
+		# @return [hash] A hash of containing the label and value of the selected choice.
 		def get_radio_choice field_slug
 			obj = self.radios.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			obj.choices.first
+			return { label: obj.choices.first.label, value: obj.choices.first.value }
 		end
 
 		# Get the select choices
 		# 
 		# @param field_slug [string] The slug of the field setting
-		# @return [array] An array containing the selected choices objects
-		def get_select_choices field_slug
+		# @return [hash] A hash of containing the label and value of the selected choice.
+		def get_selection_choice field_slug
 			# select cannot be chosen has variable name, therefore is prefixed with 's'
-			obj = self.selects.find{ |t| t.field_setting_id = FieldSetting.get_id( field_slug ) }
-			obj.choices
+			obj = self.selections.find{ |t| t.field_setting_id = FieldSetting.get_id( field_slug ) }
+			return { label: obj.choices.first.label, value: obj.choices.first.value }
 		end
 
 		# Get the checkbox choice
 		# 
 		# @param field_slug [string] The slug of the field setting
-		# @return [array] The active record object of the selected choice
+		# @return [hash] A hash of labels and values of the selected choices.
 		def get_checkbox_choices field_slug
-			# select cannot be chosen has variable name, therefore is prefixed with '_'
 			obj = self.checkboxes.find{ |t| t.field_setting_id = FieldSetting.get_id( field_slug ) }
-			obj.choices
+			obj_hash = {}
+			obj.choices.order('label').each do |o|
+				obj_hash << { label: obj.choices.first.label, value: obj.choices.first.value }
+			end
+			return obj_hash
 		end
 
+		# Find or create a field by field setting and field type
+		# This is used in Binda's form
+		# 
+		# @param field_setting_id [string] The field setting id
+		# @param field_type [string] THe field type
+		def find_or_create_a_field_by field_setting_id, field_type
+			if FieldSetting.get_field_classes.include?( field_type.capitalize ) && field_setting_id.is_a?( Integer )
+				self.send( field_type.pluralize ).find_or_create_by( field_setting_id: field_setting_id )
+			else
+				raise ArgumentError, "One parameter in find_or_create_a_field_by() is not correct.", caller
+			end
+		end
 	end
 end

data/app/views/binda/boards/edit.html.erb

@@ -0,0 +1,7 @@
+<% content_for :header do %>
+  <h3><%= "#{ t :edit }".capitalize %> <%= @structure.name.humanize.split.map(&:capitalize).join(' ') %></h3>
+<% end %>
+
+<% content_for :content do %>
+	<%= render 'binda/fieldable/form_body' %>
+<% end %>

data/app/views/binda/components/edit.html.erb

@@ -1,8 +1,11 @@
 <% content_for :header do %>
+  <div class="main-header--buttons">
+    <%= link_to "New #{ @structure.name.humanize.split.map(&:capitalize).join(' ') }", new_structure_component_path , class: 'main-header--link btn btn-primary' %>    
+  </div>
   <h3><%= "#{ t :edit }".capitalize %> <%= @structure.name.humanize.split.map(&:capitalize).join(' ') %></h3>
   <a href="<%= structure_components_path %>" class="main-header--back"><span class="glyphicon glyphicon-list"></span> <%= "#{ t :back_to_index }".capitalize %></a>
 <% end %>
 
 <% content_for :content do %>
-	<%= render 'form_body' %>
+	<%= render 'binda/fieldable/form_body' %>
 <% end %>

data/app/views/binda/components/index.html.erb

@@ -35,6 +35,8 @@
           <% end %>
         <tbody>
       </table>
+
+    <%= paginate @components %>
     
     <%= link_to "New #{ @structure.name.humanize.split.map(&:capitalize).join(' ') }", new_structure_component_path, class: 'main-header--link btn btn-default', action: "new" %>    
         

data/app/views/binda/components/new.html.erb

@@ -4,5 +4,5 @@
 <% end %>
 		
 <% content_for :content do %> 
-	<%= render 'form_body' %>
+	<%= render 'binda/fieldable/form_body' %>
 <% end %>

data/app/views/binda/field_groups/_form_body.html.erb

@@ -1,14 +1,14 @@
 <div class="row">
 <div class="form-body--container col-sm-12">
 
-<%= simple_form_for field_group, url: get_form_field_group_url, defaults: { label: false }, html: { class: 'form-body' } do |f| %>
+<%= simple_form_for @field_group, url: get_form_field_group_url, defaults: { label: false }, html: { class: 'form-body' } do |f| %>
 
-  <% if field_group.errors.any? %>
+  <% if @field_group.errors.any? %>
     <div id="error_explanation">
-      <h2><%= pluralize( field_group.errors.count, "error") %> prohibited this field_group from being saved:</h2>
+      <h2><%= pluralize( @field_group.errors.count, "error") %> prohibited this field_group from being saved:</h2>
 
       <ul>
-      <% field_group.errors.full_messages.each do |message| %>
+      <% @field_group.errors.full_messages.each do |message| %>
         <li><%= message %></li>
       <% end %>
       </ul>
@@ -25,7 +25,7 @@
           <h5><%= "#{ t :title }".capitalize %></h5>
           <%= f.input :name %>
           
-          <% if field_group.slug.nil? %>
+          <% if @field_group.slug.nil? %>
             <%= f.input :slug, as: :hidden %>
           <% else %>
             <h5><%= "#{ t :slug }".capitalize %></h5>
@@ -37,17 +37,17 @@
       <div class="form-section--wide-container row">
         <div class="col-sm-12 form-section">
 
-          <%= render "form_section", section: field_group, f: f, structure: @structure %>
+          <%= render "form_section", f: f %>
         
         </div>
       </div>
-      <% field_group.field_settings.where( field_type: 'repeater' ).order( :position ).each do |repeater| %>
+      <% @field_group.field_settings.where( field_type: 'repeater' ).order( :position, :id ).each do |repeater| %>
         <div class="form-section--wide-container row">
           <div class="col-sm-12 form-section">
           
             <h4><%= repeater.name.capitalize %></h4>
 
-            <%= render "form_section_repeater", section: field_group, f: f, structure: @structure, repeater: repeater %>
+            <%= render "form_section_repeater", f: f, repeater: repeater %>
 
           </div>
         </div>

data/app/views/binda/field_groups/_form_item.html.erb

@@ -8,7 +8,7 @@
 <% if ff.object.slug.nil? %>
 	<a class="form-item--remove-item-with-js" data-confirm="This operation will delete this setting and all related component content. Are you ok with that?"><span class="glyphicon glyphicon-trash" aria-hidden="true"></span></a>
 <% else %>
-	<a href="<%= structure_field_group_field_setting_path( field_group_id: section.slug, id: ff.object.slug ) %>" data-method="delete" data-confirm="This operation will delete this setting and all related component content. Are you ok with that?"><span class="glyphicon glyphicon-trash" aria-hidden="true"></span></a>
+	<a href="<%= structure_field_group_field_setting_path( @structure, @field_group, ff.object ) %>" data-method="delete" data-confirm="This operation will delete this setting and all related component content. Are you ok with that?"><span class="glyphicon glyphicon-trash" aria-hidden="true"></span></a>
 	<a class="form-item--close-button"><span class="glyphicon glyphicon-chevron-up" aria-hidden="true"></span></a>
 	<a class="form-item--open-button"><span class="glyphicon glyphicon-chevron-down" aria-hidden="true"></span></a>
 	<div class="form-item--label">
@@ -74,13 +74,13 @@
 			<%= ff.input :position, as: :integer, input_html: { class: "form-item--input" } %>
 		</div>
 
-		<% choiceables = ['radio', 'select', 'checkbox'] %>
+		<% choiceables = ['radio', 'selection', 'checkbox'] %>
 		<% if choiceables.include? ff.object.field_type %>
 
 			<%# - - - - - - - - - - - - %>
 			<%# CHOICES                 %>
 			<%# - - - - - - - - - - - - %>
-			<%= render 'form_item_choice', f: f, ff: ff, section: section  %>
+			<%= render 'form_item_choice', f: f, ff: ff  %>
 
 		<% end %>