annotator 0.0.6 → 0.0.7

data/README.rdoc

@@ -78,14 +78,19 @@ Contributions are very much welcome.
 
 * since name does not have "model" in it, we could possibly use "rake routes" to annotate controller actions, not sure if it's worth it
 
-== Authors
+== Credits
 
-Kacper Cieśla @ Tech-Angels http://www.tech-angels.com
+Kacper Cieśla @ Tech-Angels - http://www.tech-angels.com
 
-Contributions:
+{<img src="http://media.tumblr.com/tumblr_m5ay3bQiER1qa44ov.png" alt="Tech-Angels" />}[http://www.tech-angels.com]
+
+{Contributions}[https://github.com/tech-angels/annotator/graphs/contributors]:
 
 * {Lucas Florio}[https://github.com/lucasefe] - made it working without rails
 
+
 == License
 
-   Annotator released under the MIT license. 
+   Annotator is released under the MIT license. 
+
+

data/lib/annotator/initial_description/belongs_to.rb

@@ -7,7 +7,7 @@ module Annotator
       def check
         # check if there is belongs to association where this column is a foreign key
         @model.reflect_on_all_associations.each do |reflection|
-          if reflection.foreign_key == @column && reflection.macro == :belongs_to
+          if (reflection.options[:foreign_key] || reflection.send(:derive_foreign_key)) == @column && reflection.macro == :belongs_to
             @reflection = reflection
             return true
           end

data/lib/annotator/model.rb

@@ -33,7 +33,20 @@ module Annotator
         @blocks[current_block] += [line]
       end
 
-      @blocks[:after], @blocks[:before] = @blocks[:before], [] if @blocks[:after].empty?
+
+      # If there is no after block, it means there are no attributes block yet.
+      # Let's try to find some good place to insert them.
+      if @blocks[:after].empty?
+        @blocks[:before].each_with_index do |line,i|
+          # We want to insert them after requires or any comment block at the beginning of the file
+          unless line.match(/^require/) || line.match(/^#/)
+            @blocks[:after] = @blocks[:before][i..-1]
+            @blocks[:before] = (i == 0) ? [] : @blocks[:before][0..(i-1)] + [''] # add one additional separation line to make it cleaner
+            break
+          end
+        end
+      end
+
     end
 
     # If this file does not have associated AR class it should be skipped

data/lib/annotator/version.rb

@@ -1,3 +1,3 @@
 module Annotator
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/test/annotator_test.rb

@@ -48,6 +48,12 @@ class AnnotatorTest < ActiveSupport::TestCase
     assert_equal File.read(asset_file 'foo_require_first.rb' ), File.read(app_file 'foo.rb' )
   end
 
+  test "leaving magic comments in place" do
+    FileUtils.cp asset_file('boo_encoding.rb'), app_file('boo.rb')
+    execute "rake annotate"
+    assert_equal File.read(asset_file 'boo_encoding_annotated.rb' ), File.read(app_file 'boo.rb' )
+  end
+
   test "annotating namespaced models" do
     assert_equal File.read(asset_file 'moo_hoo_annotated.rb' ), File.read(app_file 'moo/hoo.rb' )
   end

data/test/assets/boo_encoding.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+class Boo < ActiveRecord::Base
+  belongs_to :foo
+  belongs_to :poly, :polymorphic => true
+end

data/test/assets/boo_encoding_annotated.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * created_at [datetime, not null] - creation time
+# * foo_id [integer] - belongs to :foo
+# * poly_id [integer] - belongs to :poly (polymorphic)
+# * poly_type [string] - belongs to :poly (polymorphic)
+# * updated_at [datetime, not null] - last update time
+class Boo < ActiveRecord::Base
+  belongs_to :foo
+  belongs_to :poly, :polymorphic => true
+end

data/test/assets/moo_hoo_annotated.rb

@@ -1,3 +1,5 @@
+# Some existing stupid comment
+
 # Attributes:
 # * id [integer, primary, not null] - primary key
 # * body [text]
@@ -5,7 +7,6 @@
 # * random_number [integer] - TODO: document me
 # * title [string]
 # * updated_at [datetime, not null] - last update time
-# Some existing stupid comment
 module Moo
   class Hoo < ActiveRecord::Base
     self.table_name = 'foos'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotator
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -69,84 +69,85 @@ extra_rdoc_files: []
 files:
 - lib/tasks/annotator_tasks.rake
 - lib/annotator.rb
-- lib/annotator/initial_description/belongs_to.rb
+- lib/annotator/railtie.rb
 - lib/annotator/initial_description/devise.rb
-- lib/annotator/initial_description/paperclip.rb
-- lib/annotator/initial_description/base.rb
 - lib/annotator/initial_description/rails.rb
-- lib/annotator/model.rb
-- lib/annotator/model.rb.orig
+- lib/annotator/initial_description/base.rb
+- lib/annotator/initial_description/paperclip.rb
+- lib/annotator/initial_description/belongs_to.rb
+- lib/annotator/initial_description.rb
 - lib/annotator/version.rb
 - lib/annotator/attributes.rb
-- lib/annotator/initial_description.rb
-- lib/annotator/railtie.rb
+- lib/annotator/model.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
-- test/support/test_app.rb
-- test/test_helper.rb
-- test/assets/paper_annotated.rb
-- test/assets/foo_annotated_bad_column.rb
-- test/assets/foo_annotated_with_comments.rb
+- test/assets/foo_require_first.rb
 - test/assets/user_annotated.rb
-- test/assets/foo_annotated_bad_column_nodoc.rb
-- test/assets/boo_annotated.rb
+- test/assets/moo_hoo_annotated.rb
+- test/assets/boo_encoding_annotated.rb
+- test/assets/boo_encoding.rb
 - test/assets/foo_annotated.rb
+- test/assets/foo_annotated_with_comments.rb
+- test/assets/boo_annotated.rb
+- test/assets/foo_annotated_bad_column_nodoc.rb
+- test/assets/paper_annotated.rb
+- test/assets/foo_annotated_bad_column.rb
 - test/assets/foo_annotated_column_fixed.rb
-- test/assets/foo_require_first.rb
-- test/assets/moo_hoo_annotated.rb
 - test/annotator_test.rb
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/422.html
-- test/dummy/public/404.html
-- test/dummy/Rakefile
-- test/dummy/config/locales/en.yml
+- test/test_helper.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/models/user.rb
+- test/dummy/app/models/nomodel.rb
+- test/dummy/app/models/foo.rb
+- test/dummy/app/models/paper.rb
+- test/dummy/app/models/moo/hoo.rb
+- test/dummy/app/models/boo.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config/routes.rb
+- test/dummy/config/environment.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/application.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/database.yml
 - test/dummy/config/boot.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/inflections.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/database.yml
+- test/dummy/script/rails
 - test/dummy/log/development.log
 - test/dummy/log/test.log
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/boo.rb
-- test/dummy/app/models/paper.rb
-- test/dummy/app/models/moo/hoo.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/models/foo.rb
-- test/dummy/app/models/nomodel.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
 - test/dummy/config.ru
-- test/dummy/script/rails
-- test/dummy/test/unit/foo_test.rb
-- test/dummy/test/unit/user_test.rb
-- test/dummy/test/unit/paper_test.rb
-- test/dummy/test/unit/boo_test.rb
+- test/dummy/Rakefile
+- test/dummy/db/development.sqlite3
+- test/dummy/db/migrate/20120527023350_create_papers.rb
+- test/dummy/db/migrate/20120527020350_devise_create_users.rb
+- test/dummy/db/migrate/20120527023417_add_attachment_avatar_to_papers.rb
+- test/dummy/db/migrate/20120219112425_create_foos.rb
+- test/dummy/db/migrate/20120527025142_create_boos.rb
+- test/dummy/db/schema.rb
+- test/dummy/test/fixtures/boos.yml
 - test/dummy/test/fixtures/papers.yml
 - test/dummy/test/fixtures/users.yml
 - test/dummy/test/fixtures/foos.yml
-- test/dummy/test/fixtures/boos.yml
+- test/dummy/test/unit/paper_test.rb
+- test/dummy/test/unit/boo_test.rb
+- test/dummy/test/unit/user_test.rb
+- test/dummy/test/unit/foo_test.rb
 - test/dummy/README.rdoc
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/20120527020350_devise_create_users.rb
-- test/dummy/db/migrate/20120527025142_create_boos.rb
-- test/dummy/db/migrate/20120527023350_create_papers.rb
-- test/dummy/db/migrate/20120527023417_add_attachment_avatar_to_papers.rb
-- test/dummy/db/migrate/20120219112425_create_foos.rb
-- test/dummy/db/development.sqlite3
+- test/dummy/public/favicon.ico
+- test/dummy/public/404.html
+- test/dummy/public/500.html
+- test/dummy/public/422.html
+- test/support/test_app.rb
 homepage: https://github.com/tech-angels/annotator
 licenses: []
 post_install_message: 
@@ -172,67 +173,69 @@ signing_key:
 specification_version: 3
 summary: Annotate your models and keep your comments about fields.
 test_files:
-- test/support/test_app.rb
-- test/test_helper.rb
-- test/assets/paper_annotated.rb
-- test/assets/foo_annotated_bad_column.rb
-- test/assets/foo_annotated_with_comments.rb
+- test/assets/foo_require_first.rb
 - test/assets/user_annotated.rb
-- test/assets/foo_annotated_bad_column_nodoc.rb
-- test/assets/boo_annotated.rb
+- test/assets/moo_hoo_annotated.rb
+- test/assets/boo_encoding_annotated.rb
+- test/assets/boo_encoding.rb
 - test/assets/foo_annotated.rb
+- test/assets/foo_annotated_with_comments.rb
+- test/assets/boo_annotated.rb
+- test/assets/foo_annotated_bad_column_nodoc.rb
+- test/assets/paper_annotated.rb
+- test/assets/foo_annotated_bad_column.rb
 - test/assets/foo_annotated_column_fixed.rb
-- test/assets/foo_require_first.rb
-- test/assets/moo_hoo_annotated.rb
 - test/annotator_test.rb
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/422.html
-- test/dummy/public/404.html
-- test/dummy/Rakefile
-- test/dummy/config/locales/en.yml
+- test/test_helper.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/models/user.rb
+- test/dummy/app/models/nomodel.rb
+- test/dummy/app/models/foo.rb
+- test/dummy/app/models/paper.rb
+- test/dummy/app/models/moo/hoo.rb
+- test/dummy/app/models/boo.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config/routes.rb
+- test/dummy/config/environment.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/application.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/database.yml
 - test/dummy/config/boot.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/inflections.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/database.yml
+- test/dummy/script/rails
 - test/dummy/log/development.log
 - test/dummy/log/test.log
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/boo.rb
-- test/dummy/app/models/paper.rb
-- test/dummy/app/models/moo/hoo.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/models/foo.rb
-- test/dummy/app/models/nomodel.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
 - test/dummy/config.ru
-- test/dummy/script/rails
-- test/dummy/test/unit/foo_test.rb
-- test/dummy/test/unit/user_test.rb
-- test/dummy/test/unit/paper_test.rb
-- test/dummy/test/unit/boo_test.rb
+- test/dummy/Rakefile
+- test/dummy/db/development.sqlite3
+- test/dummy/db/migrate/20120527023350_create_papers.rb
+- test/dummy/db/migrate/20120527020350_devise_create_users.rb
+- test/dummy/db/migrate/20120527023417_add_attachment_avatar_to_papers.rb
+- test/dummy/db/migrate/20120219112425_create_foos.rb
+- test/dummy/db/migrate/20120527025142_create_boos.rb
+- test/dummy/db/schema.rb
+- test/dummy/test/fixtures/boos.yml
 - test/dummy/test/fixtures/papers.yml
 - test/dummy/test/fixtures/users.yml
 - test/dummy/test/fixtures/foos.yml
-- test/dummy/test/fixtures/boos.yml
+- test/dummy/test/unit/paper_test.rb
+- test/dummy/test/unit/boo_test.rb
+- test/dummy/test/unit/user_test.rb
+- test/dummy/test/unit/foo_test.rb
 - test/dummy/README.rdoc
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/20120527020350_devise_create_users.rb
-- test/dummy/db/migrate/20120527025142_create_boos.rb
-- test/dummy/db/migrate/20120527023350_create_papers.rb
-- test/dummy/db/migrate/20120527023417_add_attachment_avatar_to_papers.rb
-- test/dummy/db/migrate/20120219112425_create_foos.rb
-- test/dummy/db/development.sqlite3
+- test/dummy/public/favicon.ico
+- test/dummy/public/404.html
+- test/dummy/public/500.html
+- test/dummy/public/422.html
+- test/support/test_app.rb

data/lib/annotator/model.rb.orig

@@ -1,66 +0,0 @@
-module Annotator
-
-  # Represents a single model file and associated class
-  class Model
-
-    def initialize(filename, base_path)
-      @filename = filename
-      @base_path = base_path
-      @blocks = Hash.new {[]}
-    end
-
-    # Model class
-    def klass
-<<<<<<< HEAD
-      begin 
-        @filename.split('app/models/').last.split(/\.rb$/).first.camelize.constantize
-      rescue Exception
-        nil
-      end
-=======
-      @filename.split(@base_path).last.split(/\.rb$/).first.camelize.constantize rescue nil
->>>>>>> lucasefe/master
-    end
-
-    # Split file into 3 blocks: before attributes, attributes block, and after
-    # If there's no attributes block, content will be in :after part (for easier insertion)
-    def parse
-      @file = File.read(@filename).strip
-      current_block = :before
-      return @nodoc = true if @file.match(/^# Attributes\(nodoc\):$/i)
-      @file.split("\n").each do |line|
-        if line.match(/^#{Regexp.escape Attributes::HEADER} *$/)
-          current_block = :attributes
-          next
-        end
-        current_block = :after if current_block == :attributes && !line.match(Attributes::R_ATTRIBUTE_LINE)
-        @blocks[current_block] += [line]
-      end
-
-      @blocks[:after], @blocks[:before] = @blocks[:before], [] if @blocks[:after].empty?
-    end
-
-    # If this file does not have associated AR class it should be skipped
-    def skipped?
-      !klass || !klass.ancestors.include?(ActiveRecord::Base) || @nodoc
-    end
-
-    # Save changes to file if there were any
-    def update_file
-      output = (@blocks[:before] + @blocks[:attributes] + @blocks[:after]).join("\n").strip + "\n"
-      File.open(@filename,'w') { |f| f.write(output) } if output != @file
-    end
-
-    # Update file with new database information
-    def update!
-      parse
-      return true if skipped?
-      attributes = Attributes.new klass, @blocks[:attributes]
-      attributes.update!
-      @blocks[:attributes] = attributes.lines
-      update_file
-    end
-  end
-end
-
-