activerecord-migration_notes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 918a80da6c0de93012f575c35e570ec22f9af9c2
+  data.tar.gz: 1c4991e6e9de395d55de45bdc1af780042ca727e
+SHA512:
+  metadata.gz: c70923dc7ccaa93416749c4eeaef5532c62a66330752eaf5f22dc5a05d32bd66a96bc057bad003aa19995c1203898167d2ab47ed7e51dedd25c87ef8ec131dcd
+  data.tar.gz: 9c03578c7c6489d046c05e922999bd7daf8ff603beaf5237888365f07bb62fef9517f7f9559172db62d462659ae2fc76cd7564e0010d8a1e3cb9a671df6444d9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-migration_notes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Manuel van Rijn
+
+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,71 @@
+# ActiveRecord::MigrationNotes
+
+ActiveRecord Migration Notes hooks into the Rails migrations and monitors if the migrations contain a note methods that should be shown afterwards.
+
+## Why?
+
+Have you ever been in a situation where you have to deploy some code and forgot what special things you had to execute manually after a migration?
+
+Searching for this answer within pull requests, issues, code comments, tickets, emails, faxes made me think this should be easier.
+
+Why not give the developer who creates the migration, an easy way to add some additional notes to the migration?
+
+![image](https://i.imgur.com/P2H99Fy.png)
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'activerecord-migration_notes'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+You can now add two new methods within your migration called `up_notes` (trigged on `rake db:migrate`) and `down_notes` (triggered on `rake db:rollback`).
+
+Both these methods are optional and you do not have to specify them both.
+
+### Example
+
+```ruby
+class AddSomeBreakingChanges < ActiveRecord::Migration
+  def change
+    # your normal migration task
+  end
+
+  def up_notes
+    <<-NOTES
+      Please run the following manually to not break the DB!
+
+      $ rake some_task
+    NOTES
+  end
+
+  def down_notes
+    "All is well no additional notes"
+  end
+end
+```
+
+## TODO
+
+* test if we covered all other cases like `db:down` and `db:up`
+* ... more?
+* probably add some docs
+
+## 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
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activerecord-migration_notes.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/migration_notes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-migration_notes'
+  spec.version       = ActiveRecord::MigrationNotes::VERSION
+  spec.authors       = ['Manuel van Rijn']
+  spec.email         = ['manuel@manuelvanrijn.nl']
+
+  spec.summary       = 'Add notes to your migrations, to explain additional steps to take for example'
+  spec.description   = 'ActiveRecord Migration Notes hooks into the Rails migrations and monitors if the migrations contain a note methods that should be shown afterwards.'
+  spec.homepage      = 'http://manuelvanrijn.nl'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'activerecord', '>= 4.2'
+end

data/lib/active_record/migration_notes/handler.rb

@@ -0,0 +1,76 @@
+require 'singleton'
+
+module ActiveRecord
+  module MigrationNotes
+    class Handler
+      include Singleton
+
+      attr_accessor :notes
+
+      def initialize
+        @notes = []
+      end
+
+      def add(version, name, content, direction = :up)
+        content = '   ' + content.split("\n").map(&:strip).join("\n   ")
+        notes << { version: version, name: name, content: content,
+                   direction: direction }
+      rescue
+        nil
+      end
+
+      def output
+        migration_notes unless notes.empty?
+        @notes = []
+      end
+
+      private
+
+      def migration_notes
+        migration_notes_header
+
+        notes.each do |note|
+          say_message(note)
+        end
+
+        migration_notes_footer
+      end
+
+      def say_message(note)
+        puts title(note)
+        puts note[:content]
+        puts '' unless notes.last == note
+      end
+
+      def title(note)
+        title = case note[:direction]
+                when :up    then '»» MIGRATED'
+                when :down  then '«« REVERTED'
+                end
+        title += " - #{note[:name]}"
+        len = [0, 77 - (title.length + note[:version].to_s.length)].max
+        format('%s %s %s', colorize(title, 33), ' ' * len, note[:version])
+      end
+
+      def migration_notes_header
+        text = 'MIGRATION NOTES:'
+        len = [0, 75 - text.length].max
+        puts format('== %s %s', colorize(text, 36), '=' * len)
+      end
+
+      def migration_notes_footer
+        puts '=' * 79
+      end
+
+      def colorize(str, color_code)
+        return str unless terminal_supports_colors?
+        "\e[#{color_code}m#{str}\e[0m"
+      end
+
+      def terminal_supports_colors?
+        cmd = 'which tput>/dev/null 2>&1 && [[ $(tput -T$TERM colors) -ge 8 ]]'
+        system(cmd)
+      end
+    end
+  end
+end

data/lib/active_record/migration_notes/migration.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  class Migration
+    alias _original_migrate migrate
+
+    def migrate(direction)
+      _original_migrate(direction)
+      case direction
+      when :up
+        return unless respond_to?(:up_notes)
+        MigrationNotes::Handler.instance.add(version, name, up_notes, :up)
+      when :down
+        return unless respond_to?(:down_notes)
+        MigrationNotes::Handler.instance.add(version, name, down_notes, :down)
+      end
+    end
+  end
+end

data/lib/active_record/migration_notes/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module ActiveRecord
+  module MigrationNotes
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load File.join(File.dirname(__FILE__), 'tasks.rake')
+      end
+    end
+  end
+end

data/lib/active_record/migration_notes/tasks.rake

@@ -0,0 +1,9 @@
+task :migration_notes do
+  ActiveRecord::MigrationNotes::Handler.instance.output
+end
+
+%w(db:migrate db:rollback).each do |task|
+  Rake::Task[task].enhance do
+    Rake::Task[:migration_notes].invoke
+  end
+end

data/lib/active_record/migration_notes/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module MigrationNotes
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/activerecord-migration_notes.rb

@@ -0,0 +1,7 @@
+# rubocop:disable Style/FileName
+require 'active_record'
+# rubocop:enable Style/FileName
+require 'active_record/migration_notes/migration'
+require 'active_record/migration_notes/handler'
+require 'active_record/migration_notes/railtie' if defined? Rails
+require 'active_record/migration_notes/version'

data/spec/active_record/migration_notes/handler_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe ActiveRecord::MigrationNotes::Handler do
+  subject { ActiveRecord::MigrationNotes::Handler.instance }
+
+  it 'initializes with an empty message array' do
+    expect(subject.notes).to eq []
+  end
+
+  before :each do
+    subject.notes = []
+  end
+  describe '#add' do
+    it 'adds the input as message' do
+      subject.add(1234, 'test', 'some content')
+      expect(subject.notes.count).to eq 1
+    end
+    it 'rescues if something goes wrong' do
+      expect(subject.add(nil, nil, nil)).to eq nil
+      expect(subject.notes.count).to eq 0
+    end
+    describe 'formats the content' do
+      it 'removes the trailing spaces at the beginnen and adds 3 spaces instead' do
+        content = "line
+          text
+                some more"
+        subject.add(1, 'test', content)
+        expect(subject.notes.first[:content]).to eq "   line\n   text\n   some more"
+      end
+    end
+  end
+
+  describe '#output' do
+    it 'skips the call migration_notes if there are no messages' do
+      expect(subject).not_to receive(:migration_notes)
+      subject.output
+    end
+    it 'calls migration_notes if there are messages' do
+      subject.add(1234, 'test', 'some content')
+      expect(subject).to receive(:migration_notes)
+      subject.output
+    end
+    it 'clears the messages afterwards' do
+      subject.add(1234, 'test', 'some content')
+      allow(subject).to receive(:migration_notes)
+      expect(subject.notes.count).to eq 1
+      subject.output
+      expect(subject.notes.count).to eq 0
+    end
+  end
+
+  describe '#migration_notes' do
+    it 'calls the header and footer' do
+      expect(subject).to receive(:migration_notes_header)
+      expect(subject).to receive(:migration_notes_footer)
+      subject.send(:migration_notes)
+    end
+    it 'loops trough the messages and calls say_message' do
+      allow(subject).to receive(:migration_notes_header)
+      allow(subject).to receive(:migration_notes_footer)
+
+      expect(subject.notes).to receive(:each).and_yield 1
+      expect(subject).to receive(:say_message).with(1)
+      subject.send(:migration_notes)
+    end
+  end
+
+  describe '#say_message' do
+    before :each do
+      subject.notes = []
+      subject.add(1, 'name-1', 'content-1', :up)
+      subject.add(2, 'name-2', 'content-2', :down)
+    end
+    it 'outputs the version and name and content' do
+      expect(subject).to receive(:puts).with("\e[33m»» MIGRATED - name-1\e[0m                                                          1")
+      expect(subject).to receive(:puts).with('   content-1')
+      expect(subject).to receive(:puts).with('')
+      subject.send(:say_message, subject.notes.first)
+    end
+    it 'will not add a blank line if message was the last message' do
+      expect(subject).to receive(:puts).with("\e[33m«« REVERTED - name-2\e[0m                                                          2")
+      expect(subject).to receive(:puts).with('   content-2')
+      expect(subject).not_to receive(:puts).with('')
+      subject.send(:say_message, subject.notes.last)
+    end
+  end
+
+  describe '#migration_notes_header' do
+    it 'outputs the header text' do
+      header = "== \e[36mMIGRATION NOTES:\e[0m ==========================================================="
+      expect(subject).to receive('puts').with(header)
+      subject.send(:migration_notes_header)
+    end
+  end
+
+  describe '#migration_notes_footer' do
+    it 'outputs the footer text' do
+      footer = '==============================================================================='
+      expect(subject).to receive('puts').with(footer)
+      subject.send(:migration_notes_footer)
+    end
+  end
+
+  describe '#colorize' do
+    it 'returns the str if terminal_supports_colors? is false' do
+      expect(subject).to receive(:terminal_supports_colors?) { false }
+      expect(subject.send(:colorize, 'content', 36)).to eq 'content'
+    end
+    it 'returns the color formatted string' do
+      expect(subject).to receive(:terminal_supports_colors?) { true }
+      expect(subject.send(:colorize, 'content', 36)).to eq "\e[36mcontent\e[0m"
+    end
+  end
+
+  describe '#terminal_supports_colors?' do
+    it 'executes the system call to check terminal color support' do
+      cmd = 'which tput>/dev/null 2>&1 && [[ $(tput -T$TERM colors) -ge 8 ]]'
+      expect(subject).to receive(:system).with(cmd)
+      subject.send(:terminal_supports_colors?)
+    end
+  end
+end

data/spec/active_record/migration_notes/migration_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe ActiveRecord::Migration do
+  subject { ActiveRecord::Migration.new }
+
+  describe '#migrate' do
+    it 'triggers the original aliased method' do
+      expect(subject).to receive(:_original_migrate).with(:up)
+      subject.migrate(:up)
+    end
+
+    describe 'message handling' do
+      before :each do
+        allow(subject).to receive(:_original_migrate)
+        subject.version = 1
+        subject.name = 'name'
+      end
+      context 'direction is up' do
+        it 'adds the message if migration responds to up_notes' do
+          expect(subject).to receive(:up_notes) { 'content' }
+          expect(ActiveRecord::MigrationNotes::Handler.instance)
+            .to receive(:add).with(1, 'name', 'content', :up)
+          subject.migrate(:up)
+        end
+        it 'skips if migration has no up_notes method' do
+          expect(ActiveRecord::MigrationNotes::Handler.instance)
+            .not_to receive(:add)
+          subject.migrate(:up)
+        end
+      end
+      context 'direction is down' do
+        it 'adds the message if migration responds to down_notes' do
+          expect(subject).to receive(:down_notes) { 'content' }
+          expect(ActiveRecord::MigrationNotes::Handler.instance)
+            .to receive(:add).with(1, 'name', 'content', :down)
+          subject.migrate(:down)
+        end
+        it 'skips if migration has no down_notes method' do
+          expect(ActiveRecord::MigrationNotes::Handler.instance)
+            .not_to receive(:add)
+          subject.migrate(:down)
+        end
+      end
+    end
+  end
+end

data/spec/active_record/migration_notes/post_message_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ActiveRecord::MigrationNotes do
+  it 'has a version number' do
+    expect(ActiveRecord::MigrationNotes::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'activerecord-migration_notes'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-migration_notes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manuel van Rijn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: ActiveRecord Migration Notes hooks into the Rails migrations and monitors
+  if the migrations contain a note methods that should be shown afterwards.
+email:
+- manuel@manuelvanrijn.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-migration_notes.gemspec
+- lib/active_record/migration_notes/handler.rb
+- lib/active_record/migration_notes/migration.rb
+- lib/active_record/migration_notes/railtie.rb
+- lib/active_record/migration_notes/tasks.rake
+- lib/active_record/migration_notes/version.rb
+- lib/activerecord-migration_notes.rb
+- spec/active_record/migration_notes/handler_spec.rb
+- spec/active_record/migration_notes/migration_spec.rb
+- spec/active_record/migration_notes/post_message_spec.rb
+- spec/spec_helper.rb
+homepage: http://manuelvanrijn.nl
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Add notes to your migrations, to explain additional steps to take for example
+test_files:
+- spec/active_record/migration_notes/handler_spec.rb
+- spec/active_record/migration_notes/migration_spec.rb
+- spec/active_record/migration_notes/post_message_spec.rb
+- spec/spec_helper.rb