spiker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6807d10b0e21344ac48f335257b7a92e41cce9ce140b7f73b3f31545d06d7135
+  data.tar.gz: cd463be9673e5f188459c1ad61e5460dd5b4e9fb05fe6d61651abfd733de1b2c
+SHA512:
+  metadata.gz: ee478066198cd3b8f3e2bb122d1bd43156dc08a13d2229ad72f1b63f68c67c2ba3d7a6aae8af33d43d319073673228b57dc7ce721b943be61ac8d5c802e2379c
+  data.tar.gz: e753e0e8618365cd74d7f1ee9a38733a1be9e20102e7ab5c22fdb3693566360ab24d6ea21c5a34e34055b4f60e63de51f76c14804c1ff22e3a3463d2265432ed

data/.circleci/config.yml

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

data/.gitignore

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

data/.rubocop.yml

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

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in spiker.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+gem "minitest-reporters", "~> 1.0"
+
+gem "guard", "~> 2.18.0"
+gem "guard-minitest", "~> 2.4.0"
+
+gem "rubocop", "~> 0.93.0"
+
+gem "thor", "~> 0.20.0"

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    spiker (0.1.0)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    ffi (1.15.5)
+    formatador (0.3.0)
+    guard (2.18.0)
+      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)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.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)
+    shellany (0.0.1)
+    thor (0.20.3)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  guard (~> 2.18.0)
+  guard-minitest (~> 2.4.0)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.0)
+  rake (~> 13.0)
+  rubocop (~> 0.93.0)
+  spiker!
+  thor (~> 0.20.0)
+
+BUNDLED WITH
+   2.2.3

data/Guardfile

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

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

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

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

@@ -0,0 +1,15 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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/exe/spiker

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

data/lib/spiker/cli.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "version"
+require_relative "generators/simple"
+require_relative "generators/multiple"
+
+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
+  class CLI < Thor
+    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])
+    end
+
+    desc "multiple 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])
+    end
+  end
+end

data/lib/spiker/generators/multiple.rb

@@ -0,0 +1,15 @@
+# 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/simple.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "thor/group"
+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"
+      end
+
+      def create_spike_directory
+        empty_directory(name)
+      end
+
+      def create_spike_file
+        template("simple_app.rb", "#{name}/app.rb")
+      end
+
+      def create_guard_file
+        template("simple_guardfile.rb", "#{name}/Guardfile")
+      end
+
+      def create_gem_file
+        template("simple_gemfile.rb", "#{name}/Gemfile")
+      end
+
+      def run_bundler
+        inside(name) do
+          run("bundle install")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+Minitest::Reporters.use!
+
+class <%= name.capitalize %>Test < Minitest::Test
+  def test_that_it_works
+    assert true
+  end
+end
+
+class <%= name.capitalize %>
+  attr_accessor :name
+  def initialize(name:)
+    @name = name
+  end
+end

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

@@ -0,0 +1,11 @@
+# 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'

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

@@ -0,0 +1,6 @@
+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

data/lib/spiker/version.rb

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

data/lib/spiker.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "spiker/version"
+
+module Spiker
+  class Error < StandardError; end
+end

data/spiker.gemspec

@@ -0,0 +1,37 @@
+# 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/norling/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", "~> 0.19"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: spiker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Norling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: Scaffold for code spikes, includes simple boilerplate with Minitest +
+  Guard to make red/green work out-of-the-box.
+email:
+- me@aaronware.com
+executables:
+- spiker
+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/cli.rb
+- lib/spiker/generators/multiple.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/version.rb
+- spiker.gemspec
+homepage: http://github.com/norling/spiker.
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://github.com/norling/spiker.
+  source_code_uri: https://github.com/norlinga/spiker
+  changelog_uri: https://github.com/norlinga/spiker
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Properly spike your Ruby
+test_files: []