guard-annotate 1.0.0 → 1.1.0

data/README.rdoc

@@ -69,7 +69,25 @@ You can disable run at start with (default is true):
 
 You can annotate indexes on your models with (default is false):
 
-    guard 'annotate', :show_indexes => true
+    guard 'annotate', :show_indexes => true do
+      ...
+    end
+
+You can add simple indexes to the column information (default is false):
+
+    guard 'annotate', :simple_indexes => true do
+      ...
+    end
+
+You can show migration version number in the annotation (default is false):
+
+    guard 'annotate', :show_migration => true do
+      ...
+    end
+
+You can annotate in three different formats: :bare, :rdoc and :markdown (default is :bare):
+
+    guard 'annotate', :format => :rdoc do
       ...
     end
 

data/lib/guard/annotate.rb

@@ -1,13 +1,14 @@
 # encoding: utf-8
 require 'guard'
 require 'guard/guard'
+require 'guard/version'
 
 module Guard
   class Annotate < Guard
 
     autoload :Notifier, 'guard/annotate/notifier'
 
-    def initialize( watchers=[], options={} )
+    def initialize(watchers=[], options={})
       super
 
       options[:notify] = true if options[:notify].nil?
@@ -16,6 +17,9 @@ module Guard
       options[:routes] = false if options[:routes].nil?
       options[:run_at_start] = true if options[:run_at_start].nil?
       options[:show_indexes] = false if options[:show_indexes].nil?
+      options[:simple_indexes] = false if options[:simple_indexes].nil?
+      options[:show_migration] = false if options[:show_migration].nil?
+      options[:format] = nil if options[:format].nil? or not [:bare, :markdown, :rdoc].include? options[:format].to_sym
     end
 
     def start
@@ -34,10 +38,10 @@ module Guard
       true
     end
 
-    def run_on_changes( paths=[] )
+    def run_on_changes(paths=[])
       run_annotate
     end
-    alias :run_on_change :run_on_changes
+    alias :run_on_change :run_on_changes if VERSION < '1.1.0'
 
     private
 
@@ -54,25 +58,51 @@ module Guard
     end
 
     def annotate_tests_flags
-      options[:tests] ? "" : "--exclude tests,fixtures"
+      options[:tests] ? '' : '--exclude tests,fixtures'
     end
 
     def show_indexes?
       options[:show_indexes]
     end
 
+    def annotate_format
+      options[:format]
+    end
+
+    def annotate_format?
+      not options[:format].nil?
+    end
+
+    def simple_indexes?
+      options[:simple_indexes]
+    end
+
+    def show_migration?
+      options[:show_migration]
+    end
+
     def run_annotate
       UI.info 'Running annotate', :reset => true
       started_at = Time.now
+      annotate_models_options, annotate_options = '', ''
+
       annotate_models_command = "bundle exec annotate #{annotate_tests_flags} -p #{annotation_position}"
-      annotate_models_command += " --show-indexes" if show_indexes?
+      annotate_models_options += ' --show-indexes' if show_indexes?
+      annotate_models_options += ' --simple-indexes' if simple_indexes?
+      annotate_models_options += ' --show-migration' if show_migration?
+      annotate_options += " --format=#{annotate_format}" if annotate_format?
+
+      annotate_models_command += annotate_models_options + annotate_options
       @result = system(annotate_models_command)
-      Notifier::notify( @result, Time.now - started_at ) if notify?
+      Notifier::notify(@result, Time.now - started_at) if notify?
 
       if annotate_routes?
         started_at = Time.now
-        @result = system("bundle exec annotate -r -p #{annotation_position}")
-        Notifier::notify( @result, Time.now - started_at ) if notify?
+        annotate_routes_command = "bundle exec annotate -r -p #{annotation_position}"
+
+        annotate_routes_command += annotate_options
+        @result = system(annotate_routes_command)
+        Notifier::notify(@result, Time.now - started_at) if notify?
       end
 
       @result

data/lib/guard/annotate/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Guard
   module AnnotateVersion
-    VERSION = "1.0.0"
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,71 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: guard-annotate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
   prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Craig P Jolicoeur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: guard
-  requirement: &70324019035600 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.2
+    none: false
+  name: guard
   type: :runtime
   prerelease: false
-  version_requirements: *70324019035600
-- !ruby/object:Gem::Dependency
-  name: annotate
-  requirement: &70324019035120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
+    none: false
+  name: annotate
   type: :runtime
   prerelease: false
-  version_requirements: *70324019035120
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70324019034660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.9.0
+    none: false
+  name: rspec
   type: :development
   prerelease: false
-  version_requirements: *70324019034660
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: &70324019034200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.0
+    none: false
+  name: guard-rspec
   type: :development
   prerelease: false
-  version_requirements: *70324019034200
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70324019033740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2.2
+    none: false
+  name: rake
   type: :development
   prerelease: false
-  version_requirements: *70324019033740
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+    none: false
 description: Guard::Annotate automatically runs the annotate gem when needed
 email:
 - cpjolicoeur@gmail.com
@@ -89,20 +114,20 @@ rdoc_options:
 require_paths:
 - lib
 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
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: guard-annotate
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Guard gem for annotate