annotate 2.4.1.beta1 → 2.5.0.pre1

data/lib/annotate/annotate_routes.rb

@@ -1,25 +1,25 @@
 # == Annotate Routes
-# 
+#
 # Based on:
-# 
-# 
+#
+#
 #
 # Prepends the output of "rake routes" to the top of your routes.rb file.
 # Yes, it's simple but I'm thick and often need a reminder of what my routes mean.
-# 
+#
 # Running this task will replace any exising route comment generated by the task.
 # Best to back up your routes file before running:
-# 
+#
 # Author:
 #  Gavin Montague
 #  gavin@leftbrained.co.uk
-#   
+#
 # Released under the same license as Ruby. No Support. No Warranty.module AnnotateRoutes
 #
-module AnnotateRoutes 
+module AnnotateRoutes
   PREFIX = "#== Route Map"
-  
-  def self.do_annotate 
+
+  def self.do_annotate
     routes_rb = File.join("config", "routes.rb")
     header = PREFIX + "\n# Generated on #{Time.now.strftime("%d %b %Y %H:%M")}\n#"
     if File.exists? routes_rb
@@ -29,8 +29,8 @@ module AnnotateRoutes
       routes_map = routes_map.inject(header){|sum, line| sum<<"\n# "<<line}
       content = File.read(routes_rb)
       content, old = content.split(/^#== Route .*?\n/)
-      File.open(routes_rb, "wb") do |f| 
-        f.puts content.sub!(/\n?\z/, "\n") + routes_map 
+      File.open(routes_rb, "wb") do |f|
+        f.puts content.sub!(/\n?\z/, "\n") + routes_map
       end
       puts "Route file annotated."
     else

data/lib/annotate/tasks.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'rake'
+
+# Make tasks visible for Rails also when used as gem.
+Dir[File.join(File.dirname(__FILE__), '..', 'tasks', '**/*.rake')].each { |rake| load rake }
+Dir[File.join(File.dirname(__FILE__), '..', '..', 'tasks', '**/*.rake')].each { |rake| load rake }

data/lib/annotate/version.rb

@@ -0,0 +1,5 @@
+module Annotate
+  def self.version
+    "2.5.0.pre1"
+  end
+end

data/lib/generators/annotate_models/USAGE

@@ -0,0 +1,4 @@
+Add a .rake file that automatically annotates models when you do a db:migrate
+in development mode:
+
+    rails generate annotate_models:install

data/lib/generators/annotate_models/install_generator.rb

@@ -0,0 +1,14 @@
+module AnnotateModels
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy annotate_models rakefiles for automatic annotation"
+      source_root File.expand_path('../templates', __FILE__)
+
+      # copy rake tasks
+      def copy_tasks
+        template "auto_annotate_models.rake", "lib/tasks/auto_annotate_models.rake"
+      end
+
+    end
+  end
+end

data/lib/generators/annotate_models/templates/auto_annotate_models.rake

@@ -0,0 +1,20 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if(Rails.env.development?)
+  task :set_annotation_options do
+    ENV['position_in_class']    = "before"
+    ENV['position_in_fixture']  = "before"
+    ENV['position_in_factory']  = "before"
+    ENV['show_indexes']         = "true"
+    ENV['include_version']      = "false"
+    ENV['exclude_tests']        = "false"
+    ENV['exclude_fixtures']     = "false"
+    ENV['ignore_model_sub_dir'] = "false"
+    ENV['skip_on_db_migrate']   = "false"
+    ENV['format_rdoc']          = "false"
+    ENV['format_markdown']      = "false"
+    ENV['no_sort']              = "false"
+    ENV['force']                = "false"
+  end
+end

data/lib/tasks/annotate_models.rake

@@ -1,21 +1,41 @@
+annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
+
+if(!ENV['is_cli'])
+  task :set_annotation_options
+  task :annotate_models => :set_annotation_options
+end
+
 desc "Add schema information (as comments) to model and fixture files"
 task :annotate_models => :environment do
-  require File.expand_path(File.join(File.dirname(__FILE__), '..', 'annotate', 'annotate_models'))
-  options={}
-  options[:position_in_class] = ENV['position_in_class'] || ENV['position'] || :before
-  options[:position_in_fixture] = ENV['position_in_fixture'] || ENV['position']  || :before
-  options[:show_indexes] = ENV['show_indexes']
-  options[:simple_indexes] = ENV['simple_indexes']
+  require "#{annotate_lib}/annotate/annotate_models"
+  require "#{annotate_lib}/annotate/active_record_patch"
+
+  true_re = /(true|t|yes|y|1)$/i
+
+  options={ :is_rake => true }
+  options[:position_in_class] = ENV['position_in_class'] || ENV['position'] || 'before'
+  options[:position_in_fixture] = ENV['position_in_fixture'] || ENV['position']  || 'before'
+  options[:position_in_factory] = ENV['position_in_factory'] || ENV['position'] || 'before'
+  options[:show_indexes] = ENV['show_indexes'] =~ true_re
+  options[:simple_indexes] = ENV['simple_indexes'] =~ true_re
   options[:model_dir] = ENV['model_dir']
-  options[:include_version] = ENV['include_version']
+  options[:include_version] = ENV['include_version'] =~ true_re
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  options[:exclude_tests] = ENV['exclude_tests'] =~ true_re
+  options[:exclude_fixtures] = ENV['exclude_fixtures'] =~ true_re
+  options[:ignore_model_sub_dir] = ENV['ignore_model_sub_dir'] =~ true_re
+  options[:format_rdoc] = ENV['format_rdoc'] =~ true_re
+  options[:format_markdown] = ENV['format_markdown'] =~ true_re
+  options[:no_sort] = ENV['no_sort'] =~ true_re
+  options[:force] = ENV['force'] =~ true_re
   AnnotateModels.do_annotations(options)
 end
 
 desc "Remove schema information from model and fixture files"
 task :remove_annotation => :environment do
-  require File.expand_path(File.join(File.dirname(__FILE__), '..', 'annotate', 'annotate_models'))
-  options={}
+  require "#{annotate_lib}/annotate/annotate_models"
+  require "#{annotate_lib}/annotate/active_record_patch"
+  options={ :is_rake => true }
   options[:model_dir] = ENV['model_dir']
   AnnotateModels.remove_annotations(options)
 end

data/lib/tasks/annotate_routes.rake

@@ -1,5 +1,6 @@
 desc "Prepends the route map to the top of routes.rb"
-task :annotate_routes do
-  require File.expand_path(File.join(File.dirname(__FILE__), '..', 'annotate', 'annotate_routes'))
+task :annotate_routes => :environment do
+  annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
+  require "#{annotate_lib}/annotate/annotate_routes"
   AnnotateRoutes.do_annotate
 end

data/tasks/migrate.rake

@@ -13,9 +13,9 @@ namespace :db do
   namespace :migrate do
     [:change, :up, :down, :reset, :redo].each do |t|
       task t do
-        Annotate::Migration.update_annotations
+        Annotate::Migration.update_annotations 
       end
-    end
+    end 
   end
 end
 
@@ -24,9 +24,9 @@ module Annotate
     @@working = false
 
     def self.update_annotations
-      unless @@working
+      unless @@working || (ENV['skip_on_db_migrate'] =~ /(true|t|yes|y|1)$/i)
         @@working = true
-        Rake::Task['annotate_models'].invoke
+        Rake::Task['annotate_models'].invoke 
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.4.1.beta1
+  version: 2.5.0.pre1
   prerelease: 6
 platform: ruby
 authors:
@@ -12,21 +12,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-02 00:00:00.000000000Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2154511620 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
-  version_requirements: *2154511620
-description: When run, inserts table descriptions from db.schema into a comment block
-  of relevant source code.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
+  on the database schema.
 email:
 - alex@stinky.com
 - ctran@pragmaquest.com
@@ -38,28 +43,27 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- History.txt
 - README.rdoc
-- Rakefile
-- VERSION.yml
-- annotate.gemspec
-- bin/annotate
-- lib/annotate.rb
+- History.txt
+- !binary |-
+  YmluL2Fubm90YXRl
+- lib/annotate/active_record_patch.rb
 - lib/annotate/annotate_models.rb
 - lib/annotate/annotate_routes.rb
+- lib/annotate/tasks.rb
+- lib/annotate/version.rb
+- lib/annotate.rb
+- lib/generators/annotate_models/install_generator.rb
+- lib/generators/annotate_models/templates/auto_annotate_models.rake
+- lib/generators/annotate_models/USAGE
 - lib/tasks/annotate_models.rake
 - lib/tasks/annotate_routes.rake
-- spec/annotate/annotate_models_spec.rb
-- spec/annotate/annotate_routes_spec.rb
-- spec/annotate_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
 - tasks/migrate.rake
-- todo.txt
 homepage: http://github.com/ctran/annotate_models
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -68,6 +72,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2416321078825126796
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -76,14 +83,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: annotate
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Annotates Rails models, routes, fixtures, and others based on the database
+summary: Annotates Rails Models, routes, fixtures, and others based on the database
   schema.
-test_files:
-- spec/annotate/annotate_models_spec.rb
-- spec/annotate/annotate_routes_spec.rb
-- spec/annotate_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+test_files: []

data/Rakefile

@@ -1,51 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-# want other tests/tasks run by default? Add them to the list
-task :default => [:spec]
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "annotate"
-  gem.summary = "Annotates Rails models, routes, fixtures, and others based on the database schema."
-  gem.description = "When run, inserts table descriptions from db.schema into a comment block of relevant source code."
-  gem.email = ["alex@stinky.com", 'ctran@pragmaquest.com', "x@nofxx.com", "turadg@aleahmad.net"]
-  gem.homepage = "http://github.com/ctran/annotate_models"
-  gem.authors = ['Cuong Tran', "Alex Chaffee", "Marcos Piccinini", "Turadg Aleahmad"]
-
-  gem.rubyforge_project = "annotate"
-
-  gem.add_development_dependency "rspec"
-
-  gem.test_files =  `git ls-files -- {spec,features}/*`.split("\n")
-  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.require_path = 'lib'
-  
-  # note that Jeweler automatically reads the version from VERSION.yml
-  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-end
-
-Jeweler::GemcutterTasks.new  
-
-
-require "rspec/core/rake_task" # RSpec 2.0
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'spec/*_spec.rb'
-  # TODO this leaves out the specs on the library itself
-end
-
-# FIXME not working yet
-RSpec::Core::RakeTask.new(:rcov) do |t|
-  t.pattern = 'spec/**/*_spec.rb'
-  t.rcov = true
-end
-
-# FIXME warns "already initialized constant Task"
-# FIXME throws "uninitialized constant RDoc::VISIBILITIES"
-# require 'rdoc/task'
-# RDoc::Task.new do |rdoc|
-#   rdoc.main = "README.rdoc"
-#   rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
-#   # require 'lib/annotate'
-#   # rdoc.title = "annotate #{Annotate.version}"
-# end

data/VERSION.yml

@@ -1,5 +0,0 @@
---- 
-  :major: 2
-  :minor: 4
-  :patch: 1
-  :build: 'beta1'

data/annotate.gemspec

@@ -1,58 +0,0 @@
-# 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 = "annotate"
-  s.version = "2.4.1.beta1"
-
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Cuong Tran", "Alex Chaffee", "Marcos Piccinini", "Turadg Aleahmad"]
-  s.date = "2011-09-02"
-  s.description = "When run, inserts table descriptions from db.schema into a comment block of relevant source code."
-  s.email = ["alex@stinky.com", "ctran@pragmaquest.com", "x@nofxx.com", "turadg@aleahmad.net"]
-  s.executables = ["annotate"]
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    "History.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION.yml",
-    "annotate.gemspec",
-    "bin/annotate",
-    "lib/annotate.rb",
-    "lib/annotate/annotate_models.rb",
-    "lib/annotate/annotate_routes.rb",
-    "lib/tasks/annotate_models.rake",
-    "lib/tasks/annotate_routes.rake",
-    "spec/annotate/annotate_models_spec.rb",
-    "spec/annotate/annotate_routes_spec.rb",
-    "spec/annotate_spec.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb",
-    "tasks/migrate.rake",
-    "todo.txt"
-  ]
-  s.homepage = "http://github.com/ctran/annotate_models"
-  s.require_paths = ["lib"]
-  s.rubyforge_project = "annotate"
-  s.rubygems_version = "1.8.10"
-  s.summary = "Annotates Rails models, routes, fixtures, and others based on the database schema."
-  s.test_files = ["spec/annotate/annotate_models_spec.rb", "spec/annotate/annotate_routes_spec.rb", "spec/annotate_spec.rb", "spec/spec.opts", "spec/spec_helper.rb"]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
-end
-

