guard-annotate 2.2 → 2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98a0532bcf1bd425c02936c5807b0d029ce89f4c
-  data.tar.gz: b53058e186c29ea03dfc4ef3ea412e3386a680bc
+  metadata.gz: 36bebacaf5025571496eced14c294ab7c2add09d
+  data.tar.gz: 356a67a27ecb62c48df1832b9628e45efcadfdbf
 SHA512:
-  metadata.gz: 547b8768f95eca595909bc2a805060cc76e10d079e40baf0ddbf1ec4e52a86251858785aed01e4527ef36f041c28df59f11044e385d5b6a95a9e0fd9c5d48f77
-  data.tar.gz: e420e1b5fe990d54c2339f9d3a3bdef47a789df9f595b4831b389f82bb2eac332eb2ecef8867890d902b688a96b661230023da8e8ae12dbe9a660c2791ec45e3
+  metadata.gz: dc680e273a866a222fa56b9ff0039badf8034c180d47e6489451d0c05f76a75d1f5154e29f5187e9e4dfe703fe5e5d3883db6862c00cde6ef608530639dc54cc
+  data.tar.gz: 4028ddeece91c375e7da189ee02856996019292006a740ea6e042efe734443c462864c01d9c30958e157bd7faf99baf73f05a9ff3c45b570c203a47be2ad632c

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Craig P Jolicoeur
+Copyright (c) 2016 Craig P Jolicoeur
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.rdoc → README.md}

@@ -1,17 +1,24 @@
-= Guard::Annotate
+---
+
+**NOTE: guard-annotate is currently looking for new maintainers.  While I am still trying to accept and stay on top of new Pull Requests, I no longer personally actively use this guard plugin.  If you are interested in becoming a maintainer, please contact me via email at cpjolicoeur@gmail.com**
+
+---
+
+# Guard::Annotate
 
 Annotate guard runs the annotate gem when needed
 
 - Compatible with Annotate 2.4.x
-- Tested on Ruby 1.8.7, 1.9.x, 2.1.x
+- Tested on Ruby 1.9.x, 2.0.x, 2.1.x, 2.2.x
 
-== Install
+## Install
 
 Install the gem:
 
     gem install guard-annotate
 
 Add the gem to your Gemfile:
+    
     gem 'guard-annotate'
 
 Add guard definitions to your Guardfile by running:
@@ -19,13 +26,13 @@ Add guard definitions to your Guardfile by running:
     guard init annotate
 
 
-== Usage
+## Usage
 
