opensource 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62ba66039ead0537f81892f1b91536e03c16c83c
-  data.tar.gz: 2577842b0f55542cb894904478ecf12473b09c5d
+  metadata.gz: 39b285b8f211a3ed4f00eb494c290fd31e4bd137
+  data.tar.gz: f738ac1de6cc359ab5fcc93823ac25d9f44ed1a3
 SHA512:
-  metadata.gz: 91ee74ea895b6d7e2080127ec5a325e9fc216f02c01f1eeb664b93c2c3cc9c6d3e1b980eaf24a6f830194fa7d946ce9430f872d2aa27edda1e41a1e1f516e81a
-  data.tar.gz: af28a4366f43ad0ca75638fe1b80849b1006334059146de80518d016ccfb2ff055005ef10dd715f2d420fd03f0aee0dadb4c6c101e031d1005003c5e913757e6
+  metadata.gz: e3f8725c004f4a8b509ec68edf5e081f5a4bba2f937475f3703e296dc1b84d30c75dee031bd968420d4ff8a567eb607ce7f8bd685c037f998ed761df6ffe1a8f
+  data.tar.gz: 10ebdf67b1bad3493841a0d67c63754d7d7c23be313f35a267a940bca8bd7aa150d6f43fb1336da4152c5c1bf290983825ceaefd3ffd948cf95e92b748dc8947

data/History.md

@@ -0,0 +1,10 @@
+
+0.6.1 / 2015-05-31
+==================
+
+  * rename opensource -> open_source
+  * update copyright year
+  * Refactor getting credentials code
+  * Handle missing arguments error. Closes #8
+  * Add supported list of licences
+  * fix missing vars in bsd 3-clause license

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2014 Mohnish Thallavajhula <i@mohni.sh>
+Copyright (c) 2015 Mohnish Thallavajhula <i@mohni.sh>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,15 @@
-## Opensource.rb
+# OpenSource
 
-Add an Opensource License to your project. Helps get rid of the annoyance of adding a new license to the project and optionally append the content of the license to the README.md file.
+[![Code Climate](https://codeclimate.com/github/mohnish/opensource.rb/badges/gpa.svg)](https://codeclimate.com/github/mohnish/opensource.rb)
+
+Command line tool that lets you add an open source license to your project by running a simple command.
+
+## Supported Licenses
+
+- MIT
+- Apache 2
+- BSD 3 Clause
+- GPL 3
 
 ## Installation
 
@@ -24,7 +33,7 @@ Usage: opensource OPTIONS
 
 Specific options:
     -s, --setup                      Setup user credentials in ~/.osrc file
-    -l, --license LICENSE            LICENSE can be mit
+    -l, --license LICENSE            LICENSE can be apache2|bsd|gpl3|mit
     -a, --append README              Append LICENSE content to README file
 
 Common options:
@@ -32,15 +41,11 @@ Common options:
     -h, --help                       Show this message
 ```
 
-### TODO
-
-- Currently only MIT is supported. Need to add support for other open source licenses like Apache, GPL, BSD etc
-
 ## License
 
 (The MIT License)
 
-Copyright (c) 2014 Mohnish Thallavajhula <i@mohni.sh>
+Copyright (c) 2015 Mohnish Thallavajhula <i@mohni.sh>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/opensource

@@ -2,21 +2,21 @@
 # encoding: UTF-8
 
 require 'optparse'
-require_relative '../lib/opensource'
+require 'open_source'
 
 options = {}
 
-OptionParser.new do |opts|
+option_parser = OptionParser.new do |opts|
   opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} OPTIONS"
   opts.separator ''
   opts.separator 'Specific options:'
 
   opts.on('-s', '--setup', 'Setup user credentials in ~/.osrc file') do |s|
-    Opensource::Owner.set_credentials
+    OpenSource::Owner.set_credentials
     exit
   end
 
-  opts.on('-l', '--license LICENSE', Opensource::LICENSES, "LICENSE can be #{Opensource::LICENSES.join('|')}") do |l|
+  opts.on('-l', '--license LICENSE', OpenSource::LICENSES, "LICENSE can be #{OpenSource::LICENSES.join('|')}") do |l|
     options[:license] = l
   end
 
@@ -28,7 +28,7 @@ OptionParser.new do |opts|
   opts.separator 'Common options:'
 
   opts.on_tail('-v', '--version', 'Print the version') do
-    puts Opensource::VERSION
+    puts OpenSource::VERSION
     exit
   end
 
@@ -36,12 +36,18 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
-end.parse!
+end
 
 begin
-  Opensource::License.new(options).process
-rescue Opensource::Error => e
-  # TODO: Make sure the above call raises only Opensource::Error
+  option_parser.parse!
+  if options.empty?
+    puts option_parser
+    exit 1
+  end
+
+  OpenSource::License.new(options).process
+rescue OpenSource::Error => e
+  # TODO: Make sure the above call raises only OpenSource::Error
   puts "Error: #{e.message}"
   exit 1
 end

data/lib/{opensource.rb → open_source.rb}

@@ -1,9 +1,9 @@
-require_relative 'opensource/version'
-require_relative 'opensource/error'
-require_relative 'opensource/owner'
-require_relative 'opensource/license'
+require 'open_source/version'
+require 'open_source/error'
+require 'open_source/owner'
+require 'open_source/license'
 
-module Opensource
+module OpenSource
   LICENSES = Dir.entries(File.expand_path("../../templates", __FILE__)).map do |filename|
     File.basename(filename, '.erb') if !['.', '..'].include?(filename)
   end.compact

data/lib/{opensource → open_source}/error.rb

@@ -1,4 +1,4 @@
-module Opensource
+module OpenSource
   module Error
     def self.exception(*args)
       RuntimeError.new(*args).extend(self)

data/lib/{opensource → open_source}/license.rb

@@ -1,11 +1,10 @@
 require 'erb'
 
-module Opensource
+module OpenSource
   class License
     def initialize(options)
       @options = options
       @user = Owner.get_credentials
-      @user['escaped_email'] = "<#{@user['email']}>"
       @license = ERB.new(File.read("#{File.expand_path("../../../templates", __FILE__)}/#{@options[:license]}.erb")).result(binding)
     end
 
@@ -14,7 +13,7 @@ module Opensource
       append if @options[:append]
     end
 
-    private
+  private
     def generate
       f = File.new("#{Dir.pwd}/LICENSE", "w")
       f.write(@license)
@@ -27,4 +26,4 @@ module Opensource
       end
     end
   end
-end
+end

data/lib/{opensource → open_source}/owner.rb

@@ -1,4 +1,4 @@
-module Opensource
+module OpenSource
   module Owner
     extend self
 
@@ -27,6 +27,8 @@ module Opensource
         end
       end
 
+      user['escaped_email'] = "<#{user['email']}>"
+
       user
     end
   end

data/lib/open_source/version.rb

@@ -0,0 +1,3 @@
+module OpenSource
+  VERSION = '0.6.1'
+end

data/opensource.gemspec

@@ -1,15 +1,15 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'opensource/version'
+require 'open_source/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "opensource"
-  spec.version       = Opensource::VERSION
+  spec.version       = OpenSource::VERSION
   spec.authors       = ["Mohnish Thallavajhula"]
   spec.email         = ["i@mohni.sh"]
-  spec.summary       = %q{Add a license to your opensource project}
-  spec.description   = %q{Add a license to your opensource project by running a simple command}
+  spec.summary       = %q{Command line tool that lets you add an open source license to your project by running a simple command}
+  spec.description   = %q{Command line tool that lets you add an open source license to your project by running a simple command}
   spec.homepage      = "https://github.com/mohnish/opensource.rb"
   spec.license       = "MIT"
 

data/templates/bsd.erb

@@ -8,14 +8,14 @@ modification, are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
-    * Neither the name of the <organization> nor the
+    * Neither the name of <%= @user['name'] %> nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DISCLAIMED. IN NO EVENT SHALL <%= @user['name'].upcase %> BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opensource
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Mohnish Thallavajhula
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Add a license to your opensource project by running a simple command
+description: Command line tool that lets you add an open source license to your project
+  by running a simple command
 email:
 - i@mohni.sh
 executables:
@@ -47,17 +48,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- CHANGELOG.md
 - Gemfile
+- History.md
 - LICENSE
 - README.md
 - Rakefile
 - bin/opensource
-- lib/opensource.rb
-- lib/opensource/error.rb
-- lib/opensource/license.rb
-- lib/opensource/owner.rb
-- lib/opensource/version.rb
+- lib/open_source.rb
+- lib/open_source/error.rb
+- lib/open_source/license.rb
+- lib/open_source/owner.rb
+- lib/open_source/version.rb
 - opensource.gemspec
 - templates/apache2.erb
 - templates/bsd.erb
@@ -83,8 +84,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Add a license to your opensource project
+summary: Command line tool that lets you add an open source license to your project
+  by running a simple command
 test_files: []

data/lib/opensource/version.rb

@@ -1,3 +0,0 @@
-module Opensource
-  VERSION = '0.6.0'
-end