db_schema 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d4608edc6072606f0aaaa72a11f1ba7a25814ea
-  data.tar.gz: 3c8b040331ea7dcbea8b89aa72c1712150517e20
+  metadata.gz: f8d57c1174558070a12ed7b3f5469b1bdaeb019d
+  data.tar.gz: d389fbca9c57a1a5cbf7356b8cc71c7c4db5423a
 SHA512:
-  metadata.gz: f6050054f09f58c312fc744b1e6ca5cb6ddbc4d52b2908b63d0ba48b2720309e4a85bcaf0399451ccd97e01c4404c0215ee181dede439f98c40bda290c5e9068
-  data.tar.gz: c98ce906a1bca09e5a3d17a8aa9d0283978246bfa2756bc5eec8e57c89792d6b32a57296e73747a0a6a8883bee11615ecccc7e75ef158bf48a5615700082284f
+  metadata.gz: d7ddcffe01abc26f6ee010e7ed161c53ce60d13e29e2e03be015750d8ba37329e1cbe683d446452f585621d31d55d89ddd9506d44d1ba9bd487d644b2fff6130
+  data.tar.gz: cea37fc0fe70f6e70d4118169677137e4b4c4bda5faed03b26f54484972444cf48113238c3551cb680a7aa23f0e824046ae9b79e7e26305e0090f54810509e34

data/README.md

@@ -53,7 +53,7 @@ But you would lose it even with manual migrations.
 Add this line to your application's Gemfile:
 
 ``` ruby
-gem 'db_schema', '~> 0.2.1'
+gem 'db_schema', '~> 0.2.2'
 ```
 
 And then execute:
@@ -78,12 +78,10 @@ DbSchema DSL looks like this:
 DbSchema.describe do |db|
   db.table :users do |t|
     t.primary_key :id
-    t.varchar     :email,           null: false
+    t.varchar     :email,           null: false, unique: true
     t.varchar     :password_digest, length: 40
     t.timestamptz :created_at
     t.timestamptz :updated_at
-
-    t.index :email, unique: true
   end
 end
 ```
@@ -91,9 +89,18 @@ end
 Before DbSchema connects to the database you need to configure it:
 
 ``` ruby
-DbSchema.configure(adapter: 'postgresql', database: 'my_database', user: 'bob', password: 'secret')
+DbSchema.configure(
+  adapter:  'postgresql',
+  database: 'my_database',
+  user:     'bob',
+  password: 'secret'
+)
+
 # or in Rails
-DbSchema.configure_from_yaml(Rails.root.join('config', 'database.yml'), Rails.env)
+DbSchema.configure_from_yaml(
+  Rails.root.join('config', 'database.yml'),
+  Rails.env
+)
 ```
 
 Then you can load your schema definition (it is executable - it instantly applies itself to your database):
@@ -110,7 +117,10 @@ Here's an initializer example for a Rails app:
 
 ``` ruby
 # config/initializers/db_schema.rb
-DbSchema.configure_from_yaml(Rails.root.join('config', 'database.yml'), Rails.env)
+DbSchema.configure_from_yaml(
+  Rails.root.join('config', 'database.yml'),
+  Rails.env
+)
 
 if Rails.env.development? || Rails.env.test?
   load Rails.root.join('db', 'schema.rb')
@@ -133,6 +143,8 @@ end
 
 Then you just call `rake db:schema:apply` from your deploy script before restarting the app.
 
+If your production setup doesn't include multiple workers starting simultaneously (for example if you run one Puma worker per docker container and restart containers one by one on deploy) you can go the simple way and just `load Rails.root.join('db', 'schema.rb')` in any environment without a separate rake task. The first DbSchema run will apply the schema while the subsequent ones will see there's nothing left to do.
+
 ## DSL
 
 Database schema is defined with a block passed to `DbSchema.describe` method.
@@ -146,27 +158,22 @@ DbSchema.describe do |db|
 
   db.table :users do |t|
     t.primary_key :id
