pg_objects 0.2.4 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3303bf968bddecccd3d347c18eca15fa77ac36ac75c252ce6c959ac7ebcf8127
-  data.tar.gz: 2c749d34ff5445612acdb8cf5e750174ae02bbe2989c2ab848371e5de2479e52
+  metadata.gz: 7d783ce9eb7db27aa9eb4e53956473891342d467d6c31c023b6657404cdae167
+  data.tar.gz: 396ed78bc7bc02adc593c889e6abcf5127dd06648ce00276322984fe4a4f1ebe
 SHA512:
-  metadata.gz: e8a594c2efc21fc8ec15a7c74f0b113f967739b6ac2921821a4f97ded4bf59e44493262d7c8a374e7699adf6e0c612b5daa24850c58a11c6d950cb47eea5e17f
-  data.tar.gz: a9e77ad822731da9fa9d706bba837692dc8b8744750615ecd274d50e33bb1242aac833c604798f57e6b8646ed48abaffac1f9d613932c94015db48d716afb31c
+  metadata.gz: 606f99d68c7ef4cd74622f0891686664b0f7445b0c9f99e31c6cb842b78104e5a64e71ecca6eeb264b04d64e3adf8693489e5931f8b8aca1fe7554f56d5fcfec
+  data.tar.gz: 280b63ede53a9f78efcf22797334692bf47add35e5c96a4a4b09d226ee92db49b8913666ed48754cf450f6800082be154632fca4b72435b8d0920a2fe68eae83

data/.rubocop.yml

@@ -69,15 +69,6 @@ Style/AsciiComments:
   Enabled: false
   StyleGuide: http://relaxed.ruby.style/#styleasciicomments
 
-# This cop checks that comment annotation keywords are written according
-# to guidelines.
-# Style/CommentAnnotation:
-#   Enabled: false
-
-# Document classes and non-namespace modules.
-Style/Documentation:
-  Enabled: false
-
 # Checks if there is a magic comment to enforce string literals
 Style/FrozenStringLiteralComment:
   Enabled: false

data/.rubocop_todo.yml

@@ -6,6 +6,11 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+Style/Documentation:
+  Exclude:
+    - lib/pg_objects/config.rb
+    - spec/**/*
+
 Style/GuardClause:
   Exclude:
     - pg_objects.gemspec

data/Gemfile.lock

@@ -1,13 +1,28 @@
 PATH
   remote: .
   specs:
-    pg_objects (0.2.4)
-      activerecord (~> 5.2)
-      rake-hooks (~> 1.2)
+    pg_objects (0.3.4)
+      activerecord (~> 5)
+      pg_query (~> 1)
+      railties (~> 5)
+      rake-hooks (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
     activemodel (5.2.1)
       activesupport (= 5.2.1)
     activerecord (5.2.1)
@@ -21,17 +36,42 @@ GEM
       tzinfo (~> 1.1)
     arel (9.0.0)
     ast (2.4.0)
+    builder (3.2.3)
     byebug (10.0.2)
     concurrent-ruby (1.0.5)
+    crass (1.0.4)
     diff-lcs (1.3)
+    erubi (1.7.1)
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
     minitest (5.11.3)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
     parser (2.5.1.2)
       ast (~> 2.4.0)
+    pg_query (1.1.0)
     powerpack (0.1.2)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rake-hooks (1.2.3)
@@ -60,6 +100,7 @@ GEM
     rubocop-rspec (1.30.0)
       rubocop (>= 0.58.0)
     ruby-progressbar (1.10.0)
+    thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -69,13 +110,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 1)
   byebug
   pg_objects!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.59)
-  rubocop-rspec (~> 1.30)
+  rake (~> 10)
+  rspec (~> 3)
+  rubocop (>= 0.59)
+  rubocop-rspec (>= 1.30)
 
 BUNDLED WITH
    1.16.6

data/lib/generators/pg_objects/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates directories structure to store database objects. By default it will be created under `RAILS_ROOT/db/objects`.
+
+    If you're going to change default path don't forget to change configuration as well.
+
+Examples:
+    `rails generate pg_objects:install`
+
+    `rails generate pg_objects:install --help`

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

@@ -0,0 +1,11 @@
+module PgObjects
+  ##
+  # Creates default directories structure
+  class InstallGenerator < ::Rails::Generators::Base
+    def create_directories
+      empty_directory 'db/objects'
+      empty_directory 'db/objects/before'
+      empty_directory 'db/objects/after'
+    end
+  end
+end

