foobara-empty-ruby-project-generator 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdd94a071a7ea95a1a265d7b4b21ebf47def1bec403a37006a9532ad7c2d31d9
-  data.tar.gz: c2edf8c142844d267030c10acf2c28e0f1538c072aed8b81d7dfa33a2fe847ee
+  metadata.gz: 7e4a3e6022876d316da2d1151570016cefcc0a3e264fab8914f80c98a5884702
+  data.tar.gz: 2dcf65b9a6c3d55816a52c02258492544168f89debb55a1839ded3935460c976
 SHA512:
-  metadata.gz: 796b690590459387a46f7711125d5f63713eb4bcfa135954b6bef8e6bbdf0203fd4e9851a455b147e3bdaf582c6e5815a1df6f19256c53ea6b9ad3c21f2ca0fe
-  data.tar.gz: 58a03f74330318ac08d3d2c85ab7dcce3fab243dc0513c5b59eb8c8e4efba3a6000a19d8edd5d8648bd856d954074eb7b7be5156ffc6106d4ea467bee032f064
+  metadata.gz: '08542c35392d879154eb195d4ecf98a05d950d4a52857e3d05f4835a1c89454f798a038768cb34c0088b1e483ff939b161630610e6abbc8e01d1b1cc396daec7'
+  data.tar.gz: ddf08ce714ecd6f0c1b42f0674c1c8890930ad06a6801d5da9691e5a4d68506ba3335d80567ac314b2d409eded691681222d3816515fa6d1882919bcdf241150

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.1.0] - 2026-10-10
+
+- Add Foobara.start! to finish.rb.erb template
+- Eliminate an annoying deprecation warning
+- Use current Foobara version in generated gemspec
+- Set created GitHub repo's description to the --description value
+- Put the correct project name in README.md.erb output
+
 ## [1.0.5] - 2026-09-15
 
 - Adds ./local_data to generated .gitignore

data/README.md

@@ -1,49 +1,84 @@
 # Foobara::EmptyRubyProjectGenerator
 
-TODO: Delete this and the text below, and describe your gem
+Generates an empty Ruby project with RuboCop, RSpec, and GitHub Actions already wired up, so you can focus on writing your gem's code rather than setting up boilerplate code. 
 
