bartask 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46e1cce930119b586806da631fc6d3e818ab8ed4b238f9560aad332471799231
+  data.tar.gz: 8b4cbe91dd8454c1d5feb44077078bd4be43ee408291ae1e34d6d2021d1167dd
+SHA512:
+  metadata.gz: 8432407cd0719a035f6d074d4e6203da54438080a82033dae43de8d4955fc54e418d94f900671979dd7f8b25306455332a26fa553a7f3c2291078ca6a6a31b9b
+  data.tar.gz: 4ad33a81804d421d0c6aa0baf29aca6cc24b67918195b93c8813e8aa5678a1aa23be6b2a1a915a6c825467691dc2f3a9342128a6ecb50bade793d8b7c99d0cb8

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Yuji Yaginuma
+
+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,53 @@
+# Bartask
+
+Backup and Recovery tool for RDBMS of Rails development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bartask'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+The Bartask provides commands for backup and recovery of RDBMS. We sometimes need to switch DB schema depending on a branch. This tool aims to switch it easily.
+
+You can get a backup by the following command.
+
+```bash
+bundle exec bartask d
+```
+
+Bartask outputs a backup file under the `tmp` directory.  A filename contains a branch name to allow the generate a file per branch.
+
+The restoration can be done with the following command. This operations uses a dump file generated by `bartask d`. So you need to generate a dump first.
+
+```bash
+bundle exec bartask r
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/y-yagi/bartask. 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/y-yagi/bartask/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 Bartask project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/y-yagi/bartask/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/exe/bartask

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "bartask"
+Bartask::Cli.start

data/lib/bartask/base.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/configuration_file"
+require "pathname"
+require "open3"
+
+module Bartask
+  class Base
+    def initialize(config_file_path: nil)
+      @config_file_path = config_file_path || Pathname.new("config/database.yml")
+      parse_config_file
+    end
+
+    def dump_file_path
+      @dump_file_path ||= begin
+        suffix = branch_name.empty? ? "" : "_#{branch_name}"
+        Pathname.new("tmp/#{@config["database"]}#{suffix}.dump")
+      end
+    end
+
+    private
+
+    def parse_config_file
+      @config = ActiveSupport::ConfigurationFile.parse(@config_file_path)["development"]
+    end
+
+    def mysql?
+      @config["adapter"] == "mysql2" || @config["adapter"] == "trilogy"
+    end
+
+    def postgresql?
+      @config["adapter"] == "postgresql"
+    end
+
+    def env_for_postgresql
+      @config["password"] ? { "PGPASSWORD" => @config["password"]} : {}
+    end
+
+    def branch_name
+      @branch_name ||= begin
+        stdout, _, _ = Open3.capture3("git name-rev --name-only HEAD")
+        stdout.strip
+      end
+    end
+
+    def build_options_for_mysql
+      options = []
+      options << "--user=#{@config["username"]}" if @config["username"]
+      %w[password host port socker].each do |key|
+        options << "--#{key}=#{@config[key]}" if @config[key]
+      end
+      options << @config["database"]
+      options
+    end
+
+    def build_options_for_postgres
+      options = []
+      %w[username host port].each do |key|
+        options << "--#{key}=#{@config[key]}" if @config[key]
+      end
+      options.push(*%w[--clean --no-owner --no-acl])
+      options
+    end
+  end
+end

data/lib/bartask/cli.rb

@@ -0,0 +1,71 @@
+require "optparse"
+
+class Bartask::Cli
+  class << self
+    def start(argv = ARGV)
+      cli = new(argv)
+      options = cli.parse
+
+      if options[:mode] == "r"
+        Bartask::Restorer.new(config_file_path: options[:config]).execute
+      else
+        Bartask::Dumper.new(config_file_path: options[:config]).execute
+      end
+    end
+  end
+
+  CMD = "bartask"
+  USAGE = <<~USAGE
+  sub commands are:
+     d :     dump DB data
+     r :     restore DB data
+  See '#{CMD} COMMAND --help' for more information on a specific command.
+  USAGE
+
+  def initialize(argv)
+    @argv = argv
+    @options = {}
+  end
+
+  def parse
+    global_command.order!(@argv)
+    @options[:mode] = @argv.shift
+    subcommand = subcommands[@options[:mode]]
+    unless subcommand
+      puts global_command.help
+      exit!
+    end
+
+    subcommand.order!(@argv)
+    @options
+  end
+
+  private
+
+  def global_command
+    @global_command ||= OptionParser.new do |opts|
+      opts.banner = "Usage: #{CMD} [options] [subcommand [options]]"
+      opts.separator ""
+      opts.separator USAGE
+    end
+  end
+
+  def subcommands
+    {
+      'd' => OptionParser.new do |opts|
+        opts.banner = "Usage: #{CMD} d [options]"
+
+        opts.on("-C", "--config PATH", "Config file path") do |v|
+          @options[:config] = v
+        end
+      end,
+      'r' => OptionParser.new do |opts|
+        opts.banner = "Usage: #{CMD} r [options]"
+
+        opts.on("-C", "--config PATH", "Config file path") do |v|
+          @options[:config] = v
+        end
+      end
+    }
+  end
+end

data/lib/bartask/dumper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Bartask
+  class Dumper < Base
+    def execute
+      if mysql?
+        system("mysqldump #{build_options_for_mysql.join(' ')} > #{dump_file_path}")
+      elsif postgresql?
+        system(env_for_postgresql, "pg_dump #{build_options_for_postgres.join(' ')} --format=c > #{dump_file_path}", exception: true)
+      else
+        raise ArgumentError, "Unsuported adapter: #{@config["adapter"]}"
+      end
+      $stdout.puts "Dumped to '#{dump_file_path}'."
+    end
+  end
+end

data/lib/bartask/restorer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Bartask
+  class Restorer < Base
+    def execute
+      if mysql?
+        system("mysql #{build_options_for_mysql.join(' ')} < #{dump_file_path}", exception: true)
+      elsif postgresql?
+        system(env_for_postgresql, "pg_restore #{build_options_for_postgres.join(' ')} --dbname #{@config["database"]} #{dump_file_path}", exception: true)
+      else
+        raise ArgumentError, "Unsuported adapter: #{@config["adapter"]}"
+      end
+      $stdout.puts "Restored from '#{dump_file_path}'."
+    end
+  end
+end

data/lib/bartask/version.rb

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

data/lib/bartask.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "bartask/version"
+require_relative "bartask/base"
+require_relative "bartask/dumper"
+require_relative "bartask/restorer"
+require_relative "bartask/cli"
+
+module Bartask
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: bartask
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Yaginuma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- yuuji.yaginuma@gmail.com
+executables:
+- bartask
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/bartask
+- lib/bartask.rb
+- lib/bartask/base.rb
+- lib/bartask/cli.rb
+- lib/bartask/dumper.rb
+- lib/bartask/restorer.rb
+- lib/bartask/version.rb
+homepage: https://github.com/y-yagi/bartask
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/y-yagi/bartask
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key: 
+specification_version: 4
+summary: Backup and Recovery tool for RDBMS of Rails development.
+test_files: []