simple_base_service 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c790803fc2653a662ff7a3a034d8059d67c3ec9157773b6a73402d18d1ff2cf
+  data.tar.gz: 97136dbfd438d00ebc11ecce6190578ec2fb029439300005e4fa38b1ca59f9a4
+SHA512:
+  metadata.gz: 3cd5c8ea3aa331bbe0c7197d1e1993103eac9c43f1c04cfdeaf9ae39c1efd9b87f474300dae82b368067b5f4cbf96f3babada7839f7ddfd00911485ad9d544c7
+  data.tar.gz: dd0326a322f5277a03315cd174976f427e9565a3c310bdb322edb8570afda427bf0a56d7fcbadb20f3b95e1056dc4b9e98e8ec23650a73c4254f9dcfedc11b80

data/.rubocop.yml

@@ -0,0 +1,25 @@
+# Use Standard's RuboCop configuration as the base so `rubocop` follows Standard
+# See https://github.com/testdouble/standard
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  SuggestExtensions: false
+
+inherit_gem:
+  standard: config/base.yml
+
+# Enable RuboCop plugins for RSpec and Rake
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
+
+# Opt into new cops from RuboCop RSpec
+RSpec/IncludeExamples:
+  Enabled: true
+RSpec/LeakyLocalVariable:
+  Enabled: true
+RSpec/Output:
+  Enabled: true
+
+# You may add project-specific overrides below if necessary.

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# [Unreleased]
+
+## [0.1.2] - 2026-02-10
+
+- Patch release: prepare v0.1.2
+
+## [0.1.1] - 2026-02-10
+
+- Release: prepare v0.1.1
+
+## [0.1.0] - 2026-02-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"simple_base_service" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["emseh@protonmail.com"](mailto:"emseh@protonmail.com").

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ModeraX
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 ModeraX
+
+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,115 @@
+# SimpleService
+
+A small framework for building plain Ruby "service objects" with a consistent interface.
+
+This gem provides:
+
+- A `Base` class for services with `.run` and `#call` conventions
+- Lightweight error handling (`add_error`, `success?`, `failure?`)
+- Pluggable logging (instance-level, class-level, `:rails`, and `:stdout` options)
+
+## Installation
+
+Install the gem from RubyGems (recommended) or add it from GitHub for development. Examples are shown below.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add simple_base_service
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```ruby
+# Gemfile
+gem 'simple_base_service', github: 'moderax/simple_base_service'
+```
+
+Then run `bundle install`.
+
+## Usage
+
+Define a service by inheriting from `SimpleService::Base` and implementing `#call`:
+
+```ruby
+class MyService < SimpleService::Base
+  def call
+    log('starting')
+
+    # perform work
+    if something_went_wrong
+      add_error('something bad happened')
+      return
+    end
+
+    :ok
+  end
+end
+
+# Execute the service (class-level convenience)
+MyService.run
+```
+
+Inspecting result and errors
+
+```ruby
+service = MyService.new
+service.call
+if service.failure?
+  puts service.errors
+end
+```
+
+### Logging
+
+You can control logging per call, per instance, or globally:
+
+- Pass an object that responds to `info(message)` as `logger: my_logger` to `MyService.run` or `MyService.new`
+- Pass `logger: :rails` to use `Rails.logger` when available (falls back to STDOUT)
+- Pass `logger: :stdout` to force a simple STDOUT logger
+- Set a class-level default with `SimpleService::Base.logger = :stdout` or `MyService.logger = my_logger`
+
+Logger resolution order:
+
+1. Instance `@logger` (if set)
+2. Class-level `logger` (inheritable by subclasses)
+3. `Rails.logger` (if available)
+4. Fallback `Logger.new($stdout)`
+
+### Example: Rails integration
+
+In Rails apps, using `logger: :rails` will forward logs to `Rails.logger` when present:
+
+```ruby
+MyService.run(logger: :rails)
+```
+
+## Development
+
+- Install dependencies: `bin/setup` (bundler will install gems)
+- Run tests: `bundle exec rspec`
+- Lint: `bundle exec standardrb` and `bundle exec rubocop`
+
+## Release
+
+- Bump the version in `lib/simple_base_service/version.rb`
+- Run `bundle exec rake release` (this tags and pushes a gem to RubyGems)
+
+## Contributing
+
+Bug reports and pull requests are welcome. Please follow these steps:
+
+1. Fork the repository
+2. Create a branch for your change
+3. Add tests and update the README if you change behavior
+4. Open a pull request
+
+We use `standardrb` and `rubocop` for linting—PRs should pass linters and specs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimpleService project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/moderax/simple_base_service/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/simple_service/base.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module SimpleService
+  # Base class for all application services providing a standard interface for running service methods
+  class Base
+    attr_reader :errors, :args
+
+    # Main entry point to execute a method from the class level
+    def self.run(method_name = :call, **args, &)
+      instance = new(**args, &)
+
+      # Passing 'true' as the second argument allows respond_to? to check for private methods as well
+      unless instance.respond_to?(method_name, true)
+        raise NoMethodError, "Method :#{method_name} is not implemented or not found in #{name}"
+      end
+
+      instance.send(method_name)
+    end
+
+    # Initialize the service with flexible arguments and auto-set instance variables
+    def initialize(**args)
+      @errors = []
+      @args = args
+
+      # Automatically set instance variables for each key in args
+      args.each do |key, value|
+        instance_variable_set("@#{key}", value) if key.to_s.match?(/\A[a-z_][a-z0-9_]*\z/i)
+      end
+    end
+
+    # Default method to be overridden by subclasses
+    def call
+      raise NotImplementedError, "#{self.class.name} must implement the #call method"
+    end
+
+    private
+
+    include SimpleService::Logger
+
+    private :logger, :log
+
+    # Check if there are any accumulated errors
+    def success?
+      @errors.empty?
+    end
+
+    # Check if any errors have occurred
+    def failure?
+      !success?
+    end
+
+    # Helper to add error messages to the collection uniquely
+    def add_error(message)
+      return if message.nil?
+
+      @errors << message unless @errors.include?(message)
+    end
+  end
+end

