opensource 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10f6493f56895d2dbfaa012c2203ae1b6c08aa3c0a12144d6cc6e9e3a838eaea
-  data.tar.gz: 5b54333690d71a3fb7c16684b477a7880d6ff4d117024ec118eaa07d150e787c
+  metadata.gz: 88a46d31221547e064e035afd8912a8330ee23556bc1f68f4e3c01041dc6e318
+  data.tar.gz: 4f75381c7b2d05615bf37815991da3319a1fde8c69451dba6d8869dac4a7d1f9
 SHA512:
-  metadata.gz: 926043857057cef9c8f676f08160226fa2b231898f20713567a8454496d1a3329442eeaa2108e69813f8fb63f5551c668d0dba1939ea287a62c6b55fa17e0638
-  data.tar.gz: e8609f1cd3ca7b7aeac98645a5e1b354ca424be23441fa0da6e51c41816345b02333694c5305ee0d5169b3b5a00287da0aac294ea5200b8f2ba04f8524f1e305
+  metadata.gz: 212d14d940e64a30aefb70823dc7907d85dd46cf434199e79bcf18d1fa88a2b4be0b572d595baf81236263e68a9d5b78ab431f2b6fbb27f0d23e2ad7afccb0c2
+  data.tar.gz: a8b75d09d62aef6de3fe861b36ec1f02003aa95bdd4218f1b7d1122207595539bd020ac3a83e63fdcf75ceb5e324ec534dfcfa9d65a8a518cebe9a19fe9376a5

data/.github/workflows/ci.yml

@@ -19,8 +19,8 @@ jobs:
           - "3.4"
           - "4.0"
     steps:
-      - uses: actions/checkout@v6
-      - uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v7.0.1
+      - uses: ruby/setup-ruby@v1.321.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true

data/History.md

@@ -1,4 +1,10 @@
 
+2.1.0 / 2026-07-25
+==================
+
+  * handle missing credentials gracefully - improve ux
+  * Upgrade to latest deps
+
 2.0.0 / 2026-07-19
 ==================
 

data/exe/opensource

@@ -39,15 +39,21 @@ option_parser = OptionParser.new do |opts|
 end
 
 begin
-  option_parser.parse!
+  begin
+    option_parser.parse!
+  rescue OptionParser::ParseError => e
+    raise OpenSource::OptionError, e.message
+  end
+
   if options.empty?
     OpenSource.logger.info(option_parser)
     exit 0
   end
 
-  OpenSource::License::Generator.new(options).generate
+  OpenSource.with_owner_credentials do
+    OpenSource::License::Generator.new(options).generate
+  end
 rescue OpenSource::Error => e
-  # TODO: Make sure the above call raises only OpenSource::Error
   OpenSource.logger.fatal("Error: #{e.message}")
   exit 1
 end

data/lib/open_source/error.rb

@@ -1,7 +1,8 @@
 module OpenSource
-  module Error
-    def self.exception(*args)
-      RuntimeError.new(*args).extend(self)
-    end
-  end
+  class Error < StandardError; end
+  class OptionError < Error; end
+  class ConfigError < Error; end
+  class MissingCredentialsError < ConfigError; end
+  class LicenseError < Error; end
+  class FileError < Error; end
 end

data/lib/open_source/license/generator.rb

@@ -6,7 +6,7 @@ module OpenSource
       def initialize(options)
         @options = options
         @owner = Owner.new
-        @license = ERB.new(File.read("#{File.expand_path("../templates", __FILE__)}/#{@options[:license]}.erb"))
+        @license = load_license_template
       end
 
       def generate
@@ -15,16 +15,62 @@ module OpenSource
       end
 
     private
+      def load_license_template
+        unless OpenSource::SUPPORTED_LICENSES.include?(@options[:license])
+          raise LicenseError, "Unsupported license #{@options[:license].inspect}. Supported licenses: #{OpenSource::SUPPORTED_LICENSES.join(', ')}"
+        end
+
+        ERB.new(File.read(template_path))
+      rescue OpenSource::Error
+        raise
+      rescue SystemCallError => ex
+        raise LicenseError, "Unable to read #{@options[:license]} license template: #{ex.message}"
+      end
+
+      def template_path
+        "#{File.expand_path("../templates", __FILE__)}/#{@options[:license]}.erb"
+      end
+
       def create_license_file
-        f = File.new("#{Dir.pwd}/LICENSE", 'w')
-        f.write(@license.result(binding))
-        f.close
+        license_content = render_license
+
+        File.open(license_path, 'w') do |file|
+          file.write(license_content)
+        end
+      rescue OpenSource::Error
+        raise
+      rescue SystemCallError => ex
+        raise FileError, "Unable to write #{license_path}: #{ex.message}"
       end
 
       def append_to_file
