spiker 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 907101e30efff6e0426d45830d7907599b4ee590b7415381d6515e610a454beb
-  data.tar.gz: 8befa5bc352c113c415e9ca223c4a24549213196a748dca6ee543d911b04b830
+  metadata.gz: f6183b45c44cffdac7e55a8cc487634185d550b98b88802d331e66b4d19e5159
+  data.tar.gz: c96d176df0f11614308af344020b8a3b546e291fcb0dc94b7c97724867a9a6e5
 SHA512:
-  metadata.gz: '09045548a1f614957922c597fe54ece30bf8a76cbf26dcfb59c54d3b57230f3cd6deb80e3c73370dadd8628a6fa775a8dd076049590e4bb7efdfc6f7f24a8dfb'
-  data.tar.gz: 21279e2734fd077c48a9414554139b1adc9adb757dc7d629fb76da27cb60a7ad78f9d4f6434502e83138dd35dab6565ab9139bc89e73908c6dcac2fe3acb5cd6
+  metadata.gz: 61065d34c4b29b1f541ec91274d326536f3952f2e94ed4efad1863bcf81b2eb2b335d140eb9eb2b38ed866ead8bcb213e7b6eff536dc7e71dfe8f9e41507c8a0
+  data.tar.gz: fc2d21d8670e09eb8acd314ae5e75c6caf57f6b880e02cc4becebfab2c6d439bb937da3abf464cc22b8a6d34fcad2fdd380a115ebe14706d9d890f168ab89d0e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spiker (0.1.3)
+    spiker (0.1.4)
       thor (~> 0.19)
 
 GEM

data/README.md

@@ -1,22 +1,12 @@
 # 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 the Ruby code.
+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)
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'spiker'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
+Install it directly:
 
     $ gem install spiker
 
@@ -31,9 +21,10 @@ 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`, and a `Guardfile`.  The `app.rb` file will contain boilerplate for both Minitest and a Ruby class in the same file:  
+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 'minitest'
 require 'minitest/autorun'
 require 'minitest/reporters'
@@ -41,8 +32,12 @@ require 'minitest/reporters'
 Minitest::Reporters.use!
 
 class MySpikeTest < Minitest::Test
-  def test_that_it_works
-    assert true
+  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
 

data/lib/spiker/cli.rb

@@ -6,8 +6,8 @@ require_relative "generators/simple"
 require_relative "generators/multi"
 
 module Spiker
-  # Accept options "single" and "multiple"
-  # for single file spikes or multi-file spikes
+  # Accept options "single" and "multi"
+  # for single-file spikes or multi-file spikes
   # and a name for the spike directory.  That is all
   class CLI < Thor
     desc "version", "Show version"

data/lib/spiker/generators/multi.rb

@@ -49,6 +49,15 @@ module Spiker
         template("multi_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)
+      end
+
+      def create_env_file
+        template("basic.env", "#{name}/.env")
+      end
+
       def run_bundler
         inside(name) do
           run("bundle install")

data/lib/spiker/generators/simple.rb

@@ -33,6 +33,10 @@ module Spiker
         template("simple_gemfile.rb", "#{name}/Gemfile")
       end
 
+      def create_env_file
+        template("basic.env", "#{name}/.env")
+      end
+
       def run_bundler
         inside(name) do
           run("bundle install")

data/lib/spiker/generators/templates/basic.env

@@ -0,0 +1 @@
+TEST_VALUE="test"

data/lib/spiker/generators/templates/multi_app.rb.erb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "dotenv/load"
+
 class <%= config[:name_as_class] %>
   def self.hello
     "Hello, world!"

data/lib/spiker/generators/templates/multi_gemfile.rb

@@ -8,3 +8,4 @@ gem "minitest"
 gem "minitest-reporters"
 gem "guard"
 gem "guard-minitest"
+gem "dotenv"

data/lib/spiker/generators/templates/multi_readme.md.erb

@@ -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 under test.
+
+## 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/generators/templates/multi_test_helper.rb

@@ -6,5 +6,13 @@ require "<%= config[:name_in_snake_case] %>"
 
 require "minitest/autorun"
 require "minitest/reporters"
+require "dotenv/load"
 
 Minitest::Reporters.use!
+
+# ensure the environment is available
+class DefaultEnvironmentTest < MiniTest::Unit::TestCase
+  def test_default_environment
+    assert_equal "test", ENV["TEST_VALUE"]
+  end
+end

data/lib/spiker/generators/templates/simple_app.rb.erb

@@ -1,3 +1,4 @@
+require 'dotenv/load'
 require 'minitest'
 require 'minitest/autorun'
 require 'minitest/reporters'
@@ -5,8 +6,12 @@ require 'minitest/reporters'
 Minitest::Reporters.use!
 
 class <%= config[:name_as_class] %>Test < Minitest::Test
-  def test_that_it_works
-    assert true
+  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
 

data/lib/spiker/generators/templates/simple_gemfile.rb

@@ -9,3 +9,5 @@ gem "minitest-reporters"
 
 gem "guard"
 gem "guard-minitest"
+
+gem "dotenv"

data/lib/spiker/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spiker
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Aaron Norling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-23 00:00:00.000000000 Z
+date: 2022-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -49,11 +49,13 @@ files:
 - lib/spiker/cli.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