ez_gen 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed6ea2992b32e37c2518ab930edcd58d187af1bf43269c8d0871c6baac696a56
-  data.tar.gz: 4574a72be283dd286a232cc104e26958f5b77a8a6ffb8c65b40288e754b78d76
+  metadata.gz: 44da2666456bc3dcf5c19f7d6acab572f84277b2513e1057ed3c5e094dbc5d90
+  data.tar.gz: 7b038b4838049cbdb87ddb235996f6bf999b06a16fd6e35e39d0a321721d88b6
 SHA512:
-  metadata.gz: 29b60f219fa163832f63d43174aff96e2cfdd9f94ba7ac01bcb647fc3ec7f2d3e75d3e34f64dfd8eaaf2589a54314fda9d0163f6e639760e2032ff5ce8dc0d3b
-  data.tar.gz: 7c15d909a61a1085fba52d4137cd9d6f91fc29526f53c6b48ed7e42e96264b08756b19492ffb990cfc4186d715ac328b946ae1506e84ec2fe84af35bc2affb4d
+  metadata.gz: e224af021133ba8d5ac044b3550f96e19a6ed9ae8d277a45a3052720c9659bc2b9acb2319cb3076947295c39d487c5d0a68df05c8e062f7dbe0c9228aaf979d0
+  data.tar.gz: c1b012bb8718d79559d34def434578f20ea894ad0d0e03e24006966f1e06dcf5e7f740e971a9e6c5e4202ce94ad89d6ec4fd34ae03e912254a0e12ff3a724f28

data/bin/ez_gen

@@ -2,4 +2,4 @@
 
 require 'ez_gen'
 
-EzGen::Template.generate 
+EzGen::Generator.generate_basic_env

data/lib/ez_gen.rb

@@ -1,9 +1,10 @@
-require "ez_gen/version"
+require 'ez_gen/version'
+require 'ez_gen/basic_env.rb'
 
 module EzGen
-  class Template
-    def self.generate
-      require 'ez_gen/generator.rb'
+  class Generator
+    def self.generate_basic_env
+      BasicEnv.new.generate
     end
   end
 end

data/lib/ez_gen/basic_env.rb

@@ -0,0 +1,52 @@
+require 'fileutils'
+require_relative 'file_writer'
+require_relative 'message_writer'
+
+class BasicEnv
+  def initialize
+    @title = ARGV.first
+    @file_writer = FileWriter.new(ARGV)
+  end
+
+  def generate
+    create_directories
+    cd_new_directory
+    initialize_git
+    write_template_files
+    commit_and_checkout
+    run_test
+    confirmation_message
+  end
+
+  private
+
+  def create_directories
+    %w(lib test .scripts).each {|dir| FileUtils.mkdir_p "#{@title}/#{dir}"}
+  end
+
+  def cd_new_directory
+    Dir.chdir "#{@title}"
+  end
+
+  def initialize_git
+    `git init`
+  end
+
+  def write_template_files
+    @file_writer.write
+  end
+
+  def commit_and_checkout
+    `git add .`
+    system("git commit -m 'Initial commit'")
+    system("git checkout -b dev")
+  end
+
+  def run_test
+    require "./test/#{ARGV.last}_test.rb"
+  end
+
+  def confirmation_message
+    MessageWriter.new(@title).write
+  end
+end

data/lib/ez_gen/file_writer.rb

@@ -0,0 +1,70 @@
+require_relative 'templatable'
+
+class FileWriter
+  include Templatable
+  def initialize(args)
+    @lower_name = args.last
+    @upper_name = @lower_name.split('_').map(&:capitalize).join
+  end
+
+  def write
+    write_rake
+    write_test_helper
+    write_class_template
+    write_test_file
+    write_generator
+    write_readme
+    write_pr_template
+    write_gitignore
+  end
+
+  private
+
+  def write_rake
+    rake = File.open("Rakefile", "w")
+    rake.write(rake_template)
+    rake.close
+  end
+
+  def write_test_helper
+    test_helper = File.open("test/test_helper.rb", "w")
+    test_helper.write(test_helper_template)
+    test_helper.close
+  end
+
+  def write_class_template
+    class_file = File.open("lib/#{@lower_name}.rb", 'w')
+    class_file.write(class_template(@upper_name))
+    class_file.close
+  end
+
+  def write_test_file
+    test_file = File.open("test/#{@lower_name}_test.rb", 'w')
+    test_file.write(test_template(@lower_name, @upper_name))
+    test_file.close
+  end
+
+  def write_generator
+    generator = File.open("./.scripts/generate.rb", 'w')
+    generator.write(generator_template)
+    generator.close
+  end
+
+  def write_readme
+    readme = File.open("README.md", 'w')
+    readme.write(readme_template)
+    readme.close
+  end
+
+  def write_pr_template
+    pr = File.open("pull_request_template.md", "w")
+    pr.write(pr_template)
+    pr.close
+  end
+
+  def write_gitignore
+    ignore = File.open(".gitignore", "w")
+    ignore.write("coverage/")
+    ignore.close
+  end
+end

