active_fields 0.1.0 → 1.0.0

data/lib/active_fields/casters/enum_caster.rb

@@ -1,9 +1,21 @@
 # frozen_string_literal: true
 
-require_relative "text_caster"
-
 module ActiveFields
   module Casters
-    class EnumCaster < TextCaster; end
+    class EnumCaster < BaseCaster
+      def serialize(value)
+        cast(value)
+      end
+
+      def deserialize(value)
+        cast(value)
+      end
+
+      private
+
+      def cast(value)
+        value&.to_s.presence
+      end
+    end
   end
 end

data/lib/active_fields/casters/integer_array_caster.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "integer_caster"
-
 module ActiveFields
   module Casters
     class IntegerArrayCaster < IntegerCaster

data/lib/active_fields/casters/integer_caster.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "base_caster"
-
 module ActiveFields
   module Casters
-    class IntegerCaster < DecimalCaster
+    class IntegerCaster < BaseCaster
       def serialize(value)
         cast(value)
       end
@@ -16,7 +14,7 @@ module ActiveFields
       private
 
       def cast(value)
-        super(value)&.to_i
+        BigDecimal(value, 0, exception: false)&.to_i
       end
     end
   end

data/lib/active_fields/casters/text_array_caster.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "text_caster"
-
 module ActiveFields
   module Casters
     class TextArrayCaster < TextCaster

data/lib/active_fields/casters/text_caster.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_caster"
-
 module ActiveFields
   module Casters
     class TextCaster < BaseCaster

data/lib/active_fields/config.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  class Config
+    DEFAULT_FIELD_BASE_CLASS_NAME = "ActiveFields::Field::Base"
+    DEFAULT_VALUE_CLASS_NAME = "ActiveFields::Value"
+
+    include Singleton
+
+    attr_accessor :field_base_class_name, :value_class_name
+    attr_reader :fields
+
+    def initialize
+      @field_base_class_name = DEFAULT_FIELD_BASE_CLASS_NAME
+      @value_class_name = DEFAULT_VALUE_CLASS_NAME
+      @fields = {
+        boolean: "ActiveFields::Field::Boolean",
+        date: "ActiveFields::Field::Date",
+        date_array: "ActiveFields::Field::DateArray",
+        datetime: "ActiveFields::Field::DateTime",
+        datetime_array: "ActiveFields::Field::DateTimeArray",
+        decimal: "ActiveFields::Field::Decimal",
+        decimal_array: "ActiveFields::Field::DecimalArray",
+        enum: "ActiveFields::Field::Enum",
+        enum_array: "ActiveFields::Field::EnumArray",
+        integer: "ActiveFields::Field::Integer",
+        integer_array: "ActiveFields::Field::IntegerArray",
+        text: "ActiveFields::Field::Text",
+        text_array: "ActiveFields::Field::TextArray",
+      }
+    end
+
+    def field_base_class
+      @field_base_class ||= field_base_class_name.constantize
+    end
+
+    def value_class
+      @value_class ||= value_class_name.constantize
+    end
+
+    def field_base_class_changed?
+      field_base_class_name != DEFAULT_FIELD_BASE_CLASS_NAME
+    end
+
+    def value_class_changed?
+      value_class_name != DEFAULT_VALUE_CLASS_NAME
+    end
+
+    def register_field(type_name, class_name)
+      @fields[type_name.to_sym] = class_name
+    end
+
+    def type_names
+      fields.keys
+    end
+
+    def type_class_names
+      fields.values
+    end
+  end
+end

data/lib/active_fields/customizable_config.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  class CustomizableConfig
+    attr_reader :customizable_model, :types
+
+    def initialize(customizable_model)
+      @customizable_model = customizable_model
+    end
+
+    def types=(value)
+      invalid_types = value - ActiveFields.config.type_names
+      if invalid_types.any?
+        raise ArgumentError, "undefined ActiveFields types provided for #{customizable_model}: #{invalid_types}"
+      end
+
+      @types = value
+    end
+
+    def types_class_names
+      ActiveFields.config.fields.values_at(*types)
+    end
+  end
+end

data/lib/active_fields/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveFields
+
+    initializer "active_fields.active_record" do
+      ActiveSupport.on_load(:active_record) do
+        include HasActiveFields
+      end
+    end
+  end
+end

