mmcopyrights 1.1.0

data/README.rdoc

@@ -0,0 +1,33 @@
+== MM Copyrights
+
+Add copyrights to your source files.
+
+== Copyrights (I know this is a bit recursive)
+
+Copyright © 2009 Micah Martin.
+MM Copyrights and all included source files are distributed under terms of the GNU LGPL.
+
+== Install
+
+	gem sources -a http://gems.github.com
+	sudo gem install slagyr-mmcopyrights
+	
+== Example
+	
+	require 'mmcopyrights'
+	MM::Copyrights.process("lib", "rb", "#-", "©2009 Micah Martin\nAll rights reserved")
+	
+== Usage
+
+	MM::Copyrights.process(SOURCE_DIRECTORY, FILE_EXTENSION, COMMENT_PREFIX, COPYRIGHT_TEXT)
+	
+* SOURCE_DIRECTORY - A directory where you keep source files
+* FILE_EXTENSION - To identify which files to process.  A values of "rb" will process all files ending in ".rb".
+* COMMENT_PREFIX - Be sure to use a unique comment prefix like "#-" for Ruby and "//-" for C, Java, C#, etc.  This is used to identify existing copyright headers to remove or update them.
+* COPYRIGHT_TEXT - The content of your copyright message (without comment prefix)
+
+== Description
+
+Running MM::Copyrights.process will add the COPYRIGHT_TEXT to all of the matching files in the SOURCE_DIRECTORY.  Processing the files multiple times is harmless.  
+
+You can change the COPYRIGHT_TEXT and process files again.  The old copyright headers will be replaces with the new content. 

data/lib/mmcopyrights.rb

@@ -0,0 +1,87 @@
+#- Copyright © 2009 Micah Martin.
+#- MM Copyrights and all included source files are distributed under terms of the GNU LGPL.
+
+module MM
+  module Copyrights
+    
+    class <<self
+      attr_accessor :verbose
+    end
+    
+    self.verbose = true
+    
+    ENDL = $/
+
+    class SourceFile
+
+      attr_reader :copyright
+
+      def initialize(filename, comment_prefix)
+        @filename = filename
+        @comment_prefix = comment_prefix
+        @lines = IO.readlines(filename)
+        find_copyright
+      end
+
+      def has_copyright?
+        not @copyright.empty?
+      end
+
+      def find_copyright
+        @copyright = ''
+        @lines.each do |line|
+          break unless has_comment_prefix(line)
+          @copyright << line[@comment_prefix.length..-1]
+        end
+        @copyright.strip!
+      end
+
+      def has_comment_prefix(line)
+        line.match(@comment_prefix)
+      end
+
+      def remove_copyright
+        @lines.shift while has_comment_prefix(@lines[0])
+      end
+
+      def add_copyright(text)
+        copyright_header = text.split(/^/).inject([]) do |header,line|
+          header << "#@comment_prefix #{line}"
+        end
+        @lines.unshift ENDL unless @lines.first.strip.empty?
+        @lines = copyright_header + [ENDL] + @lines
+      end
+
+      def save!
+        File.open(@filename, "w"){ |f| f.print @lines }
+      end
+    end
+    
+    def self.process(dir, ext, prefix, copyright)
+      Dir.glob(File.join(dir, "**", "*.#{ext}")).each do |filename|
+        source_file = SourceFile.new(filename, prefix)
+        if source_file.has_copyright?
+          if source_file.copyright != copyright
+            say "updated copyright: #{filename}"
+            source_file.remove_copyright
+            source_file.add_copyright(copyright)
+            source_file.save!
+          else
+            say "already has valid copyright: #{filename}"
+          end
+        else
+          say "missing copyright: #{filename}"
+          source_file.add_copyright(copyright)
+          source_file.save!
+        end
+      end
+    end
+
+    private
+    
+    def self.say(thing)
+      puts thing if @verbose
+    end
+
+  end
+end

data/spec/mmcopyrights_spec.rb

@@ -0,0 +1,77 @@
+#- Copyright © 2009 Micah Martin.
+#- MM Copyrights and all included source files are distributed under terms of the GNU LGPL.
+
+require 'rubygems'
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/mmcopyrights")
+require 'fileutils'
+
+TEST_DATA = File.expand_path(File.dirname(__FILE__) + "/../test_data")
+SAMPLE = File.expand_path(File.dirname(__FILE__) + "/../sample")
+
+describe MM::Copyrights do
+
+  before(:each) do
+    MM::Copyrights.verbose = false
+    FileUtils.rm_rf(TEST_DATA) if File.exist?(TEST_DATA)
+    FileUtils.cp_r(SAMPLE, TEST_DATA)
+  end
+  
+  def check_file(file, headers)
+    lines = IO.readlines(File.join(TEST_DATA, file))
+    headers.each do |header|
+      lines.shift.strip.should == header
+    end
+    original_lines = IO.readlines(File.join(SAMPLE, file))
+    lines.should == original_lines
+  end
+  
+  it "should copyright all the ruby files" do
+    MM::Copyrights.process(TEST_DATA, "rb", "#-", "A simple copyright\nAll rights reserved")
+    
+    check_file("root.rb", ["#- A simple copyright", "#- All rights reserved", ""])
+    check_file("one/one.rb", ["#- A simple copyright", "#- All rights reserved", ""])
+    check_file("two/two.rb", ["#- A simple copyright", "#- All rights reserved", ""])
+    check_file("one/one_child/one_child.rb", ["#- A simple copyright", "#- All rights reserved", ""])
+    
+    check_file("root.java", [])
+    check_file("one/one.java", [])
+    check_file("two/two.java", [])
+    check_file("one/one_child/oneChild.java", [])
+  end
+  
+  it "should copyright all the java files" do
+    MM::Copyrights.process(TEST_DATA, "java", "//-", "A java copyright\nAll rights reserved")
+    
+    check_file("root.rb", [])
+    check_file("one/one.rb", [])
+    check_file("two/two.rb", [])
+    check_file("one/one_child/one_child.rb", [])
+    
+    check_file("root.java", ["//- A java copyright", "//- All rights reserved", ""])
+    check_file("one/one.java", ["//- A java copyright", "//- All rights reserved", ""])
+    check_file("two/two.java", ["//- A java copyright", "//- All rights reserved", ""])
+    check_file("one/one_child/oneChild.java", ["//- A java copyright", "//- All rights reserved", ""])
+  end
+  
+  it "should update existing copyrights" do
+    MM::Copyrights.process(TEST_DATA, "java", "//-", "Old copyright\nNo rights reserved")
+    MM::Copyrights.process(TEST_DATA, "java", "//-", "New copyright\nAll rights reserved")
+    
+    check_file("root.java", ["//- New copyright", "//- All rights reserved", ""])
+    check_file("one/one.java", ["//- New copyright", "//- All rights reserved", ""])
+    check_file("two/two.java", ["//- New copyright", "//- All rights reserved", ""])
+    check_file("one/one_child/oneChild.java", ["//- New copyright", "//- All rights reserved", ""])
+  end
+  
+  it "should not change valid copyright" do
+    MM::Copyrights.process(TEST_DATA, "rb", "#-", "A simple copyright\nAll rights reserved")
+    MM::Copyrights.process(TEST_DATA, "rb", "#-", "A simple copyright\nAll rights reserved")
+    
+    check_file("root.rb", ["#- A simple copyright", "#- All rights reserved", ""])
+    check_file("one/one.rb", ["#- A simple copyright", "#- All rights reserved", ""])
+    check_file("two/two.rb", ["#- A simple copyright", "#- All rights reserved", ""])
+    check_file("one/one_child/one_child.rb", ["#- A simple copyright", "#- All rights reserved", ""])
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: mmcopyrights
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Micah Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-06 00:49:53 -05:00
+default_executable: 
+dependencies: []
+
+description: Add copyright comments to all your source files
+email: micah@8thlight.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/mmcopyrights.rb
+- spec/mmcopyrights_spec.rb
+has_rdoc: true
+homepage: http://github.com/slagyr/mmcopyrights
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+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: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: MM Copyrights
+test_files: []
+