fixturizer 0.1.0 → 0.4.0

data/fixturizer.gemspec

@@ -1,27 +1,45 @@
-require_relative 'lib/fixturizer/version'
+# frozen_string_literal: true
 
 Gem::Specification.new do |spec|
-  spec.name          = "fixturizer"
-  spec.version       = Fixturizer::VERSION
-  spec.authors       = ["Pierre Alphonse"]
-  spec.email         = ["pierre.alphonse@orange.com"]
+  spec.name          = 'fixturizer'
+  spec.version       = `cat VERSION`.chomp
+  spec.authors       = ['Pierre ALPHONSE', 'Romain GEORGES']
+  spec.email         = ['pierre.alphonse@orange.com', 'romain@ultragreen.net']
 
-  spec.summary       = "Ruby fixturizer for databases models"
-  spec.description   = "Ruby fixturizer for databases models"
-  spec.homepage      = "https://github.com/Ultragreen/fixturizer"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Ruby fixturizer tools for applications testing'
+  spec.description   = 'Ruby fixturizer tools for applications testing'
+  spec.homepage      = 'https://github.com/Ultragreen/fixturizer'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2.3')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency 'mongoid', '~> 9.0'
+  spec.add_dependency 'rake', '~> 13.0'
+  spec.add_dependency 'rspec', '~> 3.10.0'
+  spec.add_dependency 'version', '~> 1.1'
+
+  spec.add_development_dependency 'bundle-audit', '~> 0.1.0'
+  spec.add_development_dependency 'code_statistics', '~> 0.2.13'
+  spec.add_development_dependency 'cyclonedx-ruby', '~> 1.1'
+  spec.add_development_dependency 'debride', '~> 1.12'
+  spec.add_development_dependency 'diff-lcs', '~> 1.5.1'
+  spec.add_development_dependency 'rubocop', '~> 1.32'
+  spec.add_development_dependency 'yard', '~> 0.9.27'
+  spec.add_development_dependency 'yard-rspec', '~> 0.1'
 end

data/lib/dependencies.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+require 'logger'
+
+require 'mongoid'
+require 'fixturizer/version'
+require 'yaml'

