spiker 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98350ed051acebc34e10ec68fb8c7cf2a92bf965a6488db604e03b6c5db29dda
-  data.tar.gz: 1def1fb1ea6f87032c8122d1fd64e1703a9c9c328acfd0b41c943321c6f4a539
+  metadata.gz: 1a9aea62d09c4b4c0e42dba860dc32a6c572d779d6c40da92f9d5a56736d1455
+  data.tar.gz: 161acf90832597f8151a324a60096775cab7f9569e0dc13f717ff82b9b2a1f86
 SHA512:
-  metadata.gz: 4fbf79f17bd7b7f63a7d8ed10818be30b55e72466e943f17427d10ec5bb2b42bdd5a13874a7933f67b0fb01a52ef49f56043f2a3648b426fb3939b3aa81de1e7
-  data.tar.gz: b629943faee3516a88bbc5412bdfb72ab0c7f21076bd9e26433bd11053dd18f56f828e3ff0fd0f87607710622f45673f14732a5f624daff799c0e610172efacf
+  metadata.gz: 57f40c25c3b4e06146662f9aeb8712e1cfa9e071dcb20c251a215d635192c5473ba421fa4675291472ecd416204bddc82b7163bddb896d202502142c1fc224ce
+  data.tar.gz: 05e2bcdf0c10fcb04b1385abb1008c5341282a8f1dd2b6cdcedfb1ce8f2d4cc3c80f4b90e6994bec4ad5c159e80fcff95f2391f47f4acb806c53ff6f0d466e97

data/exe/spiker

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-require "spiker/cli"
+require "spiker"
 Spiker::CLI.start

data/lib/spiker/base_generator.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Spiker
+  # BaseGenerator handles the common steps for all generators, including allowing for
+  # several feature skips. Inherited this generator - not to be used directly.
+  class BaseGenerator < Thor::Group
+    include Thor::Actions
+
+    argument :spike_name, type: :string
+
+    def self.source_root
+      File.expand_path("../spiker/templates", __dir__)
+    end
+
+    def generator_name
+      # name here refers to the class name, not the name of the spike
+      name = self.class.name.split("::").last
+      name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+    end
+
+    def create_spike_directory
+      empty_directory(spike_name)
+    end
+
+    def create_guard_file
+      template("#{generator_name}/Guardfile.tt", "#{spike_name}/Guardfile")
+    end
+
+    def create_gem_file
+      template("#{generator_name}/Gemfile.tt", "#{spike_name}/Gemfile")
+    end
+
+    def create_env_file
+      template("common/basic.env.tt", "#{spike_name}/.env")
+    end
+
+    def create_docker_files
+      if options[:skip_docker]
+        say "🛑 Skipping Dockerfile and docker-compose.yml generation (--skip-docker was passed)", :yellow
+        return if options[:skip_docker]
+      end
+
+      template("common/Dockerfile.tt", "#{spike_name}/Dockerfile")
+      template("common/docker-compose.yml.tt", "#{spike_name}/docker-compose.yml")
+      template("common/Makefile.tt", "#{spike_name}/Makefile")
+    end
+
+    def run_bundle_install
+      if options[:skip_bundle]
+        say "🛑 Skipping bundle install (--skip-bundle was passed)", :yellow
+        return
+      end
+
+      inside(spike_name) do
+        Bundler.with_unbundled_env do
+          system("bundle install")
+        end
+      end
+    end
+
+    def run_git_init
+      if options[:skip_git]
+        say "🛑 Skipping git init (--skip-git was passed)", :yellow
+        return
+      end
+
+      say "📦 Running `git init`...", :green
+      inside(File.join(destination_root, spike_name)) { run "git init" }
+    end
+  end
+end

data/lib/spiker/cli.rb

@@ -1,39 +1,49 @@
 # frozen_string_literal: true
 
-require "thor"
-require_relative "version"
-require_relative "generators/simple"
-require_relative "generators/given"
-require_relative "generators/multi"
-
 module Spiker
-  # Accept options "simple", "given", or "multi".
+  # Accept options "simple", "given", "multi", or "rspec".
   # Both Simple and Given create "single file" spikes
   # with the tests and spike code in a single file.
