pg_objects 1.0.3 → 1.2.1

data/lib/pg_objects/manager.rb

@@ -1,69 +1,69 @@
-module PgObjects
+##
+# Manages process to create objects
+#
+# Usage:
+#
+#   Manager.new(config, logger).load_files(:before).create_objects
+#
+# or
+#
+#   Manager.new(config, logger).load_files(:after).create_objects
+class PgObjects::Manager
+  include Import['db_object_factory', 'config', 'logger']
+
   ##
-  # Manages process to create objects
-  #
-  # Usage:
-  #
-  #   Manager.new.load_files(:before).create_objects
+  # event: +:before+ or +:after+
   #
-  # or
-  #
-  #   Manager.new.load_files(:after).create_objects
-  class Manager
-    attr_reader :objects, :config, :log
-
-    def initialize
-      raise UnsupportedAdapterError if ActiveRecord::Base.connection.adapter_name != 'PostgreSQL'
+  # used to reference configuration settings +before_path+ and +after_path+
+  def load_files(event)
+    validate_workability
 
-      @objects = []
-      @config = PgObjects.config
-      @log = Logger.new(silent: config.silent)
+    dir = config.send "#{event}_path"
+    Dir[File.join(dir, '**', "*.{#{config.extensions.join(',')}}")].each do |path|
+      objects << db_object_factory.create_instance(path)
     end
 
-    ##
-    # event: +:before+ or +:after+
-    #
-    # used to reference configuration settings +before_path+ and +after_path+
-    def load_files(event)
-      dir = config.send "#{event}_path"
-      Dir[File.join(dir, '**', "*.{#{config.extensions.join(',')}}")].each do |path|
-        @objects << PgObjects::DbObject.new(path)
-      end
-
-      self
-    end
+    self
+  end
 
-    def create_objects
-      @objects.each { |obj| create_object obj }
-    end
+  def create_objects
+    objects.each { create_object(_1) }
+  end
 
-    private
+  def objects
+    @objects ||= []
+  end
 
-    def create_object(obj)
-      return if obj.status == :done
-      raise CyclicDependencyError, obj.name if obj.status == :processing
+  private
 
-      obj.status = :processing
+  def validate_workability
+    raise PgObjects::UnsupportedAdapterError if ActiveRecord::Base.connection.adapter_name != 'PostgreSQL'
+  end
 
-      create_dependencies(obj.dependencies)
+  def create_object(obj)
+    return if obj.status == :done
+    raise PgObjects::CyclicDependencyError, obj.name if obj.status == :processing
 
-      log.write("creating #{obj.name}")
-      ActiveRecord::Base.connection.execute obj.sql_query
+    obj.status = :processing
 
-      obj.status = :done
-    end
+    create_dependencies(obj.dependencies)
 
-    def create_dependencies(dependencies)
-      dependencies.each { |dep_name| create_object find_object(dep_name) }
-    end
+    logger.write("creating #{obj.name}")
+    ActiveRecord::Base.connection.execute(obj.sql_query)
 
-    def find_object(dep_name)
-      result = @objects.select { |obj| [obj.name, obj.full_name, obj.object_name].compact.include? dep_name }
+    obj.status = :done
+  end
 
-      raise AmbiguousDependencyError, dep_name if result.size > 1
-      raise DependencyNotExistError, dep_name if result.empty?
+  def create_dependencies(dependencies)
+    dependencies.each { |dep_name| create_object(find_object(dep_name)) }
+  end
 
-      result[0]
-    end
+  def find_object(dep_name)
+    result = objects.select { |obj| [obj.name, obj.full_name, obj.object_name].compact.include? dep_name }
+
+    raise PgObjects::AmbiguousDependencyError, dep_name if result.size > 1
+    raise PgObjects::DependencyNotExistError, dep_name if result.empty?
+
+    result[0]
   end
 end

data/lib/pg_objects/parsed_object/aggregate.rb

@@ -0,0 +1,8 @@
+#
+# AGGREGATE object representation
+#
+class PgObjects::ParsedObject::Aggregate < PgObjects::ParsedObject::Base
+  def name
+    stmt.define_stmt.defnames[0].string.sval
+  end
+end

data/lib/pg_objects/parsed_object/base.rb

