gnuside-custom_fields 2.3.1

data/lib/custom_fields/types/boolean.rb

@@ -0,0 +1,55 @@
+module CustomFields
+
+  module Types
+
+    module Boolean
+
+      module Field; end
+
+      module Target
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Adds a boolean field. It can not be required.
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the field.
+          #
+          def apply_boolean_custom_field(klass, rule)
+            klass.field rule['name'], type: ::Boolean, localize: rule['localized'] || false, default: false
+          end
+
+          # Build a hash storing the boolean value (true / false) for
+          # a boolean custom field of an instance.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the boolean custom field
+          #
+          # @return [ Hash ] field name => true / false
+          #
+          def boolean_attribute_get(instance, name)
+            default_attribute_get(instance, name)
+          end
+
+          # Set the value for the instance and the boolean field specified by
+          # the 2 params.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the boolean custom field
+          # @param [ Hash ] attributes The attributes used to fetch the values
+          #
+          def boolean_attribute_set(instance, name, attributes)
+            self.default_attribute_set(instance, name, attributes)
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/custom_fields/types/date.rb

@@ -0,0 +1,97 @@
+module CustomFields
+
+  module Types
+
+    module Date
+
+      module Field; end
+
+      module Target
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Adds a date field
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the field and if it is required or not
+          #
+          def apply_date_custom_field(klass, rule)
+            name = rule['name']
+
+            klass.field name, type: ::Date, localize: rule['localized'] || false
+
+            # other methods
+            klass.send(:define_method, :"formatted_#{name}") { _get_formatted_date(name) }
+            klass.send(:define_method, :"formatted_#{name}=") { |value| _set_formatted_date(name, value) }
+
+            if rule['required']
+              klass.validates_presence_of name, :"formatted_#{name}"
+            end
+          end
+
+          # Build a hash storing the formatted value for
+          # a date custom field of an instance.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the date custom field
+          #
+          # @return [ Hash ] field name => formatted date
+          #
+          def date_attribute_get(instance, name)
+            if value = instance.send(:"formatted_#{name}")
+              { name => value, "formatted_#{name}" => value }
+            else
+              {}
+            end
+          end
+
+          # Set the value for the instance and the date field specified by
+          # the 2 params.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the date custom field
+          # @param [ Hash ] attributes The attributes used to fetch the values
+          #
+          def date_attribute_set(instance, name, attributes)
+            return unless attributes.key?(name) || attributes.key?("formatted_#{name}")
+
+            value = attributes[name] || attributes["formatted_#{name}"]
+
+            instance.send(:"formatted_#{name}=", value)
+          end
+
+        end
+
+        protected
+
+        def _set_formatted_date(name, value)
+          if value.is_a?(::String) && !value.blank?
+            date = ::Date._strptime(value, self._formatted_date_format)
+
+            if date
+              value = ::Date.new(date[:year], date[:mon], date[:mday])
+            else
+              value = ::Date.parse(value) rescue nil
+            end
+          end
+
+          self.send(:"#{name}=", value)
+        end
+
+        def _get_formatted_date(name)
+          self.send(name.to_sym).strftime(self._formatted_date_format) rescue nil
+        end
+
+        def _formatted_date_format
+          I18n.t('date.formats.default')
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/custom_fields/types/date_time.rb

@@ -0,0 +1,97 @@
+module CustomFields
+
+  module Types
+
+    module DateTime
+
+      module Field; end
+
+      module Target
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Adds a date_time field
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the field and if it is required or not
+          #
+          def apply_date_time_custom_field(klass, rule)
+            name = rule['name']
+
+            klass.field name, type: ::DateTime, localize: rule['localized'] || false
+
+            # other methods
+            klass.send(:define_method, :"formatted_#{name}") { _get_formatted_date_time(name) }
+            klass.send(:define_method, :"formatted_#{name}=") { |value| _set_formatted_date_time(name, value) }
+
+            if rule['required']
+              klass.validates_presence_of name, :"formatted_#{name}"
+            end
+          end
+
+          # Build a hash storing the formatted value for
+          # a date_time custom field of an instance.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the date_time custom field
+          #
+          # @return [ Hash ] field name => formatted date_time
+          #
+          def date_time_attribute_get(instance, name)
+            if value = instance.send(:"formatted_#{name}")
+              { name => value, "formatted_#{name}" => value }
+            else
+              {}
+            end
+          end
+
+          # Set the value for the instance and the date_time field specified by
+          # the 2 params.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the date_time custom field
+          # @param [ Hash ] attributes The attributes used to fetch the values
+          #
+          def date_time_attribute_set(instance, name, attributes)
+            return unless attributes.key?(name) || attributes.key?("formatted_#{name}")
+
+            value = attributes[name] || attributes["formatted_#{name}"]
+
+            instance.send(:"formatted_#{name}=", value)
+          end
+
+        end
+
+        protected
+
+        def _set_formatted_date_time(name, value)
+          if value.is_a?(::String) && !value.blank?
+            date_time = ::DateTime._strptime(value, self._formatted_date_time_format)
+
+            if date_time
+              value = ::Time.zone.local(date_time[:year], date_time[:mon], date_time[:mday], date_time[:hour], date_time[:min], date_time[:sec] || 0)#, date_time[:zone] || "")
+            else
+              value = ::Time.zone.parse(value) rescue nil
+            end
+          end
+
+          self.send(:"#{name}=", value)
+        end
+
+        def _get_formatted_date_time(name)
+          self.send(name.to_sym).strftime(self._formatted_date_time_format) rescue nil
+        end
+
+        def _formatted_date_time_format
+          I18n.t('time.formats.default')
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/custom_fields/types/default.rb

