pg_objects 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c7eb71d09850bc60f89da023336a3b23da1032b708edd25d6d7c4c36cda48a
-  data.tar.gz: 68b0c1d67c6f8954b385bb92d9e56b4e9f26d493aeaa7ce436f853415d5df016
+  metadata.gz: 46968edaefe0dd460b86f65907df0da5e698f775713d2174ee3f353ed844ce78
+  data.tar.gz: c5e7a825fba2451b16369e6690114e9a7d9bee79d3ccf76b448ee06dc0c02ee7
 SHA512:
-  metadata.gz: 58455882d344d4dff87af1855313bb2cf534408a43d8ead7c98d5eaf726cdd5d7c53576d066d018ea51932281bd7d4c38f716b21fb3a276cc859d074fc83ffd4
-  data.tar.gz: 74199983303ce4ef51a41c2131c5f70e384e1ebeeb730681ed8458fe8fa24da481e6240ca6efad0a18350ae9428aae06d4f884f314e0dd27cecea03116292ad1
+  metadata.gz: 3b22eba8c6739aa46603b1226aa22d8a44b032c9ba64546c52c84b9bdd3ff84abd519029bdb1d4d1360a8dd8cfa755c661f6a68da0d6b53f62f0e00bbe7ad76b
+  data.tar.gz: d1219118bf8574b91372554594d7cd36afc7dc7771d6e0ded70764e2db92f0a221093f5a0ba4321d6c6ada7dfb491e6e37ff12c3d305d2f6ece13e8c4d21cbcc

data/.rubocop.yml

@@ -156,13 +156,6 @@ RSpec/ExampleWording:
     not: does not
   IgnoredWords: []
 
-# Checks the file and folder naming of the spec file.
-RSpec/FilePath:
-  Enabled: true
-  CustomTransform:
-    RuboCop: rubocop
-    RSpec: rspec
-
 RSpec/ImplicitExpect:
   EnforcedStyle: should
   Enabled: true
@@ -187,6 +180,12 @@ RSpec/NotToNot:
   EnforcedStyle: not_to
   Enabled: true
 
+RSpec/SpecFilePathFormat:
+  Enabled: true
+
+RSpec/SpecFilePathSuffix:
+  Enabled: true
+
 # Style #######################################################################
 
 Style/AccessorGrouping:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pg_objects (1.2.1)
+    pg_objects (1.3.1)
       activerecord (>= 6.1.7.0, < 8)
       dry-auto_inject (~> 1)
       dry-configurable (~> 1)
@@ -58,7 +58,7 @@ GEM
       thor (~> 1.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.3.1)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     crass (1.0.6)
     debug_inspector (1.2.0)
@@ -67,7 +67,7 @@ GEM
     dry-auto_inject (1.0.1)
       dry-core (~> 1.0)
       zeitwerk (~> 2.6)
-    dry-configurable (1.1.0)
+    dry-configurable (1.2.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
     dry-container (0.11.0)
@@ -102,7 +102,7 @@ GEM
     memery (1.5.0)
       ruby2_keywords (~> 0.0.2)
     method_source (1.0.0)
-    minitest (5.23.1)
+    minitest (5.24.1)
     mutex_m (0.2.0)
     nokogiri (1.16.5-aarch64-linux)
       racc (~> 1.4)
@@ -116,8 +116,8 @@ GEM
       racc (~> 1.4)
     nokogiri (1.16.5-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.24.0)
-    parser (3.3.2.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     pg_query (5.1.0)
@@ -135,7 +135,7 @@ GEM
     psych (5.1.2)
       stringio
     racc (1.8.0)
-    rack (3.0.11)
+    rack (3.1.6)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -167,8 +167,8 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.7)
       io-console (~> 0.5)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.2)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -193,37 +193,28 @@ GEM
       binding_of_caller
       rspec-parameterized-core (< 2)
     rspec-support (3.13.1)
-    rubocop (1.64.1)
+    rubocop (1.65.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
-    rubocop-rails (2.25.0)
+    rubocop-rails (2.25.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.30.0)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.3)
-      rubocop (~> 1.40)
+    rubocop-rspec (3.0.3)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     stringio (3.1.0)
@@ -237,7 +228,7 @@ GEM
       diff-lcs (~> 1.3)
       parser (>= 3.3.0)
     webrick (1.8.1)
-    zeitwerk (2.6.14)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   aarch64-linux

data/README.md

@@ -17,17 +17,27 @@ gem 'pg_objects'
 
 And then execute:
 
-    $ bundle
+```shell
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install pg_objects
+```shell
+gem install pg_objects
+```
+
+Run the installation procedure to initialize directories structure and configuration file:
+
+```shell
+bundle exec rails generate pg_objects:install
+```
 
 ## Usage
 
-Put DB objects as CREATE (or CREATE OR UPDATE) queries in files to directory structure (default: *db/objects*).
+Store DB objects as CREATE (or CREATE OR UPDATE) queries in files within a directory structure (default: *db/objects*).
 
-You can control order of creating by using directive *depends_on* in SQL comment:
+You can control the order of creation by using the directive *depends_on* in an SQL comment:
 
 ```sql
 --!depends_on my_another_func
