active_record-annotate 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7da2641db8b7f89154f1822775ec8d236e36651f
+  data.tar.gz: 9c51bd0f547609d06fa6542d36172f9dfc8aa680
+SHA512:
+  metadata.gz: 7ff59459899aa01aa6571380e614727e1d64b22e60312426ce7aa399b99eb90bb14598fb1f432edd55a6d72745456f36d3e46437ef5e7a0d3ac18fca2696b408
+  data.tar.gz: 0ceb493a98b0c698db070b29d3781964f545bd638a7e327e3e28a0938269bbf1c5c44a9b5350fde0fc5eb68c7bcf9b3ed8ac5c02a202838562a3ff3cf9cd22b4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vsevolod Romashov
+
+MIT License
+
+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,51 @@
+# ActiveRecord::Annotate
+
+`ActiveRecord::Annotate` is a simple `ActiveRecord` plugin for annotating your rails models. It is based on `ActiveRecord::SchemaDumper` so the annotation format is very close to what you see in `db/schema.rb`.
+
+## Installation
+
+Trivial.
+
+``` ruby
+# Gemfile
+gem 'active_record-annotate'
+```
+
+``` sh
+$ bundle
+```
+
+## Usage
+
+Gem adds a simple `db:annotate` rake task - it just writes the annotation to the top of each model file in a comment block. Magic encoding comment is preserved.
+
+This is what it looks like:
+
+``` ruby
+# create_table :documents, force: true do |t|
+#   t.string   :title
+#   t.text     :content
+#   t.integer  :category_ids, array: true
+#   t.datetime :created_at
+#   t.datetime :updated_at
+# end
+#
+# add_index :documents, [:category_ids], name: :index_documents_on_category_ids, using: :gin
+
+class Document < ActiveRecord::Base
+# ...
+```
+
+## Roadmap
+
+* Cover everything with tests
+* Write YARD docs
+* Add some means to configure the annotation process (annotation format, a place to put it)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/active_record-annotate.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/annotate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record-annotate'
+  spec.version       = ActiveRecord::Annotate::VERSION
+  spec.authors       = ['Vsevolod Romashov']
+  spec.email         = ['7@7vn.ru']
+  spec.summary       = %q{ActiveRecord models annotator based on rails' schema dumper}
+  spec.description   = %q{Adds a rake task which prepends each model file with an excerpt about the corresponding table from db/schema.rb}
+  spec.homepage      = 'https://github.com/7even/active_record-annotate'
+  spec.license       = 'MIT'
+  
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+  
+  spec.add_runtime_dependency 'rails', '>= 3.2'
+  
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/active_record/annotate.rb

@@ -0,0 +1,34 @@
+require 'active_record/annotate/dumper'
+require 'active_record/annotate/writer'
+require 'active_record/annotate/version'
+require 'active_record/annotate/railtie'
+
+module ActiveRecord
+  module Annotate
+    class << self
+      def annotate
+        models.each do |table_name, file_path|
+          annotation = Dumper.dump(table_name)
+          Writer.write(annotation, file_path)
+        end
+      end
+      
+      def models
+        models_dir = Rails.root.join('app/models')
+        files_mask = models_dir.join('**', '*.rb')
+        
+        Dir.glob(files_mask).each_with_object(Hash.new) do |path, models|
+          # .../app/models/car/hatchback.rb -> car/hatchback
+          short_path = path.sub(models_dir.to_s + '/', '').sub(/\.rb$/, '')
+          # skip any app/models/concerns files
+          next if short_path.starts_with?('concerns')
+          
+          # car/hatchback -> Car::Hatchback
+          klass = short_path.camelize.constantize
+          # collect only AR::Base descendants
+          models[klass.table_name] = path if klass < ActiveRecord::Base
+        end
+      end
+    end
+  end
+end

data/lib/active_record/annotate/dumper.rb

@@ -0,0 +1,30 @@
+module ActiveRecord
+  module Annotate
+    module Dumper
+      class << self
+        def dump(table_name, connection = ActiveRecord::Base.connection)
+          string_io = StringIO.new
+          dumper(connection).send(:table, table_name, string_io)
+          
+          process_annotation(string_io)
+        end
+        
+      private
+        def dumper(connection)
+          ActiveRecord::SchemaDumper.send(:new, connection)
+        end
+        
+        def process_annotation(string_io)
+          string_io.string.split("\n").map do |line|
+            line.tap do |line|
+              # commenting out the line
+              line[0] = '#'
+              # replacing strings with symbols
+              line.gsub!(/"(\w+)"/, ':\1')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/annotate/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module ActiveRecord
+  module Annotate
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load 'tasks/annotate.rake'
+      end
+    end
+  end
+end

data/lib/active_record/annotate/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Annotate
+    VERSION = '0.1'
+  end
+end

data/lib/active_record/annotate/writer.rb

@@ -0,0 +1,38 @@
+module ActiveRecord
+  module Annotate
+    module Writer
+      class << self
+        def write(annotation, path)
+          new_file_content = assemble(annotation, path)
+          
+          temp_path = "#{path}.annotated"
+          File.open(temp_path, 'w') do |temp_file|
+            temp_file.puts(new_file_content)
+          end
+          
+          File.delete(path)
+          File.rename(temp_path, path)
+        end
+        
+        def assemble(annotation, path)
+          lines = File.read(path).split("\n")
+          
+          if lines.first =~ /^\s*#.*coding/
+            # encoding: utf-8 encountered on the first line
+            encoding_line = lines.shift
+          end
+          
+          while lines.first.starts_with?('#') || lines.first.blank?
+            # throw out comments and empty lines in the beginning of the file (old annotation)
+            lines.shift
+          end
+          
+          lines.unshift(*annotation, nil)
+          lines.unshift(encoding_line) unless encoding_line.nil?
+          
+          lines.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/tasks/annotate.rake

@@ -0,0 +1,6 @@
+namespace :db do
+  desc 'Annotate the models'
+  task annotate: :environment do
+    ActiveRecord::Annotate.annotate
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: active_record-annotate
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Vsevolod Romashov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds a rake task which prepends each model file with an excerpt about
+  the corresponding table from db/schema.rb
+email:
+- 7@7vn.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record-annotate.gemspec
+- lib/active_record/annotate.rb
+- lib/active_record/annotate/dumper.rb
+- lib/active_record/annotate/railtie.rb
+- lib/active_record/annotate/version.rb
+- lib/active_record/annotate/writer.rb
+- lib/tasks/annotate.rake
+homepage: https://github.com/7even/active_record-annotate
+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.0.3
+signing_key: 
+specification_version: 4
+summary: ActiveRecord models annotator based on rails' schema dumper
+test_files: []