gem-license 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 816046036a98b7c44fd1c211886443bf60f92c7726245b81878ca20db36cd934
-  data.tar.gz: 1f4116b96839c2223cb2204cd58739967d990deaa7979757ad1d57cc69d24be4
+  metadata.gz: 0f287b4ff8ad851be08bf6470638c8ed27e2513fe6437e16ac95ed9abd40a722
+  data.tar.gz: ab1f84d65a0050a76541d3aa227c0d0f6471251876dac8e17d5d19c5923b74c0
 SHA512:
-  metadata.gz: a9072fa5c7ff0c084662598811629f4df2771f606b29392fed8050056e5b67c39a60f6502109a40190730323c0bb27da3b66b04a6c1c106b0939e335adff90f4
-  data.tar.gz: d8b9bb473167363dbaa484fd8c9b280a2757c1753b23cdcfbe0928c75cd350f3b3c906e535c60668b4bf4ddf4a31485eaaff7c5c8413e88c2ff1de1cf897d70f
+  metadata.gz: df9f71bd7567d0e3d4967c759ddd350d8c660283ad4b6fd2d4e26e214f60d9465997ba9de8c88082b598e5350d1342c32aa966d15e64d87f72e99b37d31b7768
+  data.tar.gz: c9e2bb3ec419a29a532fdd044d9e56bb8fd5d2740fc990e10bd4b5f0a67ff8ed6d4de80ccf50411d744ccf1b28d71b35dc38b652955816f52d370dead32b2e85

data/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*.rb,Gemfile,*.gemspec,Rakefile]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2019-05-22
+
+- Initial implementation
+
+## [0.2.0] - 2019-05-22
+
+### Added
+
+- Usage information
+- Handler for no matches against given input
+
+## [0.3.0] - 2019-5-23
+
+### Added
+
+- Suggestions when an identifier does not match in the license list
+- -l/--list for viewing all available licenses
+- -o/--output for specifying an output path

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) <year> <copyright holders>
+Copyright (c) 2019 Matt Carey
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -14,10 +14,16 @@ gem install gem-license
 gem license mit
 
 # output to stdout
-gem license gpl-3.0
+gem license gpl-3.0 -s
 
 # create a LICENSE.md
-gem license apl-1.0
+gem license apl-1.0 -m
+
+# specify output path
+gem license mit -o MIT.license
+
+# view a list of all available licenses
+gem license -l
 ```
 
 Licenses names are all based on SPDX identifiers and are not case sensitive.

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+task default: :install

data/gem-license.gemspec

@@ -2,9 +2,10 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'gem-license'
-  spec.version       = '0.2.0'
+  spec.version       = '0.3.0'
   spec.authors       = ['Matt Carey']
   spec.email         = ['matthew.b.carey@gmail.com']
+  spec.homepage      = 'https://github.com/swarley/gem-license'
 
   spec.summary       = 'Gem plugin to download licenses'
   spec.description   = 'Gem plugin to download a LICENSE file based on its shortname'
@@ -14,7 +15,9 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3'
 
   spec.add_development_dependency 'bundler', '~> 2.0.1'
+  spec.add_development_dependency 'rake', '>= 12.0.0'
   spec.add_development_dependency 'rubocop', '~> 0.69'
 end

data/lib/gem_license.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'English'
+
+# Container for license fetching utilities
+module Gem::License
+  module_function
+
+  def fetch_license_list
+    list_uri = URI('https://spdx.org/licenses/licenses.json')
+    JSON.parse(list_uri.read)['licenses']
+  rescue OpenURI::HTTPError => e
+    raise Gem::CommandLineError, "Unable to get license list. [#{e.message}]"
+  end
+
+  def fetch_license_text(url)
+    license_uri = URI(url)
+    license_obj = JSON.parse(license_uri.read)
+    license_obj['licenseText']
+  rescue OpenURI::HTTPError => e
+    raise Gem::CommandLineError, "Unable to get license text. [#{e.message}]"
+  end
+
+  def match_license_id(license_id, id_list)
+    perfect_match = id_list.find { |id| id.downcase == license_id.downcase }
+    return perfect_match if perfect_match
+
+    spell_checker = DidYouMean::SpellChecker.new(dictionary: id_list)
+    id = spell_checker.correct(license_id).first
+    abort 'Unable to find a matching SPDX identifier.' + (id ? " Did you mean `#{id}'?" : '')
+  end
+
+  def write_license(license_obj, path = nil)
+    text = fetch_license_text(license_obj['detailsUrl'])
+    text = format_license(text) if format
+
+    if path
+      File.open(path, 'w+') do |f|
+        f.write text
+      end
+    else
+      $DEFAULT_OUTPUT.puts text
+    end
+  end
+
+  def download(shortname, opt)
+    license_list = fetch_license_list
+    id_list = license_list.collect { |l_obj| l_obj['licenseId'] }
+
+    id = match_license_id(shortname, id_list)
+    license_obj = license_list.find { |l_obj| l_obj['licenseId'] == id }
+
+    path = opt[:output_path]
+    path = 'LICENSE' + (opt[:markdown] ? '.md' : '') if path.nil? && !opt[:stdout]
+
+    write_license license_obj, path
+  end
+end

