foobara-foobify-rails-app 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7671f6685f25a6e04db0faf3636a1c814494d37eaa23c1a591df8940c6e56ee8
+  data.tar.gz: 1f69816051fc9768adbcd9eea80b4bbf9f71908ce2b58b7a8071dc8631c2f4a1
+SHA512:
+  metadata.gz: 87e65aa73f4ed9a989c80a966eac8e669f208c8669e3948572c83f8597f999c39c6d1a1b479e12d11da66841908271d598ac91ce820b370feb339ce4338ee8d5
+  data.tar.gz: 1c9113d570f7b95f55a7db4e05fdcc198207fca42265c64e3067f91d1bf387f87e1a6eb24075f689c19fd5b36d56964b554f9b845f2e26654be40bc323701b18

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.0.7] - 2025-12-15
+
+- Initial release
+
+## [0.0.0] - 2025-12-04
+
+- Project birth

data/LICENSE-MPL-2.0.txt

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

data/LICENSE.txt

@@ -0,0 +1,9 @@
+This project is licensed under the MPL-2.0 license.
+
+
+  MPL-2.0 License: LICENSE-MPL-2.0.txt or https://www.mozilla.org/MPL/2.0/
+
+
+This is equivalent to the following SPDX License Expression: MPL-2.0
+
+Copyright (c) 2025 Miles Georgi

data/README.md

@@ -0,0 +1,70 @@
+# FoobifyRailsApp
+
+This is a code generator for quickly wiring up foobara to an existing Rails application.
+
+## Installation
+
+Normally, you would just use this with `foob` so you would install `foob` however you would, such as
+adding `foob` to the `:development` section of your Gemfile or maybe even just `gem install foob`.
+
+If you want to use this code generator outside of `foob` you can do the typical stuff like adding
+`gem "foobara-foobify-rails-app"` to your Gemfile or .gemspec file.
+
+## Usage
+
+### Using via `foob`
+
+You can see the options with `foob help foobify-rails-app` or `foob h foobify-rails-app`:
+
+```
+$ foob help foobify-rails-app
+```
+
+#### Using foobara as a service-object solution in an existing Rails application
+
+You would only need to run it with:
+
+```
+$ foob g foobify-rails-app
+```
+
+TODO: Finish this up once deployed and added to `foob`
+
+If you're new to Foobara and want a sample command generated, you can run:
+
+#### Exposing Foobara through the Rails router with foobara-rails-command-generator
+
+If you want to expose your Foobara commands such that they can be used by external tools like
+code generators (to generate a TypeScript SDK, for example), MCP servers, etc, then run:
+
+TODO
+
+#### Letting ActiveRecord Models be used as if they were Foobara types
+
+You can run:
+
+This will allow you to use active record as types like so:
+
+```ruby
+TODO
+
+```
+
+You can do this without `foobara-active-record-type` and Foobara will still guarantee that what is
+passed in is an instance of that active record class. But with `foobara-active-record-type` you can
+get additional foobara-entity-like behaviors, such as automatically casting primary keys to records
+and being able to make use of the record attributes in code generators if, for example, you wanted
+to quickly generate a TypeScript React form as a starting point for working with your 
+ActiveRecord class.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub
+at https://github.com/foobara/foobify-rails-app
+
+You can find a contributing guide in the foobara monorepo here: 
+https://github.com/foobara/foobara/blob/main/CONTRIBUTING.md
+
+## License
+
+This project is licensed under the MPL-2.0 license. Please see LICENSE.txt for more info.

data/lib/foobara/foobify_rails_app.rb

@@ -0,0 +1,3 @@
+require "foobara/util"
+
+Foobara::Util.require_directory "#{__dir__}/../../src"

data/src/foobify_rails_app_config.rb

