active_record-annotate 0.2 → 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 184d08a11090e8bd9d9d4e83aff9323f13c003ec
+  data.tar.gz: 309a4a90edb9aea169198585ad1ec1ed247c8797
+SHA512:
+  metadata.gz: 93170988da55b445e19743d7d627888c355df51861c14b72f78e71d42fffd5dc51f084481575e3b5402dc2daeaed5433d81fd4270db9dc3da37e81aa89dc80d0
+  data.tar.gz: 39fbba81d3b8b3d8de4f171c553a6272df9499f8c40c951c98d122dd096606519b6dd722f3fb5376e1d193b19f6473db5c4f591ff3f32b5b245d26f6fd9addae

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0

data/README.md

@@ -6,15 +6,15 @@ ActiveRecord::Annotate is a simple ActiveRecord plugin for annotating your rails
 
 Trivial.
 
-``` ruby
+```ruby
 # Gemfile
 group :development do
   # you don't want to annotate your models in production, do you?
-  gem 'active_record-annotate', '~> 0.2'
+  gem 'active_record-annotate', '~> 0.3'
 end
 ```
 
-``` sh
+```sh
 $ bundle
 ```
 
@@ -24,13 +24,13 @@ Gem adds a simple `db:annotate` rake task - it just writes the annotation to the
 
 Once you install the gem into your application it hooks `db:annotate` to run after each `db:migrate` / `db:rollback` to keep the annotations in sync with the DB schema, but if you added a new model without migrating (or just accidentally messed up with something) you can always run the annotation process by hand:
 
-``` sh
+```sh
 $ rake db:annotate
 ```
 
 This is what a common annotation looks like:
 
-``` ruby
+```ruby
 # create_table :documents, force: true do |t|
 #   t.string   :title
 #   t.text     :content
@@ -45,17 +45,29 @@ class Document < ActiveRecord::Base
 # ...
 ```
 
+### Configuration
+
+The annotation process can be configured via the `ActiveRecord::Annotate.configure` block which is handy to keep in the initializer.
+
+You can generate the basic initializer with a built-in generator:
+
+```sh
+$ rails generate active_record:annotate:install
+```
+
+It creates an initializer at `config/initializers/annotate.rb` which contains descriptive comments about all settings (currently just one setting, `yard`).
+
 ## Changelog
 
 * 0.1 Initial version with core functionality
 * 0.1.1 Support for several models per table
 * 0.2 Auto-annotation after `db:migrate` & `db:rollback`, basic output
+* 0.3 Configuration and YARD code blocks support
 
 ## Roadmap
 
 * Cover everything with tests
 * Write YARD docs
-* Add some means to configure the annotation process (annotation format, a place to put it)
 
 ## Contributing
 

data/lib/active_record/annotate.rb

@@ -1,3 +1,4 @@
+require 'active_record/annotate/configurator'
 require 'active_record/annotate/dumper'
 require 'active_record/annotate/file'
 require 'active_record/annotate/version'
@@ -14,7 +15,7 @@ module ActiveRecord
           
           file_paths_and_classes.each do |path, klass|
             file = File.new(path)
-            file.annotate_with(annotation)
+            file.annotate_with(annotation, configurator)
             
             if file.changed?
               file.write
@@ -59,10 +60,18 @@ module ActiveRecord
         short_path.camelize.constantize
       end
       
+      def configure(&block)
+        configurator.tap(&block)
+      end
+      
     private
       def models_dir
         Rails.root.join('app/models')
       end
+      
+      def configurator
+        @configurator ||= Configurator.new
+      end
     end
   end
 end

data/lib/active_record/annotate/configurator.rb

@@ -0,0 +1,19 @@
+module ActiveRecord
+  module Annotate
+    class Configurator
+      %w(yard).each do |setting|
+        attr_accessor setting
+        alias_method "#{setting}?", setting
+      end
+      
+      def initialize
+        reset
+      end
+      
+    private
+      def reset
+        @yard = false
+      end
+    end
+  end
+end

data/lib/active_record/annotate/dumper.rb

@@ -15,7 +15,7 @@ module ActiveRecord
         end
         
         def process_annotation(string_io)
-          string_io.string.split("\n").map do |line|
+          string_io.string.split(?\n).map do |line|
             line.tap do |line|
               # commenting out the line
               line[0] = '#'

data/lib/active_record/annotate/file.rb

@@ -9,7 +9,7 @@ module ActiveRecord
         @lines   = @content.split(?\n)
       end
       
-      def annotate_with(annotation)
+      def annotate_with(annotation, configurator)
         if @lines.first =~ /^\s*#.*coding/
           # encoding: utf-8 encountered on the first line
           encoding_line = @lines.shift
@@ -21,6 +21,11 @@ module ActiveRecord
           @lines.shift
         end
         
+        if configurator.yard?
+          backticks = '# ```'
+          annotation.unshift(backticks).push(backticks)
+        end
+        
         @lines.unshift(*annotation, nil)
         @lines.unshift(encoding_line) unless encoding_line.nil?
         @lines.push(nil) # newline at the end of file

data/lib/active_record/annotate/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Annotate
-    VERSION = '0.2'
+    VERSION = '0.3'
   end
 end

data/lib/generators/active_record/annotate/install/install_generator.rb

@@ -0,0 +1,8 @@
+class ActiveRecord::Annotate::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  
+  desc 'Creates an ActiveRecord::Annotate initializer in config/initializers/annotate.rb'
+  def create_initializer
+    copy_file 'initializer.rb', 'config/initializers/annotate.rb'
+  end
+end

data/lib/generators/active_record/annotate/install/templates/initializer.rb

@@ -0,0 +1,7 @@
+require 'active_record/annotate'
+
+ActiveRecord::Annotate.configure do |config|
+  # set this to true to wrap annotations in triple backticks (```)
+  # so YARD documentation can process the annotation as a code block
+  # config.yard = false
+end

data/spec/active_record/annotate/configurator_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe ActiveRecord::Annotate::Configurator do
+  describe "#initialize" do
+    it "resets all settings to their default values" do
+      expect(subject.yard).to be_false
+    end
+  end
+  
+  describe "attr_accessors" do
+    it "read and write settings' values" do
+      expect(subject.yard).to be_false
+      
+      subject.yard = true
+      expect(subject.yard).to be_true
+    end
+  end
+end

data/spec/active_record/annotate/file_spec.rb

@@ -46,6 +46,22 @@ end
 #   t.integer :age, null: false, default: 0
 # end
 
+class User < ActiveRecord::Base
+  has_many :posts
+end
+    FILE
+  end
+  
+  let(:expected_result_for_yard) do
+    <<-FILE
+# encoding: utf-8
+# ```
+# create_table :users do |t|
+#   t.string :name
+#   t.integer :age, null: false, default: 0
+# end
+# ```
+
 class User < ActiveRecord::Base
   has_many :posts
 end
@@ -53,20 +69,36 @@ end
   end
   
   let(:file) { ActiveRecord::Annotate::File.new(file_path) }
+  let(:configurator) { ActiveRecord::Annotate::Configurator.new }
   
   describe "#annotate_with" do
     it "changes the lines adding the new annotation" do
-      file.annotate_with(new_annotation)
+      file.annotate_with(new_annotation, configurator)
       
       processed_file_content = file.lines.join(?\n)
       expect(processed_file_content).to eq(expected_result)
     end
+    
+    context "when yard setting is on" do
+      let(:configurator) do
+        ActiveRecord::Annotate::Configurator.new.tap do |configurator|
+          configurator.yard = true
+        end
+      end
+      
+      it "adds triple backticks around the annotation" do
+        file.annotate_with(new_annotation, configurator)
+        
+        processed_file_content = file.lines.join(?\n)
+        expect(processed_file_content).to eq(expected_result_for_yard)
+      end
+    end
   end
   
   describe "#changed?" do
     context "with an old annotation" do
       before(:each) do
-        file.annotate_with(old_annotation)
+        file.annotate_with(old_annotation, configurator)
       end
       
       it "returns false" do
@@ -76,7 +108,7 @@ end
     
     context "with a new annotation" do
       before(:each) do
-        file.annotate_with(new_annotation)
+        file.annotate_with(new_annotation, configurator)
       end
       
       it "returns true" do
@@ -87,7 +119,7 @@ end
   
   describe "#write" do
     before(:each) do
-      file.annotate_with(new_annotation)
+      file.annotate_with(new_annotation, configurator)
     end
     
     it "writes the new contents to file" do

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: active_record-annotate
 version: !ruby/object:Gem::Version
-  version: '0.2'
-  prerelease: 
+  version: '0.3'
 platform: ruby
 authors:
 - Vsevolod Romashov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Adds a rake task which prepends each model file with an excerpt about
@@ -131,9 +116,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -141,46 +126,44 @@ files:
 - Rakefile
 - active_record-annotate.gemspec
 - lib/active_record/annotate.rb
+- lib/active_record/annotate/configurator.rb
 - lib/active_record/annotate/dumper.rb
 - lib/active_record/annotate/file.rb
 - lib/active_record/annotate/railtie.rb
 - lib/active_record/annotate/version.rb
+- lib/generators/active_record/annotate/install/install_generator.rb
+- lib/generators/active_record/annotate/install/templates/initializer.rb
 - lib/tasks/annotate.rake
+- spec/active_record/annotate/configurator_spec.rb
 - spec/active_record/annotate/file_spec.rb
 - spec/active_record/annotate_spec.rb
 - spec/spec_helper.rb
 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
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3616105738017822554
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3616105738017822554
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ActiveRecord models annotator based on rails' schema dumper
 test_files:
+- spec/active_record/annotate/configurator_spec.rb
 - spec/active_record/annotate/file_spec.rb
 - spec/active_record/annotate_spec.rb
 - spec/spec_helper.rb