-  # The Multi option creates a more traditionally structured
+  # The Multi and Rspec options create a more traditionally structured
   # spike directory with tests, code, README, etc.  That is all.
   class CLI < Thor
+    class_option :skip_bundle, type: :boolean, default: false, desc: "Skip running bundle install"
+    class_option :skip_git, type: :boolean, default: false, desc: "Skip initializing git repository"
+    class_option :skip_docker, type: :boolean, default: false, desc: "Skip creating Dockerfile and docker-compose.yml"
+
     desc "version", "Show version"
     def version
       puts "Spiker version #{Spiker::VERSION}"
     end
 
     desc "simple NAME", "Spike in a single file"
-    method_option :name, type: :string, aliases: "-n", desc: "Name of the spike"
-    def simple(name)
-      Spiker::Generators::Simple.start([name])
+    def simple(spike_name)
+      Spiker::Generators::Simple.new([spike_name], generator_options).invoke_all
     end
 
     desc "given NAME", "Spike in a single file using Given syntax"
-    method_option :name, type: :string, aliases: "-n", desc: "Name of the spike"
-    def given(name)
-      Spiker::Generators::GivenOption.start([name])
+    def given(spike_name)
+      Spiker::Generators::Given.new([spike_name], generator_options).invoke_all
+    end
+
+    desc "multi NAME", "Spike using Minitest over multiple files"
+    def multi(spike_name)
+      Spiker::Generators::Multi.new([spike_name], generator_options).invoke_all
     end
 
-    desc "multi NAME", "Spike over multiple files"
-    method_option :name, type: :string, aliases: "-n", desc: "Name of the spike"
-    def multiple(name)
-      Spiker::Generators::Multi.start([name])
+    desc "rspec NAME", "Spike using Rspec over multiple files"
+    def rspec(spike_name)
+      Spiker::Generators::Rspec.new([spike_name], generator_options).invoke_all
+    end
+
+    private
+
+    def generator_options
+      {
+        skip_bundle: options[:skip_bundle],
+        skip_git: options[:skip_git],
+        skip_docker: options[:skip_docker]
+      }
     end
   end
 end

data/lib/spiker/generators/given.rb

@@ -1,46 +1,13 @@
 # frozen_string_literal: true
 
-require "thor/group"
-require_relative "../../spiker"
-
 module Spiker
   module Generators
     # Generates a single spike file, with supporting infrastructure.
     # For simpler spikes that don't need a ton of organization.
-    class GivenOption < Thor::Group
-      include Thor::Actions
-
-      argument :name, type: :string
-
-      def self.source_root
-        "#{File.dirname(__FILE__)}/templates/given"
-      end
-
-      def create_spike_directory
-        empty_directory(name)
-      end
-
+    class Given < BaseGenerator
       def create_spike_file
-        opts = { name_as_class: Spiker.classify(name) }
-        template("app.rb.erb", "#{name}/app.rb", opts)
-      end
-
-      def create_guard_file
-        template("guardfile.rb", "#{name}/Guardfile")
-      end
-
-      def create_gem_file
-        template("gemfile.rb", "#{name}/Gemfile")
-      end
-
-      def create_env_file
-        template("../common/basic.env", "#{name}/.env")
-      end
-
-      def run_bundler
-        inside(name) do
-          run("bundle install")
-        end
+        opts = { name_as_class: Spiker.classify(spike_name) }
+        template("#{generator_name}/app.rb.tt", "#{spike_name}/app.rb", opts)
       end
     end
   end

data/lib/spiker/generators/multi.rb

@@ -1,67 +1,42 @@
 # frozen_string_literal: true
 
-require "thor/group"
-require_relative "../../spiker"
-
 module Spiker
   module Generators
     # Generates multiple spike files, seperating tests from the
     # tested code.  For when the spike gets too hairy for a single
     # file.
