dirty_seed 0.1.7 → 0.1.8

data/spec/lib/dirty_seed/{dirty_model_spec.rb → model_spec.rb}

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe DirtySeed::DirtyModel do
+RSpec.describe DirtySeed::Model do
   let(:data_model) { DirtySeed::DataModel }
 
   describe '#initialize(model:)' do
@@ -16,12 +16,12 @@ RSpec.describe DirtySeed::DirtyModel do
       expect { data_model.alfa.seed(3) }.to change(Alfa, :count).by(3)
     end
 
-    it 'counts the number of successfully seeded instances' do
+    it 'stores the number of successfully seeded instances' do
       data_model.alfa.seed(3)
-      expect(data_model.alfa.count).to eq 3
+      expect(data_model.alfa.instances.count).to eq 3
     end
 
-    it 'logs the errors' do
+    it 'stores the errors' do
       Alfa.create && data_model.juliett.seed(3)
       expect(data_model.juliett.errors).to match_array(
         [
@@ -33,11 +33,11 @@ RSpec.describe DirtySeed::DirtyModel do
     end
   end
 
-  describe '#dirty_associations' do
-    it 'returns dirty_associations' do
-      expect(data_model.alfa.dirty_associations).to be_empty
-      expect(data_model.delta.dirty_associations.count).to eq 2
-      expect(data_model.echo.dirty_associations.count).to eq 1
+  describe '#associations' do
+    it 'returns associations' do
+      expect(data_model.alfa.associations).to be_empty
+      expect(data_model.delta.associations.count).to eq 2
+      expect(data_model.echo.associations.count).to eq 1
     end
   end
 
@@ -49,15 +49,15 @@ RSpec.describe DirtySeed::DirtyModel do
     end
   end
 
-  describe '#dirty_attributes' do
-    it 'instantiates and returns dirty_attributes' do
+  describe '#attributes' do
+    it 'instantiates and returns attributes' do
       expectations = %i[a_boolean an_integer a_decimal a_string a_date a_time a_datetime]
-      expect(data_model.alfa.dirty_attributes.map(&:name)).to match_array(expectations)
+      expect(data_model.alfa.attributes.map(&:name)).to match_array(expectations)
     end
 
     it 'does not instantiate a dirty attribute for "protected columns"' do
       expect(
-        data_model.alfa.dirty_attributes.map(&:name) & described_class::PROTECTED_COLUMNS
+        data_model.alfa.attributes.map(&:name) & described_class::PROTECTED_COLUMNS
       ).to be_empty
     end
   end

data/spec/support/helpers.rb

@@ -8,15 +8,15 @@ def build_column(name: nil, type: :boolean)
   )
 end
 
-def build_dirty_attribute(name: nil, dirty_model: nil, type: :boolean)
-  DirtySeed::DirtyAttribute.new(
-    dirty_model || build_dirty_model,
+def build_attribute(name: nil, model: nil, type: :boolean)
+  DirtySeed::Attribute.new(
+    model || build_model,
     build_column(name: name, type: type)
   )
 end
 
-def build_dirty_model(model: Alfa)
-  DirtySeed::DirtyModel.new(model)
+def build_model(model: Alfa)
+  DirtySeed::Model.new(model)
 end
 
 private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dirty_seed
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -69,22 +69,24 @@ files:
 - README.md
 - Rakefile
 - lib/dirty_seed.rb
-- lib/dirty_seed/assigners/dirty_assigner.rb
-- lib/dirty_seed/assigners/dirty_boolean.rb
-- lib/dirty_seed/assigners/dirty_date.rb
-- lib/dirty_seed/assigners/dirty_float.rb
-- lib/dirty_seed/assigners/dirty_integer.rb
-- lib/dirty_seed/assigners/dirty_number.rb
-- lib/dirty_seed/assigners/dirty_string.rb
-- lib/dirty_seed/assigners/dirty_time.rb
+- lib/dirty_seed/assigners/assigner.rb
+- lib/dirty_seed/assigners/base.rb
+- lib/dirty_seed/assigners/boolean.rb
+- lib/dirty_seed/assigners/date.rb
 - lib/dirty_seed/assigners/fakers.yml
+- lib/dirty_seed/assigners/float.rb
+- lib/dirty_seed/assigners/integer.rb
+- lib/dirty_seed/assigners/min_max_helper.rb
+- lib/dirty_seed/assigners/number.rb
+- lib/dirty_seed/assigners/string.rb
+- lib/dirty_seed/assigners/time.rb
+- lib/dirty_seed/association.rb
+- lib/dirty_seed/attribute.rb
 - lib/dirty_seed/data_model.rb
-- lib/dirty_seed/dirty_association.rb
-- lib/dirty_seed/dirty_attribute.rb
-- lib/dirty_seed/dirty_model.rb
 - lib/dirty_seed/engine.rb
 - lib/dirty_seed/exceptions.rb
 - lib/dirty_seed/method_missing_helper.rb
+- lib/dirty_seed/model.rb
 - lib/dirty_seed/sorter.rb
 - lib/dirty_seed/version.rb
 - lib/tasks/dirty_seed_tasks.rake
@@ -159,17 +161,18 @@ files:
 - spec/dummy/public/apple-touch-icon.png
 - spec/dummy/public/favicon.ico
 - spec/dummy/tmp/development_secret.txt
-- spec/lib/dirty_seed/assigners/dirty_assigner_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_boolean_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_date_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_float_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_integer_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_string_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_time_spec.rb
+- spec/lib/dirty_seed/assigners/assigner_spec.rb
+- spec/lib/dirty_seed/assigners/base_spec.rb
+- spec/lib/dirty_seed/assigners/boolean_spec.rb
+- spec/lib/dirty_seed/assigners/date_spec.rb
+- spec/lib/dirty_seed/assigners/float_spec.rb
+- spec/lib/dirty_seed/assigners/integer_spec.rb
+- spec/lib/dirty_seed/assigners/string_spec.rb
+- spec/lib/dirty_seed/assigners/time_spec.rb
+- spec/lib/dirty_seed/association_spec.rb
+- spec/lib/dirty_seed/attribute_spec.rb
 - spec/lib/dirty_seed/data_model_spec.rb
-- spec/lib/dirty_seed/dirty_association_spec.rb
-- spec/lib/dirty_seed/dirty_attribute_spec.rb
-- spec/lib/dirty_seed/dirty_model_spec.rb
+- spec/lib/dirty_seed/model_spec.rb
 - spec/lib/dirty_seed/sorter_spec.rb
 - spec/lib/tasks/dirty_seed_tasks_spec.rb
 - spec/rails_helper.rb
@@ -198,18 +201,19 @@ signing_key:
 specification_version: 4
 summary: Summary of DirtySeed.
 test_files:
-- spec/lib/dirty_seed/assigners/dirty_assigner_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_time_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_string_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_float_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_date_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_boolean_spec.rb
-- spec/lib/dirty_seed/assigners/dirty_integer_spec.rb
+- spec/lib/dirty_seed/assigners/boolean_spec.rb
+- spec/lib/dirty_seed/assigners/string_spec.rb
+- spec/lib/dirty_seed/assigners/date_spec.rb
+- spec/lib/dirty_seed/assigners/base_spec.rb
+- spec/lib/dirty_seed/assigners/integer_spec.rb
+- spec/lib/dirty_seed/assigners/time_spec.rb
+- spec/lib/dirty_seed/assigners/assigner_spec.rb
+- spec/lib/dirty_seed/assigners/float_spec.rb
 - spec/lib/dirty_seed/data_model_spec.rb
-- spec/lib/dirty_seed/dirty_model_spec.rb
-- spec/lib/dirty_seed/dirty_association_spec.rb
-- spec/lib/dirty_seed/dirty_attribute_spec.rb
+- spec/lib/dirty_seed/association_spec.rb
 - spec/lib/dirty_seed/sorter_spec.rb
+- spec/lib/dirty_seed/model_spec.rb
+- spec/lib/dirty_seed/attribute_spec.rb
 - spec/lib/tasks/dirty_seed_tasks_spec.rb
 - spec/dummy/config.ru
 - spec/dummy/public/apple-touch-icon.png

data/lib/dirty_seed/assigners/dirty_assigner.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-require 'faker'
-require 'regexp-examples'
-
-module DirtySeed
-  module Assigners
-    # Draws a value matching validators
-    class DirtyAssigner
-      attr_reader :dirty_attribute
-
-      # Initializes an instance
-      # @param attribute [DirtySeed::DirtyAttribute]
-      # @return [DirtySeed::Assigners::DirtyAssigner]
-      def initialize(dirty_attribute)
-        @dirty_attribute = dirty_attribute
-      end
-
-      # Returns a random value depending on the attribute type
-      # @return [void]
-      # @note This method should be overrided
-      def value
-        return if absent?
-        return inclusion_options.sample if inclusion_options
-
-        define_value
-      end
-
-      private
-
-      # Returns an validators related to the current attribute
-      # @return [Array<ActiveModel::Validations::EachValidators>]
-      def validators
-        @validators ||= dirty_attribute.validators
-      end
-
-      # Returns nil, should be overrided by inherited classes
-      # @return [nil]
-      def define_value; end
-
-      # Returns true if value should be absent
-      # Returns [Boolean]
-      def absent?
-        validators.any? do |validator|
-          validator.is_a? ActiveRecord::Validations::AbsenceValidator
-        end
-      end
-
-      # Returns the inclusion options if value should be included in options
-      # e.g. `validates :status, inclusion: { in: %w[todo done aborted] }`
-      # @return [Array<>]
-      def inclusion_options
-        inclusion_validator =
-          validators.find do |validator|
-            validator.is_a? ActiveModel::Validations::InclusionValidator
-          end
-        inclusion_validator&.options&.dig(:in)
-      end
-
-      # Returns true if the value should be unique
-      # @return [Boolean]
-      def unique?
-        @unique ||=
-          validators.any? do |validator|
-            validator.is_a? ActiveRecord::Validations::UniquenessValidator
-          end
-      end
-
-      # Returns a value matching the requirements
-      # @param category [Symbol] fake category
-      # @param method [Symbol] fake method
-      # @param options [Hash] options used by faker
-      # @return [Object]
-      def faker_value(category:, method:, options: nil)
-        if options
-          faker_process(category).public_send(method, options)
-        else
-          faker_process(category).public_send(method)
-        end
-      rescue Faker::UniqueGenerator::RetryLimitExceeded
-        nil
-      end
-
-      # Returns a faker process
-      # @param category [Symbol] fake category
-      # @return [Faker::?]
-      def faker_process(category)
-        return @faker_method if @faker_method
-
-        action = "::Faker::#{category}".constantize
-        @faker_method = unique? ? action.unique : action
-      end
-    end
-  end
-end

data/lib/dirty_seed/assigners/dirty_float.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module DirtySeed
-  module Assigners
-    # Draws an Float matching validators
-    class DirtyFloat < DirtyNumber
-      # Returns a value matching all validators
-      # @return [Float]
-      def define_value
-        super
-        faker_value(
-          category: :Number,
-          method: :between,
-          options: { from: min, to: max - 1 }
-        ) + decimals
-      end
-
-      private
-
-      # Returns a value between 0 and 1
-      # @return [Float]
-      def decimals
-        rand(0..Float(1))
-      end
-
-      # Defines the gap to add to min when "greater_than" or to substract to max when "less_than"
-      #   For example if value should be greater_than 0, then the min is 0.01
-      #   and if the value should be lesser_than 1, then the max is 0.99
-      # @return [Float]
-      def gap
-        0.01
-      end
-    end
-  end
-end

data/lib/dirty_seed/assigners/dirty_integer.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module DirtySeed
-  module Assigners
-    # Draws an integer matching validators
-    class DirtyInteger < DirtyNumber
-      # Defines the gap to add to min when "greater_than" or to substract to max when "less_than"
-      #   For example if value should be greater_than 0, then the min is 1
-      #   and if the value should be lesser_than 1_000, then the max is 999
-      # @return [Integer]
-      def gap
-        1
-      end
-    end
-  end
-end

data/lib/dirty_seed/assigners/dirty_string.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module DirtySeed
-  module Assigners
-    # Draws a String matching validators
-    class DirtyString < DirtyAssigner
-      # Returns a value matching all validators
-      # @return [String]
-      # @note First try to guess attribute meaning by its name and use Faker to return a coherent value
-      #   Then eventually return a value matching the regex validation
-      def define_value
-        specific_value || regex_value || default
-      end
-
-      private
-
-      # Returns a specific value if the attribute name is specific
-      # @note Verify that, if there is a regex validation, the value matches it
-      # @return [String]
-      def specific_value
-        return unless specific
-
-        try = faker_value(specific)
-        try if !regex || regex.match?(try)
-      end
-
-      # Returns a value matching the pattern
-      # @note Rescue from unreadable regex
-      # @return [String]
-      def regex_value
-        return unless regex
-
-        regex.random_example
-      rescue RegexpExamples::IllegalSyntaxError
-        nil
-      end
-
-      # Returns the specific options if the attribute name is specific
-      # @return [Hash, nil]
-      def specific
-        @specific ||= specific_attributes[dirty_attribute.name]
-      end
-
-      # Returns specific attributes
-      # @return [Hash]
-      # @example
-      #   { address: { category: 'Address', method: 'full_address' } }
-      def specific_attributes
-        YAML.safe_load(
-          File.read(
-            DirtySeed::Engine.root.join('lib', 'dirty_seed', 'assigners', 'fakers.yml')
-          )
-        ).deep_symbolize_keys
-      end
-
-      # Returns a standard string
-      # @return [String]
-      def default
-        ::Faker::Lorem.unique.sentence(word_count: 3, supplemental: false, random_words_to_add: 4)
-      end
-
-      # Returns the regex pattern if value should respect a format
-      # e.g. `validates :email, format: { with: /\w{10}@(hotmail|gmail)\.com/ }`
-      # @return [Array<>]
-      def regex
-        regex_validator =
-          validators.find do |validator|
-            validator.is_a? ActiveModel::Validations::FormatValidator
-          end
-        regex_validator&.options&.dig(:with)
-      end
-    end
-  end
-end

data/lib/dirty_seed/dirty_attribute.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module DirtySeed
-  # Represents an Active Record attribute
-  class DirtyAttribute
-    extend ::DirtySeed::MethodMissingHelper
-    forward_missing_methods_to :column
-
-    attr_reader :dirty_model, :column
-
-    TYPE_SYMMETRIES = {
-      binary: :integer,
-      datetime: :time,
-      decimal: :float,
-      text: :string
-    }.freeze
-    private_constant :TYPE_SYMMETRIES
-
-    # Initializes an instance
-    # @param dirty_model [DirtySeed::DirtyModel]
-    # @param column [ActiveRecord::ConnectionAdapters::Column]
-    # @return [DirtySeed::DirtyAttribute]
-    def initialize(dirty_model, column)
-      @dirty_model = dirty_model
-      @column = column
-    end
-
-    # Assigns a value to the attribute
-    # @param instance [Object] an instance of a class inheriting from ApplicationRecord
-    # @param sequence [Integer]
-    # @return [void]
-    def assign_value(instance)
-      instance.assign_attributes(name => value)
-    rescue ArgumentError => e
-      dirty_model.errors << e
-    end
-
-    # Returns a value matching type and validators
-    # @return [Object, nil]
-    def value
-      assigner&.value
-    end
-
-    # Returns the attribute assigner
-    # @return [DirtySeed::DirtyAssigner]
-    def assigner
-      @assigner ||=
-        "DirtySeed::Assigners::Dirty#{type.capitalize}".constantize.new(self)
-    # If attribute type is not currently handled (json, array...) return nil
-    rescue NameError
-      nil
-    end
-
-    # Returns attribute name
-    # @return [Symbol]
-    def name
-      column.name.to_sym
-    end
-
-    # Returns attribute type
-    # @return [Symbol]
-    def type
-      sql_type = column.sql_type_metadata.type
-      TYPE_SYMMETRIES[sql_type] || sql_type
-    end
-
-    # Returns an validators related to the current attribute
-    # @return [Array<ActiveModel::Validations::EachValidators>]
-    def validators
-      dirty_model.validators.select do |validator|
-        validator.attributes.include? name
-      end
-    end
-  end
-end