foobara-files-generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 365de954e96ce5e5f882685e607c0d693bf3576e28f3e689b839d09be503c2dd
+  data.tar.gz: 14791fb21dad94fcdca469fd446660dbfdcfdf432e9e3ed764baf3480c0ceaf1
+SHA512:
+  metadata.gz: 9200f700241b489dedd78706105c18c14acbf170b10fa5746663857bedb4656883bd89c74af66862e4da0490ce19110a151203dc8d17817be41c2b3970e535e1
+  data.tar.gz: eafdefcc605e94c8d9bce3ea29b2f4f0687942900457a31ba3534bb060272283c378e079b813e65e8502fc86cb34291af34caadf9b6571382d85ee0050155a41

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.0.1] - 2024-06-15
+
+- Add Apache-2.0 license
+
+## [0.0.0] - 2024-02-19
+
+- 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) 2024 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,21 @@
+# Foobara::FilesGenerator
+
+Contains common-code useful in different code generators.
+
+## Development
+
+For local development, for now, run the following:
+
+```
+bundle config set local.foobara ../foobara
+bundle config set disable_local_branch_check true
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/foobara/files_generator.
+
+## License
+
+This project is licensed under your choice of the Apache-2.0 license or the MIT license.
+See [LICENSE.txt](LICENSE-MIT.txt) for more info about licensing.

data/lib/foobara/files_generator.rb

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

data/src/files_generator.rb

@@ -0,0 +1,149 @@
+require "erb"
+
+module Foobara
+  class FilesGenerator
+    include TruncatedInspect
+
+    class << self
+      def manifest_to_generator_classes(_manifest)
+        # :nocov:
+        raise "subclass responsibility"
+        # :nocov:
+      end
+
+      def generators_for(manifest)
+        if manifest.is_a?(FilesGenerator)
+          return [manifest]
+        end
+
+        generator_classes = manifest_to_generator_classes(manifest)
+
+        Util.array(generator_classes).map do |generator_class|
+          generator_class.new(manifest)
+        end
+      end
+
+      def generator_for(manifest)
+        generators_for(manifest).first
+      end
+    end
+
+    attr_accessor :relevant_manifest, :belongs_to_dependency_group
+
+    def initialize(relevant_manifest)
+      self.relevant_manifest = relevant_manifest
+    end
+
+    def target_path
+      *path, file = template_path
+
+      if file.end_with?(".erb")
+        [*path, file[0..-5]]
+      else
+        # :nocov:
+        raise "expected a .erb extension. Maybe override #target_path"
+        # :nocov:
+      end
+    end
+
+    def target_dir
+      target_path[0..-2]
+    end
+
+    def applicable?
+      true
+    end
+
+    def generators_for(...)
+      # :nocov:
+      self.class.generators_for(...)
+      # :nocov:
+    end
+
+    def generator_for(...)
+      self.class.generator_for(...)
+    end
+
+    def dependencies
+      []
+    end
+
+    def dependencies_to_generate
+      dependencies
+    end
+
+    def generate(elements_to_generate)
+      dependencies_to_generate.each do |dependency|
+        elements_to_generate << dependency
+      end
+
+      # Render the template
+      erb_template.result(binding)
+    end
+
+    def template_path
+      # :nocov:
+      raise "Subclass responsibility"
+      # :nocov:
+    end
+
+    def absolute_template_path
+      path = template_path
+
+      if path.is_a?(::Array)
+        path = path.join("/")
+      end
+
+      Pathname.new("#{templates_dir}/#{path}").cleanpath.to_s
+    end
+
+    def templates_dir
+      # :nocov:
+      "#{Dir.pwd}/templates"
+      # :nocov:
+    end
+
+    def template_string
+      File.read(absolute_template_path)
+    end
+
+    def erb_template
+      # erb = ERB.new(template_string.gsub("\n<% end %>", "<% end %>"))
+      erb = ERB.new(template_string)
+      erb.filename = absolute_template_path
+      erb
+    end
+
+    def path_to_root
+      size = target_path.size - 1
+
+      (["../"] * size).join
+    end
+
+    def method_missing(method_name, *, &)
+      if relevant_manifest.respond_to?(method_name)
+        relevant_manifest.send(method_name, *, &)
+      else
+        # :nocov:
+        super
+        # :nocov:
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      relevant_manifest.respond_to?(method_name, include_private)
+    end
+
+    def ==(other)
+      self.class == other.class && relevant_manifest == other.relevant_manifest
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      relevant_manifest.hash
+    end
+  end
+end

data/src/generate.rb

@@ -0,0 +1,93 @@
+require "find"
+
+module Foobara
+  module Generators
+    class Generate < Foobara::Command
+      # TODO: specify a better type?
+      result :associative_array
+
+      attr_accessor :element_to_generate
+
+      def base_generator
+        # :nocov:
+        raise "subclass responsibility"
+        # :nocov:
+      end
+
+      def elements_to_generate
+        @elements_to_generate ||= Set.new
+      end
+
+      def generated
+        @generated ||= Set.new
+      end
+
+      def generated_elements
+        @generated_elements ||= Set.new
+      end
+
+      def each_element_to_generate
+        until elements_to_generate.empty?
+          element_to_generate = elements_to_generate.first
+          elements_to_generate.delete(element_to_generate)
+
+          generators = if element_to_generate.is_a?(FilesGenerator)
+                         if generated.include?(element_to_generate)
+                           []
+                         else
+                           elements_to_generate << element_to_generate.relevant_manifest
+                           [element_to_generate]
+                         end
+                       else
+                         if generated_elements.include?(element_to_generate)
+                           next
+                         end
+
+                         generated_elements << element_to_generate
+
+                         base_generator.generators_for(element_to_generate).select do |generator|
+                           generator.applicable? && !generated.include?(generator)
+                         end
+                       end
+
+          generators.each do |generator|
+            # TODO: change this name
+            self.element_to_generate = generator
+            generated << generator
+            yield
+          end
+        end
+      end
+
+      def generate_element
+        return unless element_to_generate.applicable?
+
+        paths_to_source_code[Util.array(element_to_generate.target_path).join("/")] =
+          element_to_generate.generate(elements_to_generate)
+      end
+
+      def include_non_templated_files
+        templates_dir_pathname = Pathname.new(templates_dir)
+
+        Find.find(templates_dir) do |file_path|
+          next if File.directory?(file_path)
+          next if file_path.end_with?(".erb")
+
+          file_path = Pathname.new(file_path)
+
+          relative_path = file_path.relative_path_from(templates_dir_pathname)
+
+          paths_to_source_code[relative_path.to_s] = File.read(file_path)
+        end
+      end
+
+      def templates_dir
+        base_generator.templates_dir
+      end
+
+      def paths_to_source_code
+        @paths_to_source_code ||= {}
+      end
+    end
+  end
+end

data/src/write_generated_files_to_disk.rb

@@ -0,0 +1,119 @@
+require "open3"
+
+module Foobara
+  module Generators
+    class WriteGeneratedFilesToDisk < Foobara::Command
+      class << self
+        def generator_key
+          nil
+        end
+      end
+
+      inputs do
+        output_directory :string, :required
+      end
+
+      result :string
+
+      attr_accessor :paths_to_source_code
+
+      def generate_generated_files_json
+        paths_to_source_code[generated_files_json_filename] = "[\n#{
+          paths_to_source_code.keys.sort.map { |k| "  \"#{k}\"" }.join(",\n")
+        }\n]\n"
+      end
+
+      def delete_old_files_if_needed
+        file_list_file = "#{output_directory}/#{generated_files_json_filename}"
+
+        if File.exist?(file_list_file)
+          # :nocov:
+          file_list = JSON.parse(File.read(file_list_file))
+
+          file_list.map do |file|
+            Thread.new { FileUtils.rm("#{output_directory}/#{file}") }
+          end.each(&:join)
+          # :nocov:
+        end
+      end
+
+      def write_all_files_to_disk
+        if paths_to_source_code.key?(generated_files_json_filename)
+          write_file_to_disk(generated_files_json_filename, paths_to_source_code[generated_files_json_filename])
+        end
+
+        paths_to_source_code.map do |path, contents|
+          Thread.new { write_file_to_disk(path, contents) unless path == generated_files_json_filename }
+        end.each(&:join)
+      end
+
+      def write_file_to_disk(path, contents)
+        path = "#{output_directory}/#{path}"
+        FileUtils.mkdir_p(File.dirname(path))
+        File.write(path, contents)
+      end
+
+      def generated_files_json_filename
+        key = self.class.generator_key
+
+        if key
+          # TODO: test this path
+          # :nocov:
+          "#{key}-generator.json"
+          # :nocov:
+        else
+          "foobara-generated.json"
+        end
+      end
+
+      # TODO: probably needs a better name
+      def run_cmd_and_write_output(cmd, raise_if_fails: true)
+        Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
+          loop do
+            line = stdout.gets
+            break unless line
+
+            puts line
+          end
+
+          exit_status = wait_thr.value
+          unless exit_status.success?
+            # :nocov:
+            if raise_if_fails
+              raise "could not #{cmd}\n#{stderr.read}"
+            else
+              warn "WARNING: could not #{cmd}\n#{stderr.read}"
+            end
+            # :nocov:
+          end
+        end
+      end
+
+      def run_cmd_and_return_output(cmd)
+        retval = ""
+
+        Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
+          loop do
+            line = stdout.gets
+            break unless line
+
+            retval << line
+          end
+
+          exit_status = wait_thr.value
+          unless exit_status.success?
+            # :nocov:
+            raise "could not #{cmd}\n#{stderr.read}"
+          end
+          # :nocov:
+        end
+
+        retval
+      end
+
+      def stats
+        "Wrote #{paths_to_source_code.size} files to #{output_directory}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: foobara-files-generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Miles Georgi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foobara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- azimux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE-APACHE.txt
+- LICENSE-MIT.txt
+- LICENSE.txt
+- README.md
+- lib/foobara/files_generator.rb
+- src/files_generator.rb
+- src/generate.rb
+- src/write_generated_files_to_disk.rb
+homepage: https://github.com/foobara/files-generator
+licenses:
+- Apache-2.0
+- MIT
+metadata:
+  homepage_uri: https://github.com/foobara/files-generator
+  source_code_uri: https://github.com/foobara/files-generator
+  changelog_uri: https://github.com/foobara/files-generator/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Common code reused across code generator projects
+test_files: []