annotated-rails 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 TODO
 ----
 
-* rake task(rake annotate)
+* add initializer(or|and just add configuration) in order to configure annotation rake task invocation and other future configuration values:
+
+      # or maybe you want place this in environments/development.rb? this is your choice
+      if defined? Annotated::Rails
+        config.annotated-rails.rake_task = true
+        config. bla bla
+      end
+
 * add exception handling for "bad" models:
 
       Annotaiting GoodModel BadModel(failed)
@@ -14,6 +21,11 @@ current(master)
 
 nothing here yet
 
+0.0.2
+-----
+
+* added rake task (hooked into database migration tasks).
+
 0.0.1
 -----
 

data/README.md

@@ -45,28 +45,29 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install annotated-rails
+* First way: <strong>almost do nothing</strong>, your `rake db:migrate` or similar database-changing tasks will do the job if gem already installed.
 
-## Usage
+* Second way: use [guard](https://github.com/guard/guard) and [guard-migrate](https://github.com/guard/guard-migrate) and for you <strong>nothing to do at all</strong> :).
+
+* Third way (to use from commandline):
 
-To annotate:
+  To annotate:
 
-    bundle exec annotate-rails
+      bundle exec annotate-rails
 
-To remove annotation:
+  To remove annotation:
 
-    bundle exec annotate-rails -d
+      bundle exec annotate-rails -d
 
-To see CLI help:
+  To see CLI help:
 
-    bundle exec annotate-rails -h|--help
+      bundle exec annotate-rails -h|--help
 
 ## Future plans
 
 * look at the CHANGELOG for what is going to be done
-* add guard/something similar support
 * add annotations for other things
 
 ## Testing

data/lib/annotated-rails.rb

@@ -1,2 +1,9 @@
-# I have nothing to load here,
-# it's for bundler, maybe...
+module Annotated
+  module Rails
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load 'annotated/rake_task.rake'
+      end
+    end
+  end
+end

data/lib/annotated/rake_task.rake

@@ -0,0 +1,18 @@
+desc "annotate-rails task"
+task 'annotate-rails' do
+  require 'annotated/models'
+  Annotated::Models.instance.annotate!(options={})
+end
+
+%w[
+  db:migrate
+  db:rollback
+  db:forward
+].each do |db_schema_change_task|
+  if Rake::Task.task_defined? db_schema_change_task
+    # "after-hook"
+    task db_schema_change_task do
+      Rake::Task['annotate-rails'].invoke
+    end
+  end
+end

data/lib/annotated/version.rb

@@ -1,3 +1,3 @@
 module Annotated
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotated-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -144,6 +144,7 @@ files:
 - bin/annotate-rails
 - lib/annotated-rails.rb
 - lib/annotated/models.rb
+- lib/annotated/rake_task.rake
 - lib/annotated/version.rb
 - spec/annotated/models/annotator_spec.rb
 - spec/annotated/models_spec.rb