nofxx-annotate 2.1.1 → 2.2.2

data/Manifest.txt

@@ -5,17 +5,17 @@ README.rdoc
 Rakefile
 annotate.gemspec
 bin/annotate
-config/hoe.rb
-config/requirements.rb
 lib/annotate.rb
-lib/annotate_models/annotate_models.rb
-lib/annotate_routes/annotate_routes.rb
+lib/annotate/annotate_models.rb
+lib/annotate/annotate_routes.rb
 lib/tasks/annotate_models.rake
 lib/tasks/annotate_routes.rake
 script/console
 script/destroy
 script/generate
 setup.rb
+spec/annotate/annotate_models_spec.rb
+spec/annotate/annotate_routes_spec.rb
 spec/annotate_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
@@ -27,17 +27,17 @@ README.rdoc
 Rakefile
 annotate.gemspec
 bin/annotate
-config/hoe.rb
-config/requirements.rb
 lib/annotate.rb
-lib/annotate_models/annotate_models.rb
-lib/annotate_routes/annotate_routes.rb
+lib/annotate/annotate_models.rb
+lib/annotate/annotate_routes.rb
 lib/tasks/annotate_models.rake
 lib/tasks/annotate_routes.rake
 script/console
 script/destroy
 script/generate
 setup.rb
+spec/annotate/annotate_models_spec.rb
+spec/annotate/annotate_routes_spec.rb
 spec/annotate_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
@@ -49,17 +49,17 @@ README.rdoc
 Rakefile
 annotate.gemspec
 bin/annotate
-config/hoe.rb
-config/requirements.rb
 lib/annotate.rb
-lib/annotate_models/annotate_models.rb
-lib/annotate_routes/annotate_routes.rb
+lib/annotate/annotate_models.rb
+lib/annotate/annotate_routes.rb
 lib/tasks/annotate_models.rake
 lib/tasks/annotate_routes.rake
 script/console
 script/destroy
 script/generate
 setup.rb
+spec/annotate/annotate_models_spec.rb
+spec/annotate/annotate_routes_spec.rb
 spec/annotate_spec.rb
 spec/spec.opts
 spec/spec_helper.rb

data/annotate.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{annotate}
-  s.version = "2.1.1"
+  s.version = "2.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcos Piccinini"]
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.email = ["x@nofxx.com"]
   s.executables = ["annotate"]
   s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "README.rdoc"]
-  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.rdoc", "Rakefile", "annotate.gemspec", "bin/annotate", "config/hoe.rb", "config/requirements.rb", "lib/annotate.rb", "lib/annotate_models/annotate_models.rb", "lib/annotate_routes/annotate_routes.rb", "lib/tasks/annotate_models.rake", "lib/tasks/annotate_routes.rake", "script/console", "script/destroy", "script/generate", "setup.rb", "spec/annotate_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.rdoc", "Rakefile", "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", "script/console", "script/destroy", "script/generate", "setup.rb", "spec/annotate/annotate_models_spec.rb", "spec/annotate/annotate_routes_spec.rb", "spec/annotate_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/nofxx/annotate}
   s.rdoc_options = ["--main", "README.rdoc"]

data/lib/{annotate_models → annotate}/annotate_models.rb

@@ -1,14 +1,18 @@
 module AnnotateModels
   class << self
+    # Annotate Models plugin use this header
+    COMPAT_PREFIX = "== Schema Info"
+    PREFIX = "== Schema Information"
+    
     MODEL_DIR   = "app/models"
     FIXTURE_DIRS = ["test/fixtures","spec/fixtures"]
-    UNIT_TEST_DIR     = File.join(RAILS_ROOT, "test/unit"  )
-    SPEC_MODEL_DIR    = File.join(RAILS_ROOT, "spec/models")
+    # File.join for windows reverse bar compat?
+    # I dont use windows, can`t test
+    UNIT_TEST_DIR     = File.join("test", "unit"  )
+    SPEC_MODEL_DIR    = File.join("spec", "models")
     # Object Daddy http://github.com/flogic/object_daddy/tree/master
-    EXEMPLARS_DIR     = File.join(RAILS_ROOT, "spec/exemplars")
-    PREFIX = "== Schema Information"
-    # Annotate Models as plugin use this header
-    COMPAT_PREFIX = "== Schema Info"
+    EXEMPLARS_DIR     = File.join("spec", "exemplars")
+    
 
     # Simple quoting for the default column value
     def quote(value)

data/lib/{annotate_routes → annotate}/annotate_routes.rb

@@ -20,8 +20,8 @@ module AnnotateRoutes
   PREFIX = "#== Route Info"
   
   def self.do_annotate 
-    routes_rb = File.join(RAILS_ROOT, "config/routes.rb")
-    header = PREFIX + "\n# Generated on #{Time.now}"
+    routes_rb = File.join("config", "routes.rb")
+    header = PREFIX + "\n# Generated on #{Time.now}\n#"
     if File.exists? routes_rb
       routes_map = `rake routes`
       routes_map = routes_map.split("\n")

data/lib/annotate.rb

@@ -2,7 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module Annotate
-  VERSION = '2.1.1'
+  VERSION = '2.2.2'
 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_models/annotate_models'
