sequel-annotate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb5fcadf130d2d23412b4597e7e0b1fa4c2ef7c0
+  data.tar.gz: efa509bb8630ad280e036c47105d4f3fd84a8a54
+SHA512:
+  metadata.gz: 9ea01f3487452deeb82a3b34b5c2469c47d7e10e843dc66d60b68e4a762e841d21cbe73611ff3f400006dc5acbbc57db1a47598082200f5a132b1c2abd103e42
+  data.tar.gz: 945371efe3340ddd3a41f887572d6214b6940659a16cb9602cce9cec9cfd0f1ec104ef077a87b4658dff725bbd709cc131d09fda282e655cd441b794b948dffc

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 1.0.0 (2014-09-15)
+
+* Initial Public Release

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2015 Jeremy Evans
+Copyright (c) 2013-2015 Kenny Meyer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,73 @@
+= sequel-annotate
+
+sequel-annotate annotates Sequel models with schema information.  By
+default, it includes information on columns, indexes, and foreign key
+constraints for the current table.
+
+On PostgreSQL, this includes more advanced information, including
+check constraints, triggers, and foreign keys constraints for other
+tables that reference the current table.
+
+== Example
+
+The schema comments are kept at the end of the file, using a format similar to:
+
+  class Item < Sequel::Model
+  end
+
+  # Table: items
+  # Columns:
+  #  id                    | integer               | PRIMARY KEY DEFAULT nextval('items_id_seq'::regclass)
+  #  category_id           | integer               | NOT NULL
+  #  manufacturer_name     | character varying(50) |
+  #  manufacturer_location | text                  |
+  #  in_stock              | boolean               | DEFAULT false
+  #  name                  | text                  | DEFAULT 'John'::text
+  #  price                 | double precision      | DEFAULT 0
+  # Indexes:
+  #  items_pkey        | PRIMARY KEY btree (id)
+  #  name              | UNIQUE btree (manufacturer_name, manufacturer_location)
+  #  manufacturer_name | btree (manufacturer_name)
+  # Check constraints:
+  #  pos_id | (id > 0)
+  # Foreign key constraints:
+  #  items_category_id_fkey       | (category_id) REFERENCES categories(id)
+  #  items_manufacturer_name_fkey | (manufacturer_name, manufacturer_location) REFERENCES manufacturers(name, location)
+  # Triggers:
+  #  valid_price | BEFORE INSERT OR UPDATE ON items FOR EACH ROW EXECUTE PROCEDURE valid_price()
+
+== Install
+
+  gem install sequel-annotate
+
+== Usage
+
+After loading the models:
+
+  require 'sequel/annotate'
+  Sequel::Annotate.annotate(Dir['models/*.rb'])
+
+That will append or replace the schema comment in each of the files.  It's best
+to run this when the repository is clean, and then use your source control
+tools (e.g. git diff) to see the changes it makes.
+
+In some cases, sequel-annotate may not be able to correctly guess the
+model for the file.  In that case, you may need to create an instance manually:
+
+  sa = Sequel::Annotate.new(Item)
+  sa.annotate('models/item.rb')
+
+If you want to get the schema comment for a model without appending it to
+a file:
+
+  sa.schema_comment
+
+== License
+
+MIT
+
+== Author
+
+Jeremy Evans <code@jeremyevans.net>
+
+Based on [annotate-sequel]{https://github.com/kennym/annotate-sequel} by Kenny Meyer.

data/Rakefile

@@ -0,0 +1,46 @@
+require "rake"
+require "rake/clean"
+
+CLEAN.include ["sequel-annotate-*.gem", "rdoc"]
+
+desc "Build sequel-annotate gem"
+task :package=>[:clean] do |p|
+  sh %{#{FileUtils::RUBY} -S gem build sequel-annotate.gemspec}
+end
+
+### Specs
+
+desc "Run specs"
+task :spec do
+  sh "#{FileUtils::RUBY} -rubygems -I lib spec/sequel-annotate_spec.rb"
+end
+
+task :default => :spec
+
+### RDoc
+
+RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'sequel-annotate: Annotate Sequel models with schema information']
+
+begin
+  gem 'rdoc'
+  gem 'hanna-nouveau'
+  RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
+rescue Gem::LoadError
+end
+
+rdoc_task_class = begin
+  require "rdoc/task"
+  RDoc::Task
+rescue LoadError
+  require "rake/rdoctask"
+  Rake::RDocTask
+end
+
+RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
+
+rdoc_task_class.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.options += RDOC_OPTS
+  rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
+end
+

data/lib/sequel/annotate.rb

@@ -0,0 +1,211 @@
+require 'sequel'
+
+module Sequel
+  class Annotate
+    # Append/replace the schema comment for all of the given files.
+    # Attempts to guess the model for each file using a regexp match of
+    # the file's content, if this doesn't work, you'll need to create
+    # an instance manually and pass in the model and path. Example:
+    # 
+    #   Sequel::Annotate.annotate(Dir['models/*.rb'])
+    def self.annotate(paths)
+      Sequel.extension :inflector
+      paths.each do |path|
+        if match = File.read(path).match(/class (\S+)\s*<\s*Sequel::Model/)
+          new(match[1].constantize).annotate(path)
+        end
+      end
+    end
+
+    # The model to annotate
+    attr_reader :model
+
+    # Store the model to annotate
+    def initialize(model)
+      @model = model 
+    end
+
+    # Append the schema comment (or replace it if one already exists) to
+    # the file at the given path.
+    def annotate(path)
+      orig = current = File.read(path).rstrip
+
+      if m = current.reverse.match(/#{"#{$/}# Table: ".reverse}/m)
+        offset = current.length - m.end(0) + 1
+        unless current[offset..-1].match(/^[^#]/)
+          # If Table: comment exists, and there are no
+          # uncommented lines between it and the end of the file
+          # then replace current comment instead of appending it
+          current = current[0...offset].rstrip
+        end
+      end
+
+      current += "#{$/}#{$/}#{schema_comment}"
+
+      if orig != current
+        File.open(path, "wb") do |f|
+          f.puts current
+        end
+      end
+    end
+
+    # The schema comment to use for this model.  
+    # For all databases, includes columns, indexes, and foreign
+    # key constraints in this table referencing other tables.
+    # On PostgreSQL, also includes check constraints, triggers,
+    # and foreign key constraints in other tables referencing this table.
+    def schema_comment
+      output = []
+      output << "# Table: #{model.table_name}"
+
+      meth = :"_schema_comment_#{model.db.database_type}"
+      if respond_to?(meth, true)
+        send(meth, output)
+      else
+        schema_comment_columns(output)
+        schema_comment_indexes(output)
+        schema_comment_foreign_keys(output)
+      end
+
+      output.join($/)
+    end
+
+    private
+
+    # Returns an array of strings for each array of array, such that
+    # each string is aligned and commented appropriately.  Example:
+    #
+    #   align([['abcdef', '1'], ['g', '123456']])
+    #   # => ["#  abcdef  1", "#  g       123456"]
+    def align(rows)
+      cols = rows.first.length
+      lengths = [0] * cols
+
+      cols.times do |i|
+        rows.each do |r|
+          lengths[i] = r[i].length if r[i].length > lengths[i]
+        end
+      end
+
+      rows.map do |r|
+        "#  #{r.zip(lengths).map{|c, l| c.ljust(l)}.join(' | ')}".strip
+      end
+    end
+
+    # Use the standard columns schema output, but use PostgreSQL specific
+    # code for additional schema information.
+    def _schema_comment_postgres(output)
+      schema_comment_columns(output)
+      oid = model.db.send(:regclass_oid, model.table_name)
+
+      # These queries below are all based on the queries that psql
+      # uses, captured using the -E option to psql.
+
+      rows = model.db.fetch(<<SQL, :oid=>oid).all
+SELECT c2.relname, i.indisprimary, i.indisunique, pg_catalog.pg_get_indexdef(i.indexrelid, 0, true)
+FROM pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_index i
+  LEFT JOIN pg_catalog.pg_constraint con ON (conrelid = i.indrelid AND conindid = i.indexrelid AND contype IN ('p','u','x'))
+WHERE c.oid = :oid AND c.oid = i.indrelid AND i.indexrelid = c2.oid AND indisvalid
+ORDER BY i.indisprimary DESC, i.indisunique DESC, c2.relname;
+SQL
+      unless rows.empty?
+        output << "# Indexes:"
+        rows = rows.map do |r|
+          [r[:relname], "#{"PRIMARY KEY " if r[:indisprimary]}#{"UNIQUE " if r[:indisunique] && !r[:indisprimary]}#{r[:pg_get_indexdef].match(/USING (.+)\z/)[1]}"]
+        end
+        output.concat(align(rows))
+      end
+
+      rows = model.db.fetch(<<SQL, :oid=>oid).all
+SELECT r.conname, pg_catalog.pg_get_constraintdef(r.oid, true)
+FROM pg_catalog.pg_constraint r
+WHERE r.conrelid = :oid AND r.contype = 'c'
+ORDER BY 1;
+SQL
+      unless rows.empty?
+        output << "# Check constraints:"
+        rows = rows.map do |r|
+          [r[:conname], r[:pg_get_constraintdef].match(/CHECK (.+)\z/)[1]]
+        end
+        output.concat(align(rows))
+      end
+
+      rows = model.db.fetch(<<SQL, :oid=>oid).all
+SELECT conname,
+  pg_catalog.pg_get_constraintdef(r.oid, true) as condef
+FROM pg_catalog.pg_constraint r
+WHERE r.conrelid = :oid AND r.contype = 'f' ORDER BY 1;
+SQL
+      unless rows.empty?
+        output << "# Foreign key constraints:"
+        rows = rows.map do |r|
+          [r[:conname], r[:condef].match(/FOREIGN KEY (.+)\z/)[1]]
+        end
+        output.concat(align(rows))
+      end
+
+      rows = model.db.fetch(<<SQL, :oid=>oid).all
+SELECT conname, conrelid::pg_catalog.regclass,
+  pg_catalog.pg_get_constraintdef(c.oid, true) as condef
+FROM pg_catalog.pg_constraint c
+WHERE c.confrelid = :oid AND c.contype = 'f' ORDER BY 2, 1;
+SQL
+      unless rows.empty?
+        output << "# Referenced By:"
+        rows = rows.map do |r|
+          [r[:conrelid], r[:conname], r[:condef].match(/FOREIGN KEY (.+)\z/)[1]]
+        end
+        output.concat(align(rows))
+      end
+
+      rows = model.db.fetch(<<SQL, :oid=>oid).all
+SELECT t.tgname, pg_catalog.pg_get_triggerdef(t.oid, true), t.tgenabled, t.tgisinternal
+FROM pg_catalog.pg_trigger t
+WHERE t.tgrelid = :oid AND (NOT t.tgisinternal OR (t.tgisinternal AND t.tgenabled = 'D'))
+ORDER BY 1;
+SQL
+      unless rows.empty?
+        output << "# Triggers:"
+        rows = rows.map do |r|
+          [r[:tgname], r[:pg_get_triggerdef].match(/((?:BEFORE|AFTER) .+)\z/)[1]]
+        end
+        output.concat(align(rows))
+      end
+    end
+
+    # The standard column schema information to output.
+    def schema_comment_columns(output)
+      if cpk = model.primary_key.is_a?(Array)
+        output << "# Primary Key: (#{model.primary_key.join(', ')})"
+      end
+      output << "# Columns:"
+      rows = model.columns.map do |col|
+        sch = model.db_schema[col]
+        [col.to_s, sch[:db_type], "#{"PRIMARY KEY #{"AUTOINCREMENT " if sch[:auto_increment] && model.db.database_type != :postgres}" if sch[:primary_key] && !cpk}#{"NOT NULL " if sch[:allow_null] == false && !sch[:primary_key]}#{"DEFAULT #{sch[:default]}" if sch[:default]}"]
+      end
+      output.concat(align(rows))
+    end
+
+    # The standard index information to output.
+    def schema_comment_indexes(output)
+      unless (indexes = model.db.indexes(model.table_name)).empty?
+        output << "# Indexes:"
+        rows = indexes.map do |name, metadata|
+          [name.to_s, "#{'UNIQUE ' if metadata[:unique]}(#{metadata[:columns].join(', ')})"]
+        end
+        output.concat(align(rows).sort)
+      end
+    end
+
+    # The standard foreign key information to output.
+    def schema_comment_foreign_keys(output)
+      unless (fks = model.db.foreign_key_list(model.table_name)).empty?
+        output << "# Foreign key constraints:"
+        rows = fks.map do |fk|
+          ["(#{fk[:columns].join(', ')}) REFERENCES #{fk[:table]}#{"(#{fk[:key].join(', ')})" if fk[:key]}"]
+        end
+        output.concat(align(rows).sort)
+      end
+    end
+  end
+end

data/spec/annotated/category.rb

@@ -0,0 +1,12 @@
+class Category < Sequel::Model
+end
+
+# Table: categories
+# Columns:
+#  id   | integer | PRIMARY KEY DEFAULT nextval('categories_id_seq'::regclass)
+#  name | text    | NOT NULL
+# Indexes:
+#  categories_pkey     | PRIMARY KEY btree (id)
+#  categories_name_key | UNIQUE btree (name)
+# Referenced By:
+#  items | items_category_id_fkey | (category_id) REFERENCES categories(id)

data/spec/annotated/item.rb

@@ -0,0 +1,23 @@
+class Item < Sequel::Model
+end
+
+# Table: items
+# Columns:
+#  id                    | integer               | PRIMARY KEY DEFAULT nextval('items_id_seq'::regclass)
+#  category_id           | integer               | NOT NULL
+#  manufacturer_name     | character varying(50) |
+#  manufacturer_location | text                  |
+#  in_stock              | boolean               | DEFAULT false
+#  name                  | text                  | DEFAULT 'John'::text
+#  price                 | double precision      | DEFAULT 0
+# Indexes:
+#  items_pkey        | PRIMARY KEY btree (id)
+#  name              | UNIQUE btree (manufacturer_name, manufacturer_location)
+#  manufacturer_name | btree (manufacturer_name)
+# Check constraints:
+#  pos_id | (id > 0)
+# Foreign key constraints:
+#  items_category_id_fkey       | (category_id) REFERENCES categories(id)
+#  items_manufacturer_name_fkey | (manufacturer_name, manufacturer_location) REFERENCES manufacturers(name, location)
+# Triggers:
+#  valid_price | BEFORE INSERT OR UPDATE ON items FOR EACH ROW EXECUTE PROCEDURE valid_price()

data/spec/annotated/manufacturer.rb

@@ -0,0 +1,12 @@
+class Manufacturer < Sequel::Model
+end
+
+# Table: manufacturers
+# Primary Key: (name, location)
+# Columns:
+#  name     | text |
+#  location | text |
+# Indexes:
+#  manufacturers_pkey | PRIMARY KEY btree (name, location)
+# Referenced By:
+#  items | items_manufacturer_name_fkey | (manufacturer_name, manufacturer_location) REFERENCES manufacturers(name, location)

data/spec/annotated/scategory.rb

@@ -0,0 +1,7 @@
+class SCategory < Sequel::Model(SDB[:categories])
+end
+
+# Table: categories
+# Columns:
+#  id   | integer      | PRIMARY KEY AUTOINCREMENT
+#  name | varchar(255) | NOT NULL

data/spec/annotated/sitem.rb

@@ -0,0 +1,18 @@
+class SItem < Sequel::Model(SDB[:items])
+end
+
+# Table: items
+# Columns:
+#  id                    | integer          | PRIMARY KEY AUTOINCREMENT
+#  category_id           | integer          | NOT NULL
+#  manufacturer_name     | varchar(50)      |
+#  manufacturer_location | varchar(255)     |
+#  in_stock              | boolean          | DEFAULT 0
+#  name                  | varchar(255)     | DEFAULT 'John'
+#  price                 | double precision | DEFAULT 0
+# Indexes:
+#  manufacturer_name | (manufacturer_name)
+#  name              | UNIQUE (manufacturer_name, manufacturer_location)
+# Foreign key constraints:
+#  (category_id) REFERENCES categories
+#  (manufacturer_name, manufacturer_location) REFERENCES manufacturers

data/spec/annotated/smanufacturer.rb

@@ -0,0 +1,8 @@
+class SManufacturer < Sequel::Model(SDB[:manufacturers])
+end
+
+# Table: manufacturers
+# Primary Key: (name, location)
+# Columns:
+#  name     | varchar(255) |
+#  location | varchar(255) |

data/spec/sequel-annotate_spec.rb

@@ -0,0 +1,181 @@
+require 'rubygems'
+require 'fileutils'
+require File.join(File.dirname(File.expand_path(__FILE__)), '../lib/sequel/annotate')
+require 'minitest/autorun'
+
+pg_user = ENV['PGUSER'] || 'postgres'
+db_name = ENV['SEQUEL_ANNOTATE_DB'] || 'sequel-annotate_spec'
+system("dropdb", "-U", pg_user, db_name)
+system("createdb", "-U", pg_user, db_name)
+DB = Sequel.postgres(db_name, :user=>pg_user)
+SDB = Sequel.sqlite
+
+[DB, SDB].each do |db|
+  db.create_table :categories do
+    primary_key :id
+    String :name, :unique=>true, :null=>false
+  end
+
+  db.create_table :manufacturers do
+    String :name
+    String :location
+    primary_key [:name, :location]
+  end
+
+  db.create_table :items do
+    primary_key :id
+    foreign_key :category_id, :categories, :null => false
+    foreign_key [:manufacturer_name, :manufacturer_location], :manufacturers
+
+    String :manufacturer_name, :size => 50
+    String :manufacturer_location
+    TrueClass :in_stock, :default => false
+    String :name, :default => "John"
+    Float  :price, :default => 0
+
+    constraint :pos_id, Sequel.expr(:id) > 0
+
+    index [:manufacturer_name, :manufacturer_location], :name=>:name, :unique=>true
+    index [:manufacturer_name], :name=>:manufacturer_name
+  end
+end
+
+DB.run <<SQL
+CREATE FUNCTION valid_price() RETURNS trigger AS $emp_stamp$
+    BEGIN
+        -- Check that empname and salary are given
+        IF NEW.price > 1000000 THEN
+            RAISE EXCEPTION 'price is too high';
+        END IF;
+        RETURN NEW;
+    END;
+$emp_stamp$ LANGUAGE plpgsql;
+SQL
+
+DB.run <<SQL
+CREATE TRIGGER valid_price BEFORE INSERT OR UPDATE ON items
+    FOR EACH ROW EXECUTE PROCEDURE valid_price();
+SQL
+
+class ::Item < Sequel::Model; end
+class ::Category < Sequel::Model; end
+class ::Manufacturer < Sequel::Model; end
+class ::SItem < Sequel::Model(SDB[:items]); end
+class ::SCategory < Sequel::Model(SDB[:categories]); end
+class ::SManufacturer < Sequel::Model(SDB[:manufacturers]); end
+
+
+describe Sequel::Annotate do
+  before do
+    File.mkdir('spec/tmp') unless File.directory?('spec/tmp')
+  end
+  after do
+    Dir['spec/tmp/*.rb'].each{|f| File.delete(f)}
+  end
+
+  it "#schema_info should return the model schema comment" do
+    Sequel::Annotate.new(Item).schema_comment.must_equal((<<OUTPUT).chomp)
+# Table: items
+# Columns:
+#  id                    | integer               | PRIMARY KEY DEFAULT nextval('items_id_seq'::regclass)
+#  category_id           | integer               | NOT NULL
+#  manufacturer_name     | character varying(50) |
+#  manufacturer_location | text                  |
+#  in_stock              | boolean               | DEFAULT false
+#  name                  | text                  | DEFAULT 'John'::text
+#  price                 | double precision      | DEFAULT 0
+# Indexes:
+#  items_pkey        | PRIMARY KEY btree (id)
+#  name              | UNIQUE btree (manufacturer_name, manufacturer_location)
+#  manufacturer_name | btree (manufacturer_name)
+# Check constraints:
+#  pos_id | (id > 0)
+# Foreign key constraints:
+#  items_category_id_fkey       | (category_id) REFERENCES categories(id)
+#  items_manufacturer_name_fkey | (manufacturer_name, manufacturer_location) REFERENCES manufacturers(name, location)
+# Triggers:
+#  valid_price | BEFORE INSERT OR UPDATE ON items FOR EACH ROW EXECUTE PROCEDURE valid_price()
+OUTPUT
+
+    Sequel::Annotate.new(Category).schema_comment.must_equal((<<OUTPUT).chomp)
+# Table: categories
+# Columns:
+#  id   | integer | PRIMARY KEY DEFAULT nextval('categories_id_seq'::regclass)
+#  name | text    | NOT NULL
+# Indexes:
+#  categories_pkey     | PRIMARY KEY btree (id)
+#  categories_name_key | UNIQUE btree (name)
+# Referenced By:
+#  items | items_category_id_fkey | (category_id) REFERENCES categories(id)
+OUTPUT
+
+    Sequel::Annotate.new(Manufacturer).schema_comment.must_equal((<<OUTPUT).chomp)
+# Table: manufacturers
+# Primary Key: (name, location)
+# Columns:
+#  name     | text |
+#  location | text |
+# Indexes:
+#  manufacturers_pkey | PRIMARY KEY btree (name, location)
+# Referenced By:
+#  items | items_manufacturer_name_fkey | (manufacturer_name, manufacturer_location) REFERENCES manufacturers(name, location)
+OUTPUT
+
+    Sequel::Annotate.new(SItem).schema_comment.must_equal((<<OUTPUT).chomp)
+# Table: items
+# Columns:
+#  id                    | integer          | PRIMARY KEY AUTOINCREMENT
+#  category_id           | integer          | NOT NULL
+#  manufacturer_name     | varchar(50)      |
+#  manufacturer_location | varchar(255)     |
+#  in_stock              | boolean          | DEFAULT 0
+#  name                  | varchar(255)     | DEFAULT 'John'
+#  price                 | double precision | DEFAULT 0
+# Indexes:
+#  manufacturer_name | (manufacturer_name)
+#  name              | UNIQUE (manufacturer_name, manufacturer_location)
+# Foreign key constraints:
+#  (category_id) REFERENCES categories
+#  (manufacturer_name, manufacturer_location) REFERENCES manufacturers
+OUTPUT
+
+    Sequel::Annotate.new(SCategory).schema_comment.must_equal((<<OUTPUT).chomp)
+# Table: categories
+# Columns:
+#  id   | integer      | PRIMARY KEY AUTOINCREMENT
+#  name | varchar(255) | NOT NULL
+OUTPUT
+
+    Sequel::Annotate.new(SManufacturer).schema_comment.must_equal((<<OUTPUT).chomp)
+# Table: manufacturers
+# Primary Key: (name, location)
+# Columns:
+#  name     | varchar(255) |
+#  location | varchar(255) |
+OUTPUT
+  end
+
+  it "#annotate should annotate the file comment" do
+    FileUtils.cp(Dir['spec/unannotated/*.rb'], 'spec/tmp')
+
+    [Item, Category, Manufacturer, SItem, SCategory, SManufacturer].each do |model|
+      filename = model.name.downcase
+      2.times do
+        Sequel::Annotate.new(model).annotate("spec/tmp/#{filename}.rb")
+        File.read("spec/tmp/#{filename}.rb").must_equal File.read("spec/annotated/#{filename}.rb")
+      end
+    end
+  end
+
+  it ".annotate should annotate all files given" do
+    FileUtils.cp(Dir['spec/unannotated/*.rb'], 'spec/tmp')
+
+    2.times do
+      Sequel::Annotate.annotate(Dir["spec/tmp/*.rb"])
+      [Item, Category, Manufacturer, SItem, SCategory, SManufacturer].each do |model|
+        filename = model.name.downcase
+        File.read("spec/tmp/#{filename}.rb").must_equal File.read("spec/annotated/#{filename}.rb")
+      end
+    end
+  end
+end

data/spec/unannotated/category.rb

@@ -0,0 +1,2 @@
+class Category < Sequel::Model
+end

data/spec/unannotated/item.rb

@@ -0,0 +1,3 @@
+class Item < Sequel::Model
+end
+

data/spec/unannotated/manufacturer.rb

@@ -0,0 +1,2 @@
+class Manufacturer < Sequel::Model
+end

data/spec/unannotated/scategory.rb

@@ -0,0 +1,2 @@
+class SCategory < Sequel::Model(SDB[:categories])
+end

data/spec/unannotated/sitem.rb

@@ -0,0 +1,3 @@
+class SItem < Sequel::Model(SDB[:items])
+end
+

data/spec/unannotated/smanufacturer.rb

@@ -0,0 +1,2 @@
+class SManufacturer < Sequel::Model(SDB[:manufacturers])
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: sequel-annotate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  sequel-annotate annotates Sequel models with schema information.  By
+  default, it includes information on columns, indexes, and foreign key
+  constraints for the current table.
+
+  On PostgreSQL, this includes more advanced information, including
+  check constraints, triggers, and foreign keys constraints for other
+  tables that reference the current table.
+email: code@jeremyevans.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG
+- MIT-LICENSE
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/sequel/annotate.rb
+- spec/annotated/category.rb
+- spec/annotated/item.rb
+- spec/annotated/manufacturer.rb
+- spec/annotated/scategory.rb
+- spec/annotated/sitem.rb
+- spec/annotated/smanufacturer.rb
+- spec/sequel-annotate_spec.rb
+- spec/unannotated/category.rb
+- spec/unannotated/item.rb
+- spec/unannotated/manufacturer.rb
+- spec/unannotated/scategory.rb
+- spec/unannotated/sitem.rb
+- spec/unannotated/smanufacturer.rb
+homepage: http://github.com/jeremyevans/sequel-annotate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- 'sequel-annotate: Annotate Sequel models with schema information'
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Annotate Sequel models with schema information
+test_files: []