pgchief 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756ccf173c3d0cbe56bb969e2f7d20e9032e1a7b1c600155e212548fa81f93bb
-  data.tar.gz: c00f369d5e6013bedb955daba82da8c54ad2a77c978b2ead411cae3ef0ca5f0f
+  metadata.gz: 627e9af2dc140bd7210c9f4e999f5be13ba0bf514e6397619d42bef8a6d8b838
+  data.tar.gz: 78a5456432854cebd9b6d6fb68f9f02256a9a37c626ac0d78ef35b3bf79f4f21
 SHA512:
-  metadata.gz: 5ec3b0a81250bd7c8b479780ec658adf5a51f7f19db08c0447f1470ba4477cee24c7a00affec84ba5db0cf136a18e02de636e1d2f6701f0b6aa13d3ffee88afa
-  data.tar.gz: 828bf9aebb8235af34a0462f2d2890e5d51245e98841c97644a1d4411ba9147d5f9a1b594c2367f0dd34a96dff47f45201d0d312e8b862e90f27f83b5aad4514
+  metadata.gz: 26a19391751adbd9846cd70532becfa91c4f2e6a704405764c207e817f388b5ad900a5993eb2e20b574e09e78a089658b9f1f14591e9ea5f0349476fa7b49c13
+  data.tar.gz: e96db718dd3e594b4f612d47b2d63bfe0792e94b4ba622d9093db6b2d8138c02cf8dc45885557a8048f767d280f597103a410468914496dd937e25b759eb2c18

data/CHANGELOG.md

@@ -13,6 +13,19 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Fixes
 
+## [0.3.1]
+
+### Changes
+
+- The main database url will be accessed via the config class and will prioritize
+  the ENV over the config file, if it is set.
+
+### Fixes
+
+- Do not use the ENV only. Until now that was the only method and it was ignoring
+  what was set in the config file. This fixes the issue where nothing will work
+  if `ENV["DATABASE_URL"]` is not set.
+
 ## [0.3.0]
 
 ### Additions

data/README.md

@@ -26,12 +26,15 @@ below for the feature check-list and current progress.
 ```sh
 gem install pgchief
 
-# To initialize the config file at `~/.pgchief.toml`:
+# To initialize the config file at `~/.config/pgchief/config.toml`:
 
 pgchief --init
 
-# make sure the DATABASE_URL is set to the connection string for a pg server's superuser
-export DATABASE_URL=postgresql://postgres:password@postgres.local:5432
+# edit the config file and set your main administrative connection string
+# (vim|nano|pico|ed) ~/.config/pgchief/config.toml
+
+# OR ... make sure the DATABASE_URL env is set to the connection string
+# export DATABASE_URL=postgresql://postgres:password@postgres.local:5432
 
 pgchief
 ```

data/lib/pgchief/command/base.rb

@@ -12,7 +12,7 @@ module Pgchief
 
       def initialize(*params)
         @params = params
-        @conn = PG.connect(Pgchief::DATABASE_URL)
+        @conn = PG.connect(Pgchief::Config.pgurl)
       end
 
       def call

data/lib/pgchief/command/database_privileges_grant.rb

@@ -25,7 +25,7 @@ module Pgchief
       private
 
       def grant_privs! # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-        conn = PG.connect("#{Pgchief::DATABASE_URL}/#{database}")
+        conn = PG.connect("#{Pgchief::Config.pgurl}/#{database}")
         conn.exec("GRANT CONNECT ON DATABASE #{database} TO #{username};")
         conn.exec("GRANT CREATE ON SCHEMA public TO #{username};")
         conn.exec("GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO #{username};")
@@ -50,7 +50,7 @@ module Pgchief
 
       def connection_string
         ConnectionString.new(
-          Pgchief::DATABASE_URL,
+          Pgchief::Config.pgurl,
           username: username,
           password: password,
           database: database

data/lib/pgchief/command/user_create.rb

@@ -49,7 +49,7 @@ module Pgchief
 
       def connection_string
         ConnectionString.new(
-          Pgchief::DATABASE_URL,
+          Pgchief::Config.pgurl,
           username: username,
           password: password
         ).to_s

data/lib/pgchief/config.rb

@@ -8,8 +8,9 @@ module Pgchief
     class << self
       attr_accessor \
         :backup_dir,
-        :credentials_file,
-        :pgurl
+        :credentials_file
+
+      attr_writer :pgurl
 
       def load_config!(toml_file = "#{Dir.home}/.config/pgchief/config.toml")
         config = TomlRB.load_file(toml_file, symbolize_keys: true)
@@ -19,6 +20,10 @@ module Pgchief
         @pgurl = config[:pgurl]
       end
 
+      def pgurl
+        ENV.fetch("DATABASE_URL", @pgurl)
+      end
+
       def set_up_file_structure!
         FileUtils.mkdir_p(backup_dir)
 

data/lib/pgchief/database.rb

@@ -6,7 +6,7 @@ module Pgchief
   # Database information and operations
   class Database
     def self.all
-      conn = PG.connect(Pgchief::DATABASE_URL)
+      conn = PG.connect(Pgchief::Config.pgurl)
       result = conn.exec("SELECT datname FROM pg_database WHERE datistemplate = false")
       result
         .map { |row| row["datname"] }

data/lib/pgchief/user.rb

@@ -6,7 +6,7 @@ module Pgchief
   # Database information and operations
   class User
     def self.all
-      conn   = PG.connect(Pgchief::DATABASE_URL)
+      conn   = PG.connect(Pgchief::Config.pgurl)
       result = conn.exec("SELECT usename FROM pg_user")
 
       result.map { |row| row["usename"] }.reject { |name| name == "postgres" }

data/lib/pgchief/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pgchief
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/pgchief.rb

@@ -36,8 +36,6 @@ require "pgchief/command/user_drop"
 require "pgchief/command/user_list"
 
 module Pgchief
-  DATABASE_URL = ENV.fetch("DATABASE_URL")
-
   class Error < StandardError; end
 
   module Errors

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Joel Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -79,7 +79,6 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -140,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: A simple ruby script to manage postgresql databases and users

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Joel Oliveira
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.