katana_stamp 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+app/
+spec/support/test_dummy_file.rb
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in katana_stamp.gemspec
+gemspec

data/Guardfile

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

data/README.md

@@ -0,0 +1,55 @@
+# 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!

data/Rakefile

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

data/bin/katana_stamp

@@ -0,0 +1,38 @@
+#! /usr/bin/env ruby
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'katana_stamp'
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Katana Stamp Usage:"
+
+  opts.on("-i", "--include-dirs x,y,x", Array, 
+    "Include these dir patterns in stamp list") do |v|
+    options[:include_paths] = v
+  end
+  
+  opts.on("-x", "--exclude-dirs x,y,x", Array, 
+    "Don't include these dir patterns in stamp list") do |v|
+    options[:exclude_paths] = v
+  end
+  
+  opts.on("-y", "--year YEAR", "Year of Copyright") do |v|
+    options[:year] = v
+  end
+  
+  opts.on("-o", "--owner OWNER", "Copyright owner") do |v|
+    options[:owner] = v
+  end
+  
+  opts.on("-m", "--message MESSAGE", "Overwrite the entire message.") do |v|
+    options[:message] = v
+  end
+  
+end.parse!
+
+exit(KatanaStamp.run!(options))

data/katana_stamp.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "katana_stamp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "katana_stamp"
+  s.version     = KatanaStamp::VERSION
+  s.authors     = ["Bodacious"]
+  s.email       = ["bodacious@katanacode.com"]
+  s.homepage    = ""
+  s.summary     = %q{A copyright stamping gem}
+  s.description = %q{Adds copyright comments to .rb files within a Ruby application}
+
+  s.rubyforge_project = "katana_stamp"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "activesupport"
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'rake'
+end

data/lib/katana_stamp.rb

@@ -0,0 +1,43 @@
+module KatanaStamp
+
+  require 'katana_stamp/stamp_file'
+  
+  DIR_PATTERS = [ "app/**/*.rb", "lib/**/*.rb" ]
+
+  # Stamps all files matching DIR_PATTERNS and the +--include-paths+ option unless they have
+  # already been stamped
+  def run!(options={})
+    options[:exclude_paths] ||= []
+    options[:include_paths].each do |path|
+      DIR_PATTERS << path
+    end if options[:include_paths]
+    
+    DIR_PATTERS.each do |main_dir|
+      Dir.glob(main_dir).each do |path|
+        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
+      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"
+  end
+  
+  module_function :run!
+
+end

data/lib/katana_stamp/stamp_file.rb

@@ -0,0 +1,43 @@
+module KatanaStamp
+  class StampFile < Struct.new(:path, :options)
+
+    # 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."
+    
+    # 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}`
+    end
+
+    # Does the file already have a copyright stamp?
+    def has_stamp?
+      File.open(path, "r") { |file| file.read.scan(message).any? }
+    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]]
+    end
+    
+    private
+    
+
+    def has_closing_break?
+      last_char == "\n"
+    end
+
+    def last_char
+      last_line[-1] if last_line
+    end
+
+    def last_line
+      IO.readlines(path)[-1]
+    end
+
+  end  
+end

data/lib/katana_stamp/version.rb

@@ -0,0 +1,3 @@
+module KatanaStamp
+  VERSION = "0.1.0"
+end

data/spec/katana_stamp_spec.rb

