dumb_generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 212e50e575b56cc79d186ea9dab28b05533bd7fc745ec5fc98060011d77f017f
+  data.tar.gz: f8fa34490cc652ab0859578a7c68cb17f17fbf4cba55c411385b09764502e229
+SHA512:
+  metadata.gz: 5798849ccebf89204cc34e7bf549d6d4e350f3bf70a0c4f835594a503e39fedb2722a79afc08323c5aa8ab61cb8a28b9618201480dfb1991a4b0d26537fe5e41
+  data.tar.gz: 9debaacc29c7a1685703ae659963a840815f13ff37dfbb98c062e09900fb9ece0527e043b00452b6bf29120613ab1a82d2f0da227cea43abf2de4c43a03b0021

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+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/README.md

@@ -0,0 +1,20 @@
+## Introduction
+
+This is a simple scaffolding generator. A Copy-Paste tool with some extra features like variable injection, and it intends on remaining like this.
+
+## Getting started
+
+```zsh
+gem install dumb_generator
+```
+
+## Setup
+
+Go to your project forder and run
+
+```zsh
+dgen init
+dgen template:default class_name:MyClass file_name:my_file
+```
+
+This will generate the default example scaffold, 2 text files in different directories.

data/bin/dgen

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'dumb_generator'
+
+Dumb::Generator::Base.new.execute!

data/lib/dumb/generator/runner.rb

@@ -0,0 +1,24 @@
+require_relative 'template_config_assembler'
+require_relative '../input/validator'
+require_relative '../template/linker/base'
+
+module Dumb
+    module Generator
+        class Runner
+            attr_reader :arguments
+
+            def initialize(arguments)
+                @arguments = arguments
+            end
+
+            def execute!
+                config = TemplateConfigAssembler.new(arguments).execute!
+
+                arguments.delete('template')
+                Dumb::Input::ArgumentVariablesValidator.new(arguments, config).validate!
+
+                Dumb::Template::Linker::Base.new(config, arguments).execute!
+            end
+        end
+    end
+end

data/lib/dumb/generator/template_config_assembler.rb

@@ -0,0 +1,56 @@
+require_relative '../template/validator'
+
+module Dumb
+    module Generator
+        class TemplateConfigAssembler
+            attr_reader :arguments
+
+            def initialize(arguments)
+                @arguments = arguments
+            end
+
+            def execute!
+                templates_path = Dir.pwd + '/.dumb_templates'
+
+                if !Dir.exist?(templates_path)
+                    print ".dumb_templates: does not exist in current directory.\nrun: $> dgen init\n"
+                    exit
+                end
+
+                template_names = Dir.entries(templates_path).select do |entry|
+                    files = File.directory?(File.join(templates_path, entry))
+
+                    files and !(entry == '.' || entry == '..')
+                end
+
+                template_names.each do |template|
+                    Dumb::Template::Validator.new(templates_path, template).validate!
+                end
+                
+                selected_template = arguments.key?('template') ? arguments['template'] : nil
+                if selected_template.nil?
+                    print "dumb_generator: template not specified\n"
+                    exit
+                end
+
+                if !template_names.include?(selected_template)
+                    print "dumb_generator: template `#{selected_template}` not found\nAvailable templates:\n"
+                    print "#{template_names}\n"
+                    exit
+                end
+
+                templates = {} 
+                template_names.each do |template|
+                    templates[template] = {
+                        template_path: "#{templates_path}/#{template}",
+                        root_path: "#{templates_path}/#{template}/root",
+                        linker_path: "#{templates_path}/#{template}/linker.yml",
+                        variables_path: "#{templates_path}/#{template}/variables.yml"
+                    }
+                end
+
+                templates[selected_template]
+            end
+        end
+    end
+end

data/lib/dumb/input/parser.rb

@@ -0,0 +1,34 @@
+module Dumb
+  module Input
+    module Parser
+      def self.commands
+        passed_commands = ARGV.select { |a| !a.include?(':') }
+
+        if (passed_commands.length > 1)
+          print "dumb_generator: too many commands, run one at a time\n"
+          exit
+        end
+
+        available_commands = ["run", "init", "help"]
+        passed_command = passed_commands.first || "run"
+
+        if !available_commands.include?(passed_command)
+          print "dumb_generator: command `#{passed_command}` not found in:\n#{available_commands}\n"
+          exit
+        end
+
+        arguments = ARGV.each_with_object({}) do |argument_variable, memo|
+          var_name = argument_variable.split(':').first
+          var_value = argument_variable.split(':').last
+
+          memo[var_name] = var_value
+        end
+
+        {
+          command: passed_command,
+          arguments: arguments,
+        }
+      end
+    end
+  end
+end

data/lib/dumb/input/validator.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+
+module Dumb
+  module Input
+  	class ArgumentVariablesValidator
+      attr_reader :variables, :defined_variables
+
+      UNKNOWN_VARIABLE_ERROR = 'Unkown variable `%s`'
+      MISSING_VARIABLES_ERROR = 'Missing variables %s'
+
+      def initialize(variables, config)
+        @variables = variables
+        @config = config
+
+        @defined_variables = YAML.load(
+          File.read(@config[:variables_path])
+        ).to_h['variables']
+      end
+
+      def validate!
+        validate_existing_variables!
+
+        validate_missing_variables!
+      end
+
+      private
+
+      def validate_existing_variables!
+        variables.keys.each do |variable|
+          if !defined_variables.include?(variable)
+            print "Unknown variable: #{variable} in:\n"
+            print UNKNOWN_VARIABLE_ERROR % [variable]
+
+            exit
+          end
+        end
+      end
+
+      def validate_missing_variables!
+        if !missing_variables?
+          print "Missing variables: #{defined_variables - variables.keys}\n"
+          exit
+        end
+      end
+
+      def missing_variables?
+        defined_variables & variables.keys == defined_variables
+      end
+  	end
+  end
+end

data/lib/dumb/template/initializer.rb

@@ -0,0 +1,86 @@
+module Dumb
+    module Template
+        class Initializer
+            def execute!
+                puts 'Initializing dumb_generator...'
+                
+                # add .dumb_templates folder
+                if !File.directory?('.dumb_templates')
+                    Dir.mkdir('.dumb_templates')
+                    puts 'Created .dumb_templates folder'
+                end
+
+                # add default template
+                if !File.directory?('.dumb_templates/default')
+                    Dir.mkdir('.dumb_templates/default')
+                end
+
+                createLinker!
+                createVariables!
+                createDgenFiles!
+
+                puts 'Done!'
+            end
+
+            private
+
+            def createDgenFiles!
+                # create root folder
+                if !File.directory?('.dumb_templates/default/root')
+                    Dir.mkdir('.dumb_templates/default/root')
+                end
+
+                # create dgen files
+                file = File.new('.dumb_templates/default/root/file.dgen', 'w')
+                file.puts <<-TEXT
+class {{class_name}}Class {}
+TEXT
+
+                file.close
+
+                if !File.directory?('.dumb_templates/default/root/subdir')
+                    Dir.mkdir('.dumb_templates/default/root/subdir')
+                end
+
+                file = File.new('.dumb_templates/default/root/subdir/file.dgen', 'w')
+                file.puts <<-TEXT
+class Sub{{class_name}}Class {}
+TEXT
+
+                file.close
+            end
+
+            def createLinker!
+                # create linker.yml
+                file = File.new('.dumb_templates/default/linker.yml', 'w')
+                file.puts <<-TEXT
+# Suports variables defined in variables.yml
+# All paths are relative
+
+root:
+  link_destination_directory: "../../src/{{file_name}}"
+  links:
+    - link:
+      dgen_template: "subdir/file.dgen"
+      to_destinaiton_file: "subdir/{{file_name}}_file.txt"
+    - link:
+      dgen_template: "file.dgen"
+      to_destinaiton_file: "{{file_name}}_file.txt"
+TEXT
+
+                file.close
+            end
+
+            def createVariables!
+                file = File.new('.dumb_templates/default/variables.yml', 'w')
+                file.puts <<-TEXT
+variables:
+  - file_name
+  - class_name        
+TEXT
+
+                file.close
+            end
+        end
+    end
+end

data/lib/dumb/template/linker/base.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+require_relative 'content_parser'
+require_relative 'path_parser'
+require_relative 'file_creator'
+
+module Dumb
+  module Template
+    module Linker
+      class Base
+        attr_reader :config, :variables
+
+        def initialize(config, variables)
+          @config     = config
+          @variables  = variables
+        end
+
+        def execute!
+          root = dgen_linker['root']
+          link_destination_directory = root['link_destination_directory']
+          links = root['links']
+          template_path = config[:template_path]
+
+          links.each do |link|
+            link.transform_keys!(&:to_sym)
+
+            file_path = template_path + '/' + link_destination_directory + '/' + link[:to_destinaiton_file]
+            template_content = File.read(config[:root_path] + '/' + link[:dgen_template])
+
+            parsed_path = PathParser.new(file_path, variables).parse
+            parsed_content = ContentParser.new(template_content, variables).parse
+
+            FileCreator.new(parsed_path, parsed_content).execute
+          end
+        end
+
+        private
+
+        def dgen_linker
+          YAML.load(File.read(config[:linker_path])).to_h
+        end
+      end
+    end
+  end
+end

data/lib/dumb/template/linker/content_parser.rb

@@ -0,0 +1,26 @@
+module Dumb
+  module Template
+    module Linker
+      class ContentParser
+        attr_reader :content, :variables
+
+        MATCH_REGEX = /({{(.*?)}})/.freeze
+
+        def initialize(content, variables)
+          @content    = content
+          @variables  = variables
+        end
+
+        def parse
+          template_variables = content.scan(MATCH_REGEX).to_h
+
+          template_variables.each do |full_string, variable_name|
+            content.gsub!(full_string, variables[variable_name])
+          end
+
+          content
+        end
+      end
+    end
+  end
+end

data/lib/dumb/template/linker/file_creator.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+
+module Dumb
+  module Template
+    module Linker
+      class FileCreator
+        attr_reader :path, :content
+
+        def initialize(path, content)
+          @path     = path
+          @content  = content
+        end
+
+        def execute
+          safe_create_hierarchy
+
+          File.open(path, 'w') { |file| file.write(content) }
+        end
+
+        private
+
+        def safe_create_hierarchy
+          file_dirname = File.dirname(path)
+
+          unless File.directory?(file_dirname)
+            FileUtils.mkdir_p(file_dirname)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dumb/template/linker/path_parser.rb

@@ -0,0 +1,25 @@
+module Dumb
+  module Template
+    module Linker
+      class PathParser
+        attr_reader :path, :variables
+
+        MATCH_REGEX = /({{(.*?)}})/.freeze
+
+        def initialize(path, variables)
+          @path       = path
+          @variables  = variables
+        end
+
+        def parse
+          groups = path.scan(MATCH_REGEX).to_h
+          groups.each do |full_string, var_name|
+            path.gsub!(full_string, variables[var_name])
+          end
+
+          path
+        end
+      end
+    end
+  end
+end

data/lib/dumb/template/validator.rb

@@ -0,0 +1,31 @@
+module Dumb
+    module Template
+        class Validator
+            attr_reader :templates_path, :template_name
+
+            def initialize(templates_path, template_name)
+                @templates_path = templates_path
+                @template_name = template_name
+            end
+
+            def validate!
+                validate_template_exists!
+            end
+
+            private
+            def validate_template_exists!
+                linker_missing = !File.exist?("#{templates_path}/#{template_name}/linker.yml")
+                variables_missing = !File.exist?("#{templates_path}/#{template_name}/variables.yml")
+                root_missing = !File.directory?("#{templates_path}/#{template_name}/root")
+
+                if linker_missing or variables_missing or root_missing
+                    print ".dumb_templates/#{template_name}: Invalid template format. Should be:\n\n"
+                    print "#{template_name}\n"
+                    print "├──root/\n├──linker.yml\n└──variables.yml\n\n"
+                    exit
+                end
+                
+            end
+        end
+    end
+end

data/lib/dumb_generator.rb

@@ -0,0 +1,38 @@
+require_relative 'dumb/input/parser'
+require_relative 'dumb/generator/runner'
+require_relative 'dumb/template/initializer'
+
+module Dumb
+	module Generator
+		class Base
+			def execute!
+				commands = Dumb::Input::Parser.commands
+				arguments = commands[:arguments]
+
+				if commands[:command] == "run" 
+					Dumb::Generator::Runner.new(arguments).execute!
+				elsif commands[:command] == "init" 
+					Dumb::Template::Initializer.new.execute!
+				elsif commands[:command] == "help" 
+					print <<-HELP
+Usage: dgen [COMMAND] [ARGUMENT_NAME:ARGUMENT_VALUE]
+
+Ex:
+$> dgen template:default class_name:MyClass file_name:my_file
+
+Commands:
+  run:    run a template (default, if no command is specified)
+  init:   initialize the dumb_generator, adds .dumb_templates to current directory and a default template
+  help:   show this message
+
+Arguments:
+  template:   specify a template to run
+HELP
+				end
+			end
+		end
+	end
+end
+
+Dumb::Generator::Base.new.execute!
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: dumb_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cristian Cosneanu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-03 00:00:00.000000000 Z
+dependencies: []
+description: A simple hello world gem
+email: cosneanuc@gmail.com
+executables:
+- dgen
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/dgen
+- lib/dumb/generator/runner.rb
+- lib/dumb/generator/template_config_assembler.rb
+- lib/dumb/input/parser.rb
+- lib/dumb/input/validator.rb
+- lib/dumb/template/initializer.rb
+- lib/dumb/template/linker/base.rb
+- lib/dumb/template/linker/content_parser.rb
+- lib/dumb/template/linker/file_creator.rb
+- lib/dumb/template/linker/path_parser.rb
+- lib/dumb/template/validator.rb
+- lib/dumb_generator.rb
+homepage: https://rubygems.org/gems/dumb_generator
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: A simple scaffolding generator
+test_files: []