Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mbajur committed Mar 12, 2020
0 parents commit 3776919
Show file tree
Hide file tree
Showing 59 changed files with 921 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/.bundle/
/.yardoc
/Gemfile.lock
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
2 changes: 2 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--format documentation
--color
8 changes: 8 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
language: ruby
rvm:
- 2.3.4
- 2.4.1
- 2.5.1
- 2.6.5
- 2.7.0
before_install: gem install bundler
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in pronto-rails_schema.gemspec
gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Raimondas Valickas

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.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Pronto::RailsDataSchema

Pronto runner for monitoring Rails data_schema.rb consistency.
Tool prints a warning message when data migration is present
but there are no modifications in data_schema.rb.

Based on [raimondasv/pronto-rails_schema](https://github.com/raimondasv/pronto-rails_schema)

[What is Pronto?](https://github.com/mmozuras/pronto)

[![Gem Version](https://badge.fury.io/rb/pronto-rails_data_schema.svg)](https://badge.fury.io/rb/pronto-rails_data_schema)
6 changes: 6 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task :default => :spec
51 changes: 51 additions & 0 deletions lib/pronto/rails_data_schema.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
require 'pronto'

module Pronto
class RailsDataSchema < Runner
def run
return [] unless migration_patches.any?

if schema_file_present?
schema_patch = @patches.find { |patch| detect_schema_file(patch.new_file_full_path) }
return generate_messages_for('data_schema.rb') unless changes_detected?(schema_patch)
end

[]
end

private

def schema_file_present?
File.exist?('db/data_schema.rb')
end

def migration_patches
return [] unless @patches
@migration_patches ||= @patches
.select { |patch| detect_added_migration_file(patch) }
end

def generate_messages_for(target)
migration_patches.map do |patch|
first_line = patch.added_lines.first
Message.new(patch.delta.new_file[:path], first_line, :warning,
"Data migration file detected, but no changes in #{target}",
nil, self.class)
end
end

def detect_added_migration_file(patch)
return unless patch.delta.added?
/(.*)db[\\|\/]data[\\|\/](\d{14}_([_A-Za-z]+)\.rb)$/i =~
patch.delta.new_file[:path]
end

def detect_schema_file(path)
/db[\\|\/]data_schema.rb/i =~ path.to_s
end

def changes_detected?(patch)
patch && (patch.additions > 0 || patch.deletions > 0)
end
end
end
5 changes: 5 additions & 0 deletions lib/pronto/rails_data_schema/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module Pronto
module RailsDataSchemaVersion
VERSION = "0.1.0"
end
end
30 changes: 30 additions & 0 deletions pronto-rails_schema.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'pronto/rails_data_schema/version'

Gem::Specification.new do |spec|
spec.name = "pronto-rails_data_schema"
spec.version = Pronto::RailsDataSchemaVersion::VERSION
spec.authors = ["mbajur"]
spec.email = ["[email protected]"]

spec.summary = %q{Pronto runner for detection of Rails data-migrate
schema changes.}
spec.description = %q{Detects migration files and checks for changes in
data_schema.rb file}
spec.homepage = "https://github.com/mbajur/pronto-rails_data_schema"
spec.license = "MIT"

spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]

spec.required_ruby_version = '>= 2.3.0'

spec.add_dependency 'pronto', '~> 0.10.0 '
spec.add_development_dependency "bundler"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "rspec", "~> 3.3"
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
class FirstDataMigration < ActiveRecord::Migration
def up
# Work it!
end

def down
raise ActiveRecord::IrreversibleMigration
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
class SecondDataMigration < ActiveRecord::Migration
def up
# Work it!
end

def down
raise ActiveRecord::IrreversibleMigration
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
class ThirdDataMigration < ActiveRecord::Migration
def up
# Work it!
end

def down
raise ActiveRecord::IrreversibleMigration
end
end
2 changes: 2 additions & 0 deletions spec/fixtures/test.git/db/data/non_migration_file.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
class NonMigrationFile
end
1 change: 1 addition & 0 deletions spec/fixtures/test.git/db/data_schema.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
DataMigrate::Data.define(version: 20200224211435)
1 change: 1 addition & 0 deletions spec/fixtures/test.git/git/COMMIT_EDITMSG
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Non migration file
1 change: 1 addition & 0 deletions spec/fixtures/test.git/git/HEAD
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ref: refs/heads/master
7 changes: 7 additions & 0 deletions spec/fixtures/test.git/git/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[core]
repositoryformatversion = 0
filemode = true
bare = false
logallrefupdates = true
ignorecase = true
precomposeunicode = true
1 change: 1 addition & 0 deletions spec/fixtures/test.git/git/description
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Unnamed repository; edit this file 'description' to name the repository.
15 changes: 15 additions & 0 deletions spec/fixtures/test.git/git/hooks/applypatch-msg.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/sh
#
# An example hook script to check the commit log message taken by
# applypatch from an e-mail message.
#
# The hook should exit with non-zero status after issuing an
# appropriate message if it wants to stop the commit. The hook is
# allowed to edit the commit message file.
#
# To enable this hook, rename this file to "applypatch-msg".

. git-sh-setup
commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
:
24 changes: 24 additions & 0 deletions spec/fixtures/test.git/git/hooks/commit-msg.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/bin/sh
#
# An example hook script to check the commit log message.
# Called by "git commit" with one argument, the name of the file
# that has the commit message. The hook should exit with non-zero
# status after issuing an appropriate message if it wants to stop the
# commit. The hook is allowed to edit the commit message file.
#
# To enable this hook, rename this file to "commit-msg".

# Uncomment the below to add a Signed-off-by line to the message.
# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
# hook is more suited to it.
#
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"

# This example catches duplicate Signed-off-by lines.

test "" = "$(grep '^Signed-off-by: ' "$1" |
sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
echo >&2 Duplicate Signed-off-by lines.
exit 1
}
114 changes: 114 additions & 0 deletions spec/fixtures/test.git/git/hooks/fsmonitor-watchman.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
#!/usr/bin/perl

use strict;
use warnings;
use IPC::Open2;

# An example hook script to integrate Watchman
# (https://facebook.github.io/watchman/) with git to speed up detecting
# new and modified files.
#
# The hook is passed a version (currently 1) and a time in nanoseconds
# formatted as a string and outputs to stdout all files that have been
# modified since the given time. Paths must be relative to the root of
# the working tree and separated by a single NUL.
#
# To enable this hook, rename this file to "query-watchman" and set
# 'git config core.fsmonitor .git/hooks/query-watchman'
#
my ($version, $time) = @ARGV;

# Check the hook interface version

if ($version == 1) {
# convert nanoseconds to seconds
$time = int $time / 1000000000;
} else {
die "Unsupported query-fsmonitor hook version '$version'.\n" .
"Falling back to scanning...\n";
}

my $git_work_tree;
if ($^O =~ 'msys' || $^O =~ 'cygwin') {
$git_work_tree = Win32::GetCwd();
$git_work_tree =~ tr/\\/\//;
} else {
require Cwd;
$git_work_tree = Cwd::cwd();
}

my $retry = 1;

launch_watchman();

sub launch_watchman {

my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
or die "open2() failed: $!\n" .
"Falling back to scanning...\n";

# In the query expression below we're asking for names of files that
# changed since $time but were not transient (ie created after
# $time but no longer exist).
#
# To accomplish this, we're using the "since" generator to use the
# recency index to select candidate nodes and "fields" to limit the
# output to file names only. Then we're using the "expression" term to
# further constrain the results.
#
# The category of transient files that we want to ignore will have a
# creation clock (cclock) newer than $time_t value and will also not
# currently exist.

my $query = <<" END";
["query", "$git_work_tree", {
"since": $time,
"fields": ["name"],
"expression": ["not", ["allof", ["since", $time, "cclock"], ["not", "exists"]]]
}]
END

print CHLD_IN $query;
close CHLD_IN;
my $response = do {local $/; <CHLD_OUT>};

die "Watchman: command returned no output.\n" .
"Falling back to scanning...\n" if $response eq "";
die "Watchman: command returned invalid output: $response\n" .
"Falling back to scanning...\n" unless $response =~ /^\{/;

my $json_pkg;
eval {
require JSON::XS;
$json_pkg = "JSON::XS";
1;
} or do {
require JSON::PP;
$json_pkg = "JSON::PP";
};

my $o = $json_pkg->new->utf8->decode($response);

if ($retry > 0 and $o->{error} and $o->{error} =~ m/unable to resolve root .* directory (.*) is not watched/) {
print STDERR "Adding '$git_work_tree' to watchman's watch list.\n";
$retry--;
qx/watchman watch "$git_work_tree"/;
die "Failed to make watchman watch '$git_work_tree'.\n" .
"Falling back to scanning...\n" if $? != 0;

# Watchman will always return all files on the first query so
# return the fast "everything is dirty" flag to git and do the
# Watchman query just to get it over with now so we won't pay
# the cost in git to look up each individual file.
print "/\0";
eval { launch_watchman() };
exit 0;
}

die "Watchman: $o->{error}.\n" .
"Falling back to scanning...\n" if $o->{error};

binmode STDOUT, ":utf8";
local $, = "\0";
print @{$o->{files}};
}
8 changes: 8 additions & 0 deletions spec/fixtures/test.git/git/hooks/post-update.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/sh
#
# An example hook script to prepare a packed repository for use over
# dumb transports.
#
# To enable this hook, rename this file to "post-update".

exec git update-server-info
14 changes: 14 additions & 0 deletions spec/fixtures/test.git/git/hooks/pre-applypatch.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/bin/sh
#
# An example hook script to verify what is about to be committed
# by applypatch from an e-mail message.
#
# The hook should exit with non-zero status after issuing an
# appropriate message if it wants to stop the commit.
#
# To enable this hook, rename this file to "pre-applypatch".

. git-sh-setup
precommit="$(git rev-parse --git-path hooks/pre-commit)"
test -x "$precommit" && exec "$precommit" ${1+"$@"}
:
Loading

0 comments on commit 3776919

Please sign in to comment.