annotator 0.0.5 → 0.0.6

data/README.rdoc

@@ -1,6 +1,6 @@
 = 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.
+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?
 
@@ -65,6 +65,12 @@ Of course similar thing happens when you remove column or change it's type.
   * belongs_to association columns
   * devise columns
   * paperclip colums
+* you can run it without rails (if you use sinatra for example), just add something like this to your Rakefile
+      task :annotate do
+        require 'annotator'
+        Annotator.run(File.join(Dir.pwd, "lib", "models"))
+      end
+  
 
 Contributions are very much welcome.
 
@@ -74,4 +80,12 @@ Contributions are very much welcome.
 
 == Authors
 
-   Kacper Cieśla @ Tech-Angels http://www.tech-angels.com/
+Kacper Cieśla @ Tech-Angels http://www.tech-angels.com
+
+Contributions:
+
+* {Lucas Florio}[https://github.com/lucasefe] - made it working without rails
+
+== License
+
+   Annotator released under the MIT license. 

data/lib/annotator.rb

@@ -5,9 +5,15 @@ require 'annotator/initial_description'
 
 module Annotator
 
-  def self.run
-    Dir.glob("#{Rails.root}/app/models/**/*.rb").sort.map do |filename|
-      Model.new(filename).update!
+  def self.run(models_path = nil)
+    models_path ||= defined?(Rails) ? "#{Rails.root}/app/models" : "."
+    update_models(models_path)
+  end
+
+  def self.update_models(models_path)
+    path = "#{models_path}/**/*.rb"
+    Dir.glob(path).sort.map do |filename|
+      Model.new(filename, models_path).update!
     end
   end
 

data/lib/annotator/model.rb

@@ -3,14 +3,19 @@ module Annotator
   # Represents a single model file and associated class
   class Model
 
-    def initialize(filename)
+    def initialize(filename, base_path)
       @filename = filename
+      @base_path = base_path
       @blocks = Hash.new {[]}
     end
 
     # Model class
     def klass
-      @filename.split('app/models/').last.split(/\.rb$/).first.camelize.constantize rescue nil
+      begin 
+        @filename.split(@base_path).last.split(/\.rb$/).first.camelize.constantize rescue nil
+      rescue Exception
+        nil
+      end
     end
 
     # Split file into 3 blocks: before attributes, attributes block, and after

data/lib/annotator/model.rb.orig

@@ -0,0 +1,66 @@
+module Annotator
+
+  # Represents a single model file and associated class
+  class Model
+
+    def initialize(filename, base_path)
+      @filename = filename
+      @base_path = base_path
+      @blocks = Hash.new {[]}
+    end
+
+    # Model class
+    def klass
+<<<<<<< HEAD
+      begin 
+        @filename.split('app/models/').last.split(/\.rb$/).first.camelize.constantize
+      rescue Exception
+        nil
+      end
+=======
+      @filename.split(@base_path).last.split(/\.rb$/).first.camelize.constantize rescue nil
+>>>>>>> lucasefe/master
+    end
+
+    # Split file into 3 blocks: before attributes, attributes block, and after
+    # If there's no attributes block, content will be in :after part (for easier insertion)
+    def parse
+      @file = File.read(@filename).strip
+      current_block = :before
+      return @nodoc = true if @file.match(/^# Attributes\(nodoc\):$/i)
+      @file.split("\n").each do |line|
+        if line.match(/^#{Regexp.escape Attributes::HEADER} *$/)
+          current_block = :attributes
+          next
+        end
+        current_block = :after if current_block == :attributes && !line.match(Attributes::R_ATTRIBUTE_LINE)
+        @blocks[current_block] += [line]
+      end
+
+      @blocks[:after], @blocks[:before] = @blocks[:before], [] if @blocks[:after].empty?
+    end
+
+    # If this file does not have associated AR class it should be skipped
+    def skipped?
+      !klass || !klass.ancestors.include?(ActiveRecord::Base) || @nodoc
+    end
+
+    # Save changes to file if there were any
+    def update_file
+      output = (@blocks[:before] + @blocks[:attributes] + @blocks[:after]).join("\n").strip + "\n"
+      File.open(@filename,'w') { |f| f.write(output) } if output != @file
+    end
+
+    # Update file with new database information
+    def update!
+      parse
+      return true if skipped?
+      attributes = Attributes.new klass, @blocks[:attributes]
+      attributes.update!
+      @blocks[:attributes] = attributes.lines
+      update_file
+    end
+  end
+end
+
+

data/lib/annotator/railtie.rb

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

data/lib/annotator/version.rb

@@ -1,3 +1,3 @@
 module Annotator
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotator
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,10 +10,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -44,6 +44,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: ''
 email:
 - kacper.ciesla@tech-angels.com
@@ -59,6 +75,7 @@ files:
 - lib/annotator/initial_description/base.rb
 - lib/annotator/initial_description/rails.rb
 - lib/annotator/model.rb
+- lib/annotator/model.rb.orig
 - lib/annotator/version.rb
 - lib/annotator/attributes.rb
 - lib/annotator/initial_description.rb