@@ -0,0 +1,37 @@
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      class FoobifyRailsAppConfig < Foobara::Model
+        attributes do
+          include_sample_command :boolean, default: true
+          use_rails_command_connector :boolean,
+                                      default: false,
+                                      description: "Do you want to expose commands through the rails " \
+                                                   "router directly instead of running them in controller actions?"
+          use_active_record_type :boolean,
+                                 default: false,
+                                 description: "Do you want to treat ActiveRecord classes like Foobara entities? " \
+                                              "This means automatically casting primary keys to records and " \
+                                              "being able to expose their attributes via command connectors"
+          rspec :boolean, default: false
+        end
+
+        def use_active_record_type?
+          use_active_record_type
+        end
+
+        def use_rails_command_connector?
+          use_rails_command_connector
+        end
+
+        def use_rspec?
+          rspec
+        end
+
+        def include_sample_command?
+          include_sample_command
+        end
+      end
+    end
+  end
+end

data/src/generate_foobified_rails_files.rb

@@ -0,0 +1,51 @@
+require "pathname"
+
+require_relative "foobify_rails_app_config"
+
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      class GenerateFoobifiedRailsFiles < Foobara::Generators::Generate
+        class MissingManifestError < RuntimeError; end
+
+        possible_error MissingManifestError
+
+        inputs FoobifyRailsAppConfig
+
+        def execute
+          include_non_templated_files
+
+          add_initial_elements_to_generate
+
+          each_element_to_generate do
+            generate_element
+          end
+
+          paths_to_source_code
+        end
+
+        attr_accessor :manifest_data
+
+        def base_generator
+          Generators::BaseGenerator
+        end
+
+        # TODO: delegate this to base_generator
+        def templates_dir
+          # TODO: implement this?
+          # :nocov:
+          "#{__dir__}/../templates"
+          # :nocov:
+        end
+
+        def add_initial_elements_to_generate
+          elements_to_generate << foobify_rails_app_config
+        end
+
+        def foobify_rails_app_config
+          @foobify_rails_app_config ||= FoobifyRailsAppConfig.new(inputs)
+        end
+      end
+    end
+  end
+end

data/src/generators/base_generator.rb

@@ -0,0 +1,38 @@
+require "foobara/files_generator"
+
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      module Generators
+        class BaseGenerator < Foobara::FilesGenerator
+          class << self
+            def manifest_to_generator_classes(manifest)
+              case manifest
+              when FoobifyRailsAppConfig
+                [
+                  Generators::GemfileGenerator,
+                  ConfigApplicationGenerator,
+                  SampleCommandGenerator,
+                  SampleCommandSpecGenerator,
+                  RoutesGenerator
+                ]
+              else
+                # :nocov:
+                raise "Not sure how build a generator for a #{manifest}"
+                # :nocov:
+              end
+            end
+          end
+
+          alias foobify_rails_app_config relevant_manifest
+
+          def templates_dir
+            # :nocov:
+            "#{__dir__}/../../templates"
+            # :nocov:
+          end
+        end
+      end
+    end
+  end
+end

data/src/generators/config_application_generator.rb

@@ -0,0 +1,42 @@
+require_relative "base_generator"
+
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      module Generators
+        class ConfigApplicationGenerator < BaseGenerator
+          def applicable?
+            File.exist?(template_path) && application_rb_contents !~ /Rails\.root\.join.*\bapp\b.*\bcommands\b/
+          end
+
+          def template_path
+            "config/application.rb"
+          end
+
+          def target_path
+            template_path
+          end
+
+          def generate(_elements_to_generate)
+            match = application_rb_contents.match(/class\s+Application\s*<.*Application\b/)
+
+            if match
+              new_entry = '    config.eager_load_paths << Rails.root.join("app", "commands")'
+
+              "#{match.pre_match}\n#{match}\n#{new_entry}#{match.post_match}"
+            else
+              # TODO: maybe print a warning and return the original Gemfile
+              # :nocov:
+              raise "Not sure how to inject foobara into the Gemfile"
+              # :nocov:
+            end
+          end
+
+          def application_rb_contents
+            File.read(template_path)
+          end
+        end
+      end
+    end
+  end
+end

data/src/generators/gemfile_generator.rb

