Skip to content

kennym/annotate-sequel

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

annotate-sequel

DEPRECATED: Please use the fork github.com/jeremyevans/sequel-annotate instead.

A gem to annotate your Sequel models.

Currently only tested for Rails 3 and only supports Sequel 3.x as of right now. Eventually this gem will support Sequel 4.

Example

The schema comment looks like this:

# Schema Info
#
# Table name: items
#
#  id :integer, {:allow_null=>false, :default=>nil, :primary_key=>true, :db_type=>"integer", :ruby_default=>nil}
#  name :string, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"varchar(255)", :ruby_default=>nil}
#  price :float, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"double precision", :ruby_default=>nil}
#

DB.create_table :items do
  primary_key :id
  String :name
  Float :price
end

class Item < Sequel::Model(:items)
end

Install

For the `Gemfile`

$ gem 'annotate-sequel'

Usage

In your Rails project run:

$ annotate

That's it.

TODO

  • Update models after migrations

Contributing to annotate-sequel

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

  • Fork the project.

  • Start a feature/bugfix branch.

  • Commit and push until you are happy with your contribution.

  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright © 2013-2016 Kenny Meyer. See LICENSE.txt for further details.

About

Annotate your Sequel models

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages