db_schema 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dbf606aae084d2032ffbfb12940cfee0d0b9ad3
-  data.tar.gz: e354a7f339af08dadfba3b2a9bd505be2603778f
+  metadata.gz: 654c088e5c985a78e896af87cd0b4ea07a90767d
+  data.tar.gz: 559f43436988fb15091f53f6dd1aa95c8ee495f4
 SHA512:
-  metadata.gz: 6777fcffd1c201b885ae98ff4b3c44bd64b0d3fcc7585a06ae5a9a966b874a7a96070c4fb428f3762ebf5ea68e4d8ecd688a496d5076328a539e4c348ded62b8
-  data.tar.gz: 54a567aeb035b438447b7a70aa0837a6d84974f400f606820b53b4046e192189ab54999c61a439e8a4e7739114936f6f26af4d2ea26ed00002c2290ddcb58e1f
+  metadata.gz: cf94f686cf6d2659ab01f5dcce429255becf74cf2038979b283f41d2f1ea9fa486704e35d378abad9b26fdd8264f46d8fb9523923a0972ce2ba1647a17304e12
+  data.tar.gz: a1fb24c2ae4f4fd0a663cb438c7418cb991f9291e1e855572ab3dacf02ebcf000f6809de5bfabe18faeda768675858466c1544fd0c61624b2e53c84a0cc98ef7

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+services:
+  - postgresql
+addons:
+  postgresql: 9.4
+before_script:
+  - psql -c 'CREATE DATABASE db_schema_test;' -U postgres

data/README.md

@@ -1,4 +1,4 @@
-# DbSchema
+# DbSchema [![Build Status](https://travis-ci.org/7even/db_schema.svg?branch=master)](https://travis-ci.org/7even/db_schema)
 
 DbSchema is an opinionated database schema management tool that lets you maintain your DB schema with a single ruby file.
 
@@ -32,7 +32,10 @@ to a different branch only to see something like this?
 Yeah, you must remember the oldest `NO FILE` migration,
 switch back to the previous branch,
 roll back every migration up to that `NO FILE`,
+discard all changes in `schema.rb`/`structure.sql` (and model annotations if you have any),
 then switch the branch again and migrate these `down` migrations.
+If you already wrote some code to be committed to the new branch
+you need to make sure it won't get discarded so a simple `git reset --hard` won't do.
 Every migration or rollback loads the whole app, resulting in 10+ seconds wasted.
 And at the end of it all you are trying to recall why did you ever
 want to switch to that branch.
@@ -50,7 +53,7 @@ But you would lose it even with manual migrations.
 Add this line to your application's Gemfile:
 
 ``` ruby
-gem 'db_schema'
+gem 'db_schema', '~> 0.1.1'
 ```
 
 And then execute:
@@ -130,7 +133,7 @@ end
 
 Then you just call `rake db:schema:apply` from your deploy script before restarting the app.
 
-### DSL
+## DSL
 
 Database schema is defined with a block passed to `DbSchema.describe` method.
 This block receives a `db` object on which you can call `#table` to define a table
@@ -139,6 +142,8 @@ is described in a block passed to `#table`.
 
 ``` ruby
 DbSchema.describe do |db|
+  db.extension :hstore
+
   db.table :users do |t|
     t.primary_key :id
     t.varchar     :email,    null: false
@@ -146,6 +151,7 @@ DbSchema.describe do |db|
     t.varchar     :name,     null: false
     t.integer     :age
     t.user_status :status,   null: false, default: 'registered'
+    t.hstore      :tracking, null: false, default: ''
 
     t.index :email, unique: true
   end
@@ -165,7 +171,7 @@ DbSchema.describe do |db|
 end
 ```
 
-#### Tables
+### Tables
 
 Tables are described with the `#table` method; you pass it the name of the table and describe the table structure in the block:
 
@@ -176,7 +182,7 @@ db.table :users do |t|
 end
 ```
 
-##### Fields
+#### Fields
 
 You can define a field of any type by calling the corresponding method inside the table block passing it the field name and it's attributes. Most of the attributes are optional.
 
@@ -249,6 +255,20 @@ Other attributes are type specific, like `:length` for varchars; the following t
 | `tsrange`     |                  |
 | `tstzrange`   |                  |
 | `daterange`   |                  |
+| `chkpass`     |                  |
+| `citext`      |                  |
+| `cube`        |                  |
+| `hstore`      |                  |
+| `ean13`       |                  |
+| `isbn13`      |                  |
+| `ismn13`      |                  |
+| `issn13`      |                  |
+| `isbn`        |                  |
+| `ismn`        |                  |
+| `issn`        |                  |
+| `upc`         |                  |
+| `ltree`       |                  |
+| `seg`         |                  |
 
 The `of` attribute of the array type is the only required attribute (you need to specify the array element type here); other attributes either have default values or can be omitted at all.
 
@@ -267,7 +287,7 @@ end
 
 **Important: you can't rename a table or a column just by changing it's name in the schema definition - this will result in a column with the old name being deleted and a column with the new name being added; all data in that table or column will be lost.**
 
-##### Indexes
+#### Indexes
 
 Indexes are created using the `#index` method: you pass it the field name you want to index:
 
@@ -336,7 +356,7 @@ end
 
 Be warned though that you have to specify the condition exactly as PostgreSQL outputs it in `psql` with `\d table_name` command; otherwise your index will be recreated on each DbSchema run. This will be fixed in a later DbSchema version.
 
-##### Foreign keys
+#### Foreign keys
 
 The `#foreign_key` method defines a foreign key. In it's minimal form it takes a referencing field name and referenced table name:
 
@@ -390,7 +410,7 @@ There are 3 more options to the `#foreign_key` method: `:on_update`, `:on_delete
 
 Passing `deferrable: true` defines a foreign key that is checked at the end of transaction.
 
-##### Check constraints
+#### Check constraints
 
 A check constraint is like a validation on the database side: it checks if the inserted/updated row has valid values.
 
@@ -408,7 +428,7 @@ end
 
 As with partial index conditions, for now you have to specify the SQL exactly as `psql` outputs it (otherwise the constraint will be recreated on each run).
 
-#### Enum types
+### Enum types
 
 PostgreSQL allows developers to create custom enum types; value of enum type is one of a fixed set of values stored in the type definition.
 
@@ -434,11 +454,21 @@ db.enum :user_status, [:guest, :registered, :sent_confirmation_email, :confirmed
 
 Reordering and deleting values from enum types is not supported.
 
-### Configuration
+### Extensions
+
+PostgreSQL has a [wide variety](https://www.postgresql.org/docs/9.5/static/contrib.html) of extensions providing additional data types, functions and operators. You can use DbSchema to add and remove extensions in your database:
+
+``` ruby
+db.extension :hstore
+```
+
+*Note that adding and removing extensions in Postgres requires superuser privileges.*
+
+## Configuration
 
 DbSchema must be configured prior to applying the schema. There are 2 methods you can use for that: `configure` and `configure_from_yaml`.
 
-#### DbSchema.configure
+### DbSchema.configure
 
 `configure` is a generic method that receives a hash with all configuration options:
 
@@ -453,7 +483,7 @@ DbSchema.configure(
 )
 ```
 
-#### DbSchema.configure_from_yaml
+### DbSchema.configure_from_yaml
 
 `configure_from_yaml` is designed to use with Rails so you don't have to duplicate database connection settings from your `database.yml` in DbSchema configuration. Pass it the full path to your `database.yml` file and your current application environment (`development`, `production` etc), and it will read the db connection settings from that file.
 
