super_stamper 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2011-10-02
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/super_stamper
+lib/super_stamper.rb
+lib/super_stamper/cli.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_super_stamper.rb
+test/test_super_stamper_cli.rb
+test/data/header1.txt
+test/data/header2.txt
+test/data/step1.txt
+test/data/step2.txt
+test/data/step3.txt

data/PostInstall.txt

@@ -0,0 +1,10 @@
+Just one more step until you're ready:
+
+Create a file called 'header.txt' and put it in the directory that contains your source files.
+Every line should be commented (e.g. prefixed with a hash '#')
+
+Then, change directory to your project and run super_stamper:
+
+ $ super_stamper
+
+Enjoy stamping your own files!

data/README.rdoc

@@ -0,0 +1,50 @@
+= super_stamper
+
+* http://github.com/cmdjohnson/super_stamper
+
+== DESCRIPTION:
+
+Easily add a header recursively to multiple files in your project directory.
+
+== FEATURES/PROBLEMS:
+
+Stamp your files!
+
+== SYNOPSIS:
+
+1. Create a file called 'header.txt' in your project dir
+2. Run 'super_stamper'
+3. Enjoy your freshly stamped files and impress yourself with a super-long 'git status' overview.
+
+== REQUIREMENTS:
+
+Ruby
+
+== INSTALL:
+
+ $ sudo gem install super_stamper
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Commander Johnson <commanderjohnson@gmail.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,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/super_stamper'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'super_stamper' do
+  self.developer 'Commander Johnson', 'commanderjohnson@gmail.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/super_stamper

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2011-10-2.
+#  Copyright (c) 2011. All rights reserved.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/super_stamper")
+require "super_stamper/cli"
+
+SuperStamper::CLI.execute(STDOUT, ARGV)

data/lib/super_stamper/cli.rb

@@ -0,0 +1,42 @@
+require 'optparse'
+
+module SuperStamper
+  class CLI
+    def self.execute(stdout, arguments=[])
+
+      options = {
+        :filename     => 'header.txt'
+      }
+      mandatory_options = %w(  )
+
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /,'')
+          Easily add a header recursively to multiple files in your project directory.
+
+          Usage: #{File.basename($0)} [options]
+
+          Options are:
+        BANNER
+        opts.separator ""
+        ########################################################################
+        opts.on("-f", "--filename PATH", String,
+          "Which file to use as header.",
+          "Default: header.txt") { |arg| options[:filename] = arg }
+        ########################################################################
+        opts.on("-h", "--help",
+          "Show this help message.") { stdout.puts opts; exit }
+        ########################################################################
+        opts.on("-v", "--version", "Print version (#{SuperStamper::VERSION})") { stdout.puts "#{SuperStamper::VERSION}"; exit }
+        opts.parse!(arguments)
+
+        if mandatory_options && mandatory_options.find { |option| options[option.to_sym].nil? }
+          stdout.puts opts; exit
+        end
+      end
+
+      filename = options[:filename]
+      
+      SuperStamper::Base.stamp_recursively( :header_file_name => filename )
+    end
+  end
+end

data/lib/super_stamper.rb

@@ -0,0 +1,73 @@
+# -*- encoding : utf-8 -*-
+
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module SuperStamper
+  # a version constant
+  VERSION = '0.0.1'
+  # a class
+  class Base
+    BEGIN_HEADER = "# -- begin header --"
+    END_HEADER = "# -- end header --"
+    DEFAULT_HEADER_FILE_NAME = "header.txt"
+    NEWLINE = "\n"
+  
+    def self.stamp_recursively(options = {})
+      extension = options[:extension] || "rb"
+    
+      count = 0
+    
+      Dir["**/*.#{extension}"].each do |f|
+        le_stamp_options = { :filename => f, :header_file_name => options[:header_file_name] }
+        stamp_single le_stamp_options
+        count += 1
+      end
+    
+      # Informative!
+      puts "super_stamper: I inserted a header into #{count} files with extension .#{extension} (recursively)."
+    
+      count
+    end
+
+    def self.stamp_single(options = {})
+      ret = nil
+    
+      file = nil
+      header = nil
+    
+      filename = options[:filename]
+      header_file_name = options[:header_file_name] || "header.txt"
+    
+      raise "I need a filename" if filename.nil?
+      raise "Please provide a valid filename (-f) or create a header.txt in your working directory." unless File.exists?(header_file_name)
+    
+      file = File.new(filename)
+      header = File.new(header_file_name).read
+    
+      unless file.nil? || header.nil?
+        str = file.read
+        # Let's remove the magic_encoding at the start, if any.
+        str.gsub!(/^# -\*-.+-\*-(\r)?#{NEWLINE}/, '')
+        # and now .. do this.
+        contents_array = [ BEGIN_HEADER, NEWLINE, header, NEWLINE, END_HEADER, NEWLINE ]
+        contents_str = contents_array.to_s
+        # Remove the header that was already in place, if any.
+        str.gsub!(/#{BEGIN_HEADER}.*#{END_HEADER}#{NEWLINE}/m, '')
+        # concat it
+        contents = contents_str + str
+        # Re-open file and write to it
+        file.close
+        file = File.new(filename, 'w')
+        # write
+        file.write(contents)
+        # close again
+        file.close
+        # Return it
+        ret = file
+      end
+    
+      ret
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/super_stamper.rb'}"
+puts "Loading super_stamper gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/data/header1.txt

@@ -0,0 +1,24 @@
+# This is my header.
+# 
+# I use it for copyright notices and whatnot.
+#
+#
+#
+#
+#
+# There are a lot of headers, but this one is mine.
+#
+#
+# here's some ascii art of the word gopher
+#                                                _                                            
+#                                               (_)                                           
+#       _  _  _  _     _  _  _     _  _  _  _   (_) _  _  _     _  _  _  _   _       _  _     
+#     _(_)(_)(_)(_) _ (_)(_)(_) _ (_)(_)(_)(_)_ (_)(_)(_)(_)_  (_)(_)(_)(_)_(_)_  _ (_)(_)    
+#    (_)        (_)(_)         (_)(_)        (_)(_)        (_)(_) _  _  _ (_) (_)(_)          
+#    (_)        (_)(_)         (_)(_)        (_)(_)        (_)(_)(_)(_)(_)(_) (_)             
+#    (_)_  _  _ (_)(_) _  _  _ (_)(_) _  _  _(_)(_)        (_)(_)_  _  _  _   (_)             
+#      (_)(_)(_)(_)   (_)(_)(_)   (_)(_)(_)(_)  (_)        (_)  (_)(_)(_)(_)  (_)             
+#       _  _  _ (_)               (_)                                                         
+#      (_)(_)(_)                  (_)                                                         
+#
+# Done.

data/test/data/header2.txt

@@ -0,0 +1,19 @@
+# Let's put gopher in a different font now.
+#                                                                   
+#                  :                                                
+#                 t#,                                  ,;           
+#          .Gt   ;##W.   t         .    .            f#i j.         
+#         j#W:  :#L:WE   ED.       Di   Dt         .E#t  EW,        
+#       ;K#f   .KG  ,#D  E#K:      E#i  E#i       i#W,   E##j       
+#     .G#D.    EE    ;#f E##W;     E#t  E#t      L#D.    E###D.     
+#    j#K;     f#.     t#iE#E##t    E#t  E#t    :K#Wfff;  E#jG#W;    
+#  ,K#f   ,GD;:#G     GK E#ti##f   E########f. i##WLLLLt E#t t##f   
+#   j#Wi   E#t ;#L   LW. E#t ;##D. E#j..K#j...  .E#L     E#t  :K#E: 
+#    .G#D: E#t  t#f f#:  E#ELLE##K:E#t  E#t       f#E:   E#KDDDD###i
+#      ,K#fK#t   f#D#;   E#L;;;;;;,E#t  E#t        ,WW;  E#f,t#Wi,,,
+#        j###t    G#t    E#t       f#t  f#t         .D#; E#t  ;#W:  
+#         .G#t     t     E#t        ii   ii           tt DWi   ,KK: 
+#           ;;                                                      
+#                                                                   
+#
+# Done.

data/test/data/step1.txt

@@ -0,0 +1,15 @@
+# -*- encoding : utf-8 -*-
+
+################################################################################
+# This is my source file. It has some comment lines already on the top.
+################################################################################
+# w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t 
+################################################################################
+
+class Foo
+    # header should appear above the line 'class foo'
+
+    def bar
+        "baz"
+    end
+end

data/test/data/step2.txt

@@ -0,0 +1,40 @@
+# -- begin header --
+# This is my header.
+# 
+# I use it for copyright notices and whatnot.
+#
+#
+#
+#
+#
+# There are a lot of headers, but this one is mine.
+#
+#
+# here's some ascii art of the word gopher
+#                                                _                                            
+#                                               (_)                                           
+#       _  _  _  _     _  _  _     _  _  _  _   (_) _  _  _     _  _  _  _   _       _  _     
+#     _(_)(_)(_)(_) _ (_)(_)(_) _ (_)(_)(_)(_)_ (_)(_)(_)(_)_  (_)(_)(_)(_)_(_)_  _ (_)(_)    
+#    (_)        (_)(_)         (_)(_)        (_)(_)        (_)(_) _  _  _ (_) (_)(_)          
+#    (_)        (_)(_)         (_)(_)        (_)(_)        (_)(_)(_)(_)(_)(_) (_)             
+#    (_)_  _  _ (_)(_) _  _  _ (_)(_) _  _  _(_)(_)        (_)(_)_  _  _  _   (_)             
+#      (_)(_)(_)(_)   (_)(_)(_)   (_)(_)(_)(_)  (_)        (_)  (_)(_)(_)(_)  (_)             
+#       _  _  _ (_)               (_)                                                         
+#      (_)(_)(_)                  (_)                                                         
+#
+# Done.
+# -- end header --
+
+################################################################################
+# This is my source file. It has some comment lines already on the top.
+################################################################################
+# w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t 
+################################################################################
+
+class Foo
+    # header should appear above the line 'class foo'
+
+    def bar
+        "baz"
+    end
+end

data/test/data/step3.txt

@@ -0,0 +1,35 @@
+# -- begin header --
+# Let's put gopher in a different font now.
+#                                                                   
+#                  :                                                
+#                 t#,                                  ,;           
+#          .Gt   ;##W.   t         .    .            f#i j.         
+#         j#W:  :#L:WE   ED.       Di   Dt         .E#t  EW,        
+#       ;K#f   .KG  ,#D  E#K:      E#i  E#i       i#W,   E##j       
+#     .G#D.    EE    ;#f E##W;     E#t  E#t      L#D.    E###D.     
+#    j#K;     f#.     t#iE#E##t    E#t  E#t    :K#Wfff;  E#jG#W;    
+#  ,K#f   ,GD;:#G     GK E#ti##f   E########f. i##WLLLLt E#t t##f   
+#   j#Wi   E#t ;#L   LW. E#t ;##D. E#j..K#j...  .E#L     E#t  :K#E: 
+#    .G#D: E#t  t#f f#:  E#ELLE##K:E#t  E#t       f#E:   E#KDDDD###i
+#      ,K#fK#t   f#D#;   E#L;;;;;;,E#t  E#t        ,WW;  E#f,t#Wi,,,
+#        j###t    G#t    E#t       f#t  f#t         .D#; E#t  ;#W:  
+#         .G#t     t     E#t        ii   ii           tt DWi   ,KK: 
+#           ;;                                                      
+#                                                                   
+#
+# Done.
+# -- end header --
+
+################################################################################
+# This is my source file. It has some comment lines already on the top.
+################################################################################
+# w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t w00t 
+################################################################################
+
+class Foo
+    # header should appear above the line 'class foo'
+
+    def bar
+        "baz"
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/super_stamper'

data/test/test_super_stamper.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 'fileutils'
+
+class SuperStamperTest < Test::Unit::TestCase
+  def setup
+    # My files
+    @filenames = [ "step1", "step2", "step3", "header1", "header2" ]
+    # Copy these files to temp dir
+    for file in @filenames
+      FileUtils.cp(get_data_filename(file), get_tmp_filename(file))
+    end
+  end
+  
+  def test_stamp_single
+    step2_str = get_tmp_file('step2').read
+    step3_str = get_tmp_file('step3').read
+    
+    SuperStamper::Base.stamp_single( :filename => get_tmp_filename('step1'), :header_file_name => get_tmp_filename('header1') )
+    assert_equal step2_str, get_tmp_file('step1').read
+    
+    SuperStamper::Base.stamp_single( :filename => get_tmp_filename('step2'), :header_file_name => get_tmp_filename('header2') )
+    assert_equal step3_str, get_tmp_file('step2').read
+  end
+  
+  protected
+  
+  def get_data_filename name
+    File.join("test", "data", "#{name}.txt")
+  end
+  
+  def get_tmp_file name
+    File.new(get_tmp_filename(name))
+  end
+  
+  def get_tmp_filename name
+    File.join("test", "tmp", "#{name}.txt")
+  end
+end
+

data/test/test_super_stamper_cli.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+require 'super_stamper/cli'
+
+class TestSuperStamperCli < Test::Unit::TestCase
+  def setup
+    SuperStamper::CLI.execute(@stdout_io = StringIO.new, [])
+    @stdout_io.rewind
+    @stdout = @stdout_io.read
+  end
+  
+#  def test_print_default_output
+#    assert_match(/To update this executable/, @stdout)
+#  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: super_stamper
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Commander Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id001
+description: Easily add a header recursively to multiple files in your project directory.
+email: 
+- commanderjohnson@gmail.com
+executables: 
+- super_stamper
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/super_stamper
+- lib/super_stamper.rb
+- lib/super_stamper/cli.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_super_stamper.rb
+- test/test_super_stamper_cli.rb
+- test/data/header1.txt
+- test/data/header2.txt
+- test/data/step1.txt
+- test/data/step2.txt
+- test/data/step3.txt
+- .gemtest
+homepage: http://github.com/cmdjohnson/super_stamper
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: super_stamper
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Easily add a header recursively to multiple files in your project directory.
+test_files: 
+- test/test_super_stamper.rb
+- test/test_helper.rb
+- test/test_super_stamper_cli.rb