-    class Multi < Thor::Group
-      include Thor::Actions
-
-      argument :name, type: :string
-
-      def self.source_root
-        "#{File.dirname(__FILE__)}/templates/multi"
-      end
-
-      def create_spike_directories
-        empty_directory(name)
-        empty_directory("#{name}/lib")
-        empty_directory("#{name}/test")
-      end
-
-      def create_test_files
-        name_in_snake_case = Spiker.snake_case(name)
-        name_as_class = Spiker.classify(name)
-        opts = { name_as_class:, name_in_snake_case: }
-        template("app_test.rb.erb", "#{name}/test/#{name_in_snake_case}_test.rb", opts)
-        template("test_helper.rb", "#{name}/test/test_helper.rb", opts)
+    class Multi < BaseGenerator
+      def create_additional_spike_directories
+        empty_directory("#{spike_name}/lib")
+        empty_directory("#{spike_name}/test")
       end
 
       def create_app_files
-        name_in_snake_case = Spiker.snake_case(name)
-        opts = { name_as_class: Spiker.classify(name) }
-        template("app.rb.erb", "#{name}/lib/#{name_in_snake_case}.rb", opts)
-      end
-
-      def create_guard_file
-        template("guardfile.rb", "#{name}/Guardfile")
+        template("#{generator_name}/app.rb.tt",
+                 "#{spike_name}/lib/#{multi_options[:name_in_snake_case]}.rb", multi_options)
       end
 
-      def create_gem_file
-        template("gemfile.rb", "#{name}/Gemfile")
+      def create_test_files
+        template("#{generator_name}/app_test.rb.tt",
+                 "#{spike_name}/test/#{multi_options[:name_in_snake_case]}_test.rb", multi_options)
+        template("#{generator_name}/test_helper.rb.tt", "#{spike_name}/test/test_helper.rb", multi_options)
       end
 
       def create_rake_file
-        template("rakefile.rb", "#{name}/Rakefile")
+        template("#{generator_name}/Rakefile.tt", "#{spike_name}/Rakefile")
       end
 
       def create_readme_file
-        opts = { name_as_class: Spiker.classify(name), name: }
-        template("readme.md.erb", "#{name}/README.md", opts)
+        template("#{generator_name}/README.md.tt", "#{spike_name}/README.md", multi_options)
       end
 
-      def create_env_file
-        template("../common/basic.env", "#{name}/.env")
-      end
+      private
 
-      def run_bundler
-        inside(name) do
-          run("bundle install")
-        end
+      def multi_options
+        @multi_options ||= {
+          name_as_class: Spiker.classify(spike_name),
+          name_in_snake_case: Spiker.snake_case(spike_name)
+        }
       end
     end
   end

data/lib/spiker/generators/rspec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Spiker
+  module Generators
+    # Generates multiple spike files, seperating specs from the
+    # tested code.  For when the spike gets too hairy for a single
+    # file.
+    class Rspec < BaseGenerator
+      def create_additional_spike_directories
+        empty_directory("#{spike_name}/lib")
+        empty_directory("#{spike_name}/spec")
+      end
+
+      def create_app_files
+        template("#{generator_name}/app.rb.tt",
+                 "#{spike_name}/lib/#{spec_options[:name_in_snake_case]}.rb", spec_options)
+      end
+
+      def create_test_files
+        template("#{generator_name}/app_spec.rb.tt",
+                 "#{spike_name}/spec/#{spec_options[:name_in_snake_case]}_spec.rb", spec_options)
+        template("#{generator_name}/spec_helper.rb.tt", "#{spike_name}/spec/spec_helper.rb", spec_options)
+      end
+
+      def create_rake_file
+        template("#{generator_name}/Rakefile.tt", "#{spike_name}/Rakefile")
+      end
+
+      def create_readme_file
+        template("#{generator_name}/README.md.tt", "#{spike_name}/README.md", spec_options)
+      end
+
+      private
+
+      def spec_options
+        @spec_options ||= {
+          name_as_class: Spiker.classify(spike_name),
+          name_in_snake_case: Spiker.snake_case(spike_name)
+        }
+      end
+    end
+  end
+end

data/lib/spiker/generators/simple.rb

@@ -1,46 +1,13 @@
 # frozen_string_literal: true
 
-require "thor/group"
-require_relative "../../spiker"
-
 module Spiker
   module Generators
     # Generates a single spike file, with supporting infrastructure.
     # For simpler spikes that don't need a ton of organization.
-    class Simple < Thor::Group
-      include Thor::Actions
-
-      argument :name, type: :string
-
-      def self.source_root
-        "#{File.dirname(__FILE__)}/templates/simple"
-      end
-
-      def create_spike_directory
-        empty_directory(name)
-      end
-
+    class Simple < BaseGenerator
       def create_spike_file
-        opts = { name_as_class: Spiker.classify(name) }
-        template("app.rb.erb", "#{name}/app.rb", opts)
-      end
-
-      def create_guard_file
-        template("guardfile.rb", "#{name}/Guardfile")
-      end
-
-      def create_gem_file
-        template("gemfile.rb", "#{name}/Gemfile")
-      end
-
-      def create_env_file
-        template("../common/basic.env", "#{name}/.env")
-      end
-
-      def run_bundler
-        inside(name) do
-          run("bundle install")
-        end
+        opts = { name_as_class: Spiker.classify(spike_name) }
+        template("#{generator_name}/app.rb.tt", "#{spike_name}/app.rb", opts)
       end
     end
   end

data/lib/spiker/templates/common/Dockerfile.tt

@@ -0,0 +1,18 @@
+FROM ruby:3.4.3-slim
+
+# Set working directory
+WORKDIR /usr/src/app
+
+# Install dependencies (e.g., node, if needed by Guard or other tools)
+RUN apt-get update -qq && apt-get install -y \
+  build-essential
+
+# Copy Gemfiles first to install gems separately (cache layer)
+COPY Gemfile* ./
+RUN bundle install
+
+# Copy rest of your project files
+COPY . .
+
+# Set entrypoint to Bash for dev container
+CMD [ "bash" ]

data/lib/spiker/templates/common/Makefile.tt

@@ -0,0 +1,11 @@
+build:
+	docker-compose build
+
+shell:
+	docker-compose run --rm app bash
+
+guard:
+	docker-compose run --rm app bundle exec guard
+
+test: # alias to guard
+	guard

data/lib/spiker/templates/common/docker-compose.yml.tt

@@ -0,0 +1,8 @@
+services:
+  app:
+    build: .
+    volumes:
+      - .:/usr/src/app
+    working_dir: /usr/src/app
+    tty: true
+    stdin_open: true

data/lib/spiker/{generators/templates/given/gemfile.rb → templates/given/Gemfile.tt}

@@ -5,10 +5,13 @@ source "https://rubygems.org"
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem "minitest"
-gem "minitest-reporters"
 gem "minitest-given"
+gem "minitest-reporters"
 
 gem "guard"
 gem "guard-minitest"
 
 gem "dotenv"
+
+gem "rubocop"
+gem "ruby-lsp"

data/lib/spiker/templates/given/app.rb.tt

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "dotenv/load"
+require "minitest"
+require "minitest/autorun"
+require "minitest/reporters"
+require "minitest/given"
+
+Minitest::Reporters.use!
+
+# Test for the class that's also defined in this file (look below).
+# The two tests here are just "smoke tests" to make sure everything
+# is wired up correctly.  From the command line, run:
+#  $ bundle exec guard
+describe "When Initializing a <%= config[:name_as_class] %>" do
+  context "Named Fred" do
+    Given(:fred) { <%= config[:name_as_class] %>.new(name: "Fred") }
+    Then {
+      expect(fred.name).must_equal "Fred"
+    }
+  end
+end
+
+# Spike your ideas here.
+class <%= config[:name_as_class] %>
+  attr_accessor :name
+
+  def initialize(name:)
+    @name = name
+  end
+end

data/lib/spiker/{generators/templates/simple/gemfile.rb → templates/multi/Gemfile.tt}

@@ -7,7 +7,10 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gem "minitest"
 gem "minitest-reporters"
 
+gem "dotenv"
+
 gem "guard"
 gem "guard-minitest"
 
-gem "dotenv"
+gem "rubocop"
+gem "ruby-lsp"

data/lib/spiker/{generators/templates/multi/app.rb.erb → templates/multi/app.rb.tt}

@@ -2,8 +2,9 @@
 
 require "dotenv/load"
 
+# Spike your ideas here
 class <%= config[:name_as_class] %>
   def self.hello
     "Hello, world!"
   end
-end
+end

data/lib/spiker/{generators/templates/multi/app_test.rb.erb → templates/multi/app_test.rb.tt}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'test_helper'
+require "test_helper"
 
-class <%= config[:name_as_class] %>Test < MiniTest::Test
+class <%= config[:name_as_class] %>Test < Minitest::Test
   def test_default_class_instantiates
     assert <%= config[:name_as_class] %>.new
   end
@@ -10,4 +10,4 @@ class <%= config[:name_as_class] %>Test < MiniTest::Test
   def test_default_class_responds_to_hello
     assert_equal "Hello, world!", <%= config[:name_as_class] %>.hello
   end
-end
+end

data/lib/spiker/{generators/templates/multi/test_helper.rb → templates/multi/test_helper.rb.tt}

@@ -11,7 +11,7 @@ require "dotenv/load"
 Minitest::Reporters.use!
 
 # ensure the environment is available
-class DefaultEnvironmentTest < MiniTest::Test
+class DefaultEnvironmentTest < Minitest::Test
   def test_default_environment
     assert_equal "test", ENV.fetch("TEST_VALUE", nil)
   end

data/lib/spiker/templates/rspec/Gemfile.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "rspec"
+
+gem "guard"
+gem "guard-rspec"
+
+gem "dotenv"
+
+gem "rubocop"
+gem "ruby-lsp"

data/lib/spiker/templates/rspec/Guardfile.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/lib/spiker/templates/rspec/README.md.tt

