flame_app_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d84774abfa166f8a221a8af59ec007a4b3edd2398f9498261c855ea3e9656d90
+  data.tar.gz: 504e40670137ef53eac00efc95d49ebf54980a79fda02f828ad01d225470bf8e
+SHA512:
+  metadata.gz: f3dc8ab12f7b9d33fabee02e63f5ad2fdd456692b44dd7f71e6cea6ed0ec0ce0338c9116a3e2ac5c7a9070711ec37602a33ac1ce17270ed8084add5dcc8f8971
+  data.tar.gz: 5e442c6b64d76d2706c67ea7c00737238e9f077f416701d5799ec0a24df17de34974844150df2938d5832c516cfa204829d13940a27754aab5326debf1e9a36d

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0 (2023-11-06)
+
+*   Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Popov
+
+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,106 @@
+# Flame App Generator
+
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/flame_app_generator?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/flame_app_generator)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/flame_app_generator/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/flame_app_generator)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/flame_app_generator.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/flame_app_generator)
+[![Depfu](https://img.shields.io/depfu/AlexWayfer/flame_app_generator?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/flame_app_generator)
+[![license](https://img.shields.io/github/license/AlexWayfer/flame_app_generator.svg?style=flat-square)](LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/flame_app_generator.svg?style=flat-square)](https://rubygems.org/gems/flame_app_generator)
+
+Gem for new [Flame](https://github.com/AlexWayfer/flame) web applications generation.
+
+It was created for myself, but you can suggest options for generation to adopt it for your usage.
+
+## Installation
+
+Install it globally:
+
+```shell
+gem install flame_app_generator
+```
+
+## Usage
+
+### With local template
+
+```sh
+flame_app_generator name_of_a_new_app path/to/template
+```
+
+### With GitHub template
+
+```sh
+flame_app_generator name_of_a_new_app template_github_org/template_github_repo --git
+```
+
+Be aware: `flame_app_generator` uses `template/` directory from the GitHub repo, not the root one.
+
+### With custom project name
+
+It can be used instead of camelized app name, for example:
+
+```sh
+flame_app_generator foobar path/to/template --project-name=FooBar
+```
+
+### With custom domain
+
+It can be used instead of default `.com` domain, for example:
+
+```sh
+flame_app_generator foobar path/to/template --domain=foo-bar.dev
+```
+
+## Template creation
+
+Example of gem template you can see at [AlexWayfer/flame_app_template](https://github.com/AlexWayfer/flame_app_template).
+
+Available paths:
+
+| Path part  | Example of source | Example of result |
+| ---------- | ----------------- | ----------------- |
+| `app_name` | `app_name.rb`     | `foo_bar.rb`      |
+
+Any `*.erb` file will be rendered via [ERB](https://ruby-doc.org/stdlib/libdoc/erb/rdoc/ERB.html);
+if you want an `*.erb` file as result — name it as `*.erb.erb` (even if there are no tags).
+
+Available variables:
+
+| Variable            | Example of result  | Default                         |
+| ------------------- | ------------------ | ------------------------------- |
+| `name`, `app_name`  | `foo_bar`          | _required_                      |
+| `module_name`       | `FooBar`           | camelized app name              |
+| `short_module_name` | `FB`               | upcased chars from module name  |
+| `domain_name`       | `foobar.com`       | downcased module name + `.com`  |
+| `indentation`       | `tabs` or `spaces` | `tabs` (it's easier to convert) |
+
+By default indentation is `tabs`, but if a template spaces-indented — option will not affect.
+So, this option only for tabs-indented templates.
+
+### Git templates
+
+You can create public git-templates and then guide users to call
+`flame_app_generator app_name your_org/your_repo --git`,
+but be aware that `flame_app_generator` will look for template inside `template/` directory
+to allow you having out-of-template README, specs (for the template itself), anything else.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `bundle exec rspec` to run the tests.
+
+To install this gem onto your local machine, run `toys gem install`.
+
+To release a new version, run `toys gem release %version%`.
+See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
+
+## Contributing
+
+Bug reports and pull requests are welcome
+on [GitHub](https://github.com/AlexWayfer/flame_app_generator).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/exe/flame_app_generator

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require_relative '../lib/flame_app_generator/command'
+
+FlameAppGenerator::Command.run

data/lib/flame_app_generator/command/process_files/render_variables.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'gorilla_patch/blank'
+
+## For internal templates usage
+require 'date'
+require 'securerandom'
+
+module FlameAppGenerator
+	class Command < ProjectGenerator::Command
+		module ProcessFiles
+			## Class for a single object which should be a scope in render
+			class RenderVariables < ProjectGenerator::Command::ProcessFiles::RenderVariables
+				using GorillaPatch::Inflections
+
+				attr_reader :module_name, :domain_name
+
+				alias app_name name
+
+				def initialize(name, project_name, domain, indentation)
+					super name, indentation
+
+					@module_name = project_name || app_name.camelize
+
+					@domain_name = domain || "#{@module_name.downcase}.com"
+				end
+
+				undef_method :path
+
+				memoize def short_module_name
+					module_name.split(/([[:upper:]][[:lower:]]*)/).map! { |s| s[0] }.join
+				end
+			end
+		end
+	end
+end

data/lib/flame_app_generator/command/process_files.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'process_files/render_variables'
+
+module FlameAppGenerator
+	class Command < ProjectGenerator::Command
+		## Private instance methods for processing template files (copying, renaming, rendering)
+		module ProcessFiles
+			RENAME_FILES_PLACEHOLDERS = {
+				name: 'app_name'
+			}.freeze
+
+			private
+
+			def initialize_render_variables
+				self.class::RenderVariables.new name, project_name, domain, indentation
+			end
+		end
+	end
+end

data/lib/flame_app_generator/command.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'project_generator'
+
+require_relative 'command/process_files'
+
+## https://github.com/mdub/clamp#allowing-options-after-parameters
+Clamp.allow_options_after_parameters = true
+
+module FlameAppGenerator
+	## Main CLI command for Flame App Generator
+	class Command < ProjectGenerator::Command
+		include ProcessFiles
+
+		parameter 'NAME', 'name of a new application'
+		parameter 'TEMPLATE', 'template path of a new app'
+
+		option ['-d', '--domain'], 'NAME', 'domain name for configuration'
+		option ['-p', '--project-name'], 'NAME', 'project name for code and configuration'
+
+		def execute
+			check_target_directory
+
+			refine_template_parameter if git?
+
+			process_files
+
+			clean_dirs
+
+			initialize_git
+
+			setup_project
+
+			FileUtils.rm_r @git_tmp_dir if git?
+
+			done
+		end
+
+		private
+
+		def clean_dirs
+			puts 'Clean directories...'
+
+			FileUtils.rm Dir.glob('**/.keep', File::FNM_DOTMATCH)
+		end
+
+		def setup_project
+			puts 'Setup project...'
+
+			Dir.chdir name do
+				Bundler.with_unbundled_env do
+					system 'exe/setup.sh'
+				end
+			end
+		end
+	end
+end

data/lib/flame_app_generator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FlameAppGenerator
+	VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: flame_app_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Popov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gorilla_patch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: project_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: 'Generator for Flame web applications.
+
+  '
+email:
+- alex.wayfer@gmail.com
+executables:
+- flame_app_generator
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/flame_app_generator
+- lib/flame_app_generator/command.rb
+- lib/flame_app_generator/command/process_files.rb
+- lib/flame_app_generator/command/process_files/render_variables.rb
+- lib/flame_app_generator/version.rb
+homepage: https://github.com/AlexWayfer/flame_app_generator
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/AlexWayfer/flame_app_generator/issues
+  changelog_uri: https://github.com/AlexWayfer/flame_app_generator/blob/v0.1.0/CHANGELOG.md
+  homepage_uri: https://github.com/AlexWayfer/flame_app_generator
+  source_code_uri: https://github.com/AlexWayfer/flame_app_generator
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Generator for Flame web applications
+test_files: []