oops_a_rake 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6122dbeca5b52f5299d5213a706c658ce6c1e3943fc7affb1e5c3f78c0157d4d
+  data.tar.gz: bffe2ce604a67dbcbecf2f41890737e754944765a70248c1aa9340df54fa179f
+SHA512:
+  metadata.gz: 58b3a32e770b27fc4c5d5022ea853075a05ec6ab14ea23cecf86574d65b1b740772fac8adf076d7718f39916a640e93b78bdafbb046ae17c29e93c9837f5ea50
+  data.tar.gz: 6042433cb2eacbefa096f8a9197172e2fb3bd3e77bf7bebd98889639cf370ae3a7d2a2b1575f5f1a4aaf9a858af1f4508dd17fc81ecc85d8aaaa753eef712760

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in oops_a_rake.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    oops_a_rake (0.1.0)
+      activesupport (>= 5.2)
+      rake (>= 12.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  oops_a_rake!
+  pry
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Oliver Peate
+
+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,177 @@
+# OOP(s) a Rake
+
+Write your Rake tasks as plain-old Ruby objects.
+
+## Setup
+
+Add the gem to your Gemfile and `bundle install`:
+
+```ruby
+gem "oops_a_rake"
+```
+
+In your Rakefile, require `oops_a_rake` and require your tasks:
+
+```ruby
+# Rakefile
+
+require "oops_a_rake"
+
+Dir.glob("lib/tasks/*.rb").each { |task| require_relative(task) }
+```
+
+## Usage
+
+### Simple task with a description
+
+Write a class which:
+
+- responds to `#call`
+- includes `OopsARake::Task`
+
+```ruby
+class GreetingTask
+  include OopsARake::Task
+
+  description "An enthusiastic greeting"
+
+  def call
+    puts "Hello!"
+  end
+end
+```
+
+When you list all the Rake tasks in the project:
+
+```sh
+$ bundle exec rake --tasks
+```
+
+You should see the `greeting` task listed (note the optional 'task' suffix from
+the class name is omitted):
+
+```
+rake greeting   # An enthusiastic greeting
+```
+
+N.B. Unless you include a `description` for a task then Rake won't list it by
+default. Run `bundle exec rake --tasks --all` to see tasks without descriptions.
+
+### Task with arguments
+
+**Note:** Only positional arguments are supported.
+
+```ruby
+class PersonalizedGreetingTask
+  include OopsARake::Task
+
+  def call(name)
+    puts "Hello #{name}!"
+  end
+end
+```
+
+Invocation:
+
+```sh
+bundle exec rake "personalized_greeting[Bob]"
+# => Hello Bob!
+```
+
+### Task with prequisites
+
+```ruby
+class ComplexSetupTask
+  include OopsARake::Task
+
+  prerequisites :task_one, :task_two
+
+  def call
+    # Your implementation
+  end
+end
+```
+
+### Namespaced task
+
+```ruby
+class Admin::SpecialTask
+  include OopsARake::Task
+
+  def call
+    # Your implementation
+  end
+end
+```
+
+Invocation:
+
+```sh
+bundle exec rake admin:special
+```
+
+## Motivation
+
+Rake is an omnipresent tool in the Ruby world. It has some drawbacks – the main
+issue I've heard repeatedly is how difficult it is to test Rake tasks.
+
+Testing Rake tasks isn't impossible, but it's complex and requires some
+familiarity with how Rake works (see [Test Rake Tasks Like a BOSS][testing-tasks]
+for an excellent guide).
+
+As a result I've seen many codebases which opt for writing thin Rake tasks that
+call a plain Ruby object, which is tested in isolation:
+
+```ruby
+task :greeting do |_, args|
+  GreetingTask.new(*args).call
+end
+```
+
+Instead of writing this glue-code by hand it's cleaner to write your tasks as
+objects:
+
+```ruby
+# lib/tasks/greeting_task.rb
+
+class GreetingTask
+  include OopsARake::Task
+
+  def call(name)
+    puts "Hello #{name}"
+  end
+end
+```
+
+To test this task you can then initialize a new instance and invoke `#call`.
+This side-steps any requirement to manage Rake's world in tests. For example in
+RSpec:
+
+
+```ruby
+require "tasks/greeting_task"
+
+RSpec.describe GreetingTask do
+  it "personalizes the greeting" do
+    task = described_class.new
+    task.call("Bob")
+
+    # ... rest of your test
+  end
+end
+```
+
+This approach is heavily inspired by Sidekiq, which allows jobs to be tested the
+same way:
+
+```ruby
+class HardWorker
+  include Sidekiq::Worker
+
+  def perform(name, count)
+    # do something
+  end
+end
+```
+
+[testing-tasks]: https://thoughtbot.com/blog/test-rake-tasks-like-a-boss

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/lib/oops_a_rake.rb

@@ -0,0 +1,6 @@
+require "oops_a_rake/task"
+require "oops_a_rake/version"
+
+module OopsARake
+  class Error < StandardError; end
+end

data/lib/oops_a_rake/registry.rb

@@ -0,0 +1,23 @@
+require "rake"
+require "active_support/core_ext/string"
+
+module OopsARake
+  class Registry
+    @tasks = {}
+
+    def self.register(task_class)
+      task_name = task_class.name.underscore.gsub("/", ":").delete_suffix("_task")
+
+      task = Rake::Task.define_task(task_name) do |_, args|
+        task_class.new.call(*args)
+      end
+
+      @tasks[task_class] = task
+      task
+    end
+
+    def self.fetch(task_class)
+      @tasks.fetch(task_class)
+    end
+  end
+end

data/lib/oops_a_rake/task.rb

@@ -0,0 +1,28 @@
+require_relative "registry"
+
+module OopsARake
+  module Task
+    def self.included(klass)
+      Registry::register(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def description(description)
+        task.comment = description
+      end
+
+      def prerequisites(*args)
+        task.enhance(args)
+      end
+
+      alias_method :prerequisite, :prerequisites
+
+      private
+
+      def task
+        ::OopsARake::Registry.fetch(self)
+      end
+    end
+  end
+end

data/lib/oops_a_rake/version.rb

@@ -0,0 +1,3 @@
+module OopsARake
+  VERSION = "0.1.0"
+end

data/oops_a_rake.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/oops_a_rake/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "oops_a_rake"
+  spec.version = OopsARake::VERSION
+  spec.authors = ["Oliver Peate"]
+
+  spec.summary = "Write Rake tasks with plain Ruby objects"
+  spec.homepage = "https://github.com/odlp/oops_a_rake"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.2"
+  spec.add_dependency "rake", ">= 12.0"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: oops_a_rake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oliver Peate
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/oops_a_rake.rb
+- lib/oops_a_rake/registry.rb
+- lib/oops_a_rake/task.rb
+- lib/oops_a_rake/version.rb
+- oops_a_rake.gemspec
+homepage: https://github.com/odlp/oops_a_rake
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/odlp/oops_a_rake
+  source_code_uri: https://github.com/odlp/oops_a_rake
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Write Rake tasks with plain Ruby objects
+test_files: []