drumherum 0.1.17 → 0.1.18

data/README.rdoc

@@ -2,27 +2,28 @@
 = Drumherum
 http://bklippstein.github.com/drumherum/frames.html
 
+"Drumherum" is a german word for "the stuff around it".
+
 == $LOAD_PATH management
-+smart_init+ finds the directory named 'lib' in your project and adds
-* the (main) directory above
-* the lib-directory itself 
-to Rubys $LOAD_PATH. So your require statements load the actual version from your (local) project directory, not the (public) gem version.
-
-Usage (wherever you are in the directory hierarchy of your project):
-  if $0 == __FILE__ 
-    require 'drumherum'
-    smart_init 
-  end
-  require 'my-gem-project'   # actual local version, not the gem version
-
-== Rake tasks for deployment
-  rake publish               # publish all on github and rubygems, reinstall gem
-  rake git_publish           # publish actual version to github  
+{include:SmartInit}
+
+== Rake tasks for DRY release automation
+Usage: Instead of +require 'rake'+ use
+  require 'drumherum/rake'
+Tasks:
+  rake version               # VERSION of the current project and the installed gem
+  rake publish               # publish gem & docs on github and rubygems, reinstall gem
+  
+  rake git_publish           # publish current project to github  
   rake git_publish_docs      # publish docs to github
   rake rubygems_publish      # release actual version to rubygems
+See {file:lib/drumherum/rake.rb rake.rb}
 
 == Unit Tests
