miguel 0.1.0.pre1 → 0.1.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c7f6a7a9e366374d9d88b5c5dde5e3ca0e8e9fa
-  data.tar.gz: 99bc1f4cb8a9ab1bc6f84b8595f541d5226b6f0c
+  metadata.gz: 6cc20233657ee51f12faa39ae0c81c55184b09cb
+  data.tar.gz: 983d7e268d3cd5f9448b128b56f84f5a2f64cdea
 SHA512:
-  metadata.gz: 3e1d62b3872b4961a7df1276cf82ec89829b81d05560ce3d435d48f9a077bc60e46a919a4b21ae7131e24c01ceb521ebd176120525a01ff7f8d989be66335835
-  data.tar.gz: 483d87a4bd5c54251dce7255e99e54238ddcc6a729d820c881fe841153732854b55b697895b0749d3cd6a07533ea237a43c66abb40dd6b0b4678436f4324908e
+  metadata.gz: 61288b386f01bf54e2fedda5f0988e70ab0aaf3eb2133279b43ebc69f277a7cff39c57170eb92c5209fd418dd0a1613ef9ef43a87d75f2d6112ebbcfa96c8b66
+  data.tar.gz: 43f256c47f62d61d58f2031d5ec0cbcf6c8d1ce89c0e583e272c7701d9e618e8d51590010412ba4fb37bfca506c49e08f625ac15004ae6541f58f2d7d2107bfe

data/.gitignore

@@ -1 +1,2 @@
 *~
+/miguel-*.gem

data/.travis.gemfile

@@ -0,0 +1,9 @@
+# Gemfile for TravisCI integration.
+
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'bacon', '~> 1.2'
+gem 'sequel', '~> 4.0'
+
+# EOF #

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.2.3
+  - 2.1.7
+  - 2.0.0
+  - 1.9.3
+  - rbx-2
+  - jruby-head
+  - jruby-19mode
+gemfile: .travis.gemfile
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-19mode
+    - rvm: jruby-head

data/README.md

