binda 0.1.3 → 0.1.4

data/app/models/concerns/binda/fieldable_associations.rb

@@ -1,14 +1,17 @@
 module Binda
 	# 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. 
+	# They provide model classes like `Binda::Component` and `Binda::Board` 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. 
 	module FieldableAssociations
 
 		extend ActiveSupport::Concern
 
 		included do 
+
+	    include FieldableAssociationHelpers
+	    
 	    # Fieldable Associations 
 	    # 
 	    # If you add a new field remember to update:
@@ -82,355 +85,6 @@ module Binda
 		  #     end
 		  #   end
 		  # 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 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 ) && t.type != 'Binda::String' }	
-			unless obj.nil?
-				obj.content
-			else
-				check_text_error field_slug
-			end
-		end
-
-		# Check why get_text doesn't return a value
-		# This method isn't supposed to be used by anything other than get_text method
-		def check_text_error field_slug
-			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 (#{field_slug}) is associated to a string not a text. Use get_string() instead on instance (#{self.class.name} ##{self.id}).", caller
-			else
-				raise ArgumentError, "There isn't any text associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller
-			end
-		end
-
-		# Get the object related to that field setting
-		# 
-		# @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 ) && t.type != 'Binda::String' }
-			raise ArgumentError, "There isn't any text associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			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
-				check_string_error field_slug
-			end
-		end
-
-		# Check why get_string doesn't return a value
-		# This method isn't supposed to be used by anything other than get_string method
-		def check_string_error field_slug
-			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 (#{field_slug}) is associated to a text not a string. Use get_text() instead on instance (#{self.class.name} ##{self.id}).", caller
-			else
-				raise ArgumentError, "There isn't any string associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller
-			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' }
-			raise ArgumentError, "There isn't any string associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			if obj.present?
-				return !obj.content.blank?
-			else
-				return false
-			end
-		end
-
-		# Check if the field has an attached image
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [boolean]
-		def has_image field_slug 
-			obj = self.images.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			# Alternative query
-			# obj = Image.where(field_setting_id: FieldSetting.get_id( field_slug ), fieldable_id: self.id, fieldable_type: self.class.to_s ).first
-			raise ArgumentError, "There isn't any image associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			return obj.image.present?
-		end
-
-		# Get the image url based on the size provided, 
-		#   default is Carrierwave default (usually the real size)
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @param size [string] The size. It can be 'thumb' 200x200 cropped, 
-		#   'medium' 700x700 max size, 'large' 1400x1400 max size, or blank
-		# @return [string] The url of the image
-		def get_image_url field_slug, size = '' 
-			get_image_info( field_slug, size, 'url' )
-		end
-
-		# Get the image path based on the size provided, 
-		#   default is Carrierwave default (usually the real size)
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @param size [string] The size. It can be 'thumb' 200x200 cropped, 
-		#   'medium' 700x700 max size, 'large' 1400x1400 max size, or blank
-		# @return [string] The url of the image
-		def get_image_path field_slug, size = '' 
-			get_image_info( field_slug, size, 'path' )
-		end
-
-		# Get the object related to that field setting
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @param size [string] The size. It can be 'thumb' 200x200 cropped, 
-		#   'medium' 700x700 max size, 'large' 1400x1400 max size, or blank
-		# @param info [string] String of the info to be retrieved
-		# @return [string] The info requested if present
-		# @return [boolean] Returns false if no info is found or if image isn't found
-		def get_image_info field_slug, size, info 
-			obj = self.images.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			# Alternative query
-			# obj = Image.where(field_setting_id: FieldSetting.get_id( field_slug ), fieldable_id: self.id, fieldable_type: self.class.to_s ).first
-			raise ArgumentError, "There isn't any image associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			if obj.image.present?
-				if obj.image.respond_to?(size) && %w[thumb medium large].include?(size)
-					obj.image.send(size).send(info)
-				else
-					obj.image.send(info)
-				end
-			end
-		end
-
-		def get_image_dimension field_slug
-			obj = self.images.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-
-			raise ArgumentError, "There isn't any image associated to  the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			if obj.image.present?
-				if obj.image.respond_to?(size) && %w[thumb medium large].include?(size)
-					obj.image.send(size).send(info)
-				else
-					obj.image.send(info)
-				end
-			end
-		end
-
-		# Check if the field has an attached video
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [boolean]
-		def has_video field_slug 
-			obj = self.videos.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			# Alternative query
-			# obj = Image.where(field_setting_id: FieldSetting.get_id( field_slug ), fieldable_id: self.id, fieldable_type: self.class.to_s ).first
-			raise ArgumentError, "There isn't any video associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			return obj.video.present?
-		end
-
-		# Get the video url based on the size provided, 
-		#   default is Carrierwave default (usually the real size)
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @param size [string] The size. It can be 'thumb' 200x200 cropped, 
-		#   'medium' 700x700 max size, 'large' 1400x1400 max size, or blank
-		# @return [string] The url of the video
-		def get_video_url field_slug
-			get_video_info( field_slug, 'url' )
-		end
-
-		# Get the video path based on the size provided, 
-		#   default is Carrierwave default (usually the real size)
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @param size [string] The size. It can be 'thumb' 200x200 cropped, 
-		#   'medium' 700x700 max size, 'large' 1400x1400 max size, or blank
-		# @return [string] The url of the video
-		def get_video_path field_slug
-			get_video_info( field_slug, 'path' )
-		end
-
-		# Get the object related to that field setting
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @param info [string] String of the info to be retrieved
-		# @return [string] The info requested if present
-		# @return [boolean] Returns false if no info is found or if image isn't found
-		def get_video_info field_slug, info 
-			obj = self.videos.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			# Alternative query
-			# obj = video.where(field_setting_id: FieldSetting.get_id( field_slug ), fieldable_id: self.id, fieldable_type: self.class.to_s ).first
-			raise ArgumentError, "There isn't any video associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			if obj.video.present?
-				obj.video.send(info)
-			end
-		end
-
-		# Check if the field has an attached date
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [datetime] The date
-		# @return [boolean] Reutrn false if nothing is found
-		def has_date field_slug 
-			obj = self.dates.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			raise ArgumentError, "There isn't any date associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			if obj.present?
-				return !obj.date.nil?
-			else
-				return false
-			end
-		end
-
-		# Get the object related to that field setting
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [boolean]
-		def get_date field_slug 
-			obj = self.dates.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			raise ArgumentError, "There isn't any date associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			obj.date
-		end
-
-		# Check if exists any repeater with that slug
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [boolean]
-		def has_repeater field_slug 
-			obj = self.repeaters.find_all{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			raise ArgumentError, "There isn't any repeater associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			return obj.present?
-		end
-
-		# Get the all repeater instances
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [hash]
-		def get_repeater field_slug 
-			obj = self.repeaters.find_all{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			raise ArgumentError, "There isn't any repeater associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			obj.sort_by(&:position)
-		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 [hash] A hash of containing the label and value of the selected choice. `{ label: 'the label', value: 'the value'}`
-		def get_radio_choice field_slug
-			field_setting = FieldSetting.find_by(slug:field_slug)
-			obj = self.radios.find{ |t| t.field_setting_id == field_setting.id }
-			raise ArgumentError, "There isn't any radio associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			raise "There isn't any choice available for the current radio (#{field_slug}) on instance (#{self.class.name} ##{self.id})." unless field_setting.choices.any?
-			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 [hash] A hash of containing the label and value of the selected choice. `{ label: 'the label', 'value': 'the value'}`
-		def get_selection_choice field_slug
-			field_setting = FieldSetting.find_by(slug:field_slug)
-			obj = self.selections.find{ |t| t.field_setting_id == field_setting.id }
-			raise ArgumentError, "There isn't any radio associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			raise "There isn't any choice available for the current radio (#{field_slug}) on instance (#{self.class.name} ##{self.id})." unless field_setting.choices.any?
-			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] An array of labels and values of the selected choices. `[{ label: '1st label', value: '1st-value'}, { label: '2nd label', value: '2nd-value'}]`
-		def get_checkbox_choices field_slug
-			field_setting = FieldSetting.find_by(slug:field_slug)
-			obj = self.checkboxes.find{ |t| t.field_setting_id == field_setting.id }
-			raise ArgumentError, "There isn't any checkbox associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			raise "There isn't any choice available for the current radio (#{field_slug}) on instance (#{self.class.name} ##{self.id})." unless field_setting.choices.any?
-			obj_array = []
-			obj.choices.order('label').each do |o|
-				obj_array << { label: o.label, value: o.value }
-			end
-			return obj_array
-		end
-
-		# Check if has related components
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [boolean]
-		def has_related_components field_slug
-			obj = self.relations.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			raise ArgumentError, "There isn't any related field associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			return obj.dependent_relations.any?
-		end
-
-		# Alias for has_related_components
-		def has_dependent_components field_slug
-			has_related_components field_slug
-		end
-
-		# Get related components
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [array] An array of components
-		def get_related_components field_slug
-			obj = self.relations.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			raise ArgumentError, "There isn't any related field associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			return obj.dependent_relations.map{|relation| relation.dependent}
-		end
-
-		# Alias for get_related_components
-		def get_dependent_components field_slug
-			get_related_components field_slug
-		end
-
-		# Get all components which owns a relation where the current instance is a dependent
-		# 
-		# @param field_slug [string] The slug of the field setting of the relation
-		# @return [array] An array of components and/or boards
-		def get_owner_components field_slug
-			# obj = self.owner_relations.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			obj = Relation.where(field_setting_id: B.get_field_settings(field_slug)).includes(dependent_relations: :dependent).where(binda_relation_links: {dependent_type: self.class.name})
-			raise ArgumentError, "There isn't any relation associated to the current slug (#{field_slug}) where the current instance (#{self.class.name} ##{self.id}) is a dependent.", caller if obj.nil?
-			return obj
-		end
-
-		# Check if has related boards
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [boolean]
-		def has_related_boards field_slug
-			obj = self.relations.find{ |t| t.field_setting_id == FieldSetting.get_id( field_slug ) }
-			raise ArgumentError, "There isn't any related field associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			return obj.dependent_relations.any?
-		end
-
-		# Get related boards
-		# 
-		# @param field_slug [string] The slug of the field setting
-		# @return [array] An array of boards
-		def get_related_boards field_slug
-			obj = self.relations.find{ |t| t.field_setting_idid == FieldSetting.get_id( field_slug ) }
-			raise ArgumentError, "There isn't any related field associated to the current slug (#{field_slug}) on instance (#{self.class.name} ##{self.id}).", caller if obj.nil?
-			return obj.dependent_relations.map{|relation| relation.dependent}
 		end
 
 		# Find or create a field by field setting and field type
@@ -441,24 +95,9 @@ module Binda
 		# 
 		# @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
+		def find_or_create_a_field_by(field_setting_id, field_type)
 			if FieldSetting.get_field_classes.include?( field_type.classify ) && field_setting_id.is_a?( Integer )
-				# It's mandatory to use `select{}.first`!!! 
-				# If you use any ActiveRecord method (like `where` of `find`) the validation errors are wiped out 
-				# from the object and not rendered next to the form in the editor view
-				obj = self.send( field_type.pluralize ).select{|rf| rf.field_setting_id == field_setting_id}.first
-				if obj.nil?
-					# As we are using the `select{}.first` method, asynchronous requests passing through 
-					# this method will create some inconsistentcy between this `self` object and the real object. 
-					# In other words `self` should be reloaded, but we won't reload it otherwise we will 
-					# erase the errors shipped with it initially. Therefore we will check again with `find_or_create_by!`.
-					# This leads to another issue, which is: errors coming from asynchronous requests won't be considered
-					# as the `self` object is the initial one, not the "updated" one. At the current time this is not
-					# a problem because the only asynchronous requests are for brand new records which don't need validation.
-					return self.send( field_type.pluralize ).find_or_create_by!( field_setting_id: field_setting_id ) 
-				else
-					return obj
-				end
+				get_field(field_type, field_setting_id)
 			else
 				raise ArgumentError, "One parameter in find_or_create_a_field_by() is not correct on instance (#{self.class.name} ##{self.id}).", caller
 			end
@@ -495,5 +134,29 @@ module Binda
 		# TODO: Update all helpers replacing `find` method with ruby `select`. 
 		# This should improve performance avoiding generating useless ActiveRecord objects.
 
+		private
+
+			# Get field based on field type and field setting
+			# @param field_type [string]
+			# @param field_setting_id [integer]
+			# @return [ActiveRecord]
+			def get_field(field_type, field_setting_id)
+				# It's mandatory to use `select{}.first`!!! 
+				# If you use any ActiveRecord method (like `where` of `find`) the validation errors are wiped out 
+				# from the object and not rendered next to the form in the editor view
+				obj = self.send( field_type.pluralize ).select{|rf| rf.field_setting_id == field_setting_id}.first
+				if obj.nil?
+					# As we are using the `select{}.first` method, asynchronous requests passing through 
+					# this method will create some inconsistentcy between this `self` object and the real object. 
+					# In other words `self` should be reloaded, but we won't reload it otherwise we will 
+					# erase the errors shipped with it initially. Therefore we will check again with `find_or_create_by!`.
+					# This leads to another issue, which is: errors coming from asynchronous requests won't be considered
+					# as the `self` object is the initial one, not the "updated" one. At the current time this is not
+					# a problem because the only asynchronous requests are for brand new records which don't need validation.
+					return self.send( field_type.pluralize ).find_or_create_by!( field_setting_id: field_setting_id ) 
+				else
+					return obj
+				end 
+			end
 	end
 end

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

@@ -1,10 +1,23 @@
+<% content_for :title do %>
+  <%= "#{ t :edit }".capitalize %> 
+  <%= @structure.name.humanize.split.map(&:capitalize).join(' ') %> 
+<% end %>
+
 <% content_for :header do %>
   <div class="main-header--buttons">
   	<% if @structure.has_preview %>
-	    <%= link_to "<i class=\"fas fa-link\"></i>#{ t 'binda.preview' } #{ @structure.name.humanize.split.map(&:capitalize).join(' ') }".html_safe, "#{binda.root_path}#{@structure.slug}/#{@instance.slug}", class: 'main-header--link b-btn b-btn-primary' %>
+  		<a href="<%= "#{binda.root_path}#{@structure.slug}/#{@instance.slug}" %>" 
+  			class="main-header--link b-btn b-btn-primary">
+  			<i class="fas fa-link"></i> 
+  			<%= t 'binda.preview' %> 
+  			<%= @structure.name.humanize.split.map(&:capitalize).join(' ') %>
+  		</a>
     <% end %>
   </div>
-  <p class="main-header--title"><%= "#{ t :edit }".capitalize %> <%= @structure.name.humanize.split.map(&:capitalize).join(' ') %></p>
+  <p class="main-header--title">
+  	<%= "#{ t :edit }".capitalize %> 
+  	<%= @structure.name.humanize.split.map(&:capitalize).join(' ') %>	
+	</p>
 <% end %>
 
 <% content_for :content do %>