hoe-manns 2.1.2 → 2.1.8

data/MAINTENANCE.md

@@ -0,0 +1,19 @@
+# MAINTENANCE 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.

data/README.md

@@ -0,0 +1,89 @@
+# 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 CHANGELOG.md contains a detailed description of what has changed.
+
+hoe-manns is released under the GPL-3.0-or-later License, see the file 'LICENSE.md' for more information.
+
+|What | Where |
+|-----|--------|
+|codebase | [https://github.com/saigkill/hoe-manns] |  
+|rdoc | [http://www.rubydoc.info/gems/hoe-manns] |  
+|docs | [https://github.com/saigkill/hoe-manns/wiki] |  
+|bugs  & feature requests | [https://github.com/saigkill/hoe-manns/issues] |  
+|openhub statistics| [https://www.openhub.net/p/hoe-manns] |  
+|authors blog| [https://saschamanns.de/] |
+
+| What | Status |
+|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|last public version | [![Last Version](https://badge.fury.io/rb/hoe-manns.png)](http://rubygems.org/gems/hoe-manns) |
+|downloads latest | [![Downloads latest](https://img.shields.io/gem/dtv/hoe-manns.svg)](http://rubygems.org/gems/hoe-manns)  |
+|downloads all | [![Downloads all](https://img.shields.io/gem/dt/hoe-manns.svg)](http://rubygems.org/gems/hoe-manns) |
+|continuous integration | ![CI](https://github.com/saigkill/hoe-manns/workflows/CI/badge.svg?branch=master&event=push) |
+|code quality | [![Code Quality](https://api.codeclimate.com/v1/badges/009b795034d7c698c74f/maintainability)](https://codeclimate.com/github/saigkill/hoe-manns/maintainability) |
+|dependencies|[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=saigkill/hoe-manns)](https://dependabot.com)
+|security | [![Security](https://hakiri.io/github/saigkill/hoe-manns/master.svg)](https://hakiri.io/github/saigkill/hoe-manns/master/shield) |
+|vulnerabilities| [![Known Vulnerabilities](https://snyk.io/test/github/saigkill/hoe-manns/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/saigkill/hoe-manns?targetFile=Gemfile.lock)  |
+|documentation quality | [![Documentation Quality](https://inch-ci.org/github/saigkill/hoe-manns.svg?branch=master)](https://inch-ci.org/github/saigkill/hoe-manns) |
+
+## SCREENSHOT
+
+[![Screenshot](https://saschamanns.de/img/screenshots/hoe-manns-screenshots.png)](https://github.com/saigkill/hoe-manns)
+
+## 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
+
+## 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 MAINTENANCE.md and CONTRIBUTING.md for more information.
+
+## ISSUE TRACKING
+
+* Add ideas on: https://github.com/saigkill/hoe-manns/issues

data/lib/hoe/manns-methods.rb

@@ -1,71 +1,71 @@
-# 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
+# Copyright (C) 2013-2020 Sascha Manns <Sascha.Manns@outlook.de>
+#
+# 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

data/lib/hoe/manns.rb

@@ -1,106 +1,104 @@
-# 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 'hoe'
-require_relative 'manns-methods.rb'
-
-# Main module Hoe
-# TODO: Currently i don't know how to fix this.
-# Nested usage triggers error "hoe not a module"
-# rubocop:disable Metrics/ClassAndModuleChildren
-module Hoe::Manns
-  # Version constant for HOE::Manns
-  VERSION = '2.1.2'.freeze
-
-  attr_accessor :remove_pre_gemspec
-  attr_accessor :copy_master
-  attr_accessor :run_before_release
-  attr_accessor :clean_pkg
-  attr_accessor :bundle_audit
-
-  # Initialize plugin
-  def initialize_manns
-    require 'fileutils'
-    require 'rainbow/ext/string'
-    require 'bundler/audit/cli'
-  end
-
-  # Definitions of the Rake task
-  # TODO: Check if this smells can be pacified in future
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
-  # This method smells of :reek:TooManyStatements
-  def define_manns_tasks
-    # Install a Bundle
-    desc 'Install a Bundle'
-    task 'bundler:gemfile_install' do
-      Hoe::MannsMethods.bundle_install
-    end
-
-    # Task for updating Gemfile.lock
-    desc 'Update Gemfile.lock'
-    task 'bundler:gemfile_lock' do
-      Hoe::MannsMethods.update_gemfile_lock_method
-    end
-
-    # Task for removing Prerelease Gemspecs
-    desc 'Remove Pre-Gemspec'
-    task 'gem:spec_remove' do
-      Hoe::MannsMethods.remove_pre_gemspec_method
-    end
-
-    # Task for git tag
-    desc 'Copy master'
-    task :copy_master do
-      Hoe::MannsMethods.copy_master
-    end
-
-    # Task for running needed Rake Tasks before running rake release
-    desc 'Run all tasks before rake release'
-    task run_before_release:
-             %w[git:manifest bundler:gemfile bundler:gemfile_lock gem:spec_remove bundle_audit:run copy_master] do
-      puts 'Ready to run rake release VERSION=x.y.z'.color(:green)
-    end
-
-    # Task for cleaning up the pkg
-    desc 'Clean pkg'
-    task :clean_pkg do
-      Hoe::MannsMethods.clean_pkg_method
-    end
-
-    # Tasks for bundle audit
-    namespace :bundle_audit do
-      desc 'Update bundle-audit database'
-      task :update do
-        Bundler::Audit::CLI.new.update
-      end
-
-      desc 'Check gems for vulns using bundle-audit'
-      task :check do
-        Bundler::Audit::CLI.new.check
-      end
-
-      desc 'Update vulns database and check gems using bundle-audit'
-      task :run do
-        Rake::Task['bundle_audit:update'].invoke
-        Rake::Task['bundle_audit:check'].invoke
-      end
-    end
-    task :bundle_audit do
-      Rake::Task['bundle_audit:run'].invoke
-    end
-  end
-end
+# Copyright (C) 2013-2020 Sascha Manns <Sascha.Manns@outlook.de>
+#
+# 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 'hoe'
+require_relative 'manns-methods.rb'
+
+# Main module Hoe
+# TODO: Currently i don't know how to fix this.
+# Nested usage triggers error "hoe not a module"
+# rubocop:disable Metrics/ClassAndModuleChildren
+module Hoe::Manns
+
+  attr_accessor :remove_pre_gemspec
+  attr_accessor :copy_master
+  attr_accessor :run_before_release
+  attr_accessor :clean_pkg
+  attr_accessor :bundle_audit
+
+  # Initialize plugin
+  def initialize_manns
+    require 'fileutils'
+    require 'rainbow/ext/string'
+    require 'bundler/audit/cli'
+  end
+
+  # Definitions of the Rake task
+  # TODO: Check if this smells can be pacified in future
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  # This method smells of :reek:TooManyStatements
+  def define_manns_tasks
+    # Install a Bundle
+    desc 'Install a Bundle'
+    task 'bundler:gemfile_install' do
+      Hoe::MannsMethods.bundle_install
+    end
+
+    # Task for updating Gemfile.lock
+    desc 'Update Gemfile.lock'
+    task 'bundler:gemfile_lock' do
+      Hoe::MannsMethods.update_gemfile_lock_method
+    end
+
+    # Task for removing Prerelease Gemspecs
+    desc 'Remove Pre-Gemspec'
+    task 'gem:spec_remove' do
+      Hoe::MannsMethods.remove_pre_gemspec_method
+    end
+
+    # Task for git tag
+    desc 'Copy master'
+    task :copy_master do
+      Hoe::MannsMethods.copy_master
+    end
+
+    # Task for running needed Rake Tasks before running rake release
+    desc 'Run all tasks before rake release'
+    task run_before_release:
+             %w[git:manifest bundler:gemfile bundler:gemfile_lock gem:spec_remove bundle_audit:run copy_master] do
+      puts 'Ready to run rake release VERSION=x.y.z'.color(:green)
+    end
+
+    # Task for cleaning up the pkg
+    desc 'Clean pkg'
+    task :clean_pkg do
+      Hoe::MannsMethods.clean_pkg_method
+    end
+
+    # Tasks for bundle audit
+    namespace :bundle_audit do
+      desc 'Update bundle-audit database'
+      task :update do
+        Bundler::Audit::CLI.new.update
+      end
+
+      desc 'Check gems for vulns using bundle-audit'
+      task :check do
+        Bundler::Audit::CLI.new.check
+      end
+
+      desc 'Update vulns database and check gems using bundle-audit'
+      task :run do
+        Rake::Task['bundle_audit:update'].invoke
+        Rake::Task['bundle_audit:check'].invoke
+      end
+    end
+    task :bundle_audit do
+      Rake::Task['bundle_audit:run'].invoke
+    end
+  end
+end