hoe-manns 2.1.1 → 2.1.2

Sign up to get free protection for your applications and to get access to all the features.
data/README.rdoc CHANGED
@@ -1,172 +1,106 @@
1
- = hoe-manns
2
-
3
- code :: https://launchpad.net/hoe-manns
4
- rdoc :: http://www.rubydoc.info/gems/hoe-manns
5
- docs :: https://saigkill.github.io/hoe-manns/about/
6
- bugs :: https://bugs.launchpad.net/hoe-manns
7
- questions :: https://answers.launchpad.net/hoe-manns
8
- feature requests :: https://blueprints.launchpad.net/hoe-manns
9
- openhub statistics :: https://www.openhub.net/p/hoe-manns
10
- authors blog :: https://saigkill.tuxfamily.org
11
- min_rubyver :: 2.3.0
12
-
13
- If you're reading this on Github, please keep in mind, that this is just a
14
- mirror. The development happens on: https://launchpad.net/hoe-manns
15
-
16
- == DESCRIPTION:
17
-
18
- hoe-manns is a small collection of my personal used rake tasks for using with hoe. Actually it includes that tasks:
19
-
20
- * bundler:gemfile_lock
21
- * bundle_audit:*
22
- * clean_pkg
23
- * copy_master
24
- * remove_pre_gemspec
25
- * run_before_release
26
- * run_after_release
27
-
28
- The History.rdoc contains a detailed description on what has changed. For most
29
- users the NEWS file might be a better place to look since it contains
30
- change summaries between the different versions.
31
-
32
- hoe-manns is released under the GPL3 License, see the file 'License.rdoc'
33
- for more information.
34
-
35
- The official web site is:
36
-
37
- https://launchpad.net/hoe-manns
38
-
39
- == FEATURES/PROBLEMS:
40
-
41
- * Updates the Gemfile.lock
42
- * Removes the old *.gemspec created in test cases
43
- * copies your manuals to your docpath.
44
- * runs the rake tasks before release: git:manifest, bundler:gemfile, update_gemfile_lock, remove_pre_gemspec,
45
- bundler_audit:run and copy_mirror.
46
- * runs after release: send_email.
47
- * Cleans up the pkg dir
48
- * provides bundler_audit tasks
49
-
50
- This Gem was programmed and tested for Linux systems. If anyone would like to make the methods also fit for other OS,
51
- i'm happy about Pull requests.
52
-
53
- See the {FAQs}[https://answers.launchpad.net/hoe-manns/+faqs] for checking known issues.
54
- See the {status}[https://github.com/saigkill/hoe-manns/blob/master/STATUS.rdoc] of the app.
55
-
56
- == SYNOPSIS:
57
-
58
- Use in your Rakefile:
59
-
60
- Hoe.plugin :manns
61
-
62
- Hoe.spec 'yourproject' do
63
- ...
64
- end
65
-
66
- Also add hoe-manns to your requirements and recreate your Gemfile.
67
-
68
- Read the documentation at: https://saigkill.github.io/hoe-manns/about/
69
-
70
- == REQUIREMENTS:
71
-
72
- * rake
73
- * hoe
74
- * bundler-audit
75
-
76
- == INSTALL:
77
-
78
- The installation is very easy.
79
-
80
- gem install hoe-manns
81
-
82
- Read the documentation at: https://saigkill.github.io/hoe-manns/about/
83
-
84
- == DEVELOPERS:
85
-
86
- After checking out the source, run:
87
-
88
- $ rake newb
89
-
90
- This task will install any missing dependencies, run the tests/specs,
91
- and generate the RDoc.
92
-
93
- === IDEAS:
94
-
95
- * Add ideas on: https://blueprints.launchpad.net/hoe-manns
96
-
97
- === COOL HACKS:
98
-
99
- * Open a bugreport on https://bugs.launchpad.net/hoe-manns.
100
- * Please use the -u flag when generating the patch as it makes the patch
101
- more readable.
102
- * Write a good explanation of what the patch does.
103
- * It is better to use git format-patch command: git format-patch HEAD^
104
-
105
- === CONTRIBUTOR CODE OF CONDUCT:
106
-
107
- As contributors and maintainers of this project, we pledge to respect all
108
- people who contribute through reporting issues, posting feature requests,
109
- updating documentation, submitting pull requests or patches, and other
110
- activities.
111
-
112
- We are committed to making participation in this project a harassment-free
113
- experience for everyone, regardless of level of experience, gender, gender
114
- identity and expression, sexual orientation, disability, personal
115
- appearance, body size, race, age, or religion.
116
-
117
- Examples of unacceptable behavior by participants include the use of sexual
118
- language or imagery, derogatory comments or personal attacks, trolling,
119
- public or private harassment, insults, or other unprofessional conduct.
120
-
121
- Project maintainers have the right and responsibility to remove, edit, or
122
- reject comments, commits, code, wiki edits, issues, and other contributions
123
- that are not aligned to this Code of Conduct. Project maintainers who do
124
- not follow the Code of Conduct may be removed from the project team.
125
-
126
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
127
- reported by opening an issue or contacting one or more of the project
128
- maintainers.
129
-
130
- This Code of Conduct is adapted from the {Contributor Covenant}[http:contributor-covenant.org],
131
- version 1.0.0, available at {http://contributor-covenant.org/version/1/0/0/}[http://contributor-covenant.org/version/1/0/0/].
132
-
133
- === MAINTANANCE POLICY:
134
-
135
- I'm following the Semantic Versioning for its releases: (Major).(Minor).(Patch).
136
-
137
- * Major version: Whenever there is something significant or any backwards
138
- incompatible changes.
139
- * Minor version: When new, backwards compatible functionality is introduced a
140
- minor feature is introduced, or when a set of smaller features is rolled out.
141
- * Patch number: When backwards compatible bug fixes are introduced that fix
142
- incorrect behavior.
143
- * The current stable release will receive security patches and bug fixes
144
- (eg. 5.0 -> 5.0.1).
145
- * Feature releases will mark the next supported stable release where the minor
146
- version is increased numerically by increments of one (eg. 5.0 -> 5.1).
147
-
148
- I encourage everyone to run the latest stable release to ensure that you can
149
- easily upgrade to the most secure and feature rich experience. In order to
150
- make sure you can easily run the most recent stable release, we are working
151
- hard to keep the update process simple and reliable.
152
-
153
- === STRUCTURE:
154
-
155
- ==== BRANCHES:
156
-
157
- ===== `master` BRANCH:
158
- The master branch is the current edge of development.
159
-
160
- ===== `X.X` BRANCH:
161
- The X.X branch is the last stable branch. It will used for tarballs.
162
-
163
- ===== MERGE REQUESTS:
164
- If you want to merge your branch with the trunk, join the team.
165
-
166
- Please base all Merge requests off the `master` branch. Merges to
167
- `X.X` only occur through the `master` branch.
168
-
169
- == PROBLEM REPORTING:
170
-
171
- Bugs should be reported to https://bugs.launchpad.net/hoe-manns. You will need to create an
172
- account for yourself.
1
+ = hoe-manns
2
+
3
+ code :: https://github.com/saigkill/hoe-manns
4
+ rdoc :: http://www.rubydoc.info/gems/hoe-manns
5
+ docs :: http://saigkill.tuxfamily.org/documentation/hoe-manns/
6
+ bugs & feature requests:: https://github.com/saigkill/hoe-manns/issues
7
+ mailing list :: https://groups.google.com/forum/#!forum/saigkills-hoe-plugins
8
+ openhub statistics :: https://www.openhub.net/p/hoe-manns
9
+ authors blog :: https://saigkill.tuxfamily.org
10
+ min_rubyver :: 2.3.0
11
+
12
+ last public version :: {<img src="https://badge.fury.io/rb/hoe-manns.png" alt="Last Version" />}[http://rubygems.org/gems/hoe-manns]
13
+ downloads latest :: {<img src="https://img.shields.io/gem/dtv/hoe-manns.svg" alt="Downloads latest version" />}[http://rubygems.org/gems/hoe-manns]
14
+ downloads all :: {<img src="https://img.shields.io/gem/dt/hoe-manns.svg" alt="Downloads all versions" />}[http://rubygems.org/gems/hoe-manns]
15
+ continuous integration :: {<img src="https://travis-ci.org/saigkill/hoe-manns.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/saigkill/hoe-manns]
16
+ continuous integration :: {<img src="https://scrutinizer-ci.com/g/saigkill/hoe-manns/badges/build.png?b=master" />}[https://scrutinizer-ci.com/g/saigkill/hoe-manns/build-status/master]
17
+ code quality :: {<img src="https://scrutinizer-ci.com/g/saigkill/hoe-manns/badges/quality-score.png?b=master" />}[https://scrutinizer-ci.com/g/saigkill/hoe-manns/]
18
+ code quality :: {<img src="https://api.codeclimate.com/v1/badges/009b795034d7c698c74f/maintainability" />}[https://codeclimate.com/github/saigkill/hoe-manns/maintainability]
19
+ code quality :: {<img src="https://api.codacy.com/project/badge/Grade/bfa993bdac4b46efa6e102daf97ca311" alt="Codacy code quality" />}[https://www.codacy.com/app/saigkill_2/hoe-manns?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=saigkill/hoe-manns&amp;utm_campaign=Badge_Grade]
20
+ security :: {<img src="https://hakiri.io/github/saigkill/hoe-manns/master.svg" alt="security" />}[https://hakiri.io/github/saigkill/hoe-manns/master/shield]
21
+ test coverage :: {<img src="https://coveralls.io/repos/github/saigkill/hoe-manns/badge.svg?branch=master" alt="Test Coverage" />}[https://coveralls.io/github/saigkill/hoe-manns]
22
+ dependency check :: {<img src="https://gemnasium.com/badges/github.com/saigkill/hoe-manns.svg" alt="Dependency Status" />}[https://gemnasium.com/github.com/saigkill/hoe-manns]
23
+ documentation quality :: {<img src="https://inch-ci.org/github/saigkill/hoe-manns.svg?branch=master" alt="Documentation Quality" />}[https://inch-ci.org/github/saigkill/hoe-manns]
24
+ donations :: http://saigkill.tuxfamily.org/wordpress/campaigns/hoe-manns/
25
+
26
+ == DESCRIPTION:
27
+
28
+ hoe-manns is a small collection of my personal used rake tasks for using with hoe. Actually it includes that tasks:
29
+
30
+ * bundler:gemfile_lock
31
+ * bundle_audit:*
32
+ * clean_pkg
33
+ * copy_master
34
+ * remove_pre_gemspec
35
+ * run_before_release
36
+ * run_after_release
37
+
38
+ The History.rdoc contains a detailed description of what has changed. For most
39
+ users the NEWS file might be a better place to look since it contains
40
+ change summaries between the different versions.
41
+
42
+ hoe-manns is released under the GPL3 License, see the file 'LICENSE.rdoc'
43
+ for more information.
44
+
45
+ The official website is:
46
+
47
+ http://saigkill.tuxfamily.org/wordpress
48
+
49
+ == FEATURES:
50
+
51
+ * Updates the Gemfile.lock
52
+ * Removes the old *.gemspec created in test cases
53
+ * copies your manuals to your docpath.
54
+ * runs the rake tasks before release: git:manifest, bundler:gemfile, update_gemfile_lock, remove_pre_gemspec,
55
+ bundler_audit:run and copy_mirror.
56
+ * runs after release: send_email.
57
+ * Cleans up the pkg dir
58
+ * provides bundler_audit tasks
59
+
60
+ This Gem was programmed and tested on Linux systems. If anyone would like to make the methods also fit for other OS,
61
+ I'm happy about Pull requests.
62
+
63
+ == REQUIREMENTS:
64
+
65
+ * rake
66
+ * hoe
67
+ * bundler-audit
68
+
69
+ == INSTALL:
70
+
71
+ The installation is very easy.
72
+
73
+ gem install hoe-manns
74
+
75
+ == SYNOPSIS:
76
+
77
+ Use in your Rakefile:
78
+
79
+ Hoe.plugin :manns
80
+
81
+ Hoe.spec 'your project' do
82
+ ...
83
+ end
84
+
85
+ Also add hoe-manns to your requirements and recreate your Gemfile.
86
+
87
+
88
+ == DEVELOPERS:
89
+
90
+ After checking out the source, run:
91
+
92
+ $ rake newb
93
+
94
+ This task will install any missing dependencies, run the tests/specs,
95
+ and generate the RDoc.
96
+ Also you can read the DEVELOPING.md and CONTRIBUTING.md for more information.
97
+
98
+ === IDEAS:
99
+
100
+ * Add ideas on: https://github.com/saigkill/hoe-manns/issues
101
+
102
+
103
+ == PROBLEM REPORTING:
104
+
105
+ Bugs should be reported to https://bugs.launchpad.net/hoe-manns. You will need to create an
106
+ account for yourself.
data/Rakefile CHANGED
@@ -1,56 +1,64 @@
1
- # -*- ruby -*-
2
- # Release:
3
- # See README.rdoc.release
4
-
5
- require 'rubygems'
6
- require 'hoe'
7
-
8
- Hoe.plugin :bundler
9
- Hoe.plugin :doofus
10
- #Hoe.plugin :git
11
- Hoe.plugin :manns
12
- Hoe.plugin :rdoc
13
- Hoe.plugin :reek
14
- Hoe.plugin :rubocop
15
- Hoe.plugin :rubygems
16
- Hoe.plugin :travis
17
- Hoe.plugin :version
18
-
19
-
20
- ###########################################DEVELOPING ZONE##############################################################
21
- # rubocop:disable Metrics/LineLength
22
- Hoe.spec 'hoe-manns' do
23
- developer('Sascha Manns', 'Sascha.Manns@mailbox.org')
24
- license 'GPL-3.0' # this should match the license in the README
25
- require_ruby_version '>= 2.2.0'
26
-
27
- dependency 'rainbow', '~> 2.2'
28
- dependency 'bundler-audit', '~> 0.6'
29
-
30
- extra_dev_deps << ['coveralls', '~> 0.8']
31
- extra_dev_deps << ['hoe-bundler', '~> 1.3']
32
- extra_dev_deps << ['hoe-doofus', '~> 1.0']
33
- extra_dev_deps << ['hoe-git', '~> 1.6']
34
- extra_dev_deps << ['hoe-manns', '~> 1.6']
35
- extra_dev_deps << ['hoe-reek', '~> 1.1']
36
- extra_dev_deps << ['hoe-rubocop', '~> 1.0']
37
- extra_dev_deps << ['hoe-rubygems', '~> 1.0']
38
- extra_dev_deps << ['hoe-travis', '~> 1.3']
39
- extra_dev_deps << ['hoe-version', '~> 1.2']
40
- extra_dev_deps << ['rake', '~> 12.1']
41
- extra_dev_deps << ['rdoc', '~> 5.1']
42
- extra_dev_deps << ['rubocop', '~> 0.50']
43
- extra_dev_deps << ['rspec', '~> 3.7']
44
-
45
- self.history_file = 'History.rdoc'
46
- self.readme_file = 'README.rdoc'
47
- self.extra_rdoc_files = FileList['*.rdoc'].to_a
48
- self.post_install_message = 'Please file bugreports on: https://bugs.launchpad.net/hoe-manns'
49
- end
50
-
51
- ##################################################SETUP ZONE############################################################
52
-
53
-
54
-
55
- # vim: syntax=ruby
56
-
1
+ # -*- ruby -*-
2
+ # Copyright (C) 2013-2018 Sascha Manns <Sascha.Manns@mailbox.org>
3
+ # Release:
4
+ # Pre-release:
5
+ #* update docs
6
+ #* Update copyright years if needed, in the following paths:
7
+ # + lib/*
8
+ #* Check version in lib/hoe-manns.rb
9
+ #* Update History.rdoc & NEWS
10
+ #* git:manifest
11
+ #* bundler:gemfile
12
+ #* bundler:gemfile_lock
13
+ #* bundle_audit:run
14
+ #* git -a -m "Anything"
15
+ #* git tag x.x.x
16
+
17
+ # Release:
18
+ #* Create Release in Github
19
+ #* rake release
20
+ #* send_email
21
+ #* clean_pkg
22
+
23
+ # Post-release:
24
+ #* Bump version
25
+ #* Add new Milestone on Github
26
+
27
+ # Dependencies
28
+ require 'rubygems'
29
+ require 'hoe'
30
+
31
+ Hoe.plugin :bundler
32
+ Hoe.plugin :rdoc
33
+ Hoe.plugin :rubygems
34
+ Hoe.plugin :version
35
+
36
+
37
+ ###########################################DEVELOPING ZONE##############################################################
38
+ # rubocop:disable Metrics/LineLength
39
+ Hoe.spec 'hoe-manns' do
40
+ developer('Sascha Manns', 'Sascha.Manns@mailbox.org')
41
+ license 'GPL-3.0' # this should match the license in the README
42
+ require_ruby_version '>= 2.2.0'
43
+
44
+ dependency 'rainbow', '~> 3.0'
45
+ dependency 'bundler-audit', '~> 0.6'
46
+
47
+ extra_dev_deps << ['hoe-bundler', '~> 1.3']
48
+ extra_dev_deps << ['hoe-rubygems', '~> 1.0']
49
+ extra_dev_deps << ['hoe-version', '~> 1.2']
50
+ extra_dev_deps << ['rdoc', '~> 5.1']
51
+ extra_dev_deps << ['rspec', '~> 3.7']
52
+
53
+ self.history_file = 'History.rdoc'
54
+ self.readme_file = 'README.rdoc'
55
+ self.extra_rdoc_files = FileList['*.rdoc'].to_a
56
+ self.post_install_message = 'Please file bugreports on: https://github.com/saigkill/hoe-manns/issues'
57
+ end
58
+
59
+ ##################################################SETUP ZONE############################################################
60
+
61
+
62
+
63
+ # vim: syntax=ruby
64
+
@@ -1,71 +1,71 @@
1
- # Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
2
- #
3
- # This program is free software: you can redistribute it and/or modify
4
- # it under the terms of the GNU General Public License as published by
5
- # the Free Software Foundation, either version 3 of the License, or
6
- # (at your option) any later version.
7
- #
8
- # This program is distributed in the hope that it will be useful,
9
- # but WITHOUT ANY WARRANTY; without even the implied warranty of
10
- # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
- # GNU General Public License for more details.
12
- #
13
- # You should have received a copy of the GNU General Public License
14
- # along with this program. If not, see <http://www.gnu.org/licenses/>.
15
-
16
- # Dependencies
17
- require 'rainbow/ext/string'
18
-
19
- # Module Hoe
20
- # TODO: Try to fix this in future
21
- # rubocop:disable Metrics/ClassAndModuleChildren
22
- module Hoe::MannsMethods
23
- # Installs a bundle
24
- def self.bundle_install
25
- puts 'Installing Bundle'.color(:yellow)
26
- system('bundle install')
27
- puts 'Installed Bundle'.color(:green)
28
- end
29
-
30
- # Update Gemfile.lock
31
- def self.update_gemfile_lock_method
32
- puts 'Updating Gemfile.lock'.color(:yellow)
33
- system('bundle update')
34
- puts 'Updated Gemfile.lock'.color(:green)
35
- end
36
-
37
- # Remove prerelease gemspec
38
- def self.remove_pre_gemspec_method
39
- puts 'Removing pre version of gemspec'.color(:yellow)
40
- File.delete(*Dir.glob('*.gemspec'))
41
- puts 'Removed'.color(:green)
42
- end
43
-
44
- # Copying stuff to master
45
- def self.copy_master
46
- copy_master_co_master
47
- puts 'Set a Git Tag'.color(:yellow)
48
- system('rake git:tag')
49
- puts 'Checking out develop again'.color(:yellow)
50
- system('git checkout develop')
51
- puts 'Done'.color(:green)
52
- end
53
-
54
- # Check out master
55
- def self.copy_master_co_master
56
- puts 'Checking out master'.color(:yellow)
57
- system('git checkout master')
58
- puts 'Merging master with develop'.color(:yellow)
59
- system('git merge develop')
60
- puts 'Pushing master to origin'.color(:yellow)
61
- system('git push')
62
- end
63
-
64
- # Cleanup the pkg
65
- def self.clean_pkg_method
66
- puts 'Cleaning pkg'.color(:yellow)
67
- FileUtils.rm_rf('pkg') if Dir.exist?('pkg')
68
- FileUtils.rm_rf('recipes/pkg') if Dir.exist?('recipes/pkg')
69
- puts 'Cleanup succeed'.color(:green)
70
- end
71
- end
1
+ # Copyright (C) 2013-2018 Sascha Manns <Sascha.Manns@mailbox.org>
2
+ #
3
+ # This program is free software: you can redistribute it and/or modify
4
+ # it under the terms of the GNU General Public License as published by
5
+ # the Free Software Foundation, either version 3 of the License, or
6
+ # (at your option) any later version.
7
+ #
8
+ # This program is distributed in the hope that it will be useful,
9
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
10
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
+ # GNU General Public License for more details.
12
+ #
13
+ # You should have received a copy of the GNU General Public License
14
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
15
+
16
+ # Dependencies
17
+ require 'rainbow/ext/string'
18
+
19
+ # Module Hoe
20
+ # TODO: Try to fix this in future
21
+ # rubocop:disable Metrics/ClassAndModuleChildren
22
+ module Hoe::MannsMethods
23
+ # Installs a bundle
24
+ def self.bundle_install
25
+ puts 'Installing Bundle'.color(:yellow)
26
+ system('bundle install')
27
+ puts 'Installed Bundle'.color(:green)
28
+ end
29
+
30
+ # Update Gemfile.lock
31
+ def self.update_gemfile_lock_method
32
+ puts 'Updating Gemfile.lock'.color(:yellow)
33
+ system('bundle update')
34
+ puts 'Updated Gemfile.lock'.color(:green)
35
+ end
36
+
37
+ # Remove prerelease gemspec
38
+ def self.remove_pre_gemspec_method
39
+ puts 'Removing pre version of gemspec'.color(:yellow)
40
+ File.delete(*Dir.glob('*.gemspec'))
41
+ puts 'Removed'.color(:green)
42
+ end
43
+
44
+ # Copying stuff to master
45
+ def self.copy_master
46
+ copy_master_co_master
47
+ puts 'Set a Git Tag'.color(:yellow)
48
+ system('rake git:tag')
49
+ puts 'Checking out develop again'.color(:yellow)
50
+ system('git checkout develop')
51
+ puts 'Done'.color(:green)
52
+ end
53
+
54
+ # Check out master
55
+ def self.copy_master_co_master
56
+ puts 'Checking out master'.color(:yellow)
57
+ system('git checkout master')
58
+ puts 'Merging master with develop'.color(:yellow)
59
+ system('git merge develop')
60
+ puts 'Pushing master to origin'.color(:yellow)
61
+ system('git push')
62
+ end
63
+
64
+ # Cleanup the pkg
65
+ def self.clean_pkg_method
66
+ puts 'Cleaning pkg'.color(:yellow)
67
+ FileUtils.rm_rf('pkg') if Dir.exist?('pkg')
68
+ FileUtils.rm_rf('recipes/pkg') if Dir.exist?('recipes/pkg')
69
+ puts 'Cleanup succeed'.color(:green)
70
+ end
71
+ end