Giter VIP home page Giter VIP logo

servant's Introduction

Servant

Build an army of servants and command them.

Installation

Add this line to your application's Gemfile:

gem 'servant'

or:

gem 'servant', github: 'undr/servant'

And then execute:

$ bundle

Or install it yourself as:

$ gem install servant

Usage

module Services
  class UpsertSomething < Servant::Base
    context do
      argument :attributes, type: Hash, presence: true
      argument :export_to, type: String
    end

    def perform
      (find_and_update_something || create_something).tap do |something|
        send_to_somewhere(something) if context.export_to
      end
    end

    private

    def somewhere
      context.options[:somewhere]
    end

    def send_to_somewhere(something)
      result = Services::ExportToSomewhere.perform(something: something, to: context.export_to)
      error!('impossible to export it to somewhere', :export) unless result.success?
    end

    def create_something
      Services::CreateSomething.perform(attributes: context.attributes).tap do |result|
        halt_with!(result.errors) unless result.success?
      end.value
    end

    def find_and_update_something
      result = Services::FindSomething.perform(context.attributes)
      halt!('impossible accurately determinate a Something') if result.failed? || result.value.count > 1
      something = result.value.first

      if something
        if something.update_attributes(context.attributes)
          something
        else
          halt_with!(something.errors)
        end
      end
    end
  end
end
module Services
  class CreateSomething < Servant::Base
    context do
      argument :name, type: String, presence: true
      argument :description, type: String, presence: true
      argument :rating,
        type: Integer,
        default: 0,
        numericality: { greater_than_or_equal_to: 0, less_than_or_equal_to: 10 }
    end

    def perform
      Something.new(context.to_hash).tap do |something|
        merge_errors!(something.errors) unless something.save
      end
    end
  end
end
module Services
  class FindSomething < Servant::Base
    context do
      argument :name, type: String, presence: true
    end

    def perform
      Something.where(name: context.name)
    end
  end
end
 result = Services::UpsertSomething.perform(attributes: params, export_to: :somewhere)

 if result.success?
   # Do whatever you want with `result.value`
 else
   # handle errors using `result.errors`
 end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/undr/servant.

License

The gem is available as open source under the terms of the MIT License.

servant's People

Contributors

undr avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.