bundlegem 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d25b0d1c8d8979da5e2f8354d8ee1ec927c103202a379ef5c02b221ab7f1f8aa
-  data.tar.gz: 180774ef2a0cebab93940a880921ab59279d1d831f7d31c6daf9c0a8c4a4d4c9
+  metadata.gz: 5caf6f6b8a9cff25ad3bc1521ed11b68a61ceab05541e8d1213e0424c0c24723
+  data.tar.gz: 3638cf2c466c2696f519b93b654d93d6e5d3a2b69ee41cfcf526d5b210a7e708
 SHA512:
-  metadata.gz: 6d8336a33e61ce573341936dbd8bd89586fd6302299c4d9111d0b50810ecdea01e668a6317344e0202c99fc423cc541db43f96afe5c8fbc351862ea7dbe9b2b1
-  data.tar.gz: 2ef917281a2f763ef4f78976740e10402591f64c956e4d6c7d921dc05497094cb4b3a923f6cc850ea9b12cbba041dc194a30b61c3929b2e98f9c1f6519871782
+  metadata.gz: 4382727026063302d8f8da7f8ac1bf91d542bc754e774339c65013273003cabe1c053dd66f787cd5761168ac4e75393bd97fa89eb7df2e2fc35945941321c43c
+  data.tar.gz: f05e38dc8cab4557cabbe12bb18e67aace4c9c776ac2c8fe1b1483829d67843184fb4bf1b5e56591954460c961b0a6985192b8491ac196b4a3975c2dd29b2450

data/lib/bundlegem/templates/cli_gem/#{name}.gemspec.tt

@@ -1,7 +1,5 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require '<%=config[:namespaced_path]%>/version'
+require_relative 'lib/<%=config[:namespaced_path]%>/version'
 
 Gem::Specification.new do |spec|
   spec.name          = <%=config[:name].inspect%>
@@ -9,12 +7,26 @@ Gem::Specification.new do |spec|
   spec.authors       = [<%=config[:author].inspect%>]
   spec.email         = [<%=config[:email].inspect%>]
 
-  spec.summary       = %q{TODO: Write a short summary, because Rubygems requires one.}
-  # spec.description   = %q{TODO: delete this line since you're in a hurry.}
+  spec.summary       = %q{A gem}
+
   spec.homepage      = "https://github.com/<%=config[:author]%>/<%=config[:name]%>"
-  # spec.license       = "MIT" # uncomment and replace with GPLv3, etc.
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://localhost.com" # prevents unexpected data loss
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://localhost.com"
+  spec.metadata["changelog_uri"] = "https://localhost.com"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  gemspec = File.basename(__FILE__)
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      (f == gemspec) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .gitlab-ci.yml appveyor Gemfile])
+    end
+  end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -22,7 +34,7 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "bundler", "~> <%= config[:bundler_version] %>"
 
   spec.add_development_dependency "bundler", "~> <%= config[:bundler_version] %>"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
 end

data/lib/bundlegem/templates/cli_gem/LICENSE.txt.tt

@@ -1,21 +1,3 @@
-The MIT License (MIT)
+TODO: Decide license and include here.
 
-Copyright (c) <%=Time.now.year%> <%=config[:author]%>
-
-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:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+If this message is visible, please open a GH issue and assume Copyright and closed source is the intent of this repo.

data/lib/bundlegem/templates/cli_gem/README.md.tt

@@ -1,39 +1,38 @@
 # <%=config[:constant_name]%>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/<%=config[:namespaced_path]%>`. To experiment with that code, run `bin/console` for an interactive prompt.
+TODO: Describe your gem/ CLI tool
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To install this from source, just run
 
-```ruby
-gem '<%=config[:name]%>'
-```
+    $ rake install
 
-And then execute:
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+As a cli, run `<%=config[:constant_name].downcase%>`
 
-    $ gem install <%=config[:name]%>
 
-## Usage
+## Development
 
-TODO: Write usage instructions here
+Install dependencies with...
 
-## Development
+    $ bundle
+
+Mark individual tests with `, current: true` and run them with...
+
+    $ rake c
+
+Run the entire unit test suite with...
+
+    $ rake
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.<% if config[:bin] %> Run `bundle exec <%= config[:name] %>` to use the code located in this directory, ignoring other installed copies of this gem.<% end %>
+Run the integration test suite with...
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    $ rake integration
 
-## Contributing
+If a CLI is being developed, see `exe/<%=config[:constant_name].downcase%>` and consider adopting Thor or its alternatives if this will be a heavy CLI tool.
 
