annotated 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d482af89c3c8604e623643518198a72d411cde71d96e04e2a08910716711b8c
-  data.tar.gz: b132a0836e7d94299cf4b64f076e710c4a1d43c62dbdbc154212b46bd6850b1a
+  metadata.gz: 234cffd4332e9173022d1c644686205b444f88a6526cc7770ba25d4ca7d2bb0a
+  data.tar.gz: 80e0347ce4b6ed394fa7a3768844f39e3f831b215dbfb638cd44855b1547295d
 SHA512:
-  metadata.gz: 77bbf002d2bcadfaf71566d0388292a36c50c63c0d34e118ec5857d5a4f78f821435bab357c846420973f679e848f8c99b850c7bff22262a3c74dd6bf9c1f533
-  data.tar.gz: fee5fd49afa0994fdf876f9c9ab8765678a9653b6fdd3fbed3e3cbffc03c535ab42f1155aeb96470ad47955ae27d8894d8f442b9c868d73b4c8076bd24794996
+  metadata.gz: a50b1e0aa1e41c55ce7a95d8d97a00c621861f06130c8342269960913317cd1dbf456e9224507b79e0c78062bb0b398c936b7e45f7870060ca4bb1db46feb056
+  data.tar.gz: cd129ad31470998d38d7973ae67364eeec25c1441562660d9762be36452baf2456c4c0eba6c0ac99eb5a5131b80263f8f27bea2f448d76165ce2a4a416262d52

data/README.md

