simple_service_object 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 8a5534a40455d739b14652ccb075bdf604e8569d
4
+ data.tar.gz: cf85c7b63550be18162ba98797b539e45d2431a4
5
+ SHA512:
6
+ metadata.gz: 33265986f179d53655613041f1c79d4a778241baf2398ec1d4f34d9f7bd986c409cce5bb71b3f53e7d3d08c614236d5b087c4071ed8d904d39e4810e825d4104
7
+ data.tar.gz: 5da3cfdcece4150d387dcf5971ecd8696fe2dee401d0d8fed5cfff31a576a7e815a067c72063926b22892db2f7fd377632ba465277c815c1731c2f60b9668ecb
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.rubocop.yml ADDED
@@ -0,0 +1,21 @@
1
+ AllCops:
2
+ TargetRubyVersion: 2.3
3
+ DisplayCopNames: true
4
+ DisplayStyleGuide: true
5
+
6
+ Exclude:
7
+ - 'bin/*'
8
+
9
+ Metrics/LineLength:
10
+ Max: 100
11
+
12
+ Style/StringLiterals:
13
+ Enabled: false
14
+
15
+ Style/Documentation:
16
+ Enabled: false
17
+
18
+ Metrics/BlockLength:
19
+ Exclude:
20
+ - '*.gemspec'
21
+ - '**/*_spec.rb'
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.4.0
data/.travis.yml ADDED
@@ -0,0 +1,8 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 1.9.3
5
+ - 2.0.0
6
+ - 2.3.3
7
+ - 2.4.0
8
+ before_install: gem install bundler -v 1.13.6
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at fabrizio.monti@welaika.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ source 'https://rubygems.org'
5
+
6
+ # Specify your gem's dependencies in simple_service_object.gemspec
7
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Fabrizio Monti
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,117 @@
1
+ # SimpleServiceObject
2
+
3
+ A simple command pattern implementation in Ruby.
4
+
5
+ [![Build Status](https://travis-ci.org/welaika/simple_service_object.svg?branch=master)](https://travis-ci.org/welaika/simple_service_object)
6
+ [![Code Climate](https://codeclimate.com/github/welaika/simple_service_object/badges/gpa.svg)](https://codeclimate.com/github/welaika/simple_service_object)
7
+
8
+ ## Installation
9
+
10
+ Add this line to your application's Gemfile:
11
+
12
+ ```ruby
13
+ gem 'simple_service_object'
14
+ ```
15
+
16
+ And then execute:
17
+
18
+ $ bundle
19
+
20
+ Or install it yourself as:
21
+
22
+ $ gem install simple_service_object
23
+
24
+ ## Usage
25
+
26
+ ### Basic usage
27
+
28
+ Write your service object class, which must inherit from `SimpleServiceObject::Base` and must define
29
+ a `call` instance method.
30
+
31
+ ```ruby
32
+ class SubscribeUser < SimpleServiceObject::Base
33
+ def initialize(user)
34
+ @user = user
35
+ end
36
+
37
+ def call
38
+ add_user_to_newsletter_recipients(@user)
39
+ notify_user(@user)
40
+ end
41
+
42
+ private
43
+
44
+ def add_user_to_newsletter_recipients(user)
45
+ # ...
46
+ end
47
+
48
+ def notify_user(user)
49
+ # ...
50
+ end
51
+ end
52
+ ```
53
+
54
+ To run your command, simply:
55
+
56
+ ```ruby
57
+ SubscribeUser.call(my_new_user) # arguments are passed to your class '#initialize' method
58
+ ```
59
+
60
+ ### Return value and errors
61
+
62
+ You can add errors using the `errors` method, which exposes to you an array of errors.
63
+
64
+ ```ruby
65
+ class CalculateSquareRoot < SimpleServiceObject::Base
66
+ def initialize(number)
67
+ @number = number
68
+ end
69
+
70
+ def call
71
+ if number < 0
72
+ errors.push("Cannot calculate square root!")
73
+ return
74
+ end
75
+ Math.sqrt(@number)
76
+ end
77
+ end
78
+ ```
79
+
80
+ ```ruby
81
+ result = CalculateSquareRoot.call(9)
82
+ result.success? # true
83
+ result.failure? # false
84
+ result.errors # []
85
+ result.value # 3.0
86
+ ```
87
+
88
+ ```ruby
89
+ result = CalculateSquareRoot.call(-1)
90
+ result.success? # false
91
+ result.failure? # true
92
+ result.errors # ["Cannot calculate square root!"]
93
+ result.value # nil
94
+ ```
95
+
96
+ You can also use `.call!` instead of `.call`. If there aren't any errors, it will return the value,
97
+ otherwise it will raise an exception.
98
+
99
+ ```ruby
100
+ CalculateSquareRoot.call!(9) # 3.0
101
+ CalculateSquareRoot.call!(-1) # raises SimpleServiceObject::FailureError
102
+ ```
103
+
104
+ ## Development
105
+
106
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run rubocop and tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
107
+
108
+ 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](https://rubygems.org).
109
+
110
+ ## Contributing
111
+
112
+ Bug reports and pull requests are welcome on GitHub at https://github.com/welaika/simple_service_object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
113
+
114
+
115
+ ## License
116
+
117
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ require "bundler/gem_tasks"
5
+ require "rspec/core/rake_task"
6
+ require "rubocop/rake_task"
7
+
8
+ RSpec::Core::RakeTask.new(:spec)
9
+ RuboCop::RakeTask.new
10
+
11
+ task default: :rubocop
12
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "simple_service_object"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,10 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ require "simple_service_object/version"
5
+ require "simple_service_object/base"
6
+ require "simple_service_object/result"
7
+ require "simple_service_object/errors"
8
+
9
+ module SimpleServiceObject
10
+ end
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ module SimpleServiceObject
5
+ class Base
6
+ def self.call(*args)
7
+ instance = new(*args)
8
+ result_value = instance.call
9
+ Result.new(result_value, instance.errors)
10
+ end
11
+
12
+ def self.call!(*args)
13
+ result = call(*args)
14
+ raise FailureError, result.errors.join(", ") if result.failure?
15
+ result.value
16
+ end
17
+
18
+ def call
19
+ raise NotImplementedError, "Should be implemented in subclass."
20
+ end
21
+
22
+ def errors
23
+ @errors ||= []
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,10 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ module SimpleServiceObject
5
+ class Error < StandardError
6
+ end
7
+
8
+ class FailureError < Error
9
+ end
10
+ end
@@ -0,0 +1,21 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ module SimpleServiceObject
5
+ class Result
6
+ attr_reader :errors, :value
7
+
8
+ def initialize(value, errors = [])
9
+ @value = value
10
+ @errors = Array(errors)
11
+ end
12
+
13
+ def success?
14
+ errors.empty?
15
+ end
16
+
17
+ def failure?
18
+ !success?
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,6 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ module SimpleServiceObject
5
+ VERSION = "0.1.0"
6
+ end
@@ -0,0 +1,36 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ lib = File.expand_path('../lib', __FILE__)
5
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
6
+ require 'simple_service_object/version'
7
+
8
+ Gem::Specification.new do |spec|
9
+ spec.name = "simple_service_object"
10
+ spec.version = SimpleServiceObject::VERSION
11
+ spec.authors = ["Fabrizio Monti"]
12
+ spec.email = ["fabrizio.monti@welaika.com"]
13
+
14
+ spec.summary = "Simple service object implementation."
15
+ spec.description = <<-TEXT
16
+ It implements the command pattern in a simple way.
17
+ TEXT
18
+ spec.homepage = "https://github.com/welaika/simple_service_object"
19
+ spec.license = "MIT"
20
+
21
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
22
+ f.match(%r{^(test|spec|features)/})
23
+ end
24
+ spec.bindir = "exe"
25
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
26
+ spec.require_paths = ["lib"]
27
+
28
+ spec.add_development_dependency "bundler", "~> 1.13"
29
+ spec.add_development_dependency "rake", "~> 10.0"
30
+ spec.add_development_dependency "rspec", "~> 3.0"
31
+ if RUBY_VERSION < '2.0.0'
32
+ spec.add_development_dependency "rubocop", "~> 0.41.1"
33
+ else
34
+ spec.add_development_dependency "rubocop", "~> 0.46.0"
35
+ end
36
+ end
metadata ADDED
@@ -0,0 +1,118 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: simple_service_object
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Fabrizio Monti
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-12-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rubocop
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 0.46.0
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 0.46.0
69
+ description: " It implements the command pattern in a simple way.\n"
70
+ email:
71
+ - fabrizio.monti@welaika.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".rubocop.yml"
79
+ - ".ruby-version"
80
+ - ".travis.yml"
81
+ - CODE_OF_CONDUCT.md
82
+ - Gemfile
83
+ - LICENSE.txt
84
+ - README.md
85
+ - Rakefile
86
+ - bin/console
87
+ - bin/setup
88
+ - lib/simple_service_object.rb
89
+ - lib/simple_service_object/base.rb
90
+ - lib/simple_service_object/errors.rb
91
+ - lib/simple_service_object/result.rb
92
+ - lib/simple_service_object/version.rb
93
+ - simple_service_object.gemspec
94
+ homepage: https://github.com/welaika/simple_service_object
95
+ licenses:
96
+ - MIT
97
+ metadata: {}
98
+ post_install_message:
99
+ rdoc_options: []
100
+ require_paths:
101
+ - lib
102
+ required_ruby_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ required_rubygems_version: !ruby/object:Gem::Requirement
108
+ requirements:
109
+ - - ">="
110
+ - !ruby/object:Gem::Version
111
+ version: '0'
112
+ requirements: []
113
+ rubyforge_project:
114
+ rubygems_version: 2.6.8
115
+ signing_key:
116
+ specification_version: 4
117
+ summary: Simple service object implementation.
118
+ test_files: []