data/spec/annotate/annotate_models_spec.rb

@@ -1,92 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-require 'annotate/annotate_models'
-require 'rubygems'
-require 'active_support'
-
-describe AnnotateModels do
-
-  def mock_klass(stubs={})
-    @mock_file ||= mock("Klass", stubs)
-  end
-
-  def mock_column(stubs={})
-    @mock_column ||= mock("Column", stubs)
-  end
-
-  it { AnnotateModels.quote(nil).should eql("NULL") }
-  it { AnnotateModels.quote(true).should eql("TRUE") }
-  it { AnnotateModels.quote(false).should eql("FALSE") }
-  it { AnnotateModels.quote(25).should eql("25") }
-  it { AnnotateModels.quote(25.6).should eql("25.6") }
-  it { AnnotateModels.quote(1e-20).should eql("1.0e-20") }
-
-  it "should get schema info" do
-
-    AnnotateModels.get_schema_info(mock_klass(
-      :connection => mock("Conn", :indexes => []),
-      :table_name => "users",
-      :primary_key => "id",
-      :column_names => ["id","login"],
-      :columns => [
-        mock_column(:type => "integer", :default => nil, :null => false, :name => "id", :limit => nil),
-        mock_column(:type => "string", :default => nil, :null => false, :name => "name", :limit => 50)
-      ]), "Schema Info").should eql(<<-EOS)
-# Schema Info
-#
-# Table name: users
-#
-#  id    :integer         not null, primary key
-#  id    :integer         not null, primary key
-#
-
-EOS
-
-  end
-
-  describe "#get_model_class" do
-    module ::ActiveRecord
-      class Base
-      end
-    end
-
-    def create(file, body="hi")
-      File.open(@dir + '/' + file, "w") do |f|
-        f.puts(body)
-      end
-    end
-
-    before :all do
-      require "tmpdir"
-      @dir = Dir.tmpdir + "/#{Time.now.to_i}" + "/annotate_models"
-      FileUtils.mkdir_p(@dir)
-      AnnotateModels.model_dir = @dir
-      create('foo.rb', <<-EOS)
-        class Foo < ActiveRecord::Base
-        end
-      EOS
-      create('foo_with_macro.rb', <<-EOS)
-        class FooWithMacro < ActiveRecord::Base
-          acts_as_awesome :yah
-        end
-      EOS
-      create('foo_with_capitals.rb', <<-EOS)
-        class FooWithCAPITALS < ActiveRecord::Base
-          acts_as_awesome :yah
-        end
-      EOS
-    end
-    it "should work" do
-      klass = AnnotateModels.get_model_class("foo.rb")
-      klass.name.should == "Foo"
-    end
-    it "should not care about unknown macros" do
-      klass = AnnotateModels.get_model_class("foo_with_macro.rb")
-      klass.name.should == "FooWithMacro"
-    end
-    it "should find models with non standard capitalization" do
-      klass = AnnotateModels.get_model_class("foo_with_capitals.rb")
-      klass.name.should == "FooWithCAPITALS"
-    end
-  end
-
-end