@@ -0,0 +1,104 @@
+require "spec_helper"
+include ActiveSupport::Inflector
+
+describe KatanaStamp do
+
+  DEFAULT_STAMP = '# (c) Copyright 2012 Katana Code Ltd. All Rights Reserved'
+
+  before(:each) do
+    copy_template_files
+  end
+  
+  after(:all) do
+    copy_template_files
+  end
+
+  let(:file_content) { File.read("app/models/test_model_one.rb")  }
+
+  context "by default" do
+
+    before do
+      run_with_options
+    end
+
+    it 'adds the copyright notice to the bottom of the file if not present' do
+      file_content.should include(DEFAULT_STAMP)
+    end
+
+    it "doesn't add the copyright notice again if it's already there" do
+      run_with_options # again
+      file_content.scan(DEFAULT_STAMP).count.should eql(1)
+    end
+
+    it "doesn't modify non-ruby files" do
+      File.read('app/models/README').should_not include("# (c) Copyright")
+    end
+
+  end
+
+  context 'with owner option' do
+
+    it 'uses the owner passed' do
+      run_with_options(owner: 'Bodacious')
+      file_content.should include('Bodacious')
+    end
+
+  end
+
+  context 'with year option' do
+
+    it 'uses the year passed' do
+      run_with_options(year: '1999')
+      file_content.should include('1999')
+    end
+
+  end  
+
+  context 'with include-dirs option' do
+
+    let(:path) { 'spec/support/test_dummy_file.rb' }
+    
+    before do
+      run_with_options(include_paths: [path])
+    end
+    
+    it "also stamps paths listed in include_paths" do  
+      File.read(path).should include(DEFAULT_STAMP)
+    end
+
+  end
+
+  context 'with exclude-dirs option' do
+
+    let(:path) { 'app/models/test_model_two.rb' }
+
+    before do
+      run_with_options(exclude_paths: [path])
+    end
+
+    it "doesn't stamp paths listed in exclude_paths" do
+      File.read(path).should_not include(DEFAULT_STAMP)
+    end
+
+    it "it still stamps files that don't match the pattern" do
+      file_content.should include(DEFAULT_STAMP)
+    end
+
+  end
+
+  context 'with message option' do
+    
+    let(:message) { "Released under the Bodacious license" }
+    
+    before do
+      run_with_options(message: message)
+    end
+
+    it "overwrites the entire message" do
+      file_content.should include(message)
+      file_content.should_not include(DEFAULT_STAMP)      
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "katana_stamp"
+require "active_support"
+
+def copy_template_files
+  FileUtils.cp_r(Dir.glob("#{File.dirname(__FILE__)}/templates/*"), ".")
+end
+
+def run_with_options(options = {})
+  options[:exclude_paths] ||= []
+  # we don't want to stamp files from this Gem's libraries
+  # each time we test
+  options[:exclude_paths] << "lib/katana_stamp.rb"
+  options[:exclude_paths] << "lib/katana_stamp/*.rb"
+  KatanaStamp.run!(options)
+end

data/spec/templates/README.md

@@ -0,0 +1,2 @@
+Files in this directory are used to replace those that are stamped in specs so we start
+each test with fresh, unstamped files.

data/spec/templates/spec/support/test_dummy_file.rb

@@ -0,0 +1,3 @@
+class TestDummyFile
+  
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: katana_stamp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70113106504500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113106504500
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70113106504080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113106504080
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70113106503660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113106503660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70113106503240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113106503240
+description: Adds copyright comments to .rb files within a Ruby application
+email:
+- bodacious@katanacode.com
+executables:
+- katana_stamp
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- app/models/README
+- app/models/test_model_one.rb
+- app/models/test_model_two.rb
+- bin/katana_stamp
+- katana_stamp.gemspec
+- lib/katana_stamp.rb
+- lib/katana_stamp/stamp_file.rb
+- lib/katana_stamp/version.rb
+- spec/katana_stamp_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_dummy_file.rb
+- spec/templates/README.md
+- spec/templates/app/models/test_model_one.rb
+- spec/templates/app/models/test_model_two.rb
+- spec/templates/spec/support/test_dummy_file.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2004445586818876172
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2004445586818876172
+requirements: []
+rubyforge_project: katana_stamp
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A copyright stamping gem
+test_files:
+- spec/katana_stamp_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_dummy_file.rb
+- spec/templates/README.md
+- spec/templates/app/models/test_model_one.rb
+- spec/templates/app/models/test_model_two.rb
+- spec/templates/spec/support/test_dummy_file.rb