fixturizer 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b32aa16a54c913b66e8d68df00c968faea177694473669e1041e5f120158641
-  data.tar.gz: 7896981fd9376c0929896894f306bd47653058aecaffb9f293df3143f9ebe3e0
+  metadata.gz: 9cc92b66c50911ec30ffd277772939fb652d9b88e3dc33fa2b1cdbccb01aa776
+  data.tar.gz: 7cce30b3455b91e6e32fbdede70a1637e8b063f7b1bf3e02cce8e4e39d0bdbcd
 SHA512:
-  metadata.gz: 11f9ea54665b8be2fe7c2db16b0805d683d348f144d6cd7367dbecf04b562c78a6429b394c2511913882b6a926f267829f2efda6442364548fb38d629415b76f
-  data.tar.gz: 1a4714aa619eeef6ff7142a848b5d8d04d452a577353827d34ea463d0bebc4e77592256ce631139bdd2b9ab086eecc00ab388269ffefb7585c01fa2c0b12373e
+  metadata.gz: 3e213a056cc0d54acc95ef428a47125cc1a48a733e6065fc30a0bcee7b50c88c873b4eac799b3d9e4e4813439ba5cdc0f67c4396f33f46ac68e926451aa9ee13
+  data.tar.gz: 4ed4d832360555326fc93d16ef9c8413f506c250e39dfa7e56adf7cb65de20f1405812c6b3683ee00e5d4e2d937d1163c5de0cae13f276a60dd316d3e3eb454c

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.3

data/fixturizer.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'mongoid', '~> 9.0'
   spec.add_dependency 'rake', '~> 13.0'
-  spec.add_dependency 'rspec', '~> 3.10.0'
+  spec.add_dependency 'rspec', '~> 3.13.0'
   spec.add_dependency 'version', '~> 1.1'
 
   spec.add_development_dependency 'bundle-audit', '~> 0.1.0'

data/lib/fixturizer/adapters/mongoid.rb

@@ -3,30 +3,28 @@
 module Fixturizer
   module Adapters
     module Mongoid
-      def injector(model_infos:, item:)
-        model = Object.const_get(model_infos[:class])
-        model.create!(item) unless model.where(model_infos[:unicity] => item[model_infos[:unicity]]).exists?
-      end
-
-      def binder(item:)
-        result = {}
-        item.each do |element|
-          model_class = @models[element[:collection]][:class]
-          model = Object.const_get(model_class)
-          if element[:index].include?(:at)
-            result[element[:fkey]] = model.all[element[:index][:at] - 1][element[:pkey]].to_s
-          elsif element[:index].include?(:search_key)
-            raise 'Links configuration failure' unless element[:index].include?(:for)
+      def inject_data
+        list = (@orders.is_a? Array)? @order : @generated.keys
+        list.each do |name|
+          records = @generated[name]
+          records.each do |record|
+            belong = record.dig(:belong,:to)
+            by = record.dig(:belong,:by)
+            pattern = record.dig(:belong,:search_by)
+            if link.is_a? Symbol then
+              model = Object.const_get(@models[belong][:class]).find_by(**pattern).send by
+              model.create!(record[:data]) unless model.where(@models[belong][:unicity] => record[:data][@models[belong][:unicity]]).exists?
+            else
+              model = Object.const_get(@models[name][:class])
+              model.create!(record[:data]) unless model.where(@models[name][:unicity] => record[:data][@models[name][:unicity]]).exists?
+            end
 
-            result[element[:fkey]] =
-              model.where({ element[:index][:search_key] => element[:index][:for] }).first[element[:pkey]]
-          else
-            raise 'Links configuration failure'
           end
+          
         end
-        result
       end
 
+
       def drop_database
         ::Mongoid.purge!
         true

data/lib/fixturizer/configuration.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require 'yaml'
+
 module Fixturizer
   class Configuration
-    attr_reader :rules, :models, :datasets, :models_order, :models_type
+    attr_reader :rules, :models, :datasets, :models_order, :models_type, :filename
 
     def initialize(filename:)
+      @filename = filename
       @content = read_file(filename:)
       @rules = @content[:fixtures][:rules]
       @models_type = @content[:fixtures].dig(:models, :type)
@@ -19,4 +22,215 @@ module Fixturizer
       YAML.load(File.readlines(filename).join)
     end
   end
