dbgrapher 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +3 -1
  3. data/README.md +9 -5
  4. data/dbgrapher.gemspec +1 -1
  5. data/lib/dbgrapher/version.rb +1 -1
  6. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 216e0bf448c9a04b8878009c8d74bcac49ef2a59ed242f14f6f224bd94200157
4
- data.tar.gz: '08cdfb6be53b59e0a3bbf643dd1dacf171ec2e85a89ef720f9aa3a007dd113ae'
3
+ metadata.gz: 80fe68639f2cc6ff8a8d420924991ad8f2ecc26da175878150aa4744d8fa8d82
4
+ data.tar.gz: 24cde9679abc09eae51c80aa540bcb135154cceb1308b80826464d56534debae
5
5
  SHA512:
6
- metadata.gz: 29914d7a7c53ced3cb7a15ed449f916f1aa3527d39cd5318a46b04eb603bba62dcd4287e1c44bef036d9b9b46bb93490d15efada9fc2c364b3fa1fcc7b441f75
7
- data.tar.gz: 920a12eb8ee1ae88e79facbd75a9be1e71cb275f594a213884478fd744f623d158d000488643dd8c6da29212101beb4210b5b9e4cc8a300a6714daf1d7196c34
6
+ metadata.gz: 9970992518c6fe3b87130f881a04e778d23b33af37720b7758a64e99623db2d3e25ef94eb4281641f368710ea2dd23a4e9475a30e49c9263d76b28b992a5227c
7
+ data.tar.gz: b60f2bf96100ba456937ffab6cddff0400ee35d6ec5ceac923b4ec6005f2724b8ffecece78989d90b14eea3b1ce5472fec21b604996ebade0ae1256e9fed25e5
data/.gitignore CHANGED
@@ -9,4 +9,6 @@
9
9
 
10
10
  # rspec failure tracking
11
11
  .rspec_status
12
- .byebug_history
12
+
13
+ .byebug_history
14
+ dbgrapher-*.*.*.gem
data/README.md CHANGED
@@ -1,4 +1,5 @@
1
1
  [![CI](https://github.com/ayeressian/dbgrapher_gem/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/ayeressian/dbgrapher_gem/actions/workflows/ci.yml)
2
+ [![Gem Version](https://badge.fury.io/rb/dbgrapher.svg)](https://badge.fury.io/rb/dbgrapher)
2
3
 
3
4
  # Dbgrapher
4
5
 
@@ -28,15 +29,18 @@ require "dbgrapher/rake_task"
28
29
  Dbgrapher::RakeTask.new()
29
30
  ```
30
31
 
31
- Then run
32
+ If everything is setup correctlly `rake -T dbgrapher` should return `rake dbgrapher:gen # Generates dbgrapher.json`.
32
33
 
33
- rake dbgrapher:gen
34
-
35
- In the `db/schema directory` it will generate `dbgrapher.json` file.
36
- Now in your browser (preferably chrome) navigate to [dbgrapher.com](https://dbgrapher.com). In the "Please select a cloud provider." dialog select "None". In the following dialog select "Open". Open the `db/schema/dbgrapher.json` file. Move the tables to appropriate positions. Then from "File" top menu select save. In case you're not using chrome you should select "Download" from "File" top menu and copy the downloaded file to the `db/schema/dbgrapher.json`.
34
+ ## Usage
35
+ ### Generation
36
+ To generate schema run `rake dbgrapher:gen`. In the `db/schema directory` it will generate `dbgrapher.json` file.
37
+ Now in your browser (preferably chrome) navigate to [dbgrapher.com](https://dbgrapher.com). In the "Please select a cloud provider" dialog select "None". In the following dialog select "Open". Open the `db/schema/dbgrapher.json` file. Move the tables to appropriate positions. Then from "File" top menu select save. In case you're not using chrome you should select "Download" from "File" top menu and copy the downloaded file to the `db/schema/dbgrapher.json`.
37
38
  Every time a new table is being added to the database the top procedure should be performed. Note its only necessary to position the newly added tables, the previously positioned table positions are persisted.
38
39
  Don't forget to commit your dbgrapher.json file. It contains information about the table positions.
39
40
 
41
+ ### View
42
+ To view the schema in the browser navigate to [dbgrapher.com](https://dbgrapher.com). In the "Please select a cloud provider" dialog select "None". In the following dialog select "Open". Open the `db/schema/dbgrapher.json` file.
43
+
40
44
  ## Development
41
45
 
42
46
  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.
data/dbgrapher.gemspec CHANGED
@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
6
6
  spec.authors = ["Ara Yeressian"]
7
7
  spec.email = ["yeressian@tuta.io"]
8
8
 
9
- spec.summary = "This library provides rake task to be used with rails application to generate dbgrapher.com db schema file"
9
+ spec.summary = "This library provides a rake task to be used with the rails application to generate dbgrapher.com db schema files"
10
10
  # spec.description = %q{TODO: Write a longer description or delete this line.}
11
11
  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
12
12
  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
data/lib/dbgrapher/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Dbgrapher
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dbgrapher
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ara Yeressian
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2021-04-14 00:00:00.000000000 Z
11
+ date: 2021-04-21 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description:
14
14
  email:
@@ -55,6 +55,6 @@ requirements: []
55
55
  rubygems_version: 3.1.2
56
56
  signing_key:
57
57
  specification_version: 4
58
- summary: This library provides rake task to be used with rails application to generate
59
- dbgrapher.com db schema file
58
+ summary: This library provides a rake task to be used with the rails application to
59
+ generate dbgrapher.com db schema files
60
60
  test_files: []