thor-validations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff22a39235a36fde79684aadb15fa502d5148c53b720c88997995af023293940
+  data.tar.gz: e9303579d55681beee89b7ff52a64b134c09dc8fa0db1543a15008785db28d85
+SHA512:
+  metadata.gz: 0b74b03bf1ff3a208db87645811d808937f2d2045d7de52965143de16616e291d28bad8d0bf647a10ffc692dbae8ce166884e04319ccba14d5e849d48c50023c
+  data.tar.gz: bbdaf8f4564ba02ad3da82c837512356bb8fe463983b41b42378c6c877d53f133f9be3b500be2628f0cd990ea0731ff660007df1ad6ca2f29906968ca3f6cf96

data/README.md

@@ -0,0 +1,47 @@
+# Thor::Validations
+
+Thor::Validations adds a `validate_before` method to Thor, allowing you to perform validations before executing commands.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thor-validations'
+```
+
+## Inspiration
+
+Thanks to https://github.com/kddnewton/thor-hollaback for the original idea.
+
+
+## Usage
+
+```ruby
+class MyCommand < Thor
+  include Thor::Validations
+
+  validate_before, :deploy, :rollback do
+    check_permissions
+  end
+
+  desc "deploy", "Deploy app"
+  def deploy
+    sleep(1)
+    puts "Deploying..."
+  end
+
+  desc "rollback", "Rollback app"
+  def rollback
+    sleep(1)
+    puts "Rolling back..."
+  end
+
+  private
+
+    def check_permissions
+      puts "Checking permissions..."
+    end
+
+end
+```

data/lib/thor/validations/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Thor
+  module Validations
+    VERSION = "0.1.0"
+  end
+end

data/lib/thor/validations.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative 'validations/version
+
+class Thor
+  module Validations
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.prepend(InstanceMethods)
+    end
+
+    module ClassMethods
+      def validations
+        @validations ||= {}
+      end
+
+      def validate_before(*method_names, &validation)
+        method_names.each do |method_name|
+          validations[method_name.to_sym] ||= []
+          validations[method_name.to_sym] << validation
+        end
+      end
+    end
+
+    module InstanceMethods
+      def invoke_command(command, *args)
+        run_validations(command)
+        super
+      end
+
+      private
+
+      def run_validations(command)
+        return unless command && self.class.validations.key?(command.name.to_sym)
+
+        self.class.validations[command.name.to_sym].each do |validation|
+          result = instance_exec(&validation)
+          raise Thor::Error, "Validation failed for #{command.name}" unless result
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: thor-validations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benoit Tigeot
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: A simple gem that adds a validate_before method to Thor, allowing pre-command
+  validations
+email:
+- benoit.tigeot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/thor/validations.rb
+- lib/thor/validations/version.rb
+homepage: https://github.com/benoittgt/thor-validations
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/benoittgt/thor-validations
+  source_code_uri: https://github.com/benoittgt/thor-validations
+  changelog_uri: https://github.com/benoittgt/thor-validations/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Adds validate_before functionality to Thor commands
+test_files: []