data/lib/active_fields/has_active_fields.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  # Mix-in that allows ActiveRecord models to enable active fields
+  module HasActiveFields
+    extend ActiveSupport::Concern
+
+    class_methods do
+      attr_reader :active_fields_config
+
+      def has_active_fields(types: ActiveFields.config.type_names)
+        include CustomizableConcern
+
+        @active_fields_config = CustomizableConfig.new(self)
+        @active_fields_config.types = types
+      end
+    end
+  end
+end

data/lib/active_fields/validators/base_validator.rb

@@ -4,24 +4,28 @@ module ActiveFields
   module Validators
     # Validates the active_value value
     class BaseValidator
-      attr_reader :active_field, :errors
+      attr_reader :options, :errors
 
-      def initialize(active_field)
-        @active_field = active_field
+      def initialize(**options)
+        @options = options
         @errors = Set.new
       end
 
+      # Performs the validation and adds errors to the `errors` list.
+      # Returns `true` if no errors are found, `false` otherwise.
       def validate(value)
         perform_validation(value)
         valid?
       end
 
+      # Returns `true` if no errors are found, `false` otherwise.
       def valid?
         errors.empty?
       end
 
       private
 
+      # Performs the validation. If there are any errors, it should save them in `errors`.
       def perform_validation(value)
         raise NotImplementedError
       end

data/lib/active_fields/validators/boolean_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class BooleanValidator < BaseValidator
@@ -9,9 +7,9 @@ module ActiveFields
 
       def perform_validation(value)
         if value.nil?
-          errors << :exclusion unless active_field.nullable?
+          errors << :exclusion unless options[:nullable]
         elsif value.is_a?(FalseClass)
-          errors << :required if active_field.required?
+          errors << :required if options[:required]
         elsif value.is_a?(TrueClass)
           nil
         else

data/lib/active_fields/validators/date_array_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class DateArrayValidator < BaseValidator
@@ -13,11 +11,11 @@ module ActiveFields
           return
         end
 
-        validate_size(value, min: active_field.min_size, max: active_field.max_size)
+        validate_size(value, min: options[:min_size], max: options[:max_size])
 
         value.each do |elem_value|
-          if elem_value.is_a?(Date)
-            validate_minmax(elem_value, min: active_field.min, max: active_field.max)
+          if elem_value.acts_like?(:date)
+            validate_minmax(elem_value, min: options[:min], max: options[:max])
           else
             errors << :invalid
           end

data/lib/active_fields/validators/date_time_array_validator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  module Validators
+    class DateTimeArrayValidator < BaseValidator
+      private
+
+      def perform_validation(value)
+        unless value.is_a?(Array)
+          errors << :invalid
+          return
+        end
+
+        validate_size(value, min: options[:min_size], max: options[:max_size])
+
+        value.each do |elem_value|
+          if elem_value.acts_like?(:time)
+            validate_minmax(elem_value, min: options[:min], max: options[:max])
+          else
+            errors << :invalid
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_fields/validators/date_time_validator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  module Validators
+    class DateTimeValidator < BaseValidator
+      private
+
+      def perform_validation(value)
+        if value.nil?
+          errors << :required if options[:required]
+        elsif value.acts_like?(:time)
+          validate_minmax(value, min: options[:min], max: options[:max])
+        else
+          errors << :invalid
+        end
+      end
+    end
+  end
+end

data/lib/active_fields/validators/date_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class DateValidator < BaseValidator
@@ -9,9 +7,9 @@ module ActiveFields
 
       def perform_validation(value)
         if value.nil?
-          errors << :required if active_field.required?
-        elsif value.is_a?(Date)
-          validate_minmax(value, min: active_field.min, max: active_field.max)
+          errors << :required if options[:required]
+        elsif value.acts_like?(:date)
+          validate_minmax(value, min: options[:min], max: options[:max])
         else
           errors << :invalid
         end

data/lib/active_fields/validators/decimal_array_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class DecimalArrayValidator < BaseValidator
@@ -13,11 +11,11 @@ module ActiveFields
           return
         end
 
-        validate_size(value, min: active_field.min_size, max: active_field.max_size)
+        validate_size(value, min: options[:min_size], max: options[:max_size])
 
         value.each do |elem_value|
           if elem_value.is_a?(Numeric)
-            validate_minmax(elem_value, min: active_field.min, max: active_field.max)
+            validate_minmax(elem_value, min: options[:min], max: options[:max])
           else
             errors << :invalid
           end

data/lib/active_fields/validators/decimal_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class DecimalValidator < BaseValidator
@@ -9,9 +7,9 @@ module ActiveFields
 
       def perform_validation(value)
         if value.nil?
-          errors << :required if active_field.required?
+          errors << :required if options[:required]
         elsif value.is_a?(Numeric)
-          validate_minmax(value, min: active_field.min, max: active_field.max)
+          validate_minmax(value, min: options[:min], max: options[:max])
         else
           errors << :invalid
         end

data/lib/active_fields/validators/enum_array_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class EnumArrayValidator < BaseValidator
@@ -13,11 +11,11 @@ module ActiveFields
           return
         end
 
-        validate_size(value, min: active_field.min_size, max: active_field.max_size)
+        validate_size(value, min: options[:min_size], max: options[:max_size])
 
-        if active_field.allowed_values.is_a?(Array)
+        if options[:allowed_values].is_a?(Array)
           value.each do |elem_value|
-            validate_value_allowed(elem_value, allowed_values: active_field.allowed_values)
+            validate_value_allowed(elem_value, allowed_values: options[:allowed_values])
           end
         end
 

data/lib/active_fields/validators/enum_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class EnumValidator < BaseValidator
@@ -9,9 +7,9 @@ module ActiveFields
 
       def perform_validation(value)
         if value.nil?
-          errors << :required if active_field.required?
-        elsif active_field.allowed_values.is_a?(Array)
-          validate_value_allowed(value, allowed_values: active_field.allowed_values)
+          errors << :required if options[:required]
+        elsif options[:allowed_values].is_a?(Array)
+          validate_value_allowed(value, allowed_values: options[:allowed_values])
         end
       end
 

data/lib/active_fields/validators/integer_array_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class IntegerArrayValidator < BaseValidator
@@ -13,11 +11,11 @@ module ActiveFields
           return
         end
 
-        validate_size(value, min: active_field.min_size, max: active_field.max_size)
+        validate_size(value, min: options[:min_size], max: options[:max_size])
 
         value.each do |elem_value|
           if elem_value.is_a?(Numeric)
-            validate_minmax(elem_value, min: active_field.min, max: active_field.max)
+            validate_minmax(elem_value, min: options[:min], max: options[:max])
           else
             errors << :invalid
           end

data/lib/active_fields/validators/integer_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class IntegerValidator < BaseValidator
@@ -9,9 +7,9 @@ module ActiveFields
 
       def perform_validation(value)
         if value.nil?
-          errors << :required if active_field.required?
+          errors << :required if options[:required]
         elsif value.is_a?(Numeric)
-          validate_minmax(value, min: active_field.min, max: active_field.max)
+          validate_minmax(value, min: options[:min], max: options[:max])
         else
           errors << :invalid
         end

data/lib/active_fields/validators/text_array_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class TextArrayValidator < BaseValidator
@@ -13,11 +11,11 @@ module ActiveFields
           return
         end
 
-        validate_size(value, min: active_field.min_size, max: active_field.max_size)
+        validate_size(value, min: options[:min_size], max: options[:max_size])
 
         value.each do |elem_value|
           if elem_value.is_a?(String)
-            validate_length(elem_value, min: active_field.min_length, max: active_field.max_length)
+            validate_length(elem_value, min: options[:min_length], max: options[:max_length])
           else
             errors << :invalid
           end

data/lib/active_fields/validators/text_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_validator"
-
 module ActiveFields
   module Validators
     class TextValidator < BaseValidator
@@ -9,9 +7,9 @@ module ActiveFields
 
       def perform_validation(value)
         if value.nil?
-          errors << :required if active_field.required?
+          errors << :required if options[:required]
         elsif value.is_a?(String)
-          validate_length(value, min: active_field.min_length, max: active_field.max_length)
+          validate_length(value, min: options[:min_length], max: options[:max_length])
         else
           errors << :invalid
         end

data/lib/active_fields/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveFields
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/active_fields.rb

@@ -1,13 +1,53 @@
 # frozen_string_literal: true
 
-require "active_support"
-require "active_record"
-
 require_relative "active_fields/version"
-Dir["#{__dir__}/active_fields/casters/**/*.rb"].each { |f| require_relative f }
-Dir["#{__dir__}/active_fields/validators/**/*.rb"].each { |f| require_relative f }
-Dir["#{__dir__}/active_fields/models/**/*.rb"].each { |f| require_relative f }
+require_relative "active_fields/engine"
 
 module ActiveFields
