foobara-typescript-remote-command-generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88862a0a23e8083e35cb4532b39dacd37ddc676106ef0256f4d44078b5e46e60
+  data.tar.gz: e40985f3adf7022efdf3cf85e655092909b35b9037c05edcd0f98106a6923d26
+SHA512:
+  metadata.gz: e0ed06bab827629f9d05ddc065ff8ccc63a640f1cfa29cd3d2007a0e2aeab3db78505a4459feae8fccf0764b3817ce2cee9dffd58c4c05baa158e68949d4e1bf
+  data.tar.gz: c41a5cc46c96afa5cf537caba003925c880e861363060fd1859e6b95cd7a7bb747a435dc183c9c90bf52c976d7fd26741e40adc99b662f1d93390158a46f4713

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.0.1] - 2024-06-17
+
+- Add Apache-2.0 license
+
+## [0.0.0] - 2023-11-28
+
+- Project birth

data/LICENSE-APACHE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/LICENSE-MIT.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Miles Georgi
+
+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.

data/LICENSE.txt

@@ -0,0 +1,8 @@
+This project is dual licensed under your choice of the Apache-2.0 license and the MIT license.
+
+Apache-2.0 License: LICENSE-APACHE.txt or https://www.apache.org/licenses/LICENSE-2.0.txt
+MIT License: LICENSE-MIT.txt or https://opensource.org/licenses/MIT
+
+This is equivalent to the following SPDX License Expression: Apache-2.0 OR MIT
+
+Copyright (c) 2024 Miles Georgi

data/README.md

@@ -0,0 +1,55 @@
+# Typescript::Remote::Command::Generator
+
+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/typescript/remote/command/generator`. To experiment with that code,
+run `bin/console` for an interactive prompt.
+
+## Installation
+
+From this directory, run the following:
+
+```
+bundle config set local.foobara ../foobara
+bundle config set disable_local_branch_check true
+```
+
+NOTE: you don´t need to do this because it is already done, but when setting up a new project, you need to
+put a valid private key in TYPESCRIPT_REMOTE_COMMAND_GENERATOR_KEY_FOR_FOOBARA in gitub actions secrets for this
+repository.
+
+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:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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]/typescript-remote-command-generator.
+
+## 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.

data/lib/foobara/typescript_remote_command_generator.rb

@@ -0,0 +1,13 @@
+require "foobara/all"
+require "foobara/files_generator"
+
+require "erb"
+require "json"
+require "open-uri"
+
+src = "#{__dir__}/../../src/"
+
+Foobara::Util.require_directory(src)
+
+module TypescriptRemoteCommandGenerator
+end

data/src/remote_generator/association_depth.rb

@@ -0,0 +1,11 @@
+module Foobara
+  # TODO: give this module a non-generic name throughout this project...
+  # and extract truly generic behavior to some other shared project
+  module RemoteGenerator
+    module AssociationDepth
+      AMBIGUOUS = :ambiguous
+      ATOM = :atom
+      AGGREGATE = :aggregate
+    end
+  end
+end

data/src/remote_generator/generate_typescript.rb

@@ -0,0 +1,85 @@
+require "net/http"
+require "uri"
+
+module Foobara
+  module RemoteGenerator
+    class GenerateTypescript < Foobara::Generators::Generate
+      class MissingManifestError < RuntimeError; end
+
+      possible_error MissingManifestError
+
+      inputs raw_manifest: :associative_array,
+             manifest_url: :string
+
+      def execute
+        load_manifest_if_needed
+
+        include_non_templated_files
+
+        add_root_manifest_to_set_of_elements_to_generate
+        add_all_commands_to_set_of_elements_to_generate
+
+        each_element_to_generate do
+          generate_element
+        end
+
+        paths_to_source_code
+      end
+
+      def validate
+        if raw_manifest.nil? && manifest_url.nil?
+          # :nocov:
+          add_runtime_error(MissingManifestError.new(message: "Either raw_manifest or manifest_url must be given"))
+          # :nocov:
+        end
+      end
+
+      attr_accessor :command_manifest, :manifest_data
+
+      def base_generator
+        Services::TypescriptFromManifestBaseGenerator
+      end
+
+      def templates_dir
+        "#{__dir__}/../../templates"
+      end
+
+      def load_manifest_if_needed
+        self.manifest_data = if raw_manifest
+                               raw_manifest
+                               # TODO: introduce VCR to test the following elsif block
+                               # :nocov:
+                             elsif manifest_url
+                               url = URI.parse(manifest_url)
+                               response = Net::HTTP.get_response(url)
+
+                               manifest_json = if response.is_a?(Net::HTTPSuccess)
+                                                 response.body
+                                               else
+                                                 raise "Could not get manifest from #{url}: " \
+                                                       "#{response.code} #{response.message}"
+                                               end
+
+                               JSON.parse(manifest_json)
+                               # :nocov:
+                             end
+      end
+
+      def add_all_commands_to_set_of_elements_to_generate
+        manifest.commands.each do |command|
+          elements_to_generate << command
+          elements_to_generate << command.domain
+          elements_to_generate << command.organization
+        end
+      end
+
+      def add_root_manifest_to_set_of_elements_to_generate
+        elements_to_generate << manifest
+      end
+
+      def manifest
+        @manifest ||= Manifest::RootManifest.new(manifest_data)
+      end
+    end
+  end
+end

data/src/remote_generator/services/aggregate_entity_generator.rb

@@ -0,0 +1,49 @@
+require_relative "loaded_entity_generator"
+
+module Foobara
+  module RemoteGenerator
+    class Services
+      class AggregateEntityGenerator < LoadedEntityGenerator
+        class << self
+          def new(relevant_manifest)
+            return super unless self == AggregateEntityGenerator
+
+            if relevant_manifest.has_associations?
+              super
+            else
+              LoadedEntityGenerator.new(relevant_manifest)
+            end
+          end
+        end
+
+        def target_path
+          [*domain.scoped_full_path, "types", entity_name, "Aggregate.ts"]
+        end
+
+        def template_path
+          ["Entity", "Aggregate.ts.erb"]
+        end
+
+        def model_generators
+          types_depended_on.select(&:model?).map do |model|
+            Services::AggregateModelGenerator.new(model)
+          end
+        end
+
+        def attributes_type_ts_type
+          aggregate_attributes_ts_type
+        end
+
+        def ts_instance_path
+          *prefix, name = scoped_path
+          [*prefix, "#{name}Aggregate"]
+        end
+
+        def ts_instance_full_path
+          *prefix, name = scoped_full_path
+          [*prefix, "#{name}Aggregate"]
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/aggregate_model_generator.rb

@@ -0,0 +1,53 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      class AggregateModelGenerator < ModelGenerator
+        class << self
+          def new(relevant_manifest)
+            return super unless self == AggregateModelGenerator
+
+            if relevant_manifest.entity?
+              AggregateEntityGenerator.new(relevant_manifest)
+            elsif relevant_manifest.has_associations?
+              super
+            else
+              ModelGenerator.new(relevant_manifest)
+            end
+          end
+        end
+
+        def target_path
+          [*domain.scoped_full_path, "types", model_name, "Aggregate.ts"]
+        end
+
+        def template_path
+          ["Model", "Aggregate.ts.erb"]
+        end
+
+        def model_generators
+          types_depended_on.select(&:model?).map do |model|
+            if model.entity?
+              Services::AggregateEntityGenerator.new(model)
+            else
+              Services::AggregateModelGenerator.new(model)
+            end
+          end
+        end
+
+        def attributes_type_ts_type
+          aggregate_attributes_ts_type
+        end
+
+        def ts_instance_path
+          *prefix, name = scoped_path
+          [*prefix, "#{name}Aggregate"]
+        end
+
+        def ts_instance_full_path
+          *prefix, name = scoped_full_path
+          [*prefix, "#{name}Aggregate"]
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/atom_entity_generator.rb

@@ -0,0 +1,47 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      class AtomEntityGenerator < LoadedEntityGenerator
+        class << self
+          def new(relevant_manifest)
+            return super unless self == AtomEntityGenerator
+
+            if relevant_manifest.has_associations?
+              super
+            else
+              LoadedEntityGenerator.new(relevant_manifest)
+            end
+          end
+        end
+
+        def target_path
+          [*domain.scoped_full_path, "types", entity_name, "Atom.ts"]
+        end
+
+        def template_path
+          ["Entity", "Atom.ts.erb"]
+        end
+
+        def model_generators
+          types_depended_on.select(&:model?).map do |model|
+            if model.entity?
+              Services::UnloadedEntityGenerator.new(model)
+            else
+              Services::AtomModelGenerator.new(model)
+            end
+          end
+        end
+
+        def ts_instance_path
+          *prefix, name = scoped_path
+          [*prefix, "#{name}Atom"]
+        end
+
+        def ts_instance_full_path
+          *prefix, name = scoped_full_path
+          [*prefix, "#{name}Atom"]
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/atom_model_generator.rb

@@ -0,0 +1,49 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      class AtomModelGenerator < ModelGenerator
+        class << self
+          def new(relevant_manifest)
+            return super unless self == AtomModelGenerator
+
+            if relevant_manifest.entity?
+              AtomEntityGenerator.new(relevant_manifest)
+            elsif relevant_manifest.has_associations?
+              super
+            else
+              ModelGenerator.new(relevant_manifest)
+            end
+          end
+        end
+
+        def target_path
+          [*domain.scoped_full_path, "types", model_name, "Atom.ts"]
+        end
+
+        def template_path
+          ["Model", "Atom.ts.erb"]
+        end
+
+        def model_generators
+          types_depended_on.select(&:model?).map do |model|
+            if model.entity?
+              Services::UnloadedEntityGenerator.new(model)
+            else
+              Services::AtomModelGenerator.new(model)
+            end
+          end
+        end
+
+        def ts_instance_path
+          *prefix, name = scoped_path
+          [*prefix, "#{name}Atom"]
+        end
+
+        def ts_instance_full_path
+          *prefix, name = scoped_full_path
+          [*prefix, "#{name}Atom"]
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/command_errors_generator.rb

@@ -0,0 +1,36 @@
+require_relative "typescript_from_manifest_base_generator"
+require_relative "command_generator"
+
+module Foobara
+  module RemoteGenerator
+    class Services
+      class CommandErrorsGenerator < CommandGenerator
+        alias command_manifest relevant_manifest
+
+        def target_path
+          [*scoped_full_path, "Errors.ts"]
+        end
+
+        def template_path
+          "Command/Errors.ts.erb"
+        end
+
+        def error_generators
+          @error_generators ||= possible_errors.values.map(&:error).sort_by(&:error_name).uniq.map do |error|
+            Services::ErrorGenerator.new(error)
+          end
+        end
+
+        def error_type_union
+          error_generators.map do |error_generator|
+            dependency_group.non_colliding_type(error_generator)
+          end.join(" |\n  ")
+        end
+
+        def dependencies
+          error_generators
+        end
+      end
+    end
+  end
+end