@@ -0,0 +1,16 @@
+#
+# Base class for parsed objects
+#
+class PgObjects::ParsedObject::Base
+  def initialize(stmt)
+    @stmt = stmt
+  end
+
+  def name
+    raise NotImplementedError
+  end
+
+  private
+
+  attr_reader :stmt
+end

data/lib/pg_objects/parsed_object/conversion.rb

@@ -0,0 +1,8 @@
+#
+# CONVERSION object representation
+#
+class PgObjects::ParsedObject::Conversion < PgObjects::ParsedObject::Base
+  def name
+    stmt.create_conversion_stmt.conversion_name[0].string.sval
+  end
+end

data/lib/pg_objects/parsed_object/event_trigger.rb

@@ -0,0 +1,8 @@
+#
+# EVENT TRIGGER object representation
+#
+class PgObjects::ParsedObject::EventTrigger < PgObjects::ParsedObject::Base
+  def name
+    stmt.create_event_trig_stmt.trigname
+  end
+end

data/lib/pg_objects/parsed_object/function.rb

@@ -0,0 +1,8 @@
+#
+# FUNCTION object representation
+#
+class PgObjects::ParsedObject::Function < PgObjects::ParsedObject::Base
+  def name
+    stmt.create_function_stmt.funcname[0].string.sval
+  end
+end

data/lib/pg_objects/parsed_object/materialized_view.rb

@@ -0,0 +1,8 @@
+#
+# MATERIALIZED VIEW object representation
+#
+class PgObjects::ParsedObject::MaterializedView < PgObjects::ParsedObject::Base
+  def name
+    stmt.create_table_as_stmt.into.rel.relname
+  end
+end

data/lib/pg_objects/parsed_object/operator.rb

@@ -0,0 +1,8 @@
+#
+# OPERATOR object representation
+#
+class PgObjects::ParsedObject::Operator < PgObjects::ParsedObject::Base
+  def name
+    stmt.define_stmt.defnames[0].string.sval
+  end
+end

data/lib/pg_objects/parsed_object/operator_class.rb

@@ -0,0 +1,8 @@
+#
+# OPERATOR CLASS object representation
+#
+class PgObjects::ParsedObject::OperatorClass < PgObjects::ParsedObject::Base
+  def name
+    stmt.create_op_class_stmt.opclassname[0].string.sval
+  end
+end

data/lib/pg_objects/parsed_object/table.rb

@@ -0,0 +1,8 @@
+#
+# TABLE object representation
+#
+class PgObjects::ParsedObject::Table < PgObjects::ParsedObject::Base
+  def name
+    stmt.create_stmt.relation.relname
+  end
+end

data/lib/pg_objects/parsed_object/text_search_parser.rb

@@ -0,0 +1,8 @@
+#
+# TEXT SEARCH PARSER object representation
+#
+class PgObjects::ParsedObject::TextSearchParser < PgObjects::ParsedObject::Base
+  def name
+    stmt.define_stmt.defnames[0].string.sval
+  end
+end

data/lib/pg_objects/parsed_object/text_search_template.rb

@@ -0,0 +1,8 @@
+#
+# TEXT SEARCH TEMPLATE object representation
+#
+class PgObjects::ParsedObject::TextSearchTemplate < PgObjects::ParsedObject::Base
+  def name
+    stmt.define_stmt.defnames[0].string.sval
+  end
+end

data/lib/pg_objects/parsed_object/trigger.rb

@@ -0,0 +1,8 @@
+#
+# TRIGGER object representation
+#
+class PgObjects::ParsedObject::Trigger < PgObjects::ParsedObject::Base
+  def name
+    stmt.create_trig_stmt.trigname
+  end
+end

data/lib/pg_objects/parsed_object/type.rb

@@ -0,0 +1,8 @@
+#
+# TYPE object representation
+#
+class PgObjects::ParsedObject::Type < PgObjects::ParsedObject::Base
+  def name
+    stmt.composite_type_stmt.typevar.relname
+  end
+end

data/lib/pg_objects/parsed_object/view.rb

@@ -0,0 +1,8 @@
+#
+# VIEW object representation
+#
+class PgObjects::ParsedObject::View < PgObjects::ParsedObject::Base
+  def name
+    stmt.view_stmt.view.relname
+  end
+end

data/lib/pg_objects/parsed_object.rb