data/lib/pg_objects/config.rb

@@ -1,4 +1,16 @@
 module PgObjects
+  ##
+  # Use to set custom configuration:
+  #
+  #   PgObjects.configure do |config|
+  #     # use relative from RAILS_ROOT
+  #     config.before_path = 'db/alternate/before'
+  #     # or full (not recommended)
+  #     config.after_path = '/var/tmp/alternate/after'
+  #     config.extensions = ['sql', 'txt']
+  #     # suppress output to console
+  #     config.silent = true
+  #   end
   class << self
     def configure
       yield config
@@ -10,10 +22,11 @@ module PgObjects
   end
 
   class Config
-    attr_accessor :directories, :extensions, :silent
+    attr_accessor :before_path, :after_path, :extensions, :silent
 
     def initialize
-      @directories = ['db/objects']
+      @before_path = 'db/objects/before'
+      @after_path = 'db/objects/after'
       @extensions = ['sql']
       @silent = false
     end

data/lib/pg_objects/db_object.rb

@@ -1,14 +1,29 @@
 module PgObjects
+  ##
+  # Represents DB object as it is described in file
+  #
+  # [name]  name of file without extension
+  # [full_name] full pathname of file
+  # [object_name] name of function, trigger etc. if it was successfully parsed, otherwise - nil
   class DbObject
-    attr_reader :sql_query, :name, :dependencies
+    attr_reader :sql_query, :name, :full_name, :object_name, :dependencies
     attr_accessor :status
 
     def initialize(file_path)
+      @full_name = file_path
       @name = File.basename file_path, '.*'
       @sql_query = File.read file_path
-      @dependencies = Parser.fetch_dependencies @sql_query
+
+      directives = Parser.fetch_directives @sql_query
+      @dependencies = directives[:depends_on]
+      @multistatement = directives[:multistatement]
+      @object_name = Parser.fetch_object_name @sql_query
 
       @status = :pending
     end
+
+    def multistatement?
+      @multistatement
+    end
   end
 end

data/lib/pg_objects/logger.rb

@@ -1,4 +1,8 @@
 module PgObjects
+  ##
+  # Console output
+  #
+  # Passs +true+ to constructor to suppress output
   class Logger
     attr_reader :silent
 

data/lib/pg_objects/manager.rb

@@ -1,4 +1,14 @@
 module PgObjects
+  ##
+  # Manages process to create objects
+  #
+  # Usage:
+  #
+  #   Manager.new.load_files(:before).create_objects
+  #
+  # or
+  #
+  #   Manager.new.load_files(:after).create_objects
   class Manager
     attr_reader :objects, :config, :log
 
@@ -10,11 +20,14 @@ module PgObjects
       @log = Logger.new(config.silent)
     end
 
