nofxx-annotate 2.3.1 → 2.3.2

data/VERSION

@@ -0,0 +1 @@
+2.3.2

data/annotate.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{annotate}
-  s.version = "2.3.1"
+  s.version = "2.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cuong Tran", "Marcos Piccinini"]
-  s.date = %q{2009-07-02}
+  s.date = %q{2009-08-21}
   s.default_executable = %q{annotate}
   s.email = %q{x@nofxx.com}
   s.executables = ["annotate"]
@@ -18,7 +21,7 @@ Gem::Specification.new do |s|
      "History.txt",
      "README.rdoc",
      "Rakefile",
-     "VERSION.yml",
+     "VERSION",
      "annotate.gemspec",
      "bin/annotate",
      "lib/annotate.rb",
@@ -35,7 +38,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/nofxx/annotate}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Annotates Rails Models, routes, and others}
   s.test_files = [
     "spec/annotate/annotate_models_spec.rb",

data/bin/annotate

@@ -7,13 +7,46 @@ task = :annotate_models
 
 OptionParser.new do |opts|
   opts.banner = "Usage: annotate [options]"
-  opts.on('-d', '--delete', "Remove annotations from all model files") { task = :remove_annotation }
-  opts.on('-p', '--position [before|after]', ['before', 'after'], "Place the annotations at the top (before) or the bottom (after) of the model file") { |p| ENV['position'] = p }
-  opts.on('-r', '--routes', "Annotate routes.rb with the output of 'rake routes'") { task = :annotate_routes }
-  opts.on('-v', '--version', "Show the current version of this gem") { puts "Annotate v#{Annotate::VERSION}"; exit }
-  opts.on('-m', '--show-migration', "Include the migration version number in the annotation") { ENV['include_version'] = "yes" }
-  opts.on('-i', '--show-indexes', "List the table's database indexes in the annotation") { ENV['show_indexes'] = "yes" }
-  opts.on('--model-dir dir', "Annotate model files stored in dir rather than app/models") {|dir| ENV['model_dir'] = dir }
+  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
 end.parse!
 
 if Annotate.load_tasks

data/lib/annotate/annotate_models.rb

@@ -8,10 +8,11 @@ module AnnotateModels
     # I dont use windows, can`t test
     UNIT_TEST_DIR     = File.join("test", "unit"  )
     SPEC_MODEL_DIR    = File.join("spec", "models")
+    EXEMPLARS_TEST_DIR     = File.join("test", "exemplars")
     # Object Daddy http://github.com/flogic/object_daddy/tree/master
-    EXEMPLARS_DIR     = File.join("spec", "exemplars")
+    EXEMPLARS_SPEC_DIR     = File.join("spec", "exemplars")
     # Machinist http://github.com/notahat/machinist
-    BLUEPRINT         = File.join("spec", "blueprint")
+    BLUEPRINTS_DIR         = File.join("test", "blueprints")
 
     def model_dir
       @model_dir || "app/models"
@@ -63,6 +64,17 @@ module AnnotateModels
           attrs << "#{col.geometry_type}, #{col.srid}"
         end
 
+        # Check if the column has indices and print "indexed" if true
+        # If the indice include another colum, print it too.
+        if options[:simple_indexes] # Check out if this column is indexed
+          indices = klass.connection.indexes(klass.table_name)
+          if indices = indices.select { |ind| ind.columns.include? col.name }
+            indices.each do |ind|
+              ind = ind.columns.reject! { |i| i == col.name }
+              attrs << (ind.length == 0 ? "indexed" : "indexed => [#{ind.join(", ")}]")
+            end
+          end
+        end
         info << sprintf("#  %-#{max_size}.#{max_size}s:%-15.15s %s", col.name, col_type, attrs.join(", ")).rstrip + "\n"
       end
 
@@ -152,9 +164,11 @@ module AnnotateModels
       end
 
       [
-        File.join(UNIT_TEST_DIR,      "#{model_name}_test.rb"), # test
-        File.join(SPEC_MODEL_DIR,     "#{model_name}_spec.rb"), # spec
-        File.join(EXEMPLARS_DIR,      "#{model_name}_exemplar.rb"),   # Object Daddy
+        File.join(UNIT_TEST_DIR,      "#{model_name}_test.rb"),      # test
+        File.join(SPEC_MODEL_DIR,     "#{model_name}_spec.rb"),      # spec
+        File.join(EXEMPLARS_TEST_DIR, "#{model_name}_exemplar.rb"),  # Object Daddy
+        File.join(EXEMPLARS_SPEC_DIR, "#{model_name}_exemplar.rb"),  # Object Daddy
+        File.join(BLUEPRINTS_DIR,     "#{model_name}_blueprint.rb"), # Machinist Blueprints
       ].each { |file| annotate_one_file(file, info) }
 
       FIXTURE_DIRS.each do |dir|
@@ -185,7 +199,7 @@ module AnnotateModels
     # Check for namespaced models in subdirectories as well as models
     # in subdirectories without namespacing.
     def get_model_class(file)
-      require "#{model_dir}/#{file}" # this is for non-rails projects, which don't get Rails auto-require magic
+      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
       parts = model.split('::')
       begin
@@ -198,8 +212,14 @@ module AnnotateModels
     # We're passed a name of things that might be
     # ActiveRecord models. If we can find the class, and
     # if its a subclass of ActiveRecord::Base,
-    # then pas it to the associated block
+    # then pass it to the associated block
     def do_annotations(options={})
+      if options[:require]
+        options[:require].each do |path|
+          require path
+        end
+      end
+
       header = PREFIX.dup
 
       if options[:include_version]
@@ -227,14 +247,13 @@ module AnnotateModels
         end
       end
       if annotated.empty?
-        puts "Nothing annotated!"
+        puts "Nothing annotated."
       else
         puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
       end
     end
 
     def remove_annotations(options={})
-      p options
       if options[:model_dir]
         puts "removing"
         self.model_dir = options[:model_dir]
@@ -262,3 +281,13 @@ module AnnotateModels
     end
   end
 end
+
+# monkey patches
+
+module ::ActiveRecord
+  class Base
+    def self.method_missing(name, *args)
+      # ignore this, so unknown/unloaded macros won't cause parsing to fail
+    end
+  end
+end

data/lib/tasks/annotate_models.rake

@@ -5,8 +5,10 @@ task :annotate_models => :environment do
   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']
   options[:model_dir] = ENV['model_dir']
   options[:include_version] = ENV['include_version']
+  options[:require] = ENV['require'].split(',') rescue []
   AnnotateModels.do_annotations(options)
 end
 

data/spec/annotate/annotate_models_spec.rb

@@ -1,5 +1,7 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 require 'annotate/annotate_models'
+require 'rubygems'
+require 'activesupport'
 
 describe AnnotateModels do
 
@@ -21,6 +23,7 @@ describe AnnotateModels do
   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"],
@@ -40,4 +43,41 @@ 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
+    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
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nofxx-annotate
 version: !ruby/object:Gem::Version 
-  version: 2.3.1
+  version: 2.3.2
 platform: ruby
 authors: 
 - Cuong Tran
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-02 00:00:00 -07:00
+date: 2009-08-21 00:00:00 -07:00
 default_executable: annotate
 dependencies: []
 
@@ -27,7 +27,7 @@ files:
 - History.txt
 - README.rdoc
 - Rakefile
-- VERSION.yml
+- VERSION
 - annotate.gemspec
 - bin/annotate
 - lib/annotate.rb
@@ -42,6 +42,7 @@ files:
 - spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/nofxx/annotate
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Annotates Rails Models, routes, and others

data/VERSION.yml

@@ -1,4 +0,0 @@
----
-:major: 2
-:minor: 3
-:patch: 1