-1. Fork it ( https://github.com/[my-github-username]/<%=config[:name]%>/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+For open source projects, releasing a new version is done with an update to the version number in `version.rb`.  Then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).  By default you'll need to tweak the gemspec file in root to enable pushes.

data/lib/bundlegem/templates/cli_gem/Rakefile.tt

@@ -1,6 +1,31 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.verbose = false
+  t.pattern = "spec/**/*_int.rb"
+end
+
+# this is for running tests that you've marked current... eg: it 'should work', :current => true do
+# I waffle between this work flow and the one defined in spec_helper.rb which uses focus: true
+# which overrides the entire test suite... not better
+RSpec::Core::RakeTask.new(:current) do |t|
+  t.verbose = false
+  t.pattern = 'spec/**/*_{spec,int}.rb'
+  t.rspec_opts = ['--tag current']
+end
+
+# alias for current
+RSpec::Core::RakeTask.new(:c) do |t|
+  t.verbose = false
+  t.pattern = 'spec/**/*_{spec,int}.rb'
+  t.rspec_opts = ['--tag current']
+end
 
-task :default => :spec
+task default: :spec

data/lib/bundlegem/templates/cli_gem/exe/#{name}.tt

@@ -2,4 +2,11 @@
 
 require "<%= config[:namespaced_path] %>"
 
-puts "I'm still just a stub cli ruby app"
+command = ARGV.count > 0 ? ARGV[0].chomp.strip : ''
+
+if command == "help" || command == "--help" || command == "-h"
+  puts <%= config[:constant_name] %>.help
+  return
+end
+
+puts <%= config[:constant_name] %>.main

data/lib/bundlegem/templates/cli_gem/lib/#{name}/config.rb.tt

@@ -0,0 +1,40 @@
+<%- config[:constant_array].each_with_index do |c,i| -%>
+<%= '  '*i %>module <%= c %>
+<%- end -%>
+
+  class Config
+
+    def initialize(c = {})
+      @root_folder = c[:root_folder]
+      @config_file = c[:config_file]
+      @database_url = c[:database_url]
+    end
+
+    def root_folder
+      @root_folder ||= gather_parameters('ROOT_FOLDER')
+    end
+
+    def config_file
+      @config_file ||= gather_parameters('CONFIG_FILE')
+    end
+
+    def database_url
+      @database_url ||= gather_parameters('DATABASE_URL')
+    end
+
+    # private
+
+    def gather_parameters(param_name)
+      ENV["<%=config[:constant_name].upcase%>_#{param_name.upcase}"] || default_constant_or_nil(param_name)
+    end
+
+    def default_constant_or_nil(param_name)
+      const_name = 'DEFAULT_' + param_name
+      root_module = Module.nesting.last
+      root_module.const_get(const_name) if root_module.const_defined?(const_name)
+    end
+  end
+
+<%- (config[:constant_array].size-1).downto(0) do |i| -%>
+<%= '  '*i %>end
+<%- end -%>

data/lib/bundlegem/templates/cli_gem/lib/#{name}/constants.rb.tt

@@ -0,0 +1,9 @@
+<%- config[:constant_array].each_with_index do |c,i| -%>
+<%= '  '*i %>module <%= c %>
+<%- end -%>
+  DEFAULT_ROOT_FOLDER = '..'
+  DEFAULT_CONFIG_FILE = '../env.yaml'
+  DEFAULT_DATABASE_URL = '..'
+<%- (config[:constant_array].size-1).downto(0) do |i| -%>
+<%= '  '*i %>end
+<%- end -%>

data/lib/bundlegem/templates/cli_gem/lib/#{name}.rb.tt

@@ -1,9 +1,26 @@
 require "<%=config[:namespaced_path]%>/version"
+require "<%=config[:namespaced_path]%>/constants"
+require "<%=config[:namespaced_path]%>/config"
+
 
 <%- config[:constant_array].each_with_index do |c,i| -%>
 <%= '  '*i %>module <%= c %>
 <%- end -%>
-<%= '  '*config[:constant_array].size %># Your code goes here...
+  # Your code goes here...
+  def self.main
+    "test"
+  end
+
+  def self.help
+    msg = <<-EOF
+<%=config[:constant_name].downcase%>
+TODO: Update this to be correct to this tool!
+Commands:
+  ls           - List things
+  run          - Run things
+  status       - Show status
+EOF
+  end
 <%- (config[:constant_array].size-1).downto(0) do |i| -%>
 <%= '  '*i %>end
 <%- end -%>

data/lib/bundlegem/templates/cli_gem/spec/#{name}/config_spec.rb.tt

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module <%= config[:constant_name] %>
+
+  describe Config do
+
+    before :each do
+      ENV['<%= config[:constant_name].upcase %>_ROOT_FOLDER'] = nil
+    end
+
+    after :each do
+      ENV['<%= config[:constant_name].upcase %>_ROOT_FOLDER'] = nil
+    end
+
+    it 'returns the ROOT_FOLDER set by the environment variable' do
+      ENV['<%= config[:constant_name].upcase %>_ROOT_FOLDER'] = "/tmp/blah"
+
+      c = Config.new
+
+      expect(c.root_folder).to eq("/tmp/blah")
+    end
+
+  end
+
+end

data/lib/bundlegem/templates/cli_gem/spec/#{name}_int.rb.tt

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+
+# This file ends in _int because it's an integration test and can use the file
+# system and network to assert the applications correctness
+
+module <%= config[:constant_name] %>
+
+  describe <%= config[:constant_name] %> do
+    it 'does something useful' do
+      result = <%= config[:constant_name] %>.main
+      expect(result).to eq("test")
+    end
+  end
+
+end

data/lib/bundlegem/templates/cli_gem/spec/#{name}_spec.rb.tt

@@ -1,11 +1,17 @@
 require 'spec_helper'
 
-describe <%= config[:constant_name] %> do
-  it 'has a version number' do
-    expect(<%= config[:constant_name] %>::VERSION).not_to be nil
-  end
 
-  it 'does something useful' do
-    expect(false).to eq(true)
+module <%= config[:constant_name] %>
+
+  describe <%= config[:constant_name] %> do
+    it 'has a version number' do
+      expect(<%= config[:constant_name] %>::VERSION).not_to be nil
+    end
+
+    it 'does something useful', current: true do
+      result = <%= config[:constant_name] %>.main
+      expect(result).to eq("test")
+    end
   end
+
 end

data/lib/bundlegem/templates/cli_gem/spec/data/sample_data.json.tt

@@ -0,0 +1 @@
+{ "I'm some sample data": "used in a test" }

data/lib/bundlegem/templates/newgem/#{name}.gemspec.tt

@@ -9,10 +9,16 @@ Gem::Specification.new do |spec|
   spec.authors       = [<%=config[:author].inspect%>]
   spec.email         = [<%=config[:email].inspect%>]
 
-  spec.summary       = %q{TODO: Write a short summary, because Rubygems requires one.}
+  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
   # spec.description   = %q{TODO: delete this line since you're in a hurry.}
   spec.homepage      = "https://github.com/<%=config[:author]%>/<%=config[:name]%>"
-  # spec.license       = "MIT" # uncomment this line if MIT is the best license for your situation
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://localhost.com" # prevents unexpected data loss
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://localhost.com"
+  spec.metadata["changelog_uri"] = "https://localhost.com"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"

data/lib/bundlegem/templates/newgem/Gemfile.tt

@@ -1,4 +1,10 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in <%=config[:name]%>.gemspec
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in blah.gemspec
 gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/lib/bundlegem/templates/newgem/README.md.tt

@@ -1,5 +1,7 @@
 # <%=config[:constant_name]%>
 
+NOTE: I'm tempted to deprecate this in favor of `cli_gem`.  I'm going to make updates to that exclusively in the meantime.
+
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/<%=config[:namespaced_path]%>`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 TODO: Delete this and the text above, and describe your gem

data/lib/bundlegem/version.rb

@@ -1,3 +1,3 @@
 module Bundlegem
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundlegem
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - TheNotary
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -129,13 +129,11 @@ files:
 - lib/bundlegem/templates/c_extension_gem/spec/#{name}_spec.rb.tt
 - lib/bundlegem/templates/c_extension_gem/spec/spec_helper.rb.tt
 - lib/bundlegem/templates/cli_gem/#{name}.gemspec.tt
-- lib/bundlegem/templates/cli_gem/.travis.yml.tt
 - lib/bundlegem/templates/cli_gem/CODE_OF_CONDUCT.md.tt
 - lib/bundlegem/templates/cli_gem/Gemfile.tt
 - lib/bundlegem/templates/cli_gem/LICENSE.txt.tt
 - lib/bundlegem/templates/cli_gem/README.md.tt
 - lib/bundlegem/templates/cli_gem/Rakefile.tt
-- lib/bundlegem/templates/cli_gem/bin/#{name}.tt
 - lib/bundlegem/templates/cli_gem/bin/console.tt
 - lib/bundlegem/templates/cli_gem/changelog.tt
 - lib/bundlegem/templates/cli_gem/exe/#{name}.tt
@@ -144,9 +142,14 @@ files:
 - lib/bundlegem/templates/cli_gem/ext/#{name}/extconf.rb.tt
 - lib/bundlegem/templates/cli_gem/gitignore.tt
 - lib/bundlegem/templates/cli_gem/lib/#{name}.rb.tt
+- lib/bundlegem/templates/cli_gem/lib/#{name}/config.rb.tt
+- lib/bundlegem/templates/cli_gem/lib/#{name}/constants.rb.tt
 - lib/bundlegem/templates/cli_gem/lib/#{name}/version.rb.tt
 - lib/bundlegem/templates/cli_gem/rspec.tt
+- lib/bundlegem/templates/cli_gem/spec/#{name}/config_spec.rb.tt
+- lib/bundlegem/templates/cli_gem/spec/#{name}_int.rb.tt
 - lib/bundlegem/templates/cli_gem/spec/#{name}_spec.rb.tt
+- lib/bundlegem/templates/cli_gem/spec/data/sample_data.json.tt
 - lib/bundlegem/templates/cli_gem/spec/spec_helper.rb.tt
 - lib/bundlegem/templates/newgem/#{name}.gemspec.tt
 - lib/bundlegem/templates/newgem/.gitignore.tt
@@ -186,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: this gem makes more gems!

data/lib/bundlegem/templates/cli_gem/.travis.yml.tt

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - <%= RUBY_VERSION %>

data/lib/bundlegem/templates/cli_gem/bin/#{name}.tt

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-require "<%= config[:namespaced_path] %>"