-    def load_files
-      config.directories.each do |dir|
-        Dir[File.join(dir, '**', "*.{#{config.extensions.join(',')}}")].each do |path|
-          @objects << PgObjects::DbObject.new(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
@@ -28,26 +41,31 @@ module PgObjects
 
     def create_object(obj)
       return if obj.status == :done
-      raise CyclicDependencyError if obj.status == :processing
+      raise CyclicDependencyError, obj.name if obj.status == :processing
 
       obj.status = :processing
 
       create_dependencies(obj.dependencies)
 
       log.write("creating #{obj.name}")
-      ActiveRecord::Base.connection.exec_query obj.sql_query
+      execute_query(obj)
 
       obj.status = :done
     end
 
+    def execute_query(obj)
+      exec_method = obj.multistatement? ? :execute : :exec_query
+      ActiveRecord::Base.connection.send exec_method, obj.sql_query
+    end
+
     def create_dependencies(dependencies)
       dependencies.each { |dep_name| create_object find_object(dep_name) }
     end
 
     def find_object(dep_name)
-      result = @objects.select { |obj| obj.name == dep_name }
+      result = @objects.select { |obj| [obj.name, obj.full_name, obj.object_name].compact.include? dep_name }
 
-      raise AmbiguousDependencyError if result.size > 1
+      raise AmbiguousDependencyError, dep_name if result.size > 1
       raise DependencyNotExistError, dep_name if result.empty?
 
       result[0]

data/lib/pg_objects/parser.rb

@@ -1,8 +1,40 @@
+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
+  #
+  #    --!multistatement
+  #
+  # use when there are more than one SQL command in object file
   class Parser
     class << self
+      def fetch_directives(text)
+        {
+          depends_on: fetch_dependencies(text),
+          multistatement: fetch_multistatement(text)
+        }
+      end
+
+      def fetch_object_name(text)
+        parsed = PgQuery.parse(text).tree.dig(0, 'RawStmt', 'stmt')
+        parsed.dig('CreateTrigStmt', 'trigname') || parsed.dig('CreateFunctionStmt', 'funcname', 0, 'String', 'str')
+      rescue PgQuery::ParseError
+        nil
+      end
+
+      private
+
       def fetch_dependencies(text)
-        text.split("\n").select { |ln| ln =~ /^(--|#)!/ }.map { |ln| ln.split(' ')[1] if ln =~ /!depends_on/ }
+        text.split("\n").select { |ln| ln =~ /^(--|#)!/ }.map { |ln| ln.split(' ')[1] if ln =~ /!depends_on/ }.compact
+      end
+
+      def fetch_multistatement(text)
+        text.split("\n").select { |ln| ln =~ /^(--|#)!/ }.select { |ln| ln =~ /!multistatement/ }.present?
       end
     end
   end

data/lib/pg_objects/railtie.rb

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

data/lib/pg_objects/version.rb

@@ -1,3 +1,3 @@
 module PgObjects
-  VERSION = '0.2.4'.freeze
+  VERSION = '0.3.4'.freeze
 end

data/lib/tasks/pg_objects_tasks.rake

@@ -1,12 +1,23 @@
 namespace :db do
-  desc 'Generate all the database objects of the current project'
-  task create_objects: :environment do
-    PgObjects::Manager.new.load_files.create_objects
+  namespace :create_objects do
+    desc 'Create all the database objects from "before" folder'
+    task before: :environment do
+      PgObjects::Manager.new.load_files(:before).create_objects
+    end
+
+    desc 'Create all the database objects from "after" folder'
+    task after: :environment do
+      PgObjects::Manager.new.load_files(:after).create_objects
+    end
   end
 end
 
 require 'rake/hooks'
 
 before 'db:migrate' do
-  Rake::Task['db:create_objects'].invoke
+  Rake::Task['db:create_objects:before'].invoke
+end
+
+after 'db:migrate' do
+  Rake::Task['db:create_objects:after'].invoke
 end

data/pg_objects.gemspec

@@ -11,6 +11,8 @@ 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.5'
+
   spec.metadata = {
     'bug_tracker_uri'   => 'https://github.com/marinazzio/pg_objects/issues',
     'documentation_uri' => 'https://github.com/marinazzio/pg_objects/blob/master/README.md',
@@ -18,6 +20,12 @@ Gem::Specification.new do |spec|
     'source_code_uri'   => 'https://github.com/marinazzio/pg_objects'
   }
 
+  spec.post_install_message = %q(
+    Now execute this to create directories structure:
+
+    $ bundle exec rails generate pg_objects:install
+  )
+
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
@@ -35,12 +43,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '~> 5.2'
-  spec.add_dependency 'rake-hooks', '~> 1.2'
+  spec.add_dependency 'activerecord', '~> 5'
+  spec.add_dependency 'pg_query', '~> 1'
+  spec.add_dependency 'railties', '~> 5'
+  spec.add_dependency 'rake-hooks', '~> 1'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.59'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.30'
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rubocop', '>= 0.59'
+  spec.add_development_dependency 'rubocop-rspec', '>= 1.30'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_objects
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.4
 platform: ruby
 authors:
 - Denis Kiselyov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,96 +16,124 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: pg_query
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake-hooks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.59'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.30'
 description: 
@@ -127,6 +155,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/pg_objects/install/USAGE
+- lib/generators/pg_objects/install/install_generator.rb
 - lib/pg_objects.rb
 - lib/pg_objects/config.rb
 - lib/pg_objects/db_object.rb
@@ -146,7 +176,8 @@ metadata:
   homepage_uri: https://github.com/marinazzio/pg_objects
   source_code_uri: https://github.com/marinazzio/pg_objects
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message: "\n    Now execute this to create directories structure:\n\n
+  \   $ bundle exec rails generate pg_objects:install\n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -154,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="