@@ -35,23 +45,52 @@ CREATE FUNCTION my_func()
 ...
 ```
 
-The string after directive should be a name of file with dependency without extension.
+The string after the directive should be the name of the file that the dependency refers to, without the file extension.
 
 ## Configuration
 
-Create file in *config/initializers* with the following content:
+You have the option to configure the gem using either a YAML file or a Ruby initializer. The priority order for configuration is as follows:
+1. Ruby initializer
+2. YAML config
+3. Default values
+
+### YAML
+
+Create `pg_objects.yml` in the application *config* directory:
+
+```yaml
+# pg_objects.yml
+
+# Specify the directories where the DB objects files are located
+directories:
+  before: path/to/objects/before # executed before the migrations
+  after: path/to/objects/after # executed after the migrations
+
+# Specify the file extensions of the DB objects files
+extensions:
+  - sql
+  - txt
+
+# Specify whether to suppress output to console
+silent: false
+```
+
+### Initializer
+
+Create file in *config/initializers* directory with the following content:
 
 ```ruby
 PgObjects.configure do |config|
-  config.directories = ['db/objects', 'another/path/to/files'] # default: 'db/objects'
+  config.before_path = 'path/to/objects/before' # default: 'db/objects/before'
+  config.after_path = 'path/to/objects/after' # default: 'db/objects/after'
   config.extensions = ['sql', 'txt'] # default: 'sql'
-  config.silent = false # whether to suppress output to console
+  config.silent = true # whether to suppress output to console, default: false
 end
 ```
 
-Otherwise default values will be used.
+Otherwise, the default values will be used.
 
-Remember, you take care the specified directories are exist.
+Please make sure to verify that the specified directories actually exist.
 
 ## Development
 

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

@@ -1,6 +1,7 @@
 ##
 # Creates default directories structure
 class PgObjects::InstallGenerator < Rails::Generators::Base
+  desc 'Creates directories structure in `db` directory of the Rails application and initializes configuration files'
   def create_directories
     empty_directory 'db/objects'
     empty_directory 'db/objects/before'

data/lib/pg_objects/config.rb

@@ -1,3 +1,5 @@
+require_relative 'yaml_configurable'
+
 module PgObjects
   ##
   # Use to set custom configuration:
@@ -23,10 +25,13 @@ module PgObjects
 
   class Config
     extend Dry::Configurable
+    extend YamlConfigurable
 
     setting :before_path, default: 'db/objects/before'
     setting :after_path, default: 'db/objects/after'
     setting :extensions, default: ['sql']
     setting :silent, default: false
+
+    load_from_yaml 'config/pg_objects.yml'
   end
 end

data/lib/pg_objects/db_object.rb

@@ -12,9 +12,10 @@ class PgObjects::DbObject
   attr_accessor :status
   attr_reader :full_name, :object_name
 
-  def initialize(path, status = :new)
+  def initialize(path, status = :new, parser:)
     @full_name = path
     @status = status
+    @parser = parser
   end
 
   def create

data/lib/pg_objects/db_object_factory.rb

@@ -7,7 +7,7 @@ class PgObjects::DbObjectFactory
   include Import['parser']
 
   def create_instance(path, status: :new)
-    db_object = PgObjects::DbObject.new(path, status)
+    db_object = PgObjects::DbObject.new(path, status, parser:)
     db_object.create
   end
 end

data/lib/pg_objects/version.rb

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

data/lib/pg_objects/yaml_configurable.rb

@@ -0,0 +1,22 @@
+# A module that provides a method to load configuration settings from a YAML file.
+module YamlConfigurable
+  # Loads configuration settings from a YAML file.
+  #
+  # @param file_path [String] The path to the YAML file.
+  def load_from_yaml(file_path)
+    return unless File.exist?(file_path)
+
+    config_hash = YAML.load_file(file_path)
+
+    set_if_present(config, :before_path, config_hash.dig('directories', 'before'))
+    set_if_present(config, :after_path, config_hash.dig('directories', 'after'))
+    set_if_present(config, :extensions, config_hash['extensions'])
+    set_if_present(config, :silent, config_hash['silent'])
+  end
+
+  private
+
+  def set_if_present(config, key, value)
+    config.public_send("#{key}=", value) if value.present?
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_objects
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Denis Kiselyov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -197,6 +197,7 @@ files:
 - lib/pg_objects/parser.rb
 - lib/pg_objects/railtie.rb
 - lib/pg_objects/version.rb
+- lib/pg_objects/yaml_configurable.rb
 - lib/tasks/pg_objects_tasks.rake
 - pg_objects.gemspec
 homepage: https://github.com/marinazzio/pg_objects