@@ -0,0 +1,103 @@
+module CustomFields
+
+  module Types
+
+    module Default
+
+      module Field
+
+        # Build the mongodb updates based on
+        # the new state of the field
+        #
+        # @param [ Hash ] memo Store the updates
+        #
+        # @return [ Hash ] The memo object upgraded
+        #
+        def collect_default_diff(memo)
+          # puts "collect_default_diff #{self.name}: #{self.persisted?} / #{self.destroyed?}" # DEBUG
+          if self.persisted?
+            if self.destroyed?
+              memo['$unset'][self.name] = 1
+            elsif self.changed?
+              if self.changes.key?('name')
+                old_name, new_name = self.changes['name']
+                memo['$rename'][old_name] = new_name
+              end
+            end
+          end
+
+          (memo['$set']['custom_fields_recipe.rules'] ||= []) << self.to_recipe
+
+          memo
+        end
+
+      end
+
+      module Target
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Modify the target class according to the rule.
+          # By default, it declares the field and a validator
+          # if specified by the rule
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the field and if it is required or not
+          #
+          def apply_custom_field(klass, rule)
+            klass.field rule['name'], localize: rule['localized'] || false
+
+            klass.validates_presence_of rule['name'] if rule['required']
+            klass.validates_uniqueness_of rule['name'], scope: :_type if rule['unique']
+          end
+
+          # Build a hash storing the formatted (or not) values
+          # for a custom field of an instance.
+          # Since aliases are accepted, we return a hash. Beside,
+          # it is more convenient to use (ex: API).
+          # By default, it only returns hash with only one entry
+          # whose key is the second parameter and the value the
+          # value of the field in the instance given in first parameter.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the custom field
+          #
+          # @return [ Hash ] field name => formatted value or empty hash if no value
+          #
+          def default_attribute_get(instance, name)
+            unless (value = instance.send(name.to_sym)).nil?
+              { name => instance.send(name.to_sym) }
+            else
+              {}
+            end
+          end
+
+          # Set the value for the instance and the field specified by
+          # the 2 params.
+          # Since the value can come from different attributes and other
+          # params can modify the instance too, we need to pass a hash
+          # instead of a single value.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the custom field
+          # @param [ Hash ] attributes The attributes used to fetch the values
+          #
+          def default_attribute_set(instance, name, attributes)
+            # do not go further if the name is not one of the attributes keys.
+            return unless attributes.key?(name)
+
+            # simple assign
+            instance.send(:"#{name}=", attributes[name])
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/custom_fields/types/email.rb

@@ -0,0 +1,60 @@
+module CustomFields
+
+  module Types
+
+    module Email
+
+      module Field; end
+
+      module Target
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Add a string field
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the field and if it is required or not
+          #
+          def apply_email_custom_field(klass, rule)
+            name = rule['name']
+
+            klass.field name, type: ::String, localize: rule['localized'] || false
+            klass.validates_presence_of name if rule['required']
+            klass.validates_format_of name, with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/, allow_blank: !rule['required']
+            klass.validates_uniqueness_of rule['name'], scope: :_type if rule['unique']
+          end
+
+          # Build a hash storing the raw value for
+          # a string custom field of an instance.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the string custom field
+          #
+          # @return [ Hash ] field name => raw value
+          #
+          def email_attribute_get(instance, name)
+            self.default_attribute_get(instance, name)
+          end
+
+          # Set the value for the instance and the string field specified by
+          # the 2 params.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the string custom field
+          # @param [ Hash ] attributes The attributes used to fetch the values
+          #
+          def email_attribute_set(instance, name, attributes)
+            self.default_attribute_set(instance, name, attributes)
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/custom_fields/types/file.rb

@@ -0,0 +1,74 @@
+module CustomFields
+
+  module Types
+
+    module File
+
+      module Field; end
+
+      module Target
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Adds a file field (using carrierwave)
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the field and if it is required or not
+          #
+          def apply_file_custom_field(klass, rule)
+            name = rule['name']
+
+            klass.mount_uploader name, FileUploader
+
+            if rule['localized'] == true
+              klass.replace_field name, ::String, true
+            end
+
+            if rule['required']
+              klass.validates_presence_of name
+            end
+          end
+
+          # Build a hash storing the url for a file custom field of an instance.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the file custom field
+          #
+          # @return [ Hash ] field name => url or empty hash if no file
+          #
+          def file_attribute_get(instance, name)
+            if instance.send(:"#{name}?") #"
+              value = instance.send(name.to_sym).url
+              { name => value, "#{name}_url" => value }
+            else
+              {}
+            end
+          end
+
+          # Set the value for the instance and the file field specified by
+          # the 2 params.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the file custom field
+          # @param [ Hash ] attributes The attributes used to fetch the values
+          #
+          def file_attribute_set(instance, name, attributes)
+            [name, "remote_#{name}_url", "remove_#{name}"].each do |_name|
+              self.default_attribute_set(instance, _name, attributes)
+            end.compact
+          end
+
+        end
+
+      end
+
+      class FileUploader < ::CarrierWave::Uploader::Base
+      end
+
+    end
+
+  end
+
+end

