foobara-empty-ruby-project-generator 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19cd84cd08933d8e04ad23b06e2599d7830457b17a39226306ea1d40b9f4462a
-  data.tar.gz: 4352afd26444e91dddcf218986c80b31620676cf6b7bf75bbf5df7cfcf8d3522
+  metadata.gz: a2be938e5b3deffab94dc479791b2071210c23930e04637c07ac39ff23c12248
+  data.tar.gz: 9f709cb0ff03da216182c1c33a7f80fa8256f3ffe10cde4b6f252942ba5192c7
 SHA512:
-  metadata.gz: de5e98645b90f47673eb1000f0ee8e25c713f7d337f275f142d31cbf97acb2aaece20d8d26f5d5616b65651a68d6912f2e451847152d0fae7fad97c242c33042
-  data.tar.gz: 702a6b4e95723135b355ba69a34ec583d95e728d954f65ebfbd68e0ee19241838d1e16f04957fbbb40f2e2237aafa9002642eafcbb6b3da58969a54b7c4e0da7
+  metadata.gz: a2a3af69340a2306a0c9e136579a9b952666ab630a0288270f3a294e98a15fe74144e26729714ab07c58918cc38a394b6255124963be1899e456e3333975fa51
+  data.tar.gz: 5fb6402ffbe779151d93e180360d772c4a973b3034311743306025e7fd4e95ed43200a49f8a988cae4203475d3aa10a623669de8bac0e4dda06c21eabf36fb1c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.0.15] - 2025-04-08
+
+- Improve generated README.md
+
 ## [0.0.14] - 2025-02-19
 
 - Bump Ruby to 3.4.2

data/src/manifests/project_config.rb

@@ -31,6 +31,10 @@ module Foobara
           Util.kebab_case(full_project_path.join)
         end
 
+        def gem_name
+          kebab_case_full_project_name
+        end
+
         def org_slash_project_kebab(organization_name = self.organization_name, project_name = self.project_name)
           org_part = Util.kebab_case(organization_name)&.gsub("::", "-")
           project_part = Util.kebab_case(project_name).gsub("::", "-")
@@ -120,7 +124,11 @@ module Foobara
         end
 
         def homepage_url
-          @homepage_url ||= "https://github.com/#{org_slash_project_kebab(organization_name, project_module_name)}"
+          github_url
+        end
+
+        def github_url
+          @github_url ||= "https://github.com/#{org_slash_project_kebab(organization_name, project_module_name)}"
         end
 
         private

data/templates/Gemfile.erb

@@ -5,13 +5,13 @@ ruby <%= full_project_name %>::MINIMUM_RUBY_VERSION
 
 gemspec
 
-gem "foobara-dotenv-loader"
+gem "foobara-dotenv-loader", "~> 0.0.1"
 
 gem "rake"
 
 group :development do
   gem "foob"
-  gem "foobara-rubocop-rules"
+  gem "foobara-rubocop-rules", "~> 0.0.1"
   gem "guard-rspec"
   gem "rubocop-rake"
   gem "rubocop-rspec"
@@ -26,7 +26,7 @@ group :development, :test do
 end
 
 group :test do
-  gem "foobara-spec-helpers"
+  gem "foobara-spec-helpers", "~> 0.0.1"
   gem "rspec"
   gem "rspec-its"
   gem "ruby-prof"

data/templates/README.md.erb

@@ -1,4 +1,4 @@
-# Foobara::EmptyRubyProjectGenerator
+# <%= full_module_name %>
 
 TODO: Delete this and the text below, and describe your gem
 
@@ -6,43 +6,28 @@ Welcome to your new gem! In this directory, you'll find the files you need to be
 into a gem. Put your Ruby code in the file `lib/foobara/empty_ruby_project_generator`. To experiment with that code,
 run `bin/console` for an interactive prompt.
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it
-to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with
-instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Installation
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Typical stuff: add `gem "<%= gem_name %>"` to your Gemfile or .gemspec file. Or even just
+`gem install <%= gem_name %>` if just playing with it directly in scripts.
 
 ## Usage
 
 TODO: Write usage instructions here
 
-## Development
+```ruby
+#!/usr/bin/env ruby
 
-If using Foobara locally, then run the following (TODO: make this no-longer necessary.)
+require "foobara/load_dotenv"
+Foobara::LoadDotenv.run!(dir: __dir__)
 
-```bash
-bundle config set disable_local_branch_check true
+TODO: some example code
 ```
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
-also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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`, which will create a git tag for the version,
-push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub
-at https://github.com/[USERNAME]/foobara-empty_ruby_project_generator.
+at <%= github_url %>
 
 ## License
 

data/templates/gemspec.gemspec.erb

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
     "CHANGELOG.md"
   ]
 
-  spec.add_dependency "foobara"
+  spec.add_dependency "foobara", "~> 0.0.94"
 
   spec.require_paths = ["lib"]
   spec.metadata["rubygems_mfa_required"] = "true"

metadata

@@ -1,56 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: foobara-empty-ruby-project-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: extract-repo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: foobara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.94
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.94
 - !ruby/object:Gem::Dependency
   name: foobara-files-generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
 email:
 - azimux@gmail.com
 executables: []
@@ -85,7 +85,6 @@ files:
 - src/manifests/project_config.rb
 - src/types/extract_inputs.rb
 - src/write_empty_ruby_project_to_disk.rb
-- templates/.bundle/config
 - templates/.github/workflows/ci.yml.erb
 - templates/.gitignore.erb
 - templates/.rspec
@@ -139,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Generates empty ruby project boilerplate code from a template
 test_files: []

data/templates/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_DISABLE_LOCAL_BRANCH_CHECK: "true"