+
+  class ConfigurationLinter
+    attr_reader :content
+    
+    KEYS_BY_LEVEL = {:fixtures => [:rules,:models,:datasets],
+                     :dataset => [:definition, :rules],
+                     :models => [:type, :order, :definitions],
+                     :model_definition => [:rules,:class,:unicity, :collection],
+                     :collection => [:attributes,:belong]
+
+    }
+  
+
+    def initialize(filename:)
+      @status = {status: :ok, warn: [], error: [], cleaned: []}
+      @filename = filename
+    end
+    
+    
+    def display
+      puts "Running linter for Configuration file : #{@filename} :"
+      validate
+      puts " => Status : #{@status[:status].to_s.upcase} "
+      unless @status[:error].empty? then 
+        puts "Errors : "
+        @status[:error].each do |error|
+          puts " * #{error}"
+        end
+      end
+      unless @status[:warn].empty? then 
+        puts "Warnings : "
+        @status[:warn].each do |warning|
+          puts " * #{warning}"
+        end
+      end
+    end
+    
+
+    def validate!
+      validate
+      unless @status[:status] == :ok
+        puts "Configuration error, run rake fixturizer:configuration:lint to show"  
+        exit 10
+      end
+    end
+
+
+    private
+
+    def validate
+      begin
+        @content = read_file filename: @filename
+        [:validate_root,:validate_section, :validate_rules,:validate_datasets,:validate_models].each do |method|
+          self.send method if @status[:status] = :ok
+        end
+      rescue RuntimeError => e
+        @status[:status] = :ko
+        @status[:error].push "Malformed YAML file #{e.message}"
+      rescue  Errno::ENOENT
+        @status[:status] = :ko
+        @status[:error].push "Missing YAML file"
+      rescue  NoMethodError => e
+        @status[:status] = :ko
+        @status[:error].push "Malformed YAML file #{e.message}"
+      end
+      return @status
+    end
+
+    def read_file(filename:)
+      YAML.load(File.readlines(filename).join)
+    end
+
+    def validate_root
+      if @content.dig(:fixtures).nil? 
+        @status[:error].push "General root error : key is not Symbol :fixtures or empty" 
+        @status[:status] = :ko
+      end
+    end
+
+    def validate_section
+      full_nil = []
+      [:datasets,:rules,:models].each do |root|
+        unless @content.dig(:fixtures, root).is_a? Hash or @content.dig(:fixtures,root).nil?
+          @status[:error].push "//:fixtures/#{root} is not a Hash" 
+          @status[:status] = :ko
+        end
+        full_nil.push root if @content.dig(:fixtures,root).nil?
+      end
+      if full_nil.size == 3 
+        @status[:error].push "All sections are empty  : #{full_nil}" 
+          @status[:status] = :ko
+      end
+    end
+
+    def validate_rules
+      return if @content.dig(:fixtures,:rules).nil?
+      count = @status[:error].size
+      @content.dig(:fixtures,:rules).each do |name, rule|
+        @status[:error].push "//:fixtures/:rules/:#{name} is not a Symbol" unless name.is_a? Symbol
+        @status[:error].push "//:fixtures/:rules/:#{name} record is not a Hash" unless rule.is_a? Hash 
+        @status[:error].push "//:fixtures/:rules/:#{name} not have key :proc defined" unless rule.include? :proc
+        @status[:error].push "//:fixtures/:rules/:#{name}/:proc is not a String" unless rule[:proc].is_a? String
+        if rule.include? :preserve then
+          @status[:error].push "//:fixtures/:rules/:#{name} have key :preserve but it's not a Boolean" unless [true, false].include? rule[:preserve]
+        end
+      end
+      @status[:status] = (@status[:error].size > count)? :ko : @status[:status]
+    end
+
+
+    def validate_datasets
+      return if @content.dig(:fixtures,:datasets).nil?
+      count = @status[:error].size
+      @content.dig(:fixtures,:datasets).each do |name, dataset|
+        @status[:error].push "//:fixtures/:datasets/:#{name} is not a Symbol" unless name.is_a? Symbol
+        @status[:error].push "//:fixtures/:datasets/:#{name} record is not a Hash" unless dataset.is_a? Hash
+        @status[:error].push "//:fixtures/:datasets/:#{name} not have key :definition defined" unless dataset.include? :definition
+        @status[:error].push "//:fixtures/:datasets/:#{name}/:definition is nil" if dataset[:definition].nil?   
+        if dataset.include? :rules then
+          @status[:error].push "//:fixtures/:datasets/:#{name} have key :rules but it's not a Hash" unless dataset[:rules].is_a? Hash
+          dataset[:rules].each do |key,value|
+            @status[:error].push "//:fixtures/:datasets/:#{name}/:rules/#{key} is not a Symbol" unless key.is_a? Symbol
+            unless value.is_a? Symbol
+              @status[:error].push "//:fixtures/:datasets/:#{name}/:rules/#{key} value (#{value}) is not a Symbol" 
+            else
+              @status[:warn].push "//:fixtures/:datasets/:#{name}/:rules/#{key} is useless" if deep_find_key(key,dataset[:definition]).empty?
+            end
+            @status[:error].push "//:fixtures/:datasets/:#{name}/:rules/#{key} set but no rules exist" unless @content.dig(:fixtures,:rules).include? value
+            
+          end
+          
+        end
+      end
+      @status[:status] = (@status[:error].size > count)? :ko : @status[:status]
+    end
+
+
+    def validate_models
+      return if @content.dig(:fixtures,:models).nil?
+      count = @status[:error].size
+      model_config = @content.dig(:fixtures,:models)
+      unless model_config.is_a? Hash
+        @status[:error].push "//:fixtures/:models record is not a Hash" 
+      else
+        @status[:error].push "//:fixtures/:models/ not have key :type defined" unless model_config.include? :type
+        @status[:error].push "//:fixtures/:models/:type is not a symbol" unless model_config[:type].is_a? Symbol
+        @status[:error].push "//:fixtures/:models/ not have key :definitions defined" unless model_config.include? :definitions
+        unless model_config[:definitions].is_a? Hash then 
+          @status[:error].push "//:fixtures/:models/:definitions is not a Hash" 
+        else
+          @content.dig(:fixtures,:models,:definitions).each do |name, definitions|
+            @status[:error].push "//:fixtures/:models/:definitions/:#{name} is not a Symbol" unless name.is_a? Symbol
+            @status[:error].push "//:fixtures/:models/:definitions/:#{name} not have key :class defined" unless definitions.include? :class
+            @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:class is not a String" unless definitions[:class].is_a? String
+            @status[:error].push "//:fixtures/:models/:definitions/:#{name} not have key :unicity defined" unless definitions.include? :unicity
+            @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:unicity is not a Symbol" unless definitions[:unicity].is_a? Symbol
+            if definitions.include? :rules then
+              @status[:error].push "//:fixtures/:models/:definitions/:#{name} have key :rules but it's not a Hash" unless definitions[:rules].is_a? Hash
+              definitions[:rules].each do |key,value|
+                @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:rules/#{key} is not a Symbol" unless key.is_a? Symbol
+                unless value.is_a? Symbol
+                  @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:rules/#{key} value (#{value}) is not a Symbol" 
+                else
+                  @status[:warn].push "//:fixtures/:models/:definitions/:#{name}/:rules/#{key} is useless" if deep_find_key(key,definitions[:collection]).empty?
+                end
+                @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:rules/#{key} set but no rules exist" unless @content.dig(:fixtures,:rules).include? value
+              end
+            end
+            
+            @status[:error].push "//:fixtures/:models/:definitions/:#{name} not have key :collection defined" unless definitions.include? :collection
+            @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:collection is not a Array" unless definitions[:collection].is_a? Array
+            if definitions.include? :collection then
+              definitions.dig(:collection).each_with_index do |record,i|
+                @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:collection[#{i}] not have key :attributes defined" unless record.include? :attributes
+                @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:collection[#{i}]/:attributes is not a Hash" unless record[:attributes].is_a? Hash
+                if record.include? :belong
+                  unless record[:belong].is_a? Hash then
+                    @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:collection[#{i}]/:belong is set but is not a Hash" 
+                  else
+                    {to: Symbol, by: Symbol, search_by: Hash}.each do |verb,type|
+                      @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:collection[#{i}]/:belong not have key :#{verb} defined" unless record[:belong].include? verb
+                      @status[:error].push "//:fixtures/:models/:definitions/:#{name}/:collection[#{i}]/:belong/:#{verb} is not a #{type}" unless record[:belong][verb].is_a? type
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+      @status[:status] = (@status[:error].size > count)? :ko : @status[:status]
+    end
+
+    def deep_find_key(key, object)
+      found = []
+      if object.respond_to?(:key?) && object.key?(key)
+        found << key
+      end
+      if object.is_a? Enumerable
+        found << object.collect { |*a| deep_find_key(key, a.last) }
+      end
+      found.flatten.compact
+    end
+
+    
+
+
+  end
+
 end
+
+

data/lib/fixturizer/engines/models.rb

@@ -5,11 +5,10 @@ module Fixturizer
     class Models
       ADAPTERS = { mongoid: ::Fixturizer::Adapters::Mongoid }.freeze
 
-      attr_reader :generated
+      attr_reader :generated, :order, :models
 
       def initialize
         @configuration = Fixturizer::Services.get.configuration
-        @rules = @configuration.rules
         @models = @configuration.models
         @order = @configuration.models_order
         @type = @configuration.models_type
@@ -18,12 +17,12 @@ module Fixturizer
       end
 
       def populate
-        generate_data
-        inject_data
+        generate
+        inject
         true
       end
 
-      def generate_data
+      def generate
         @generated.clear
         raise 'Order field format missmatch, not an array' unless @order.nil? || @order.is_a?(Array)
 
@@ -32,41 +31,37 @@ module Fixturizer
 
           @order.each do |item|
             raise "Definition #{item} not found in models definitions" unless @models.include?(item)
-
-            @generated[item] = generate_collection(name: item)
+            @generated[item]  = generate_collection(name: item)
           end
         else
-          @models.each_key do |key|
-            @generated[key] = generate_collection(name: key)
+          @models.each_key do |item|
+            @generated[item] = generate_collection(name: item)
           end
+
         end
       end
 
-      def inject_data
+      def inject
         raise 'Data not generated' if @generated.empty?
-
-        @generated.each do |key, value|
-          model_infos = @models[key].dup
-          model_infos.delete(:collection)
-          value.each do |item|
-            item[:attributes].merge!(binder(item: item[:links])) if item.include?(:links)
-            injector model_infos:, item: item[:attributes]
-          end
-        end
+        inject_data
       end
 
       private
 
       def generate_collection(name:)
-        data = @models[name][:collection].dup
-        data.each do |item|
-          dataset = {}
-          dataset[:definition] = item[:attributes]
-          dataset[:rules] = @models[name][:rules]
-          item[:attributes] =
-            Fixturizer::Services.get.engine(name: :dataset, parameters: { dataset: }).generate
+        data = []
+        @models[name][:collection].each do |item|
+          res = {data: Fixturizer::Services.get.engine(name: :dataset, parameters: { dataset: 
+              { definition: item[:attributes], rules: @models[name][:rules]}
+               }).generate  }
+          belong = item.dig(:belong)
+          res[:belong] = belong if belong
+          have = item.dig(:have)
+          res[:have] = have if have
+          data.push res 
+          
         end
-        data
+        return data
       end
     end
   end

data/lib/fixturizer/rake/rules/configuration.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+namespace :fixturizer do
+    namespace :configuration do
+      desc 'Check the configuration file'
+      task :lint do
+        filename = (ENV['FIXTURIZER_CONFIGURATION_FILE'].is_a? String)? 
+            ENV['FIXTURIZER_CONFIGURATION_FILE'] : 
+            Fixturizer::Services.settings.configuration_filename
+        Fixturizer::Services.get.linter(filename: filename).display
+      end
+  
+      
+    end
+  end

data/lib/fixturizer/rspec/helpers/database.rb

@@ -14,8 +14,8 @@ module Fixturizer
 
         def populate
           Fixturizer::Services.get.engine(name: :models).populate
-        rescue StandardError
-          false
+        # rescue StandardError
+        #   false
         end
       end
     end

data/lib/fixturizer/services.rb

@@ -15,6 +15,7 @@ module Fixturizer
     attr_reader :configuration, :log
 
     def initialize
+      linter(filename: @@settings.configuration_filename).validate! unless detect_rake_lint
       @configuration = Fixturizer::Configuration.new filename: @@settings.configuration_filename
       @log = Logger.new(Fixturizer::Services.settings.log_target)
       log.info 'Starting new Fixturing'
@@ -43,9 +44,24 @@ module Fixturizer
       service(type: :serializers, name:, parameters:)
     end
 
+    def linter(filename: @@settings.configuration_filename)
+      Fixturizer::ConfigurationLinter.new filename: filename
+    end
+
     class << self
       alias get instance
       alias init instance
     end
+
+    private 
+    
+    def detect_rake_lint
+      res = false
+      if defined?(Rake)
+        res = true if Rake.application.top_level_tasks.first == "fixturizer:configuration:lint"
+      end
+      return res 
+    end
+
   end
 end

data/samples/Gemfile

@@ -7,11 +7,11 @@ gem 'rackup', '~> 2.1'
 gem 'sinatra', '~> 4.0.0'
 
 group :test, :development do
-  gem 'fixturizer', '~> 0.4.0'
+  gem 'fixturizer'
   gem 'rack-rest-rspec', '~> 0.0.3'
   gem 'rack-test', '~> 2.0.2'
   gem 'rake', '~> 13.0'
-  gem 'rspec', '~> 3.10.0'
+  gem 'rspec', '~> 3.13.0'
 end
 
 gem 'mongoid', '~> 9.0'

data/samples/app.rb

@@ -16,8 +16,18 @@ class Post
   field :title, type: String
   field :body, type: String
   has_many :comments
+  has_one :type
 end
 
+
+class Type
+  include Mongoid::Document
+  field :name, type: String
+  field :description, type: String
+  belongs_to :post, optional: true
+end
+
+
 class Comment
   include Mongoid::Document
   field :name, type: String
@@ -37,7 +47,8 @@ class Application < Sinatra::Base
   get '/posts/:post_id' do |post_id|
     post = Post.find(post_id)
     post.attributes.merge(
-      comments: post.comments
+      comments: post.comments,
+      type: post.type
     ).to_json
   end
 end

data/samples/config/rules.yml

@@ -13,6 +13,7 @@
         - "two" 
       :rules:
         :body: :body
+
   :rules:
     :body: 
       :proc: "SecureRandom.urlsafe_base64(64)"
@@ -22,18 +23,34 @@
   :models:
     :type: :mongoid
     :order:
+      - :types
       - :posts
       - :comments
     :definitions:
+      :types:
+        :class: Type
+        :unicity: :name
+        :collection:
+          - :attributes:
+              :name: News
+              :description: A fresh news
+          - :attributes:
+              :name: Reaction
+              :description: An instant reaction
       :posts:
         :rules:
           :body: :preserve_body
         :class: Post
-        :unicity: :id
+        :unicity: :title
         :collection:
           - :attributes:
               :title: First post Title
               :body: First Post Body
+              # :have: 
+              #   :linked: :types
+              #   :by: :type
+              #   :search_by:
+              #      :name: News
           - :attributes:
               :title: Second post Title
               :body: 
@@ -44,9 +61,8 @@
           - :attributes:
               :name: test name
               :message: test message
-            :links:
-              - :collection: :posts
-                :index:
-                  :at: 1
-                :fkey: :post
-                :pkey: :id
+            :belong:
+              :to: :posts
+              :by: :comments
+              :search_by:  
+                :title: First post Title

data/samples/spec/app_spec.rb

@@ -81,17 +81,17 @@ RSpec.describe 'Test Fixturizer' do
     end
   end
 
-  # context 'Database : drop and populate' do
-  #   it 'must be possible to drop database with helper ' do
-  #     expect(database.drop).to be true
-  #   end
-  #   it 'must be possible to populate database with helper ' do
-  #     expect(database.populate).to be true
-  #   end
-
-  #   it { expect(database).to be_correctly_dropped }
-  #   it { expect(database).to be_correctly_populated }
-  # end
+  context 'Database : drop and populate' do
+    it 'must be possible to drop database with helper ' do
+      expect(database.drop).to be true
+    end
+    it 'must be possible to populate database with helper ' do
+      expect(database.populate).to be true
+    end
+
+    it { expect(database).to be_correctly_dropped }
+    it { expect(database).to be_correctly_populated }
+  end
 
   context 'Serializers : test ' do
     it 'must be possible to serialize data to JSON' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixturizer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Pierre ALPHONSE
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: version
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +214,7 @@ files:
 - lib/fixturizer/getters/json.rb
 - lib/fixturizer/getters/yaml.rb
 - lib/fixturizer/rake/manage.rb
+- lib/fixturizer/rake/rules/configuration.rake
 - lib/fixturizer/rake/rules/database.rake
 - lib/fixturizer/rspec/helpers/database.rb
 - lib/fixturizer/rspec/helpers/datasets.rb