@@ -0,0 +1,44 @@
+# <%= config[:name_as_class] %> Spike
+
+This is the auto-generated README for the <%= config[:name_as_class] %> spike.  This content was generated by the [Spiker](https://github.com/norlinga/spiker) gem.
+
+## Getting Started
+
+This directory is the result of **someone** running the following command on a command line:
+
+    $ gem install spiker
+    $ spiker multi <%= config[:name] %>
+    $ cd <%= config[:name] %>
+
+Once inside the spike directory, open your favorite text editor and then execute the following command:
+
+    $ bundle install
+    $ guard
+
+Bundler will have executed once when the spike directory was first created, but it's no problem to run it again (in case the spike directory was shared between machines / environments).
+
+After starting Guard you should have been greeted with passing tests.  You are now ready to start hashing out your spike using specs.
+
+## Adding to This README
+
+This README could be a great place to capture findings from your spike.  Topics to address in this README might include:
+
+- what was the initial motivation for this spike?
+- what is the current state of this spike?
+- is there a future intention or unrealized goal for this spike?
+- what was discovered in the course of this spike?
+- who is involved in this spike?
+
+## Feel Free to Include Code
+
+Embedding code in a Markdown file is easy - this README uses the triple backtick syntax.  The following code will be rendered as a Ruby code block:
+
+```ruby
+require 'dotenv'
+
+puts ENV["TEST_VALUE"]
+
+"maybe show some code in your README?".capitalize
+```
+
+Spikes are intended to be short lived, but that's no reason to skip proper practices in your spike development.  Have fun!

data/lib/spiker/templates/rspec/Rakefile.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/spiker/templates/rspec/app.rb.tt

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "dotenv/load"
+
+# Spike your ideas here
+class <%= config[:name_as_class] %>
+  def self.hello
+    "Hello, world!"
+  end
+end

data/lib/spiker/templates/rspec/app_spec.rb.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe <%= config[:name_as_class] %> do
+  it "gives a cheerful greeting" do
+    expect(<%= config[:name_as_class] %>.hello).to eq("Hello, world!")
+  end
+end

data/lib/spiker/templates/rspec/spec_helper.rb.tt

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "dotenv/load"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "<%= config[:name_in_snake_case] %>"
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = ".rspec_status"
+  config.disable_monkey_patching!
+end

data/lib/spiker/{generators/templates/multi/gemfile.rb → templates/simple/Gemfile.tt}

@@ -6,6 +6,11 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem "minitest"
 gem "minitest-reporters"
+
 gem "guard"
 gem "guard-minitest"
+
 gem "dotenv"
+
+gem "rubocop"
+gem "ruby-lsp"

data/lib/spiker/templates/simple/app.rb.tt

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "dotenv/load"
+require "minitest"
+require "minitest/autorun"
+require "minitest/reporters"
+
+Minitest::Reporters.use!
+
+# Test for the class that's also defined in this file (look below).
+# The two tests here are just "smoke tests" to make sure everything
+# is wired up correctly.  From the command line, run:
+#  $ bundle exec guard
+class <%= config[:name_as_class] %>Test < Minitest::Test
+  def test_name
+    assert_equal "Fred", <%= config[:name_as_class] %>.new(name: "Fred").name
+  end
+
+  def test_default_env_value
+    assert_equal "test", ENV.fetch("TEST_VALUE", nil)
+  end
+end
+
+# Spike your ideas here.
+class <%= config[:name_as_class] %>
+  attr_accessor :name
+
+  def initialize(name:)
+    @name = name
+  end
+end

data/lib/spiker/utils.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# methods used in the generators
+module Spiker
+  def self.classify(str)
+    str.split(/[^A-Za-z0-0]/).map(&:capitalize).join
+  end
+
+  def self.snake_case(str)
+    # lifted from ActiveSupport inflectors
+    str.gsub("::", "/")
+       .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+       .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+       .tr("-", "_")
+       .downcase
+  end
+end

data/lib/spiker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spiker
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/spiker.rb

@@ -1,21 +1,18 @@
 # frozen_string_literal: true
 
-require_relative "spiker/version"
+require "thor"
+require "thor/group"
+
+require "spiker/version"
+require "spiker/utils"
+require "spiker/base_generator"
+require "spiker/generators/simple"
+require "spiker/generators/given"
+require "spiker/generators/multi"
+require "spiker/generators/rspec"
+require "spiker/cli"
 
 # Spiker is a simple spike generator.
 module Spiker
   class Error < StandardError; end
-
-  def self.classify(str)
-    str.split(/[^A-Za-z0-0]/).map(&:capitalize).join
-  end
-
-  def self.snake_case(str)
-    # lifted from ActiveSupport inflectors
-    str.gsub("::", "/")
-       .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-       .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-       .tr("-", "_")
-       .downcase
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spiker
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Aaron Norling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-27 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -33,39 +33,40 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- Gemfile
-- Gemfile.lock
-- Guardfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
 - exe/spiker
 - lib/spiker.rb
+- lib/spiker/base_generator.rb
 - lib/spiker/cli.rb
 - lib/spiker/generators/given.rb
 - lib/spiker/generators/multi.rb
+- lib/spiker/generators/rspec.rb
 - lib/spiker/generators/simple.rb
-- lib/spiker/generators/templates/common/basic.env
-- lib/spiker/generators/templates/given/app.rb.erb
-- lib/spiker/generators/templates/given/gemfile.rb
-- lib/spiker/generators/templates/given/guardfile.rb
-- lib/spiker/generators/templates/multi/app.rb.erb
-- lib/spiker/generators/templates/multi/app_test.rb.erb
-- lib/spiker/generators/templates/multi/gemfile.rb
-- lib/spiker/generators/templates/multi/guardfile.rb
-- lib/spiker/generators/templates/multi/rakefile.rb
-- lib/spiker/generators/templates/multi/readme.md.erb
-- lib/spiker/generators/templates/multi/test_helper.rb
-- lib/spiker/generators/templates/simple/app.rb.erb
-- lib/spiker/generators/templates/simple/gemfile.rb
-- lib/spiker/generators/templates/simple/guardfile.rb
+- lib/spiker/templates/common/Dockerfile.tt
+- lib/spiker/templates/common/Makefile.tt
+- lib/spiker/templates/common/basic.env.tt
+- lib/spiker/templates/common/docker-compose.yml.tt
+- lib/spiker/templates/given/Gemfile.tt
+- lib/spiker/templates/given/Guardfile.tt
+- lib/spiker/templates/given/app.rb.tt
+- lib/spiker/templates/multi/Gemfile.tt
+- lib/spiker/templates/multi/Guardfile.tt
+- lib/spiker/templates/multi/README.md.tt
+- lib/spiker/templates/multi/Rakefile.tt
+- lib/spiker/templates/multi/app.rb.tt
+- lib/spiker/templates/multi/app_test.rb.tt
+- lib/spiker/templates/multi/test_helper.rb.tt
+- lib/spiker/templates/rspec/Gemfile.tt
+- lib/spiker/templates/rspec/Guardfile.tt
+- lib/spiker/templates/rspec/README.md.tt
+- lib/spiker/templates/rspec/Rakefile.tt
+- lib/spiker/templates/rspec/app.rb.tt
+- lib/spiker/templates/rspec/app_spec.rb.tt
+- lib/spiker/templates/rspec/spec_helper.rb.tt
+- lib/spiker/templates/simple/Gemfile.tt
+- lib/spiker/templates/simple/Guardfile.tt
+- lib/spiker/templates/simple/app.rb.tt
+- lib/spiker/utils.rb
 - lib/spiker/version.rb
-- spiker.gemspec
 homepage: http://github.com/norlinga/spiker
 licenses:
 - MIT
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Properly spike your Ruby

data/.circleci/config.yml

@@ -1,13 +0,0 @@
-version: 2.1
-jobs:
-  build:
-    docker:
-      - image: ruby:3.3.0
-    steps:
-      - checkout
-      - run:
-          name: Run the default task
-          command: |
-            gem install bundler -v 2.2.3
-            bundle install
-            bundle exec rake

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rubocop.yml

@@ -1,16 +0,0 @@
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
-AllCops:
-  NewCops: enable
-  Exclude:
-    - 'exe/spiker'
-    - 'spiker.gemspec'

data/Gemfile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in spiker.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-group :development, :test do
-  gem "minitest", "~> 5.0"
-  gem "minitest-reporters", "~> 1.0"
-
-  gem "guard", "~> 2.18.0"
-  gem "guard-minitest", "~> 2.4.0"
-
-  gem "rubocop", "~> 1.60"
-end
-
-gem "thor", "~> 1.3"

data/Gemfile.lock

@@ -1,94 +0,0 @@
-PATH
-  remote: .
-  specs:
-    spiker (0.1.5)
-      thor (~> 1.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.2)
-    builder (3.2.4)
-    coderay (1.1.3)
-    ffi (1.16.3)
-    formatador (1.1.0)
-    guard (2.18.1)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.13.0)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-minitest (2.4.6)
-      guard-compat (~> 1.2)
-      minitest (>= 3.0)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    listen (3.8.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.10)
-    method_source (1.0.0)
-    minitest (5.21.2)
-    minitest-reporters (1.6.1)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    nenv (0.3.0)
-    notiffany (0.1.3)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
-      ast (~> 2.4.1)
-      racc
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.1.0)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.60.2)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.13.0)
-    shellany (0.0.1)
-    thor (1.3.0)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  ruby
-  x86_64-linux
-
-DEPENDENCIES
-  guard (~> 2.18.0)
-  guard-minitest (~> 2.4.0)
-  minitest (~> 5.0)
-  minitest-reporters (~> 1.0)
-  rake (~> 13.0)
-  rubocop (~> 1.60)
-  spiker!
-  thor (~> 1.3)
-
-BUNDLED WITH
-   2.5.5

data/Guardfile

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-clearing :on
-
-guard :minitest, all_after_pass: true do
-  watch(%r{^test/(.*)/?(.*)_test\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/test_helper\.rb$})      { "test" }
-end

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022-2024 Aaron Norling
-
-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

@@ -1,77 +0,0 @@
-# Spiker
-
-Spiker helps you validate your ideas under test.  It can also be a basic educational tool, giving the learner a minimal framework to start writing and testing their Ruby code.
-
-## Installation
-
-[![Gem Version](https://badge.fury.io/rb/spiker.svg)](https://badge.fury.io/rb/spiker)
-
-Install it directly:
-
-    $ gem install spiker
-
-## Usage
-
-In the terminal, change directory to someplace where you want to collect your spikes:
-
-    $ cd ~/spikes
-
-Then, create a new spike:
-
-    $ spiker simple my_spike
-    $ cd my_spike
-
-Using the "simple" formula, Spiker will create an `app.rb` file, a `Gemfile`, a `Guardfile` and an `.env` file for configuration, to be read by the `dotenv` gem.  The `app.rb` file will contain boilerplate for both Minitest and a Ruby class in the same file:  
-
-```ruby
-require 'dotenv/load'
-require 'minitest'
-require 'minitest/autorun'
-require 'minitest/reporters'
-
-Minitest::Reporters.use!
-
-class MySpikeTest < Minitest::Test
-  def test_name
-    assert_equal "Fred", MySpike.new(name: "Fred").name
-  end
-
-  def test_default_env_value
-    assert_equal "test", ENV["TEST_VALUE"]
-  end
-end
-
-class MySpike
-  attr_accessor :name
-  def initialize(name:)
-    @name = name
-  end
-end
-```
-
-From here, the user should be able to start Guard and immediately begin development in a red-green fashion.
-
-## Types of Spikes
-
-The `simple` option shown above puts the code and the tests together in a single file, which can be useful in a number of circumstances.  Similar to the `simple` option, the `given` option puts the code and tests in the same file but offers the user the Minitest::Spec and ::Given syntax options.  Learn more about the [Given/When/Then](https://en.wikipedia.org/wiki/Given-When-Then) syntax on Wikipedia, or the work of Jim Weirich related to Rspec with [Given](https://github.com/jimweirich/rspec-given).
-
-The `multi` option places directories and files into a named directory, and is intended to flesh out a more complex spike that includes a tests directory and `test_helper.rb`, a `lib` directory, README.md, etc.  The overall workflow is still the same:
-
-    $ spiker multi my_spike
-    $ cd my_spike
-
-Bundle will run automatically and the user will be able to start development in a red-green fashion just the same as with the simple spike.  There is also a Rakefile provided, the Guardfile is modified from the simple version to include files in directories, and simple tests are predefined.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/norlinga/spiker.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "spiker"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/spiker/generators/templates/given/app.rb.erb

@@ -1,23 +0,0 @@
-require 'dotenv/load'
-require 'minitest'
-require 'minitest/autorun'
-require 'minitest/reporters'
-require 'minitest/given'
-
-Minitest::Reporters.use!
-
-describe 'When Initializing a <%= config[:name_as_class] %>' do
-  context 'Named Fred' do
-    Given(:fred) { <%= config[:name_as_class] %>.new(name: 'Fred') }
-    Then {
-      expect(fred.name).must_equal 'Fred'
-    }      
-  end
-end
-
-class <%= config[:name_as_class] %>
-  attr_accessor :name
-  def initialize(name:)
-    @name = name
-  end
-end

data/lib/spiker/generators/templates/simple/app.rb.erb

@@ -1,23 +0,0 @@
-require 'dotenv/load'
-require 'minitest'
-require 'minitest/autorun'
-require 'minitest/reporters'
-
-Minitest::Reporters.use!
-
-class <%= config[:name_as_class] %>Test < Minitest::Test
-  def test_name
-    assert_equal "Fred", <%= config[:name_as_class] %>.new(name: 'Fred').name
-  end
-
-  def test_default_env_value
-    assert_equal "test", ENV["TEST_VALUE"]
-  end
-end
-
-class <%= config[:name_as_class] %>
-  attr_accessor :name
-  def initialize(name:)
-    @name = name
-  end
-end

data/spiker.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/spiker/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "spiker"
-  spec.version       = Spiker::VERSION
-  spec.authors       = ["Aaron Norling"]
-  spec.email         = ["me@aaronware.com"]
-
-  spec.summary       = "Properly spike your Ruby"
-  spec.description   = "Scaffold for code spikes, includes simple boilerplate with Minitest + Guard to make red/green work out-of-the-box."
-  spec.homepage      = "http://github.com/norlinga/spiker"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/norlinga/spiker"
-  spec.metadata["changelog_uri"] = "https://github.com/norlinga/spiker"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "thor", "~> 1.3"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end