license-header 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29550a5c7febb9d4ad0981160d12585c7702dbe0
+  data.tar.gz: e7b7f7a145af8a3586a00a98026421bb9d10af88
+SHA512:
+  metadata.gz: ce5a0fe189cc7b10acb0d6751181a4d6ff28adfadc953beda9381f7ba856525dc04ec61ac1e5394b5da2025727526fc307d0fc8b6bc801d27497116c81affee4
+  data.tar.gz: d4c8d7a696d6308c4cfb5a503ab0857079ebf5e03d95b4ab7b7b1c656fc9e885e8528b548decb85011da416754b095f6e217b71806611f78bc6a299ab98ca8e5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in license-header.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,14 @@
+# Copyright 2014 Pier-Hugues Pellerin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#

data/README.md

@@ -0,0 +1,24 @@
+# License::Header
+
+Simple way to add license header to your ruby source file.
+
+## Caveats
+
+Only work for ruby file and doesnt support updating yet.
+
+
+```ruby
+license-header -l LICENSE.txt -t director
+```
+Dry run with -d
+```ruby
+license-header -l LICENSE.txt -t director -d
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ph/license-header/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/license_header

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/license_header/tag_license'
+LicenseHeader::TagLicense.run!

data/lib/license_header/tag_license.rb

@@ -0,0 +1,126 @@
+# Copyright 2014 Pier-Hugues Pellerin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'optparse'
+require 'tempfile'
+require 'securerandom'
+
+module LicenseHeader
+  class TagLicense
+    def initialize(options =  {})
+      @dry_run = options[:dry_run]
+      @license_content = options[:license_content] || LICENSE
+      @extensions = options[:extension] || ['rb']
+    end
+
+    def whitelisted?(file)
+      extension = File.basename(file).split('.').pop
+      @extensions.include?(extension)
+    end
+
+    def has_copyright?(file)
+      fd = File.open(file)
+      line = fd.gets
+      fd.close
+
+      if line =~ license_check
+        return true
+      else
+        return false
+      end
+    end
+
+    def tempfile
+      Tempfile.new(SecureRandom.hex(30))
+    end
+
+    def add_license(file)
+      temp = tempfile
+      File.open(temp, 'w+') do |fd|
+        fd.write(@license_content)
+        fd.write(File.read(file))
+      end
+
+      FileUtils.cp(temp.path, file)
+      FileUtils.rm_rf(temp.path)
+    end
+
+    def license_check
+      /#{@license_check ||= @license_content.split("\n").shift}$/
+    end
+
+    def tag_directory_recursively(directory)
+      modified_files = []
+
+
+      Dir[File.join(File.expand_path(directory), '**/*')].each do |f|
+        if !File.directory?(f) && whitelisted?(f) && !has_copyright?(f)
+          modified_files << f
+          add_license(f) unless dry_run?
+        end
+      end
+
+      modified_files
+    end
+
+    def dry_run?
+      @dry_run
+    end
+
+    def self.run!
+      options = { :target => '.' }
+
+      options_parser = OptionParser.new do |opts|
+        opts.banner = "Usager: license_header [options]"
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on("-t", "--target=val", String, "specify the target directory, default to current directory") do |v|
+          options[:target] = v 
+        end
+
+        opts.on("-l", "--license=val", String, "specify the header to apply to the source code") do |v|
+          options[:license_content] = File.read(v) if File.exist?(v)
+        end
+
+        opts.on("--extensions=[x,y,z]", Array, "rb,cs") do |v|
+         options[:extensions] = v
+        end
+
+        opts.on("-d", "--dry-run", "List the files to changes") do |v|
+          options[:dry_run] = v
+        end
+
+        opts.on_tail
+      end
+      
+      begin
+        options_parser.parse!
+
+        if options[:license_content].nil?
+          puts "Missing the license header file"
+          puts options_parser
+          exit
+        else
+          tag = TagLicense.new(options)
+          modified = tag.tag_directory_recursively(options[:target])
+          modified.each { |f| puts "Modified: #{f}" }
+        end
+      rescue OptionParser::InvalidOption
+        puts "Invalid option"
+        puts options_parser
+      end
+    end
+  end
+end

data/lib/license_header/version.rb

@@ -0,0 +1,17 @@
+# Copyright 2014 Pier-Hugues Pellerin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module LicenseHeader
+  VERSION = "0.0.1"
+end

data/license-header.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'license_header/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "license-header"
+  spec.version       = LicenseHeader::VERSION
+  spec.authors       = ["Pier-Hugues Pellerin"]
+  spec.email         = ["ph@heykimo.com"]
+  spec.summary       = "Simple way to tag a directory with a specific opensource license"
+  spec.description   = "Simple way to tag a directory with a specific opensource license"
+  spec.homepage      = ""
+  spec.license       = "Apache License 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "stud", "~> 0.0.18"
+end

data/spec/fixtures/file_with_copyright.rb

@@ -0,0 +1,16 @@
+# Copyright 2014 Pier-Hugues Pellerin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+def Testing
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.unshift(File.expand_path("#{__FILE__}/../../lib"))

data/spec/tag_license_spec.rb

@@ -0,0 +1,73 @@
+# Copyright 2014 Pier-Hugues Pellerin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'spec_helper'
+require 'license_header/tag_license'
+require 'fileutils'
+require 'stud/temporary'
+
+describe LicenseHeader::TagLicense do
+  let(:current_license) { File.read(__FILE__).split("\n").slice(0, 14).join("\n") }
+  let(:file_with_copyright) { File.join(File.dirname(__FILE__), 'fixtures/file_with_copyright.rb') }
+  let(:unmatched_file) { File.join(File.dirname(__FILE__), 'fixtures/unmatched.md') }
+
+  subject { LicenseHeader::TagLicense.new(:dry_run => true, :license_content => current_license) }
+
+  context '#tagged?' do
+    it "return false if the file doesn't content the copyright header" do
+      Stud::Temporary.file do |f|
+        expect(subject.has_copyright?(f)).to eq(false)
+      end
+    end
+
+    it 'return true if the file has the copyright header' do
+      expect(subject.has_copyright?(file_with_copyright)).to eq(true)
+    end
+  end
+
+  it "should return tagged file" do
+    tmp_file = temporary_file('code.rb', 'w')
+    files = [tmp_file, file_with_copyright]
+
+    expect(Dir).to receive(:[]).with(File.expand_path('spec/**/*')).and_return(files)
+    expect(subject.tag_directory_recursively("spec")).to eq([tmp_file])
+
+    FileUtils.rm_rf(tmp_file)
+  end
+
+  it "should add the license at the beginning of the file" do
+    tmp = Stud::Temporary.file
+
+    File.open(tmp, 'w+') do |f|
+      f.write('LGTM')
+    end
+
+    subject.add_license(tmp)
+    content = File.read(tmp)
+    splitted = content.split("\n")
+
+    expect(splitted.first).to match(/^# Copyright/)
+    expect(splitted.last).to match('LGTM')
+
+    FileUtils.rm_rf(tmp.path)
+
+  end
+end
+
+def temporary_file(suffix, *args)
+  root = ENV["TMP"] || ENV["TMPDIR"] || ENV["TEMP"] || "/tmp"
+  path = File.join(root, "#{SecureRandom.hex(30)}-#{suffix}")
+  File.open(path, *args) {}
+  path
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: license-header
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pier-Hugues Pellerin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.18
+description: Simple way to tag a directory with a specific opensource license
+email:
+- ph@heykimo.com
+executables:
+- license_header
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/license_header
+- lib/license_header/tag_license.rb
+- lib/license_header/version.rb
+- license-header.gemspec
+- spec/fixtures/file_with_copyright.rb
+- spec/spec_helper.rb
+- spec/tag_license_spec.rb
+homepage: ''
+licenses:
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple way to tag a directory with a specific opensource license
+test_files:
+- spec/fixtures/file_with_copyright.rb
+- spec/spec_helper.rb
+- spec/tag_license_spec.rb