gem-license 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f287b4ff8ad851be08bf6470638c8ed27e2513fe6437e16ac95ed9abd40a722
-  data.tar.gz: ab1f84d65a0050a76541d3aa227c0d0f6471251876dac8e17d5d19c5923b74c0
+  metadata.gz: b102bbba895ece6a8926aeea927a29a3b3c65476e8b43b8385b850ba2354611f
+  data.tar.gz: 68f5eb591ef07643eec680943f32f2755d3682314eefcda886f077a11d0c24a3
 SHA512:
-  metadata.gz: df9f71bd7567d0e3d4967c759ddd350d8c660283ad4b6fd2d4e26e214f60d9465997ba9de8c88082b598e5350d1342c32aa966d15e64d87f72e99b37d31b7768
-  data.tar.gz: c9e2bb3ec419a29a532fdd044d9e56bb8fd5d2740fc990e10bd4b5f0a67ff8ed6d4de80ccf50411d744ccf1b28d71b35dc38b652955816f52d370dead32b2e85
+  metadata.gz: b5e83086d6ae3b7706e31a371e1e89c5303bb21e0902422fde6577c7da83bef7d39ed888f71e3cb8f7de84ac3b9d6371271b18d10bbcd5f52ead7360d1ce0f53
+  data.tar.gz: 40892a7898e4a82b6e2533208164cc32511bf143b1ab90ffa684df9cac75034737c6b38973cf5703781d1e30df0256fc3948b873f712065e48781391a96ff140

data/.gitignore

@@ -0,0 +1,53 @@
+*.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

data/.rubocop.yml

@@ -3,3 +3,6 @@ Style/ClassAndModuleChildren:
 
 Metrics:
   Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3

data/CHANGELOG.md

@@ -25,3 +25,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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
+- -f/--format attempt to format common values

data/README.md

@@ -11,6 +11,7 @@ gem install gem-license
 ## Usage
 
 ```sh
+# download the MIT license to `LICENSE'
 gem license mit
 
 # output to stdout
@@ -22,6 +23,12 @@ gem license apl-1.0 -m
 # specify output path
 gem license mit -o MIT.license
 
+# attempt to format common values
+# Uses git config --get user.name for author names,
+# and the base name of the current working directory for
+# program/project name.
+gem license mit -f
+
 # view a list of all available licenses
 gem license -l
 ```

data/gem-license.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'gem-license'
-  spec.version       = '0.3.0'
+  spec.version       = '0.4.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'
+  spec.description   = 'Gem plugin to download a LICENSE file based on its SPDX identifier'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/gem_license.rb

@@ -4,8 +4,6 @@ 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']
@@ -30,7 +28,43 @@ module Gem::License
     abort 'Unable to find a matching SPDX identifier.' + (id ? " Did you mean `#{id}'?" : '')
   end
 
-  def write_license(license_obj, path = nil)
+  def format_license(text)
+    data_map = {
+      /<\s*(year|yyyy|dates)\s*>/i => Time.now.year,
+      /<program>/i => File.basename(Dir.pwd)
+    }
+
+    begin
+      name = `git config --get user.name`.chomp
+    rescue Errno::ENOENT
+      name = nil
+      say 'Can\'t find git for user.name'
+    end
+
+    if name
+      if name.empty?
+        say '[WARN] No user.name git config value'
+      else
+        author = `git config --get user.name`.chomp
+        data_map[
+          Regexp.union(
+            /<\s*author\s*>/i,
+            /<\s*name of author\s*>/i,
+            /<\s*owner\s*>/i,
+            /<copyright holders?>/i
+          )
+         ] = author
+      end
+    end
+
+    data_map.each do |pattern, value|
+      text.gsub!(pattern, value.to_s)
+    end
+
+    text
+  end
+
+  def write_license(license_obj, path = nil, format = false)
     text = fetch_license_text(license_obj['detailsUrl'])
     text = format_license(text) if format
 
@@ -43,16 +77,18 @@ module Gem::License
     end
   end
 
-  def download(shortname, opt)
+  def download(spdx_id, opt)
     license_list = fetch_license_list
     id_list = license_list.collect { |l_obj| l_obj['licenseId'] }
 
-    id = match_license_id(shortname, id_list)
+    id = match_license_id(spdx_id, 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
+    write_license license_obj, path, opt[:format]
+
+    say 'Remember to read your license for any fields you might need to fill in.'
   end
 end

data/lib/rubygems/commands/license_command.rb

@@ -6,6 +6,8 @@ require 'json'
 
 # license gem plugin
 class Gem::Commands::LicenseCommand < Gem::Command
+  include Gem::License
+
   def initialize
     super('license', 'Download a license by SPDX id')
 
@@ -24,11 +26,15 @@ class Gem::Commands::LicenseCommand < Gem::Command
     add_option('-l', '--list', 'View all available licenses') do |_, options|
       options[:list] = true
     end
+
+    add_option('-f', '--format', 'Attempt to fill in values like year, author, and program name') do |_, options|
+      options[:format] = true
+    end
   end
 
   def execute
     if options[:list]
-      list = Gem::License.fetch_license_list
+      list = fetch_license_list
       just_size = list.collect { |lsc| lsc['licenseId'].length }.max
       list.each do |license|
         say(license['licenseId'].ljust(just_size) + ' - ' + license['name'])
@@ -37,7 +43,7 @@ class Gem::Commands::LicenseCommand < Gem::Command
     end
 
     id = options[:args].first || abort("USAGE: #{usage}")
-    Gem::License.download(id, options)
+    download(id, options)
   end
 
   def description

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem-license
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Carey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.69'
-description: Gem plugin to download a LICENSE file based on its shortname
+description: Gem plugin to download a LICENSE file based on its SPDX identifier
 email:
 - matthew.b.carey@gmail.com
 executables: []
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE