copyright-header 1.0.0

data/README.md

@@ -0,0 +1,69 @@
+CopyrightHeader
+===============
+
+
+Features
+------------
+
+* Add/remove a copyright headers recursively on source files
+* Customize the syntax configuration for how to write out comments
+* Built-in support for GPL3 and MIT licenses
+* Supports custom licenes with --license-file argument
+* ERB template support
+
+Caveats
+-------
+* Will only remove headers to files that have exactly the same header as the one we added
+* Will only add headers to files which do not contain the pattern /[Cc]opyright|[Lc]icense/ in the first N lines
+
+
+Requirements
+------------
+
+* Ruby 1.9.2 (supported version)
+
+Installation & Usage
+--------------------
+
+    # gem install copyright-header
+    # copyright-header --help
+
+Add a GPL3 License header to a file:
+
+    copyright-header --add-path /tmp/test.rb --license GPL3 --dry-run
+
+Remove the header created in the previous step (without --dry-run argument):
+
+    copyright-header --remove-path /tmp/test.rb --license GPL3 --dry-run
+
+Paths can be either files or directories. It will recursively traverse the directory tree ignoring all dot files.
+
+You can specify an alternative syntax configuration file using the --syntax argument.
+
+
+Full list of supported arguments:
+
+    Usage: copyright-header options [file]
+        -n, --dry-run                    Output the parsed files to STDOUT
+        -o, --output-dir DIR             Use DIR as output directory
+            --license-file FILE          Use FILE as header
+            --license [GPL3|MIT]         Use LICENSE as header
+            --copyright-software NAME    The common name for this piece of software (e.g. "Copyright Header")
+            --copyright-software-description DESC
+                                         The common name for this piece of software (e.g. "A utility to manipulate copyright headers on source code files")
+            --copyright-holder NAME      The common name for this piece of software (e.g. "Erik Osterman <e@osterman.com>"). Repeat argument for multiple names.
+            --copyright-year YEAR        The common name for this piece of software (e.g. "2012"). Repeat argument for multiple years.
+        -w, --word-wrap LEN              Maximum number of characters per line for license (default: 80)
+        -a, --add-path PATH              Recursively insert header in all files found in path
+        -r, --remove-path PATH           Recursively remove header in all files found in path
+        -c, --syntax FILE                Syntax configuration file
+        -V, --version                    Display version information
+        -h, --help                       Display this screen
+
+
+Contact Information
+-------------------
+
+Erik Osterman <e@osterman.com>
+http://www.osterman.com/
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/copyright-header

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path('.')) # Ruby 1.9 doesn't have . in the load path...
+$:.push(File.expand_path('lib/')) 
+
+require 'rubygems'
+require 'copyright_header'
+
+command_line = CopyrightHeader::CommandLine.new
+command_line.execute

data/contrib/syntax.yml

@@ -0,0 +1,61 @@
+ruby:
+  ext: ['.rb']
+  after: ['^#!']
+  comment:
+    open:   '#\n'
+    close:  '#\n'
+    prefix: '# '
+
+html:
+  ext: ['.html', '.htm', '.xhtml', '.xml']
+  comment:
+    open:   '<!--\n'
+    close:  '-->\n'
+    prefix: '    '
+
+php:
+  ext: ['.php']
+  after: [ '^#!' ]
+  comment:
+    open:   '<?php \n/*\n'
+    close:  ' */ ?>\n'
+    prefix: ' * '
+
+
+javacript:
+  ext: ['.js']
+  comment:
+    open:   '/*\n'
+    close:  ' */\n\n'
+    prefix: ' * '
+
+css:
+  ext: ['.css']
+  comment:
+    open:   '/*\n'
+    close:  ' */\n\n'
+    prefix: ' * '
+
+
+c:
+  ext: ['.java', '.c', '.cpp', '.cc']
+  comment:
+    open:   '/*'
+    close:  ' */\n\n'
+    prefix: ' * '
+
+cpp:
+  ext: ['.cpp', '.cc', '.hh', '.hpp']
+  comment:
+    open:   '//\n'
+    close:  '//\n\n'
+    prefix: '// '
+
+java:
+  ext: ['.java']
+  comment:
+    open:   '/*\n'
+    close:  ' */\n\n'
+    prefix: ' * '
+
+

data/copyright-header.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "copyright_header/version"
+
+Gem::Specification.new do |s|
+  s.name        = "copyright-header"
+  s.version     = CopyrightHeader::VERSION
+  s.authors     = ["Erik Osterman"]
+  s.email       = ["e@osterman.com"]
+  s.homepage    = "https://github.com/osterman/copyright-header"
+  s.summary     = %q{A utility to insert copyright headers into various types of source code files}
+  s.description = %q{A utility which is able to recursively insert and remove copyright headers from source code files based on file extensions.}
+  s.rubyforge_project = "copyright-header"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = ['README.md', 'LICENSE', 'AUTHORS', 'contrib/syntax.yml' ]
+  s.require_paths = ["lib"]
+end

data/lib/copyright_header.rb

@@ -0,0 +1,7 @@
+require 'copyright_header/version'
+require 'copyright_header/command_line'
+require 'copyright_header/parser'
+
+module CopyrightHeader
+end
+

data/lib/copyright_header/command_line.rb

@@ -0,0 +1,112 @@
+require 'optparse'
+
+module CopyrightHeader
+  class MissingArgumentException < Exception; end
+
+  class CommandLine
+    attr_accessor :options, :parser, :optparse
+    def initialize(options = {})
+      begin
+        @options = options
+        @options[:base_path] = File.expand_path File.dirname(__FILE__) + "/../../"
+        @optparse = OptionParser.new do |opts|
+          opts.banner = "Usage: #{$0} options [file]"
+          
+          @options[:dry_run] = false
+          opts.on( '-n', '--dry-run', 'Output the parsed files to STDOUT' ) do
+            @options[:dry_run] = true
+          end
+          
+          opts.on( '-o', '--output-dir DIR', 'Use DIR as output directory') do |dir|
+            @options[:output_dir] = dir + '/'
+          end
+          
+          opts.on( '--license-file FILE', 'Use FILE as header' ) do|file|
+            @options[:license_file] = file
+          end
+
+          opts.on( '--license [' + Dir.glob(@options[:base_path] + '/licenses/*').map { |f| File.basename(f, '.erb') }.join('|') + ']', 'Use LICENSE as header' ) do|license|
+            @options[:license] = license
+            @options[:license_file] = @options[:base_path] + '/licenses/' + license + '.erb'
+          end
+
+          opts.on( '--copyright-software NAME', 'The common name for this piece of software (e.g. "Copyright Header")' ) do|name|
+            @options[:copyright_software] = name
+          end
+
+          opts.on( '--copyright-software-description DESC', 'The common name for this piece of software (e.g. "A utility to manipulate copyright headers on source code files")' ) do|desc|
+            @options[:copyright_software_description] = desc
+          end
+
+          @options[:copyright_holders] = []
+          opts.on( '--copyright-holder NAME', 'The common name for this piece of software (e.g. "Erik Osterman <e@osterman.com>"). Repeat argument for multiple names.' ) do|name|
+            @options[:copyright_holders] << name
+          end
+
+          @options[:copyright_years] = []
+          opts.on( '--copyright-year YEAR', 'The common name for this piece of software (e.g. "2012"). Repeat argument for multiple years.' ) do|year|
+            @options[:copyright_years] << year
+          end
+
+          @options[:word_wrap] = 80
+          opts.on( '-w', '--word-wrap LEN', 'Maximum number of characters per line for license (default: 80)' ) do |len|
+            @options[:word_wrap] = len.to_i
+          end
+
+          opts.on( '-a', '--add-path PATH', 'Recursively insert header in all files found in path' ) do |path|
+            @options[:add_path] = path
+          end
+
+          opts.on( '-r', '--remove-path PATH', 'Recursively remove header in all files found in path' ) do |path|
+            @options[:remove_path] = path
+          end
+
+          @options[:syntax] = @options[:base_path] + '/contrib/syntax.yml'
+          opts.on( '-c', '--syntax FILE', 'Syntax configuration file' ) do |path|
+            @options[:syntax] = path
+          end
+
+          opts.on( '-V', '--version', 'Display version information' ) do
+            puts "CopyrightHeader #{CopyrightHeader::VERSION}"
+            puts "Copyright (C) 2012 Erik Osterman <e@osterman.com>"
+            puts "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>"
+            puts "This is free software: you are free to change and redistribute it."
+            puts "There is NO WARRANTY, to the extent permitted by law."
+            exit
+          end
+
+          opts.on( '-h', '--help', 'Display this screen' ) do
+            puts opts
+            exit
+          end
+        end
+
+        @optparse.parse!
+        unless @options.has_key?(:license_file)
+          raise MissingArgumentException.new("Missing --license or --license-file argument")
+        end
+
+        unless File.file?(@options[:license_file])
+          raise MissingArgumentException.new("Invalid --license or --license-file argument. Cannot open #{@options[:license_file]}")
+        end
+     
+        if @options[:license]
+          raise MissingArgumentException.new("Missing --copyright-software argument") if @options[:copyright_software].nil?
+          raise MissingArgumentException.new("Missing --copyright-software-description argument") if @options[:copyright_software_description].nil?
+          raise MissingArgumentException.new("Missing --copyright-holder argument") unless @options[:copyright_holders].length > 0
+          raise MissingArgumentException.new("Missing --copyright-year argument") unless @options[:copyright_years].length > 0
+        end
+      rescue MissingArgumentException => e
+        puts e.message
+        puts @optparse
+        exit (1)
+      end
+    end 
+
+    def execute
+      @parser = CopyrightHeader::Parser.new(@options)
+      @parser.execute
+    end
+  end
+end
+

