katana_stamp 0.1.1 → 1.0.0

data/Guardfile

@@ -2,6 +2,6 @@
 # More info at https://github.com/guard/guard#readme
 
 guard 'rspec', :version => 2 do
-  watch(%r{^lib/*\.rb$})  
+  watch(%r{^lib/**/*\.rb$})   { 'spec/katana_stamp_spec.rb' }
   watch(%r{^spec/.+_spec\.rb$})
 end

data/README.md

@@ -1,55 +1,2 @@
-# Katana Code's Copyright Stamper
-
-This gem is used internally by Katana Code. Feel free to fork it and modify for your 
-own organisation.
-
-## Usage: 
-
-    $ katana_stamp
-
-adds **(c) Copyright 2012 Katana Code Ltd. All Rights Reserved.** to the end of every Ruby file under app/ and lib/.
-
-See options below for configuration
-
-## Options
-
-###  --include-dirs (-i)
-
-Include these dir patterns in stamp list
-e.g.    
-     $ katana_stamp -i vendor/**/*.rb # will also stamp files matching vendor/**/*.rb
-     
-### --exclude-dirs (-x)
-
-Don't include these dir patterns in stamp list
-e.g.
-   
-   $ katana_stamp -x app/controllers/application_controller.rb # will not stamp files matching app/controllers/application_controller.rb
-
-### --year (-y)
-
-Change the year of the Copyright
-e.g.
-
-    $ katana_stamp -y 1999
-
- 
-### --owner (-o)
-
-Change the owner of the Copyright
-e.g.
-
-    $ katana_stamp -o "Ace Rimmer!"
-
- 
-### --message (-m)
-
-Overwrite the entire message for the stamp.
-e.g.
-    
-    $ katana_stamp -m "Released under the MIT license"
-    
-## Known Issues
-
-At the moment there's no way to reverse this... make sure you commit any changes before you
-run this!
+Files in this directory are used to replace those that are stamped in specs so we start
+each test with fresh, unstamped files.

data/bin/katana_stamp

@@ -11,6 +11,11 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = "Katana Stamp Usage:"
 
+  # TODO: Consider this? Is it safe?
+  # opts.on("-f", "--force", "Forceably overwrite any existing stamps") do |v|
+  #   options[:force] = v
+  # end
+
   opts.on("-i", "--include-dirs x,y,x", Array, 
     "Include these dir patterns in stamp list") do |v|
     options[:include_paths] = v

data/lib/katana_stamp.rb

@@ -14,30 +14,14 @@ module KatanaStamp
     
     DIR_PATTERS.each do |main_dir|
       Dir.glob(main_dir).each do |path|
+        # skip to the next file if this file matches exclude_paths
         next if options[:exclude_paths].detect { |pattern| File.fnmatch(pattern, path) }
-        custom_file = StampFile.new(path, options)
-        if custom_file.has_stamp?
-          print_colour("#{path} already stamped!", :yellow)
-        else
-          print_colour("#{path} stamped!", :green)
-          custom_file.stamp
-        end
+        StampFile.new(path, options).stamp!
       end      
     end
-    true # return true
-  end
-  
-  def self.print_colour(message, colour)
-    colour_id = 
-      case colour
-      when :yellow then 33
-      when :green then 32
-      else
-        37 # white
-      end
-    puts "\033[0;#{colour_id}m#{message}\033[0m"
+    true # return true (success)
   end
   
   module_function :run!
 
-end
+end

data/lib/katana_stamp/stamp_file.rb

@@ -1,40 +1,108 @@
 module KatanaStamp
-  class StampFile < Struct.new(:path, :options)
+  class StampFile
 
-    # The default message stamped to each file.
-    # The %s are placeholders for _year_ and _owner_ respectively
-    COPYRIGHT_NOTICE = "(c) Copyright %s %s. All Rights Reserved."
+    def initialize(path, options)
+      @path              = path      
+      @comment_delimiter = options[:comment_delimiter] || '#'
+      @year              = options[:year] || Time.now.year
+      @owner             = options[:owner] || 'Katana Code Ltd'
+      @options_message   = options[:message]
+    end
+
+    # Path to this file
+    attr_reader :path
+    
+    # Comment delimeter used in stamp (defaults to '#')
+    attr_reader :comment_delimiter
     
+    # Copyright year (defaults to this Year)
+    attr_reader :year
+    
+    # Copyright owner (defaults to Katana Code Ltd)
+    attr_reader :owner
+
+    # ANSI Colour code numbers
+    ANSI_COLORS = {
+      red: 31,
+      green: 32,    
+      yellow: 33,
+    }
+
     # When called, will add a copyright notice comment to the end of the file
     # with path