data/lib/rubygems/commands/license_command.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'gem_license'
 require 'open-uri'
 require 'json'
 
@@ -15,75 +16,28 @@ class Gem::Commands::LicenseCommand < Gem::Command
     add_option('-s', '--stdout', 'Write to STDOUT instead of LICENSE') do |_, options|
       options[:stdout] = true
     end
-  end
-
-  def fetch_license_list
-    list_uri = URI('https://spdx.org/licenses/licenses.json')
-    JSON.parse(list_uri.read)
-  rescue OpenURI::HTTPError => e
-    raise Gem::CommandLineError, "Unable to get license list. [#{e.message}]"
-  end
-
-  def fetch_license_text(url)
-    license_uri = URI(url)
-    license_obj = JSON.parse(license_uri.read)
-    license_obj['licenseText']
-  rescue OpenURI::HTTPError => e
-    raise Gem::CommandLineError, "Unable to get license text. [#{e.message}]"
-  end
-
-  def match_license_id(license_id, id_list)
-    license_id_rxp = Regexp.new(Regexp.escape(license_id), Regexp::IGNORECASE)
-    matched_ids = id_list.select { |id| id =~ license_id_rxp }
-
-    if matched_ids.empty?
-      say 'Unable to find a matching SPDX identifier'
-      exit
-    end
-
-    perfect_match = matched_ids.find { |id| id =~ /\A#{license_id_rxp}\Z/i }
 
-    unless perfect_match
-      say 'Unable to find an exact match. Suggestions below'
-      matched_ids.each { |id| say "\t#{id}" }
-      exit
+    add_option('-o', '--output=PATH', 'Specify an output path') do |value, options|
+      options[:output_path] = value
     end
 
-    perfect_match
-  end
-
-  def write_license(license_obj)
-    text = fetch_license_text(license_obj['detailsUrl'])
-    if options[:stdout]
-      say text
-    else
-      fname = 'LICENSE'
-      fname += '.md' if options[:markdown]
-      File.open(fname, 'w+') do |f|
-        f.write text
-      end
+    add_option('-l', '--list', 'View all available licenses') do |_, options|
+      options[:list] = true
     end
   end
 
-  def download(shortname)
-    license_list = fetch_license_list['licenses']
-    id_list = license_list.collect { |l_obj| l_obj['licenseId'] }
-
-    id = match_license_id(shortname, id_list)
-    license_obj = license_list.find { |l_obj| l_obj['licenseId'] == id }
-
-    write_license license_obj
-  end
-
   def execute
-    id = options[:args].first
-
-    if id.nil?
-      say "USAGE: #{usage}"
+    if options[:list]
+      list = Gem::License.fetch_license_list
+      just_size = list.collect { |lsc| lsc['licenseId'].length }.max
+      list.each do |license|
+        say(license['licenseId'].ljust(just_size) + ' - ' + license['name'])
+      end
       exit
     end
 
-    download(id)
+    id = options[:args].first || abort("USAGE: #{usage}")
+    Gem::License.download(id, options)
   end
 
   def description

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem-license
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Carey
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +59,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- ".editorconfig"
 - ".rubocop.yml"
+- CHANGELOG.md
 - LICENSE
 - README.md
+- Rakefile
 - gem-license.gemspec
+- lib/gem_license.rb
 - lib/rubygems/commands/license_command.rb
 - lib/rubygems_plugin.rb
-homepage: 
+homepage: https://github.com/swarley/gem-license
 licenses:
 - MIT
 metadata: {}
@@ -64,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.gitignore

@@ -1,53 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc