annotator 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,71 @@
+= Annotator
+
+If you just want to have column descriptions in your model file, [annotate_models](https://github.com/ctran/annotate_models) should suite you well. Annotator will help you if you want to also keep your own comments about these columns.
+
+Ever wondered what the heck is that column used for?
+
+== Usage
+
+In your Gemfile:
+
+    gem 'annotator'
+
+Then in app directory:
+
+    rake annotate
+
+voila!
+
+== Usage (verbose)
+
+Let's say you have a Foo model:
+
+   class Foo < ActiveRecord::Base
+
+Make sure your working tree is clean (it's suggested tu put annotations in separate commits so you can easily review changes done by annotator before commiting and you can always easily revert them all) and run:
+
+    rake annotate
+
+Then it should become something like:
+
+    # My Foo model, it's awesome
+
+    # Attributes:
+    # * id [integer, primary, not null, limit=4] - primary key
+    # * body [text] - TODO: document me
+    # * created_at [datetime] - creation time
+    # * title [string] - TODO: document me
+
+    class Foo < ActiveRecord::Base
+
+Now you can edit these TODOs and run it again, nothing happens. But when you add new column and run it again:
+
+    # My Foo model, it's awesome
+
+    # Attributes:
+    # * id [integer, primary, not null, limit=4] - primary key
+    # * body [text] - there we store foo complicated body
+    # * created_at [datetime] - creation time
+    # * some_number [integer, limit=4] - TODO: document me
+    # * title [string]
+
+    class Foo < ActiveRecord::Base
+
+Of course similar thing happens when you remove column or change it's type.
+
+== Some actually useful information
+
+* it recognizes it's own block by "Attributes:" and then punctation list
+* if you don't want it to update anything, put "Attributes(nodoc):" instead
+* for some fields like title above you can just skip description including dash sometimes name is just obvious enough
+* multiline comments are ok
+
+== Todos
+
+* tests :)
+* it could be written a bit cleaner
+* 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
+
+   Kacper Cieśla @ Tech-Angels http://www.tech-angels.com/

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Annotator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/annotator.rb

@@ -0,0 +1,136 @@
+require 'annotator/railtie'
+
+module Annotator
+  def self.run
+    models = Dir.glob("#{Rails.root}/app/models/*.rb").map do |filename|
+      klass = filename.split('/').last.split(/\.rb$/).first.camelize.constantize
+      [filename, klass]
+    end.sort_by {|x| x.last.to_s}
+
+    i = 0
+    models.each do |filename, model|
+    begin
+      file = File.read(filename)
+      lines = file.split("\n")
+      out = ''
+      ia = false # inside attributes block
+      after_block = false
+      changed = false
+      skip_file = false
+      attrs_arr = []
+      lines.each do |line|
+        break if skip_file
+        out << "#{line}\n" && next if after_block
+
+        if ia && !line.match(/^# \*/) && !line.match(/^#   \S/)
+          out << stringify_attrs_arr(update_attrs_arr(attrs_arr, model))
+          ia = false
+          changed = true
+        end
+
+        # check if we are still in the comments part of the file
+        unless line.strip.empty? || line.match(/^\s*#/)
+          after_block = true
+          unless changed
+            out << "# Attributes:\n"
+            out << stringify_attrs_arr(update_attrs_arr(attrs_arr, model))
+          end
+        end
+
+        if ia
+          if line.match(/^# \*/)
+            m = line.match(/^# \* (\w+) \[(.*?)\]( \- )?(.*)/)
+            if m
+              attrs_arr << [m[1], m[2], m[4]].map(&:strip)
+            else
+              puts "!! Unrecognized line format on attributes list in #{model}:"
+              puts line
+            end
+          else
+            attrs_arr[-1][2] << " #{line[4..-1]}"
+          end
+        else
+          out << "#{line}\n"
+        end
+
+        ia = true if line.match(/^# Attributes:/i)
+        skip_file = true if line.match(/^# Attributes\(nodoc\):/i)
+      end
+
+      File.open(filename,'w') { |f| f.write(out) } if out.strip != file.strip && !skip_file
+
+    rescue Exception => e
+      puts "FAILURE while trying to update model #{model}:\n  #{e.to_str}"
+    end
+    end
+
+
+  end
+
+  protected
+
+  def self.update_attrs_arr(arr, model)
+    arr = arr.dup
+    model.columns.each do |column|
+      attrs_str = column_attrs(column)
+      if row = arr.find {|x| x[0] == column.name}
+        if row[1] != attrs_str
+          puts "  M #{model}##{column.name} [#{row[1]} -> #{attrs_str}]"
+          row[1] = attrs_str
+        end
+      else
+        puts "  A #{model}##{column.name} [#{attrs_str}]"
+        desc = "TODO: document me"
+        desc = "primary key" if column.name == 'id'
+        desc = "creation time" if column.name == 'created_at'
+        desc = "last update time" if column.name == 'updated_at'
+        arr << [column.name, attrs_str, desc]
+      end
+    end
+
+    # find columns that no more exist in db
+    orphans = arr.map(&:first) - model.columns.map(&:name)
+    unless orphans.empty?
+      orphans.each do |orphan|
+        puts "  D #{model}#{orphan}"
+        arr = arr.select {|x| x[0] != orphan}
+      end
+    end
+    arr
+  end
+
+  def self.column_attrs(c)
+    ret = c.type.to_s
+    ret << ", primary" if c.primary
+    ret << ", default=#{c.default}" if c.default
+    ret << ", not null" unless c.null
+    ret << ", limit=#{c.limit}" if c.limit && (c.limit != 255 && c.type != :string)
+    ret
+  end
+
+  def self.stringify_attrs_arr(arr)
+    ret = ''
+    arr.sort_by{|x| x[0] == 'id' ? '_' : x[0]}.each do |name, attrs, desc|
+      # split into lines that don't exceed 80 chars
+      desc = " - #{desc}" unless desc.empty?
+      line = "# * #{name} [#{attrs}]#{desc}"
+      lt = wrap_text(line, opts[:max_chars_per_line]-3).split("\n")
+      line = ([lt[0]] + lt[1..-1].map{|x| "#   #{x}"}).join("\n")
+      ret << "#{line}\n"
+    end
+    ret
+  end
+
+  def self.wrap_text(txt, col)
+    txt.gsub(/(.{1,#{col}})( +|$)\n?|(.{#{col}})/,"\\1\\3\n")
+  end
+
+  def self.opts
+    {
+      :max_chars_per_line => 120
+    }
+  end
+
+
+end
+

data/lib/annotator/railtie.rb

@@ -0,0 +1,7 @@
+module Annotate
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/annotator/version.rb

@@ -0,0 +1,3 @@
+module Annotator
+  VERSION = "0.0.2"
+end

data/lib/tasks/annotator_tasks.rake

@@ -0,0 +1,4 @@
+desc "Explaining what the task does"
+task :annotate => :environment do
+  Annotator.run
+end

data/test/annotator_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AnnotatorTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Annotator
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.