-        File.open(File.expand_path(@options[:append]), 'a') do |f|
-          f << "\n## License\n\n#{@license.result(binding)}"
+        append_path = File.expand_path(@options[:append])
+        license_content = render_license(markdown: true)
+
+        File.open(append_path, 'a') do |file|
+          file << "\n## License\n\n#{license_content}"
         end
+      rescue OpenSource::Error
+        raise
+      rescue SystemCallError => ex
+        raise FileError, "Unable to append license to #{append_path}: #{ex.message}"
+      end
+
+      def license_path
+        "#{Dir.pwd}/LICENSE"
+      end
+
+      def render_license(markdown: false)
+        previous_owner_email = @owner_email
+        @owner_email = markdown ? @owner.markdown_supported_email : @owner.license_email
+
+        @license.result(binding)
+      rescue OpenSource::Error
+        raise
+      rescue StandardError => ex
+        raise LicenseError, "Unable to render #{@options[:license]} license: #{ex.message}"
+      ensure
+        @owner_email = previous_owner_email
       end
     end
   end

data/lib/open_source/license/owner.rb

@@ -4,15 +4,15 @@ 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}")
+        File.open(CONFIG_PATH, 'w') do |config_file|
+          config_file.write(YAML.dump(credentials))
+        end
+      rescue SystemCallError => ex
+        raise ConfigError, "Unable to write #{CONFIG_PATH}: #{ex.message}"
       end
 
       def credentials
-        @credentials ||= YAML.load_file(CONFIG_PATH)
+        @credentials ||= load_credentials
       end
 
       def email
@@ -23,9 +23,43 @@ module OpenSource
         "<#{credentials[:email]}>"
       end
 
+      def license_email
+        "<#{credentials[:email]}>"
+      end
+
       def name
         credentials[:name]
       end
+
+    private
+      def load_credentials
+        credentials = YAML.load_file(CONFIG_PATH)
+        credentials = normalize_credentials(credentials)
+
+        unless credentials.key?(:name) && credentials.key?(:email)
+          raise ConfigError, "Invalid configuration in #{CONFIG_PATH}; run `opensource --setup` to recreate it"
+        end
+
+        credentials
+      rescue OpenSource::Error
+        raise
+      rescue Errno::ENOENT
+        raise MissingCredentialsError, "Missing #{CONFIG_PATH}; run `opensource --setup` first"
+      rescue Psych::Exception => ex
+        raise ConfigError, "Unable to parse #{CONFIG_PATH}: #{ex.message}"
+      rescue SystemCallError => ex
+        raise ConfigError, "Unable to read #{CONFIG_PATH}: #{ex.message}"
+      end
+
+      def normalize_credentials(credentials)
+        unless credentials.is_a?(Hash)
+          raise ConfigError, "Invalid configuration in #{CONFIG_PATH}; run `opensource --setup` to recreate it"
+        end
+
+        credentials.each_with_object({}) do |(key, value), normalized|
+          normalized[key.to_sym] = value if key.respond_to?(:to_sym)
+        end
+      end
     end
   end
 end

data/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 %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
+Copyright <%= Time.now.year %> <%= @owner.name %> <%= @owner_email %>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/open_source/license/templates/bsd.erb

@@ -1,4 +1,4 @@
-Copyright (c) <%= Time.now.year %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
+Copyright (c) <%= Time.now.year %> <%= @owner.name %> <%= @owner_email %>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/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 %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
+    Copyright (C) <%= Time.now.year %> <%= @owner.name %> <%= @owner_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 %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
+    Copyright (C) <%= Time.now.year %> <%= @owner.name %> <%= @owner_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/lib/open_source/license/templates/isc.erb

@@ -1,5 +1,5 @@
 ISC License (ISC)
-Copyright (c) <%= Time.now.year %>, <%= @owner.name %> <%= @owner.markdown_supported_email %>
+Copyright (c) <%= Time.now.year %>, <%= @owner.name %> <%= @owner_email %>
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 

data/lib/open_source/license/templates/mit.erb

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) <%= Time.now.year %> <%= @owner.name %> <%= @owner.markdown_supported_email %>
+Copyright (c) <%= Time.now.year %> <%= @owner.name %> <%= @owner_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/version.rb

@@ -1,3 +1,3 @@
 module OpenSource
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/lib/open_source.rb

@@ -27,4 +27,14 @@ module OpenSource
     owner = License::Owner.new
     owner.credentials = owner_credentials
   end
+
+  def self.with_owner_credentials(interactive: $stdin.tty?)
+    yield
+  rescue MissingCredentialsError
+    raise unless interactive
+
+    OpenSource.logger.info("Owner credentials are not set. Let's set them up now.")
+    setup_owner_credentials
+    yield
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensource
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Mohnish Thallavajhula