-    def stamp
-      `echo "#{"\n" unless has_closing_break?}# #{message}" >> #{path}`
+    def stamp!
+      case 
+      when has_stamp_with_another_owner?
+        print_colour("stamped by another owner!", :red, :warn)
+      when has_stamp?
+        print_colour("already stamped!", :yellow)
+      else
+        `echo "#{"\n" unless has_closing_break?}#{message}" >> #{path}`
+        print_colour("stamped!", :green)        
+      end
     end
 
     # Does the file already have a copyright stamp?
+    def existing_stamp
+      @existing_stamp = begin
+        File.open(path, "r") do |file|
+          file.read.scan(%r{#{comment_delimiter}\s\(c\)(.+)\sAll\sRights\sReserved}).flatten.first
+        end
+      end
+    end
+
+    # The existing Copyright owner or nil
+    def existing_owner
+      existing_stamp.scan(%r{Copyright\s#{year}\s(.+)\.}).flatten.first
+    end
+
+    # Does this file already have a stamp?
     def has_stamp?
-      File.open(path, "r") { |file| file.read.scan(message).any? }
+      !!existing_stamp
     end
     
+    # Regular expression to match stamps
+    def stamp_regexp
+      %r{#{comment_delimiter}\s\(c\)(.+)\sAll\sRights\sReserved}
+    end
+
+    # Does this file have a stamp with a different owner?
+    def has_stamp_with_another_owner?
+      has_stamp? and existing_owner != owner
+    end
+
     # The message to be stamped to each file
-    # defaults to: COPYRIGHT_NOTICE
     def message
-      options[:year]  ||= Time.now.year
-      options[:owner] ||= 'Katana Code Ltd'      
-      message = options[:message] || COPYRIGHT_NOTICE % [options[:year], options[:owner]]
+      @message ||= begin
+        message_prefix = "#{comment_delimiter} (c) "
+        if @options_message
+          message_prefix << @options_message
+        else
+          message_prefix << "Copyright #{year} #{owner}. All Rights Reserved"
+        end
+        message_prefix
+      end
     end
-    
+
     private
-    
 
+    # Print a message to the console with colour
+    def print_colour(msg, colour, method = :puts)
+      colour_id = ANSI_COLORS[colour] || 39
+      send(method, "\033[0;#{colour_id}m#{path} #{msg}\033[0m")
+    end
+
+    # Does this file have a line break at the end?
     def has_closing_break?
       last_char == "\n"
     end
 
+    # The last character of this file
     def last_char
       last_line[-1] if last_line
     end
 
+    # The last line of this file
     def last_line
       IO.readlines(path)[-1]
     end

data/lib/katana_stamp/version.rb

@@ -1,3 +1,3 @@
 module KatanaStamp
-  VERSION = "0.1.1"
-end
+  VERSION = "1.0.0"
+end

data/spec/katana_stamp_spec.rb

@@ -14,6 +14,41 @@ describe KatanaStamp do
   end
 
   let(:file_content) { File.read("app/models/test_model_one.rb")  }
+  
+  context "printing to console" do
+    
+    it "explains file has been stamped if not already" do
+      @orig_stdout = $stdout
+      $stdout = StringIO.new
+      run_with_options
+      $stdout.rewind
+      $stdout.string.chomp.should include("app/models/test_model_one.rb stamped!")
+      $stdout = @orig_stdout    
+    end
+    
+    it "explains file has already been if stamped with the same name" do
+      @orig_stdout = $stdout
+      $stdout = StringIO.new
+      run_with_options
+      run_with_options      
+      $stdout.rewind
+      $stdout.string.chomp.should include("app/models/test_model_one.rb already stamped!")
+      $stdout = @orig_stdout    
+    end
+    
+    it "warns file has already been if stamped with another name" do
+      @orig_stderr = $stderr
+      $stderr = StringIO.new
+      run_with_options
+      run_with_options(owner: "gavin")      
+      $stderr.rewind
+      $stderr.string.chomp.should include("app/models/test_model_one.rb stamped by another owner!")
+      $stderr = @orig_stderr    
+    end
+    
+  end
+  
+  
 
   context "by default" do
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katana_stamp
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70231788536560 !ruby/object:Gem::Requirement
+  requirement: &70120602990220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231788536560
+  version_requirements: *70120602990220
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70231788536140 !ruby/object:Gem::Requirement
+  requirement: &70120602989800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231788536140
+  version_requirements: *70120602989800
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70231788535720 !ruby/object:Gem::Requirement
+  requirement: &70120602989380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231788535720
+  version_requirements: *70120602989380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70231788535300 !ruby/object:Gem::Requirement
+  requirement: &70120602988960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231788535300
+  version_requirements: *70120602988960
 description: Adds copyright comments to .rb files within a Ruby application
 email:
 - bodacious@katanacode.com
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4026286511023334403
+      hash: -1893729203238284076
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4026286511023334403
+      hash: -1893729203238284076
 requirements: []
 rubyforge_project: katana_stamp
 rubygems_version: 1.8.15