@@ -0,0 +1,191 @@
+# Miguel
+
+[![Gem Version](https://img.shields.io/gem/v/miguel.svg)](http://rubygems.org/gems/miguel) [![Build Status](https://img.shields.io/travis/raxoft/miguel.svg?branch=master)](http://travis-ci.org/raxoft/miguel) [![Dependency Status](https://img.shields.io/gemnasium/raxoft/miguel.svg)](https://gemnasium.com/raxoft/miguel) [![Code Climate](https://img.shields.io/codeclimate/github/raxoft/miguel.svg)](https://codeclimate.com/github/raxoft/miguel) [![Coverage](https://img.shields.io/codeclimate/coverage/github/raxoft/miguel.svg)](https://codeclimate.com/github/raxoft/miguel)
+
+Miguel is a tool for sane management of database schemas. It aims to help with these goals:
+
+* Have just one up-to-date description of the desired database schema using a concise DSL.
+* Apply that schema to the database anytime, no matter how either may have diverged.
+* Adjust and repeat as often as needed.
+
+To achieve this, it provides the following features:
+
+* [Sequel](http://sequel.jeremyevans.net/)-like DSL for schema description with some enhancements.
+* Load schema from given description file or from given database.
+* Show changes necessary to turn one schema into another.
+* Render those changes as Sequel's change or up/down migrations.
+* Alternatively apply those changes directly to the database.
+
+## Describing the schema
+
+The schema is described using a DSL similar to Sequel's
+[standard schema syntax](http://sequel.jeremyevans.net/rdoc/files/doc/schema_modification_rdoc.html).
+It looks like this:
+
+``` ruby
+# Example schema for Miguel.
+Miguel::Schema.define do
+
+  # The user, the core of every web site.
+
+  table :users do
+    primary_key :id
+
+    # The login id, usually user email address.
+    String :login
+    # The encrypted password.
+    String :password
+
+    # First name(s).
+    String :first_name
+    # Last name(s).
+    String :last_name
+
+    # Arbitrary JSON encoded info.
+    Text? :info
+
+    timestamps
+
+    unique :login
+    index :first_name
+    index :last_name
+    index :create_time
+  end
+
+  # User's emails, as every user can have multiple emails.
+
+  table :user_emails do
+    primary_key :id
+
+    # The email address itself.
+    String :email
+    # To which user does the email belong.
+    foreign_key :user_id, :users
+
+    # Flag set when this email is verified.
+    False :verified
+    # Flag set when this email is marked as their primary email by the user.
+    False :primary
+
+    timestamps
+
+    unique :email
+    index :user_id
+    index :create_time
+  end
+
+  # User's profile, collecting various info about the user.
+
+  table :user_profiles do
+    primary_key :user_id
+    foreign_key [:user_id], :users
+
+    String? :company
+    String? :street
+    String? :city
+    String? :state
+    String? :country
+    String? :zip
+    String? :phone
+    String? :fax
+    String? :url
+
+    index :country
+    index :state
+  end
+
+  # User's followers.
+
+  join_table :user_id, :users, :follower_id, :users, :user_followers
+
+end
+```
+
+One enhancement is that it allows you to define `NULL` columns simply by adding `?` to the type name.
+Anything else is implicitly `NOT NULL`, which is a really wise default.
+
+Another enhancement is that it allows you to set defaults and
+define custom shortcuts for types which you use frequently.
+See documentation of the `set_defaults` method for details.
+The preset defaults are like this:
+
+``` ruby
+set_defaults :global, :null => false
+set_defaults :primary_key, :type => :integer, :unsigned => true
+set_defaults :foreign_key, :key => :id, :type => :integer, :unsigned => true
+set_defaults :unique, :index, :unique => true
+set_defaults :Bool, :TrueClass
+set_defaults :True, :TrueClass, :default => true
+set_defaults :False, :TrueClass, :default => false
+set_defaults :Signed, :integer, :unsigned => false
+set_defaults :Unsigned, :integer, :unsigned => true
+set_defaults :Text, :String, :text => true
+set_defaults :Time, :timestamp, :default => 0
+set_defaults :Time?, :timestamp, :default => nil
+```
+
+Finally, the `timestamp` helper can be used to create the
+`create_time` and `update_time` timestamps for you.
+
+## Using the command
+
+Using the command should be pretty straightforward.
+Try `miguel -h` and follow the examples.
+You can basically:
+
+* `show` - show schema loaded from given `.rb` file or from given database.
+* `dump` - dump migration which creates such schema.
+* `down` - dump migration which reverses given schema entirely.
+* `diff` - dump migration for migrating from one schema to another.
+* `apply` - apply given schema to given database.
+* `clear` - entirely wipe out schema of given database.
+
+You don't have to worry about changing things accidentally,
+the command will always ask for a confirmation before changing anything in the database
+(unless you use the `--force` option).
+
+Databases can be specified either by their Sequel URL like
+`mysql2://user:password@localhost/main`,
+or by the common database `.yml` config file:
+
+``` yaml
+adapter: mysql2
+user: jim
+password: sup3rsecr3t
+host: localhost
+database: main
+encoding: utf8
+```
+
+Note that you can use the `--env` option to specify an environment other than `development`
+if your `.yml` contains configs for multiple environments.
+
+Use the `--migration <format>` option to choose how you want the migration displayed.
+The `bare` format (the default) shows just the changes themselves,
+the `change` format creates the one-way Sequel's change migration,
+relying on Sequel's ability to reverse it,
+while
+the `full` format creates the two-way Sequel's up/down migration.
+
+It's up to you if you will use `diff` each time to create the migration files for you,
+amend them if needed,
+and then let the `sequel` command use them normally,
+or if you will just `apply` the schema directly
+and rely on your VCS to keep its previous versions for you,
+leaving dozens of piecewise migration files finally behind.
+
+## Limitations
+
+The type support is geared towards the MySQL, especially the timestamp types.
+Generic types should work with any database, but your mileage may vary.
+
+It is currently not possible to describe renaming of columns.
+If you need that,
+simply rename the columns directly in the database or by using standard Sequel migration,
+and adjust the schema description accordingly.
+
+## Credits
+
+Copyright &copy; 2015 Patrik Rak
+
+Miguel is released under the MIT license.

data/TODO

@@ -1,2 +1 @@
 add tests
-write docs

data/examples/db.yml

@@ -0,0 +1,21 @@
+# Example database configuration.
+
+# Development database.
+:development:
+  :adapter: mysql2
+  :user: dev
+  :password: hax0rz
+  :host: localhost
+  :database: test
+  :encoding: utf8
+
+# Production database.
+:production:
+  :adapter: mysql2
+  :user: web
+  :password: aGhiTheig6iex6shieMohz5orsomethinglikethat
+  :host: localhost
+  :database: main
+  :encoding: utf8
+
+# EOF #

data/examples/schema.rb

@@ -0,0 +1,133 @@
+# Example schema for Miguel.
+#
+# Few words on indexes/indices, applying to Sequel migrations in general:
+#
+# Create explicit indexes even for foreign keys, to make them named the Sequel way.
+# This also prevents MySQL from using combined index starting with that column for the foreign key.
+# Such combined index couldn't be dropped later because of the foreign key constraint,
+# at least until you would create an explicit one for that single column.
+#
+# Do not create overly complicated indexes before performance proves you really need them.
+# Remember that every index increases insertion time considerably and takes space,
+# so you should always start only with the basic indexes for the fields you need.
+
+Miguel::Schema.define do
+
+  set_standard_defaults
+
+  # The user, the core of every web site.
+
+  table :users do
+    primary_key :id
+
+    # The login id, usually user email address.
+    String :login
+    # The encrypted password.
+    String :password
+
+    # Random bytes associated with this user, used in hashing and encrypting user specific things.
+    String :secret
+
+    # First name(s).
+    String :first_name
+    # Last name(s).
+    String :last_name
+
+    # String describing which permissions and what access rights the user has, separated by comma.
+    Text :permissions
+
+    # Arbitrary JSON encoded info.
+    Text? :info
+
+    timestamps
+
+    unique :login
+    index :first_name
+    index :last_name
+    index :create_time
+  end
+
+  # User's emails, as every user can have multiple emails.
+
+  table :user_emails do
+    primary_key :id
+
+    # The email address itself.
+    String :email
+    # To which user does the email belong.
+    foreign_key :user_id, :users
+
+    # Flag set when this email is verified.
+    False :verified
+    # Flag set when this email is marked as their primary email by the user.
+    False :primary
+
+    timestamps
+
+    unique :email
+    index :user_id
+    index :create_time
+  end
+
+  # User's profile, collecting various info about the user.
+
+  table :user_profiles do
+    primary_key :user_id
+    foreign_key [:user_id], :users
+
+    String? :company
+    String? :street
+    String? :city
+    String? :state
+    String? :country
+    String? :zip
+    String? :phone
+    String? :fax
+    String? :url
+
+    index :country
+    index :state
+  end
+
+  # Event log, for recording various things which happen on this web site.
+  # Every event contains what kind of object it refers to, what action was taken,
+  # what object was involved, if any, and arbitrary additional info stored as JSON.
+
+  table :events do
+    primary_key :id
+
+    # The kind of the object affected (like user or email)
+    String :kind
+    # What action was taken (like create or update)
+    String :action
+
+    # Id of the user the event relates to, if any.
+    foreign_key? :user_id, :users
+    # Id of the user responsible for creating the event, if any.
+    foreign_key? :author_id, :users
+    # Id of the object involved, whatever it is, for easier database lookup.
+    Unsigned? :subject_id
+
+    # IP of the request, if any.
+    String? :ip
+
+    # Arbitrary JSON encoded info.
+    Text :info
+
+    timestamps
+
+    index [ :kind, :action ]
+    index :user_id
+    index :author_id
+    index :subject_id
+    index :ip
+    index :create_time
+  end
+
+  # User's followers.
+
+  join_table :user_id, :user, :follower_id, :user, :user_followers
+
+end
+
+# EOF #

data/miguel.gemspec

@@ -4,11 +4,11 @@ require File.expand_path( '../lib/miguel/version', __FILE__ )
 
 Gem::Specification.new do |s|
   s.name        = 'miguel'
-  s.version     = Miguel::VERSION + '.pre1'
+  s.version     = Miguel::VERSION + '.pre2'
   s.summary     = 'Database migrator and migration generator for Sequel.'
   s.description = <<EOT
 This gem makes it easy to create and maintain an up-to-date database schema
-and apply it to the database as needed by the means of standard Sequel migrations."
+and apply it to the database as needed by the means of standard Sequel migrations.
 EOT
 
   s.author      = 'Patrik Rak'
@@ -19,6 +19,7 @@ EOT
   s.files       = `git ls-files`.split( "\n" )
   s.executables = `git ls-files -- bin/*`.split( "\n" ).map{ |f| File.basename( f ) }
 
+  s.required_ruby_version = '>= 1.9.3'
   s.add_runtime_dependency 'sequel', '~> 4.0'
   s.add_development_dependency 'bacon', '~> 1.2'
 end

data/test/test_dumper.rb

@@ -12,7 +12,7 @@ describe Miguel::Dumper do
     d << "d"
     d.text.should == "a\nb\nc\nd\n"
   end
-  
+
   should 'support nesting' do
     d = Miguel::Dumper.new
     d.dump "test" do
@@ -36,7 +36,7 @@ test do
 end
 EOT
   end
-  
+
   should 'support text interpolation' do
     d = Miguel::Dumper.new
     d << "abc"
@@ -44,7 +44,7 @@ EOT
     d.text.should == d.to_s
     d.text.should == "#{d}"
   end
-  
+
   should 'accept nonstring arguments' do
     d = Miguel::Dumper.new
     d << 123
@@ -52,14 +52,14 @@ EOT
     d << :test
     d.text.should == "123\n0.5\ntest\n"
   end
-  
+
   should 'support chaining' do
     d = Miguel::Dumper.new
     d.dump( "x" ).should == d
     ( d << "y" << "z" ).should == d
     d.text.should == "x\ny\nz\n"
   end
-  
+
   should 'support custom buffer' do
     a = []
     d = Miguel::Dumper.new( a )
@@ -68,7 +68,7 @@ EOT
     a.should == [ "xyz\n", "abc\n" ]
     d.text.should == "xyz\nabc\n"
   end
-  
+
   should 'support configurable indentation' do
     d = Miguel::Dumper.new( [], 4 )
     d.dump "a" do
@@ -84,7 +84,7 @@ a do
 end
 EOT
   end
-  
+
 end
 
 # EOF #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miguel
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre1
+  version: 0.1.0.pre2
 platform: ruby
 authors:
 - Patrik Rak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -40,7 +40,7 @@ dependencies:
         version: '1.2'
 description: |
   This gem makes it easy to create and maintain an up-to-date database schema
-  and apply it to the database as needed by the means of standard Sequel migrations."
+  and apply it to the database as needed by the means of standard Sequel migrations.
 email: patrik@raxoft.cz
 executables:
 - miguel
@@ -48,9 +48,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.gemfile"
+- ".travis.yml"
+- README.md
 - Rakefile
 - TODO
 - bin/miguel
+- examples/db.yml
+- examples/schema.rb
 - lib/miguel.rb
 - lib/miguel/command.rb
 - lib/miguel/dumper.rb
@@ -72,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"