data/lib/fixturizer/adapters/init.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/*.rb"].each { |file| require file unless File.basename(file) == 'init.rb' }

data/lib/fixturizer/adapters/mongoid.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+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)
+
+            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
+      rescue StandardError
+        false
+      end
+
+      def check
+        res = {}
+        begin
+          node = ::Mongoid.default_client.cluster.addresses.first.to_s
+          dbname = ::Mongoid.default_client.database.name
+          client = ::Mongo::Client.new("mongodb://#{node}/#{dbname}")
+          client.database_names
+          return true
+        rescue ::Mongo::Auth::Unauthorized, Mongo::Error
+          return false
+        end
+        res
+      end
+    end
+  end
+end

data/lib/fixturizer/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  class Configuration
+    attr_reader :rules, :models, :datasets, :models_order, :models_type
+
+    def initialize(filename:)
+      @content = read_file(filename:)
+      @rules = @content[:fixtures][:rules]
+      @models_type = @content[:fixtures].dig(:models, :type)
+      @models = @content[:fixtures].dig(:models, :definitions)
+      @models_order = @content[:fixtures].dig(:models, :order)
+      @datasets = @content[:fixtures][:datasets]
+    end
+
+    private
+
+    def read_file(filename:)
+      YAML.load(File.readlines(filename).join)
+    end
+  end
+end

data/lib/fixturizer/engines/datasets.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Engines
+    class Dataset
+      attr_reader :name, :dataset
+
+      def initialize(dataset:)
+        @name = dataset
+        @configuration = Fixturizer::Services.get.configuration
+        @dataset = dataset.is_a?(Symbol) ? @configuration.datasets[@name] : dataset
+        @effectives_rules = @dataset[:rules]
+      end
+
+      def generate
+        data = @dataset[:definition]
+        substitute_values(data)
+      end
+
+      private
+
+      def apply_rule(key, value, rule)
+        if @effectives_rules.key? key
+          value = Fixturizer::Services.get.engine(name: :record, parameters: { value:, rule: }).apply
+        end
+        value
+      end
+
+      def substitute_values(obj)
+        return obj.map { |v| substitute_values(v) } if obj.is_a? Array
+        return obj unless obj.is_a? Hash
+
+        obj.each_with_object({}) do |(key, value), result|
+          result[key] = case value
+                        when Hash
+                          substitute_values(value)
+                        when Array
+                          value.map { |v| substitute_values(v) }
+                        else
+                          @effectives_rules.nil? ? value : apply_rule(key, value, @effectives_rules[key])
+                        end
+        end
+      end
+    end
+  end
+end

data/lib/fixturizer/engines/init.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/*.rb"].each { |file| require file unless File.basename(file) == 'init.rb' }

data/lib/fixturizer/engines/models.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Engines
+    class Models
+      ADAPTERS = { mongoid: ::Fixturizer::Adapters::Mongoid }.freeze
+
+      attr_reader :generated
+
+      def initialize
+        @configuration = Fixturizer::Services.get.configuration
+        @rules = @configuration.rules
+        @models = @configuration.models
+        @order = @configuration.models_order
+        @type = @configuration.models_type
+        @generated = {}
+        extend ADAPTERS[@type]
+      end
+
+      def populate
+        generate_data
+        inject_data
+        true
+      end
+
+      def generate_data
+        @generated.clear
+        raise 'Order field format missmatch, not an array' unless @order.nil? || @order.is_a?(Array)
+
+        if @order
+          raise 'Order field size missmatch for configurate definitions' unless @order.size == @models.size
+
+          @order.each do |item|
+            raise "Definition #{item} not found in models definitions" unless @models.include?(item)
+
+            @generated[item] = generate_collection(name: item)
+          end
+        else
+          @models.each_key do |key|
+            @generated[key] = generate_collection(name: key)
+          end
+        end
+      end
+
+      def inject_data
+        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
+      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
+        end
+        data
+      end
+    end
+  end
+end

data/lib/fixturizer/engines/records.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Engines
+    class Record
+      def initialize(value:, rule:)
+        # @configuration = Fixturizer::Configuration::new filename: './config/rules.yml'
+        @configuration = Fixturizer::Services.get.configuration
+        @rules = @configuration.rules
+        @record = value
+        @rule = rule.is_a?(Symbol) ? @rules[rule] : rule
+      end
+
+      def apply
+        result = @record
+        return result if @rule.nil?
+
+        result = eval("lambda { #{@rule[:proc]} } ").call unless (@rule[:preserve] == true) && !@record.nil?
+        result
+      end
+    end
+  end
+end

data/lib/fixturizer/rake/manage.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'fixturizer'
-Dir[File.dirname(__FILE__) + '/rules/*.rake'].each {|file| load file }
+Dir["#{File.dirname(__FILE__)}/rules/*.rake"].each { |file| load file }

data/lib/fixturizer/rake/rules/database.rake

@@ -1,18 +1,21 @@
+# frozen_string_literal: true
+
 namespace :fixturizer do
   namespace :database do
-
-    desc "Drop database"
+    desc 'Drop database'
     task :drop do
-      my_fixturer = Fixturizer::Engine::new filename: './config/rules.yml'
-      my_fixturer.drop_database
+      Fixturizer::Services.get.engine(name: :models).drop_database
+      # Fixturizer::Engines::Models::new(filename: './config/rules.yml').drop_database
     end
 
-    desc "Populate database"
+    desc 'Populate database'
     task :populate do
-      my_fixturer = Fixturizer::Engine::new filename: './config/rules.yml'
-      my_fixturer.generate_data
-      my_fixturer.inject_data
+      Fixturizer::Services.get.engine(name: :models).populate
     end
 
+    desc 'Check database connection'
+    task :check do
+      puts Fixturizer::Services.get.engine(name: :models).check ? 'OK' : 'KO'
+    end
   end
-end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Rspec
+    module Helpers
+      class Database
+        include Singleton
+
+        def drop
+          Fixturizer::Services.get.engine(name: :models).drop_database
+        rescue StandardError
+          false
+        end
+
+        def populate
+          Fixturizer::Services.get.engine(name: :models).populate
+        rescue StandardError
+          false
+        end
+      end
+    end
+  end
+end
+
+def database
+  Fixturizer::Rspec::Helpers::Database.instance
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Rspec
+    module Helpers
+      class Datasets
+        include Singleton
+
+        def generate(dataset:)
+          Fixturizer::Services.get.engine(name: :dataset, parameters: { dataset: }).generate
+        end
+      end
+    end
+  end
+end
+
+def datasets
+  Fixturizer::Rspec::Helpers::Datasets.instance
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Rspec
+    module Helpers
+      class Records
+        include Singleton
+
+        def apply(value:, rule:)
+          Fixturizer::Services.get.engine(name: :record, parameters: { value:, rule: }).apply
+        end
+      end
+    end
+  end
+end
+
+def record
+  Fixturizer::Rspec::Helpers::Records.instance
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Rspec
+    module Helpers
+      class Serializer
+        include Singleton
+
+        def to(format:, data:, raw: false, to_file: nil)
+          options = {}
+          options[:raw] = raw
+          options[:to_file] = to_file
+          Fixturizer::Services.get.serializer(name: format,
+                                              parameters: {
+                                                data:, options:
+                                              }).apply
+        end
+      end
+    end
+  end
+end
+
+def serialize
+  Fixturizer::Rspec::Helpers::Serializer.instance
+end

data/lib/fixturizer/rspec/matchers/database_be_correctly_dropped.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :be_correctly_dropped do
+  match do |actual|
+    actual.drop == true
+  end
+  description do
+    'be effectively dropped.'
+  end
+  failure_message do |_actual|
+    "expected database drop response to be true \ngot : false "
+  end
+  failure_message_when_negated do |_actual|
+    "expected database drop response to be false \ngot : true "
+  end
+end

data/lib/fixturizer/rspec/matchers/database_be_correctly_populated.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :be_correctly_populated do
+  match do |actual|
+    actual.populate == true
+  end
+  description do
+    'be effectively populated.'
+  end
+  failure_message do |_actual|
+    "expected database populate response to be true \ngot : false "
+  end
+  failure_message_when_negated do |_actual|
+    "expected database populate response to be false \ngot : true "
+  end
+end

data/lib/fixturizer/rspec/prepare.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'fixturizer'
+
+Dir["#{File.dirname(__FILE__)}/helpers/*.rb"].each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/matchers/*.rb"].each { |file| require file }

data/lib/fixturizer/serializers/init.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Serializers
+    class Template
+      attr_reader :data
+
+      def initialize(data:, options: nil)
+        @data = data
+        @options = options
+      end
+
+      def apply
+        raise "Abstract template, don't use"
+      end
+
+      def write_file(file, data)
+        File.write(file, data)
+      rescue Errno::EACCES
+        puts "Error: Permission denied to write the file #{file}."
+      rescue Errno::ENOSPC
+        puts 'Error: No space left on the device.'
+      rescue StandardError => e
+        puts "Error: #{e.message}"
+      end
+    end
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/*.rb"].each { |file| require file unless File.basename(file) == 'init.rb' }

data/lib/fixturizer/serializers/json.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Serializers
+    class Json < Template
+      def apply
+        result = if @options[:raw]
+                   @data.to_json
+                 else
+                   JSON.pretty_generate(@data).concat("\n")
+                 end
+        return result unless @options[:to_file].is_a?(String)
+
+        write_file(@options[:to_file], result)
+      end
+    end
+  end
+end

data/lib/fixturizer/serializers/yaml.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  module Serializers
+    class Yaml < Template
+      def apply
+        result = @data.to_yaml
+
+        return result unless @options[:to_file].is_a?(String)
+
+        write_file(@options[:to_file], result)
+      end
+    end
+  end
+end

data/lib/fixturizer/services.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  class Services
+    include Singleton
+    @@settings = Fixturizer::Settings.new
+    def self.settings
+      @@settings
+    end
+
+    def self.configure
+      yield(@@settings)
+    end
+
+    attr_reader :configuration, :log
+
+    def initialize
+      @configuration = Fixturizer::Configuration.new filename: @@settings.configuration_filename
+      @log = Logger.new(Fixturizer::Services.settings.log_target)
+      log.info 'Starting new Fixturing'
+    end
+
+    def service(type:, name:, parameters: nil)
+      service = "Fixturizer::#{type.to_s.capitalize}::#{name.to_s.capitalize}"
+      log.info "running Service : #{service}"
+      if parameters.nil?
+        Object.const_get(service).new
+      else
+        log.info "  => params : #{parameters}"
+        Object.const_get(service).new(**parameters)
+      end
+    end
+
+    def engine(name:, parameters: nil)
+      service(type: :engines, name:, parameters:)
+    end
+
+    def serializer(name:, parameters: nil)
+      service(type: :serializers, name:, parameters:)
+    end
+
+    class << self
+      alias get instance
+      alias init instance
+    end
+  end
+end

data/lib/fixturizer/settings.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Fixturizer
+  class Settings
+    attr_accessor :configuration_filename, :log_target
+
+    def initialize
+      @configuration_filename = './config/rules.yml'
+      @log_target = '/tmp/fixturizer.log'
+    end
+  end
+end

data/lib/fixturizer/version.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'version'
+
 module Fixturizer
-  VERSION = "0.1.0"
+  VERSION = Version.current
 end