source-tools 0.6.0

data/.gitignore

@@ -0,0 +1,6 @@
+tmp
+pkg
+doc
+ann-*
+
+*.rbc

data/CHANGES

@@ -0,0 +1,10 @@
+= source-tools changes history
+
+== source-tools 0.6 / 2009-11-21
+
+* first rubyforge and gemcutter release
+
+== source-tools 0.5 / 2008-12-12
+
+* 1 major enhancement
+  * Birthday!

data/README

@@ -0,0 +1,54 @@
+= source-tools 0.6
+by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
+  godfat (XD) godfat.org
+
+== LINKS:
+
+* github-project[http://github.com/godfat/source-tools]
+* rubyforge-project[http://rubyforge.org/projects/ludy]
+
+== DESCRIPTION:
+
+ source code tools collection
+
+== FEATURES:
+
+$ source-tools
+source-tools st:chmod                  # fix files(644) and directories(755) permission recursively.
+source-tools st:html_wrap[glob]        # Wrap html with comments at the beginning and the end of file (for tracking partial template on generated html)
+source-tools st:strip[spaces]          # Strip trailing whitespace from source files, also normalize tabs to spaces, and an newline at end of file
+source-tools st:t:.bashrc              # create a common .bashrc file
+source-tools st:t:.gemrc[project]      # create a user gem only .gemrc file
+source-tools st:t:.gitconfig[project]  # create a common .gitconfig file
+source-tools st:t:.gitignore           # create a common .gitignore file
+source-tools st:t:.vimrc               # create a common .vimrc file
+source-tools st:t:Rakefile[project]    # create a Rakefile template for bones.
+source-tools st:t:config.fish          # create a common config.fish file
+source-tools st:t:mime.types           # create a common mime.types file
+source-tools st:t:nginx.conf[project]  # create an nginx config file
+
+== SYNOPSIS:
+
+== REQUIREMENTS:
+
+== INSTALL:
+
+* gem install source-tools
+
+== LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2008-2009, Lin Jen-Shin (a.k.a. godfat 真常)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+SUDO = '' # this prevent `rake gem:install` to use sudo
+
+gem 'bones', '<3.0'
+require 'bones'
+Bones.setup
+
+PROJ.name = 'source-tools'
+PROJ.authors = 'Lin Jen-Shin (a.k.a. godfat 真常)'
+PROJ.email = 'godfat (XD) godfat.org'
+PROJ.url = 'http://github.com/godfat/source-tools'
+PROJ.rubyforge.name = 'ludy'
+
+# begin workaround
+# PROJ.include << 'lib/.+'
+PROJ.gem.files = manifest << 'lib/source-tools/templates/t.git/hooks/post-receive.erb'
+# end   workaround
+
+# PROJ.gem.dependencies << ['source-tools', '>=0.5.0']
+# PROJ.gem.development_dependencies << ['minitest', '>=1.3.0']
+PROJ.gem.executables = ["bin/#{PROJ.name}"]
+
+# PROJ.ruby_opts.delete '-w'
+
+PROJ.description = PROJ.summary = paragraphs_of('README', 'description').join("\n\n")
+PROJ.changes = paragraphs_of('CHANGES', 0..1).join("\n\n")
+PROJ.version = File.read("lib/#{PROJ.name}/version.rb").gsub(/.*VERSION = '(.*)'.*/m, '\1')
+
+PROJ.exclude += ['^tmp', 'tmp$', '^pkg', '^\.gitignore$',
+                 '^ann-', '\.sqlite3$', '\.db$']
+
+PROJ.rdoc.remote_dir = PROJ.name
+
+PROJ.readme_file = 'README'
+PROJ.rdoc.main = 'README'
+PROJ.rdoc.exclude += ['Rakefile', '^tasks', '^test']
+PROJ.rdoc.include << '\w+'
+# PROJ.rdoc.opts << '--diagram' if !Rake::Win32 and `which dot` =~ %r/\/dot/
+PROJ.rdoc.opts += ['--charset=utf-8', '--inline-source',
+                   '--line-numbers', '--promiscuous']
+
+PROJ.spec.opts << '--color'
+
+PROJ.ann.file = "ann-#{PROJ.name}-#{PROJ.version}"
+PROJ.ann.paragraphs.concat %w[LINKS SYNOPSIS REQUIREMENTS INSTALL LICENSE]
+
+CLEAN.include Dir['**/*.rbc']
+
+task :default do
+  Rake.application.options.show_task_pattern = /./
+  Rake.application.display_tasks_and_comments
+end

data/TODO

@@ -0,0 +1,4 @@
+= source-tools todo list
+
+* adding --verbose option.
+* adding task that generate all template.

data/bin/source-tools

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'source-tools/bin'

data/lib/source-tools.rb

@@ -0,0 +1,112 @@
+
+module SourceTools
+  module_function
+
+  def strip file, spaces = '  '
+    strip_utf8_bom(
+      file.map{ |line| line.gsub("\t", spaces).rstrip }.join("\n") + "\n"
+    )
+  end
+
+  def strip_utf8_bom str
+    str[0..2] == "\xEF\xBB\xBF" ? str[3..-1] : str
+  end
+
+  def generate path, args = [], task_args = nil, &block
+    require 'fileutils'
+
+    args.each{ |arg|
+      if task_args[arg].nil?
+        puts 'please fill your arguments like:'
+        puts "  > source-tools st:t:#{File.basename(path)}[#{args.join(',').upcase}]"
+        exit(1)
+      end
+    }
+
+    if File.exist?(path)
+      puts "#{path} exists."
+      exit(1)
+    end
+
+    FileUtils.mkdir_p(File.dirname(path))
+    content = ''
+    File.open(path, 'w'){ |file|
+      require 'erb'
+      args = task_args.to_hash
+      block.call(args) if block_given?
+
+      directory = "#{File.dirname(__FILE__)}/source-tools/templates/"
+      template  = "t#{path}.erb"
+
+      content = File.read(directory + template)
+      file << ERB.new(content).result(binding)
+    }
+    if content =~ /\A#!/
+      puts "chmod #{path} to 755"
+      File.chmod(0755, path)
+    end
+
+    puts "#{path} generated."
+  end
+
+  def task_template path, *args, &block
+    task(*args.dup.unshift(File.basename(path))) do |t, task_args|
+      SourceTools.generate(path, args, task_args, &block)
+    end
+  end
+
+  def each_source_path
+    require 'pathname'
+
+    Pathname.getwd.find{ |path|
+      # skip unreadable, unwritable, .git and .svn directories
+      skip_dir = path.directory? && (!path.readable? || !path.writable?)
+      Find.prune if skip_dir || %w[.git .svn].include?(path.basename.to_s)
+
+      # skip non-files, zero-sized files, files not matching specific names, or files without the matching extensions
+      match = files.include?(path.basename.to_s) || extensions.include?(path.extname[1..-1])
+      next unless path.file? && path.size? && match && path.readable? && path.writable?
+
+      yield(path)
+    }
+
+  end
+
+  def files
+    # files and extensions to process
+    %w[ CHANGELOG HISTORY MIT-LICENSE LICENSE README README_FOR_APP
+        RUNNING_UNIT_TESTS TODO USAGE INSTALL NOTICE .autotest .gitignore
+        Makefile Rakefile capfile ]
+  end
+
+  def extensions
+    source_codes = %w[ rb ru rake sake php pl py js sh c cpp cxx h hpp hs ml java cs d y as ]
+    templates = %w[ haml builder erb eruby rxml rhtml rjs ratom rcsv ]
+    markup = %w[ css htm html xml rdf yml yaml ]
+    others = %w[ cgi fcgi conf deploy example htc key opts rpdf sql txt vcf log ]
+
+    (source_codes + templates + markup + others)
+  end
+
+  def glob glob_str
+    if glob_str.nil?
+      puts 'Please provide a glob to indicate which files you want to append the comment'
+      exit(1)
+    end
+
+    require 'pathname'
+    Pathname.glob(glob_str).each{ |path|
+      next unless path.writable? && !path.directory?
+      yield(path)
+    }
+  end
+
+  def wrap_source path, content, args = {}
+    path.open('w'){ |f|
+      f.puts(args[:header]) if args[:header]
+      f.print(content)
+      f.puts(args[:footer]) if args[:footer]
+    }
+  end
+
+end

data/lib/source-tools/bin.rb

@@ -0,0 +1,7 @@
+
+require 'rake'
+require 'source-tools/tasks'
+require 'source-tools/default'
+
+Rake.application.init('source-tools')
+Rake.application.top_level

data/lib/source-tools/default.rb

@@ -0,0 +1,5 @@
+
+task :default do
+  Rake.application.options.show_task_pattern = /./
+  Rake.application.display_tasks_and_comments
+end

data/lib/source-tools/tasks.rb

@@ -0,0 +1,4 @@
+
+%w[strip template chmod html_wrap ruby_magic_encoding].each{ |task|
+  require "source-tools/tasks/#{task}"
+}

data/lib/source-tools/tasks/chmod.rb

@@ -0,0 +1,19 @@
+
+namespace :st do
+  desc 'fix files(644) and directories(755) permission recursively.'
+  task :chmod do
+    require 'pathname'
+    Pathname.glob("**/*").each{ |path|
+      next unless path.writable?
+
+      if path.directory?
+        path.chmod(0755)
+
+      else
+        path.chmod(0644)
+
+      end
+    }
+
+  end
+end

data/lib/source-tools/tasks/html_wrap.rb

@@ -0,0 +1,15 @@
+
+namespace :st do
+  desc 'Wrap html with comments at the beginning and the end of file (for tracking partial template on generated html)'
+  task :html_wrap, :glob do |t, args|
+    SourceTools.glob(args[:glob]){ |path|
+      content = path.read
+      next if content =~ /\A<!-- begin/
+
+      puts "Processing #{path}"
+      SourceTools.wrap_source( path, content,
+        :header => "<!-- begin #{path} -->",
+        :footer => "<!--   end #{path} -->")
+    }
+  end
+end

data/lib/source-tools/tasks/ruby_magic_encoding.rb

@@ -0,0 +1,17 @@
+
+namespace :st do
+  desc 'Add magic comment for source encoding for ruby 1.9'
+  task :ruby_magic_encoding, :glob, :encoding do |t, args|
+    encoding = args[:encoding] || 'utf-8'
+
+    SourceTools.glob(args[:glob]){ |path|
+      header = path.readlines.first
+      next if header =~ /\A# ?encoding:/
+      content = path.read
+
+      puts "Processing #{path}"
+      SourceTools.wrap_source( path, content,
+        :header => "# encoding: #{encoding}")
+    }
+  end
+end

data/lib/source-tools/tasks/strip.rb

@@ -0,0 +1,31 @@
+
+# forked from http://github.com/dkubb/dm-dev
+
+namespace :st do
+  desc 'Strip trailing whitespace from source files, also normalize tabs to spaces, and an newline at end of file'
+  task :strip, :spaces, :glob do |t, args|
+    require 'source-tools'
+    require 'zlib'
+
+    spaces = ' ' * (args[:spaces] || 2).to_i
+
+    kind = if args[:glob]
+             [:glob, args[:glob]]
+           else
+             [:each_source_path]
+           end
+
+    SourceTools.send(*kind){ |path|
+      # strat striping unnecessary whitespaces
+      result = path.open('r:binary'){ |f| SourceTools.strip(f, spaces) }
+
+      # skip the file if it was not modified
+      next if Zlib.crc32(result) == Zlib.crc32(path.read)
+
+      puts "Stripping #{args[:glob] ? path
+                                    : path.relative_path_from(Pathname.new(Dir.pwd))}"
+      path.open('w'){ |f| f.write result }
+    }
+
+  end
+end

data/lib/source-tools/tasks/template.rb

@@ -0,0 +1,29 @@
+
+require 'source-tools'
+
+namespace :st do
+  namespace :t do
+    desc 'create a Rakefile template for bones.'
+    SourceTools.task_template('Rakefile', :project){ |args|
+      args[:author] = `whoami`.chop
+    }
+
+    desc 'create a common .gitconfig file'
+    SourceTools.task_template('.gitconfig', :project)
+
+    desc 'create a user gem only .gemrc file'
+    SourceTools.task_template('.gemrc', :project)
+
+    desc 'create an nginx config file'
+    SourceTools.task_template('config/nginx.conf', :project)
+
+    %w[ .gitignore .vimrc .bashrc .config/fish/config.fish
+        config/mime.types .git/hooks/post-receive .screenrc
+      ].each{ |path|
+
+      desc "create a common #{File.basename(path)} file"
+      SourceTools.task_template(path)
+    }
+
+  end
+end

data/lib/source-tools/templates/t.bashrc.erb

@@ -0,0 +1,5 @@
+#export GEM_HOME=$HOME/.gem/ruby/1.8
+#export GEM_PATH=$GEM_HOME
+export LC_ALL=en_US.utf-8
+export LANG=en_US.utf-8
+umask g+w

data/lib/source-tools/templates/t.config/fish/config.fish.erb

@@ -0,0 +1,6 @@
+set GEM_HOME $HOME/.gem/ruby/1.8
+set GEM_PATH $GEM_HOME
+set PATH $PATH:$HOME/.gem/ruby/1.8/bin
+set LC_ALL en_US.utf-8
+set LANG en_US.utf-8
+umask g+w

data/lib/source-tools/templates/t.gemrc.erb

@@ -0,0 +1,4 @@
+#gemhome: /home/<%= args[:project] %>/.gem/ruby/1.8
+#gempath: - /home/<%= args[:project] %>/.gem/ruby/1.8
+#         - /home/<%= args[:project] %>/.gem/ruby/1.9.1
+gem: --no-rdoc --no-ri --user-install --format-executable

data/lib/source-tools/templates/t.git/hooks/post-receive.erb

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# /home/user/.git => user
+# /home/user/.git => /home/user
+
+chgrp --silent `pwd | ruby -e 'puts gets.scan(/\w+/)[1]'` -R \
+               `pwd | ruby -e 'puts gets.scan(/\/\w+/).join'`

data/lib/source-tools/templates/t.gitconfig.erb

@@ -0,0 +1,14 @@
+[color]
+  branch = auto
+  diff = auto
+  interactive = auto
+  status = auto
+  ui = auto
+[diff]
+  renames = copy
+[user]
+  name = <%= args[:project] %>
+[push]
+  default = tracking
+[merge]
+  log = true

data/lib/source-tools/templates/t.gitignore.erb

@@ -0,0 +1,15 @@
+tmp
+pkg
+doc
+ann-*
+
+*.rbc
+*.log
+*.sqlite3
+*.gz
+
+.bash_history
+.bash_logout
+.bash_profile
+.gem
+.viminfo