@@ -0,0 +1,18 @@
+module PgObjects::ParsedObject # rubocop: disable Style/Documentation
+end
+
+require 'pg_objects/parsed_object/base'
+require 'pg_objects/parsed_object/aggregate'
+require 'pg_objects/parsed_object/conversion'
+require 'pg_objects/parsed_object/event_trigger'
+require 'pg_objects/parsed_object/function'
+require 'pg_objects/parsed_object/materialized_view'
+require 'pg_objects/parsed_object/operator'
+require 'pg_objects/parsed_object/operator_class'
+require 'pg_objects/parsed_object/table'
+require 'pg_objects/parsed_object/text_search_parser'
+require 'pg_objects/parsed_object/text_search_template'
+require 'pg_objects/parsed_object/trigger'
+require 'pg_objects/parsed_object/type'
+require 'pg_objects/parsed_object/view'
+require 'pg_objects/parsed_object_factory'

data/lib/pg_objects/parsed_object_factory.rb

@@ -0,0 +1,103 @@
+#
+# Returns an object of the respective class based on the provided parsed query
+#
+class PgObjects::ParsedObjectFactory
+  class << self
+    include Dry::Monads[:try, :result]
+
+    SUPPORTED_TYPES = %i[
+      aggregate
+      conversion
+      event_trigger
+      function
+      materialized_view
+      operator
+      operator_class
+      table
+      text_search_parser
+      text_search_template
+      trigger
+      type
+      view
+    ].freeze
+
+    def create_object(input_data)
+      @input_data = input_data
+      @stmt = input_data.tree.stmts[0].stmt
+
+      determine_class.new(stmt)
+    end
+
+    private
+
+    attr_reader :stmt, :input_data
+
+    def determine_class
+      SUPPORTED_TYPES.each do |type|
+        return class_for(type) if send("#{type}?")
+      end
+    end
+
+    def class_for(type)
+      "PgObjects::ParsedObject::#{type.to_s.classify}".constantize
+    end
+
+    def aggregate?
+      try_check_get_result { stmt.define_stmt.kind == :OBJECT_AGGREGATE }
+    end
+
+    def conversion?
+      try_check_get_result { stmt.create_conversion_stmt.conversion_name.present? }
+    end
+
+    def event_trigger?
+      try_check_get_result { stmt.create_event_trig_stmt.trigname.present? }
+    end
+
+    def function?
+      try_check_get_result { stmt.create_function_stmt.funcname.present? }
+    end
+
+    def materialized_view?
+      try_check_get_result { stmt.create_table_as_stmt.objtype == :OBJECT_MATVIEW }
+    end
+
+    def operator_class?
+      try_check_get_result { stmt.create_op_class_stmt.opclassname.present? }
+    end
+
+    def operator?
+      try_check_get_result { stmt.define_stmt.kind == :OBJECT_OPERATOR }
+    end
+
+    def table?
+      try_check_get_result { stmt.create_stmt.table_elts.present? }
+    end
+
+    def text_search_parser?
+      try_check_get_result { stmt.define_stmt.kind == :OBJECT_TSPARSER }
+    end
+
+    def text_search_template?
+      try_check_get_result { stmt.define_stmt.kind == :OBJECT_TSTEMPLATE }
+    end
+
+    def trigger?
+      try_check_get_result { stmt.create_trig_stmt.trigname.present? }
+    end
+
+    def type?
+      try_check_get_result { stmt.composite_type_stmt.typevar.present? }
+    end
+
+    def view?
+      try_check_get_result { stmt.view_stmt.view.present? }
+    end
+
+    def try_check_get_result(&)
+      result = Try(&).to_result
+
+      result.success? && result.value!
+    end
+  end
+end

data/lib/pg_objects/parser.rb

@@ -1,47 +1,50 @@
 require 'pg_query'
 
