dumpcar 0.1.0

data/LGPL-3.0.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/LICENSE

@@ -0,0 +1,44 @@
+# Free Software Licensing Information for Dumpcar.
+
+The primary license of the Dumpcar is:
+
+   LGPL-3.0-or-later
+
+You can copy, convey, propagate, redistribute and/or modify this program
+   under the terms of the GNU General Public License (GPL) as published by
+   the Free Software Foundation (FSF), either version 3 of the License, or
+   (at your option) any later version of the GPL published by the FSF.
+
+   This program is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
+   License for more details.
+
+   You should have received a copy of the GNU General Public License along
+   with this program in a file in the toplevel directory called
+   "GPL-3.0.txt".  If not, see <http://www.gnu.org/licenses/>.
+
+   In addition to the permission granted by the GPLv3, you also receive
+   permissions as written in GNU Lesser General Public License (LGPL),
+   Version 3.0, as published by the Free Software Foundation (FSF), either
+   version 3 of the License, or (at your option) any later version of the
+   LGPL published by the FSF.
+
+   This program is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+   for more details.
+
+   You should have received a copy of the GNU Lesser General Public License
+   along with this program in a file in the toplevel directory called
+   "LGPL-3.0.txt".  If not, see <http://www.gnu.org/licenses/>.
+
+## Licenses for files in Dumpcar Repository.
+
+1. Any file in the Dumpcar repository that does not specify a license, or is
+   not discussed explicitly in this toplevel "LICENSE" file is licensed:
+
+   LGPL-3.0-or-later
+
+   as specified in detail above.
+

data/NOTICES

@@ -0,0 +1,24 @@
+pg_backup: 
+
+Copyright (c) 2015 Marcus Geissler
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,43 @@
+# Rails::Db::Dump
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dumpcar`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wwahammy/dumpcar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/wwahammy/dumpcar/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rails::Db::Dump project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wwahammy/dumpcar/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/dumpcar/generators/dumpcar_generator.rb

@@ -0,0 +1,25 @@
+class DumpcarGenerator < Rails::Generators::Base
+  def add_db_dumps_dir
+    create_file("db/dumps/.keep", "")
+  end
+
+  def add_keep_to_git
+    git add: "db/dumps/.keep"
+  end
+
+  def gitignore_db_dumps
+    insert_into_file ".gitignore", <<~RUBY
+    
+      # dumpcar dumps
+      /db/dumps
+    RUBY
+  end
+
+  def add_gitignore_to
+    git add: ".gitignore"
+  end
+
+  def commit_git
+    git commit: '-m "Added dumpcar .gitignore"'
+  end
+end

data/lib/dumpcar/instance.rb

@@ -0,0 +1,17 @@
+module Dumpcar
+  class Instance
+    attr_reader :location, :pg
+    def initialize(base: Rails.root.join("db/dumps"), connection: ActiveRecord::Base.connection_db_config.configuration_hash)
+      @location = Location.new(base)
+      @pg = Pg.new(connection)
+    end
+
+    def dump
+      @pg.dump(@location.next)
+    end
+
+    def restore
+      @pg.restore(@location.last)
+    end
+  end
+end

data/lib/dumpcar/location.rb

@@ -0,0 +1,42 @@
+module Dumpcar
+  class Location
+    TIMESTAMP_STRFTIME_FORMAT = "%Y%m%d%H%M%S"
+    TIMESTAMP_GLOB = 14.times.map { "[0-9]" }.join
+    TIMESTAMP_FILE_GLOB = TIMESTAMP_GLOB + "*.dump"
+
+    attr_reader :base
+    def initialize(base)
+      @base = Pathname.new base
+    end
+
+    def dumps
+      prepare_base!
+      Dir.glob(base.join(TIMESTAMP_FILE_GLOB))
+    end
+
+    def first
+      prepare_base!
+      dumps.first
+    end
+
+    def last
+      prepare_base!
+      dumps.last
+    end
+
+    def next
+      prepare_base!
+      base.join(from_time + ".dump").to_s
+    end
+
+    def from_time(time = Time.now.utc)
+      time.strftime(TIMESTAMP_STRFTIME_FORMAT)
+    end
+
+    private
+
+    def prepare_base!
+      FileUtils.mkdir_p base
+    end
+  end
+end

data/lib/dumpcar/pg.rb

@@ -0,0 +1,38 @@
+module Dumpcar
+  class Pg
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def restore(filename)
+      with_database_config do |config|
+        config => {password:, host:, port:, username:, database:}
+        result = "PGPASSWORD=#{password} pg_restore --verbose --clean --no-acl --no-owner -h #{host} -U #{username} -d #{database} -p #{port} #{filename}"
+        puts result
+        `#{result} `
+      end
+    end
+
+    def dump(filename)
+      with_database_config do |config|
+        config => {password:, host:, port:, username:, database:}
+        result = "PGPASSWORD=#{password} pg_dump --host #{host} --port #{port} --username #{username} --clean --format=c --create  --if-exists --no-owner --no-acl #{database} --file=#{filename}"
+        puts result
+        `#{result} `
+      end
+    end
+
+    def with_database_config
+      yield self.class.defaults.merge(connection)
+    end
+
+    def self.defaults
+      {
+        host: "localhost",
+        port: "5432"
+      }
+    end
+  end
+end

data/lib/dumpcar/railtie.rb

@@ -0,0 +1,11 @@
+module Dumpcar
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "dumpcar/tasks/dump.rake"
+    end
+
+    generators do
+      load "dumpcar/generators/dumpcar_generator.rb"
+    end
+  end
+end

data/lib/dumpcar/tasks/dump.rake

@@ -0,0 +1,17 @@
+namespace :dumpcar do
+  namespace :pg do
+    desc "Dumped postgres backup file"
+    task dump: :environment do
+      Dumpcar.dump
+    end
+
+    desc "Load dumped postgres backup file"
+    task restore: :environment do
+      Dumpcar.restore
+    end
+
+    def say(something)
+      puts(something)
+    end
+  end
+end

data/lib/dumpcar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dumpcar
+  VERSION = "0.1.0"
+end

data/lib/dumpcar.rb

@@ -0,0 +1,15 @@
+require "dumpcar/version"
+require "dumpcar/location"
+require "dumpcar/pg"
+require "dumpcar/instance"
+require "dumpcar/railtie" if defined?(Rails)
+
+module Dumpcar
+  def self.dump
+    Instance.new.dump
+  end
+
+  def self.restore
+    Instance.new.restore
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: dumpcar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Schultz
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+email:
+- eric@wwahammy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/create-db-user.sql"
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/docker-compose.yml"
+- ".rspec"
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- GPL-3.0.txt
+- LGPL-3.0.txt
+- LICENSE
+- NOTICES
+- README.md
+- Rakefile
+- config.ru
+- lib/dumpcar.rb
+- lib/dumpcar/generators/dumpcar_generator.rb
+- lib/dumpcar/instance.rb
+- lib/dumpcar/location.rb
+- lib/dumpcar/pg.rb
+- lib/dumpcar/railtie.rb
+- lib/dumpcar/tasks/dump.rake
+- lib/dumpcar/version.rb
+homepage: https://github.com/wwahammy/dumpcar
+licenses:
+- LGPL-3.0-or-later
+metadata:
+  homepage_uri: https://github.com/wwahammy/dumpcar
+  source_code_uri: https://github.com/wwahammy/dumpcar
+  changelog_uri: https://github.com/wwahammy/dumpcar
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: We're getting there
+test_files: []