solidservice 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7141572a223276cd54f17af3fec910c9ca9f064c4d70beaee5f85c10defe88cb
-  data.tar.gz: e07fda6b224cac244fb85f44fbf5d10468323a27e0ebf2ffcf5dd4c4b40e31ed
+  metadata.gz: 4f392725c3e702c59ac368f8b437d4e16a4485f7326b35b818d38cc1225e8098
+  data.tar.gz: d26bab0fb422776548372ed8da261ac18ad0f0040a3d520d48f80bea6866b1fb
 SHA512:
-  metadata.gz: 372fefa3c563a54bfbe246142f873dbecab933434ac838e0ac28d1d415226ded0826b34b6572e3ec793a94223489b5d0fe77cdbcaf7e6c5aff2f4094053f17ce
-  data.tar.gz: 4fd9dfe75a6d5d14abb9561d8fa62091b2cd4f92dd3f8e50b9485601f54280cb7d34e50e75260fb1e4ca9f901eaa1225cb8a9c8f6627085470095cc3493bffee
+  metadata.gz: 237fc7a04efec213147e501c52fbcd71b1d26463d75ffceb1e63f0317acd65f45876265726880a99bd3ce9862c1ac68602be12d4e0b51aa8ed44084e9b031dda
+  data.tar.gz: 836fe0f7b0026cee670295d3f911a3c6bdfc0ab1a26c1bc20cd0f421324233e67301021319265fcbcefb2aa5c0049f87e024ec4be4e32ba0a95c827d3fd529c7

data/Gemfile

@@ -2,9 +2,19 @@
 
 source "https://rubygems.org"
 
+if rails_version = ENV['RAILS_VERSION']
+  gem 'rails', rails_version
+end
+
 # Specify your gem's dependencies in solidservice.gemspec
 gemspec
 
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+
+group :development, :test do
+  gem "debug"
+  gem 'matrixeval-ruby'
+  gem 'simplecov'
+end

data/README.md

@@ -1,32 +1,170 @@
 # SolidService
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/solidservice`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![CI](https://github.com/hoppergee/solidservice/actions/workflows/main.yml/badge.svg)](https://github.com/hoppergee/solidservice/actions/workflows/main.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/625ef769e60ab39159ce/maintainability)](https://codeclimate.com/github/hoppergee/solidservice/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/625ef769e60ab39159ce/test_coverage)](https://codeclimate.com/github/hoppergee/solidservice/test_coverage)
 
-TODO: Delete this and the text above, and describe your gem
+Servcie object with a simple API.
+
+```ruby
+result = ASolidService.call(any: 'thing', you: 'like')
+result.success? #=> true
+result.fail? #=> false
+```
+
+- One service per action
+- Service only has one public method `.call` with a hash input argument
+- The `.call` always return a `State` object. You can ask the state object the execution result
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add solidservice
+```bash
+$ bundle add solidservice
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or manually add it in Gemfile
 
-    $ gem install solidservice
+```ruby
+gem 'solidservice'
+```
 
-## Usage
 
-TODO: Write usage instructions here
+## Basic Usage
 
-## Development
+Here is an example for Rails app.
+
+1. Create a `services` folder
+
+```bash
+mkdir app/services
+```
+
+2. Create the service you want
+
+```ruby
+class UpdateUser < SolidService
+  def call
+    if user.update(user_params)
+      success!(user: user)
+    else
+      fail!(user: user)
+    end
+  end
+
+  private
+
+  def user
+    @user ||= User.find(params[:id])
+  end
+
+  def user_params
+    @user ||= params[:user_params]
+  end
+end
+```
+
+3. Use this service in controller
+
+```ruby
+class UsersController < ApplicationController
+  def update
+    result = UpdateUser.call(
+      id: params[:id],
+      user_params: params.require(:user).permit(:email)
+    )
+
+    if result.success?
+      redirect_to root_path
+    else
+      @user = result.user
+      render :edit
+    end
+  end
+end
+```
+
+## Only 4 DSL in the `call` method
+
+- `success!` - Success the servcie immediately, any code after it won't be execute (Recommend)
+- `success` - Just update the state to success
+- `fail!` - Fail the service immediately, any code after it won't be execute (Recommend)
+- `fail` - Just update the state to fail
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## How to return other data
+
+You can send data with state object like this:
+
+```ruby
+success!(user: user)
+success(user: user, item: item)
+fail!(email: email, error: error)
+fail(error: error)
+```
+
+Then we can get those data on the result:
+
+```ruby
+result = ExampleService.call
+result.success? #=> true
+result.user
+result.item
+
+result.success? #=> false
+result.error
+result.email
+```
+
+## Servcie success by default
+
+If you don't call above 4 methods, the servcie will be marked as success by default. It's some those service which just want to execute some action and don't want to return any thing.
+
+```ruby
+class ACommandService < SolidService
+  def call
+    # Do some actions that don't need to return anything
+  end
+end
+
+result = ACommandService.call
+result.success? #=> true
+```
+
+## Use service in service with `call!`
+
+Sometimes, we want to use a service in another service, but don't want to doing `if/else` on the state object everywhere, then we can use `call!` for the inner service. Then the service will raise error on failure.
+
+```ruby
+class Action2 < SolidService
+  def call
+    fail!(error: StandardError.new('something wrong'))
+  end
+end
+
+class Action1 < SolidService
+  def call
+    Action2.call!
+  end
+end
+
+result = Action1.call
+result.fail? #=> true
+result.error #=> #<StandardError: something wrong>
+```
+
+
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+bundle install
+meval rake # Run test
+meval -a rake # Run tests against all Ruby versions and Rails versions
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/solidservice. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/solidservice/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/hoppergee/solidservice. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hoppergee/solidservice/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -34,4 +172,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SolidService project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/solidservice/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SolidService project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hoppergee/solidservice/blob/master/CODE_OF_CONDUCT.md).