data/lib/ez_gen/message_writer.rb

@@ -0,0 +1,65 @@
+require 'pastel'
+
+class MessageWriter
+  PASTEL = Pastel.new
+  def initialize(title)
+    @title = title
+    @message = {}
+  end
+
+  def write
+    stylize
+    confirmation
+  end
+
+  private
+
+  def confirmation
+    puts "\n" * 4
+    puts spacing[:spacing1] + @message[:repo] + @message[:title],""
+    puts spacing[:spacing1] + @message[:branch] + @message[:dev],""
+    puts spacing[:spacing2] + @message[:instructions],""
+    puts spacing[:spacing1] + @message[:run] + @message[:cd],""
+    puts spacing[:spacing1] + @message[:then],""
+    puts spacing[:spacing1] + @message[:run] + @message[:rake] + @message[:options],""
+    puts "\n" * 4
+  end
+
+  def spacing
+    {
+      spacing1: " " * 10,
+      spacing2: " " * 15,
+    }
+  end
+
+  def cyan_italic
+    {
+      repo: "Created new repository: ",
+      branch: "Switched to new branch: ",
+      run: "Run: ",
+      options: "to see available rake tasks",
+      then: "then..."
+    }
+  end
+
+  def magenta_bold
+    {
+      title: @title,
+      dev: "dev",
+      cd: "cd #{@title}",
+      rake: "rake --tasks "
+    }
+  end
+
+  def cyan_bold
+    {
+      instructions: "INSTRUCTIONS:"
+    }
+  end
+
+  def stylize
+    cyan_italic.each { |k,v| @message[k] = PASTEL.italic.cyan(v) }
+    magenta_bold.each { |k,v| @message[k] = PASTEL.bold.magenta(v) }
+    cyan_bold.each { |k,v| @message[k] = PASTEL.bold.cyan(v) }
+  end
+end

data/lib/ez_gen/templatable.rb