-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/foobara/empty_ruby_project_generator`. To experiment with that code,
-run `bin/console` for an interactive prompt.
+The generated project is ideally meant to be used with Foobara however, it can also be used for non-Foobara projects by deleting Foobara-specific parts after generation. 
 
 ## 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.
+The `foobara-empty-ruby-project-generator` is part of the `foob` family of code generators. Installing the `foob` gem will therefore automatically bring in this generator along with all other foobara generators eliminating the need to install the `foobara-empty-ruby-project-generator` gem separately. 
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem directly in the terminal:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    `$ gem install foob`
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or add it to your Gemfile:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    `$ bundle add foob`
 
 ## Usage
 
-TODO: Write usage instructions here
+Run the generator to create a new project:
 
-## Development
+    `$ foob g ruby-project -n NAME [options]`
 
-```bash
-bundle config --global local.foobara /path/to/foobara
-bundle config set disable_local_branch_check true
-```
+The `-n` flag represents the name of the project to be generated and is required. It accepts either a plain project name or a name in the 
+`org/project` format:
 
-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.
+- **Individual account:** `-n my-gem` — creates a project with a single 
+  module e.g. `MyGem`
+- **Organization:** `-n my-org/my-gem` — creates a project with a nested 
+  module e.g. `MyOrg::MyGem` and uses `my-org` as the GitHub organization
 
-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).
+For a full list of available options run:
+
+    `$ foob g ruby-project --help`
+
+or
+
+    `$ foob help ruby-project`
+
+**Commonly used options:**
+
+| Flag | Description |
+|------|-------------|
+| `-n, --name` | Project name or org/project (required) |
+| `-d, --description` | Project description. Defaults to `"No description. Add one."` |
+| `-a, --author-names` | Author name(s) |
+| `--author-emails` | Author email(s) |
+| `-l, --license` | One of: `MIT`, `Apache-2.0`, `MPL-2.0`, `Apache-2.0 OR MIT` |
+| `-u, --use-git` | Initialize a git repository |
+| `--push-to-github` | Create a private GitHub repo and push to it |
+| `-o, --output-directory` | Where to generate the project. Defaults to the project name |
+
+**Example:**
+
+    `$ foob g ruby-project -n my-org/my-gem -d "Does something useful" -l MIT --use-git`
+
+The above generator example when run will put the project in the `my-org/my-gem` folder. 
+
+Upon running the generator, all projects will have the following structure:
+
+- `lib/` - Contains all files that are loaded via `require` and based on the name you provided when generating the project, this folder will be structured as either `lib/my_org/my_gem.rb` for an organisation project name OR `lib/my_gem.rb` for a plain project name.
+
+- `src/` - Contains your ruby gem code. This is a Foobara-specific convention whereby instead of putting all your code in the `lib/` folder, the actual implementation code lives in `src/` folder while the `lib/` folder is reserved for code that can be required. 
+
+If you used the `foobara-empty-ruby-project-generator` gem to generate a non-Foobara Ruby project, you can delete the `src/` folder and place all your code in the `lib/` folder as well as delete any associated Foobara-specific parts. 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub
-at https://github.com/[USERNAME]/foobara-empty_ruby_project_generator.
+Contributions in the form of PRs and issues are always welcome.
+
+To work on an existing issue or submit a PR:
+
+1. Fork the repo and clone it to your local machine
+2. Run `bundle install` to install dependencies
+3. Run `rake` to ensure that everything works as expected before making any changes. 
+4. Implement your changes and add tests where applicable
+5. Re-run `rake` to make sure that all tests and rubocop pass.
+6. Commit, push to GitHub and open a PR for review
 
 ## License
 
-This project is licensed under your choice of the Apache-2.0 license or the MIT license.
-See [LICENSE.txt](LICENSE.txt) for more info about licensing.
+This project is licensed under your choice of the Apache-2.0 license or 
+the MIT license. See [LICENSE.txt](LICENSE.txt) for more info.

data/src/generators/gemspec_generator.rb

@@ -12,6 +12,10 @@ module Foobara
           def target_path
             "#{kebab_case_full_project_name}.gemspec"
           end
+
+          def current_foobara_version
+            Gem.loaded_specs["foobara"].version
+          end
         end
       end
     end

data/src/manifests/project_config.rb

@@ -38,8 +38,12 @@ module Foobara
         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("::", "-")
+          org_part = if organization_name
+                       Util.kebab_case(organization_name)&.gsub("::", "-")
+                     end
+          project_part = if project_name
+                           Util.kebab_case(project_name).gsub("::", "-")
+                         end
 
           if org_part.nil? || org_part.empty?
             project_part

data/src/write_empty_ruby_project_to_disk.rb

@@ -1,5 +1,6 @@
 require "fileutils"
 require "extract_repo"
+require "shellwords"
 require_relative "generate_empty_ruby_project"
 
 module Foobara
@@ -197,7 +198,8 @@ module Foobara
 
           puts "pushing to github..."
 
-          cmd = "gh repo create --private #{project_config.org_slash_project_kebab}"
+          description = Shellwords.escape(project_config.description)
+          cmd = "gh repo create --private #{project_config.org_slash_project_kebab} --description #{description}"
           exit_status = run_cmd_and_write_output(cmd, raise_if_fails: false)
 
           unless exit_status&.success?

data/templates/README.md.erb

@@ -3,7 +3,7 @@
 TODO: Delete this and the text below, and describe your gem
 
 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/foobara/empty_ruby_project_generator`. To experiment with that code,
+into a gem. Put your Ruby code in the file `lib/<%= org_slash_project_underscore %>.rb`. To experiment with that code,
 run `bin/console` for an interactive prompt.
 
 

data/templates/boot/finish.rb.erb

@@ -28,3 +28,5 @@ end
 # simplecov:disable
 last.each { |f| require_relative f if File.exist?("#{__dir__}/#{f}") }
 # simplecov:enable
+
+Foobara.start!

data/templates/gemspec.gemspec.erb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-empty-ruby-project-generator
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Miles Georgi
@@ -29,7 +29,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.7.3
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -39,7 +39,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.7.3
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -47,6 +47,9 @@ dependencies:
   name: foobara-files-generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -54,6 +57,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0