@@ -1,10 +1,14 @@
-## Annotated (fork of Annotate aka AnnotateModels)
+## Annotated (drop-in fork of Annotate aka AnnotateModels)
+
+> This is a fork of the [annotate](https://github.com/ctran/annotate_models) gem, created to provide ongoing maintenance and updates while maintaining drop-in compatibility. This fork was created in response to the original gem's maintenance status (see [discussion](https://github.com/ctran/annotate_models/issues/1028)) and serves as an alternative to [annotaterb](https://github.com/drwl/annotaterb) which introduces breaking changes.
+> 
+> Unlike annotaterb, this gem aims to be a direct drop-in replacement for the original annotate gem, allowing users to migrate without any minimal to their existing configuration or workflow.
+
+
+[![Gem Version](https://badge.fury.io/rb/annotated.svg)](http://badge.fury.io/rb/annotated)
+[![Downloads count](https://img.shields.io/gem/dt/annotated.svg?style=flat)](https://rubygems.org/gems/annotated)
+[![CI Status](https://github.com/thedumbtechguy/annotated/workflows/CI/badge.svg)](https://github.com/thedumbtechguy/annotated/actions?workflow=CI)
 
-[![Gem Version](https://badge.fury.io/rb/annotate.svg)](http://badge.fury.io/rb/annotate)
-[![Downloads count](https://img.shields.io/gem/dt/annotate.svg?style=flat)](https://rubygems.org/gems/annotate)
-[![CI Status](https://github.com/ctran/annotate_models/workflows/CI/badge.svg)](https://github.com/ctran/annotate_models/actions?workflow=CI)
-[![Coveralls](https://coveralls.io/repos/ctran/annotate_models/badge.svg?branch=develop)](https://coveralls.io/r/ctran/annotate_models?branch=develop)
-[![Maintenability](https://codeclimate.com/github/ctran/annotate_models/badges/gpa.svg)](https://codeclimate.com/github/ctran/annotate_models)
 
 Add a comment summarizing the current schema to the top or bottom of each of your...
 
@@ -82,7 +86,7 @@ Into Gemfile from rubygems.org:
 
 ```ruby
 group :development do
-  gem 'annotate'
+  gem 'annotated'
 end
 ```
 
@@ -90,20 +94,15 @@ Into Gemfile from Github:
 
 ```ruby
 group :development do
-  gem 'annotate', git: 'https://github.com/ctran/annotate_models.git'
+  gem 'annotated', git: 'https://github.com/thedumbtechguy/annotated.git'
 end
 ```
 
 Into environment gems from rubygems.org:
 
-    gem install annotate
+    gem install annotated
 
-Into environment gems from Github checkout:
 
-    git clone https://github.com/ctran/annotate_models.git annotate_models
-    cd annotate_models
-    rake gem
-    gem install dist/annotate-*.gem
 
 ## Usage
 
@@ -112,32 +111,38 @@ Into environment gems from Github checkout:
 ### Usage in Rails
 
 To annotate all your models, tests, fixtures, and factories:
-
+```bash
     cd /path/to/app
-    annotate
+    bundle exec annotate
+```
 
 To annotate just your models, tests, and factories:
-
-    annotate --models --exclude fixtures
+```bash
+    bundle exec annotate --models --exclude fixtures
+```
 
 To annotate just your models:
-
-    annotate --models
+```bash
+    bundle exec annotate --models
+```
 
 To annotate routes.rb:
-
-    annotate --routes
+```bash
+    bundle exec annotate --routes
+```
 
 To remove model/test/fixture/factory/serializer annotations:
-
-    annotate --delete
+```bash
+    bundle exec annotate --delete
+```
 
 To remove routes.rb annotations:
-
-    annotate --routes --delete
+```bash
+    bundle exec annotate --routes --delete
+```
 
 To automatically annotate every time you run `db:migrate`,
-either run `rails g annotate:install`
+either run `rails g annotated:install`
 or add `Annotated.load_tasks` to your `Rakefile`.
 
 See the [configuration in Rails](#configuration-in-rails) section for more info.

data/annotated.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
 
   spec.files = Dir.glob(%w[LICENSE.txt *.md *.gemspec bin/* lib/**/*])
   spec.bindir = "bin"
-  spec.executables = ["annotated"]
+  spec.executables = ["annotate"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord", ">= 3.2"

data/bin/{annotated → annotate}

@@ -28,5 +28,5 @@ options = Annotated.setup_options(
 )
 Annotated.eager_load(options) if Annotated::Helpers.include_models?
 
-AnnotatedModels.send(options_result[:target_action], options) if Annotated::Helpers.include_models?
-AnnotatedRoutes.send(options_result[:target_action], options) if Annotated::Helpers.include_routes?
+AnnotateModels.send(options_result[:target_action], options) if Annotated::Helpers.include_models?
+AnnotateRoutes.send(options_result[:target_action], options) if Annotated::Helpers.include_routes?

data/lib/annotated/version.rb

@@ -1,5 +1,5 @@
 module Annotated
   def self.version
-    "0.0.1"
+    "0.0.3"
   end
 end

data/lib/annotated.rb

@@ -143,5 +143,3 @@ module Annotated
     end
   end
 end
-
-# Annotate = Annotated unless defined?(Annotate)

data/lib/generators/{annotate → annotated}/install_generator.rb

@@ -1,4 +1,4 @@
-require "annotate"
+require "annotated"
 
 module Annotated
   module Generators

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotated
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Stefan Froelich
@@ -39,7 +39,7 @@ email:
 - turadg@aleahmad.net
 - jon@cloudability.com
 executables:
-- annotated
+- annotate
 extensions: []
 extra_rdoc_files: []
 files:
@@ -49,7 +49,7 @@ files:
 - README.md
 - RELEASE.md
 - annotated.gemspec
-- bin/annotated
+- bin/annotate
 - lib/annotated.rb
 - lib/annotated/active_record_patch.rb
 - lib/annotated/annotate_models.rb
@@ -62,9 +62,9 @@ files:
 - lib/annotated/parser.rb
 - lib/annotated/tasks.rb
 - lib/annotated/version.rb
-- lib/generators/annotate/USAGE
-- lib/generators/annotate/install_generator.rb
-- lib/generators/annotate/templates/auto_annotate_models.rake
+- lib/generators/annotated/USAGE
+- lib/generators/annotated/install_generator.rb
+- lib/generators/annotated/templates/auto_annotate_models.rake
 - lib/tasks/annotate_models.rake
 - lib/tasks/annotate_models_migrate.rake
 - lib/tasks/annotate_routes.rake