-Please read the {Guard usage docs}[https://github.com/guard/guard#readme]
+Please read the [Guard usage docs][1]
 
-== Guardfile
+## Guardfile
 
-=== Standard Ruby on Rails project
+### Standard Ruby on Rails project
 
     guard 'annotate' do
       watch( 'db/schema.rb' )
@@ -35,13 +42,17 @@ Please read the {Guard usage docs}[https://github.com/guard/guard#readme]
     end
 
 
-== Options
+## Options
+
+### Desktop notifications
 
 You can disable desktop notifications with (default is notifications are enabled):
 
     guard 'annotate', :notify => false do
       ...
     end
+    
+### Placement
 
 You can customize the placement of the annotations with (default is 'before'):
 
@@ -49,17 +60,39 @@ You can customize the placement of the annotations with (default is 'before'):
       ...
     end
 
+### Routes
+
 You can choose to also annotate your routes file with true, false or 'before'/'after' (default is false):
 
     guard 'annotate', :routes => 'before|after' do
       ...
     end
+    
+### Tests Annotation
 
 You can annotate your tests and fixtures files with (default is false):
 
     guard 'annotate', :tests => true do
       ...
     end
+    
+### Factory Exclusion
+
+You can exclude annotations in factory files with (default is true):
+
+    guard 'annotate', :factories => false do
+      ...
+    end
+
+### Serializers
+
+You can exclude annotations in serializers with (default is true):
+
+    guard 'annotate', :serializers => false do
+      ...
+    end
+    
+### Run at start
 
 You can disable run at start with (default is true):
 
@@ -67,35 +100,56 @@ You can disable run at start with (default is true):
       ...
     end
 
+### Indexes
+
 You can annotate indexes on your models with (default is false):
 
     guard 'annotate', :show_indexes => true do
       ...
     end
 
+### Simple Indexes
+
 You can add simple indexes to the column information (default is false):
 
     guard 'annotate', :simple_indexes => true do
       ...
     end
 
+
+### Foreign Keys
+
+You can show foreign keys (default is false):
+
+    guard 'annotate', :show_foreign_keys => true do
+      ...
+    end
+
+### Migration version number
 You can show migration version number in the annotation (default is false):
 
     guard 'annotate', :show_migration => true do
       ...
     end
 
+### Annotation Format
+
 You can annotate in three different formats: :bare, :rdoc and :markdown (default is :bare):
 
     guard 'annotate', :format => :rdoc do
       ...
     end
 
-== Development
+## Development
+
+- Source hosed at [GitHub][2]
+- Issue/Bug/Question/Feature requests via [GitHub Issues][3]
 
-- Source hosed at {GitHub}[https://github.com/cpjolicoeur/guard-annotate]
-- Issue/Bug/Question/Feature requests via {GitHub Issues}[http://github.com/cpjolicoeur/guard-annotate/issues]
+## Authors
 
-== Authors
+[Craig P Jolicoeur][4]
 
-{Craig P Jolicoeur}[https://github.com/cpjolicoeur]
+[1]: https://github.com/guard/guard#readme]
+[2]: https://github.com/guard/guard-annotate
+[3]: http://github.com/guard/guard-annotate/issues
+[4]: https://github.com/cpjolicoeur

data/lib/guard/annotate.rb

@@ -13,11 +13,14 @@ module Guard
       options[:notify] = true if options[:notify].nil?
       options[:position] = 'before' if options[:position].nil?
       options[:tests] = false if options[:tests].nil?
+      options[:factories] = true if options[:factories].nil?
+      options[:serializers] = true if options[:serializers].nil?
       options[:sort] = false if options[:sort].nil?
       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_foreign_keys] = false if options[:show_foreign_keys].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
@@ -57,8 +60,13 @@ module Guard
       options[:routes]
     end
 
-    def annotate_tests_flags
-      options[:tests] ? '' : '--exclude tests,fixtures'
+    def annotate_excludes
+      excludes = []
+      excludes << 'tests' << 'fixtures' unless options[:tests]
+      excludes << 'factories' unless options[:factories]
+      excludes << 'serializers' unless options[:serializers]
+
+      excludes.empty? ? '' : "--exclude #{excludes.join(',')}"
     end
 
     def annotate_sort_columns?
@@ -84,17 +92,22 @@ module Guard
     def show_migration?
       options[:show_migration]
     end
+    
+    def show_foreign_keys?
+      options[:show_foreign_keys]
+    end
 
     def run_annotate
       Compat::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 = "bundle exec annotate #{annotate_excludes} -p #{annotation_position}"
       annotate_models_options += ' --sort' if annotate_sort_columns?
       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_models_options += ' --show-foreign-keys' if show_foreign_keys?
       annotate_options += " --format=#{annotate_format}" if annotate_format?
 
       annotate_models_command += annotate_models_options + annotate_options

data/lib/guard/annotate/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Guard
   module AnnotateVersion
-    VERSION = '2.2'
+    VERSION = '2.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-annotate
 version: !ruby/object:Gem::Version
-  version: '2.2'
+  version: '2.3'
 platform: ruby
 authors:
 - Craig P Jolicoeur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-compat
@@ -72,7 +72,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- README.rdoc
+- README.md
 - lib/guard/annotate.rb
 - lib/guard/annotate/notifier.rb
 - lib/guard/annotate/templates/Guardfile
@@ -84,11 +84,10 @@ metadata: {}
 post_install_message: |-
   ** guard-annotate is looking for maintainers. While I am still trying
     to accept and stay on top of new Pull Requests, I no longer personally actively use this guard
-    plugin.  If you are interested in becoming a maintainer please contact me via GitHub Issues at
-    https://github.com/guard/guard-annotate. **
+    plugin.  If you are interested in becoming a maintainer please contact me via email at cpjolicoeur@gmail.com. **
 rdoc_options:
 - "--charset=UTF-8"
-- "--main=README.rdoc"
+- "--main=README.md"
 - "--exclude='(lib|test|spec)|(Gem|Guard|Rake)file'"
 require_paths:
 - lib
@@ -104,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: guard-annotate
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Guard gem for annotate