annotate-sequel 1.0.0.final
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.document +5 -0
- data/.rspec +1 -0
- data/Gemfile +15 -0
- data/Gemfile.lock +80 -0
- data/LICENSE.txt +20 -0
- data/README.rdoc +64 -0
- data/Rakefile +51 -0
- data/annotate-sequel.gemspec +78 -0
- data/bin/annotate +20 -0
- data/lib/annotate-sequel.rb +23 -0
- data/lib/annotate_sequel/model.rb +125 -0
- data/lib/annotate_sequel/tasks.rb +6 -0
- data/lib/annotate_sequel/version.rb +10 -0
- data/lib/tasks/annotate_sequel.rake +8 -0
- data/spec/annotate-sequel_spec.rb +7 -0
- data/spec/annotate_sequel/model_spec.rb +34 -0
- data/spec/spec_helper.rb +13 -0
- metadata +175 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: ea02a9d3e5ef81c39076ca78c9c58faaada4058d
|
4
|
+
data.tar.gz: 34d3cc76a52e0b73dd76d0956fff151366a2a206
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b1c089492de8c7d3ff2f78ffe3cee3ac81eb8b474b1fb20c8f549ce45d37c2095fd47a20c27d86845659df4c00a3d5f9fe46b209a18183f4b1da4ea293ff8f4a
|
7
|
+
data.tar.gz: 333c77ebf71c69820ba8143b07f2124059d5e45b07832b08dcd4e41d50e1ed3cb46a326a801d8ca3422b1a532274d0ebbaf4b3d664bceef6c895266c7ef36eb7
|
data/.document
ADDED
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color
|
data/Gemfile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
source "http://rubygems.org"
|
2
|
+
|
3
|
+
gem 'sequel', '~> 3'
|
4
|
+
|
5
|
+
# Add dependencies to develop your gem here.
|
6
|
+
# Include everything needed to run rake, tests, features, etc.
|
7
|
+
group :development do
|
8
|
+
gem "rspec", "~> 2.8.0"
|
9
|
+
gem "rdoc", "~> 3.12"
|
10
|
+
gem "bundler", "~> 1.0"
|
11
|
+
gem "jeweler", "~> 1.8.7"
|
12
|
+
gem "simplecov", ">= 0"
|
13
|
+
gem "debugger", ">= 0"
|
14
|
+
gem "sqlite3"
|
15
|
+
end
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
GEM
|
2
|
+
remote: http://rubygems.org/
|
3
|
+
specs:
|
4
|
+
addressable (2.3.5)
|
5
|
+
builder (3.2.2)
|
6
|
+
columnize (0.3.6)
|
7
|
+
debugger (1.6.2)
|
8
|
+
columnize (>= 0.3.1)
|
9
|
+
debugger-linecache (~> 1.2.0)
|
10
|
+
debugger-ruby_core_source (~> 1.2.3)
|
11
|
+
debugger-linecache (1.2.0)
|
12
|
+
debugger-ruby_core_source (1.2.3)
|
13
|
+
diff-lcs (1.1.3)
|
14
|
+
faraday (0.8.8)
|
15
|
+
multipart-post (~> 1.2.0)
|
16
|
+
git (1.2.6)
|
17
|
+
github_api (0.10.1)
|
18
|
+
addressable
|
19
|
+
faraday (~> 0.8.1)
|
20
|
+
hashie (>= 1.2)
|
21
|
+
multi_json (~> 1.4)
|
22
|
+
nokogiri (~> 1.5.2)
|
23
|
+
oauth2
|
24
|
+
hashie (2.0.5)
|
25
|
+
highline (1.6.20)
|
26
|
+
httpauth (0.2.0)
|
27
|
+
jeweler (1.8.8)
|
28
|
+
builder
|
29
|
+
bundler (~> 1.0)
|
30
|
+
git (>= 1.2.5)
|
31
|
+
github_api (= 0.10.1)
|
32
|
+
highline (>= 1.6.15)
|
33
|
+
nokogiri (= 1.5.10)
|
34
|
+
rake
|
35
|
+
rdoc
|
36
|
+
json (1.8.1)
|
37
|
+
jwt (0.1.8)
|
38
|
+
multi_json (>= 1.5)
|
39
|
+
multi_json (1.8.2)
|
40
|
+
multi_xml (0.5.5)
|
41
|
+
multipart-post (1.2.0)
|
42
|
+
nokogiri (1.5.10)
|
43
|
+
oauth2 (0.9.2)
|
44
|
+
faraday (~> 0.8)
|
45
|
+
httpauth (~> 0.2)
|
46
|
+
jwt (~> 0.1.4)
|
47
|
+
multi_json (~> 1.0)
|
48
|
+
multi_xml (~> 0.5)
|
49
|
+
rack (~> 1.2)
|
50
|
+
rack (1.5.2)
|
51
|
+
rake (10.1.0)
|
52
|
+
rdoc (3.12.2)
|
53
|
+
json (~> 1.4)
|
54
|
+
rspec (2.8.0)
|
55
|
+
rspec-core (~> 2.8.0)
|
56
|
+
rspec-expectations (~> 2.8.0)
|
57
|
+
rspec-mocks (~> 2.8.0)
|
58
|
+
rspec-core (2.8.0)
|
59
|
+
rspec-expectations (2.8.0)
|
60
|
+
diff-lcs (~> 1.1.2)
|
61
|
+
rspec-mocks (2.8.0)
|
62
|
+
sequel (3.48.0)
|
63
|
+
simplecov (0.7.1)
|
64
|
+
multi_json (~> 1.0)
|
65
|
+
simplecov-html (~> 0.7.1)
|
66
|
+
simplecov-html (0.7.1)
|
67
|
+
sqlite3 (1.3.8)
|
68
|
+
|
69
|
+
PLATFORMS
|
70
|
+
ruby
|
71
|
+
|
72
|
+
DEPENDENCIES
|
73
|
+
bundler (~> 1.0)
|
74
|
+
debugger
|
75
|
+
jeweler (~> 1.8.7)
|
76
|
+
rdoc (~> 3.12)
|
77
|
+
rspec (~> 2.8.0)
|
78
|
+
sequel (~> 3)
|
79
|
+
simplecov
|
80
|
+
sqlite3
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2013 Kenny Meyer
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
= annotate-sequel
|
2
|
+
|
3
|
+
A gem to annotate your Sequel models.
|
4
|
+
|
5
|
+
== DISCLAIMER: Not ready for production, yet
|
6
|
+
|
7
|
+
Currently only tested for Rails 3 and only supports Sequel 3.x as of right now.
|
8
|
+
Eventually this gem will support Sequel 4.
|
9
|
+
|
10
|
+
== Example
|
11
|
+
|
12
|
+
The schema comment looks like this:
|
13
|
+
|
14
|
+
# Schema Info
|
15
|
+
#
|
16
|
+
# Table name: items
|
17
|
+
#
|
18
|
+
# id :integer, {:allow_null=>false, :default=>nil, :primary_key=>true, :db_type=>"integer", :ruby_default=>nil}
|
19
|
+
# name :string, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"varchar(255)", :ruby_default=>nil}
|
20
|
+
# price :float, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"double precision", :ruby_default=>nil}
|
21
|
+
#
|
22
|
+
|
23
|
+
DB.create_table :items do
|
24
|
+
primary_key :id
|
25
|
+
String :name
|
26
|
+
Float :price
|
27
|
+
end
|
28
|
+
|
29
|
+
class Item < Sequel::Model(:items)
|
30
|
+
end
|
31
|
+
|
32
|
+
== Install
|
33
|
+
|
34
|
+
For the `Gemfile`
|
35
|
+
|
36
|
+
$ gem 'annotate-sequel'
|
37
|
+
|
38
|
+
== Usage
|
39
|
+
|
40
|
+
In your Rails project run:
|
41
|
+
|
42
|
+
$ annotate
|
43
|
+
|
44
|
+
That's it.
|
45
|
+
|
46
|
+
== TODO
|
47
|
+
|
48
|
+
* Update models after migrations
|
49
|
+
|
50
|
+
== Contributing to annotate-sequel
|
51
|
+
|
52
|
+
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
|
53
|
+
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
|
54
|
+
* Fork the project.
|
55
|
+
* Start a feature/bugfix branch.
|
56
|
+
* Commit and push until you are happy with your contribution.
|
57
|
+
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
|
58
|
+
* 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.
|
59
|
+
|
60
|
+
== Copyright
|
61
|
+
|
62
|
+
Copyright (c) 2013 Kenny Meyer. See LICENSE.txt for
|
63
|
+
further details.
|
64
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
require 'rubygems'
|
4
|
+
require 'bundler'
|
5
|
+
begin
|
6
|
+
Bundler.setup(:default, :development)
|
7
|
+
rescue Bundler::BundlerError => e
|
8
|
+
$stderr.puts e.message
|
9
|
+
$stderr.puts "Run `bundle install` to install missing gems"
|
10
|
+
exit e.status_code
|
11
|
+
end
|
12
|
+
require 'rake'
|
13
|
+
|
14
|
+
require 'jeweler'
|
15
|
+
require './lib/annotate-sequel'
|
16
|
+
Jeweler::Tasks.new do |gem|
|
17
|
+
# gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
|
18
|
+
gem.name = "annotate-sequel"
|
19
|
+
gem.homepage = "http://github.com/kennym/annotate-sequel"
|
20
|
+
gem.license = "MIT"
|
21
|
+
gem.summary = %Q{Annotate Sequel models}
|
22
|
+
gem.description = %Q{Annotate Sequel models}
|
23
|
+
gem.email = "kenny@kennymeyer.net"
|
24
|
+
gem.authors = ["Kenny Meyer"]
|
25
|
+
gem.version = AnnotateSequel::Version::STRING
|
26
|
+
# dependencies defined in Gemfile
|
27
|
+
end
|
28
|
+
Jeweler::RubygemsDotOrgTasks.new
|
29
|
+
|
30
|
+
require 'rspec/core'
|
31
|
+
require 'rspec/core/rake_task'
|
32
|
+
RSpec::Core::RakeTask.new(:spec) do |spec|
|
33
|
+
spec.pattern = FileList['spec/**/*_spec.rb']
|
34
|
+
end
|
35
|
+
|
36
|
+
RSpec::Core::RakeTask.new(:rcov) do |spec|
|
37
|
+
spec.pattern = 'spec/**/*_spec.rb'
|
38
|
+
spec.rcov = true
|
39
|
+
end
|
40
|
+
|
41
|
+
task :default => :spec
|
42
|
+
|
43
|
+
require 'rdoc/task'
|
44
|
+
Rake::RDocTask.new do |rdoc|
|
45
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
46
|
+
|
47
|
+
rdoc.rdoc_dir = 'rdoc'
|
48
|
+
rdoc.title = "annotate-sequel #{version}"
|
49
|
+
rdoc.rdoc_files.include('README*')
|
50
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
51
|
+
end
|
@@ -0,0 +1,78 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
|
4
|
+
# -*- encoding: utf-8 -*-
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = "annotate-sequel"
|
8
|
+
s.version = "1.0.0.final"
|
9
|
+
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
|
11
|
+
s.authors = ["Kenny Meyer"]
|
12
|
+
s.date = "2013-11-14"
|
13
|
+
s.description = "Annotate Sequel models"
|
14
|
+
s.email = "kenny@kennymeyer.net"
|
15
|
+
s.executables = ["annotate"]
|
16
|
+
s.extra_rdoc_files = [
|
17
|
+
"LICENSE.txt",
|
18
|
+
"README.rdoc"
|
19
|
+
]
|
20
|
+
s.files = [
|
21
|
+
".document",
|
22
|
+
".rspec",
|
23
|
+
"Gemfile",
|
24
|
+
"Gemfile.lock",
|
25
|
+
"LICENSE.txt",
|
26
|
+
"README.rdoc",
|
27
|
+
"Rakefile",
|
28
|
+
"annotate-sequel.gemspec",
|
29
|
+
"bin/annotate",
|
30
|
+
"lib/annotate-sequel.rb",
|
31
|
+
"lib/annotate_sequel/model.rb",
|
32
|
+
"lib/annotate_sequel/tasks.rb",
|
33
|
+
"lib/annotate_sequel/version.rb",
|
34
|
+
"lib/tasks/annotate_sequel.rake",
|
35
|
+
"spec/annotate-sequel_spec.rb",
|
36
|
+
"spec/annotate_sequel/model_spec.rb",
|
37
|
+
"spec/spec_helper.rb"
|
38
|
+
]
|
39
|
+
s.homepage = "http://github.com/kennym/annotate-sequel"
|
40
|
+
s.licenses = ["MIT"]
|
41
|
+
s.require_paths = ["lib"]
|
42
|
+
s.rubygems_version = "2.0.6"
|
43
|
+
s.summary = "Annotate Sequel models"
|
44
|
+
|
45
|
+
if s.respond_to? :specification_version then
|
46
|
+
s.specification_version = 4
|
47
|
+
|
48
|
+
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
49
|
+
s.add_runtime_dependency(%q<sequel>, ["~> 3"])
|
50
|
+
s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
|
51
|
+
s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
|
52
|
+
s.add_development_dependency(%q<bundler>, ["~> 1.0"])
|
53
|
+
s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
|
54
|
+
s.add_development_dependency(%q<simplecov>, [">= 0"])
|
55
|
+
s.add_development_dependency(%q<debugger>, [">= 0"])
|
56
|
+
s.add_development_dependency(%q<sqlite3>, [">= 0"])
|
57
|
+
else
|
58
|
+
s.add_dependency(%q<sequel>, ["~> 3"])
|
59
|
+
s.add_dependency(%q<rspec>, ["~> 2.8.0"])
|
60
|
+
s.add_dependency(%q<rdoc>, ["~> 3.12"])
|
61
|
+
s.add_dependency(%q<bundler>, ["~> 1.0"])
|
62
|
+
s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
|
63
|
+
s.add_dependency(%q<simplecov>, [">= 0"])
|
64
|
+
s.add_dependency(%q<debugger>, [">= 0"])
|
65
|
+
s.add_dependency(%q<sqlite3>, [">= 0"])
|
66
|
+
end
|
67
|
+
else
|
68
|
+
s.add_dependency(%q<sequel>, ["~> 3"])
|
69
|
+
s.add_dependency(%q<rspec>, ["~> 2.8.0"])
|
70
|
+
s.add_dependency(%q<rdoc>, ["~> 3.12"])
|
71
|
+
s.add_dependency(%q<bundler>, ["~> 1.0"])
|
72
|
+
s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
|
73
|
+
s.add_dependency(%q<simplecov>, [">= 0"])
|
74
|
+
s.add_dependency(%q<debugger>, [">= 0"])
|
75
|
+
s.add_dependency(%q<sqlite3>, [">= 0"])
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
data/bin/annotate
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
require 'rubygems'
|
3
|
+
require 'annotate-sequel'
|
4
|
+
begin
|
5
|
+
require 'bundler'
|
6
|
+
Bundler.setup
|
7
|
+
rescue Exception => e
|
8
|
+
puts e.backtrace
|
9
|
+
end
|
10
|
+
|
11
|
+
here = File.expand_path(File.dirname __FILE__)
|
12
|
+
$:<< "#{here}/../lib"
|
13
|
+
|
14
|
+
require File.expand_path('config/environment')
|
15
|
+
target = {
|
16
|
+
:klass => AnnotateSequel::Model,
|
17
|
+
:task => :do_annotations,
|
18
|
+
}
|
19
|
+
|
20
|
+
target[:klass].send(target[:task])
|
@@ -0,0 +1,23 @@
|
|
1
|
+
$:.unshift(File.dirname(__FILE__))
|
2
|
+
|
3
|
+
require 'annotate_sequel/version'
|
4
|
+
require 'annotate_sequel/model'
|
5
|
+
|
6
|
+
module Annotate
|
7
|
+
def self.loaded_tasks=(val); @loaded_tasks = val; end
|
8
|
+
def self.loaded_tasks; return @loaded_tasks; end
|
9
|
+
|
10
|
+
def self.load_tasks
|
11
|
+
return if(self.loaded_tasks)
|
12
|
+
self.loaded_tasks = true
|
13
|
+
Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
|
14
|
+
end
|
15
|
+
|
16
|
+
def self.bootstrap_rake
|
17
|
+
if File.exists?("./Rakefile")
|
18
|
+
load "./Rakefile"
|
19
|
+
end
|
20
|
+
Rake::Task[:environment].invoke rescue nil
|
21
|
+
self.load_tasks
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,125 @@
|
|
1
|
+
class AnnotateSequel
|
2
|
+
COMPAT_PREFIX = "== Schema Info"
|
3
|
+
PATTERN = /^\n?# (?:#{COMPAT_PREFIX}).*?\n(#.*\n)*\n*/
|
4
|
+
module Model
|
5
|
+
class << self
|
6
|
+
def model_dir
|
7
|
+
@model_dir || "app/models"
|
8
|
+
end
|
9
|
+
|
10
|
+
def model_dir=(dir)
|
11
|
+
@model_dir = dir
|
12
|
+
end
|
13
|
+
|
14
|
+
def schema_info(klass)
|
15
|
+
|
16
|
+
info = "# Schema Info\n"
|
17
|
+
info << "# \n"
|
18
|
+
info << "# Table name: #{klass.table_name}\n"
|
19
|
+
info << "# \n"
|
20
|
+
|
21
|
+
klass.db_schema.each do |key, value|
|
22
|
+
type = value.delete(:type)
|
23
|
+
info << "# #{key} :#{type}, #{value}\n"
|
24
|
+
end
|
25
|
+
info << "# \n"
|
26
|
+
end
|
27
|
+
|
28
|
+
def get_model_files
|
29
|
+
models = []
|
30
|
+
begin
|
31
|
+
Dir.chdir(@model_dir) do
|
32
|
+
models = Dir["**/*.rb"]
|
33
|
+
end
|
34
|
+
rescue SystemCallError
|
35
|
+
puts "No models found in directory '#{model_dir}'."
|
36
|
+
exit 1
|
37
|
+
end
|
38
|
+
models
|
39
|
+
end
|
40
|
+
|
41
|
+
def get_model_class(file)
|
42
|
+
require File.expand_path("#{model_dir}/#{file}")
|
43
|
+
model_path = file.gsub(/\.rb$/, '')
|
44
|
+
get_loaded_model(model_path) || get_loaded_model(model_path.split("/").last)
|
45
|
+
end
|
46
|
+
|
47
|
+
def get_loaded_model(model_path)
|
48
|
+
ObjectSpace.each_object(::Class).
|
49
|
+
select do |c|
|
50
|
+
Class === c and
|
51
|
+
c.ancestors.respond_to?(:include?) and
|
52
|
+
c.ancestors.include?(Sequel::Model)
|
53
|
+
end.
|
54
|
+
detect { |c| underscore(c.name) == model_path }
|
55
|
+
end
|
56
|
+
|
57
|
+
def annotate_model_file(annotated, file)
|
58
|
+
begin
|
59
|
+
klass = get_model_class(file)
|
60
|
+
if klass && klass < Sequel::Model
|
61
|
+
if annotate(klass, file)
|
62
|
+
annotated << klass
|
63
|
+
end
|
64
|
+
end
|
65
|
+
rescue Exception => e
|
66
|
+
puts "Unable to annotate #{file}: #{e.message}"
|
67
|
+
puts "\t" + e.backtrace.join("\n\t")
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
def do_annotations
|
72
|
+
annotated = []
|
73
|
+
get_model_files.each do |file|
|
74
|
+
annotate_model_file(annotated, file)
|
75
|
+
end
|
76
|
+
if annotated.empty?
|
77
|
+
puts "Nothing annotated"
|
78
|
+
else
|
79
|
+
puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
def annotate_one_file(file_name, info_block)
|
84
|
+
if File.exist?(file_name)
|
85
|
+
old_content = File.read(file_name)
|
86
|
+
|
87
|
+
header_pattern = /(^# Table name:.*?\n(#.*[\r]?\n)*[\r]?)/
|
88
|
+
old_header = old_content.match(header_pattern).to_s
|
89
|
+
new_header = info_block.match(header_pattern).to_s
|
90
|
+
|
91
|
+
column_pattern = /^#[\t ]+\w+[\t ]+.+$/
|
92
|
+
old_columns = old_header && old_header.scan(column_pattern).sort
|
93
|
+
new_columns = new_header && new_header.scan(column_pattern).sort
|
94
|
+
if old_columns == new_columns
|
95
|
+
return false
|
96
|
+
end
|
97
|
+
|
98
|
+
old_content.sub!(PATTERN, '')
|
99
|
+
new_content = info_block + "\n" + old_content
|
100
|
+
|
101
|
+
File.open(file_name, "wb") { |f| f.puts new_content }
|
102
|
+
return true
|
103
|
+
else
|
104
|
+
return false
|
105
|
+
end
|
106
|
+
end
|
107
|
+
|
108
|
+
def annotate(klass, file)
|
109
|
+
begin
|
110
|
+
info = schema_info(klass)
|
111
|
+
did_annotate = false
|
112
|
+
model_file_name = File.join(model_dir, file)
|
113
|
+
|
114
|
+
if annotate_one_file(model_file_name, info)
|
115
|
+
did_annotate = true
|
116
|
+
end
|
117
|
+
|
118
|
+
return did_annotate
|
119
|
+
rescue Exception => e
|
120
|
+
puts "Unable to annotate #{file}: #{e.message}"
|
121
|
+
end
|
122
|
+
end
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
@@ -0,0 +1,6 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
# Make tasks visible for Rails also when used as gem.
|
5
|
+
Dir[File.join(File.dirname(__FILE__), '..', 'tasks', '**/*.rake')].each { |rake| load rake }
|
6
|
+
Dir[File.join(File.dirname(__FILE__), '..', '..', 'tasks', '**/*.rake')].each { |rake| load rake }
|
@@ -0,0 +1,34 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe AnnotateSequel::Model do
|
4
|
+
describe ".schema_info(klass)" do
|
5
|
+
before(:each) do
|
6
|
+
@DB = Sequel.sqlite
|
7
|
+
@DB.create_table :items do
|
8
|
+
primary_key :id
|
9
|
+
String :name
|
10
|
+
Float :price
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
let(:klass) {
|
15
|
+
class Item < Sequel::Model(:items)
|
16
|
+
end
|
17
|
+
Item
|
18
|
+
}
|
19
|
+
it "should return the model schema" do
|
20
|
+
AnnotateSequel::Model.schema_info(klass).should eql(<<-EOS)
|
21
|
+
# Schema Info
|
22
|
+
#
|
23
|
+
# Table name: items
|
24
|
+
#
|
25
|
+
# id :integer, {:allow_null=>false, :default=>nil, :primary_key=>true, :db_type=>"integer", :ruby_default=>nil}
|
26
|
+
# name :string, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"varchar(255)", :ruby_default=>nil}
|
27
|
+
# price :float, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"double precision", :ruby_default=>nil}
|
28
|
+
#
|
29
|
+
EOS
|
30
|
+
end
|
31
|
+
|
32
|
+
it "should support indexes"
|
33
|
+
end
|
34
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
2
|
+
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
3
|
+
require 'rspec'
|
4
|
+
require 'annotate-sequel'
|
5
|
+
require 'sequel'
|
6
|
+
|
7
|
+
# Requires supporting files with custom matchers and macros, etc,
|
8
|
+
# in ./support/ and its subdirectories.
|
9
|
+
Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
|
10
|
+
|
11
|
+
RSpec.configure do |config|
|
12
|
+
|
13
|
+
end
|
metadata
ADDED
@@ -0,0 +1,175 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: annotate-sequel
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0.final
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kenny Meyer
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-11-14 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: sequel
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rspec
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ~>
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 2.8.0
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ~>
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 2.8.0
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rdoc
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ~>
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.12'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ~>
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.12'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: bundler
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ~>
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ~>
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: jeweler
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ~>
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: 1.8.7
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ~>
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 1.8.7
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: simplecov
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - '>='
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - '>='
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: debugger
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - '>='
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - '>='
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: sqlite3
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - '>='
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - '>='
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
description: Annotate Sequel models
|
126
|
+
email: kenny@kennymeyer.net
|
127
|
+
executables:
|
128
|
+
- annotate
|
129
|
+
extensions: []
|
130
|
+
extra_rdoc_files:
|
131
|
+
- LICENSE.txt
|
132
|
+
- README.rdoc
|
133
|
+
files:
|
134
|
+
- .document
|
135
|
+
- .rspec
|
136
|
+
- Gemfile
|
137
|
+
- Gemfile.lock
|
138
|
+
- LICENSE.txt
|
139
|
+
- README.rdoc
|
140
|
+
- Rakefile
|
141
|
+
- annotate-sequel.gemspec
|
142
|
+
- bin/annotate
|
143
|
+
- lib/annotate-sequel.rb
|
144
|
+
- lib/annotate_sequel/model.rb
|
145
|
+
- lib/annotate_sequel/tasks.rb
|
146
|
+
- lib/annotate_sequel/version.rb
|
147
|
+
- lib/tasks/annotate_sequel.rake
|
148
|
+
- spec/annotate-sequel_spec.rb
|
149
|
+
- spec/annotate_sequel/model_spec.rb
|
150
|
+
- spec/spec_helper.rb
|
151
|
+
homepage: http://github.com/kennym/annotate-sequel
|
152
|
+
licenses:
|
153
|
+
- MIT
|
154
|
+
metadata: {}
|
155
|
+
post_install_message:
|
156
|
+
rdoc_options: []
|
157
|
+
require_paths:
|
158
|
+
- lib
|
159
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
160
|
+
requirements:
|
161
|
+
- - '>='
|
162
|
+
- !ruby/object:Gem::Version
|
163
|
+
version: '0'
|
164
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
165
|
+
requirements:
|
166
|
+
- - '>'
|
167
|
+
- !ruby/object:Gem::Version
|
168
|
+
version: 1.3.1
|
169
|
+
requirements: []
|
170
|
+
rubyforge_project:
|
171
|
+
rubygems_version: 2.0.6
|
172
|
+
signing_key:
|
173
|
+
specification_version: 4
|
174
|
+
summary: Annotate Sequel models
|
175
|
+
test_files: []
|