hoe-manns 2.1.1 → 2.1.2

data/README.rdoc

@@ -1,172 +1,106 @@
-= hoe-manns
-
-code  :: https://launchpad.net/hoe-manns
-rdoc  :: http://www.rubydoc.info/gems/hoe-manns
-docs  :: https://saigkill.github.io/hoe-manns/about/
-bugs  :: https://bugs.launchpad.net/hoe-manns
-questions :: https://answers.launchpad.net/hoe-manns
-feature requests :: https://blueprints.launchpad.net/hoe-manns
-openhub statistics :: https://www.openhub.net/p/hoe-manns
-authors blog :: https://saigkill.tuxfamily.org
-min_rubyver :: 2.3.0
-
-If you're reading this on Github, please keep in mind, that this is just a
-mirror. The development happens on: https://launchpad.net/hoe-manns
-
-== DESCRIPTION:
-
-hoe-manns is a small collection of my personal used rake tasks for using with hoe. Actually it includes that tasks:
-
-* bundler:gemfile_lock
-* bundle_audit:*
-* clean_pkg
-* copy_master
-* remove_pre_gemspec
-* run_before_release
-* run_after_release
-
-The History.rdoc contains a detailed description on what has changed. For most
-users the NEWS file might be a better place to look since it contains
-change summaries between the different versions.
-
-hoe-manns is released under the GPL3 License, see the file 'License.rdoc'
-for more information.
-
-The official web site is:
-
-    https://launchpad.net/hoe-manns
-
-== FEATURES/PROBLEMS:
-
-* Updates the Gemfile.lock
-* Removes the old *.gemspec created in test cases
-* copies your manuals to your docpath.
-* runs the rake tasks before release: git:manifest, bundler:gemfile, update_gemfile_lock, remove_pre_gemspec,
-bundler_audit:run and copy_mirror.
-* runs after release: send_email.
-* Cleans up the pkg dir
-* provides bundler_audit tasks
-
-This Gem was programmed and tested for Linux systems. If anyone would like to make the methods also fit for other OS,
-i'm happy about Pull requests.
-
-See the {FAQs}[https://answers.launchpad.net/hoe-manns/+faqs] for checking known issues.
-See the {status}[https://github.com/saigkill/hoe-manns/blob/master/STATUS.rdoc] of the app.
-
-== SYNOPSIS:
-
-Use in your Rakefile:
-
-    Hoe.plugin :manns
-
-    Hoe.spec 'yourproject' do
-    ...
-    end
-
-Also add hoe-manns to your requirements and recreate your Gemfile.
-
-Read the documentation at: https://saigkill.github.io/hoe-manns/about/
-
-== REQUIREMENTS:
-
-* rake
-* hoe
-* bundler-audit
-
-== INSTALL:
-
-The installation is very easy.
-
-    gem install hoe-manns
-
-Read the documentation at: https://saigkill.github.io/hoe-manns/about/
-
-== DEVELOPERS:
-
-After checking out the source, run:
-
-  $ rake newb
-
-This task will install any missing dependencies, run the tests/specs,
-and generate the RDoc.
-
-=== IDEAS:
-
-* Add ideas on: https://blueprints.launchpad.net/hoe-manns
-
-=== COOL HACKS:
-
-* Open a bugreport on https://bugs.launchpad.net/hoe-manns.
-* Please use the -u flag when generating the patch as it makes the patch
-  more readable.
-* Write a good explanation of what the patch does.
-* It is better to use git format-patch command: git format-patch HEAD^
-
-=== CONTRIBUTOR CODE OF CONDUCT:
-
-As contributors and maintainers of this project, we pledge to respect all
-people who contribute through reporting issues, posting feature requests,
-updating documentation, submitting pull requests or patches, and other
-activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal
-appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual
-language or imagery, derogatory comments or personal attacks, trolling,
-public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct. Project maintainers who do
-not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by opening an issue or contacting one or more of the project
-maintainers.
-
-This Code of Conduct is adapted from the {Contributor Covenant}[http:contributor-covenant.org],
-version 1.0.0, available at {http://contributor-covenant.org/version/1/0/0/}[http://contributor-covenant.org/version/1/0/0/].
-
-=== MAINTANANCE POLICY:
-
-I'm following the Semantic Versioning for its releases: (Major).(Minor).(Patch).
-
- * Major version: Whenever there is something significant or any backwards
-   incompatible changes.
- * Minor version: When new, backwards compatible functionality is introduced a
-   minor feature is introduced, or when a set of smaller features is rolled out.
- * Patch number: When backwards compatible bug fixes are introduced that fix
-   incorrect behavior.
- * The current stable release will receive security patches and bug fixes
-   (eg. 5.0 -> 5.0.1).
- * Feature releases will mark the next supported stable release where the minor
-   version is increased numerically by increments of one (eg. 5.0 -> 5.1).
-
-I encourage everyone to run the latest stable release to ensure that you can
-easily upgrade to the most secure and feature rich experience. In order to
-make sure you can easily run the most recent stable release, we are working
-hard to keep the update process simple and reliable.
-
-=== STRUCTURE:
-
-==== BRANCHES:
-
-===== `master` BRANCH:
-The master branch is the current edge of development.
-
-===== `X.X` BRANCH:
-The X.X branch is the last stable branch. It will used for tarballs.
-
-===== MERGE REQUESTS:
-If you want to merge your branch with the trunk, join the team.
-
-Please base all Merge requests off the `master` branch. Merges to
-`X.X` only occur through the `master` branch.
-
-== PROBLEM REPORTING:
-
-Bugs should be reported to https://bugs.launchpad.net/hoe-manns. You will need to create an
-account for yourself.
+= hoe-manns
+
+code  :: https://github.com/saigkill/hoe-manns
+rdoc  :: http://www.rubydoc.info/gems/hoe-manns
+docs  :: http://saigkill.tuxfamily.org/documentation/hoe-manns/
+bugs  & feature requests:: https://github.com/saigkill/hoe-manns/issues
+mailing list :: https://groups.google.com/forum/#!forum/saigkills-hoe-plugins
+openhub statistics :: https://www.openhub.net/p/hoe-manns
+authors blog :: https://saigkill.tuxfamily.org
+min_rubyver :: 2.3.0
+
+last public version  :: {<img src="https://badge.fury.io/rb/hoe-manns.png" alt="Last Version" />}[http://rubygems.org/gems/hoe-manns]
+downloads latest :: {<img src="https://img.shields.io/gem/dtv/hoe-manns.svg" alt="Downloads latest version" />}[http://rubygems.org/gems/hoe-manns]
+downloads all :: {<img src="https://img.shields.io/gem/dt/hoe-manns.svg" alt="Downloads all versions" />}[http://rubygems.org/gems/hoe-manns]
+continuous integration :: {<img src="https://travis-ci.org/saigkill/hoe-manns.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/saigkill/hoe-manns]
+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]
+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/]
+code quality :: {<img src="https://api.codeclimate.com/v1/badges/009b795034d7c698c74f/maintainability" />}[https://codeclimate.com/github/saigkill/hoe-manns/maintainability]
+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]
+security :: {<img src="https://hakiri.io/github/saigkill/hoe-manns/master.svg" alt="security" />}[https://hakiri.io/github/saigkill/hoe-manns/master/shield]
+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]
+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]
+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]
+donations :: http://saigkill.tuxfamily.org/wordpress/campaigns/hoe-manns/
+
+== DESCRIPTION:
+
+hoe-manns is a small collection of my personal used rake tasks for using with hoe. Actually it includes that tasks:
+
+* bundler:gemfile_lock
+* bundle_audit:*
+* clean_pkg
+* copy_master
+* remove_pre_gemspec
+* run_before_release
+* run_after_release
+
+The History.rdoc contains a detailed description of what has changed. For most
+users the NEWS file might be a better place to look since it contains
+change summaries between the different versions.
+
+hoe-manns is released under the GPL3 License, see the file 'LICENSE.rdoc'
+for more information.
+
+The official website is:
+
+    http://saigkill.tuxfamily.org/wordpress
+
+== FEATURES:
+
+* Updates the Gemfile.lock
+* Removes the old *.gemspec created in test cases
+* copies your manuals to your docpath.
+* runs the rake tasks before release: git:manifest, bundler:gemfile, update_gemfile_lock, remove_pre_gemspec,
+bundler_audit:run and copy_mirror.
+* runs after release: send_email.
+* Cleans up the pkg dir
+* provides bundler_audit tasks
+
+This Gem was programmed and tested on Linux systems. If anyone would like to make the methods also fit for other OS,
+I'm happy about Pull requests.
+
+== REQUIREMENTS:
+
+* rake
+* hoe
+* bundler-audit
+
+== INSTALL:
+
+The installation is very easy.
+
+    gem install hoe-manns
+
+== SYNOPSIS:
+
+Use in your Rakefile:
+
+    Hoe.plugin :manns
+
+    Hoe.spec 'your project' do
+    ...
+    end
+
+Also add hoe-manns to your requirements and recreate your Gemfile.
+
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+Also you can read the DEVELOPING.md and CONTRIBUTING.md for more information.
+
+=== IDEAS:
+
+* Add ideas on: https://github.com/saigkill/hoe-manns/issues
+
+
+== PROBLEM REPORTING:
+
+Bugs should be reported to https://bugs.launchpad.net/hoe-manns. You will need to create an
+account for yourself.

data/Rakefile

@@ -1,56 +1,64 @@
-# -*- ruby -*-
-# Release:
-# See README.rdoc.release
-
-require 'rubygems'
-require 'hoe'
-
-Hoe.plugin :bundler
-Hoe.plugin :doofus
-#Hoe.plugin :git
-Hoe.plugin :manns
-Hoe.plugin :rdoc
-Hoe.plugin :reek
-Hoe.plugin :rubocop
-Hoe.plugin :rubygems
-Hoe.plugin :travis
-Hoe.plugin :version
-
-
-###########################################DEVELOPING ZONE##############################################################
-# rubocop:disable Metrics/LineLength
-Hoe.spec 'hoe-manns' do
-  developer('Sascha Manns', 'Sascha.Manns@mailbox.org')
-  license 'GPL-3.0' # this should match the license in the README
-  require_ruby_version '>= 2.2.0'
-
-  dependency 'rainbow', '~> 2.2'
-  dependency 'bundler-audit', '~> 0.6'
-
-  extra_dev_deps << ['coveralls', '~> 0.8']
-  extra_dev_deps << ['hoe-bundler', '~> 1.3']
-  extra_dev_deps << ['hoe-doofus', '~> 1.0']
-  extra_dev_deps << ['hoe-git', '~> 1.6']
-  extra_dev_deps << ['hoe-manns', '~> 1.6']
-  extra_dev_deps << ['hoe-reek', '~> 1.1']
-  extra_dev_deps << ['hoe-rubocop', '~> 1.0']
-  extra_dev_deps << ['hoe-rubygems', '~> 1.0']
-  extra_dev_deps << ['hoe-travis', '~> 1.3']
-  extra_dev_deps << ['hoe-version', '~> 1.2']
-  extra_dev_deps << ['rake', '~> 12.1']
-  extra_dev_deps << ['rdoc', '~> 5.1']
-  extra_dev_deps << ['rubocop', '~> 0.50']
-  extra_dev_deps << ['rspec', '~> 3.7']
-
-  self.history_file = 'History.rdoc'
-  self.readme_file = 'README.rdoc'
-  self.extra_rdoc_files = FileList['*.rdoc'].to_a
-  self.post_install_message = 'Please file bugreports on: https://bugs.launchpad.net/hoe-manns'
-end
-
-##################################################SETUP ZONE############################################################
-
-
-
-# vim: syntax=ruby
-
+# -*- ruby -*-
+# Copyright (C) 2013-2018 Sascha Manns <Sascha.Manns@mailbox.org>
+# Release:
+# Pre-release:
+#* update docs
+#* Update copyright years if needed, in the following paths:
+#  + lib/*
+#* Check version in lib/hoe-manns.rb
+#* Update History.rdoc & NEWS
+#* git:manifest
+#* bundler:gemfile
+#* bundler:gemfile_lock
+#* bundle_audit:run
+#* git -a -m "Anything"
+#* git tag x.x.x
+
+# Release:
+#* Create Release in Github
+#* rake release
+#* send_email
+#* clean_pkg
+
+# Post-release:
+#* Bump version
+#* Add new Milestone on Github
+
+# Dependencies
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :bundler
+Hoe.plugin :rdoc
+Hoe.plugin :rubygems
+Hoe.plugin :version
+
+
+###########################################DEVELOPING ZONE##############################################################
+# rubocop:disable Metrics/LineLength
+Hoe.spec 'hoe-manns' do
+  developer('Sascha Manns', 'Sascha.Manns@mailbox.org')
+  license 'GPL-3.0' # this should match the license in the README
+  require_ruby_version '>= 2.2.0'
+
+  dependency 'rainbow', '~> 3.0'
+  dependency 'bundler-audit', '~> 0.6'
+
+  extra_dev_deps << ['hoe-bundler', '~> 1.3']
+  extra_dev_deps << ['hoe-rubygems', '~> 1.0']
+  extra_dev_deps << ['hoe-version', '~> 1.2']
+  extra_dev_deps << ['rdoc', '~> 5.1']
+  extra_dev_deps << ['rspec', '~> 3.7']
+
+  self.history_file = 'History.rdoc'
+  self.readme_file = 'README.rdoc'
+  self.extra_rdoc_files = FileList['*.rdoc'].to_a
+  self.post_install_message = 'Please file bugreports on: https://github.com/saigkill/hoe-manns/issues'
+end
+
+##################################################SETUP ZONE############################################################
+
+
+
+# vim: syntax=ruby
+

data/lib/hoe/manns-methods.rb

@@ -1,71 +1,71 @@
-# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# Dependencies
-require 'rainbow/ext/string'
-
-# Module Hoe
-# TODO: Try to fix this in future
-# rubocop:disable Metrics/ClassAndModuleChildren
-module Hoe::MannsMethods
-  # Installs a bundle
-  def self.bundle_install
-    puts 'Installing Bundle'.color(:yellow)
-    system('bundle install')
-    puts 'Installed Bundle'.color(:green)
-  end
-
-  # Update Gemfile.lock
-  def self.update_gemfile_lock_method
-    puts 'Updating Gemfile.lock'.color(:yellow)
-    system('bundle update')
-    puts 'Updated Gemfile.lock'.color(:green)
-  end
-
-  # Remove prerelease gemspec
-  def self.remove_pre_gemspec_method
-    puts 'Removing pre version of gemspec'.color(:yellow)
-    File.delete(*Dir.glob('*.gemspec'))
-    puts 'Removed'.color(:green)
-  end
-
-  # Copying stuff to master
-  def self.copy_master
-    copy_master_co_master
-    puts 'Set a Git Tag'.color(:yellow)
-    system('rake git:tag')
-    puts 'Checking out develop again'.color(:yellow)
-    system('git checkout develop')
-    puts 'Done'.color(:green)
-  end
-
-  # Check out master
-  def self.copy_master_co_master
-    puts 'Checking out master'.color(:yellow)
-    system('git checkout master')
-    puts 'Merging master with develop'.color(:yellow)
-    system('git merge develop')
-    puts 'Pushing master to origin'.color(:yellow)
-    system('git push')
-  end
-
-  # Cleanup the pkg
-  def self.clean_pkg_method
-    puts 'Cleaning pkg'.color(:yellow)
-    FileUtils.rm_rf('pkg') if Dir.exist?('pkg')
-    FileUtils.rm_rf('recipes/pkg') if Dir.exist?('recipes/pkg')
-    puts 'Cleanup succeed'.color(:green)
-  end
-end
+# Copyright (C) 2013-2018 Sascha Manns <Sascha.Manns@mailbox.org>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Dependencies
+require 'rainbow/ext/string'
+
+# Module Hoe
+# TODO: Try to fix this in future
+# rubocop:disable Metrics/ClassAndModuleChildren
+module Hoe::MannsMethods
+  # Installs a bundle
+  def self.bundle_install
+    puts 'Installing Bundle'.color(:yellow)
+    system('bundle install')
+    puts 'Installed Bundle'.color(:green)
+  end
+
+  # Update Gemfile.lock
+  def self.update_gemfile_lock_method
+    puts 'Updating Gemfile.lock'.color(:yellow)
+    system('bundle update')
+    puts 'Updated Gemfile.lock'.color(:green)
+  end
+
+  # Remove prerelease gemspec
+  def self.remove_pre_gemspec_method
+    puts 'Removing pre version of gemspec'.color(:yellow)
+    File.delete(*Dir.glob('*.gemspec'))
+    puts 'Removed'.color(:green)
+  end
+
+  # Copying stuff to master
+  def self.copy_master
+    copy_master_co_master
+    puts 'Set a Git Tag'.color(:yellow)
+    system('rake git:tag')
+    puts 'Checking out develop again'.color(:yellow)
+    system('git checkout develop')
+    puts 'Done'.color(:green)
+  end
+
+  # Check out master
+  def self.copy_master_co_master
+    puts 'Checking out master'.color(:yellow)
+    system('git checkout master')
+    puts 'Merging master with develop'.color(:yellow)
+    system('git merge develop')
+    puts 'Pushing master to origin'.color(:yellow)
+    system('git push')
+  end
+
+  # Cleanup the pkg
+  def self.clean_pkg_method
+    puts 'Cleaning pkg'.color(:yellow)
+    FileUtils.rm_rf('pkg') if Dir.exist?('pkg')
+    FileUtils.rm_rf('recipes/pkg') if Dir.exist?('recipes/pkg')
+    puts 'Cleanup succeed'.color(:green)
+  end
+end