@@ -471,7 +501,7 @@ DbSchema.configure_from_yaml(
 )
 ```
 
-#### Configuration options
+### Configuration options
 
 All configuration options are described in the following table:
 

data/lib/db_schema/awesome_print.rb

@@ -29,6 +29,8 @@ if defined?(AwesomePrint)
           :dbschema_foreign_key
         when ::DbSchema::Definitions::Enum
           :dbschema_enum
+        when ::DbSchema::Definitions::Extension
+          :dbschema_column_operation
         when ::DbSchema::Changes::CreateTable
           :dbschema_create_table
         when ::DbSchema::Changes::DropTable
@@ -68,6 +70,9 @@ if defined?(AwesomePrint)
           :dbschema_column_operation
         when ::DbSchema::Changes::AddValueToEnum
           :dbschema_add_value_to_enum
+        when ::DbSchema::Changes::CreateExtension,
+             ::DbSchema::Changes::DropExtension
+          :dbschema_column_operation
         else
           cast_without_dbschema(object, type)
         end

data/lib/db_schema/changes.rb

@@ -89,7 +89,16 @@ module DbSchema
           end
         end
 
-        table_changes + enum_changes
+        desired_extensions = extract_extensions(desired_schema)
+        actual_extensions  = extract_extensions(actual_schema)
+
+        extension_changes = (desired_extensions - actual_extensions).map do |extension|
+          CreateExtension.new(extension.name)
+        end + (actual_extensions - desired_extensions).map do |extension|
+          DropExtension.new(extension.name)
+        end
+
+        table_changes + enum_changes + extension_changes
       end
 
     private
@@ -225,6 +234,10 @@ module DbSchema
       def extract_enums(schema)
         Utils.filter_by_class(schema, Definitions::Enum)
       end
+
+      def extract_extensions(schema)
+        Utils.filter_by_class(schema, Definitions::Extension)
+      end
     end
 
     class CreateTable
@@ -392,5 +405,11 @@ module DbSchema
         before.nil?
       end
     end
+
+    class CreateExtension < Definitions::Extension
+    end
+
+    class DropExtension < ColumnOperation
+    end
   end
 end

data/lib/db_schema/definitions.rb

@@ -116,6 +116,15 @@ module DbSchema
         @values = values
       end
     end
+
+    class Extension
+      include Dry::Equalizer(:name)
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+    end
   end
 end
 

data/lib/db_schema/definitions/field.rb

@@ -3,7 +3,11 @@ module DbSchema
     module Field
       class << self
         def build(name, type, **options)
-          type_class_for(type).new(name, **options)
+          if registry.key?(type)
+            type_class_for(type).new(name, **options)
+          else
+            Custom.new(name, type_name: type, **options)
+          end
         end
 
         def type_class_for(type)
@@ -35,4 +39,13 @@ require_relative 'field/uuid'
 require_relative 'field/json'
 require_relative 'field/array'
 require_relative 'field/range'
+
+require_relative 'field/extensions/chkpass'
+require_relative 'field/extensions/citext'
+require_relative 'field/extensions/cube'
+require_relative 'field/extensions/hstore'
+require_relative 'field/extensions/isn'
+require_relative 'field/extensions/ltree'
+require_relative 'field/extensions/seg'
+
 require_relative 'field/custom'

data/lib/db_schema/definitions/field/extensions/chkpass.rb

@@ -0,0 +1,9 @@
+module DbSchema
+  module Definitions
+    module Field
+      class Chkpass < Base
+        register :chkpass
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/field/extensions/citext.rb

@@ -0,0 +1,9 @@
+module DbSchema
+  module Definitions
+    module Field
+      class Citext < Base
+        register :citext
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/field/extensions/cube.rb

@@ -0,0 +1,9 @@
+module DbSchema
+  module Definitions
+    module Field
+      class Cube < Base
+        register :cube
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/field/extensions/hstore.rb

@@ -0,0 +1,9 @@
+module DbSchema
+  module Definitions
+    module Field
+      class Hstore < Base
+        register :hstore
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/field/extensions/isn.rb

@@ -0,0 +1,37 @@
+module DbSchema
+  module Definitions
+    module Field
+      class EAN13 < Base
+        register :ean13
+      end
+
+      class ISBN13 < Base
+        register :isbn13
+      end
+
+      class ISMN13 < Base
+        register :ismn13
+      end
+
+      class ISSN13 < Base
+        register :issn13
+      end
+
+      class ISBN < Base
+        register :isbn
+      end
+
+      class ISMN < Base
+        register :ismn
+      end
+
+      class ISSN < Base
+        register :issn
+      end
+
+      class UPC < Base
+        register :upc
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/field/extensions/ltree.rb

@@ -0,0 +1,9 @@
+module DbSchema
+  module Definitions
+    module Field
+      class Ltree < Base
+        register :ltree
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/field/extensions/seg.rb

@@ -0,0 +1,9 @@
+module DbSchema
+  module Definitions
+    module Field
+      class Seg < Base
+        register :seg
+      end
+    end
+  end
+end

data/lib/db_schema/dsl.rb

@@ -29,6 +29,10 @@ module DbSchema
       @schema << Definitions::Enum.new(name.to_sym, values.map(&:to_sym))
     end
 
+    def extension(name)
+      @schema << Definitions::Extension.new(name.to_sym)
+    end
+
     class TableYielder
       attr_reader :table_name
 

data/lib/db_schema/reader.rb

@@ -87,12 +87,22 @@ LEFT JOIN pg_am
 GROUP BY name
       SQL
 
+      EXTENSIONS_QUERY = <<-SQL.freeze
+SELECT extname
+  FROM pg_extension
+ WHERE extname != 'plpgsql'
+      SQL
+
       class << self
         def read_schema
           enums = DbSchema.connection[ENUMS_QUERY].map do |enum_data|
             Definitions::Enum.new(enum_data[:name].to_sym, enum_data[:values].map(&:to_sym))
           end
 
+          extensions = DbSchema.connection[EXTENSIONS_QUERY].map do |extension_data|
+            Definitions::Extension.new(extension_data[:extname].to_sym)
+          end
+
           tables = DbSchema.connection.tables.map do |table_name|
             primary_key_name = DbSchema.connection.primary_key(table_name)
 
@@ -124,7 +134,7 @@ GROUP BY name
             )
           end
 
-          enums + tables
+          enums + extensions + tables
         end
 
         def indices_data_for(table_name)
@@ -164,6 +174,9 @@ GROUP BY name
       private
         def build_field(data, primary_key: false)
           type = data[:type].to_sym.downcase
+          if type == :'user-defined'
+            type = data[:custom_type_name].to_sym
+          end
 
           nullable = (data[:null] != 'NO')
 
@@ -212,24 +225,14 @@ GROUP BY name
             {}
           end
 
-          if data[:type] == 'USER-DEFINED'
-            Definitions::Field::Custom.new(
-              data[:name].to_sym,
-              type_name:   data[:custom_type_name].to_sym,
-              primary_key: primary_key,
-              null:        nullable,
-              default:     default
-            )
-          else
-            Definitions::Field.build(
-              data[:name].to_sym,
-              type,
-              primary_key: primary_key,
-              null:        nullable,
-              default:     default,
-              **options
-            )
-          end
+          Definitions::Field.build(
+            data[:name].to_sym,
+            type,
+            primary_key: primary_key,
+            null:        nullable,
+            default:     default,
+            **options
+          )
         end
 
         def build_foreign_key(data)

data/lib/db_schema/runner.rb

@@ -24,6 +24,10 @@ module DbSchema
             self.class.create_enum(change)
           when Changes::DropEnum
             self.class.drop_enum(change)
+          when Changes::CreateExtension
+            self.class.create_extension(change)
+          when Changes::DropExtension
+            self.class.drop_extension(change)
           end
         end
       end
@@ -39,6 +43,7 @@ module DbSchema
       Utils.sort_by_class(
         changes,
         [
+          Changes::CreateExtension,
           Changes::AddValueToEnum,
           Changes::DropForeignKey,
           Changes::CreateEnum,
@@ -46,7 +51,8 @@ module DbSchema
           Changes::AlterTable,
           Changes::DropTable,
           Changes::DropEnum,
-          Changes::CreateForeignKey
+          Changes::CreateForeignKey,
+          Changes::DropExtension
         ]
       )
     end
@@ -187,6 +193,14 @@ module DbSchema
         end
       end
 
+      def create_extension(change)
+        DbSchema.connection.run(%Q(CREATE EXTENSION "#{change.name}"))
+      end
+
+      def drop_extension(change)
+        DbSchema.connection.run(%Q(DROP EXTENSION "#{change.name}"))
+      end
+
       def map_options(type, options)
         mapping = case type
         when :char, :varchar, :bit, :varbit

data/lib/db_schema/version.rb

@@ -1,3 +1,3 @@
 module DbSchema
-  VERSION = '0.1'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_schema
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Vsevolod Romashov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-24 00:00:00.000000000 Z
+date: 2016-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -198,6 +198,13 @@ files:
 - lib/db_schema/definitions/field/character.rb
 - lib/db_schema/definitions/field/custom.rb
 - lib/db_schema/definitions/field/datetime.rb
+- lib/db_schema/definitions/field/extensions/chkpass.rb
+- lib/db_schema/definitions/field/extensions/citext.rb
+- lib/db_schema/definitions/field/extensions/cube.rb
+- lib/db_schema/definitions/field/extensions/hstore.rb
+- lib/db_schema/definitions/field/extensions/isn.rb
+- lib/db_schema/definitions/field/extensions/ltree.rb
+- lib/db_schema/definitions/field/extensions/seg.rb
 - lib/db_schema/definitions/field/geometric.rb
 - lib/db_schema/definitions/field/json.rb
 - lib/db_schema/definitions/field/monetary.rb