beadme 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 505ccb5bfa83400fe2cd60e5382c99f52fae242ef34f0400396b58324982112f
+  data.tar.gz: 14b5fceb1c0733093c56fa486b757f63ff441ee0516d2563db7d29af39f7d4e7
+SHA512:
+  metadata.gz: 36d3abfa211d9e778b9d44106697b2f3452581621bd3df520bfe89b8e2252e1baa85b405c49d06719aa6109b2fd932bf35f4018e91337793634ba2b6da43950d
+  data.tar.gz: 4a33a0df630f7dab64c456fe58418b23f7effb9c72a1d5a5dc8d5af7399a0423b4176524d5dbcabe2b510399df4e37a67d82369f0da97e1a55297dcc0fb4f733

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Wai Yan Phyo
+
+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.markdown

@@ -0,0 +1,61 @@
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+
+# Beadme - Build Readme 😂 
+
+This is a simple CLI tool to create a README.md for your project.
+Don't take is seriously, I just wanted to try out some Ruby stuff.
+
+## Installation
+```sh
+  gem install beadme`
+```
+
+## Install from source code 
+
+Install via Bundler:
+
+
+```sh
+  bundle install
+```
+
+## Usage
+
+Using ruby:
+
+```sh
+  ruby bin/beadme
+```
+
+or using the executable:
+
+### Make it executable
+
+```sh
+  chmod +x bin/beadme
+```
+
+### Run it
+
+```sh
+  bin/beadme
+```
+
+## Help
+
+Run `beadme -h` to see the help message:
+
+```sh
+  beadme - A CLI tool to create a README.md for your project
+
+  Version: 0.0.1
+
+  Commands:
+    beadme -h, --help     # Display this help message
+    beadme -v, --version  # Show version
+
+  Options:
+    -o, [--output=OUTPUT]  # Output directory
+                           # Default: Current directory
+```
+

data/bin/beadme

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/beadme/runner'
+
+Beadme::Runner.start(ARGV)

data/lib/beadme/runner.rb

@@ -0,0 +1,63 @@
+require 'thor'
+
+require_relative './template'
+require_relative '../beadme'
+
+module Beadme
+  class Runner < Thor
+    class_option :output, aliases: '-o', type: :string, desc: 'Output directory (default: current directory)'
+
+    desc 'create', 'Create a new Readme file', hide: true
+    def create
+      say "#{Beadme.configuration.messages[:welcome]}\n"
+      puts options[:output]
+
+      Template.new(
+        # update this line to use the new configuration
+        # template: custom_template,
+        # questions: custom_questions,
+        dir: options[:output] || Dir.pwd
+      ).create
+    end
+
+    default_task :create
+
+    desc '-v, --version', 'Show version'
+    map %w[-v --version] => :version
+    def version
+      puts VERSION
+    end
+
+    desc '-h, --help', 'Display this help message'
+    def help(*)
+      say Beadme.configuration.messages[:about]
+      say "\nVersion: #{VERSION}\n\n"
+      super
+    end
+
+    def self.banner(command, _namespace = nil, _subcommand = false)
+      "#{basename} #{command.usage}"
+    end
+
+    def self.start(args = ARGV, config = {})
+      # I don't want to use commands like `beadme help` or `beadme version`
+      # I want to use `beadme -h` or `beadme -v` instead
+      # So I need to filter out the commands
+      filter_commands = public_instance_methods(false).map(&:to_s)
+      invalids = filter_commands & args
+      raise UndefinedCommandError.new(invalids.first, [], nil) if invalids.any?
+
+      super
+    rescue Thor::Error => e
+      warn e.message
+      exit 1
+    rescue Interrupt
+      warn "\nAborted!"
+      exit 1
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+  end
+end

data/lib/beadme/template.rb

@@ -0,0 +1,84 @@
+require 'erb'
+require 'thor/shell'
+
+class ::String
+  def to_list
+    split(',').map(&:strip).reject(&:empty?).map(&:capitalize)
+  end
+end
+
+module Beadme
+  # This class is responsible for generating the README.md file
+  class Template
+    include Thor::Shell
+
+    attr_reader :template, :questions, :dir, :save_path
+
+    def ask(question, color = nil)
+      say question, color
+      print '> '
+      super ''
+    ensure
+      puts ''
+    end
+
+    def initialize(
+      template: Beadme.configuration.default_template,
+      questions: Beadme.configuration.default_questions,
+      dir: Dir.pwd
+    )
+      @template = template
+      @questions = questions
+      @dir = dir
+      @save_path = File.join(dir, 'README.md')
+    end
+
+    # Create the README.md file
+    def create
+      check_dir
+      check_file
+
+      erb = ERB.new(template)
+
+      # ERB template will use this variable to populate the content
+      data = ask_questions
+      File.write(save_path, erb.result(binding))
+
+      print 'Successfully generate Readme.md in '
+      say save_path, :green
+    rescue ArgumentError => e
+      say e.message
+      exit 1
+    rescue StandardError => e
+      say "An error occurred while generating the README.md \n file: #{e.message}"
+      exit 1
+    end
+
+    private
+
+    def check_dir
+      raise ArgumentError, "#{dir} does not exist" unless File.exist?(dir)
+      raise ArgumentError, "#{dir} is not a directory" unless File.directory?(dir)
+      raise ArgumentError, "#{dir} is not writable" unless File.writable?(dir)
+    end
+
+    def check_file
+      return unless File.exist?(save_path)
+
+      say 'README.md already exists in this directory'
+      exit(1) unless yes?('Do you want to overwrite it? (y/N)', :red)
+    end
+
+    def ask_questions
+      data = {}
+      questions.each_with_index do |value, i|
+        key, question = value
+        answer = ask "#{i + 1}. #{question}", :blue
+        answer = answer.to_list if key.to_s.include?('stack') or key.to_s.include?('features')
+
+        data[key] = answer
+      end
+      data
+    end
+  end
+end

data/lib/beadme.rb

@@ -0,0 +1,55 @@
+require 'yaml'
+
+module Beadme
+  module Utils
+    # Find a file or directory in the project
+    # Raises an error if the file or directory does not exist
+    def self.get_path(*path_parts, root: File.join(__dir__, '..'))
+      path = File.join(root, *path_parts)
+      unless File.exist?(path)
+        raise ArgumentError,
+              "File or directory does not exist: #{path}"
+      end
+      path
+    end
+
+    # Load a YAML file and convert all keys to symbols
+    def self.load_yaml(file)
+      YAML.load_file(file).transform_keys(&:to_sym)
+    end
+  end
+
+  class Defaults
+    TEMPLATE_FILE = Utils.get_path('templates', 'microverse.md.erb')
+    QUESTIONS_FILE = Utils.get_path('config', 'questions.yml')
+    MESSAGES_FILE = Utils.get_path('config', 'messages.yml')
+  end
+
+  class Configuration
+    def default_template
+      File.read(Defaults::TEMPLATE_FILE)
+    end
+
+    def default_questions
+      Utils.load_yaml(Defaults::QUESTIONS_FILE)
+    end
+
+    # Get messages like welcome, help, etc.
+    # To display them in the terminal
+    def messages
+      Utils.load_yaml(Defaults::MESSAGES_FILE)
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: beadme
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wai Yan Phyo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-02 00:00:00.000000000 Z
+dependencies: []
+description: README generator for projects
+email: oyhpnayiaw@gmail.com
+executables:
+- beadme
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- bin/beadme
+- lib/beadme.rb
+- lib/beadme/runner.rb
+- lib/beadme/template.rb
+homepage: https://rubygems.org/gems/beadme
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/oyhpnayiaw/beadme
+  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: 2.6.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: README.md generator
+test_files: []