loggable_activity 0.2.1c → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +29 -42
- data/.vscode/commands.json +2 -2
- data/.vscode/terminals.json +8 -8
- data/CHANGELOG.md +0 -3
- data/CHEAT_SHEET.md +31 -0
- data/MIT-LICENSE +21 -0
- data/README.md +31 -45
- data/Rakefile +6 -4
- data/app/assets/config/loggable_activity_manifest.js +4 -0
- data/app/assets/javascripts/loggable_activity/application.js +2 -0
- data/app/assets/stylesheets/loggable_activity/application.scss +20 -0
- data/app/controllers/concerns/.keep +0 -0
- data/app/controllers/loggable_activity/activities_controller.rb +12 -0
- data/app/controllers/loggable_activity/application_controller.rb +6 -0
- data/app/helpers/loggable_activity/activities_helper.rb +17 -0
- data/app/helpers/loggable_activity/application_helper.rb +6 -0
- data/app/jobs/loggable_activity/application_job.rb +6 -0
- data/app/mailers/loggable_activity/application_mailer.rb +8 -0
- data/app/models/loggable_activity/application_record.rb +7 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_first_page.html.erb +14 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_gap.html.erb +8 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_last_page.html.erb +13 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_next_page.html.erb +13 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_page.html.erb +14 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_paginator.html.erb +27 -0
- data/app/views/kaminari/kaminari-turbo-bootstrap/_prev_page.html.erb +14 -0
- data/app/views/layouts/loggable_activity/application.html.erb +19 -0
- data/app/views/loggable_activity/activities/_activities.html.erb +56 -0
- data/app/views/loggable_activity/activities/index.html.erb +7 -0
- data/app/views/loggable_activity/activities/show.html.erb +2 -0
- data/config/initializers/kaminari_config.rb +14 -0
- data/config/routes.rb +7 -0
- data/{lib/generators/loggable_activity/templates/create_loggable_activities.rb → db/migrate/20240702092648_create_loggable_activity_tables.rb} +18 -10
- data/git-org/HEAD +1 -0
- data/git-org/config +7 -0
- data/git-org/description +1 -0
- data/git-org/hooks/applypatch-msg.sample +15 -0
- data/git-org/hooks/commit-msg.sample +24 -0
- data/git-org/hooks/fsmonitor-watchman.sample +174 -0
- data/git-org/hooks/post-update.sample +8 -0
- data/git-org/hooks/pre-applypatch.sample +14 -0
- data/git-org/hooks/pre-commit.sample +49 -0
- data/git-org/hooks/pre-merge-commit.sample +13 -0
- data/git-org/hooks/pre-push.sample +53 -0
- data/git-org/hooks/pre-rebase.sample +169 -0
- data/git-org/hooks/pre-receive.sample +24 -0
- data/git-org/hooks/prepare-commit-msg.sample +42 -0
- data/git-org/hooks/push-to-checkout.sample +78 -0
- data/git-org/hooks/update.sample +128 -0
- data/git-org/info/exclude +6 -0
- data/lib/loggable_activity/activity.rb +3 -3
- data/lib/{schemas → loggable_activity}/config_schema.json +3 -3
- data/lib/loggable_activity/configuration.rb +51 -74
- data/lib/loggable_activity/data_owner.rb +0 -1
- data/lib/loggable_activity/encryption.rb +16 -7
- data/lib/loggable_activity/encryption_key.rb +4 -7
- data/lib/loggable_activity/engine.rb +27 -0
- data/lib/loggable_activity/error.rb +0 -10
- data/lib/loggable_activity/hooks.rb +10 -5
- data/lib/loggable_activity/payload.rb +8 -11
- data/lib/loggable_activity/sanitizer.rb +6 -2
- data/lib/loggable_activity/services/base_payloads_builder.rb +14 -5
- data/lib/loggable_activity/services/destroy_payloads_builder.rb +2 -1
- data/lib/loggable_activity/services/payloads_builder.rb +9 -2
- data/lib/loggable_activity/services/update_payloads_builder.rb +30 -2
- data/lib/loggable_activity/version.rb +1 -1
- data/lib/loggable_activity.rb +51 -14
- data/lib/tasks/loggable_activity_tasks.rake +6 -0
- metadata +126 -114
- data/.document +0 -1
- data/.nojekyll +0 -1
- data/.rspec +0 -3
- data/CONSIDERTIONS.md +0 -129
- data/GETTING-STARTED.md +0 -119
- data/LICENSE.txt +0 -21
- data/PAYLOAD_EXAMPLE.md +0 -63
- data/ROADMAP.md +0 -23
- data/docs/LoggableActivity/Activity.html +0 -555
- data/docs/LoggableActivity/Configuration.html +0 -330
- data/docs/LoggableActivity/ConfigurationError.html +0 -148
- data/docs/LoggableActivity/DataOwner.html +0 -138
- data/docs/LoggableActivity/Encryption.html +0 -234
- data/docs/LoggableActivity/EncryptionError.html +0 -145
- data/docs/LoggableActivity/EncryptionKey.html +0 -351
- data/docs/LoggableActivity/Error.html +0 -145
- data/docs/LoggableActivity/Hooks.html +0 -759
- data/docs/LoggableActivity/Payload.html +0 -432
- data/docs/LoggableActivity/Services/BasePayloadsBuilder.html +0 -442
- data/docs/LoggableActivity/Services/DestroyPayloadsBuilder.html +0 -395
- data/docs/LoggableActivity/Services/PayloadsBuilder.html +0 -342
- data/docs/LoggableActivity/Services/UpdatePayloadsBuilder.html +0 -490
- data/docs/LoggableActivity/Services.html +0 -93
- data/docs/LoggableActivity.html +0 -102
- data/docs/created.rid +0 -14
- data/docs/css/fonts.css +0 -167
- data/docs/css/rdoc.css +0 -687
- data/docs/fonts/Lato-Light.ttf +0 -0
- data/docs/fonts/Lato-LightItalic.ttf +0 -0
- data/docs/fonts/Lato-Regular.ttf +0 -0
- data/docs/fonts/Lato-RegularItalic.ttf +0 -0
- data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
- data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
- data/docs/images/add.png +0 -0
- data/docs/images/arrow_up.png +0 -0
- data/docs/images/brick.png +0 -0
- data/docs/images/brick_link.png +0 -0
- data/docs/images/bug.png +0 -0
- data/docs/images/bullet_black.png +0 -0
- data/docs/images/bullet_toggle_minus.png +0 -0
- data/docs/images/bullet_toggle_plus.png +0 -0
- data/docs/images/date.png +0 -0
- data/docs/images/delete.png +0 -0
- data/docs/images/find.png +0 -0
- data/docs/images/loadingAnimation.gif +0 -0
- data/docs/images/macFFBgHack.png +0 -0
- data/docs/images/package.png +0 -0
- data/docs/images/page_green.png +0 -0
- data/docs/images/page_white_text.png +0 -0
- data/docs/images/page_white_width.png +0 -0
- data/docs/images/plugin.png +0 -0
- data/docs/images/ruby.png +0 -0
- data/docs/images/tag_blue.png +0 -0
- data/docs/images/tag_green.png +0 -0
- data/docs/images/transparent.png +0 -0
- data/docs/images/wrench.png +0 -0
- data/docs/images/wrench_orange.png +0 -0
- data/docs/images/zoom.png +0 -0
- data/docs/index.html +0 -99
- data/docs/js/darkfish.js +0 -97
- data/docs/js/navigation.js +0 -105
- data/docs/js/navigation.js.gz +0 -0
- data/docs/js/search.js +0 -110
- data/docs/js/search_index.js +0 -1
- data/docs/js/search_index.js.gz +0 -0
- data/docs/js/searcher.js +0 -229
- data/docs/js/searcher.js.gz +0 -0
- data/docs/table_of_contents.html +0 -617
- data/help/loggable_activity_help.txt +0 -19
- data/lib/generators/.DS_Store +0 -0
- data/lib/generators/loggable_activity/.DS_Store +0 -0
- data/lib/generators/loggable_activity/install_generator.rb +0 -109
- data/lib/generators/loggable_activity/templates/.DS_Store +0 -0
- data/lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb +0 -30
- data/lib/generators/loggable_activity/templates/config/locales/loggable_activity.en.yml +0 -36
- data/lib/generators/loggable_activity/templates/config/loggable_activity.yaml +0 -29
- data/lib/generators/loggable_activity/templates/loggable_activity.en.yaml +0 -36
- data/pkg/loggable_activity-0.1.35.gem +0 -0
- data/sig/loggable_activity.rbs +0 -4
- /data/{.rspec_status → app/assets/images/loggable_activity/.keep} +0 -0
- /data/lib/{generators/loggable_activity/templates → loggable_activity/concerns}/current_user.rb +0 -0
@@ -1,23 +1,27 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
class
|
3
|
+
class CreateLoggableActivityTables < ActiveRecord::Migration[7.1]
|
4
4
|
def change
|
5
|
-
create_table :
|
5
|
+
create_table :loggable_activity_encryption_keys do |t|
|
6
6
|
t.references :record, polymorphic: true, null: true, index: true
|
7
|
-
t.
|
7
|
+
t.string :secret_key
|
8
|
+
t.datetime :delete_at
|
9
|
+
|
10
|
+
t.timestamps
|
8
11
|
end
|
9
12
|
|
10
|
-
create_table :
|
13
|
+
create_table :loggable_activity_activities do |t|
|
11
14
|
t.string :action
|
12
15
|
t.references :actor, polymorphic: true, null: true
|
13
16
|
t.string :encrypted_actor_name
|
14
17
|
t.references :record, polymorphic: true, null: true
|
18
|
+
|
15
19
|
t.timestamps
|
16
20
|
end
|
17
21
|
|
18
|
-
create_table :
|
19
|
-
t.references :activity, null: false, foreign_key: { to_table: '
|
20
|
-
t.references :encryption_key, null: false, foreign_key: { to_table: '
|
22
|
+
create_table :loggable_activity_payloads do |t|
|
23
|
+
t.references :activity, null: false, foreign_key: { to_table: 'loggable_activity_activities' }
|
24
|
+
t.references :encryption_key, null: false, foreign_key: { to_table: 'loggable_activity_encryption_keys' }
|
21
25
|
t.references :record, polymorphic: true, null: true, index: true
|
22
26
|
t.string :encrypted_record_name
|
23
27
|
t.json :encrypted_attrs
|
@@ -25,12 +29,16 @@ class CreateLoggableActivities < ActiveRecord::Migration[7.1]
|
|
25
29
|
t.boolean :data_owner, default: false
|
26
30
|
t.string :route
|
27
31
|
t.boolean :current_payload, default: true
|
32
|
+
t.json :public_attrs, default: {}
|
33
|
+
|
34
|
+
t.timestamps
|
28
35
|
end
|
29
36
|
|
30
|
-
create_table :
|
37
|
+
create_table :loggable_activity_data_owners do |t|
|
31
38
|
t.references :record, polymorphic: true, null: true, index: true
|
32
|
-
t.
|
33
|
-
|
39
|
+
t.references :encryption_key, null: false, foreign_key: { to_table: 'loggable_activity_encryption_keys' }
|
40
|
+
|
41
|
+
t.timestamps
|
34
42
|
end
|
35
43
|
end
|
36
44
|
end
|
data/git-org/HEAD
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
ref: refs/heads/main
|
data/git-org/config
ADDED
data/git-org/description
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
Unnamed repository; edit this file 'description' to name the repository.
|
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to check the commit log message taken by
|
4
|
+
# applypatch from an e-mail message.
|
5
|
+
#
|
6
|
+
# The hook should exit with non-zero status after issuing an
|
7
|
+
# appropriate message if it wants to stop the commit. The hook is
|
8
|
+
# allowed to edit the commit message file.
|
9
|
+
#
|
10
|
+
# To enable this hook, rename this file to "applypatch-msg".
|
11
|
+
|
12
|
+
. git-sh-setup
|
13
|
+
commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
|
14
|
+
test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
|
15
|
+
:
|
@@ -0,0 +1,24 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to check the commit log message.
|
4
|
+
# Called by "git commit" with one argument, the name of the file
|
5
|
+
# that has the commit message. The hook should exit with non-zero
|
6
|
+
# status after issuing an appropriate message if it wants to stop the
|
7
|
+
# commit. The hook is allowed to edit the commit message file.
|
8
|
+
#
|
9
|
+
# To enable this hook, rename this file to "commit-msg".
|
10
|
+
|
11
|
+
# Uncomment the below to add a Signed-off-by line to the message.
|
12
|
+
# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
|
13
|
+
# hook is more suited to it.
|
14
|
+
#
|
15
|
+
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
|
16
|
+
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
|
17
|
+
|
18
|
+
# This example catches duplicate Signed-off-by lines.
|
19
|
+
|
20
|
+
test "" = "$(grep '^Signed-off-by: ' "$1" |
|
21
|
+
sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
|
22
|
+
echo >&2 Duplicate Signed-off-by lines.
|
23
|
+
exit 1
|
24
|
+
}
|
@@ -0,0 +1,174 @@
|
|
1
|
+
#!/usr/bin/perl
|
2
|
+
|
3
|
+
use strict;
|
4
|
+
use warnings;
|
5
|
+
use IPC::Open2;
|
6
|
+
|
7
|
+
# An example hook script to integrate Watchman
|
8
|
+
# (https://facebook.github.io/watchman/) with git to speed up detecting
|
9
|
+
# new and modified files.
|
10
|
+
#
|
11
|
+
# The hook is passed a version (currently 2) and last update token
|
12
|
+
# formatted as a string and outputs to stdout a new update token and
|
13
|
+
# all files that have been modified since the update token. Paths must
|
14
|
+
# be relative to the root of the working tree and separated by a single NUL.
|
15
|
+
#
|
16
|
+
# To enable this hook, rename this file to "query-watchman" and set
|
17
|
+
# 'git config core.fsmonitor .git/hooks/query-watchman'
|
18
|
+
#
|
19
|
+
my ($version, $last_update_token) = @ARGV;
|
20
|
+
|
21
|
+
# Uncomment for debugging
|
22
|
+
# print STDERR "$0 $version $last_update_token\n";
|
23
|
+
|
24
|
+
# Check the hook interface version
|
25
|
+
if ($version ne 2) {
|
26
|
+
die "Unsupported query-fsmonitor hook version '$version'.\n" .
|
27
|
+
"Falling back to scanning...\n";
|
28
|
+
}
|
29
|
+
|
30
|
+
my $git_work_tree = get_working_dir();
|
31
|
+
|
32
|
+
my $retry = 1;
|
33
|
+
|
34
|
+
my $json_pkg;
|
35
|
+
eval {
|
36
|
+
require JSON::XS;
|
37
|
+
$json_pkg = "JSON::XS";
|
38
|
+
1;
|
39
|
+
} or do {
|
40
|
+
require JSON::PP;
|
41
|
+
$json_pkg = "JSON::PP";
|
42
|
+
};
|
43
|
+
|
44
|
+
launch_watchman();
|
45
|
+
|
46
|
+
sub launch_watchman {
|
47
|
+
my $o = watchman_query();
|
48
|
+
if (is_work_tree_watched($o)) {
|
49
|
+
output_result($o->{clock}, @{$o->{files}});
|
50
|
+
}
|
51
|
+
}
|
52
|
+
|
53
|
+
sub output_result {
|
54
|
+
my ($clockid, @files) = @_;
|
55
|
+
|
56
|
+
# Uncomment for debugging watchman output
|
57
|
+
# open (my $fh, ">", ".git/watchman-output.out");
|
58
|
+
# binmode $fh, ":utf8";
|
59
|
+
# print $fh "$clockid\n@files\n";
|
60
|
+
# close $fh;
|
61
|
+
|
62
|
+
binmode STDOUT, ":utf8";
|
63
|
+
print $clockid;
|
64
|
+
print "\0";
|
65
|
+
local $, = "\0";
|
66
|
+
print @files;
|
67
|
+
}
|
68
|
+
|
69
|
+
sub watchman_clock {
|
70
|
+
my $response = qx/watchman clock "$git_work_tree"/;
|
71
|
+
die "Failed to get clock id on '$git_work_tree'.\n" .
|
72
|
+
"Falling back to scanning...\n" if $? != 0;
|
73
|
+
|
74
|
+
return $json_pkg->new->utf8->decode($response);
|
75
|
+
}
|
76
|
+
|
77
|
+
sub watchman_query {
|
78
|
+
my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
|
79
|
+
or die "open2() failed: $!\n" .
|
80
|
+
"Falling back to scanning...\n";
|
81
|
+
|
82
|
+
# In the query expression below we're asking for names of files that
|
83
|
+
# changed since $last_update_token but not from the .git folder.
|
84
|
+
#
|
85
|
+
# To accomplish this, we're using the "since" generator to use the
|
86
|
+
# recency index to select candidate nodes and "fields" to limit the
|
87
|
+
# output to file names only. Then we're using the "expression" term to
|
88
|
+
# further constrain the results.
|
89
|
+
my $last_update_line = "";
|
90
|
+
if (substr($last_update_token, 0, 1) eq "c") {
|
91
|
+
$last_update_token = "\"$last_update_token\"";
|
92
|
+
$last_update_line = qq[\n"since": $last_update_token,];
|
93
|
+
}
|
94
|
+
my $query = <<" END";
|
95
|
+
["query", "$git_work_tree", {$last_update_line
|
96
|
+
"fields": ["name"],
|
97
|
+
"expression": ["not", ["dirname", ".git"]]
|
98
|
+
}]
|
99
|
+
END
|
100
|
+
|
101
|
+
# Uncomment for debugging the watchman query
|
102
|
+
# open (my $fh, ">", ".git/watchman-query.json");
|
103
|
+
# print $fh $query;
|
104
|
+
# close $fh;
|
105
|
+
|
106
|
+
print CHLD_IN $query;
|
107
|
+
close CHLD_IN;
|
108
|
+
my $response = do {local $/; <CHLD_OUT>};
|
109
|
+
|
110
|
+
# Uncomment for debugging the watch response
|
111
|
+
# open ($fh, ">", ".git/watchman-response.json");
|
112
|
+
# print $fh $response;
|
113
|
+
# close $fh;
|
114
|
+
|
115
|
+
die "Watchman: command returned no output.\n" .
|
116
|
+
"Falling back to scanning...\n" if $response eq "";
|
117
|
+
die "Watchman: command returned invalid output: $response\n" .
|
118
|
+
"Falling back to scanning...\n" unless $response =~ /^\{/;
|
119
|
+
|
120
|
+
return $json_pkg->new->utf8->decode($response);
|
121
|
+
}
|
122
|
+
|
123
|
+
sub is_work_tree_watched {
|
124
|
+
my ($output) = @_;
|
125
|
+
my $error = $output->{error};
|
126
|
+
if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) {
|
127
|
+
$retry--;
|
128
|
+
my $response = qx/watchman watch "$git_work_tree"/;
|
129
|
+
die "Failed to make watchman watch '$git_work_tree'.\n" .
|
130
|
+
"Falling back to scanning...\n" if $? != 0;
|
131
|
+
$output = $json_pkg->new->utf8->decode($response);
|
132
|
+
$error = $output->{error};
|
133
|
+
die "Watchman: $error.\n" .
|
134
|
+
"Falling back to scanning...\n" if $error;
|
135
|
+
|
136
|
+
# Uncomment for debugging watchman output
|
137
|
+
# open (my $fh, ">", ".git/watchman-output.out");
|
138
|
+
# close $fh;
|
139
|
+
|
140
|
+
# Watchman will always return all files on the first query so
|
141
|
+
# return the fast "everything is dirty" flag to git and do the
|
142
|
+
# Watchman query just to get it over with now so we won't pay
|
143
|
+
# the cost in git to look up each individual file.
|
144
|
+
my $o = watchman_clock();
|
145
|
+
$error = $output->{error};
|
146
|
+
|
147
|
+
die "Watchman: $error.\n" .
|
148
|
+
"Falling back to scanning...\n" if $error;
|
149
|
+
|
150
|
+
output_result($o->{clock}, ("/"));
|
151
|
+
$last_update_token = $o->{clock};
|
152
|
+
|
153
|
+
eval { launch_watchman() };
|
154
|
+
return 0;
|
155
|
+
}
|
156
|
+
|
157
|
+
die "Watchman: $error.\n" .
|
158
|
+
"Falling back to scanning...\n" if $error;
|
159
|
+
|
160
|
+
return 1;
|
161
|
+
}
|
162
|
+
|
163
|
+
sub get_working_dir {
|
164
|
+
my $working_dir;
|
165
|
+
if ($^O =~ 'msys' || $^O =~ 'cygwin') {
|
166
|
+
$working_dir = Win32::GetCwd();
|
167
|
+
$working_dir =~ tr/\\/\//;
|
168
|
+
} else {
|
169
|
+
require Cwd;
|
170
|
+
$working_dir = Cwd::cwd();
|
171
|
+
}
|
172
|
+
|
173
|
+
return $working_dir;
|
174
|
+
}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to verify what is about to be committed
|
4
|
+
# by applypatch from an e-mail message.
|
5
|
+
#
|
6
|
+
# The hook should exit with non-zero status after issuing an
|
7
|
+
# appropriate message if it wants to stop the commit.
|
8
|
+
#
|
9
|
+
# To enable this hook, rename this file to "pre-applypatch".
|
10
|
+
|
11
|
+
. git-sh-setup
|
12
|
+
precommit="$(git rev-parse --git-path hooks/pre-commit)"
|
13
|
+
test -x "$precommit" && exec "$precommit" ${1+"$@"}
|
14
|
+
:
|
@@ -0,0 +1,49 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to verify what is about to be committed.
|
4
|
+
# Called by "git commit" with no arguments. The hook should
|
5
|
+
# exit with non-zero status after issuing an appropriate message if
|
6
|
+
# it wants to stop the commit.
|
7
|
+
#
|
8
|
+
# To enable this hook, rename this file to "pre-commit".
|
9
|
+
|
10
|
+
if git rev-parse --verify HEAD >/dev/null 2>&1
|
11
|
+
then
|
12
|
+
against=HEAD
|
13
|
+
else
|
14
|
+
# Initial commit: diff against an empty tree object
|
15
|
+
against=$(git hash-object -t tree /dev/null)
|
16
|
+
fi
|
17
|
+
|
18
|
+
# If you want to allow non-ASCII filenames set this variable to true.
|
19
|
+
allownonascii=$(git config --type=bool hooks.allownonascii)
|
20
|
+
|
21
|
+
# Redirect output to stderr.
|
22
|
+
exec 1>&2
|
23
|
+
|
24
|
+
# Cross platform projects tend to avoid non-ASCII filenames; prevent
|
25
|
+
# them from being added to the repository. We exploit the fact that the
|
26
|
+
# printable range starts at the space character and ends with tilde.
|
27
|
+
if [ "$allownonascii" != "true" ] &&
|
28
|
+
# Note that the use of brackets around a tr range is ok here, (it's
|
29
|
+
# even required, for portability to Solaris 10's /usr/bin/tr), since
|
30
|
+
# the square bracket bytes happen to fall in the designated range.
|
31
|
+
test $(git diff --cached --name-only --diff-filter=A -z $against |
|
32
|
+
LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
|
33
|
+
then
|
34
|
+
cat <<\EOF
|
35
|
+
Error: Attempt to add a non-ASCII file name.
|
36
|
+
|
37
|
+
This can cause problems if you want to work with people on other platforms.
|
38
|
+
|
39
|
+
To be portable it is advisable to rename the file.
|
40
|
+
|
41
|
+
If you know what you are doing you can disable this check using:
|
42
|
+
|
43
|
+
git config hooks.allownonascii true
|
44
|
+
EOF
|
45
|
+
exit 1
|
46
|
+
fi
|
47
|
+
|
48
|
+
# If there are whitespace errors, print the offending file names and fail.
|
49
|
+
exec git diff-index --check --cached $against --
|
@@ -0,0 +1,13 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to verify what is about to be committed.
|
4
|
+
# Called by "git merge" with no arguments. The hook should
|
5
|
+
# exit with non-zero status after issuing an appropriate message to
|
6
|
+
# stderr if it wants to stop the merge commit.
|
7
|
+
#
|
8
|
+
# To enable this hook, rename this file to "pre-merge-commit".
|
9
|
+
|
10
|
+
. git-sh-setup
|
11
|
+
test -x "$GIT_DIR/hooks/pre-commit" &&
|
12
|
+
exec "$GIT_DIR/hooks/pre-commit"
|
13
|
+
:
|
@@ -0,0 +1,53 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
|
3
|
+
# An example hook script to verify what is about to be pushed. Called by "git
|
4
|
+
# push" after it has checked the remote status, but before anything has been
|
5
|
+
# pushed. If this script exits with a non-zero status nothing will be pushed.
|
6
|
+
#
|
7
|
+
# This hook is called with the following parameters:
|
8
|
+
#
|
9
|
+
# $1 -- Name of the remote to which the push is being done
|
10
|
+
# $2 -- URL to which the push is being done
|
11
|
+
#
|
12
|
+
# If pushing without using a named remote those arguments will be equal.
|
13
|
+
#
|
14
|
+
# Information about the commits which are being pushed is supplied as lines to
|
15
|
+
# the standard input in the form:
|
16
|
+
#
|
17
|
+
# <local ref> <local oid> <remote ref> <remote oid>
|
18
|
+
#
|
19
|
+
# This sample shows how to prevent push of commits where the log message starts
|
20
|
+
# with "WIP" (work in progress).
|
21
|
+
|
22
|
+
remote="$1"
|
23
|
+
url="$2"
|
24
|
+
|
25
|
+
zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
|
26
|
+
|
27
|
+
while read local_ref local_oid remote_ref remote_oid
|
28
|
+
do
|
29
|
+
if test "$local_oid" = "$zero"
|
30
|
+
then
|
31
|
+
# Handle delete
|
32
|
+
:
|
33
|
+
else
|
34
|
+
if test "$remote_oid" = "$zero"
|
35
|
+
then
|
36
|
+
# New branch, examine all commits
|
37
|
+
range="$local_oid"
|
38
|
+
else
|
39
|
+
# Update to existing branch, examine new commits
|
40
|
+
range="$remote_oid..$local_oid"
|
41
|
+
fi
|
42
|
+
|
43
|
+
# Check for WIP commit
|
44
|
+
commit=$(git rev-list -n 1 --grep '^WIP' "$range")
|
45
|
+
if test -n "$commit"
|
46
|
+
then
|
47
|
+
echo >&2 "Found WIP commit in $local_ref, not pushing"
|
48
|
+
exit 1
|
49
|
+
fi
|
50
|
+
fi
|
51
|
+
done
|
52
|
+
|
53
|
+
exit 0
|
@@ -0,0 +1,169 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# Copyright (c) 2006, 2008 Junio C Hamano
|
4
|
+
#
|
5
|
+
# The "pre-rebase" hook is run just before "git rebase" starts doing
|
6
|
+
# its job, and can prevent the command from running by exiting with
|
7
|
+
# non-zero status.
|
8
|
+
#
|
9
|
+
# The hook is called with the following parameters:
|
10
|
+
#
|
11
|
+
# $1 -- the upstream the series was forked from.
|
12
|
+
# $2 -- the branch being rebased (or empty when rebasing the current branch).
|
13
|
+
#
|
14
|
+
# This sample shows how to prevent topic branches that are already
|
15
|
+
# merged to 'next' branch from getting rebased, because allowing it
|
16
|
+
# would result in rebasing already published history.
|
17
|
+
|
18
|
+
publish=next
|
19
|
+
basebranch="$1"
|
20
|
+
if test "$#" = 2
|
21
|
+
then
|
22
|
+
topic="refs/heads/$2"
|
23
|
+
else
|
24
|
+
topic=`git symbolic-ref HEAD` ||
|
25
|
+
exit 0 ;# we do not interrupt rebasing detached HEAD
|
26
|
+
fi
|
27
|
+
|
28
|
+
case "$topic" in
|
29
|
+
refs/heads/??/*)
|
30
|
+
;;
|
31
|
+
*)
|
32
|
+
exit 0 ;# we do not interrupt others.
|
33
|
+
;;
|
34
|
+
esac
|
35
|
+
|
36
|
+
# Now we are dealing with a topic branch being rebased
|
37
|
+
# on top of master. Is it OK to rebase it?
|
38
|
+
|
39
|
+
# Does the topic really exist?
|
40
|
+
git show-ref -q "$topic" || {
|
41
|
+
echo >&2 "No such branch $topic"
|
42
|
+
exit 1
|
43
|
+
}
|
44
|
+
|
45
|
+
# Is topic fully merged to master?
|
46
|
+
not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
|
47
|
+
if test -z "$not_in_master"
|
48
|
+
then
|
49
|
+
echo >&2 "$topic is fully merged to master; better remove it."
|
50
|
+
exit 1 ;# we could allow it, but there is no point.
|
51
|
+
fi
|
52
|
+
|
53
|
+
# Is topic ever merged to next? If so you should not be rebasing it.
|
54
|
+
only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
|
55
|
+
only_next_2=`git rev-list ^master ${publish} | sort`
|
56
|
+
if test "$only_next_1" = "$only_next_2"
|
57
|
+
then
|
58
|
+
not_in_topic=`git rev-list "^$topic" master`
|
59
|
+
if test -z "$not_in_topic"
|
60
|
+
then
|
61
|
+
echo >&2 "$topic is already up to date with master"
|
62
|
+
exit 1 ;# we could allow it, but there is no point.
|
63
|
+
else
|
64
|
+
exit 0
|
65
|
+
fi
|
66
|
+
else
|
67
|
+
not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
|
68
|
+
/usr/bin/perl -e '
|
69
|
+
my $topic = $ARGV[0];
|
70
|
+
my $msg = "* $topic has commits already merged to public branch:\n";
|
71
|
+
my (%not_in_next) = map {
|
72
|
+
/^([0-9a-f]+) /;
|
73
|
+
($1 => 1);
|
74
|
+
} split(/\n/, $ARGV[1]);
|
75
|
+
for my $elem (map {
|
76
|
+
/^([0-9a-f]+) (.*)$/;
|
77
|
+
[$1 => $2];
|
78
|
+
} split(/\n/, $ARGV[2])) {
|
79
|
+
if (!exists $not_in_next{$elem->[0]}) {
|
80
|
+
if ($msg) {
|
81
|
+
print STDERR $msg;
|
82
|
+
undef $msg;
|
83
|
+
}
|
84
|
+
print STDERR " $elem->[1]\n";
|
85
|
+
}
|
86
|
+
}
|
87
|
+
' "$topic" "$not_in_next" "$not_in_master"
|
88
|
+
exit 1
|
89
|
+
fi
|
90
|
+
|
91
|
+
<<\DOC_END
|
92
|
+
|
93
|
+
This sample hook safeguards topic branches that have been
|
94
|
+
published from being rewound.
|
95
|
+
|
96
|
+
The workflow assumed here is:
|
97
|
+
|
98
|
+
* Once a topic branch forks from "master", "master" is never
|
99
|
+
merged into it again (either directly or indirectly).
|
100
|
+
|
101
|
+
* Once a topic branch is fully cooked and merged into "master",
|
102
|
+
it is deleted. If you need to build on top of it to correct
|
103
|
+
earlier mistakes, a new topic branch is created by forking at
|
104
|
+
the tip of the "master". This is not strictly necessary, but
|
105
|
+
it makes it easier to keep your history simple.
|
106
|
+
|
107
|
+
* Whenever you need to test or publish your changes to topic
|
108
|
+
branches, merge them into "next" branch.
|
109
|
+
|
110
|
+
The script, being an example, hardcodes the publish branch name
|
111
|
+
to be "next", but it is trivial to make it configurable via
|
112
|
+
$GIT_DIR/config mechanism.
|
113
|
+
|
114
|
+
With this workflow, you would want to know:
|
115
|
+
|
116
|
+
(1) ... if a topic branch has ever been merged to "next". Young
|
117
|
+
topic branches can have stupid mistakes you would rather
|
118
|
+
clean up before publishing, and things that have not been
|
119
|
+
merged into other branches can be easily rebased without
|
120
|
+
affecting other people. But once it is published, you would
|
121
|
+
not want to rewind it.
|
122
|
+
|
123
|
+
(2) ... if a topic branch has been fully merged to "master".
|
124
|
+
Then you can delete it. More importantly, you should not
|
125
|
+
build on top of it -- other people may already want to
|
126
|
+
change things related to the topic as patches against your
|
127
|
+
"master", so if you need further changes, it is better to
|
128
|
+
fork the topic (perhaps with the same name) afresh from the
|
129
|
+
tip of "master".
|
130
|
+
|
131
|
+
Let's look at this example:
|
132
|
+
|
133
|
+
o---o---o---o---o---o---o---o---o---o "next"
|
134
|
+
/ / / /
|
135
|
+
/ a---a---b A / /
|
136
|
+
/ / / /
|
137
|
+
/ / c---c---c---c B /
|
138
|
+
/ / / \ /
|
139
|
+
/ / / b---b C \ /
|
140
|
+
/ / / / \ /
|
141
|
+
---o---o---o---o---o---o---o---o---o---o---o "master"
|
142
|
+
|
143
|
+
|
144
|
+
A, B and C are topic branches.
|
145
|
+
|
146
|
+
* A has one fix since it was merged up to "next".
|
147
|
+
|
148
|
+
* B has finished. It has been fully merged up to "master" and "next",
|
149
|
+
and is ready to be deleted.
|
150
|
+
|
151
|
+
* C has not merged to "next" at all.
|
152
|
+
|
153
|
+
We would want to allow C to be rebased, refuse A, and encourage
|
154
|
+
B to be deleted.
|
155
|
+
|
156
|
+
To compute (1):
|
157
|
+
|
158
|
+
git rev-list ^master ^topic next
|
159
|
+
git rev-list ^master next
|
160
|
+
|
161
|
+
if these match, topic has not merged in next at all.
|
162
|
+
|
163
|
+
To compute (2):
|
164
|
+
|
165
|
+
git rev-list master..topic
|
166
|
+
|
167
|
+
if this is empty, it is fully merged to "master".
|
168
|
+
|
169
|
+
DOC_END
|
@@ -0,0 +1,24 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to make use of push options.
|
4
|
+
# The example simply echoes all push options that start with 'echoback='
|
5
|
+
# and rejects all pushes when the "reject" push option is used.
|
6
|
+
#
|
7
|
+
# To enable this hook, rename this file to "pre-receive".
|
8
|
+
|
9
|
+
if test -n "$GIT_PUSH_OPTION_COUNT"
|
10
|
+
then
|
11
|
+
i=0
|
12
|
+
while test "$i" -lt "$GIT_PUSH_OPTION_COUNT"
|
13
|
+
do
|
14
|
+
eval "value=\$GIT_PUSH_OPTION_$i"
|
15
|
+
case "$value" in
|
16
|
+
echoback=*)
|
17
|
+
echo "echo from the pre-receive-hook: ${value#*=}" >&2
|
18
|
+
;;
|
19
|
+
reject)
|
20
|
+
exit 1
|
21
|
+
esac
|
22
|
+
i=$((i + 1))
|
23
|
+
done
|
24
|
+
fi
|
@@ -0,0 +1,42 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to prepare the commit log message.
|
4
|
+
# Called by "git commit" with the name of the file that has the
|
5
|
+
# commit message, followed by the description of the commit
|
6
|
+
# message's source. The hook's purpose is to edit the commit
|
7
|
+
# message file. If the hook fails with a non-zero status,
|
8
|
+
# the commit is aborted.
|
9
|
+
#
|
10
|
+
# To enable this hook, rename this file to "prepare-commit-msg".
|
11
|
+
|
12
|
+
# This hook includes three examples. The first one removes the
|
13
|
+
# "# Please enter the commit message..." help message.
|
14
|
+
#
|
15
|
+
# The second includes the output of "git diff --name-status -r"
|
16
|
+
# into the message, just before the "git status" output. It is
|
17
|
+
# commented because it doesn't cope with --amend or with squashed
|
18
|
+
# commits.
|
19
|
+
#
|
20
|
+
# The third example adds a Signed-off-by line to the message, that can
|
21
|
+
# still be edited. This is rarely a good idea.
|
22
|
+
|
23
|
+
COMMIT_MSG_FILE=$1
|
24
|
+
COMMIT_SOURCE=$2
|
25
|
+
SHA1=$3
|
26
|
+
|
27
|
+
/usr/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE"
|
28
|
+
|
29
|
+
# case "$COMMIT_SOURCE,$SHA1" in
|
30
|
+
# ,|template,)
|
31
|
+
# /usr/bin/perl -i.bak -pe '
|
32
|
+
# print "\n" . `git diff --cached --name-status -r`
|
33
|
+
# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;;
|
34
|
+
# *) ;;
|
35
|
+
# esac
|
36
|
+
|
37
|
+
# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
|
38
|
+
# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE"
|
39
|
+
# if test -z "$COMMIT_SOURCE"
|
40
|
+
# then
|
41
|
+
# /usr/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE"
|
42
|
+
# fi
|