data/lib/custom_fields/types/float.rb

@@ -0,0 +1,52 @@
+module CustomFields
+  module Types
+    module Float
+
+      module Field; end
+
+      module Target
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Add a string field
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the field and if it is required or not
+          #
+          def apply_float_custom_field(klass, rule)
+            klass.field rule['name'], type: ::Float, localize: rule['localized'] || false
+            klass.validates_presence_of rule['name'] if rule['required']
+            klass.validates rule['name'], numericality: true, if: ->(x){ rule['required'] }
+          end
+
+          # Build a hash storing the raw value for
+          # a string custom field of an instance.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the string custom field
+          #
+          # @return [ Hash ] field name => raw value
+          #
+          def float_attribute_get(instance, name)
+            self.default_attribute_get(instance, name)
+          end
+
+          # Set the value for the instance and the string field specified by
+          # the 2 params.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the string custom field
+          # @param [ Hash ] attributes The attributes used to fetch the values
+          #
+          def float_attribute_set(instance, name, attributes)
+            self.default_attribute_set(instance, name, attributes)
+          end
+
+        end # ClassMethods
+
+      end # Target
+
+    end # Float
+  end # Types
+end # CustomFields

data/lib/custom_fields/types/has_many.rb

@@ -0,0 +1,74 @@
+module CustomFields
+
+  module Types
+
+    module HasMany
+
+      module Field
+
+        extend ActiveSupport::Concern
+
+        included do
+
+          def has_many_to_recipe
+            { 'class_name' => self.class_name, 'inverse_of' => self.inverse_of, 'order_by' => self.order_by }
+          end
+
+          def has_many_is_relationship?
+            self.type == 'has_many'
+          end
+
+        end
+
+      end
+
+      module Target
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Adds a has_many relationship between 2 mongoid models
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the relation and if it is required or not
+          #
+          def apply_has_many_custom_field(klass, rule)
+            # puts "#{klass.inspect}.has_many #{rule['name'].inspect}, class_name: #{rule['class_name'].inspect}, inverse_of: #{rule['inverse_of']}" # DEBUG
+            position_name = "position_in_#{rule['inverse_of']}"
+
+            _order_by   = rule['order_by'] || position_name.to_sym.asc
+            _inverse_of = rule['inverse_of'].blank? ? nil : rule['inverse_of'] # an empty String can cause weird behaviours
+
+            klass.has_many rule['name'], class_name: rule['class_name'], inverse_of: _inverse_of, order: _order_by do
+
+              def filtered(conditions = {}, order_by = nil)
+                list = conditions.empty? ? self.unscoped : self.where(conditions)
+
+                if order_by
+                  list.order_by(order_by)
+                else
+                  list.order_by(metadata.order)
+                end
+              end
+
+              alias :ordered :filtered # backward compatibility + semantic purpose
+
+            end
+
+            klass.accepts_nested_attributes_for rule['name'], allow_destroy: true
+
+            if rule['required']
+              klass.validates_collection_size_of rule['name'], minimum: 1, message: :at_least_one_element, on: :update
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/custom_fields/types/integer.rb

@@ -0,0 +1,54 @@
+module CustomFields
+  module Types
+    module Integer
+
+      module Field; end
+
+      module Target
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          # Add a integer field
+          #
+          # @param [ Class ] klass The class to modify
+          # @param [ Hash ] rule It contains the name of the field and if it is required or not
+          #
+          def apply_integer_custom_field(klass, rule)
+            name = rule['name']
+
+            klass.field name, type: ::Integer, localize: rule['localized'] || false
+            klass.validates_presence_of name if rule['required']
+            klass.validates name, numericality: { only_integer: true }, if: ->(x){ rule['required'] }
+          end
+
+          # Build a hash storing the raw value for
+          # a string custom field of an instance.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the string custom field
+          #
+          # @return [ Hash ] field name => raw value
+          #
+          def integer_attribute_get(instance, name)
+            self.default_attribute_get(instance, name)
+          end
+
+          # Set the value for the instance and the string field specified by
+          # the 2 params.
+          #
+          # @param [ Object ] instance An instance of the class enhanced by the custom_fields
+          # @param [ String ] name The name of the string custom field
+          # @param [ Hash ] attributes The attributes used to fetch the values
+          #
+          def integer_attribute_set(instance, name, attributes)
+            self.default_attribute_set(instance, name, attributes)
+          end
+
+        end # ClassMethods
+
+      end # Target
+
+    end # Integer
+  end # Types
+end # CustomFields