copyright-header 1.0.5 → 1.0.7

data/README.md

@@ -35,24 +35,24 @@ Usage
 
 Full list of supported arguments:
 
-    Usage: copyright-header options [file]
+    Usage: bin/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
+            --license-file FILE          Use FILE as header (instead of using --license argument)
+            --license [AGPL3|BSD-2-CLAUSE|BSD-3-CLAUSE|BSD-4-CLAUSE|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
+        -a, --add-path PATH              Recursively insert header in all files found in path (allows multiple pathes separated by platform path-separator)
+        -r, --remove-path PATH           Recursively remove header in all files found in path (allows multiple pathes separated by platform path-separator)
         -c, --syntax FILE                Syntax configuration file
         -V, --version                    Display version information
         -h, --help                       Display this screen
 
-
 Examples
 --------
 
@@ -84,6 +84,30 @@ Paths can be either files or directories. It will recursively traverse the direc
 
 You can specify an alternative syntax configuration file using the `--syntax` argument.
 
+Rake
+----
+
+the above example as rake task inside a Rakefile:
+
+    task :headers do
+      require 'rubygems'
+      require 'copyright_header'
+
+      args = {
+        :license => 'GPL3',
+        :copyright_software => 'Copyright Header',
+        :copyright_software_description => "A utility to manipulate copyright headers on source code files",
+        :copyright_holders => ['Erik Osterman <e@osterman.com>'],
+        :copyright_years => ['2012'],
+        :add_path => 'lib',
+        :output_dir => '.'
+      }
+
+      command_line = CopyrightHeader::CommandLine.new( args )
+      command_line.execute
+    end
+
+
 Contributors
 ------------
 

data/lib/copyright_header/command_line.rb

@@ -21,17 +21,18 @@ require 'optparse'
 
 module CopyrightHeader
   class MissingArgumentException < Exception; end
+  class AmbiguousArgumentException < Exception; end
 
   class CommandLine
     attr_accessor :options, :parser, :optparse
     def initialize(options = {})
       begin
         @options = options
-        @options[:base_path] = File.expand_path File.dirname(__FILE__) + "/../../"
+        @options[:base_path] ||= File.expand_path File.dirname(__FILE__) + "/../../"
         @optparse = OptionParser.new do |opts|
           opts.banner = "Usage: #{$0} options [file]"
           
-          @options[:dry_run] = false
+          @options[:dry_run] ||= false
           opts.on( '-n', '--dry-run', 'Output the parsed files to STDOUT' ) do
             @options[:dry_run] = true
           end
@@ -40,13 +41,12 @@ module CopyrightHeader
             @options[:output_dir] = dir + '/'
           end
           
-          opts.on( '--license-file FILE', 'Use FILE as header' ) do|file|
+          opts.on( '--license-file FILE', 'Use FILE as header (instead of using --license argument)' ) 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|
@@ -57,30 +57,30 @@ module CopyrightHeader
             @options[:copyright_software_description] = desc
           end
 
-          @options[:copyright_holders] = []
+          @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] = []
+          @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
+          @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|
+          opts.on( '-a', '--add-path PATH', 'Recursively insert header in all files found in path (allows multiple pathes separated by platform path-separator)' ) do |path|
             @options[:add_path] = path
           end
 
-          opts.on( '-r', '--remove-path PATH', 'Recursively remove header in all files found in path' ) do |path|
+          opts.on( '-r', '--remove-path PATH', 'Recursively remove header in all files found in path (allows multiple pathes separated by platform path-separator)' ) do |path|
             @options[:remove_path] = path
           end
 
-          @options[:syntax] = @options[:base_path] + '/contrib/syntax.yml'
+          @options[:syntax] ||= @options[:base_path] + '/contrib/syntax.yml'
           opts.on( '-c', '--syntax FILE', 'Syntax configuration file' ) do |path|
             @options[:syntax] = path
           end
@@ -101,6 +101,15 @@ module CopyrightHeader
         end
 
         @optparse.parse!
+
+        unless @options[:license].nil?
+          unless @options[:license_file].nil?
+            raise AmbiguousArgumentException.new("Cannot pass both --license and --license-file arguments")
+          end
+          # get the license_file from the shiped files
+          @options[:license_file] ||= @options[:base_path] + '/licenses/' + @options[:license] + '.erb'
+        end
+
         unless @options.has_key?(:license_file)
           raise MissingArgumentException.new("Missing --license or --license-file argument")
         end

data/lib/copyright_header/parser.rb

@@ -176,11 +176,11 @@ module CopyrightHeader
 
     def execute
       if @options.has_key?(:add_path)
-        add(@options[:add_path])
+        @options[:add_path].split(File::PATH_SEPARATOR).each { |path| add(path) }
       end
 
       if @options.has_key?(:remove_path)
-        remove(@options[:remove_path])
+        @options[:add_path].split(File::PATH_SEPARATOR).each { |path| remove(path) }
       end
     end
 

data/lib/copyright_header/version.rb

@@ -18,5 +18,5 @@
 # along with Copyright Header.  If not, see <http://www.gnu.org/licenses/>.
 #
 module CopyrightHeader
-  VERSION = "1.0.5"
+  VERSION = "1.0.7"
 end

data/licenses/AGPL3.erb

@@ -0,0 +1,17 @@
+<%=copyright_software%> - <%=copyright_software_description%>
+Copyright (C) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%>
+
+This file is part of <%=copyright_software%>.
+
+<%=copyright_software%> is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+<%=copyright_software%> is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with <%=copyright_software%>.  If not, see <http://www.gnu.org/licenses/>.

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: copyright-header
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 1
   - 0
-  - 5
-  version: 1.0.5
+  - 7
+  version: 1.0.7
 platform: ruby
 authors: 
 - Erik Osterman
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-16 00:00:00 -07:00
+date: 2012-12-04 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -45,6 +44,7 @@ files:
 - lib/copyright_header/command_line.rb
 - lib/copyright_header/parser.rb
 - lib/copyright_header/version.rb
+- licenses/AGPL3.erb
 - licenses/BSD-2-CLAUSE.erb
 - licenses/BSD-3-CLAUSE.erb
 - licenses/BSD-4-CLAUSE.erb
@@ -60,27 +60,23 @@ rdoc_options: []
 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: copyright-header
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A utility to insert copyright headers into various types of source code files