hanami-db_schema_dump 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d40ad347315619f4f1bc05c3dc032e7012a3117489f3c1cf99e37ddb114d04ea
+  data.tar.gz: 6856869d485343bfedff2060301e6bf82bb68ad3a48b0c284233bced3dcc0b2d
+SHA512:
+  metadata.gz: 3626a0c6e650a24838eb6512213f36ad1dc4ae2f015ac7b1e3b07b4c8556db8eb6d53f2ed19bcc0927011db3f86de7db797cc2bf18c771ecbc6b500ae4b51cc6
+  data.tar.gz: 88c75d9acdf642128852b9c32d87ceca2eeff233517f8df7e0b19ed69f17ee96e3dc2e0b33cfc06c25b41a3b83d8bf1c7f3147fbc4fd835c450931dead07d6ab

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.1.0
+
+- Support PostgreSQL database dump using `pg_dump`.
+- Hook into existing Hanami CLI command `hanami db migrate`.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at teohuiming@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hanami-database-schema_dump.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    hanami-db_schema_dump (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hanami-db_schema_dump!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Huiming Teo
+
+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,49 @@
+# hanami-db_schema_dump
+
+A Hanami [command-line plugin](https://guides.hanamirb.org/command-line/plugins/) that dumps your PostgreSQL
+development database schema into `db/schema.sql` after `hanami db migrate` is executed.
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+group :plugins do
+  gem "hanami-database-schema_dump"
+end
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+## Usage
+
+To update `db/schema.sql`, run:
+
+```sh
+bundle exec hanami db migrate
+```
+
+Note: This only happens when `HANAMI_ENV` is set to `development`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/[USERNAME]/hanami-database-schema_dump. 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/[USERNAME]/hanami-database-schema_dump/blob/master/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 Hanami::Database::SchemaDump project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hanami-database-schema_dump/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hanami/database/schema_dump"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hanami-db_schema_dump.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/hanami/db_schema_dump/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanami-db_schema_dump"
+  spec.version       = Hanami::DbSchemaDump::VERSION
+  spec.authors       = ["Huiming Teo"]
+  spec.email         = ["teohuiming@gmail.com"]
+
+  spec.summary       = %q{Hanami command-line plugin that dumps PostgreSQL db schema into `db/schema.sql`.}
+  spec.description   = %q{This Hanami command-line plugin dumps your PostgreSQL development database schema
+    into `db/schema.sql` after `hanami db migrate` is executed.}
+  spec.homepage      = "http://github.com/teohm/hanami-db_schema_dump"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/teohm/hanami-db_schema_dump"
+  spec.metadata["changelog_uri"] = "https://github.com/teohm/hanami-db_schema_dump/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/hanami/db_schema_dump/version.rb

@@ -0,0 +1,5 @@
+module Hanami
+  module DbSchemaDump
+    VERSION = "0.1.0"
+  end
+end

data/lib/hanami/db_schema_dump.rb

@@ -0,0 +1,15 @@
+require "hanami/db_schema_dump/version"
+
+module Hanami
+  module DbSchemaDump
+    class Command
+      def call(*)
+        if ENV["HANAMI_ENV"] == "development"
+          system("pg_dump -s --no-owner --no-privileges #{ENV.fetch('DATABASE_URL')} > db/schema.sql")
+        end
+      end
+    end
+  end
+end
+
+Hanami::CLI::Commands.after "db migrate", Hanami::DbSchemaDump::Command.new

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: hanami-db_schema_dump
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Huiming Teo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-03 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  This Hanami command-line plugin dumps your PostgreSQL development database schema
+      into `db/schema.sql` after `hanami db migrate` is executed.
+email:
+- teohuiming@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hanami-db_schema_dump.gemspec
+- lib/hanami/db_schema_dump.rb
+- lib/hanami/db_schema_dump/version.rb
+homepage: http://github.com/teohm/hanami-db_schema_dump
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/teohm/hanami-db_schema_dump
+  source_code_uri: https://github.com/teohm/hanami-db_schema_dump
+  changelog_uri: https://github.com/teohm/hanami-db_schema_dump/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Hanami command-line plugin that dumps PostgreSQL db schema into `db/schema.sql`.
+test_files: []