-You will see a status display for your tests if you use UnitTest instead of Test::Unit::TestCase: 
+{include:UnitTest}
+
+== Easy development of regular expressions
+See {String#show_regexp}
 
 
 

data/Rakefile.rb

@@ -9,7 +9,6 @@ YARD::Rake::YardocTask.new
 Drumherum.github_username = 'bklippstein'
 
 
-
 #  ----------------------------------------------------------------------------------------------
 #  Hoe
 #  
@@ -34,25 +33,16 @@ end
 
   
   
-  
 #  ----------------------------------------------------------------------------------------------
-#  Local Tasks
+#  Hide Tasks
 #  
  
-remove_task 'audit' 
-remove_task 'dcov' 
-remove_task 'debug_email' 
-remove_task 'debug_gem' 
-remove_task 'deploy' 
-remove_task 'deps:email' 
-remove_task 'install_gem'
-remove_task 'multi' 
-remove_task 'newb' 
-remove_task 'publish_docs' 
-remove_task 'rdoc'
-remove_task 'ridocs'
-
-#Dir['tasks/**/*.rake'].each { |t| load t }  
+ hide_tasks [ :announce, :audit, :check_extra_deps, :clobber_docs, :clobber_package, :default ]
+ hide_tasks [ :dcov, :debug_email, :docs, :gem, :git_add, :git_commit, :git_push, :install_gem ]
+ hide_tasks [ :newb, :package, :post_blog, :publish_docs, :release, :release_sanity, :release_to_gemcutter ]
+ hide_tasks [ :repackage, :ridocs, :sleep_15, :sleep_5, :utf8, :yard, :yard_post ]
+
+
   
   
   

data/lib/drumherum/rake.rb

@@ -1,14 +1,7 @@
 # ruby encoding: utf-8
 
-#== Rake
-
-#  ----------------------------------------------------------------------------------------------
-#  Rake initialisieren
-#  
-
 require 'rake'
 
-  
 
 #   ----------------------------------------------------------------------------------------------
 #   Ergänzung: Alte Tasks entfernen
@@ -16,6 +9,16 @@ require 'rake'
 #   Beispiel: remove_task 'test:plugins'     
 #   Quelle: http://matthewbass.com/2007/03/07/overriding-existing-rake-tasks/
 #   dies hier stimmt nicht: http://www.dcmanges.com/blog/modifying-rake-tasks
+
+
+# @private
+module Rake
+  class Task 
+    def hide!
+      @comment = nil
+    end
+  end
+end  
    
 Rake::TaskManager.class_eval do
   def remove_task(task_name)
@@ -23,13 +26,44 @@ Rake::TaskManager.class_eval do
   end
 end
 
-def remove_task(task_name)
-  Rake.application.remove_task(task_name)
+
+module RakeTaskCleanup
+  
+  # If you want to override a task, you first have to delete it. Usage:
+  #  remove_task 'test:plugins'  
+  #
+  def remove_task(task_name)
+    Rake.application.remove_task(task_name)
+  end
+
+  # You can just hide tasks by clearing their descriptions.
+  # After this they still exist, but they are not listed anymore.
+  # Usage: 
+  #  hide_tasks [ :announce, :audit, :check_extra_deps, :clobber_docs, :clobber_package, :default ]
+  #
+  def hide_tasks(task_list)
+    task_list.each do | task_name |
+      t = Rake.application.lookup(task_name)
+      t.hide!
+    end
+  end
+end
+
+class Object
+  include RakeTaskCleanup
 end
 
 
 
 
+
+
+
+
+
+
+
+
 # -------------------------------------------------------------------------------------------------------
 # publish
 #
@@ -268,11 +302,17 @@ end
 
 # Task :version
 #
-desc 'VERSION of the current project'
+desc 'VERSION of the current project and the installed gem'
 task :version do
 
-  puts "\n#{Drumherum.project_name} (#{Drumherum.project_version})\n\n"
-          
+  puts "\n*** THIS PROJECT ***\n"
+  puts "\n#{Drumherum.project_name} (#{Drumherum.project_version})\n"  
+  verbose(false) do
+    sh "gem list #{Drumherum.project_name}" 
+  end  
+  puts
+  puts
+   
 end
 
 

data/lib/drumherum/regexp.rb

@@ -3,11 +3,12 @@
 
 class String
 
-
-  # Zeigt das Ergebnis eines Matches mit einer Regular Expression. Erleichtert das Entwickeln regulärer Ausdrücke.
+  # Easy development of regular expressions.
+  # @return [String] result of the match  
+  # @param [Regexp] regular_expression to match with +self+
   # 
-  def show_regexp(re)
-      if self =~ re
+  def show_regexp(regular_expression)
+      if self =~ regular_expression
           "#{$`}<<#{$&}>>#{$'}"
       else
           "no match"
@@ -17,6 +18,7 @@ class String
 end
 
 if defined? TransparentNil
+  # @private
   class NilClass
     def show_regexp(*a);                          nil;            end 
   end

data/lib/drumherum/smart_init.rb

@@ -1,12 +1,33 @@
 # ruby encoding: utf-8
-# ü
-
+#
+# 
+# You set up your release info once in your Rakefile. Like this:
+#   require 'drumherum'
+#   smart_init
+#   require 'version' 
+#   require 'yard'
+#   require 'drumherum/rake'
+#   YARD::Rake::YardocTask.new
+#   Drumherum.github_username = 'your_user_name'
+#
+# {SmartInit#smart_init smart_init} detects your root directory and sets up the projectname and all other stuff. 
+#
 module Drumherum  
    
   
   class << self
+  
+    # @!group Set this up in your Rakefile
+    
+    # @return [void] Set your github username    
+    def github_username=(your_user_name)
+      @github_username = your_user_name
+    end
+
+    
+    # @!group Release infos for DRY release automation
      
-    # Name of the actual project
+    # @return [String] Name of the actual project
     def project_name
       if @directory_main
         @directory_main[-1].strip
@@ -16,7 +37,7 @@ module Drumherum
     end
 
     
-    # Class of the actual project    
+    # @return [Class] Class of the actual project    
     def project_class
       classname = project_name.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
       unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ classname
@@ -25,70 +46,85 @@ module Drumherum
       Object.module_eval("::#{$1}", __FILE__, __LINE__)
     end
 
-    # Version of the actual project
+    # @return [String] Version of the actual project
     def project_version
       project_class.const_get('VERSION')
     end
     
     
     
-    # Set your github username    
-    def github_username=(gn)
-      @github_username = gn
-    end
+
     
-    # Your github username      
+    # @return [String] Your github username  
+    # (see #github_username=)
     def github_username
       @github_username || 'gleer'
     end    
     
-    # Set the main directory (as array)   
+    # @return [void] Set the main directory (as array)   
+    # @private
     def directory_main=(mn)
       @directory_main = mn
     end    
     
-    # The main directory (as array).
-    # main_dir = File.join(Drumherum::directory_main)
-    # lib_dir = File.join(Drumherum::directory_main, 'lib')
-    # test_dir = File.join(Drumherum::directory_main, 'test')
+    # The root directory of your project (as array).
+    # It's available whenever you called {SmartInit#smart_init smart_init} before.
+    # You can call {SmartInit#smart_init smart_init} from any location in your project directory.
+    # * main_dir = File.join(Drumherum.directory_main)
+    # * lib_dir = File.join(Drumherum.directory_main, 'lib')
+    # * test_dir = File.join(Drumherum.directory_main, 'test')
+    # @return [Array]
     #
     def directory_main
       @directory_main || []
     end      
     
     
+    # @return [void] indicates setup complete. All require-statements are done.
     def loaded!
       @loaded = true
     end
     
+    
+    # @return [true, false] setup complete? All require-statements done?       
     def loaded?
       @loaded 
     end    
     
+    # @return [String] URI to github (source)     
     def url_source
       "https://github.com/#{Drumherum.github_username}/#{Drumherum.project_name}"
     end   
 
+    # @return [String] URI to github (documentation)       
     def url_docs
       "http://#{Drumherum.github_username}.github.com/#{Drumherum.project_name}/frames.html"
     end     
-        
+       
+    
   end # moduldefinitionen   
   
 end
 
 
+# {SmartInit#smart_init smart_init} finds the directory named 'lib' in your project and adds
+# * the (main) directory above
+# * the lib-directory itself 
+# to Rubys $LOAD_PATH. So your require statements load the actual version from your (local) project directory, not the (public) gem version.
+#
+# Also, {SmartInit#smart_init smart_init} sets some {Drumherum release infos} for Hoe. 
+#
+# Usage (wherever you are in the directory hierarchy of your project):
+#  if $0 == __FILE__ 
+#    require 'drumherum'
+#    smart_init 
+#  end
+#  require 'my-gem-project'   # actual local version, not the gem version
+#
 module SmartInit 
-  
-  # Vereinfacht die require-Statements in den Tests bei der Entwicklung von Libraries.  
-  # Beim lokalen Aufruf eines einzelnen Tests wird die lokale Version der Library verwendet, nicht die installierte gem.
-  # Verwendung:
-  #   if $0 == __FILE__ 
-  #     require 'drumherum'
-  #     smart_init   
-  #   end
-  #   require 'mygemproject'  
-  #
+
+  # @!group Included in Object
+
   def smart_init(__file__ = nil)
     __file__ = caller[0] unless __file__
     dir_caller =File.dirname(__file__)
@@ -124,7 +160,7 @@ module SmartInit
   
 end # module
 
-
+# @private
 class Object
   include SmartInit
 end

data/lib/drumherum/unit_test.rb

@@ -1,11 +1,12 @@
 # ruby encoding: utf-8
 require 'test/unit'
 
+# You will see a status display for your tests if you use {UnitTest} instead of Test::Unit::TestCase: 
+#
+class UnitTest < Test::Unit::TestCase 
 
-class UnitTest < Test::Unit::TestCase # :nodoc:
-
-  # Meldet den aktuell durchlaufenden Test
-  def test0 #:nodoc:
+  # looks like a test, but just prints status information
+  def test0 
     name = self.class.to_s.gsub(/^.*::/, '')
     name.gsub!(/^Test/, '')
     name.gsub!(/^[0-9]+/, '')
@@ -28,6 +29,7 @@ end
 #
 if $0 == __FILE__ 
 
+# @private
 class Test030Blatest < UnitTest # :nodoc:
 
   def test_bla

data/version.rb

@@ -1,6 +1,6 @@
 
 module Drumherum  
   
-    VERSION = '0.1.17' 
+    VERSION = '0.1.18' 
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: drumherum
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
   prerelease: 
 platform: ruby
 authors: