rdeco-task 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81e452abde148b27c824d6ffb5f0af7c50fbb07911323109fa23fd54f1a936b2
+  data.tar.gz: b6501677a09c2f4afee35407cde9264cdffcfffd21c8fc0dbba14981b2ed8605
+SHA512:
+  metadata.gz: ad5c234a6895180a3fbd709d0cb486edeb4940e9e98aedaa506a71a5c93b66aa1f4f4371d9aca6a114f9b295ad43e748f3a8b2081dcb66d0f77e609da058c5aa
+  data.tar.gz: 017abf1baad98a8d3c3061a6d1a8e35f7fc30b08e5ffef43a7284b23a07cdf025d0d326107a1a11d095dfcdffd1618626f9fedaec45ac5e2cb053539c310e812

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Fuseraft
+
+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,98 @@
+# Rdeco::Task
+
+**Rdeco::Task** is a RubyGem that provides a metaprogramming module for task execution in a specified order. It allows you to define a set of methods (tasks) in a class and execute them in a specific sequence: **before**, **main**, and **after**.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "rdeco-task"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it directly using:
+
+```bash
+$ gem install rdeco-task
+```
+
+## Usage
+
+### Basic Example
+
+To use the `Rdeco::Task` module in your class, follow these steps:
+
+```ruby
+require "rdeco/task"
+
+class YourClass
+  include Rdeco::Task
+
+  before :setup, :preparation
+  main :core_logic
+  after :teardown
+
+  def setup
+    puts "Setting up..."
+  end
+
+  def preparation
+    puts "Doing some preparation..."
+  end
+
+  def core_logic
+    puts "Executing core logic..."
+  end
+
+  def teardown
+    puts "Tearing down..."
+  end
+end
+
+# Create an instance of the class
+instance = YourClass.new
+
+# Running the tasks in order: before, main, after
+YourClass.run(instance)
+```
+
+The above code will produce the following output:
+
+```
+Setting up...
+Doing some preparation...
+Executing core logic...
+Tearing down...
+```
+
+### Decorate Multiple Methods in One Line
+
+You can decorate multiple methods in one line.
+
+```ruby
+class AnotherClass
+  include Rdeco::Task
+
+  before :setup, :preparation, :setup_other
+  main :core_logic
+  after :teardown, :cleanup
+
+  # ... (rest of the class definition)
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [fuseraft/rdeco-task](https://github.com/fuseraft/rdeco-task). 
+
+This project is intended to be a safe, welcoming space for collaboration and contributors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rdeco/task.rb

@@ -0,0 +1,51 @@
+module Rdeco
+  module Task
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def before(*method_names)
+        (@before_tasks ||= []).concat(method_names)
+      end
+
+      def main(method_name)
+        @main_task = method_name
+      end
+
+      def after(*method_names)
+        (@after_tasks ||= []).concat(method_names)
+      end
+
+      def run(instance)
+        execute_before_tasks(instance)
+        execute_main_task(instance)
+        execute_after_tasks(instance)
+      end
+
+      private
+
+      def execute_before_tasks(instance)
+        return unless @before_tasks
+
+        @before_tasks.each do |task|
+          instance.send(task)
+        end
+      end
+
+      def execute_main_task(instance)
+        raise "No main task defined!" unless @main_task
+
+        instance.send(@main_task)
+      end
+
+      def execute_after_tasks(instance)
+        return unless @after_tasks
+
+        @after_tasks.each do |task|
+          instance.send(task)
+        end
+      end
+    end
+  end
+end

data/spec/rdeco/task_spec.rb

@@ -0,0 +1,51 @@
+# spec/rdeco/task_spec.rb
+require "rdeco/task"
+
+RSpec.describe Rdeco::Task do
+  class YourClass
+    include Rdeco::Task
+
+    before :setup, :preparation, :setup_other
+    main :core_logic
+    after :teardown, :cleanup
+
+    def setup
+      puts "Setting up..."
+    end
+
+    def preparation
+      puts "Doing some preparation..."
+    end
+
+    def setup_other
+      puts "Setting up other things..."
+    end
+
+    def core_logic
+      puts "Executing core logic..."
+    end
+
+    def teardown
+      puts "Tearing down..."
+    end
+
+    def cleanup
+      puts "Cleaning up..."
+    end
+  end
+
+  let(:instance) { YourClass.new }
+
+  describe ".run" do
+    it "executes the tasks in the correct order" do
+      expect(instance).to receive(:setup).ordered
+      expect(instance).to receive(:preparation).ordered
+      expect(instance).to receive(:setup_other).ordered
+      expect(instance).to receive(:core_logic).ordered
+      expect(instance).to receive(:teardown).ordered
+      expect(instance).to receive(:cleanup).ordered
+
+      YourClass.run(instance)
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rdeco-task
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Stauffer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A RubyGem that provides metaprogramming attributes for task execution
+  in a specified order.
+email:
+- scott@fuseraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rdeco/task.rb
+- spec/rdeco/task_spec.rb
+homepage: https://github.com/fuseraft/rdeco-task
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/fuseraft/rdeco-task
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fuseraft/rdeco-task
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A RubyGem for the Rdeco::Task module
+test_files:
+- spec/rdeco/task_spec.rb