hoe-manns 1.0.0

data/README.rdoc

@@ -0,0 +1,114 @@
+= hoe-manns
+
+home  :: http://saigkill.github.io
+code  :: http://github.com/saigkill/hoe-manns
+rdoc  :: http://www.rubydoc.info/gems/hoe-manns
+docu :: http://saigkill.github.io/docs/hoemanns/index.html
+bugs  :: http://saigkill-bugs.myjetbrains.com/youtrack/issues
+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://secure.travis-ci.org/saigkill/hoe-manns.png?branch=master" alt="Build Status" />}[https://secure.travis-ci.org/saigkill/hoe-manns]
+continuous integration :: {<img src="https://scrutinizer-ci.com/g/saigkill/hoe-manns/badges/build.png?b=master" alt="Build Status" />}[https://scrutinizer-ci.com/g/saigkill/hoe-manns/build-status/master]
+continuous integration :: {<img src="http://saigkill.ddns.net:8111/app/rest/builds/buildType:(id:hoe-manns_Build)/statusIcon" alt="Build Status" />}[http://saigkill.ddns.net:8111/viewType.html?buildTypeId=hoe-manns_Build&guest=1]
+test coverage :: {<img src="https://coveralls.io/repos/saigkill/hoe-manns/badge.png?branch=master" alt="Test Coverage" />}[https://coveralls.io/r/saigkill/hoe-manns?branch=master]
+code quality :: {<img src="https://codeclimate.com/github/saigkill/hoe-manns.png" alt="Code Quality" />}[https://codeclimate.com/github/saigkill/hoe-manns]
+code quality :: {<img src="https://scrutinizer-ci.com/g/saigkill/hoe-manns/badges/quality-score.png?b=master" alt="Code Quality" />}[https://scrutinizer-ci.com/g/saigkill/hoe-manns/?branch=master]
+dependency check :: {<img src="https://gemnasium.com/saigkill/hoe-manns.png" alt="Dependency Check" />}[https://gemnasium.com/saigkill/hoe-manns]
+still maintained? :: {<img src="http://stillmaintained.com/saigkill/hoe-manns.png" alt="Still maintained?" />}[http://stillmaintained.com/saigkill/hoe-manns]
+documentation quality :: {<img src="http://inch-ci.org/github/saigkill/hoe-manns.svg?branch=master" alt="Documentation Quality" />}[http://inch-ci.org/github/saigkill/hoe-manns]
+donations :: {<img src="https://pledgie.com/campaigns/30268.png?skin_name=chrome" alt="Donations" />}[https://pledgie.com/campaigns/FIX]
+donations :: {<img src="http://img.shields.io/gratipay/saigkill.svg" alt="Donations" />}[https://gratipay.com/~saigkill/]
+donations :: {<img src="http://tsv-neuss.de/cms/upload/News-Bilder/amazon1.png" alt="Donations" />}[http://www.amazon.de/registry/wishlist/D75HOEQ00BDD]
+
+
+== DESCRIPTION:
+
+hoe-manns is a small collection of my personal used rake tasks for using with hoe. Actually it includes that tasks:
+
+* update_gemfile_lock
+* remove_pre_gemspec
+* update_workspace
+* update_index
+* copy_manuals
+* run_before_release
+* run_after_release
+* clean_pkg
+
+== FEATURES/PROBLEMS:
+
+* Updates the Gemfile.lock
+* Removes the old *.gemspec created in test cases
+* It adds .idea/ to git, does a commit for all stacked changes and pushs it before rake release
+* Does a index --using VERSION Index.yml if you use the indexer from Rubyworks
+* copies your manuals to your docpath.
+* runs the rake tasks before release: git:manifest, bundler:gemfile, update_gemfile_lock, update_index,
+remove_pre_gemspec and update_workspace
+* runs after release: send_email version:bump
+* Cleans up the pkg dir
+
+For a detailed information please visit: http://saigkill.github.io/docs/hoemanns/index.html
+If you like this piece of software don't forget to give the github repo a star.
+
+== SYNOPSIS:
+
+Use in your Rakefile:
+
+    Hoe.plugin :manns
+
+    Hoe.spec 'yourproject' do
+    ...
+    end
+
+Also add hoe-manns to your requirements and recreate your Gemfile.
+
+== REQUIREMENTS:
+
+* rake
+* hoe
+* parseconfig
+
+== INSTALL:
+
+* gem install hoe-manns
+* cd /path/to/gem (In case of using RVM anything like ~/.rvm/gems/ruby-2.2.1/gems/hoe-manns)
+* rake setup
+
+'rake setup' installs a config file in $HOME/.hoe-manns/hoe-manns.cfg. If you would like to use copy_manuals so you
+have to place in the config your docpath.
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+Read https://github.com/saigkill/hoe-manns/blob/master/CONTRIBUTING.md
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2015 Sascha Manns <samannsml@directbox.com>
+
+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.

data/Rakefile

@@ -0,0 +1,104 @@
+# -*- ruby -*-
+# Release:
+# * Enable Hoe.plugin :deveiate
+# * Generate new apidocs
+# * Update pages
+# * regenerate pages
+# * rake copy_manuals
+# * Disable Hoe.plugin :deveiate
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :bundler
+#Hoe.plugin :deveiate # Enable deveiate plugin for generating manuals and send_email
+Hoe.plugin :doofus
+Hoe.plugin :email
+Hoe.plugin :gemspec
+# Hoe.plugin :gem_prelude_sucks
+Hoe.plugin :git
+Hoe.plugin :history
+Hoe.plugin :highline
+#Hoe.plugin :inline
+Hoe.plugin :manualgen
+Hoe.plugin :manifest
+Hoe.plugin :manns
+# Hoe.plugin :mercurial
+#Hoe.plugin :perforce
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+Hoe.plugin :reek
+Hoe.plugin :rdoc
+Hoe.plugin :rubocop
+Hoe.plugin :rubygems
+#Hoe.plugin :seattlerb
+Hoe.plugin :travis
+Hoe.plugin :version
+Hoe.plugin :website
+Hoe.plugin :yard
+
+###########################################DEVELOPING ZONE##############################################################
+# rubocop:disable Metrics/LineLength
+Hoe.spec 'hoe-manns' do
+  developer('Sascha Manns', 'samannsml@directbox.com')
+  license 'MIT' # this should match the license in the README
+  require_ruby_version '>= 2.2.0'
+
+  #email_to << 'ruby-talk@ruby-lang.org'
+  email_to << 'Sascha.Manns@directbox.com'
+
+  dependency 'setup', '~> 5.2'
+  dependency 'parseconfig', '~> 1.0'
+
+  extra_dev_deps << ['coveralls', '~> 0.8']
+  extra_dev_deps << ['gem-release', '~> 0.7']
+  extra_dev_deps << ['hoe-bundler', '~> 1.2']
+  extra_dev_deps << ['hoe-deveiate', '~> 0.7']
+  extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  extra_dev_deps << ['hoe-gemspec', '~> 1.0']
+  extra_dev_deps << ['hoe-git', '~> 1.6']
+  extra_dev_deps << ['hoe-highline', '~> 0.2']
+  extra_dev_deps << ['hoe-manifest', '~> 0.1']
+  extra_dev_deps << ['hoe-manns', '~> 1.0']
+  extra_dev_deps << ['hoe-manualgen', '~> 0.3']
+  extra_dev_deps << ['hoe-reek', '~> 1.0']
+  extra_dev_deps << ['hoe-rubocop', '~> 0.1']
+  extra_dev_deps << ['hoe-rubygems', '~> 1.0']
+  extra_dev_deps << ['hoe-seattlerb', '~> 1.3']
+  extra_dev_deps << ['hoe-travis', '~> 1.2']
+  extra_dev_deps << ['hoe-version', '~> 1.2']
+  extra_dev_deps << ['hoe-yard', '~> 0.1']
+  extra_dev_deps << ['indexer', '~> 0.3']
+  extra_dev_deps << ['rake', '~> 10.0']
+  extra_dev_deps << ['reek', '~> 3.3']
+  extra_dev_deps << ['rspec', '~> 3.2']
+  extra_dev_deps << ['rubocop', '~> 0.34']
+  extra_dev_deps << ['simplecov', '~> 0.10']
+  extra_dev_deps << ['ZenTest', '~> 4.11']
+
+  self.history_file = 'History.rdoc'
+  self.readme_file = 'README.rdoc'
+  self.extra_rdoc_files = FileList['*.rdoc'].to_a
+  self.post_install_message = '*** Run rake setup to finish the installation *** Please file bugreports and feature requests on: http://saigkill-bugs.myjetbrains.com/youtrack/issues'
+end
+
+require 'fileutils'
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib/hoe/manns'))
+desc 'Prepares for release'
+task :make_release => %w(run_before_release) do
+
+  system("rake release VERSION=#{Hoe::Manns::VERSION}")
+
+  Rake::Task['run_after_release']
+end
+
+##################################################SETUP ZONE############################################################
+require 'setup'
+task :setup do
+  system('setup.rb uninstall --force')
+  system('setup.rb config --sysconfdir=$HOME/.hoe-manns')
+  system('setup.rb install')
+end
+
+
+# vim: syntax=ruby

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/config.reek

@@ -0,0 +1,111 @@
+---
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 3
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+ModuleInitialize:
+  enabled: true
+  exclude: []
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+PrimaDonnaMethod:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 2
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 9
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 25
+TooManyStatements:
+  enabled: true
+  exclude:
+  - initialize
+  max_statements: 15
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept:
+  - Inline::C
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  - !ruby/regexp /^_/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - _
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []

data/etc/hoe-manns.cfg

@@ -0,0 +1 @@
+docpath = "/home/sascha/RubymineProjects/saigkill.github.com/docs/"

data/lib/hoe/manns.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# @encoding: utf-8
+# @author: Sascha Manns
+# @abstract: hoe-manns is a small collection of my personal used rake tasks for using with hoe
+#
+# Copyright (c) 2015 Sascha Manns <samannsml@directbox.com>
+# License: MIT
+
+# Dependencies
+
+# empty main class
+class Hoe; end
+
+# Main module for hoe-manns
+module Hoe::Manns
+  # Version constant for HOE::Manns
+  VERSION = '1.0.0'
+
+  attr_accessor :update_gemfile_lock
+  attr_accessor :remove_pre_gemspec
+  attr_accessor :update_workspace
+  attr_accessor :update_index
+  attr_accessor :copy_manuals
+  attr_accessor :run_before_release
+  attr_accessor :run_after_release
+  attr_accessor :clean_pkg
+
+  def initialize_manns
+    require 'yaml'
+    require 'fileutils'
+    require 'rainbow/ext/string'
+  end
+
+  def define_manns_tasks
+
+    desc 'Update Gemfile.lock'
+    task :update_gemfile_lock do
+      Hoe::Manns.update_gemfile_lock_method
+    end
+
+    desc 'Remove Pre-Gemspec'
+    task :remove_pre_gemspec do
+      Hoe::Manns.remove_pre_gemspec_method
+    end
+
+    desc 'Update Workspace'
+    task :update_workspace do
+      Hoe::Manns.update_workspace_method
+    end
+
+    desc 'Update .index'
+    task :update_index do
+      Hoe::Manns.update_index_method
+    end
+
+    require 'parseconfig'
+    desc 'Copy manuals'
+    task :copy_manuals do
+      Hoe::Manns.copy_manuals_method
+    end
+
+    desc 'Run all tasks before rake release'
+    task :run_before_release => %w(git:manifest bundler:gemfile update_gemfile_lock update_index remove_pre_gemspec
+update_workspace) do
+      puts 'Ready to run rake release VERSION=x.y.z'.color(:green)
+    end
+
+    desc 'Run all tasks after rake release'
+    task :run_after_release => %w(send_email version:bump) do
+      puts 'Release finished'.color (:green)
+    end
+
+    desc 'Clean pkg'
+    task :clean_pkg do
+      Hoe::Manns.clean_pkg_method
+    end
+  end
+
+  require 'rainbow/ext/string'
+  # Method for updating Gemfile.lock
+  def self.update_gemfile_lock_method
+    puts 'Updating Gemfile.lock'.color(:yellow)
+    system('bundle update')
+    puts 'Updated Gemfile.lock'.color(:green)
+  end
+
+  # Method for removing 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
+
+  # Method for updating workspace
+  def self.update_workspace_method
+    puts 'Updating workspace'.color(:yellow)
+    system('git add .idea/*')
+    system('git add Manifest.txt Gemfile Gemfile.lock')
+    system('git commit -m "Updated workspace"')
+    system('git push')
+    puts 'Updated workspace'.color(:green)
+  end
+
+  # Method for updating .index
+  def self.update_index_method
+    puts 'Updating .index. Have you changed your VERSION file?'.color(:yellow)
+    system('index --using VERSION Index.yml')
+    system('git add .index')
+    puts '.index updated'.color(:green)
+  end
+
+  # Method for copying the manuals to a target directory
+  def self.copy_manuals_method
+    puts 'Copying manual pages to target'.color(:yellow)
+    pnameraw = File.open(*Dir.glob('README.*')) {|f| f.readline}
+    project = pnameraw.gsub(/[^0-9A-Za-z]/, '')
+    config = ParseConfig.new(File.join("#{Dir.home}/.hoe-manns/hoe-manns.cfg"))
+    docpath = config['docpath'].to_s
+    FileUtils.cp_r('manual/output', "#{docpath}/#{project}")
+  end
+
+  # Method for cleanup the pkg
+  def self.clean_pkg_method
+    puts 'Cleaning pkg'.color(:yellow)
+    FileUtils.rm_rf('pkg') if Dir.exist?('pkg')
+    puts 'Cleanup succeed'.color(:green)
+  end
+end

data/manual/layouts/default.erb

@@ -0,0 +1,87 @@
+<!DOCTYPE html>  
+<!--
+
+	Main Manual Layout
+	$Id: default.erb.erb,v 8077c9cdbac9 2011/01/26 02:15:09 ged $
+	
+	Author: Michael Granger <ged@FaerieMUD.org>
+	Two column fluid layout adapted from Matthew James Taylor's "Perfect 'Left Menu' 
+	2 Column Liquid Layout":
+	http://matthewjamestaylor.com/blog/perfect-2-column-left-menu.htm
+
+  -->
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+
+  <title>hoe-manns Manual — <%= page.config['title'] || "untitled" %></title>
+
+  <link rel="stylesheet" href="css/manual.css">
+
+  <script src="js/jquery-1.4.4.min.js"></script>
+  <script src="js/sh.js"></script>
+  <script src="js/manual.js"></script>
+
+</head>
+<body>
+<div id="page">
+
+	<header>
+		<hgroup>
+			<a href="/">
+				<h1>hoe-manns</h1>
+			</a>
+			<% if metadata.version %><h2 class="version"><%= metadata.version %></h2><% end %>
+			<% if page.config['tagline'] %><h2 class="tagline"><%= page.config['tagline'] %></h2><% end %>
+		</hgroup>
+	</header>
+
+	<div class="colmask leftmenu">
+		<div class="colleft">
+
+			<section id="content" class="col1">
+				<!-- Generated content -->
+				<%= content %>
+				<!-- end of generated content -->
+			</section>
+
+			<aside id="sidebar" class="col2">
+				<nav>
+		<%
+					@catalog.traverse_page_hierarchy( self ) do |type, title, path|
+						case type
+		  			when :section
+		%>
+						<div class="section">
+							<h3><a href="<%= self.basepath + path %>/"><%= title %></a></h3>
+							<ul class="index-section">
+		<%  		when :current_section %>
+						<div class="section current-section">
+							<h3><a href="<%= self.basepath + path %>/"><%= title %></a></h3>
+							<ul class="index-section current-index-section">
+		<%  		when :section_end, :current_section_end %>
+							</ul>
+						</div>
+		<%  		when :entry %>
+							<li><a href="<%= self.basepath + path %>.html"><%= title %></a></li>
+		<%  		when :current_entry %>
+							<li class="current-entry"><%= title %></li>
+		<% 			end
+					end
+		 %>
+				</nav>
+	</aside>
+
+		</div>
+	</div>
+ 
+	<footer>
+		<div class="copyright">Copyright &copy; 2008-<%= Time.now.year %> Sascha Manns.</div>
+		<div class="vcsrev">Rev: $Revision: 8077c9cdbac9 $</div>
+		<div class="timestamp">Built: <%= Time.now.strftime("%Y%m%d %H:%M:%S %Z") %></div>
+	</footer>
+
+</body>
+</html>
+

data/manual/lib/api-filter.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/ruby 
+#
+# A manual filter to generate links from the Darkfish API.
+#
+# Authors:
+# * Michael Granger <ged@FaerieMUD.org>
+# * Mahlon E. Smith <mahlon@martini.nu>
+#
+
+
+### A filter for generating links from the generated API documentation. This allows you to refer
+### to class documentation by simply referencing a class name.
+###
+### Links are XML processing instructions. Pages can be referenced as such:
+###
+###   <?api Class::Name ?>
+###   <?api Class::Name#instance_method ?>
+###   <?api Class::Name.class_method ?>
+###
+### Link text can be overridden, too:
+###
+###   <?api "click here":Class::Name ?>
+###   <?api "click here":Class::Name#instance_method ?>
+###
+class Hoe::ManualGen::APIFilter < Hoe::ManualGen::PageFilter
+
+	# PI	   ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
+	ApiPI = %r{
+		<\?
+			api			# Instruction Target
+			\s+
+			(?:"
+				(.*?)   # Optional link text [$1]
+			":)?
+			(.*?)	    # Class name [$2]
+			([\.#].*?)? # Method anchor [$3]
+			\s+
+		\?>
+	  }x
+
+
+	######
+	public
+	######
+
+	### Process the given +source+ for <?api ... ?> processing-instructions, calling out
+	def process( source, page, metadata )
+
+		apipath = metadata.api_dir or
+			raise "The API output directory is not defined in the manual task."
+
+		return source.gsub( ApiPI ) do |match|
+			# Grab the tag values
+			link_text  = $1
+			classname  = $2
+			methodname = $3
+
+			self.generate_link( page, apipath, classname, methodname, link_text )
+		end
+	end
+
+
+	### Create an HTML link fragment from the parsed ApiPI.
+	def generate_link( current_page, apipath, classname, methodname=nil, link_text=nil )
+
+		classpath = "%s.html" % [ classname.gsub('::', '/') ]
+		classfile = apipath + classpath
+		classuri  = current_page.basepath + 'api' + classpath
+
+		if classfile.exist?
+			return %{<a href="%s%s">%s</a>} % [
+				classuri,
+				make_anchor( methodname ),
+				link_text || (classname + (methodname || ''))
+			]
+		else
+			link_text ||= classname
+			error_message = "Could not find a link for class '%s'" % [ classname ]
+			$stderr.puts( error_message )
+			return %{<a href="#" title="#{error_message}" class="broken-link">#{link_text}</a>}
+		end
+	end
+
+
+	### Attach a method anchor.
+	def make_anchor( methodname )
+		return '' unless methodname
+
+		method_type = methodname[ 0, 1 ]
+		return "#method-%s-%s" % [
+			( method_type == '#' ? 'i' : 'c' ),
+			methodname[ 1..-1 ]
+		]
+	end
+end
+