spiker 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6183b45c44cffdac7e55a8cc487634185d550b98b88802d331e66b4d19e5159
-  data.tar.gz: c96d176df0f11614308af344020b8a3b546e291fcb0dc94b7c97724867a9a6e5
+  metadata.gz: d65d9dc195dfb1282b040fbfcac1139d9cc4c44f8bae2441deef02901ad0e38a
+  data.tar.gz: add551461d8e80b7626e5c96e738ed79b93ee360b3c2d7f809f07e90390a20f6
 SHA512:
-  metadata.gz: 61065d34c4b29b1f541ec91274d326536f3952f2e94ed4efad1863bcf81b2eb2b335d140eb9eb2b38ed866ead8bcb213e7b6eff536dc7e71dfe8f9e41507c8a0
-  data.tar.gz: fc2d21d8670e09eb8acd314ae5e75c6caf57f6b880e02cc4becebfab2c6d439bb937da3abf464cc22b8a6d34fcad2fdd380a115ebe14706d9d890f168ab89d0e
+  metadata.gz: f90ec88cf889ab847482622d47e040b5c6ba64b664e261b21c3076963a5f669d027f3cbc494349d48fcc7c44902cec6878a60e50181e67690f6facacf3abfef4
+  data.tar.gz: 0ec1b5564017f569255ffbec1286b85a5edf793c98e9a23fa4cd08d1c1b4bbda6b20ad2cb09ee648bc91be32c284f947748e2293002ed90fe079b26674eaa100

data/Gemfile.lock

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

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'

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
@@ -27,35 +27,35 @@ module Spiker
         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)
+        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)
+        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,7 +11,7 @@ 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"]
   end

data/lib/spiker/version.rb

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

metadata

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