db_schema-reader-postgres 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06c75ff7d43c7a7fcf852e6e96a2cea6da4e517c
-  data.tar.gz: 69866cfefe8454539deca882a00cdbd3f85c1238
+SHA256:
+  metadata.gz: 9f12b3dcea5dc1a301418825e2b8da015e078c520195e42517da991830d3bc22
+  data.tar.gz: 52778450688b800dccf4934525fc567f0d99a9b426095298f198728cb827a9e6
 SHA512:
-  metadata.gz: d51763814f5e752b7b5a313287780aa39e4e5a7ccf32649620251b128673006f16ccc8192f43ee3a54d47e1644897eeff602b2b3b15ffdf6987245cf774fe816
-  data.tar.gz: 6bfb55ff18fde36a8efaac023a8ef07e211daa040d99477797c9a16878253b4da9eb058709f7789c0662a4b7dd313a64ecf3f64914c65f6a00ea42cef375431b
+  metadata.gz: 7c222884746207d2c46ab112ed40b7d78b4de10feef39dbeee650fa0b40c58bd00307c121ce1fa550391379aa61e80a4d78275e7c2782394f4e91153be986997
+  data.tar.gz: 7ec7a253c3ca0c576b6935df764a24456994b8a26a045d5614445164399dff84568c424d11955ab4560542eef9ec8d340c215ee82145c7b585b27c38b5cf003a

data/.travis.yml

@@ -5,3 +5,9 @@ rvm:
   - 2.3.5
   - 2.4.2
 before_install: gem install bundler -v 1.16.0
+services:
+  - postgresql
+addons:
+  postgresql: 9.6
+before_script:
+  - psql -c 'CREATE DATABASE db_schema_test;' -U postgres

data/README.md

@@ -1,4 +1,4 @@
-# DbSchema::Reader::Postgres
+# DbSchema::Reader::Postgres [![Build Status](https://travis-ci.org/db-schema/reader-postgres.svg?branch=master)](https://travis-ci.org/db-schema/reader-postgres)
 
 DbSchema::Reader::Postgres is a library for reading the database
 structure from PostgreSQL.
@@ -26,7 +26,7 @@ $ gem install db_schema-reader-postgres
 
 First you need a Sequel connection object with `:pg_enum` and `:pg_array`
 Sequel extensions enabled; once you have that object just pass it to
-the `.read_schema` method to get full database schema definition:
+`DbSchema::Reader::Postgres.new` to construct the reader:
 
 ``` ruby
 connection = Sequel.connect(adapter: 'postgres', database: 'db_schema_test').tap do |db|
@@ -34,24 +34,30 @@ connection = Sequel.connect(adapter: 'postgres', database: 'db_schema_test').tap
   db.extension :pg_array
 end
 
-DbSchema::Reader::Postgres.read_schema(connection)
+reader = DbSchema::Reader::Postgres.new(connection)
+```
+
+You can call `#read_schema` to get the full database schema definition:
+
+``` ruby
+reader.read_schema
 # => #<DbSchema::Definitions::Schema ...>
 ```
 
-Other useful methods are `.read_tables`, `.read_table`, `.read_enums` & `.read_extensions`;
+Other useful methods are `#read_tables`, `#read_table`, `#read_enums` & `#read_extensions`;
 they return definitions of respective parts of the database schema:
 
 ``` ruby
-DbSchema::Reader::Postgres.read_tables(connection)
+reader.read_tables
 # => [#<DbSchema::Definitions::Table ...>, #<DbSchema::Definitions::Table ...>, ...]
 
-DbSchema::Reader::Postgres.read_table(:users, connection)
+reader.read_table(:users)
 # => #<DbSchema::Definitions::Table name=:users ...>
 
-DbSchema::Reader::Postgres.read_enums(connection)
+reader.read_enums
 # => [#<DbSchema::Definitions::Enum ...>, #<DbSchema::Definitions::Enum ...>, ...]
 
-DbSchema::Reader::Postgres.read_extensions(connection)
+reader.read_extensions
 # => [#<DbSchema::Definitions::Extension ...>, #<DbSchema::Definitions::Extension ...>, ...]
 ```
 

data/lib/db_schema/reader/postgres.rb

@@ -4,7 +4,7 @@ require_relative 'postgres/version'
 
 module DbSchema
   module Reader
-    module Postgres
+    class Postgres
       ENUMS_QUERY = <<-SQL.freeze
   SELECT t.typname AS name,
          array_agg(e.enumlabel ORDER BY e.enumsortorder) AS values
@@ -20,35 +20,39 @@ SELECT extname
  WHERE extname != 'plpgsql'
       SQL
 
-      class << self
-        def read_schema(connection)
-          Definitions::Schema.new(
-            tables:     read_tables(connection),
-            enums:      read_enums(connection),
-            extensions: read_extensions(connection)
-          )
-        end
+      attr_reader :connection
 
-        def read_tables(connection)
-          connection.tables.map do |table_name|
-            read_table(table_name, connection)
-          end
-        end
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def read_schema
+        Definitions::Schema.new(
+          tables:     read_tables,
+          enums:      read_enums,
+          extensions: read_extensions
+        )
+      end
 
-        def read_table(table_name, connection)
-          Table.new(connection, table_name).read
+      def read_tables
+        connection.tables.map do |table_name|
+          read_table(table_name)
         end
+      end
+
+      def read_table(table_name)
+        Table.new(connection, table_name).read
+      end
 
-        def read_enums(connection)
-          connection[ENUMS_QUERY].map do |enum_data|
-            Definitions::Enum.new(enum_data[:name].to_sym, enum_data[:values].map(&:to_sym))
-          end
+      def read_enums
+        connection[ENUMS_QUERY].map do |enum_data|
+          Definitions::Enum.new(enum_data[:name].to_sym, enum_data[:values].map(&:to_sym))
         end
+      end
 
-        def read_extensions(connection)
-          connection[EXTENSIONS_QUERY].map do |extension_data|
-            Definitions::Extension.new(extension_data[:extname].to_sym)
-          end
+      def read_extensions
+        connection[EXTENSIONS_QUERY].map do |extension_data|
+          Definitions::Extension.new(extension_data[:extname].to_sym)
         end
       end
     end

data/lib/db_schema/reader/postgres/table.rb

@@ -1,6 +1,6 @@
 module DbSchema
   module Reader
-    module Postgres
+    class Postgres
       class Table
         DEFAULT_VALUE = /\A(
           ('(?<date>\d{4}-\d{2}-\d{2})'::date)

data/lib/db_schema/reader/postgres/version.rb

@@ -1,7 +1,7 @@
 module DbSchema
   module Reader
-    module Postgres
-      VERSION = '0.1'
+    class Postgres
+      VERSION = '0.1.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_schema-reader-postgres
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Vsevolod Romashov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Database schema reader for PostgreSQL