data/lib/solidservice/base.rb

@@ -0,0 +1,69 @@
+module SolidService
+  class Base
+  
+    class << self
+
+      def call(params={})
+        service = new(params)
+        service.call
+        service.state
+
+      rescue Success
+        service.state
+
+      rescue Failure
+        service.state
+
+      rescue => e
+        service.fail(error: e)
+        service.state
+      end
+  
+      def call!(params={})
+        state = call(params)
+        return state unless state.fail?
+  
+        if state.error
+          raise state.error
+        else
+          raise Error.new("Service failed", service_result: state)
+        end
+      end
+
+    end
+  
+    attr_reader :params, :state
+  
+    def initialize(params)
+      @params = (params || {}).with_indifferent_access
+      @state = State.new(:success)
+    end
+  
+    def call
+      raise "Override please"
+    end
+
+    ##########
+    # Private
+    ##########
+  
+    def success!(params={})
+      @state = State.new(:success, params)
+      raise Success.new
+    end
+  
+    def fail!(params={})
+      @state = State.new(:fail, params)
+      raise Failure.new
+    end
+
+    def success(params={})
+      @state = State.new(:success, params)
+    end
+
+    def fail(params={})
+      @state = State.new(:fail, params)
+    end
+
+  end
+end

data/lib/solidservice/error.rb

@@ -0,0 +1,10 @@
+module SolidService
+  class Error < StandardError
+    attr_reader :service_result
+  
+    def initialize(message, params={})
+      @service_result = params[:service_result]
+      super(message)
+    end
+  end
+end

data/lib/solidservice/failure.rb

@@ -0,0 +1,4 @@
+module SolidService
+  class Failure < StandardError
+  end
+end

data/lib/solidservice/state.rb

@@ -0,0 +1,20 @@
+module SolidService
+  class State
+    def initialize(state = :success, data={})
+      @state = state || :success
+      @_data = (data || {}).with_indifferent_access
+    end
+
+    def success?
+      @state == :success
+    end
+
+    def fail?
+      @state == :fail
+    end
+
+    def method_missing(key)
+      @_data[key]
+    end
+  end
+end

data/lib/solidservice/success.rb

@@ -0,0 +1,4 @@
+module SolidService
+  class Success < StandardError
+  end
+end

data/lib/solidservice/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidService
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/solidservice.rb

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "solidservice/version"
+require "active_support/core_ext/hash/indifferent_access"
 
 module SolidService
-  class Error < StandardError; end
-  # Your code goes here...
+  autoload :Error, "solidservice/error"
+  autoload :Failure, "solidservice/failure"
+  autoload :Success, "solidservice/success"
+
+  autoload :State, "solidservice/state"
+
+  autoload :Base, "solidservice/base"
 end

data/matrixeval.yml

@@ -0,0 +1,77 @@
+version: 0.4
+target: ruby
+project_name: solidservice
+parallel_workers: number_of_processors
+commands:
+#   - ps
+#   - top
+#   - an_additional_command
+# mounts:
+#   - /a/path/need/to/mount:/a/path/mount/to
+matrix:
+  ruby:
+    main: true
+    variants:
+      - key: 2.6
+        container:
+          image: ruby:2.6.10
+      - key: 2.7
+        container:
+          image: ruby:2.7.6
+      - key: 3.0
+        container:
+          image: ruby:3.0.4
+      - key: 3.1
+        default: true
+        container:
+          image: ruby:3.1.2
+      # - key: jruby-9.3
+      #   container:
+      #     image: jruby:9.3
+      #   env:
+      #       PATH: "/opt/jruby/bin:/app/bin:/bundle/bin:$PATH"
+      #   mounts:
+      #     - /a/path/need/to/mount:/a/path/mount/to
+
+  rails:
+    variants:
+      - key: 6.0
+        env:
+          RAILS_VERSION: "~> 6.0.0"
+      - key: 6.1
+        env:
+          RAILS_VERSION: "~> 6.1.0"
+      - key: 7.0
+        default: true
+        env:
+          RAILS_VERSION: "~> 7.0.0"
+  # another:
+  #   variants:
+  #     - key: key1
+  #       default: true
+  #       env:
+  #         ENV_KEY: 1
+  #     - key: key2
+  #       env:
+  #         ENV_KEY: 2
+
+exclude:
+  - ruby: 2.6
+    rails: 7.0
+  # - ruby: jruby-9.3
+  #   rails: 7.0
+
+docker-compose-extend:
+  # services:
+  #   postgres:
+  #     image: postgres:12.8
+  #     volumes:
+  #       - postgres12:/var/lib/postgresql/data
+  #     environment:
+  #       POSTGRES_HOST_AUTH_METHOD: trust
+
+  #   redis:
+  #     image: redis:6.2-alpine
+
+  # volumes:
+  #   postgres12:

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: solidservice
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Hopper Gee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-30 00:00:00.000000000 Z
-dependencies: []
+date: 2022-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: Service object with a simple API
 email:
 - hopper.gee@hey.com
@@ -24,7 +38,13 @@ files:
 - README.md
 - Rakefile
 - lib/solidservice.rb
+- lib/solidservice/base.rb
+- lib/solidservice/error.rb
+- lib/solidservice/failure.rb
+- lib/solidservice/state.rb
+- lib/solidservice/success.rb
 - lib/solidservice/version.rb
+- matrixeval.yml
 homepage: https://github.com/hoppergee/solidservice
 licenses:
 - MIT