data/lib/copyright_header/parser.rb

@@ -0,0 +1,227 @@
+require 'fileutils'
+require 'yaml'
+require 'erb'
+require 'ostruct'
+
+module CopyrightHeader
+  class FileNotFoundException < Exception; end
+
+  class License
+    @lines = []
+    def initialize(options)
+      @options = options
+      @lines = load_template.split(/(\n)/)
+    end
+
+    def word_wrap(text, max_width = nil)
+      max_width ||= @options[:word_wrap]
+      text.gsub(/(.{1,#{max_width}})(\s|\Z)/, "\\1\n")
+    end
+
+    def load_template
+      if File.exists?(@options[:license_file])
+        template = ::ERB.new File.new(@options[:license_file]).read, 0, '%<'
+        license = template.result(OpenStruct.new(@options).instance_eval { binding }) 
+        license += "\n" if license !~ /\n$/s
+        word_wrap(license)
+      else
+        raise FileNotFoundException.new("Unable to open #{file}")
+      end
+    end
+
+    def format(comment_open = nil, comment_close = nil, comment_prefix = nil)
+      comment_open ||= ''
+      comment_close ||= ''
+      comment_prefix ||= ''
+      license = comment_open + @lines.map { |line| comment_prefix + line }.join() + comment_close
+      license.gsub!(/\\n/, "\n")
+      license
+    end
+  end
+
+  class Header
+    @file = nil
+    @contents = nil
+    @config = nil
+
+    def initialize(file, config)
+      @file = file
+      @contents = File.read(@file)
+      @config = config
+    end
+
+    def format(license)
+      license.format(@config[:comment]['open'], @config[:comment]['close'], @config[:comment]['prefix'])
+    end
+
+    def add(license)
+      if has_copyright?
+        puts "SKIP #{@file}; detected exisiting license"
+        return nil
+      end
+
+      copyright = self.format(license)
+      if copyright.nil?
+        puts "Copyright is nil"
+        return nil
+      end
+
+      text = ""
+      if @config.has_key?(:after) && @config[:after].instance_of?(Array)
+        copyright_written = false
+        lines = @contents.split(/\n/)
+        head = lines.shift(10)
+        while(head.size > 0)
+          line = head.shift
+          text += line + "\n"
+          @config[:after].each do |regex|
+            pattern = Regexp.new(regex)
+            if pattern.match(line)
+              text += copyright
+              copyright_written = true
+              break
+            end
+          end
+        end
+        if copyright_written
+          text += lines.join("\n")
+        else
+          text = copyright + text + lines.join("\n")
+        end
+      else
+        # Simply prepend text
+        text = copyright + @contents
+      end
+      return text
+    end
+
+    def remove(license)
+      if has_copyright?
+        text = self.format(license)
+        @contents.gsub!(/#{Regexp.escape(text)}/, '')
+        @contents
+      else
+        puts "SKIP #{@file}; copyright not detected"
+        return nil
+      end
+    end
+
+    def has_copyright?(lines = 10)
+      @contents.split(/\n/)[0..lines].select { |line| line =~ /[Cc]opyright|[Ll]icense/ }.length > 0
+    end
+  end
+
+  class Syntax
+    def initialize(config)
+      @config = {}
+      syntax = YAML.load_file(config)
+      syntax.each_value do |format|
+        format['ext'].each do |ext|
+          @config[ext] = {
+            :before => format['before'],
+            :after => format['after'],
+            :comment => format['comment']
+          }
+        end
+      end
+    end
+
+    def ext(file)
+      File.extname(file)
+    end
+
+    def supported?(file)
+      @config.has_key? ext(file)
+    end
+
+    def header(file)
+      Header.new(file, @config[ext(file)])
+    end
+  end
+
+  class Parser
+    attr_accessor :options
+    @syntax = nil
+    @license = nil
+    def initialize(options = {})
+      @options = options
+    @exclude = [ /^LICENSE(|\.txt)$/i, /^holders(|\.txt)$/i, /^README/, /^\./]
+      @license = License.new(:license_file => @options[:license_file],
+                             :copyright_software => @options[:copyright_software],
+                             :copyright_software_description => @options[:copyright_software_description],
+                             :copyright_years => @options[:copyright_years],
+                             :copyright_holders => @options[:copyright_holders],
+                             :word_wrap => @options[:word_wrap])
+      @syntax = Syntax.new(@options[:syntax])
+    end
+
+    def execute
+      if @options.has_key?(:add_path)
+        add(@options[:add_path])
+      end
+
+      if @options.has_key?(:remove_path)
+        remove(@options[:remove_path])
+      end
+    end
+
+    def transform(method, path)
+      paths = []
+      if File.file?(path)
+        paths << path
+      else
+        paths << Dir.glob("#{path}/**/*")
+      end
+
+      puts paths.inspect
+
+      paths.flatten!
+
+      paths.each do |path|
+        if File.file?(path)
+          if @exclude.include? File.basename(path)
+            puts "SKIP #{path}; excluded"
+            next
+          end
+
+        if @syntax.supported?(path) 
+          header = @syntax.header(path)
+            contents = header.send(method, @license)
+            if contents.nil?
+              puts "SKIP #{path}; failed to generate license"
+            else
+              write(path, contents)
+            end
+          end
+        else
+          puts "SKIP #{path}; unsupported"
+        end
+      end
+    end
+
+    # Add copyright header recursively
+    def add(dir)
+      transform(:add, dir)
+    end
+
+    # Remove copyright header recursively
+    def remove(dir)
+      transform(:remove, dir)
+    end
+
+    def write(file, contents)
+      puts "UPDATE #{file}"
+      if @options[:dry_run] || @options[:output_dir].nil?
+        puts contents
+      else
+        dir = "#{@options[:output_dir]}/#{File.dirname(file)}"
+        FileUtils.mkpath dir unless File.directory?(dir)
+        output_path = @options[:output_dir] + file
+        f =File.new(output_path, 'w')
+        f.write(contents)
+        f.close
+      end
+    end
+  end
+end
+