annotated_models 3.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    annotated_models (3.0.0)
+      activesupport
+      annotated_models
+      i18n
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.4)
+    diff-lcs (1.1.2)
+    fakefs (0.3.1)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  annotated_models!
+  bundler
+  fakefs
+  i18n
+  jeweler
+  rcov
+  rspec

data/History.txt

@@ -0,0 +1,51 @@
+== 2.4.2 2009-11-21
+
+* Annotates (spec|test)/factories/<model>_factory.rb files
+
+== 2.4.1 2009-11-20
+
+* Annotates thoughtbot's factory_girl factories (test/factories/<model>_factory.rb)
+* Move default annotation position back to top
+
+== 2.4.0 2009-12-13
+
+* Incorporated lots of patches from the Github community, including support for Blueprints fixtures
+* Several bug fixes
+
+== 2.1 2009-10-18
+
+* New options
+  * -R to require additional files before loading the models
+  * -i to show database indexes in annotations
+  * -e to exclude annotating tests or fixtures
+  * -m to include the migration version number in the annotation
+  * --model-dir to annotate model files stored a different place than app/models  
+* Ignore unknown macros ('acts_as_whatever')
+
+== 2.0 2009-02-03
+
+* Add annotate_models plugin fork additions
+  * Annotates Rspec and Test Unit models
+  * Annotates Object Daddy exemplars
+  * Annotates geometrical columns
+* Add AnnotateRoutes rake task
+* Up gem structure to newgem defaults
+
+== 1.0.4 2008-09-04
+
+* Only update modified models since last run, thanks to sant0sk1
+
+== 1.0.3 2008-05-02
+
+* Add misc changes from Dustin Sallings and Henrik N
+  * Remove trailing whitespace
+  * More intuitive info messages
+  * Update README file with update-to-date example
+
+== 1.0.2 2008-03-22
+
+* Add contributions from Michael Bumann (http://github.com/bumi)
+  * added an option "position" to choose to put the annotation,
+  * spec/fixtures now also get annotated
+  * added a task to remove the annotations
+  * these options can be specified from command line as -d and -p [before|after]

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dmitry Lihachev
+
+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,145 @@
+== Annotate (aka AnnotatedModels)
+
+Add a comment summarizing the current schema to the top or bottom of each of your...
+
+  * ActiveRecord models
+  * Fixture files
+  * Tests and Specs
+  * Object Daddy exemplars
+  * Machinist blueprints
+  * Thoughtbot's factory_girl factories, i.e. the (spec|test)/factories/<model>_factory.rb files
+
+The schema comment looks like this:
+
+   # == Schema Info
+   #
+   # Table name: line_items
+   #
+   #  id                  :integer(11)    not null, primary key
+   #  quantity            :integer(11)    not null
+   #  product_id          :integer(11)    not null
+   #  unit_price          :float
+   #  order_id            :integer(11)
+   #
+
+    class LineItem < ActiveRecord::Base
+      belongs_to :product
+     . . .
+
+It also annotates geometrical columns, geom type and srid, when using SpatialAdapter or PostgisAdapter:
+
+   # == Schema Info
+   #
+   # Table name: trips
+   #
+   #  local           :geometry        point, 4326
+   #  path            :geometry        line_string, 4326
+
+Also, if you pass the -r option, it'll annotate routes.rb with the output of "rake routes".
+
+== INSTALL
+
+From rubyforge:
+
+  sudo gem install annotate
+
+From github:
+
+  git clone git://github.com/ctran/annotate_models.git annotate
+  cd annotate
+  gem build annotate.gemspec
+  sudo gem install annotate-<version>.gem
+
+== USAGE
+
+To annotate all your models, tests, fixtures, etc.:
+
+  cd /path/to/app
+  annotate
+
+To annotate your models and tests:
+
+  annotate --exclude fixtures
+
+To annotate just your models:
+
+  annotate --exclude tests,fixtures
+
+To annotate routes.rb:
+
+  annotate -r
+
+To automatically annotate after running 'rake db:migrate':
+
+  [needs more clarity] unpack the gem into vendor/plugins, or maybe vendor/gems, or maybe just require tasks/migrate.rake.
+
+If you install annotate_models as a plugin, it will automatically
+adjust your <tt>rake db:migrate</tt> tasks so that they update the
+annotations in your model files for you once the migration is
+completed.
+
+Warning: ImageMagick installs a tool called `annotate` too (if you're using MacPorts it's in `/opt/local/bin/annotate`. So if you see Usage: annotate imagein.jpg imageout.jpg then put `/usr/bin` ahead on the path and you'll get ours instead.
+
+
+== OPTIONS
+
+    Usage: annotate [options] [model_file]*
+        -d, --delete                     Remove annotations from all model files
+        -p, --position [before|after]    Place the annotations at the top (before) or the bottom (after) of the model file
+        -r, --routes                     Annotate routes.rb with the output of 'rake routes'
+        -v, --version                    Show the current version of this gem
+        -m, --show-migration             Include the migration version number in the annotation
+        -i, --show-indexes               List the table's database indexes in the annotation
+        -s, --simple-indexes             Concat the column's related indexes in the annotation
+            --model-dir dir              Annotate model files stored in dir rather than app/models
+        -R, --require path               Additional files to require before loading models
+        -e [tests,fixtures,factories]    Do not annotate fixtures, test files, and/or factories
+            --exclude
+
+
+== WARNING
+
+Note that this code will blow away the initial/final comment
+block in your models if it looks like it was previously added
+by annotate models, so you don't want to add additional text
+to an automatically created comment block.
+
+        * * Back up your model files before using... * *
+
+== LINKS
+
+* Factory Girl => http://github.com/thoughtbot/factory_girl
+* Object Daddy => http://github.com/flogic/object_daddy
+* SpatialAdapter => http://github.com/pdeffendol/spatial_adapter
+* PostgisAdapter => http://github.com/nofxx/postgis_adapter
+
+== LICENSE:
+
+Released under the same license as Ruby. No Support. No Warranty.
+
+== AUTHOR:
+
+Original code by: Dave Thomas -- Pragmatic Programmers, LLC
+Overhauled by: Alex Chaffee
+Gemmed by: Cuong Tran
+Maintained by: Alex Chaffee and Cuong Tran
+Homepage: http://github.com/ctran/annotate_models
+
+Modifications by:
+
+ - Alex Chaffee - http://github.com/alexch - alex@pivotallabs.com
+ - Cuong Tran - http://github.com/ctran - ctran@pragmaquest.com
+ - Jack Danger - http://github.com/JackDanger
+ - Michael Bumann - http://github.com/bumi
+ - Henrik Nyh - http://github.com/henrik
+ - Marcos Piccinini - http://github.com/nofxx
+ - Neal Clark - http://github.com/nclark
+ - Jacqui Maher - http://github.com/jacqui
+ - Nick Plante - http://github.com/zapnap - http://blog.zerosum.org
+ - Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com
+ - Bob Potter - http://github.com/bpot
+ - Gavin Montague - http://github.com/govan/
+ - Alexander Semyonov - http://github.com/rotuka/
+ - Nathan Brazil - http://github.com/bitaxis/
+
+and many others that I may have missed to add.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "annotated_models"
+  gem.homepage = "http://github.com/lda/annotated_models"
+  gem.license = "MIT"
+  gem.summary = %Q{Annotate ActiveRecord models as a gem}
+  gem.description = %Q{Add a comment summarizing the current schema to the top or bottom of each of your models}
+  gem.email = "lda@openteam.ru"
+  gem.authors = ["Dave Thomas", "Alex Chaffee", "Cuong Tran", "Alex Chaffee", "Dmitry Lihachev"]
+
+  gem.add_development_dependency(%q<bundler>, [">= 0"])
+  gem.add_development_dependency(%q<jeweler>, [">= 0"])
+  gem.add_development_dependency(%q<rcov>, [">= 0"])
+  gem.add_development_dependency(%q<fakefs>, [">= 0"])
+  gem.add_development_dependency(%q<rspec>, [">= 0"])
+
+  gem.add_runtime_dependency(%q<activesupport>, [">= 0"])
+  gem.add_runtime_dependency(%q<i18n>, [">= 0"])
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "annotated_models #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 3
+:minor: 0
+:patch: 0
+:build: 

data/annotated_models.gemspec

@@ -0,0 +1,120 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{annotated_models}
+  s.version = "3.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dave Thomas", "Alex Chaffee", "Cuong Tran", "Alex Chaffee", "Dmitry Lihachev"]
+  s.date = %q{2011-02-22}
+  s.default_executable = %q{annotate}
+  s.description = %q{Add a comment summarizing the current schema to the top or bottom of each of your models}
+  s.email = %q{lda@openteam.ru}
+  s.executables = ["annotate"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "History.txt",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "annotated_models.gemspec",
+    "bin/annotate",
+    "lib/annotated_models.rb",
+    "lib/tasks/annotate_models.rake",
+    "lib/tasks/migrate.rake",
+    "spec/annotate_models_spec.rb",
+    "spec/spec_helper.rb",
+    "todo.txt"
+  ]
+  s.homepage = %q{http://github.com/lda/annotated_models}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Annotate ActiveRecord models as a gem}
+  s.test_files = [
+    "spec/annotate_models_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<annotated_models>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+    else
+      s.add_dependency(%q<annotated_models>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<fakefs>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<fakefs>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<fakefs>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<annotated_models>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<fakefs>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<fakefs>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<fakefs>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+  end
+end
+

data/bin/annotate

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'annotate'
+
+task = :annotate_models
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: annotate [options] [model_file]*"
+
+  opts.on('-d', '--delete',
+          "Remove annotations from all model files") do
+    task = :remove_annotation
+  end
+
+  opts.on('-p', '--position [before|after]', ['before', 'after'],
+          "Place the annotations at the top (before) or the bottom (after) of the model file") do |p|
+    ENV['position'] = p
+  end
+
+  opts.on('-r', '--routes',
+          "Annotate routes.rb with the output of 'rake routes'") do
+    task = :annotate_routes
+  end
+
+  opts.on('-v', '--version',
+          "Show the current version of this gem") do
+    puts "annotate v#{Annotate.version}"; exit
+  end
+
+  opts.on('-m', '--show-migration',
+          "Include the migration version number in the annotation") do
+    ENV['include_version'] = "yes"
+  end
+
+  opts.on('-i', '--show-indexes',
+          "List the table's database indexes in the annotation") do
+    ENV['show_indexes'] = "yes"
+  end
+
+  opts.on('-s', '--simple-indexes',
+          "Concat the column's related indexes in the annotation") do
+    ENV['simple_indexes'] = "yes"
+  end
+
+  opts.on('--model-dir dir',
+          "Annotate model files stored in dir rather than app/models") do |dir|
+    ENV['model_dir'] = dir
+  end
+
+  opts.on('-R', '--require path',
+          "Additional files to require before loading models") do |path|
+    if ENV['require']
+      ENV['require'] = ENV['require'] + ",#{path}"
+    else
+      ENV['require'] = path
+    end
+  end
+
+  opts.on('-e', '--exclude [tests,fixtures]', Array, "Do not annotate fixtures, test files, or both") do |exclusions|
+    exclusions.each { |exclusion| ENV["exclude_#{exclusion}"] = "yes" }
+  end
+
+  opts.on('-f', '--format [bare|rdoc]', ['bare', 'rdoc'], 'rdoc: render Schema Infomation as RDoc') do |fmt|
+    ENV['format_#{fmt}'] = 'yes'
+  end
+
+end.parse!
+
+if Annotate.load_tasks
+  Rake::Task[task].invoke
+else
+  STDERR.puts "Can't find Rakefile. Are we in a Rails folder?"
+end