-module PgObjects
-  ##
-  # Reads directives from SQL-comments
-  #
-  #    --!depends_on [name_of_dependency]
-  #
-  # name_of_dependency: short or full name of object as well as object_name
-  #
-  class Parser
-    # rubocop: disable Style/WordArray
-    ROUTES = [
-      ['DefineStmt', 'defnames', 0, 'String', 'str'],
-      ['CreateFunctionStmt', 'funcname', 0, 'String', 'str'],
-      ['CreateTrigStmt', 'trigname'],
-      ['CreateEventTrigStmt', 'trigname'],
-      ['CompositeTypeStmt', 'typevar', 'RangeVar', 'relname'],
-      ['ViewStmt', 'view', 'RangeVar', 'relname'],
-      ['CreateConversionStmt', 'conversion_name', 0, 'String', 'str'],
-      ['CreateTableAsStmt', 'into', 'IntoClause', 'rel', 'RangeVar', 'relname'],
-      ['CreateOpClassStmt', 'opclassname', 0, 'String', 'str']
-    ].freeze
-    # rubocop: enable Style/WordArray
-
-    class << self
-      def fetch_directives(text)
-        {
-          depends_on: fetch_dependencies(text)
-        }
-      end
-
-      def fetch_object_name(text)
-        parsed = PgQuery.parse(text).tree.dig(0, 'RawStmt', 'stmt')
-        ROUTES.map { |route| parsed.dig(*route) }.compact[0]
-      rescue PgQuery::ParseError, NoMethodError
-        nil
-      end
-
-      private
-
-      def fetch_dependencies(text)
-        text.split("\n").grep(/^(--|#)!/).map { |ln| ln.split[1] if ln =~ /!depends_on/ }.compact
-      end
-    end
+##
+# Reads directives from SQL-comments
+#
+#    --!depends_on [name_of_dependency]
+#
+# name_of_dependency: short or full name of object as well as object_name
+#
+class PgObjects::Parser
+  include Import['parsed_object_factory']
+  include Memery
+
+  PG_ENTITIES = %i[operator_class trigger define_statement conversion event_trigger type function table].freeze
+
+  def load(source)
+    @source = source
+    self
+  end
+
+  def fetch_directives
+    {
+      depends_on: fetch_dependencies
+    }
+  end
+
+  def fetch_object_name
+    parse_query
+    parsed_object.name
+  rescue PgQuery::ParseError, NoMethodError
+    nil
+  end
+
+  private
+
+  attr_reader :parsed
+
+  def parse_query
+    @parsed = PgQuery.parse(@source)
+  end
+
+  memoize
+  def parsed_object
+    parsed_object_factory.create_object(parsed)
+  end
+
+  def fetch_dependencies
+    @source.split("\n").grep(/^(--|#)!/).map { |ln| ln.split[1] if ln =~ /!depends_on/ }.compact
   end
 end

data/lib/pg_objects/railtie.rb

@@ -1,12 +1,7 @@
-module PgObjects
-  ##
-  # Brings rake tasks to rails app
-  class Railtie < Rails::Railtie
-    # initializer 'pg_objects.initialization' do |app|
-    # end
-
-    rake_tasks do
-      load 'tasks/pg_objects_tasks.rake'
-    end
+##
+# Brings rake tasks to rails app
+class PgObjects::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/pg_objects_tasks.rake'
   end
 end

data/lib/pg_objects/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgObjects
-  VERSION = '1.0.3'
+  VERSION = '1.2.1'
 end

data/lib/pg_objects.rb

@@ -1,10 +1,19 @@
 require 'pg_objects/version'
 require 'pg_objects/railtie' if defined?(Rails)
 
+require 'dry-configurable'
+require 'dry-container'
+require 'dry-auto_inject'
+require 'dry/monads'
+require 'memery'
+
+require 'pg_objects/container'
 require 'pg_objects/config'
 require 'pg_objects/db_object'
+require 'pg_objects/db_object_factory'
 require 'pg_objects/logger'
 require 'pg_objects/manager'
+require 'pg_objects/parsed_object'
 require 'pg_objects/parser'
 
 module PgObjects

data/pg_objects.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q(Simple manager for PostgreSQL objects like triggers and functions)
   spec.homepage      = 'https://github.com/marinazzio/pg_objects'
 
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/marinazzio/pg_objects/issues',
@@ -43,8 +43,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '>= 6.0.3.5', '< 7'
-  spec.add_dependency 'pg_query', '~> 1'
-  spec.add_dependency 'railties', '>= 4', '< 7'
+  spec.add_dependency 'activerecord', '>= 6.1.7.0', '< 8'
+  spec.add_dependency 'dry-auto_inject', '~> 1'
+  spec.add_dependency 'dry-configurable', '~> 1'
+  spec.add_dependency 'dry-container', '0.11.0'
+  spec.add_dependency 'dry-monads', '~> 1.6'
+  spec.add_dependency 'memery', '~> 1.5.0'
+  spec.add_dependency 'pg_query', '~> 5'
+  spec.add_dependency 'railties', '>= 4', '< 8'
   spec.add_dependency 'rake-hooks', '~> 1'
 end