+  require 'annotate/annotate_models'
   options={}
   options[:position_in_class] = ENV['position_in_class'] || ENV['position']
   options[:position_in_fixture] = ENV['position_in_fixture'] || ENV['position']  

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_routes/annotate_routes'
+  require 'annotate/annotate_routes'
   AnnotateRoutes.do_annotate
 end

data/spec/annotate/annotate_models_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'annotate/annotate_models'
+
+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(
+      :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)
+      ]), "Hello").should eql("# Hello\n#\n# Table name: users\n#\n#  id    :integer         not null, primary key\n#  id    :integer         not null, primary key\n#\n\n")
+
+
+  end
+
+end

data/spec/annotate/annotate_routes_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'annotate/annotate_routes'
+
+describe AnnotateRoutes do
+
+  def mock_file(stubs={})
+    @mock_file ||= mock(File, stubs)
+  end
+
+  it "should check if routes.rb exists" do
+    File.should_receive(:join).with("config", "routes.rb").and_return(mock_file)
+    File.should_receive(:exists?).with(@mock_file).and_return(false)
+    AnnotateRoutes.should_receive(:puts).with("Can`t find routes.rb")
+
+    AnnotateRoutes.do_annotate
+  end
+
+  it "should annotate!" do
+    File.should_receive(:join).with("config", "routes.rb").and_return("config/routes.rb")
+    File.should_receive(:exists?).with("config/routes.rb").and_return(true)
+    AnnotateRoutes.should_receive(:`).with("rake routes").and_return("bad line\ngood line")
+    File.should_receive(:read).with("config/routes.rb").and_return("bla")
+    File.should_receive(:open).with("config/routes.rb", "wb").and_yield(mock_file)
+    @mock_file.should_receive(:puts).with(/bla\n\n#== Route Info\n# Generated on .*\n#\n# good line/)
+
+    AnnotateRoutes.do_annotate
+  end
+
+
+end

data/spec/annotate_spec.rb

@@ -1,11 +1,9 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
-# Time to add your specs!
-# http://rspec.info/
-describe "Place your specs here" do
+describe Annotate do
   
-  it "find this spec in spec directory" do
-    violated "Be sure to write your specs"
+  it "should have a version" do
+    Annotate::VERSION.should be_instance_of(String)
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nofxx-annotate
 version: !ruby/object:Gem::Version 
-  version: 2.1.1
+  version: 2.2.2
 platform: ruby
 authors: 
 - Marcos Piccinini
@@ -50,17 +50,17 @@ files:
 - Rakefile
 - annotate.gemspec
 - bin/annotate
-- config/hoe.rb
-- config/requirements.rb
 - lib/annotate.rb
-- lib/annotate_models/annotate_models.rb
-- lib/annotate_routes/annotate_routes.rb
+- lib/annotate/annotate_models.rb
+- lib/annotate/annotate_routes.rb
 - lib/tasks/annotate_models.rake
 - lib/tasks/annotate_routes.rake
 - script/console
 - script/destroy
 - script/generate
 - setup.rb
+- spec/annotate/annotate_models_spec.rb
+- spec/annotate/annotate_routes_spec.rb
 - spec/annotate_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/config/hoe.rb

@@ -1,69 +0,0 @@
-require 'annotate_models/version'
-
-AUTHOR = 'Dave Thomas'  # can also be an array of Authors
-EMAIL = "ctran@pragmaquest.com"
-DESCRIPTION = "Add a comment summarizing the current schema to the top of each ActiveRecord model source file"
-GEM_NAME = 'annotate-models' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'annotate-models' # The unix name for your project
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
-
-@config_file = "~/.rubyforge/user-config.yml"
-@config = nil
-RUBYFORGE_USERNAME = "unknown"
-def rubyforge_username
-  unless @config
-    begin
-      @config = YAML.load(File.read(File.expand_path(@config_file)))
-    rescue
-      puts <<-EOS
-ERROR: No rubyforge config file found: #{@config_file}
-Run 'rubyforge setup' to prepare your env for access to Rubyforge
- - See http://newgem.rubyforge.org/rubyforge.html for more details
-      EOS
-      exit
-    end
-  end
-  RUBYFORGE_USERNAME.replace @config["username"]
-end
-
-
-REV = nil 
-# UNCOMMENT IF REQUIRED: 
-# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
-VERS = AnnotateModels::VERSION::STRING + (REV ? ".#{REV}" : "")
-RDOC_OPTS = ['--quiet', '--title', 'annotate_models documentation',
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-class Hoe
-  def extra_deps 
-    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
-    @extra_deps
-  end 
-end
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.developer(AUTHOR, EMAIL)
-  p.description = DESCRIPTION
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/test_*.rb"]
-  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
-  
-  # == Optional
-  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
-  p.spec_extras = {}    # A hash of extra values to set in the gemspec.
-  
-end
-
-CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
-PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
-hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
-hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -1,17 +0,0 @@
-require 'fileutils'
-include FileUtils
-
-require 'rubygems'
-%w[rake hoe newgem rubigen].each do |req_gem|
-  begin
-    require req_gem
-  rescue LoadError
-    puts "This Rakefile requires the '#{req_gem}' RubyGem."
-    puts "Installation: gem install #{req_gem} -y"
-    exit
-  end
-end
-
-$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
-
-require 'annotate_models'