-  class Error < StandardError; end
+  autoload :Config, "active_fields/config"
+  autoload :CustomizableConfig, "active_fields/customizable_config"
+  autoload :HasActiveFields, "active_fields/has_active_fields"
+
+  module Casters
+    autoload :BaseCaster, "active_fields/casters/base_caster"
+    autoload :BooleanCaster, "active_fields/casters/boolean_caster"
+    autoload :DateCaster, "active_fields/casters/date_caster"
+    autoload :DateArrayCaster, "active_fields/casters/date_array_caster"
+    autoload :DateTimeCaster, "active_fields/casters/date_time_caster"
+    autoload :DateTimeArrayCaster, "active_fields/casters/date_time_array_caster"
+    autoload :DecimalCaster, "active_fields/casters/decimal_caster"
+    autoload :DecimalArrayCaster, "active_fields/casters/decimal_array_caster"
+    autoload :EnumCaster, "active_fields/casters/enum_caster"
+    autoload :EnumArrayCaster, "active_fields/casters/enum_array_caster"
+    autoload :IntegerCaster, "active_fields/casters/integer_caster"
+    autoload :IntegerArrayCaster, "active_fields/casters/integer_array_caster"
+    autoload :TextCaster, "active_fields/casters/text_caster"
+    autoload :TextArrayCaster, "active_fields/casters/text_array_caster"
+  end
+
+  module Validators
+    autoload :BaseValidator, "active_fields/validators/base_validator"
+    autoload :BooleanValidator, "active_fields/validators/boolean_validator"
+    autoload :DateValidator, "active_fields/validators/date_validator"
+    autoload :DateArrayValidator, "active_fields/validators/date_array_validator"
+    autoload :DateTimeValidator, "active_fields/validators/date_time_validator"
+    autoload :DateTimeArrayValidator, "active_fields/validators/date_time_array_validator"
+    autoload :DecimalValidator, "active_fields/validators/decimal_validator"
+    autoload :DecimalArrayValidator, "active_fields/validators/decimal_array_validator"
+    autoload :EnumValidator, "active_fields/validators/enum_validator"
+    autoload :EnumArrayValidator, "active_fields/validators/enum_array_validator"
+    autoload :IntegerValidator, "active_fields/validators/integer_validator"
+    autoload :IntegerArrayValidator, "active_fields/validators/integer_array_validator"
+    autoload :TextValidator, "active_fields/validators/text_validator"
+    autoload :TextArrayValidator, "active_fields/validators/text_array_validator"
+  end
+
+  class << self
+    def config
+      yield Config.instance if block_given?
+      Config.instance
+    end
+
+    alias_method :configure, :config
+  end
 end

data/lib/generators/active_fields/install/USAGE

@@ -1,5 +1,5 @@
 Description:
-    Generates a migration to create ActiveFields tables.
+    Generates an initializer and copies plugin migrations.
 
 Examples:
     `bin/rails generate active_fields:install`

data/lib/generators/active_fields/install/install_generator.rb

@@ -5,28 +5,24 @@ require "rails/generators"
 module ActiveFields
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      include ::Rails::Generators::Migration
+      desc "This generator creates an create_initializer and copies plugin migrations"
 
-      source_root File.expand_path("templates", __dir__)
+      def create_initializer
+        initializer "active_fields.rb", <<~RUBY
+          ActiveFields.configure do |config|
+            # Change fields base class:
+            # config.field_base_class_name = "CustomField"
+            # Change value class:
+            # config.value_class_name = "CustomValue"
 
-      desc "This generator creates a migration to create ActiveFields tables"
-
-      def copy_migration
-        migration_template(
-          "create_active_fields_tables.rb.tt",
-          "db/migrate/create_active_fields_tables.rb",
-          { migration_version: migration_version },
-        )
+            # Register custom field type:
+            # config.register_field :ip, "IpField"
+          end
+        RUBY
       end
 
-      private
-
-      def migration_version
-        format(
-          "[%d.%d]",
-          ActiveRecord::VERSION::MAJOR,
-          ActiveRecord::VERSION::MINOR,
-        )
+      def install_migrations
+        rails_command "active_fields:install:migrations"
       end
     end
   end

data/lib/tasks/active_fields_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :active_fields do
+#   # Task goes here
+# end