data/lib/simple_service/logger.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module SimpleService
+  # Extracted logging behavior so services can include or override it easily.
+  module Logger
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # rubocop:disable Style/Documentation
+    module ClassMethods
+      def logger
+        return @logger if defined?(@logger) && @logger
+        return superclass.logger if superclass.respond_to?(:logger)
+
+        nil
+      end
+
+      def logger=(value)
+        @logger = value
+      end
+    end
+    # rubocop:enable Style/Documentation
+
+    # Returns the logger to use: instance-level override -> class-level -> Rails.logger -> STDOUT Logger
+    def logger
+      # try instance-level value
+      value = resolve_logger_value(defined?(@logger) && @logger)
+      return value if value
+
+      # try class-level value
+      value = resolve_logger_value(self.class.logger)
+      return value if value
+
+      # rails fallback then stdout
+      rails_logger || detected_stdout_logger
+    end
+
+    private
+
+    def resolve_logger_value(value)
+      return nil unless value
+
+      case value
+      when :rails
+        rails_logger
+      when :stdout
+        detected_stdout_logger
+      else
+        value
+      end
+    end
+
+    def rails_logger
+      return Rails.logger if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+
+      nil
+    end
+
+    def detected_stdout_logger
+      require "logger"
+      @detected_stdout_logger ||= ::Logger.new($stdout)
+    end
+
+    # Generic logging helper
+    def log(message)
+      prefix = "[#{self.class.name}]"
+
+      if logger.respond_to?(:info)
+        logger.info("#{prefix} #{message}")
+      else
+        puts("#{prefix} #{message}")
+      end
+    end
+  end
+end

data/lib/simple_service/version.rb

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

data/lib/simple_service.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "simple_service/version"
+require_relative "simple_service/logger"
+require_relative "simple_service/base"
+
+module SimpleService
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/simple_service.rbs

@@ -0,0 +1,4 @@
+module SimpleService
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: simple_base_service
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- ModeraX
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Provides a `Base` class for service objects with `.run`/`#call`, simple
+  error handling, and configurable logging.
+email:
+- emseh@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_service.rb
+- lib/simple_service/base.rb
+- lib/simple_service/logger.rb
+- lib/simple_service/version.rb
+- sig/simple_service.rbs
+homepage: https://github.com/moderax/simple_base_service
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moderax/simple_base_service
+  source_code_uri: https://github.com/moderax/simple_base_service
+  changelog_uri: https://github.com/moderax/simple_base_service/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Tiny framework for plain Ruby service objects
+test_files: []