@@ -0,0 +1,138 @@
+module Templatable
+  def rake_template
+    <<~HEREDOC
+      require "rake/testtask"
+
+      Rake::TestTask.new do |task|
+        task.pattern = "test/*_test.rb"
+      end
+
+      desc "Run single test file based on class name, ex: rake test_class person"
+      task :test_class do
+        ARGV.each { |arg| task arg.to_sym do ; end }
+        eval File.read("./test/\#{ARGV.last}_test.rb")
+      end
+
+      desc "Generate new class and test, ex: rake g person"
+      task :g do
+        ARGV.each { |arg| task arg.to_sym do ; end }
+        ruby "./.scripts/generate.rb \#{ARGV.last}"
+      end
+    HEREDOC
+  end
+
+  def test_helper_template
+    <<~HEREDOC
+      require 'simplecov'
+      SimpleCov.start
+      require 'minitest/autorun'
+      require 'minitest/pride'
+      require 'mocha/minitest'
+    HEREDOC
+  end
+
+  def class_template(class_name)
+    <<~HEREDOC
+      class #{class_name}
+
+      end
+    HEREDOC
+  end
+
+  def test_template(lower_name, upper_name)
+    <<~HEREDOC
+      require './test/test_helper.rb'
+      require './lib/#{lower_name}.rb'
+
+      class #{upper_name}Test < Minitest::Test
+        def setup
+          @#{lower_name} = #{upper_name}.new
+        end
+
+        def test_it_exists
+          assert_instance_of #{upper_name}, @#{lower_name}
+        end
+      end
+    HEREDOC
+  end
+
+  def generator_template
+    <<~'HEREDOC'
+      lower_name = ARGV.first
+      upper_name = lower_name.split("_").map{|word| word.capitalize}.join
+
+      class_file = File.open("lib/#{lower_name}.rb", "w")
+      class_file.write("class #{upper_name}\n\nend")
+      class_file.close
+
+      test_file = File.open("test/#{lower_name}_test.rb", "w")
+      test_file.write(
+      "require \'./test/test_helper.rb\'
+      require \'./lib/#{lower_name}.rb\'
+
+      class #{upper_name}Test < Minitest::Test
+        def setup
+          @#{lower_name} = #{upper_name}.new
+        end
+
+        def test_it_exists
+          assert_instance_of #{upper_name}, @#{lower_name}
+        end
+      end"
+      )
+      test_file.close
+      eval File.read(test_file)
+      puts ""
+      puts "Created \'lib/#{lower_name}.rb\' and \'test/#{lower_name}_test.rb\'"
+      puts ""
+      HEREDOC
+  end
+
+  def readme_template
+    <<~HEREDOC
+      # Title
+
+      *Description*
+
+      ## Table of Contents:
+      - [Running Locally](#running-locally)
+      - [Tech Stack](#tech-stack)
+      - [Contributors](#contributors)
+
+      ***
+      ## Running Locally
+      [top](#table-of-contents)
+      * Instructions to run locally
+
+      ***
+      ## Tech Stack
+      [top](#table-of-contents)
+      * Language version
+      * Framework, gems, etc.
+
+      ***
+      ## Contributors
+      [top](#table-of-contents)
+      * [<NAME HERE>](<LINK TO GITHUB>)
+    HEREDOC
+  end
+
+  def pr_template
+    <<~HEREDOC
+      ## Description
+
+      ## Type of change
+      - [ ] Bug fix (non-breaking change which fixes an issue)
+      - [ ] Refactor (non-breaking change which maintains existing functionality)
+      - [ ] New feature (non-breaking change which adds functionality)
+      - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+      ## Notes
+
+      ## Test Results
+      ```
+
+      ```
+    HEREDOC
+
+  end
+end

data/lib/ez_gen/version.rb

@@ -1,3 +1,3 @@
 module EzGen
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ez_gen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tyler Porter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
 description: Enter a project name and the name of the class you'd like to create.
   EzGen will generate a new git repo, class template, corresponding test template,
   PR template, README template, and Rakefile.
@@ -50,7 +64,10 @@ extra_rdoc_files: []
 files:
 - bin/ez_gen
 - lib/ez_gen.rb
-- lib/ez_gen/generator.rb
+- lib/ez_gen/basic_env.rb
+- lib/ez_gen/file_writer.rb
+- lib/ez_gen/message_writer.rb
+- lib/ez_gen/templatable.rb
 - lib/ez_gen/version.rb
 homepage: https://github.com/tylerpporter/ez_gen
 licenses:
@@ -58,7 +75,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/tylerpporter/ez_gen
   source_code_uri: https://github.com/tylerpporter/ez_gen
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,8 +90,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: Quickly create an environment to write and test Ruby code.
 test_files: []

data/lib/ez_gen/generator.rb

@@ -1,207 +0,0 @@
-require 'fileutils'
-require 'pastel'
-
-# file/class name
-title = ARGV.first
-lower_name = ARGV.last
-upper_name = lower_name.split('_').map{|word| word.capitalize}.join
-
-# create the directories
-%w(lib test .scripts).each {|dir| FileUtils.mkdir_p "#{title}/#{dir}"}
-
-# cd into new directory
-Dir.chdir "#{title}"
-
-# initialize git
-`git init`
-
-#write Rakefile
-rake = File.open("Rakefile", "w")
-rake.write(
-'require "rake/testtask"
-
-Rake::TestTask.new do |task|
-  task.pattern = "test/*_test.rb"
-end
-
-desc "Run single test file based on class name, ex: rake test_class person"
-task :test_class do
-  ARGV.each { |arg| task arg.to_sym do ; end }
-  eval File.read("./test/#{ARGV.last}_test.rb")
-end
-
-desc "Generate new class and test, ex: rake g person"
-task :g do
-  ARGV.each { |arg| task arg.to_sym do ; end }
-  ruby "./.scripts/generate.rb #{ARGV.last}"
-end
-'
-)
-rake.close
-
-# write test helper
-test_helper = File.open("test/test_helper.rb", "w")
-test_helper.write(
-"require 'simplecov'
-SimpleCov.start
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'mocha/minitest'
-"
-)
-test_helper.close
-
-# write class template
-class_file = File.open("lib/#{lower_name}.rb", 'w')
-class_file.write("class #{upper_name}\n\nend")
-class_file.close
-
-# write test template
-test_file = File.open("test/#{lower_name}_test.rb", 'w')
-test_file.write(
-"require './test/test_helper.rb'
-require './lib/#{lower_name}.rb'
-
-class #{upper_name}Test < Minitest::Test
-  def setup
-    @#{lower_name} = #{upper_name}.new
-  end
-
-  def test_it_exists
-    assert_instance_of #{upper_name}, @#{lower_name}
-  end
-end"
-)
-test_file.close
-
-# write generator
-generator = File.open("./.scripts/generate.rb", 'w')
-generator.write(
-'lower_name = ARGV.first
-upper_name = lower_name.split("_").map{|word| word.capitalize}.join
-
-class_file = File.open("lib/#{lower_name}.rb", "w")
-class_file.write("class #{upper_name}\n\nend")
-class_file.close
-
-test_file = File.open("test/#{lower_name}_test.rb", "w")
-test_file.write(
-"require \'./test/test_helper.rb\'
-require \'./lib/#{lower_name}.rb\'
-
-class #{upper_name}Test < Minitest::Test
-  def setup
-    @#{lower_name} = #{upper_name}.new
-  end
-
-  def test_it_exists
-    assert_instance_of #{upper_name}, @#{lower_name}
-  end
-end"
-)
-test_file.close
-eval File.read(test_file)
-puts ""
-puts "Created \'lib/#{lower_name}.rb\' and \'test/#{lower_name}_test.rb\'"
-puts ""
-'
-)
-generator.close
-
-# write README
-readme = File.open("README.md", 'w')
-readme.write(
-'# Title
-
-*Description*
-
-## Table of Contents:
-- [Running Locally](#running-locally)
-- [Tech Stack](#tech-stack)
-- [Contributors](#contributors)
-
-***
-## Running Locally
-[top](#table-of-contents)
-* Instructions to run locally
-
-***
-## Tech Stack
-[top](#table-of-contents)
-* Language version
-* Framework, gems, etc.
-
-***
-## Contributors
-[top](#table-of-contents)
-* [<NAME HERE>](<LINK TO GITHUB>)
-'
-)
-readme.close
-
-# write pr template
-pr = File.open("pull_request_template.md", "w")
-pr.write(
-"## Description
-
-## Type of change
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] Refactor (non-breaking change which maintains existing functionality)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-## Notes
-
-## Test Results
-```
-
-```
-"
-)
-pr.close
-
-# write gitignore
-ignore = File.open(".gitignore", "w")
-ignore.write("coverage/")
-ignore.close
-
-# git
-`git add .`
-system("git commit -m 'Initial commit'")
-system("git checkout -b dev")
-
-# run the test
-eval File.read(test_file)
-
-# confirmation message
-pastel = Pastel.new
-message = {
-  spacing1: " " * 10,
-  spacing2: " " * 15,
-  title: pastel.bold.magenta("#{title}"),
-  repo: pastel.italic.cyan("Created new repository: "),
-  branch: pastel.italic.cyan("Switched to new branch: "),
-  dev: pastel.bold.magenta("dev"),
-  run: pastel.italic.cyan("Run: "),
-  cd: pastel.magenta.bold("cd #{title}"),
-  rake: pastel.magenta.bold("rake --tasks "),
-  options: pastel.italic.cyan("to see available rake tasks"),
-  then: pastel.italic.cyan("then..."),
-  instructions: pastel.cyan.bold("INSTRUCTIONS:")
-}
-4.times do
-  puts ""
-end
-puts message[:spacing1] + message[:repo] + message[:title]
-puts ""
-puts message[:spacing1] + message[:branch] + message[:dev]
-puts ""
-puts message[:spacing2] + message[:instructions]
-puts ""
-puts message[:spacing1] + message[:run] + message[:cd]
-puts ""
-puts message[:spacing1] + message[:then]
-puts ""
-puts message[:spacing1] + message[:run] + message[:rake] + message[:options]
-4.times do
-  puts ""
-end