copyright-header 1.0.11 → 1.0.12

data/README.md

@@ -16,6 +16,7 @@ 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 case-sensitive pattern `/[Cc]opyright|[Lc]icense/` in the first `N` lines
+* Will not properly format arguments that contain new-line ("`\n`") characters.
 
 Requirements
 ------------
@@ -35,17 +36,17 @@ Usage
 
 Full list of supported arguments:
 
-    Usage: bin/copyright-header options [file]
+    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 (instead of using --license argument)
-            --license [AGPL3|BSD-2-CLAUSE|BSD-3-CLAUSE|BSD-4-CLAUSE|GPL3|MIT]
+            --license [AGPL3|ASL2|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.
+                                         The detailed description for this piece of software (e.g. "A utility to manipulate copyright headers on source code files")
+            --copyright-holder NAME      The legal owner of the copyright for the software. (e.g. "Erik Osterman <e@osterman.com>"). Repeat argument for multiple names.
+            --copyright-year YEAR        The years for which the copyright exists (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 (allows multiple paths separated by platform path-separator ":")
         -r, --remove-path PATH           Recursively remove header in all files found in path (allows multiple paths separated by platform path-separator ":")
@@ -54,7 +55,6 @@ Full list of supported arguments:
         -V, --version                    Display version information
         -h, --help                       Display this screen
 
-
 Examples
 --------
 
@@ -64,11 +64,25 @@ Discover available parameters by passing the `--help` argument
 
 Add a GPL3 License header to a file:
 
-    copyright-header --add-path /tmp/test.rb --license GPL3 --dry-run
+    copyright-header --add-path /tmp/test.rb \
+                     --license GPL3 \
+                     --copyright-holder 'Joe Shmoe' \
+                     --copyright-software 'Example Software' \
+                     --copyright-software-description "This is the description of the software." \
+                     --copyright-year 2012 \
+                     --output-dir /tmp \
+                     --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
+    copyright-header --remove-path /tmp/test.rb \
+                     --license GPL3 \
+                     --copyright-holder 'Joe Shmoe' \
+                     --copyright-software 'Example Software' \
+                     --copyright-software-description 'This is the description of the software.' \
+                     --copyright-year 2012 \
+                     --output-dir /tmp \
+                     --dry-run 
 
 Command used to generate copyright headers for this script:
 

data/contrib/syntax.yml

@@ -1,5 +1,5 @@
 ruby:
-  ext: ['.rb']
+  ext: ['.rb', '.rake']
   after: ['^#!', '^#.*encoding:']
   comment:
     open:   '#\n'
@@ -14,7 +14,6 @@ perl:
     close:  '#\n'
     prefix: '# '
 
-
 # Support PEP 0263 comments:
 # coding=<encoding name>
 # -*- coding: <encoding name> -*-
@@ -42,7 +41,6 @@ php:
     close:  ' */ ?>\n'
     prefix: ' * '
 
-
 javacript:
   ext: ['.js']
   comment:
@@ -57,7 +55,6 @@ css:
     close:  ' */\n\n'
     prefix: ' * '
 
-
 c:
   ext: ['.c', '.h']
   comment:
@@ -80,7 +77,7 @@ java:
     prefix: ' * '
 
 haml:
-  ext: ['.haml']
+  ext: ['.haml', '.hamlc']
   comment:
     open:   '-#\n'
     close:  '-#\n'
@@ -122,9 +119,24 @@ sql:
 # preprocessing directive, if present.
 # FIXME: only supports single line directives
 xml:
-  ext: ['.xml', '.xsd']
+  ext: ['.xml', '.xsd', '.mxml']
   after: ['^<\?']
   comment:
     open:   '<!--\n'
     close:  '-->\n'
     prefix: '    '
+
+yaml:
+  ext:  ['.yml', '.yaml']
+  comment:
+    open:   '#\n'
+    close:  '#\n'
+    prefix: '# '
+ 
+action_script:
+  ext: ['.as']
+  comment:
+    open:   '//\n'
+    close:  '//\n\n'
+    prefix: '// '
+  

data/lib/copyright_header/command_line.rb

@@ -38,7 +38,7 @@ module CopyrightHeader
           end
           
           opts.on( '-o', '--output-dir DIR', 'Use DIR as output directory') do |dir|
-            @options[:output_dir] = dir + '/'
+            @options[:output_dir] = dir.gsub(/\/+$/, '')
           end
           
           opts.on( '--license-file FILE', 'Use FILE as header (instead of using --license argument)' ) do|file|
@@ -53,17 +53,17 @@ module CopyrightHeader
             @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|
+          opts.on( '--copyright-software-description DESC', 'The detailed description 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|
+          opts.on( '--copyright-holder NAME', 'The legal owner of the copyright for the 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|
+          opts.on( '--copyright-year YEAR', 'The years for which the copyright exists (e.g. "2012"). Repeat argument for multiple years.' ) do|year|
             @options[:copyright_years] << year
           end
 
@@ -91,11 +91,11 @@ module CopyrightHeader
           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."
+            STDERR.puts "CopyrightHeader #{CopyrightHeader::VERSION}",
+                        "Copyright (C) 2012 Erik Osterman <e@osterman.com>",
+                        "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>",
+                        "This is free software: you are free to change and redistribute it.", 
+                        "There is NO WARRANTY, to the extent permitted by law."
             exit
           end
 
@@ -130,13 +130,13 @@ module CopyrightHeader
           raise MissingArgumentException.new("Missing --copyright-year argument") unless @options[:copyright_years].length > 0
         end
       rescue MissingArgumentException => e
-        puts e.message
-        puts @optparse
+        STDERR.puts e.message, @optparse
         exit (1)
       end
     end 
 
     def execute
+      STDERR.puts "-- DRY RUN --" if @options[:dry_run]
       @parser = CopyrightHeader::Parser.new(@options)
       @parser.execute
     end

data/lib/copyright_header/parser.rb

@@ -82,7 +82,7 @@ module CopyrightHeader
 
       copyright = self.format(license)
       if copyright.nil?
-        puts "Copyright is nil"
+        STDERR.puts "Copyright is nil"
         return nil
       end
 
@@ -121,7 +121,7 @@ module CopyrightHeader
         @contents.gsub!(/#{Regexp.escape(text)}/, '')
         @contents
       else
-        puts "SKIP #{@file}; copyright not detected"
+        STDERR.puts "SKIP #{@file}; copyright not detected"
         return nil
       end
     end
@@ -206,11 +206,11 @@ module CopyrightHeader
         begin
           if File.file?(path)
             if @exclude.include? File.basename(path)
-              puts "SKIP #{path}; excluded"
+              STDERR.puts "SKIP #{path}; excluded"
               next
             end
           else
-            puts "SKIP #{path}; not file"
+            STDERR.puts "SKIP #{path}; not file"
             next
           end
 
@@ -218,15 +218,15 @@ module CopyrightHeader
             header = @syntax.header(path)
             contents = header.send(method, @license)
             if contents.nil?
-              puts "SKIP #{path}; failed to generate license"
+              STDERR.puts "SKIP #{path}; failed to generate license"
             else
               write(path, contents)
             end
           else
-            puts "SKIP #{path}; unsupported"
+            STDERR.puts "SKIP #{path}; unsupported"
           end
         rescue Exception => e
-          puts "SKIP #{path}; #{e.message}"
+          STDERR.puts "SKIP #{path}; #{e.message}"
         end
       end
     end
@@ -242,11 +242,15 @@ module CopyrightHeader
     end
 
     def write(file, contents)
-      puts "UPDATE #{file}"
-      if @options[:dry_run] || @options[:output_dir].nil?
-        puts contents
+      if @options[:dry_run] 
+        STDERR.puts "UPDATE #{file} [dry-run]"
+        STDERR.puts contents
+      elsif @options[:output_dir].nil?
+        STDERR.puts "UPDATE #{file} [no output-dir]"
+        STDERR.puts contents
       else
-        dir = "#{@options[:output_dir]}/#{File.dirname(file)}"
+        dir = "#{@options[:output_dir]}/#{File.dirname(file).gsub(/^\/+/, '')}"
+        STDERR.puts "UPDATE #{file} [output-dir #{dir}]"
         FileUtils.mkpath dir unless File.directory?(dir)
         output_path = @options[:output_dir] + file
         f =File.new(output_path, 'w')

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.11"
+  VERSION = "1.0.12"
 end

metadata

@@ -1,45 +1,49 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: copyright-header
-version: !ruby/object:Gem::Version
-  version: 1.0.11
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 12
+  version: 1.0.12
 platform: ruby
-authors:
+authors: 
 - Erik Osterman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-11-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: github-linguist
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.6.7
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 7
         version: 2.6.7
-description: A utility which is able to recursively insert and remove copyright headers
-  from source code files based on file extensions.
-email:
+  type: :runtime
+  version_requirements: *id001
+description: A utility which is able to recursively insert and remove copyright headers from source code files based on file extensions.
+email: 
 - e@osterman.com
-executables:
+executables: 
 - copyright-header
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.md
 - LICENSE
 - AUTHORS
 - contrib/syntax.yml
-files:
+files: 
 - .gitignore
 - AUTHORS
 - Gemfile
@@ -60,29 +64,35 @@ files:
 - licenses/BSD-4-CLAUSE.erb
 - licenses/GPL3.erb
 - licenses/MIT.erb
+has_rdoc: true
 homepage: https://github.com/osterman/copyright-header
-licenses:
+licenses: 
 - GPL-3
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: copyright-header
-rubygems_version: 1.8.23
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A utility to insert copyright headers into various types of source code files
 test_files: []
+