active_record-annotate 0.1.1 → 0.2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, all_on_start: true, all_after_pass: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+  
+  notification :terminal_notifier, activate: 'com.googlecode.iTerm2'
+end

data/README.md

@@ -1,6 +1,6 @@
-# ActiveRecord::Annotate
+# ActiveRecord::Annotate [![Build Status](https://travis-ci.org/7even/active_record-annotate.png)](https://travis-ci.org/7even/active_record-annotate) [![Code Climate](https://codeclimate.com/github/7even/active_record-annotate.png)](https://codeclimate.com/github/7even/active_record-annotate)
 
-`ActiveRecord::Annotate` is a simple `ActiveRecord` plugin for annotating your rails models. It is based on `ActiveRecord::SchemaDumper` so the annotation format is very close to what you see in `db/schema.rb`.
+ActiveRecord::Annotate is a simple ActiveRecord plugin for annotating your rails models. It is based on `ActiveRecord::SchemaDumper` (a core ActiveRecord class responsible for creating `db/schema.rb`) so the annotation format is very close to what you write in your migrations.
 
 ## Installation
 
@@ -9,7 +9,8 @@ Trivial.
 ``` ruby
 # Gemfile
 group :development do
-  gem 'active_record-annotate'
+  # you don't want to annotate your models in production, do you?
+  gem 'active_record-annotate', '~> 0.2'
 end
 ```
 
@@ -19,9 +20,15 @@ $ bundle
 
 ## Usage
 
-Gem adds a simple `db:annotate` rake task - it just writes the annotation to the top of each model file in a comment block. Magic encoding comment is preserved.
+Gem adds a simple `db:annotate` rake task - it just writes the annotation to the top of each model file in a comment block (magic encoding comment is preserved).
 
-This is what it looks like:
+Once you install the gem into your application it hooks `db:annotate` to run after each `db:migrate` / `db:rollback` to keep the annotations in sync with the DB schema, but if you added a new model without migrating (or just accidentally messed up with something) you can always run the annotation process by hand:
+
+``` sh
+$ rake db:annotate
+```
+
+This is what a common annotation looks like:
 
 ``` ruby
 # create_table :documents, force: true do |t|
@@ -38,12 +45,17 @@ class Document < ActiveRecord::Base
 # ...
 ```
 
+## Changelog
+
+* 0.1 Initial version with core functionality
+* 0.1.1 Support for several models per table
+* 0.2 Auto-annotation after `db:migrate` & `db:rollback`, basic output
+
 ## Roadmap
 
 * Cover everything with tests
 * Write YARD docs
 * Add some means to configure the annotation process (annotation format, a place to put it)
-* Try to add auto-annotation after `db:migrate`
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/active_record-annotate.gemspec

@@ -22,4 +22,9 @@ Gem::Specification.new do |spec|
   
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'terminal-notifier-guard'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'awesome_print'
 end

data/lib/active_record/annotate.rb

@@ -1,5 +1,5 @@
 require 'active_record/annotate/dumper'
-require 'active_record/annotate/writer'
+require 'active_record/annotate/file'
 require 'active_record/annotate/version'
 require 'active_record/annotate/railtie'
 
@@ -7,17 +7,31 @@ module ActiveRecord
   module Annotate
     class << self
       def annotate
-        models.each do |table_name, file_paths|
+        processed_models = []
+        
+        models.each do |table_name, file_paths_and_classes|
           annotation = Dumper.dump(table_name)
           
-          file_paths.each do |path|
-            Writer.write(annotation, path)
+          file_paths_and_classes.each do |path, klass|
+            file = File.new(path)
+            file.annotate_with(annotation)
+            
+            if file.changed?
+              file.write
+              processed_models << "#{klass} (#{file.relative_path})"
+            end
+          end
+        end
+        
+        unless processed_models.empty?
+          puts 'Annotated models:'
+          processed_models.each do |model|
+            puts "  * #{model}"
           end
         end
       end
       
       def models
-        models_dir = Rails.root.join('app/models')
         files_mask = models_dir.join('**', '*.rb')
         
         hash_with_arrays = Hash.new do |hash, key|
@@ -25,17 +39,30 @@ module ActiveRecord
         end
         
         Dir.glob(files_mask).each_with_object(hash_with_arrays) do |path, models|
-          # .../app/models/car/hatchback.rb -> car/hatchback
-          short_path = path.sub(models_dir.to_s + '/', '').sub(/\.rb$/, '')
-          # skip any app/models/concerns files
-          next if short_path.starts_with?('concerns')
+          short_path = short_path_for(path)
+          next if short_path.starts_with?('concerns') # skip any app/models/concerns files
+          
+          klass = class_name_for(short_path)
+          next unless klass < ActiveRecord::Base # collect only AR::Base descendants
           
-          # car/hatchback -> Car::Hatchback
-          klass = short_path.camelize.constantize
-          # collect only AR::Base descendants
-          models[klass.table_name] << path if klass < ActiveRecord::Base
+          models[klass.table_name] << [path, klass]
         end
       end
+      
+      # .../app/models/car/hatchback.rb -> car/hatchback
+      def short_path_for(full_path)
+        full_path.sub(models_dir.to_s + '/', '').sub(/\.rb$/, '')
+      end
+      
+      # car/hatchback -> Car::Hatchback
+      def class_name_for(short_path)
+        short_path.camelize.constantize
+      end
+      
+    private
+      def models_dir
+        Rails.root.join('app/models')
+      end
     end
   end
 end

data/lib/active_record/annotate/file.rb

@@ -0,0 +1,50 @@
+module ActiveRecord
+  module Annotate
+    class File
+      attr_reader :path, :lines
+      
+      def initialize(path)
+        @path    = path
+        @content = ::File.read(path)
+        @lines   = @content.split(?\n)
+      end
+      
+      def annotate_with(annotation)
+        if @lines.first =~ /^\s*#.*coding/
+          # encoding: utf-8 encountered on the first line
+          encoding_line = @lines.shift
+        end
+        
+        while @lines.first.start_with?('#') || @lines.first.blank?
+          # throw out comments and empty lines
+          # in the beginning of the file (old annotation)
+          @lines.shift
+        end
+        
+        @lines.unshift(*annotation, nil)
+        @lines.unshift(encoding_line) unless encoding_line.nil?
+        @lines.push(nil) # newline at the end of file
+      end
+      
+      def write
+        new_file_content = @lines.join(?\n)
+        temp_path = "#{@path}.annotated"
+        
+        ::File.open(temp_path, 'w') do |temp_file|
+          temp_file.write(new_file_content)
+        end
+        
+        ::File.delete(@path)
+        ::File.rename(temp_path, @path)
+      end
+      
+      def changed?
+        @lines.join(?\n) != @content
+      end
+      
+      def relative_path
+        path.sub(/^#{Rails.root}\//, '')
+      end
+    end
+  end
+end

data/lib/active_record/annotate/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Annotate
-    VERSION = '0.1.1'
+    VERSION = '0.2'
   end
 end

data/lib/tasks/annotate.rake

@@ -4,3 +4,9 @@ namespace :db do
     ActiveRecord::Annotate.annotate
   end
 end
+
+%w(db:migrate db:rollback).each do |task_name|
+  Rake::Task[task_name].enhance do
+    Rake::Task['db:annotate'].invoke
+  end
+end

data/spec/active_record/annotate/file_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe ActiveRecord::Annotate::File do
+  let(:file_path) do
+    file = Tempfile.new('test_annotation')
+    File.open(file.path, 'w') do |tempfile|
+      tempfile.write(<<-FILE)
+# encoding: utf-8
+# create_table :users do |t|
+#   t.string :name
+#   t.integer :age
+# end
+
+class User < ActiveRecord::Base
+  has_many :posts
+end
+      FILE
+    end
+    
+    file.path
+  end
+  
+  let(:old_annotation) do
+    [
+      '# create_table :users do |t|',
+      '#   t.string :name',
+      '#   t.integer :age',
+      '# end'
+    ]
+  end
+  
+  let(:new_annotation) do
+    [
+      '# create_table :users do |t|',
+      '#   t.string :name',
+      '#   t.integer :age, null: false, default: 0',
+      '# end'
+    ]
+  end
+  
+  let(:expected_result) do
+    <<-FILE
+# encoding: utf-8
+# create_table :users do |t|
+#   t.string :name
+#   t.integer :age, null: false, default: 0
+# end
+
+class User < ActiveRecord::Base
+  has_many :posts
+end
+    FILE
+  end
+  
+  let(:file) { ActiveRecord::Annotate::File.new(file_path) }
+  
+  describe "#annotate_with" do
+    it "changes the lines adding the new annotation" do
+      file.annotate_with(new_annotation)
+      
+      processed_file_content = file.lines.join(?\n)
+      expect(processed_file_content).to eq(expected_result)
+    end
+  end
+  
+  describe "#changed?" do
+    context "with an old annotation" do
+      before(:each) do
+        file.annotate_with(old_annotation)
+      end
+      
+      it "returns false" do
+        expect(file).not_to be_changed
+      end
+    end
+    
+    context "with a new annotation" do
+      before(:each) do
+        file.annotate_with(new_annotation)
+      end
+      
+      it "returns true" do
+        expect(file).to be_changed
+      end
+    end
+  end
+  
+  describe "#write" do
+    before(:each) do
+      file.annotate_with(new_annotation)
+    end
+    
+    it "writes the new contents to file" do
+      file.write
+      
+      new_file_contents = ::File.read(file.path)
+      expect(new_file_contents).to eq(expected_result)
+    end
+  end
+  
+  describe "#relative_path" do
+    before(:each) do
+      Rails.stub(:root).and_return('root')
+      file.stub(:path).and_return('root/namespace/path.rb')
+    end
+    
+    it "returns a relative path" do
+      expect(file.relative_path).to eq('namespace/path.rb')
+    end
+  end
+end

data/spec/active_record/annotate_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe ActiveRecord::Annotate do
+  describe ".short_path_for" do
+    before(:each) do
+      subject.stub(:models_dir).and_return('dir')
+    end
+    
+    it "removes the root/app/models prefix and .rb suffix" do
+      short_path = subject.short_path_for('dir/namespace/model_name.rb')
+      expect(short_path).to eq('namespace/model_name')
+    end
+  end
+  
+  describe ".class_name_for" do
+    it "finds the class by the short path" do
+      class_name = subject.class_name_for('active_record/annotate/file')
+      expect(class_name).to eq(ActiveRecord::Annotate::File)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require 'active_record/annotate'
+require 'pry'
+require 'awesome_print'

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: active_record-annotate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
+  prerelease: 
 platform: ruby
 authors:
 - Vsevolod Romashov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,15 +46,81 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Adds a rake task which prepends each model file with an excerpt about
@@ -61,39 +132,55 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_record-annotate.gemspec
 - lib/active_record/annotate.rb
 - lib/active_record/annotate/dumper.rb
+- lib/active_record/annotate/file.rb
 - lib/active_record/annotate/railtie.rb
 - lib/active_record/annotate/version.rb
-- lib/active_record/annotate/writer.rb
 - lib/tasks/annotate.rake
+- spec/active_record/annotate/file_spec.rb
+- spec/active_record/annotate_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/7even/active_record-annotate
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3616105738017822554
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3616105738017822554
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: ActiveRecord models annotator based on rails' schema dumper
-test_files: []
+test_files:
+- spec/active_record/annotate/file_spec.rb
+- spec/active_record/annotate_spec.rb
+- spec/spec_helper.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 0d4d19dd9aa4aa53ab77fbb3e956de2a2ed0f400
-  data.tar.gz: 8ad179c14a5499aa39ae090b5d1a8e5ccaa6924e
-SHA512:
-  metadata.gz: b584d252701c53b7153e3977825e95722902edd654ef0eb1a5fd02a093ecdc00c2276b182b338252cba9f37727384ac7f0c8b0df128c3abacfaef9155862adaf
-  data.tar.gz: 1efd1c3364ae8dfe5f7758e6d7aba2d39b71f11e7a9fdb9544ab397260c35bbcaac90655d9dea94817bf848a9ce0d0f2835f885819a660cce503103280f12584

data/lib/active_record/annotate/writer.rb

@@ -1,38 +0,0 @@
-module ActiveRecord
-  module Annotate
-    module Writer
-      class << self
-        def write(annotation, path)
-          new_file_content = assemble(annotation, path)
-          
-          temp_path = "#{path}.annotated"
-          File.open(temp_path, 'w') do |temp_file|
-            temp_file.puts(new_file_content)
-          end
-          
-          File.delete(path)
-          File.rename(temp_path, path)
-        end
-        
-        def assemble(annotation, path)
-          lines = File.read(path).split("\n")
-          
-          if lines.first =~ /^\s*#.*coding/
-            # encoding: utf-8 encountered on the first line
-            encoding_line = lines.shift
-          end
-          
-          while lines.first.starts_with?('#') || lines.first.blank?
-            # throw out comments and empty lines in the beginning of the file (old annotation)
-            lines.shift
-          end
-          
-          lines.unshift(*annotation, nil)
-          lines.unshift(encoding_line) unless encoding_line.nil?
-          
-          lines.join("\n")
-        end
-      end
-    end
-  end
-end