annotate_models 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53b7a0a3bcc8c72bbecf825408c5a3abed24ce81
+  data.tar.gz: 144c14334120433ef0a61f6fdee4aa1ee3ebdb67
+SHA512:
+  metadata.gz: 6b11348c86f2bac0d9e009649e5c2f95b28b5ec77dbe0db50fd96617e4e962df5da063f17a614389d310cbeb90a348ff7dd962c55e4c1926b9d4b2cd14b5c789
+  data.tar.gz: 11faa9d4fcef539177fdba0619ccad7ffb349513152018dc50e2268a565d4faa361d5b5e729fa63018ef1f6aa11ba1e9ff068d67063fafd9b99813200ec1037a

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nathan Brazil
+
+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.md

@@ -0,0 +1,38 @@
+# annotate_models
+
+This is my own re-write of an earlier version [ctran/annoate_models](https://github.com/ctran/annotate_models) when
+work on it waned.  This work started out as a Rails plugin; I am now re-bundling it as a gem since plugin support for Rails has
+long been deprecated.
+
+## Installation
+
+If you are using Bundler, add this line to your Gemfile:
+
+```ruby
+gem "annotate_models"
+```
+
+Otherwise, run this command:
+
+```
+gem install annotate_models"
+```
+
+## Usage
+
+Run this command from the root folder of your Rails application:
+
+```
+rake annotate:all
+```
+
+For details, run ```rake -T```.
+
+## Credit
+
+I first learned to love the functionality of Dave Thomas' annotate_models plugin (you can find a repo for it
+[here](https://github.com/alsemyonov/annotate_models)).  Later, when it became un-maintained and broke, I switched over to
+[ctran/annoate](https://github.com/ctran/annotate_models).  Then, when work on it waned and broke as well, I decided to write my own
+as an exercise.
+
+So thanks go out to Pragmatic Dave as well as to the author and contributors of ctran/annotate_models.

data/lib/annotate_models/model_annotation_generator.rb

@@ -0,0 +1,108 @@
+module AnnotateModels
+
+  ##
+  # Class contains the Ruby code to generate the annotations
+  #
+
+  class ModelAnnotationGenerator
+    
+    def initialize
+      @annotations = {}
+    end
+
+    ##
+    # Apply annotations to a file
+    # 
+    # @param path [String] Relative path (from root of application) of directory to apply annotations to.
+    # @param suffix [String] Optionally specify suffix of files to apply annotation to (e.g. "<model.name>_<suffix>.rb").
+    # @param extension [String] Optionally specify extension of files to apply annotaations to (e.g. "<model.name>_<suffix>.<extension>").
+    
+    def apply_annotation(path, suffix=nil, extension="rb", plural=false)
+      pn_models = Pathname.new(path)
+      return unless pn_models.exist?
+      suffix = "_#{suffix}" unless suffix == nil
+      extension = (extension == nil) ? "" : ".#{extension}"
+      @annotations.each do |model, annotation|
+        prefix = (plural) ? model.name.pluralize : model.name
+        pn = pn_models + "#{ActiveSupport::Inflector.underscore(prefix)}#{suffix}#{extension}"
+        text = File.open(pn.to_path) { |fp| fp.read }
+        re = Regexp.new("^#-(?:--)+-\n# #{model.name}.*\n(?:#.+\n)+#-(?:--)+-\n", Regexp::MULTILINE)
+        if re =~ text
+          text = text.sub(re, annotation)
+        else
+          text = "#{text}\n#{annotation}"
+        end
+        File.open(pn.to_path, "w") { |fp| fp.write(text) }
+        puts "Annotated #{pn.to_path}."
+      end
+    end
+    
+    def apply_to_factories
+      self.apply_annotation("test/factories", suffix="factory")
+    end
+    
+    def apply_to_fixtures
+      self.apply_annotation("test/fixtures", suffix=nil, extension="yml", plural=true)
+    end
+    
+    def apply_to_models
+      self.apply_annotation("app/models")
+    end
+    
+    def apply_to_model_tests
+      self.apply_annotation("test/models", suffix="test")
+    end
+    
+    ##
+    # Gather model classes and generate annotation for each one.
+
+    def generate
+      Dir["app/models/*.rb"].each do |path|
+        result = File.basename(path).scan(/^(.+)\.rb/)[0][0]
+        model = eval(ActiveSupport::Inflector.camelize(result))
+        next unless model < ActiveRecord::Base
+        @annotations[model] = generate_annotation(model) unless @annotations.keys.include?(model)
+      end
+    end
+
+    ##
+    # Print out the annotation text.
+    
+    def print
+      @annotations.values.sort.each do |annotation|
+        puts annotation
+        puts
+      end
+    end
+    
+    private
+      
+    ##
+    # Generate annotation text.
+    # @param model [Class] An ActiveRecord model class.
+
+    def generate_annotation(model)
+      annotation = []
+      annotation << "#-#{'--' * 38}-"
+      annotation << "# #{model.name}"
+      annotation << "#"
+      annotation << "# Name                           SQL Type             Null    Default Primary"
+      annotation << "# ------------------------------ -------------------- ------- ------- -------"
+      model.columns.each do |column|
+        annotation << sprintf(
+          "# %-30s %-20s %-7s %-7s %-7s",
+          column.name,
+          column.sql_type,
+          column.null,
+          (column.default || ""),
+          column.name == model.primary_key
+          )
+      end
+      annotation << "#"
+      annotation << "#-#{'--' * 38}-"
+      annotation.join("\n") + "\n"
+    end
+    
+  end
+
+end

data/lib/annotate_models/railtie.rb

@@ -0,0 +1,11 @@
+require "annotate_models"
+require "rails"
+
+module AnnotateModels
+  class Railtie < Rails::Railtie
+    railtie_name :annotate_models
+    rake_tasks do
+      load "tasks/annotate_models.rake"
+    end
+  end
+end

data/lib/annotate_models/version.rb

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

data/lib/annotate_models.rb

@@ -0,0 +1,3 @@
+module AnnotateModels
+  require "annotate_models/railtie" if defined?(Rails)
+end

data/lib/tasks/annotate_models.rake

@@ -0,0 +1,55 @@
+require "annotate_models/model_annotation_generator"
+
+#-----
+# Ruby tasks
+#-----
+
+task annotate: "annotate:all"
+
+namespace :annotate do
+  
+  desc "Annotate everything"
+  task :all => [:factories, :fixtures, :models, "test:models"]
+  
+  desc "Annotate factories"
+  task :factories do
+    puts "Annotating factories..."
+    am = AnnotateModels::ModelAnnotationGenerator.new
+    am.generate
+    am.apply_to_factories
+  end
+
+  desc "Annotate fixtures"
+  task :fixtures do
+    puts "Annotating fixtures..."
+    am = AnnotateModels::ModelAnnotationGenerator.new
+    am.generate
+    am.apply_to_fixtures
+  end
+
+  desc "Annotate ActiveRecord models"
+  task :models do
+    puts "Annotating models..."
+    am = AnnotateModels::ModelAnnotationGenerator.new
+    am.generate
+    am.apply_to_models
+  end
+  
+  desc "Print annotations"
+  task :print do
+    am = AnnotateModels::ModelAnnotationGenerator.new
+    am.generate
+    am.print
+  end
+  
+  namespace :test do
+    desc "Annotate model tests"
+    task :models do
+      puts "Annotating model tests..."
+      am = AnnotateModels::ModelAnnotationGenerator.new
+      am.generate
+      am.apply_to_model_tests
+    end
+  end
+
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: annotate_models
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nathan Brazil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-08 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  This is my own re-write of an earlier version [ctran/annoate](https://github.com/ctran/annotate_models) when
+      work on it waned.  This work started out as a Rails plugin; I am now re-bundling it as a gem since plugin support for Rails has
+      long been deprecated.
+email: nb@bitaxis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/annotate_models.rb
+- lib/annotate_models/model_annotation_generator.rb
+- lib/annotate_models/railtie.rb
+- lib/annotate_models/version.rb
+- lib/tasks/annotate_models.rake
+homepage: https://github.com/bitaxis/annotate_models.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple gem that adds several rake tasks to annotate Rails source files with
+  model schema.
+test_files: []
+has_rdoc: