spiker 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a83635eae4874bcb567fdcae912b250f3c4096620c5703885d5de9c501527090
-  data.tar.gz: f2dc29b6a4dd30cf380c44b68f970f15ac93cea3db71ab86db22c657a4e9ea65
+  metadata.gz: d65d9dc195dfb1282b040fbfcac1139d9cc4c44f8bae2441deef02901ad0e38a
+  data.tar.gz: add551461d8e80b7626e5c96e738ed79b93ee360b3c2d7f809f07e90390a20f6
 SHA512:
-  metadata.gz: 63f83edb340f1480c296fbc6eff8e1f943086f0bfecf3146d0f9581d0a674131b66bb196ae65bcf9893e5c3003fa0dda49419b3acdfa06449f27c4118dafc448
-  data.tar.gz: '03718cc66377cd005f6a27334da152ab2f331c52e5f58d60a0f24dcc73eda967a30cc94a8479433b59fdc19c577a9bf880ef36e92352bffde3b523069accab0e'
+  metadata.gz: f90ec88cf889ab847482622d47e040b5c6ba64b664e261b21c3076963a5f669d027f3cbc494349d48fcc7c44902cec6878a60e50181e67690f6facacf3abfef4
+  data.tar.gz: 0ec1b5564017f569255ffbec1286b85a5edf793c98e9a23fa4cd08d1c1b4bbda6b20ad2cb09ee648bc91be32c284f947748e2293002ed90fe079b26674eaa100

data/.rubocop.yml

@@ -12,6 +12,5 @@ Layout/LineLength:
 AllCops:
   NewCops: enable
   Exclude:
-    - 'lib/spiker/generators/templates/**'
     - 'exe/spiker'
     - 'spiker.gemspec'

data/Gemfile.lock

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

data/README.md

@@ -1,20 +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
 
-Add this line to your application's Gemfile:
+[![Gem Version](https://badge.fury.io/rb/spiker.svg)](https://badge.fury.io/rb/spiker)
 
-```ruby
-gem 'spiker'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
+Install it directly:
 
     $ gem install spiker
 
@@ -29,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/load'
 require 'minitest'
 require 'minitest/autorun'
 require 'minitest/reporters'
@@ -39,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
 
@@ -54,7 +51,12 @@ end
 
 From here, the user should be able to start Guard and immediately begin development in a red-green fashion.
 
-The "multiple" option is not implemented yet, but 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 "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
 

data/lib/spiker/cli.rb

@@ -3,12 +3,15 @@
 require "thor"
 require_relative "version"
 require_relative "generators/simple"
-require_relative "generators/multiple"
+require_relative "generators/given"
+require_relative "generators/multi"
 
 module Spiker
-  # Accept options "single" and "multiple"
-  # 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,10 +24,16 @@ module Spiker
       Spiker::Generators::Simple.start([name])
     end
 
-    desc "multiple NAME", "Spike over multiple files"
+    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)
-      Spiker::Generators::Multiple.start([name])
+      Spiker::Generators::Multi.start([name])
     end
   end
 end

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

@@ -0,0 +1,68 @@
+# 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_as_class, name_in_snake_case: 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("app.rb.erb", "#{name}/lib/#{name_in_snake_case}.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_rake_file
+        template("rakefile.rb", "#{name}/Rakefile")
+      end
+
+      def create_readme_file
+        opts = { name_as_class: Spiker.classify(name), name: name }
+        template("readme.md.erb", "#{name}/README.md", opts)
+      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/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
@@ -21,16 +21,20 @@ module Spiker
       end
 
       def create_spike_file
-        opts = {name_as_class: Spiker.classify(name)}
-        template("simple_app.rb", "#{name}/app.rb", opts)
+        opts = { name_as_class: Spiker.classify(name) }
+        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("../common/basic.env", "#{name}/.env")
       end
 
       def run_bundler

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

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

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.rb.erb

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

data/lib/spiker/generators/templates/multi/app_test.rb.erb

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

data/lib/spiker/generators/templates/{simple_gemfile.rb → multi/gemfile.rb}

@@ -4,8 +4,8 @@ source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'minitest'
-gem 'minitest-reporters'
-
-gem 'guard'
-gem 'guard-minitest'
+gem "minitest"
+gem "minitest-reporters"
+gem "guard"
+gem "guard-minitest"
+gem "dotenv"

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

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

data/lib/spiker/generators/templates/multi/rakefile.rb

@@ -0,0 +1,12 @@
+# 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
+
+task default: %i[test]

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+# require the default lib file
+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::Test
+  def test_default_environment
+    assert_equal "test", ENV["TEST_VALUE"]
+  end
+end

data/lib/spiker/generators/templates/{simple_app.rb → 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

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

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+clearing :on
+
+guard :minitest, all_after_pass: true, test_folders: ["."], test_file_patterns: "*.rb" do
+  # with Minitest::Unit
+  watch(/^app\.rb$/) { "./app.rb" }
+end

data/lib/spiker/version.rb

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

data/lib/spiker.rb

@@ -2,10 +2,20 @@
 
 require_relative "spiker/version"
 
+# 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

data/spiker.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   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/norling/spiker."
+  spec.homepage      = "http://github.com/norlinga/spiker"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spiker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Aaron Norling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -47,19 +47,31 @@ files:
 - exe/spiker
 - lib/spiker.rb
 - lib/spiker/cli.rb
-- lib/spiker/generators/multiple.rb
+- lib/spiker/generators/given.rb
+- lib/spiker/generators/multi.rb
 - lib/spiker/generators/simple.rb
-- lib/spiker/generators/templates/simple_app.rb
-- 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/norling/spiker.
+homepage: http://github.com/norlinga/spiker
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: http://github.com/norling/spiker.
+  homepage_uri: http://github.com/norlinga/spiker
   source_code_uri: https://github.com/norlinga/spiker
   changelog_uri: https://github.com/norlinga/spiker
 post_install_message: 

data/lib/spiker/generators/multiple.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "thor/group"
-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 Multiple < Thor::Group
-      include Thor::Actions
-
-      argument :name, type: :string
-    end
-  end
-end

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

@@ -1,6 +0,0 @@
-clearing :on
-
-guard :minitest, all_after_pass: true, test_folders: ['.'], test_file_patterns: '*.rb' do
-  # with Minitest::Unit
-  watch(%r{^app\.rb$})      { './app.rb' }
-end