gem_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f6652896d539c126a338591546a05a6c4ac65009eb9fd9add79ffce31412cc0
+  data.tar.gz: d8f5b3dd52a7f98cd2d548281cc50070de63d2ea308e53acb254ec71ee700dcc
+SHA512:
+  metadata.gz: 14987f158b13c559f9f77846abbee7b15da524c76d77cb8eec965461a59a34255c4fe503336f65483c69b91ae31f23114dce5c5bbe4d6b08652acede07cf1302
+  data.tar.gz: a4d5a7cab7d3ca9e7fd8ea2266052bebb0450f6276414ac8c681241ef6ffcd45471f30ec2eb0872a4a9cca3ca5ca583fe225661d34a1577ca3d7b067bb167ed2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0 (2021-10-05)
+
+*   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,67 @@
+# Gem Generator
+
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/gem_generator?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/gem_generator)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/gem_generator/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/gem_generator)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/gem_generator.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/gem_generator)
+[![Depfu](https://img.shields.io/depfu/AlexWayfer/gem_generator?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/gem_generator)
+[![Inline docs](https://inch-ci.org/github/AlexWayfer/gem_generator.svg?branch=main)](https://inch-ci.org/github/AlexWayfer/gem_generator)
+[![license](https://img.shields.io/github/license/AlexWayfer/gem_generator.svg?style=flat-square)](LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/gem_generator.svg?style=flat-square)](https://rubygems.org/gems/gem_generator)
+
+Gem for new gems 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 gem_generator
+```
+
+## Usage
+
+```sh
+gem_generator --namespace=github_nickname name_of_a_new_gem
+```
+
+You can create a config file, `.gem_generator.yaml` (or `.yml`) like this:
+
+```yaml
+## This can be overwriten via `--namespace` CLI option, config just as default
+:namespace: AlexWayfer
+
+## These options have defaults from `git config --get user.*`
+# :author:
+#   :name: Alexander Popov
+#   :email: alex.wayfer@gmail.com
+```
+
+Gem Generator will look for it in each directory from current to the root,
+so the common place for it in the home directory, but you can redefine it,
+for example, in some directory for work projects.
+
+## Template creation
+
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `toys 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/gem_generator).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/exe/gem_generator

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

data/lib/gem_generator/command.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'clamp'
+require 'erb'
+require 'fileutils'
+require 'pathname'
+
+require_relative 'render_variables'
+
+## https://github.com/mdub/clamp#allowing-options-after-parameters
+Clamp.allow_options_after_parameters = true
+
+module GemGenerator
+	## Main CLI command for Gem Generator
+	class Command < Clamp::Command
+		parameter 'NAME', 'name of a new gem'
+		parameter 'TEMPLATE', 'template path of a new gem'
+
+		option ['-n', '--namespace'], 'NAME', 'use NAME as repository namespace'
+		option ['-i', '--indentation'], 'TYPE', 'type of indentation (tabs or spaces)',
+			default: 'tabs' do |value|
+				## TODO: Add something like `:variants` to Clamp
+				unless %w[tabs spaces].include? value
+					raise ArgumentError, 'Only `tabs` or `spaces` values acceptable'
+				end
+
+				value
+			end
+
+		attr_reader(
+			:path, :title, :modules, :version_constant, :github_path, :github_uri,
+			:author_name, :author_email
+		)
+
+		def execute
+			@directory = File.expand_path name
+
+			signal_usage_error 'the target directory already exists' if Dir.exist? @directory
+
+			## Prevent error like '"FIXME" or "TODO" is not a description' for `bundle install`
+			@summary = ask_for_summary
+
+			copy_files
+
+			render_files_and_file_names
+
+			install_dependencies
+
+			## If there is no `gem_generator` config — `render` asks `git config`
+			## Also do `git add .` after all renders
+			initialize_git
+
+			puts 'Done.'
+
+			puts <<~HELP
+				To checkout into a new directory:
+					cd #{name}
+			HELP
+		end
+
+		private
+
+		def ask_for_summary
+			require 'readline'
+
+			puts 'Please, write a summary for the gem:'
+
+			result = Readline.readline('> ', true)
+
+			puts <<~TEXT
+
+				Thank you! You can write more detailed description later for `spec.description` and `README.md`.
+
+			TEXT
+
+			## Give a time to read the hint about description
+			# sleep 3
+
+			result
+		end
+
+		def copy_files
+			puts 'Copying files...'
+
+			FileUtils.cp_r template, @directory
+
+			FileUtils.rm_rf "#{@directory}/.git"
+		end
+
+		def rename_files
+			puts 'Renaming files...'
+
+			{ 'gem_name' => @render_variables.name, 'gem_path' => @render_variables.path }
+				.each do |template_name, real_name|
+					Dir["#{@directory}/**/*#{template_name}*"].each do |file_name|
+						new_file_name =
+							@directory + file_name.delete_prefix(@directory).gsub(template_name, real_name)
+
+						FileUtils.mkdir_p File.dirname new_file_name
+
+						File.rename file_name, new_file_name
+					end
+				end
+		end
+
+		def render_files_and_file_names
+			@render_variables = RenderVariables.new name, namespace, indentation, @summary
+
+			rename_files
+
+			begin
+				render_files
+			rescue SystemExit, Clamp::UsageError => e
+				FileUtils.rm_r @directory
+				raise e
+			end
+		end
+
+		def render_files
+			puts 'Rendering files...'
+
+			Dir.glob("#{@directory}/**/*.erb", File::FNM_DOTMATCH).each do |template_file|
+				## Read a template file content and render it
+				content =
+					ERB.new(File.read(template_file), trim_mode: '-').result(@render_variables.get_binding)
+
+				## Replace tabs with spaces if necessary
+				## TODO: Get spaces count from `.editorconfig` file
+				content.gsub!(/^\t+/) { |tabs| '  ' * tabs.count("\t") } if indentation == 'spaces'
+
+				## Render variables in file name
+				real_pathname = Pathname.new(template_file).sub_ext('')
+
+				## Rename template file
+				File.rename template_file, real_pathname
+
+				## Update file content
+				File.write real_pathname, content
+			end
+		end
+
+		def initialize_git
+			puts 'Initializing git...'
+
+			Dir.chdir name do
+				system 'git init'
+				system 'git add .'
+			end
+		end
+
+		def install_dependencies
+			puts 'Installing dependencies...'
+
+			Dir.chdir name do
+				system 'bundle update'
+
+				system 'npm install' if File.exist? 'package.json'
+			end
+		end
+	end
+end

data/lib/gem_generator/render_variables.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'memery'
+require 'gorilla_patch/blank'
+require 'gorilla_patch/inflections'
+
+module GemGenerator
+	## Class for a single object which should be a scope in render
+	class RenderVariables
+		include Memery
+
+		using GorillaPatch::Blank
+		using GorillaPatch::Inflections
+
+		attr_reader :name, :indentation, :summary
+
+		def initialize(name, namespace_option, indentation, summary)
+			@name = name
+			@namespace_option = namespace_option
+			@indentation = indentation
+			@summary = summary
+		end
+
+		## `public :binding` and `send :binding` return caller binding
+		## This is from ERB documentation: https://ruby-doc.org/core-2.7.2/Binding.html
+		# rubocop:disable Naming/AccessorMethodName
+		def get_binding
+			binding
+		end
+		# rubocop:enable Naming/AccessorMethodName
+
+		memoize def summary_quotes
+			summary.include?("'") ? '"' : "'"
+		end
+
+		memoize def description
+			summary.match?(/[.?!]$/) ? summary : "#{summary}."
+		end
+
+		memoize def path
+			name.tr('-', '/')
+		end
+
+		memoize def title
+			name.split(/[-_]/).map(&:camelize).join(' ')
+		end
+
+		memoize def module_name
+			path.camelize
+		end
+
+		memoize def modules
+			module_name.split('::')
+		end
+
+		memoize def version_constant
+			"#{module_name}::VERSION"
+		end
+
+		memoize def github_path
+			"#{github_namespace}/#{name}"
+		end
+
+		memoize def github_namespace_uri
+			"https://github.com/#{github_namespace}"
+		end
+
+		memoize def github_uri
+			"https://github.com/#{github_path}"
+		end
+
+		EXAMPLE_VALUES = {
+			name: 'My Name',
+			email: 'my.email@example.com'
+		}.freeze
+		private_constant :EXAMPLE_VALUES
+
+		%i[name email].each do |property|
+			method_name = "author_#{property}"
+
+			define_method method_name do
+				result = config.dig(:author, property) || `git config --get user.#{property}`.chomp
+
+				return result unless result.blank?
+
+				abort <<~TEXT
+					You have to specify project's author #{property}.
+					You can use `git config user.#{property} "#{EXAMPLE_VALUES[property]}"`, or create a configuration file.
+					Check the README.
+				TEXT
+			end
+
+			memoize method_name
+		end
+
+		private
+
+		memoize def github_namespace
+			result = @namespace_option || config[:namespace]
+
+			return result unless result.blank?
+
+			abort <<~TEXT
+				You have to specify project's namespace on GitHub.
+				You can use `--namespace` option, or create a configuration file.
+				Check the README.
+			TEXT
+		end
+
+		memoize def config
+			config_file = find_config_file
+			return {} unless config_file
+
+			YAML.load_file config_file
+		end
+
+		def find_config_file
+			config_lookup_directory = Dir.getwd
+
+			until (
+				config_file = Dir.glob(
+					File.join(config_lookup_directory, '.gem_generator.y{a,}ml'), File::FNM_DOTMATCH
+				).first
+			) || config_lookup_directory == '/'
+				config_lookup_directory = File.dirname config_lookup_directory
+			end
+
+			config_file
+		end
+	end
+end

data/lib/gem_generator/version.rb

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

metadata

@@ -0,0 +1,270 @@
+--- !ruby/object:Gem::Specification
+name: gem_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Popov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alt_memery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: gorilla_patch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gem_toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 'Generator for gems.
+
+  '
+email:
+- alex.wayfer@gmail.com
+executables:
+- gem_generator
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/gem_generator
+- lib/gem_generator/command.rb
+- lib/gem_generator/render_variables.rb
+- lib/gem_generator/version.rb
+homepage: https://github.com/AlexWayfer/gem_generator
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/AlexWayfer/gem_generator/issues
+  changelog_uri: https://github.com/AlexWayfer/gem_generator/blob/v0.1.0/CHANGELOG.md
+  homepage_uri: https://github.com/AlexWayfer/gem_generator
+  source_code_uri: https://github.com/AlexWayfer/gem_generator
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Generator for gems
+test_files: []