spiker 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6183b45c44cffdac7e55a8cc487634185d550b98b88802d331e66b4d19e5159
-  data.tar.gz: c96d176df0f11614308af344020b8a3b546e291fcb0dc94b7c97724867a9a6e5
+  metadata.gz: 98350ed051acebc34e10ec68fb8c7cf2a92bf965a6488db604e03b6c5db29dda
+  data.tar.gz: 1def1fb1ea6f87032c8122d1fd64e1703a9c9c328acfd0b41c943321c6f4a539
 SHA512:
-  metadata.gz: 61065d34c4b29b1f541ec91274d326536f3952f2e94ed4efad1863bcf81b2eb2b335d140eb9eb2b38ed866ead8bcb213e7b6eff536dc7e71dfe8f9e41507c8a0
-  data.tar.gz: fc2d21d8670e09eb8acd314ae5e75c6caf57f6b880e02cc4becebfab2c6d439bb937da3abf464cc22b8a6d34fcad2fdd380a115ebe14706d9d890f168ab89d0e
+  metadata.gz: 4fbf79f17bd7b7f63a7d8ed10818be30b55e72466e943f17427d10ec5bb2b42bdd5a13874a7933f67b0fb01a52ef49f56043f2a3648b426fb3939b3aa81de1e7
+  data.tar.gz: b629943faee3516a88bbc5412bdfb72ab0c7f21076bd9e26433bd11053dd18f56f828e3ff0fd0f87607710622f45673f14732a5f624daff799c0e610172efacf

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2.1
 jobs:
   build:
     docker:
-      - image: ruby:3.0.0
+      - image: ruby:3.3.0
     steps:
       - checkout
       - run:

data/Gemfile

@@ -7,12 +7,14 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "minitest", "~> 5.0"
-gem "minitest-reporters", "~> 1.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 "guard", "~> 2.18.0"
+  gem "guard-minitest", "~> 2.4.0"
 
-gem "rubocop", "~> 0.93.0"
+  gem "rubocop", "~> 1.60"
+end
 
-gem "thor", "~> 0.20.0"
+gem "thor", "~> 1.3"

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    spiker (0.1.4)
-      thor (~> 0.19)
+    spiker (0.1.5)
+      thor (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -11,9 +11,9 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
-    ffi (1.15.5)
-    formatador (0.3.0)
-    guard (2.18.0)
+    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)
@@ -26,13 +26,15 @@ GEM
     guard-minitest (2.4.6)
       guard-compat (~> 1.2)
       minitest (>= 3.0)
-    listen (3.7.1)
+    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.8)
+    lumberjack (1.2.10)
     method_source (1.0.0)
-    minitest (5.15.0)
-    minitest-reporters (1.5.0)
+    minitest (5.21.2)
+    minitest-reporters (1.6.1)
       ansi
       builder
       minitest (>= 5.0)
@@ -41,36 +43,41 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    rb-fsevent (0.11.0)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.2.0)
-    rexml (3.2.5)
-    rubocop (0.93.1)
+    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 (>= 2.7.1.5)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.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 (>= 1.4.0, < 2.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
+      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 (0.20.3)
-    unicode-display_width (1.8.0)
+    thor (1.3.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
@@ -79,9 +86,9 @@ DEPENDENCIES
   minitest (~> 5.0)
   minitest-reporters (~> 1.0)
   rake (~> 13.0)
-  rubocop (~> 0.93.0)
+  rubocop (~> 1.60)
   spiker!
-  thor (~> 0.20.0)
+  thor (~> 1.3)
 
 BUNDLED WITH
-   2.2.3
+   2.5.5

data/LICENSE.txt

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

data/README.md

@@ -24,7 +24,7 @@ Then, create a new 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'
+require 'dotenv/load'
 require 'minitest'
 require 'minitest/autorun'
 require 'minitest/reporters'
@@ -51,7 +51,11 @@ end
 
 From here, the user should be able to start Guard and immediately begin development in a red-green fashion.
 
-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:
+## 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

data/lib/spiker/cli.rb

@@ -3,12 +3,15 @@
 require "thor"
 require_relative "version"
 require_relative "generators/simple"
+require_relative "generators/given"
 require_relative "generators/multi"
 
 module Spiker
-  # Accept options "single" and "multi"
-  # for single-file spikes or multi-file spikes
-  # and a name for the spike directory.  That is all
+  # Accept options "simple", "given", or "multi".
+  # 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
+  # spike directory with tests, code, README, etc.  That is all.
   class CLI < Thor
     desc "version", "Show version"
     def version
@@ -21,6 +24,12 @@ module Spiker
       Spiker::Generators::Simple.start([name])
     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])
+    end
+
     desc "multi NAME", "Spike over multiple files"
     method_option :name, type: :string, aliases: "-n", desc: "Name of the spike"
     def multiple(name)

data/lib/spiker/generators/given.rb

@@ -0,0 +1,47 @@
+# 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
+
+      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
+      end
+    end
+  end
+end

data/lib/spiker/generators/multi.rb

@@ -14,7 +14,7 @@ module Spiker
       argument :name, type: :string
 
       def self.source_root
-        "#{File.dirname(__FILE__)}/templates"
+        "#{File.dirname(__FILE__)}/templates/multi"
       end
 
       def create_spike_directories
@@ -26,36 +26,36 @@ module Spiker
       def create_test_files
         name_in_snake_case = Spiker.snake_case(name)
         name_as_class = Spiker.classify(name)
-        opts = { name_as_class: name_as_class, name_in_snake_case: name_in_snake_case }
-        template("multi_app_test.rb.erb", "#{name}/test/#{name_in_snake_case}_test.rb", opts)
-        template("multi_test_helper.rb", "#{name}/test/test_helper.rb", opts)
+        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)
       end
 
       def create_app_files
         name_in_snake_case = Spiker.snake_case(name)
         opts = { name_as_class: Spiker.classify(name) }
-        template("multi_app.rb.erb", "#{name}/lib/#{name_in_snake_case}.rb", opts)
+        template("app.rb.erb", "#{name}/lib/#{name_in_snake_case}.rb", opts)
       end
 
       def create_guard_file
-        template("multi_guardfile.rb", "#{name}/Guardfile")
+        template("guardfile.rb", "#{name}/Guardfile")
       end
 
       def create_gem_file
-        template("multi_gemfile.rb", "#{name}/Gemfile")
+        template("gemfile.rb", "#{name}/Gemfile")
       end
 
       def create_rake_file
-        template("multi_rakefile.rb", "#{name}/Rakefile")
+        template("rakefile.rb", "#{name}/Rakefile")
       end
 
       def create_readme_file
-        opts = { name_as_class: Spiker.classify(name), name: name }
-        template("multi_readme.md.erb", "#{name}/README.md", opts)
+        opts = { name_as_class: Spiker.classify(name), name: }
+        template("readme.md.erb", "#{name}/README.md", opts)
       end
 
       def create_env_file
-        template("basic.env", "#{name}/.env")
+        template("../common/basic.env", "#{name}/.env")
       end
 
       def run_bundler

data/lib/spiker/generators/simple.rb

@@ -13,7 +13,7 @@ module Spiker
       argument :name, type: :string
 
       def self.source_root
-        "#{File.dirname(__FILE__)}/templates"
+        "#{File.dirname(__FILE__)}/templates/simple"
       end
 
       def create_spike_directory
@@ -22,19 +22,19 @@ module Spiker
 
       def create_spike_file
         opts = { name_as_class: Spiker.classify(name) }
-        template("simple_app.rb.erb", "#{name}/app.rb", opts)
+        template("app.rb.erb", "#{name}/app.rb", opts)
       end
 
       def create_guard_file
-        template("simple_guardfile.rb", "#{name}/Guardfile")
+        template("guardfile.rb", "#{name}/Guardfile")
       end
 
       def create_gem_file
-        template("simple_gemfile.rb", "#{name}/Gemfile")
+        template("gemfile.rb", "#{name}/Gemfile")
       end
 
       def create_env_file
-        template("basic.env", "#{name}/.env")
+        template("../common/basic.env", "#{name}/.env")
       end
 
       def run_bundler

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

@@ -0,0 +1,23 @@
+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/given/gemfile.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "minitest"
+gem "minitest-reporters"
+gem "minitest-given"
+
+gem "guard"
+gem "guard-minitest"
+
+gem "dotenv"

data/lib/spiker/generators/templates/given/guardfile.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+clearing :on
+
+guard :minitest, all_after_pass: true, test_folders: ["."], test_file_patterns: "*.rb" do
+  # We're using Minitest's Spec syntax, loaded by Given.
+  # We don't have to watch for spec files through because
+  # we're using a single file, which is also the app file.
+  watch(/^app\.rb$/) { "./app.rb" }
+end

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

@@ -2,7 +2,7 @@
 
 require 'test_helper'
 
-class <%= config[:name_as_class] %>Test < MiniTest::Unit::TestCase
+class <%= config[:name_as_class] %>Test < MiniTest::Test
   def test_default_class_instantiates
     assert <%= config[:name_as_class] %>.new
   end

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

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

data/lib/spiker/version.rb

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

data/lib/spiker.rb

@@ -12,7 +12,7 @@ module Spiker
 
   def self.snake_case(str)
     # lifted from ActiveSupport inflectors
-    str.gsub(/::/, "/")
+    str.gsub("::", "/")
        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
        .tr("-", "_")

data/spiker.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "thor", "~> 0.19"
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spiker
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Aaron Norling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-29 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.3'
 description: Scaffold for code spikes, includes simple boilerplate with Minitest +
   Guard to make red/green work out-of-the-box.
 email:
@@ -47,19 +47,23 @@ files:
 - exe/spiker
 - lib/spiker.rb
 - lib/spiker/cli.rb
+- lib/spiker/generators/given.rb
 - lib/spiker/generators/multi.rb
 - lib/spiker/generators/simple.rb
-- lib/spiker/generators/templates/basic.env
-- 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/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/version.rb
 - spiker.gemspec
 homepage: http://github.com/norlinga/spiker
@@ -85,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.5
 signing_key: 
 specification_version: 4
 summary: Properly spike your Ruby