@@ -0,0 +1,66 @@
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      module Generators
+        class GemfileGenerator < BaseGenerator
+          def applicable?
+            return false unless File.exist?(template_path)
+
+            need_to_add_foobara? ||
+              need_to_add_foobara_active_record_type? ||
+              need_to_add_foobara_rails_command_connector?
+          end
+
+          def need_to_add_foobara?
+            gemfile_contents !~ /^\s*gem\s*["']foobara\b["']/
+          end
+
+          def need_to_add_foobara_active_record_type?
+            if foobify_rails_app_config.use_active_record_type?
+              gemfile_contents !~ /^\s*gem\s*["']foobara-active-record-type\b["']/
+            end
+          end
+
+          def need_to_add_foobara_rails_command_connector?
+            if foobify_rails_app_config.use_rails_command_connector?
+              gemfile_contents !~ /^\s*gem\s*["']foobara-rails-command-connector\b["']/
+            end
+          end
+
+          def template_path
+            "Gemfile"
+          end
+
+          def target_path
+            template_path
+          end
+
+          def generate(_elements_to_generate)
+            match = gemfile_contents.match(/^gem\s/)
+
+            if match
+              new_entries = []
+
+              new_entries << 'gem "foobara", "<= 2.0.0"' if need_to_add_foobara?
+              new_entries << 'gem "foobara-active-record-type"' if need_to_add_foobara_active_record_type?
+              new_entries << 'gem "foobara-rails-command-connector"' if need_to_add_foobara_rails_command_connector?
+
+              new_entry = new_entries.join("\n")
+
+              "#{match.pre_match}\n#{new_entry}\n#{match}#{match.post_match}"
+            else
+              # TODO: maybe print a warning and return the original Gemfile
+              # :nocov:
+              raise "Not sure how to inject foobara into the Gemfile"
+              # :nocov:
+            end
+          end
+
+          def gemfile_contents
+            File.read(template_path)
+          end
+        end
+      end
+    end
+  end
+end

data/src/generators/routes_generator.rb

@@ -0,0 +1,59 @@
+require_relative "base_generator"
+
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      module Generators
+        class RoutesGenerator < BaseGenerator
+          def applicable?
+            use_rails_command_connector? &&
+              File.exist?(template_path) &&
+              routes_rb_contents !~ /require.*foobara\/rails_command_connector/
+          end
+
+          def template_path
+            "config/routes.rb"
+          end
+
+          def target_path
+            template_path
+          end
+
+          def generate(_elements_to_generate)
+            with_requires_prepended = <<~HERE
+              require "foobara/rails_command_connector"
+              # require "foobara/auth_http"
+              # Foobara::CommandConnectors::RailsCommandConnector.new(authenticator: Foobara::AuthHttp::BearerAuthenticator)
+              Foobara::CommandConnectors::RailsCommandConnector.new
+              require "foobara/rails/routes"
+            HERE
+
+            with_requires_prepended = "#{with_requires_prepended}\n#{routes_rb_contents}"
+
+            match = with_requires_prepended.match(/Rails.application.routes.draw do/)
+
+            if match
+              # You can hit /run/ConstructGreeting or /help/ConstructGreeting
+              new_entry = "  command ConstructGreeting"
+
+              unless include_sample_command?
+                new_entry = "# #{new_entry}"
+              end
+
+              "#{match.pre_match}\n#{match}\n#{new_entry}#{match.post_match}"
+            else
+              # TODO: maybe print a warning and return the original Gemfile
+              # :nocov:
+              raise "Not sure how to inject foobara into the Gemfile"
+              # :nocov:
+            end
+          end
+
+          def routes_rb_contents
+            File.read(template_path)
+          end
+        end
+      end
+    end
+  end
+end

data/src/generators/sample_command_generator.rb

@@ -0,0 +1,19 @@
+require_relative "base_generator"
+
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      module Generators
+        class SampleCommandGenerator < BaseGenerator
+          def applicable?
+            foobify_rails_app_config.include_sample_command?
+          end
+
+          def template_path
+            ["app", "commands", "construct_greeting.rb.erb"]
+          end
+        end
+      end
+    end
+  end
+end

data/src/generators/sample_command_spec_generator.rb

@@ -0,0 +1,20 @@
+require_relative "base_generator"
+
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      module Generators
+        class SampleCommandSpecGenerator < BaseGenerator
+          def applicable?
+            foobify_rails_app_config.include_sample_command? &&
+              foobify_rails_app_config.use_rspec?
+          end
+
+          def template_path
+            ["spec", "commands", "construct_greeting_spec.rb.erb"]
+          end
+        end
+      end
+    end
+  end
+end

data/src/write_foobified_rails_files_to_disk.rb

@@ -0,0 +1,99 @@
+require_relative "generate_foobified_rails_files"
+
+module Foobara
+  module Generators
+    module FoobifyRailsApp
+      class WriteFoobifiedRailsFilesToDisk < Foobara::Generators::WriteGeneratedFilesToDisk
+        class << self
+          def generator_key
+            "foobify-rails-app"
+          end
+        end
+
+        depends_on GenerateFoobifiedRailsFiles
+
+        inputs do
+          foobify_rails_app_config FoobifyRailsAppConfig, default: FoobifyRailsAppConfig.new
+          # TODO: should be able to delete this and inherit it
+          output_directory :string
+        end
+
+        def execute
+          generate_file_contents
+          write_all_files_to_disk
+          run_post_generation_tasks
+
+          stats
+        end
+
+        def output_directory
+          inputs[:output_directory] || default_output_directory
+        end
+
+        def default_output_directory
+          "."
+        end
+
+        def generate_file_contents
+          puts "generating files..."
+          self.paths_to_source_code = run_subcommand!(GenerateFoobifiedRailsFiles,
+                                                      foobify_rails_app_config.attributes)
+        end
+
+        def run_post_generation_tasks
+          Dir.chdir output_directory do
+            bundle_install
+            rubocop_autocorrect
+          end
+        end
+
+        # TODO: is this not in the base class?
+        def bundle_install
+          unless File.exist?("Gemfile")
+            # :nocov:
+            return
+            # :nocov:
+          end
+
+          puts "bundling..."
+          cmd = "bundle install"
+
+          Bundler.with_unbundled_env do
+            Open3.popen3(cmd) do |_stdin, _stdout, stderr, wait_thr|
+              exit_status = wait_thr.value
+
+              unless exit_status.success?
+                # :nocov:
+                warn "WARNING: could not #{cmd}\n#{stderr.read}"
+                # :nocov:
+              end
+            end
+          end
+        end
+
+        # TODO: is this not in the base class?
+        def rubocop_autocorrect
+          unless File.exist?(".rubocop.yml")
+            # :nocov:
+            return
+            # :nocov:
+          end
+
+          puts "linting..."
+          cmd = "bundle exec rubocop --no-server -A"
+
+          Bundler.with_unbundled_env do
+            Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
+              exit_status = wait_thr.value
+              unless exit_status.success?
+                # :nocov:
+                warn "WARNING: could not #{cmd}.\n#{stdout.read}\n#{stderr.read}"
+                # :nocov:
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/templates/app/commands/construct_greeting.rb.erb

@@ -0,0 +1,57 @@
+class ConstructGreeting < Foobara::Command
+  description "Takes an optional salutation and greetee to greet and constructs a greeting"
+
+  inputs do
+    salutation :string, default: "hello"
+    greetee :string, default: "world"
+  end
+
+  result :string
+
+  possible_input_error :salutation, :threatening_to_capybaras,
+                       context: { threatening_salutation: :string },
+                       message: "Do not hiss around our capybaras!"
+  possible_error :greeting_overreach,
+                 context: { greetee: :string },
+                 message: "Can we keep custom salutations within this galaxy, please?"
+
+  def execute
+    normalize_greetee
+    normalize_salutation
+
+    check_for_greeting_overreach
+
+    build_greeting
+
+    greeting
+  end
+
+  def validate
+    if salutation.strip =~ /\s*h*i*ss+\s*/i
+      add_input_error :salutation,
+                      :threatening_to_capybaras,
+                      threatening_salutation: salutation
+
+    end
+  end
+
+  attr_accessor :greeting, :normalized_salutation, :normalized_greetee
+
+  def normalize_greetee
+    self.normalized_greetee = greetee.strip.capitalize
+  end
+
+  def check_for_greeting_overreach
+    if normalized_salutation != "Hello" && normalized_greetee == "Universe"
+      add_runtime_error :greeting_overreach, greetee:
+    end
+  end
+
+  def normalize_salutation
+    self.normalized_salutation = salutation.strip.capitalize
+  end
+
+  def build_greeting
+    self.greeting = "#{normalized_salutation}, #{normalized_greetee}!"
+  end
+end

data/templates/spec/commands/construct_greeting_spec.rb.erb

@@ -0,0 +1,56 @@
+RSpec.describe ConstructGreeting do
+  let(:command) { inputs ? described_class.new(inputs) : described_class.new }
+  let(:outcome) { command.run }
+  let(:result) { outcome.result }
+  let(:errors) { outcome.errors }
+  let(:errors_hash) { outcome.errors_hash }
+
+  let(:inputs) { nil }
+
+  describe "#run" do
+    it "constructs 'Hello, World!'" do
+      expect(outcome).to be_success
+      expect(result).to eq("Hello, World!")
+    end
+
+    context "when constructing a custom greeting" do
+      let(:inputs) do
+        { salutation: "howdy", greetee: "y'all" }
+      end
+
+      it "constructs the custom greeting" do
+        expect(outcome).to be_success
+        expect(result).to eq("Howdy, Y'all!")
+      end
+    end
+
+    context "when hissing" do
+      let(:inputs) do
+        { salutation: "hiss" }
+      end
+
+      it "is an error" do
+        expect(outcome).to_not be_success
+
+        error_hash = errors_hash["data.salutation.threatening_to_capybaras"]
+
+        expect(error_hash[:path]).to eq([:salutation])
+        expect(error_hash[:context][:threatening_salutation]).to eq("hiss")
+        expect(errors.first).to be_a(ConstructGreeting::ThreateningToCapybarasError)
+      end
+    end
+
+    context "when using a custom salutation to the universe" do
+      let(:inputs) do
+        { salutation: "howdy", greetee: "universe" }
+      end
+
+      it "is an error" do
+        expect(outcome).to_not be_success
+
+        expect(errors_hash["runtime.greeting_overreach"][:context]).to eq(greetee: "universe")
+        expect(errors.first).to be_a(ConstructGreeting::GreetingOverreachError)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: foobara-foobify-rails-app
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Miles Georgi
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foobara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+email:
+- azimux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE-MPL-2.0.txt
+- LICENSE.txt
+- README.md
+- lib/foobara/foobify_rails_app.rb
+- src/foobify_rails_app_config.rb
+- src/generate_foobified_rails_files.rb
+- src/generators/base_generator.rb
+- src/generators/config_application_generator.rb
+- src/generators/gemfile_generator.rb
+- src/generators/routes_generator.rb
+- src/generators/sample_command_generator.rb
+- src/generators/sample_command_spec_generator.rb
+- src/write_foobified_rails_files_to_disk.rb
+- templates/app/commands/construct_greeting.rb.erb
+- templates/spec/commands/construct_greeting_spec.rb.erb
+homepage: https://github.com/foobara/foobify-rails-app
+licenses:
+- MPL-2.0
+metadata:
+  homepage_uri: https://github.com/foobara/foobify-rails-app
+  source_code_uri: https://github.com/foobara/foobify-rails-app
+  changelog_uri: https://github.com/foobara/foobify-rails-app/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Generates the minimum plumbing to use foobara in an existing rails app
+test_files: []