-    t.varchar     :email,    null: false
+    t.varchar     :email,    null: false, unique: true
     t.varchar     :password, null: false
     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
 
   db.enum :user_status, [:registered, :confirmed_email, :subscriber]
 
   db.table :posts do |t|
     t.primary_key :id
-    t.integer     :user_id, null: false
+    t.integer     :user_id, null: false, index: true, references: :users
     t.varchar     :title,   null: false, length: 50
     t.text        :content
     t.array       :tags,    of: :varchar
-
-    t.index       :user_id
-    t.foreign_key :user_id, references: :users
   end
 end
 ```
@@ -304,7 +311,28 @@ Unique indexes are created with `unique: true`:
 t.index :email, unique: true
 ```
 
-Passing several field names makes a multiple index:
+Simple one-field indexes can be created with `index: true` and `unique: true` options passed to the field definition method so
+
+``` ruby
+db.table :users do |t|
+  t.varchar :name,  index: true
+  t.varchar :email, unique: true
+end
+```
+
+is essentially the same as
+
+``` ruby
+db.table :users do |t|
+  t.varchar :name
+  t.varchar :email
+
+  t.index :name
+  t.index :email, unique: true
+end
+```
+
+Passing several field names to `#index` makes a multiple index:
 
 ``` ruby
 db.table :users do |t|
@@ -397,6 +425,15 @@ db.table :posts do |t|
 end
 ```
 
+DbSchema also provides a short syntax for simple one-column foreign keys - just pass the `:references` option to the field definition:
+
+``` ruby
+db.table :posts do |t|
+  t.integer :user_id,  references: :users
+  t.varchar :username, references: [:users, :name]
+end
+```
+
 As with indexes, you can pass your custom name in the `:name` option; default foreign key name looks like `"#{table_name}_#{fkey_fields.first}_fkey"`.
 
 You can also define a composite foreign key consisting of (and referencing) multiple columns; just list them all:
@@ -435,6 +472,16 @@ db.table :users do |t|
 end
 ```
 
+As with indexes and foreign keys, DbSchema has a short syntax for simple check constraints - a `:check` option in the method definition:
+
+``` ruby
+db.table :products do |t|
+  t.primary_key :id
+  t.text :name,     null: false
+  t.numeric :price, check: 'price > 0'
+end
+```
+
 ### 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.

data/lib/db_schema/definitions.rb

@@ -160,7 +160,7 @@ module DbSchema
       attr_reader :name, :condition
 
       def initialize(name:, condition:)
-        @name      = name
+        @name      = name.to_sym
         @condition = condition
       end
     end

data/lib/db_schema/dsl.rb

@@ -47,12 +47,12 @@ module DbSchema
         end
       end
 
-      def primary_key(name)
-        fields << Definitions::Field::Integer.new(name, primary_key: true)
+      def method_missing(method_name, name, *args, &block)
+        field(name, method_name, args.first || {})
       end
 
-      def field(name, type, **options)
-        fields << Definitions::Field.build(name, type, options)
+      def primary_key(name)
+        field(name, :integer, primary_key: true)
       end
 
       def index(*columns, name: nil, unique: false, using: :btree, where: nil, **ordered_fields)
@@ -132,14 +132,22 @@ module DbSchema
         end
       end
 
-      def method_missing(method_name, name, *args, &block)
-        options = args.first || {}
+      def field(name, type, custom: false, unique: false, index: false, references: nil, check: nil, **options)
+        fields << Definitions::Field.build(name, type, options)
 
-        fields << Definitions::Field::Custom.new(
-          name,
-          type_name: method_name,
-          **options
-        )
+        if unique
+          index(name, unique: true)
+        elsif index
+          index(name)
+        end
+
+        if references
+          foreign_key(name, references: references)
+        end
+
+        if check
+          check("#{table_name}_#{name}_check", check)
+        end
       end
 
       def fields

data/lib/db_schema/version.rb

@@ -1,3 +1,3 @@
 module DbSchema
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Vsevolod Romashov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-05 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel