opensource 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b71bfd2ad3dee64ad2488205434dfa845fccbe62
-  data.tar.gz: 84ec7190d8741aef42e702d9dac2f1418bebe12c
+  metadata.gz: a49b0a7a6f0eb57af9cd727066d3738d835cab24
+  data.tar.gz: 29e1676472604520274219feaa63127e2dc8e59f
 SHA512:
-  metadata.gz: a7fd97d8f962565a9a186eb06b43ea27f255e58b78e37888e7774210a3f42ff49b40ec0becc0db3ddcf17439d1c867cae3e84ee9034aa72f8d3bfa8d94db7a8c
-  data.tar.gz: 7335b6e8b8c720b7f43faf2dabf40082ff36ac9fc3f7cd5e9cb26dd676d6b100f321f19fd73985f99679abb61e58d5f26c9d3bc217573fdb37fc6a9c39222b5a
+  metadata.gz: ea6012b2cad1a20d5d4fde86e064b05c95afeed0637f889f2cd8bd481a87e860c4b19ebffa928aaa41103cb0ef24e2fc005ba870d4660d66ca27cf1d0f5713bc
+  data.tar.gz: a42265fc6f2e913faf0828e5f4a366ffb56c2c18be61e79c6a71a2ef2908a66712573f299b797ab881b757e86990ab9744a540fd2e0332a102105c491c2a69b1

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -12,3 +13,4 @@
 *.o
 *.a
 mkmf.log
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler
+script: ./bin/rspec

data/History.md

@@ -1,4 +1,10 @@
 
+1.0.0 / 2016-02-28
+==================
+
+  * rewrite of the origin gem
+
+
 0.6.2 / 2015-06-02
 ==================
 

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2015 Mohnish Thallavajhula <i@mohni.sh>
+Copyright (c) 2016 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/README.md

@@ -1,8 +1,10 @@
 # OpenSource
-
+[![Build Status](https://travis-ci.org/mohnish/opensource.svg?branch=master)](https://travis-ci.org/mohnish/opensource)
 [![Code Climate](https://codeclimate.com/github/mohnish/opensource/badges/gpa.svg)](https://codeclimate.com/github/mohnish/opensource)
 
-Command line tool that lets you add an open source license to your project by running a simple command.
+> Command line tool that lets you add an open source license to your project by running a simple command.
+
+Supports **Ruby 1.9.3+**.
 
 ## Supported Licenses
 
@@ -13,27 +15,20 @@ Command line tool that lets you add an open source license to your project by ru
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Run:
 
-```ruby
-gem 'opensource'
+```bash
+$ gem install opensource
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install opensource
-
 ## Usage
-```
+
+```bash
 Usage: opensource OPTIONS
 
 Specific options:
     -s, --setup                      Setup user credentials in ~/.osrc file
-    -l, --license LICENSE            LICENSE can be apache2|bsd|gpl3|mit
+    -l, --license LICENSE            LICENSE can be apache2, bsd, gpl3, mit
     -a, --append README              Append LICENSE content to README file
 
 Common options:
@@ -45,7 +40,7 @@ Common options:
 
 (The MIT License)
 
-Copyright (c) 2015 Mohnish Thallavajhula <i@mohni.sh>
+Copyright (c) 2016 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/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'open_source'
+
+require 'irb'
+require 'irb/completion'
+
+IRB.conf[:PROMPT_MODE] = :SIMPLE
+IRB.conf[:AUTO_INDENT] = true
+
+IRB.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/{bin → exe}/opensource

@@ -12,11 +12,11 @@ option_parser = OptionParser.new do |opts|
   opts.separator 'Specific options:'
 
   opts.on('-s', '--setup', 'Setup user credentials in ~/.osrc file') do |s|
-    OpenSource.setup_owner_credentails
+    OpenSource.setup_owner_credentials
     exit
   end
 
-  opts.on('-l', '--license LICENSE', OpenSource::LICENSES, "LICENSE can be #{OpenSource::LICENSES.join(', ')}") do |l|
+  opts.on('-l', '--license LICENSE', OpenSource::SUPPORTED_LICENSES, "LICENSE can be #{OpenSource::SUPPORTED_LICENSES.join(', ')}") do |l|
     options[:license] = l
   end
 
@@ -28,12 +28,12 @@ option_parser = OptionParser.new do |opts|
   opts.separator 'Common options:'
 
   opts.on_tail('-v', '--version', 'Print the version') do
-    puts OpenSource::VERSION
+    OpenSource.logger.info(OpenSource::VERSION)
     exit
   end
 
   opts.on_tail('-h', '--help', 'Show this message') do
-    puts opts
+    OpenSource.logger.info(opts)
     exit
   end
 end
@@ -41,13 +41,13 @@ end
 begin
   option_parser.parse!
   if options.empty?
-    puts option_parser
+    OpenSource.logger.info(option_parser)
     exit 0
   end
 
-  OpenSource::License.new(options).process
+  OpenSource::License::Generator.new(options).generate
 rescue OpenSource::Error => e
   # TODO: Make sure the above call raises only OpenSource::Error
-  puts "Error: #{e.message}"
+  OpenSource.logger.fatal("Error: #{e.message}")
   exit 1
 end

data/lib/open_source.rb

@@ -1,24 +1,30 @@
 require 'open_source/version'
 require 'open_source/error'
-require 'open_source/owner'
-require 'open_source/license'
+require 'open_source/utilities/logging'
+require 'open_source/license/owner'
+require 'open_source/license/generator'
 
 module OpenSource
-  LICENSES = Dir.entries(File.expand_path("../../templates", __FILE__)).map do |filename|
+  extend Utilities::Logging
+
+  SUPPORTED_LICENSES = Dir.entries(File.expand_path('../open_source/license/templates', __FILE__)).map do |filename|
     File.basename(filename, '.erb') if !['.', '..'].include?(filename)
   end.compact
 
+  CONFIG_PATH = File.expand_path('~/.osrc')
+
   def self.request_owner_credentials
-    puts "Enter full name: "
+    OpenSource.logger.info("Enter full name: ")
     name = gets.chomp
-    puts "Enter email address: "
+    OpenSource.logger.info("Enter email address: ")
     email = gets.chomp
 
     { name: name, email: email }
   end
 
-  def self.setup_owner_credentails
+  def self.setup_owner_credentials
     owner_credentials = request_owner_credentials
-    Owner.set_credentials(owner_credentials)
+    owner = License::Owner.new
+    owner.credentials = owner_credentials
   end
 end

data/lib/open_source/license/generator.rb

@@ -0,0 +1,31 @@
+require 'erb'
+
+module OpenSource
+  module License
+    class Generator
+      def initialize(options)
+        @options = options
+        @owner = Owner.new
+        @license = ERB.new(File.read("#{File.expand_path("../templates", __FILE__)}/#{@options[:license]}.erb"))
+      end
+
+      def generate
+        create_license_file
+        append_to_file if @options[:append]
+      end
+
+    private
+      def create_license_file
+        f = File.new("#{Dir.pwd}/LICENSE", 'w')
+        f.write(@license.result(binding))
+        f.close
+      end
+
+      def append_to_file
+        File.open(File.expand_path(@options[:append]), 'a') do |f|
+          f << "\n## License\n\n#{@license.result(binding)}"
+        end
+      end
+    end
+  end
+end

data/lib/open_source/license/owner.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module OpenSource
+  module License
+    class Owner
+      def credentials=(credentials)
+        config_file = File.new(CONFIG_PATH, 'w')
+        file_contents = YAML.dump(credentials)
+        config_file.write(file_contents)
+      rescue StandardError => ex
+        OpenSource.logger.fatal("Unable to access #{CONFIG_PATH}")
+      end
+
+      def credentials
+        @credentials ||= YAML.load_file(CONFIG_PATH)
+      end
+
+      def email
+        credentials[:email]
+      end
+
+      def markdown_supported_email
+        "<#{credentials[:email]}>"
+      end
+
+      def name
+        credentials[:name]
+      end
+    end
+  end
+end

data/{templates → lib/open_source/license/templates}/apache2.erb

@@ -187,7 +187,7 @@ APPENDIX: How to apply the Apache License to your work.
    same "printed page" as the copyright notice for easier
    identification within third-party archives.
 
-Copyright <%= Time.now.year %> <%= @user[:name] %> <%= @user[:escaped_email] %>
+Copyright <%= Time.now.year %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/{templates → lib/open_source/license/templates}/bsd.erb

@@ -1,4 +1,4 @@
-Copyright (c) <%= Time.now.year %> <%= @user[:name] %> <%= @user[:escaped_email] %>
+Copyright (c) <%= Time.now.year %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -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 <%= @user[:name] %> nor the
+    * Neither the name of <%= @owner.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 <%= @user[:name].upcase %> BE LIABLE FOR ANY
+DISCLAIMED. IN NO EVENT SHALL <%= @owner.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

data/{templates → lib/open_source/license/templates}/gpl3.erb

@@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <%= Time.now.year %> <%= @user[:name] %> <%= @user[:escaped_email] %>
+    Copyright (C) <%= Time.now.year %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    Copyright (C) <%= Time.now.year %> <%= @user[:name] %> <%= @user[:escaped_email] %>
+    Copyright (C) <%= Time.now.year %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

data/{templates → lib/open_source/license/templates}/mit.erb

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) <%= Time.now.year %> <%= @user[:name] %> <%= @user[:escaped_email] %>
+Copyright (c) <%= Time.now.year %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/open_source/utilities/logging.rb

@@ -0,0 +1,25 @@
+require 'logger'
+
+module OpenSource
+  module Utilities
+    module Logging
+      class Simple < Logger::Formatter
+        def call(severity, time, progname, msg)
+          "OpenSource: #{msg}\n"
+        end
+      end
+
+      def logger
+        @logger ||= initialize_logger
+      end
+
+      private
+        def initialize_logger
+          logger = Logger.new(STDOUT)
+          logger.level = Logger::INFO
+          logger.formatter = Simple.new
+          logger
+        end
+    end
+  end
+end

data/lib/open_source/version.rb

@@ -1,3 +1,3 @@
 module OpenSource
-  VERSION = '0.6.2'
+  VERSION = '1.0.0'
 end

data/opensource.gemspec

@@ -4,20 +4,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'open_source/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "opensource"
+  spec.name          = 'opensource'
   spec.version       = OpenSource::VERSION
-  spec.authors       = ["Mohnish Thallavajhula"]
-  spec.email         = ["i@mohni.sh"]
-  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"
+  spec.authors       = ['Mohnish Thallavajhula']
+  spec.email         = ['i@mohni.sh']
+  spec.summary       = 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'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opensource
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Mohnish Thallavajhula
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Command line tool that lets you add an open source license to your project
   by running a simple command
 email:
@@ -49,23 +63,30 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - History.md
 - LICENSE
 - README.md
 - Rakefile
-- bin/opensource
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- exe/opensource
 - lib/open_source.rb
 - lib/open_source/error.rb
-- lib/open_source/license.rb
-- lib/open_source/owner.rb
+- lib/open_source/license/generator.rb
+- lib/open_source/license/owner.rb
+- lib/open_source/license/templates/apache2.erb
+- lib/open_source/license/templates/bsd.erb
+- lib/open_source/license/templates/gpl3.erb
+- lib/open_source/license/templates/mit.erb
+- lib/open_source/utilities/logging.rb
 - lib/open_source/version.rb
 - opensource.gemspec
-- templates/apache2.erb
-- templates/bsd.erb
-- templates/gpl3.erb
-- templates/mit.erb
-homepage: https://github.com/mohnish/opensource.rb
+homepage: https://github.com/mohnish/opensource
 licenses:
 - MIT
 metadata: {}
@@ -85,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Command line tool that lets you add an open source license to your project

data/lib/open_source/license.rb

@@ -1,29 +0,0 @@
-require 'erb'
-
-module OpenSource
-  class License
-    def initialize(options)
-      @options = options
-      @user = Owner.get_credentials
-      @license = ERB.new(File.read("#{File.expand_path("../../../templates", __FILE__)}/#{@options[:license]}.erb")).result(binding)
-    end
-
-    def process
-      generate
-      append if @options[:append]
-    end
-
-  private
-    def generate
-      f = File.new("#{Dir.pwd}/LICENSE", "w")
-      f.write(@license)
-      f.close
-    end
-
-    def append
-      File.open(File.expand_path(@options[:append]), "a") do |f|
-        f << "\n## License\n\n#{@license}"
-      end
-    end
-  end
-end

data/lib/open_source/owner.rb

@@ -1,31 +0,0 @@
-module OpenSource
-  module Owner
-    extend self
-
-    OSRC_PATH = File.expand_path("~/.osrc")
-
-    def set_credentials credentials
-      f = File.new(OSRC_PATH, "w")
-      f.write <<-CREDENTIALS.gsub /^\s+/, ""
-        name: #{credentials[:name]}
-        email: #{credentials[:email]}
-        escaped_email: &lt;#{credentials[:email]}&gt;
-      CREDENTIALS
-      f.close
-    end
-
-    def get_credentials
-      credentials = {}
-
-      IO.foreach(OSRC_PATH) do |line|
-        current_line = line.strip
-        if !current_line.empty?
-          key, value = current_line.split(':')
-          credentials[key.strip.to_sym] = value.strip
-        end
-      end
-
-      credentials
-    end
-  end
-end