quickstep 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a222ed7e6965c0b0b3f61199e73447ef706ee0ee9ea3266919fdafe1c596d29c
-  data.tar.gz: f941af4a57b0c4eccd5a187b4e0b62ae8acbc83fd449ac59bdf3a4a6da69891b
+  metadata.gz: 346e59b0747f25796c6903ce007daf080a63e88ed9f19897fb9ef61f12e4dbcc
+  data.tar.gz: c3ba62ba1c119ca5b534482d2cd0c106c7161dbcdc3940026897862a1699a43b
 SHA512:
-  metadata.gz: 957373834862d07320edaff7fac4c61e94beb7e934fdadc566e8887cee2a524d73ac4ee4b3c3afd91774d3ef232a9f277b386e099f43313f234438e7f2bb47f5
-  data.tar.gz: 70e6eee6be09fdb62b1c4d8b99e7acf8094cb2e22974f12c5ffe1723c0ed8d464f17be27bd23c9d613433124eeeaeae4ce38f9957df0925ac43f2317d44165a7
+  metadata.gz: 7c78591ee480a7835663e2ca8c136c48cc566df56937dfe34c40067b50799eccb1808de158b741653083dc2e498991f74107559fb08f26acea0c03f5c00bf891
+  data.tar.gz: 42a6abae6b2d76ebee7dbe7644270220d1864ef8df2d76f0f3ee72bcfe35d9c4a6379b9a903f52818f264bbf7c47b3601181bd23f17781227872086598303cbc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Igor Korepanov
+
+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,64 @@
+[![Gem Version](https://badge.fury.io/rb/quickstep.svg)](https://badge.fury.io/rb/quickstep)
+![CI](https://github.com/igorkorepanov/quickstep/actions/workflows/main.yml/badge.svg)
+
+# Quickstep
+
+Quickstep is a lightweight business operation tool inspired by [dry-operation](https://github.com/dry-rb/dry-operation). It provides a structured way to execute multi-step operations with built-in success and failure handling.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+ gem 'quickstep'
+```
+
+Or install it manually:
+
+```sh
+ gem install quickstep
+```
+
+## Usage
+
+### Defining an Operation
+
+Operations in Quickstep are composed of sequential steps. Each step returns either a `Success` or a `Failure`. If any step fails, the operation halts immediately.
+
+```ruby
+require 'quickstep'
+
+class MyOperation
+  include Quickstep
+
+  def call(input)
+    step validate(input)
+    step process(input)
+  end
+
+  private
+
+  def validate(input)
+    input[:valid] ? Success(input) : Failure(:invalid_input)
+  end
+
+  def process(input)
+    Success(result: input[:value] * 2)
+  end
+end
+
+result = MyOperation.new.call(valid: true, value: 5)
+# or
+# result = MyOperation.call(valid: true, value: 5)
+
+if result.success?
+  puts "Success: #{result.value}"
+else
+  puts "Failure: #{result.value}"
+end
+```
+
+## License
+
+Quickstep is available under the MIT License.
+

data/lib/quickstep/result.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Quickstep
+  module Result
+    class Success
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def success?
+        true
+      end
+
+      def failure?
+        false
+      end
+
+      def inspect
+        "Success(#{value.inspect})"
+      end
+    end
+
+    class Failure
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def success?
+        false
+      end
+
+      def failure?
+        true
+      end
+
+      def inspect
+        "Failure(#{value.inspect})"
+      end
+    end
+
+    def Success(value)
+      Success.new(value)
+    end
+
+    def Failure(value)
+      Failure.new(value)
+    end
+  end
+end

data/lib/quickstep/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Quickstep
+  VERSION = '0.2.0'
+end

data/lib/quickstep.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'quickstep/version'
+require_relative 'quickstep/result'
+
+module Quickstep
+  include Quickstep::Result
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.prepend(InstanceMethods)
+  end
+
+  module ClassMethods
+    def call(*args)
+      catch :halt do
+        new.call(*args)
+      end
+    end
+  end
+
+  module InstanceMethods
+    def call(*args)
+      catch :halt do
+        super
+      end
+    end
+  end
+
+  def step(result)
+    if result.success?
+      result
+    else
+      throw :halt, result
+    end
+  end
+end

metadata

@@ -1,22 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: quickstep
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Korepanov
 bindir: bin
 cert_chain: []
-date: 2025-04-01 00:00:00.000000000 Z
+date: 2025-05-07 00:00:00.000000000 Z
 dependencies: []
-description: Quickstep provides a structured way to handle multi-step operations with
-  success/failure handling.
+description: |2
+      Quickstep provides a structured way to execute multi-step business operations with built-in success and
+      failure handling.
 email:
 - korepanovigor87@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/quickstep.rb
+- lib/quickstep/result.rb
+- lib/quickstep/version.rb
 homepage: https://github.com/igorkorepanov/quickstep
 licenses:
 - MIT
@@ -38,5 +44,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: A lightweight step-based operation handler.
+summary: A lightweight business operation tool.
 test_files: []