annotate 2.4.0 → 2.4.1.beta1

data/README.rdoc

@@ -38,19 +38,27 @@ Also, if you pass the -r option, it'll annotate routes.rb with the output of "ra
 
 == INSTALL
 
-From rubyforge:
+Into Gemfile from Github:
+
+    gem 'annotate', :git => 'git://github.com/ctran/annotate_models.git'
+    
+
+Into environment gems From Rubygems.org:
 
   sudo gem install annotate
 
-From github:
+Into environment gems from Github checkout:
 
   git clone git://github.com/ctran/annotate_models.git annotate
   cd annotate
   rake gem
   sudo gem install pkg/annotate-*.gem
 
+
 == USAGE
 
+(If you used the Gemfile install, prefix the below commands with `bundle exec`.)
+
 To annotate all your models, tests, fixtures, etc.:
 
   cd /path/to/app
@@ -70,7 +78,7 @@ To annotate routes.rb:
 
 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.
+  [*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

data/Rakefile

@@ -0,0 +1,51 @@
+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,4 +1,5 @@
 --- 
   :major: 2
   :minor: 4
-  :patch: 0
+  :patch: 1
+  :build: 'beta1'

data/annotate.gemspec

@@ -0,0 +1,58 @@
+# 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/lib/annotate.rb

@@ -1,6 +1,8 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'yaml'
+
 module Annotate
   def self.version
     version_file = File.dirname(__FILE__) + "/../VERSION.yml"
@@ -14,6 +16,7 @@ module Annotate
   
   def self.load_tasks
     if File.exists?('Rakefile')
+      require 'rake'
       load 'Rakefile'
       Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
       return true

data/lib/annotate/annotate_models.rb

@@ -119,18 +119,24 @@ module AnnotateModels
         old_content = File.read(file_name)
 
         # Ignore the Schema version line because it changes with each migration
-        header = Regexp.new(/(^# Table name:.*?\n(#.*\n)*\n)/)
+        header = Regexp.new(/(^# Table name:.*?\n(#.*[\r]?\n)*[\r]?\n)/)
         old_header = old_content.match(header).to_s
         new_header = info_block.match(header).to_s
 
-        if old_header == new_header
+        old_columns = old_header && old_header.scan(/#[\t\s]+([\w\d]+)[\t\s]+\:([\d\w]+)/).sort
+        new_columns = new_header && new_header.scan(/#[\t\s]+([\w\d]+)[\t\s]+\:([\d\w]+)/).sort
+
+        if old_columns == new_columns
           false
         else
-          # Remove old schema info
-          old_content.sub!(/^# #{COMPAT_PREFIX}.*?\n(#.*\n)*\n/, '')
-
-          # Write it back
-          new_content = options[:position] == 'before' ?  (info_block + old_content) : (old_content + "\n" + info_block)
+          # Replace the old schema info with the new schema info
+          new_content = old_content.sub(/^# #{COMPAT_PREFIX}.*?\n(#.*\n)*\n/, info_block)
+          # But, if there *was* no old schema info, we simply need to insert it
+          if new_content == old_content
+            new_content = options[:position] == 'before' ?
+              (info_block + old_content) :
+              ((old_content =~ /\n$/ ? old_content : old_content + '\n') + info_block)
+          end
 
           File.open(file_name, "wb") { |f| f.puts new_content }
           true
@@ -228,12 +234,16 @@ module AnnotateModels
     # in subdirectories without namespacing.
     def get_model_class(file)
       require File.expand_path("#{model_dir}/#{file}") # this is for non-rails projects, which don't get Rails auto-require magic
-      model = file.gsub(/\.rb$/, '').camelize
+      model = ActiveSupport::Inflector.camelize(file.gsub(/\.rb$/, ''))
       parts = model.split('::')
       begin
         parts.inject(Object) {|klass, part| klass.const_get(part) }
       rescue LoadError, NameError
-        Object.const_get(parts.last)
+        begin
+          Object.const_get(parts.last)
+        rescue LoadError, NameError
+          Object.const_get(Module.constants.detect{|c|parts.last.downcase == c.downcase})
+        end
       end
     end
 

data/lib/tasks/annotate_models.rake

@@ -1,6 +1,6 @@
 desc "Add schema information (as comments) to model and fixture files"
 task :annotate_models => :environment do
-  require 'annotate/annotate_models'
+  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
@@ -14,7 +14,7 @@ end
 
 desc "Remove schema information from model and fixture files"
 task :remove_annotation => :environment do
-  require 'annotate/annotate_models'
+  require File.expand_path(File.join(File.dirname(__FILE__), '..', 'annotate', 'annotate_models'))
   options={}
   options[:model_dir] = ENV['model_dir']
   AnnotateModels.remove_annotations(options)

data/lib/tasks/annotate_routes.rake

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

data/spec/annotate/annotate_models_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 require 'annotate/annotate_models'
 require 'rubygems'
-require 'activesupport'
+require 'active_support'
 
 describe AnnotateModels do
 
@@ -69,6 +69,11 @@ EOS
           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")
@@ -78,6 +83,10 @@ EOS
       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

data/spec/spec_helper.rb

@@ -2,8 +2,8 @@ begin
   require 'spec'
 rescue LoadError
   require 'rubygems'
-  gem 'rspec'
-  require 'spec'
+  gem 'rspec-core'
+  require 'rspec'
 end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')

data/tasks/migrate.rake

@@ -11,7 +11,7 @@ namespace :db do
   end
 
   namespace :migrate do
-    [:up, :down, :reset, :redo].each do |t|
+    [:change, :up, :down, :reset, :redo].each do |t|
       task t do
         Annotate::Migration.update_annotations
       end

data/todo.txt

@@ -0,0 +1,5 @@
+TODO
+-----
+change default position back to "top" for all
+add "top" and "bottom" as synonyms for "before" and "after"
+change 'exclude' to 'only' (double negatives are not unconfusing)

metadata

@@ -1,35 +1,48 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: annotate
-version: !ruby/object:Gem::Version 
-  version: 2.4.0
+version: !ruby/object:Gem::Version
+  version: 2.4.1.beta1
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - Cuong Tran
 - Alex Chaffee
 - Marcos Piccinini
+- Turadg Aleahmad
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-12-13 00:00:00 -08:00
-default_executable: annotate
-dependencies: []
-
-description: Annotates Rails Models, routes, fixtures, and others based on the database schema.
-email: 
+date: 2011-09-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154511620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154511620
+description: When run, inserts table descriptions from db.schema into a comment block
+  of relevant source code.
+email:
 - alex@stinky.com
 - ctran@pragmaquest.com
 - x@nofxx.com
-executables: 
+- turadg@aleahmad.net
+executables:
 - annotate
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - History.txt
 - README.rdoc
+- Rakefile
 - VERSION.yml
+- annotate.gemspec
 - bin/annotate
 - lib/annotate.rb
 - lib/annotate/annotate_models.rb
@@ -42,36 +55,35 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/migrate.rake
-has_rdoc: true
-homepage: http://github.com/ctran/annotate
+- todo.txt
+homepage: http://github.com/ctran/annotate_models
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: annotate
-rubygems_version: 1.3.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Annotates Rails Models, routes, fixtures, and others based on the database schema.
-test_files: 
+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