oha 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 55366a03dddde521a7a681bcdaee41180332f7e566ea010e7b717e0f5dcce094
4
+ data.tar.gz: e3692be7cf26697f9a7b64e56b7445b39cbce27c3050db186d90658098eff8f5
5
+ SHA512:
6
+ metadata.gz: 9949f48d6191c797930a0536ea7b75921d837325c4f880b62e5918e138d46b478366a1e195bf48a74abd3eeaa979b7bd3914557e72c65841f04c9e726ff9e19d
7
+ data.tar.gz: 864b84b16c8fd60de3fae3bb0c046f27c9dc46fa71c16858dd876d79875c7a8d46c7b3d31d528312ec6cea1d4906fd7fb381ebaea1ca981edcfa90967425a33d
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ .idea
14
+ vendor
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 3.0.0
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.4
7
+ before_install: gem install bundler -v 2.0.2
@@ -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 marioeviapiano@gmail.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,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in oha.gemspec
4
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,45 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ oha (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ byebug (11.1.3)
10
+ diff-lcs (1.4.4)
11
+ docile (1.4.0)
12
+ json (2.5.1)
13
+ rake (13.0.3)
14
+ rspec (3.10.0)
15
+ rspec-core (~> 3.10.0)
16
+ rspec-expectations (~> 3.10.0)
17
+ rspec-mocks (~> 3.10.0)
18
+ rspec-core (3.10.1)
19
+ rspec-support (~> 3.10.0)
20
+ rspec-expectations (3.10.1)
21
+ diff-lcs (>= 1.2.0, < 2.0)
22
+ rspec-support (~> 3.10.0)
23
+ rspec-mocks (3.10.2)
24
+ diff-lcs (>= 1.2.0, < 2.0)
25
+ rspec-support (~> 3.10.0)
26
+ rspec-support (3.10.2)
27
+ simplecov (0.17.1)
28
+ docile (~> 1.1)
29
+ json (>= 1.8, < 3)
30
+ simplecov-html (~> 0.10.0)
31
+ simplecov-html (0.10.2)
32
+
33
+ PLATFORMS
34
+ x86_64-darwin-20
35
+
36
+ DEPENDENCIES
37
+ bundler (~> 2.0)
38
+ byebug (~> 11.1)
39
+ oha!
40
+ rake (~> 13.0)
41
+ rspec (~> 3.0)
42
+ simplecov (~> 0.17.1)
43
+
44
+ BUNDLED WITH
45
+ 2.2.3
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Mario Viapiano
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,93 @@
1
+ # Oha
2
+ [![Build Status](https://travis-ci.org/mariiillo/oha.svg?branch=master)](https://travis-ci.org/mariiillo/oha)
3
+
4
+ Decouple the business logic from the delivery mechanismt by using this gem.
5
+ 1. Define the use case.
6
+ 2. Create the UseCase class.
7
+ 3. Bind the UseCase's happy path (and the not so happy ones) to what the calling object should execute in each case.
8
+ 4. Profit
9
+
10
+ ## Installation
11
+
12
+ Add this line to your application's Gemfile:
13
+
14
+ ```ruby
15
+ gem 'oha'
16
+ ```
17
+
18
+ And then execute:
19
+
20
+ $ bundle
21
+
22
+ Or install it yourself as:
23
+
24
+ $ gem install oha
25
+
26
+ ## Usage
27
+
28
+ In the calling object:
29
+ ```ruby
30
+ SomeUseCase.call(params) do |use_case|
31
+ use_case.bind(:success).to(redirect_to_user)
32
+ use_case.bind(:data_invalid).to(render_new)
33
+ use_case.bind(:another_error).to(do_something_different)
34
+ end
35
+
36
+ def redirect_to_user
37
+ -> (payload) do
38
+ redirect_to user_path(payload[:user])
39
+ end
40
+ end
41
+
42
+ def render_new
43
+ -> (_payload) do
44
+ render :new
45
+ end
46
+ end
47
+
48
+ def do_something_different
49
+ -> (_payload) do
50
+ # ...
51
+ end
52
+ end
53
+ ```
54
+
55
+ The Use Case:
56
+ ```ruby
57
+ class SomeUseCase
58
+ include Oha
59
+
60
+ def call(params)
61
+ trigger(:data_invalid) if invalid_params?
62
+ do_something
63
+ trigger(:success, user: @user)
64
+ rescue SomeError
65
+ trigger(:another_error)
66
+ end
67
+
68
+ private
69
+
70
+ def do_something
71
+ @user = ...
72
+ #...
73
+ end
74
+ end
75
+ ```
76
+
77
+ ## Development
78
+
79
+ 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.
80
+
81
+ 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).
82
+
83
+ ## Contributing
84
+
85
+ Bug reports and pull requests are welcome on GitHub at https://github.com/mariiillo/oha. 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.
86
+
87
+ ## License
88
+
89
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
90
+
91
+ ## Code of Conduct
92
+
93
+ Everyone interacting in the Oha project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/oha/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'oha'
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(__FILE__)
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
data/lib/oha.rb ADDED
@@ -0,0 +1,39 @@
1
+ require 'oha/version'
2
+ require 'oha/binder'
3
+ require 'oha/errors/no_block_given_error'
4
+ require 'oha/errors/event_not_defined'
5
+
6
+ # Main Module that defines all the behaviour
7
+ # that will be added to a UseCase
8
+ module Oha
9
+ def self.included(base)
10
+ base.extend ClassMethods
11
+ end
12
+
13
+ def initialize(*args)
14
+ raise Oha::Errors::NoBlockGivenError unless block_given?
15
+
16
+ @binder = Oha::Binder.new(self)
17
+ @callbacks = {}
18
+ @params = args
19
+ yield @binder
20
+ self
21
+ end
22
+
23
+ def set_callback(event, callable)
24
+ @callbacks[event.to_sym] = callable
25
+ self
26
+ end
27
+
28
+ def trigger(event, payload = {})
29
+ callback = @callbacks.fetch(event.to_sym) { raise Oha::Errors::EventNotDefined }
30
+ callback.call(payload)
31
+ end
32
+
33
+ # Class methods to be added to a UseCase.
34
+ module ClassMethods
35
+ def call(*args, &block)
36
+ new(*args, &block)
37
+ end
38
+ end
39
+ end
data/lib/oha/binder.rb ADDED
@@ -0,0 +1,18 @@
1
+ module Oha
2
+ # This clas contains the logic to map events to actions
3
+ class Binder
4
+ def initialize(context)
5
+ @context = context
6
+ end
7
+
8
+ def bind(event)
9
+ @event = event
10
+ self
11
+ end
12
+
13
+ def to(callable_object)
14
+ @context.set_callback(@event, callable_object)
15
+ self
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,6 @@
1
+ module Oha
2
+ module Errors
3
+ # This error will be raised if no event is defined.
4
+ class EventNotDefined < StandardError; end
5
+ end
6
+ end
@@ -0,0 +1,7 @@
1
+ module Oha
2
+ module Errors
3
+ # This error will be raised if no callbacks
4
+ # are passed to the UseCase.
5
+ class NoBlockGivenError < StandardError; end
6
+ end
7
+ end
@@ -0,0 +1,3 @@
1
+ module Oha
2
+ VERSION = '0.1.0'
3
+ end
data/oha.gemspec ADDED
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ lib = File.expand_path('lib', __dir__)
4
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
5
+ require 'oha/version'
6
+
7
+ Gem::Specification.new do |spec|
8
+ spec.name = 'oha'
9
+ spec.version = Oha::VERSION
10
+ spec.authors = ['Mario Viapiano']
11
+ spec.email = ['marioeviapiano@gmail.com']
12
+
13
+ spec.summary = "Service Objects...mariiillo's way"
14
+ spec.description = "Service Objects...mariiillo's way"
15
+ spec.homepage = 'https://rubygems.org/gems/oha'
16
+ spec.license = 'MIT'
17
+
18
+ spec.required_ruby_version = '>= 3.0'
19
+
20
+ spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
21
+
22
+ spec.metadata['homepage_uri'] = spec.homepage
23
+ spec.metadata['source_code_uri'] = 'http://www.github.com/mariiillo/oha'
24
+ spec.metadata['changelog_uri'] = 'http://www.github.com/mariiillo/oha'
25
+
26
+ # Specify which files should be added to the gem when it is released.
27
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
28
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
29
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
30
+ end
31
+ spec.bindir = 'exe'
32
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
33
+ spec.require_paths = ['lib']
34
+
35
+ spec.add_development_dependency 'bundler', '~> 2.0'
36
+ spec.add_development_dependency 'byebug', '~> 11.1'
37
+ spec.add_development_dependency 'rake', '~> 13.0'
38
+ spec.add_development_dependency 'rspec', '~> 3.0'
39
+ spec.add_development_dependency 'simplecov', '~> 0.17.1'
40
+ end
metadata ADDED
@@ -0,0 +1,135 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: oha
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Mario Viapiano
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2021-07-05 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: '2.0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: byebug
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '11.1'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '11.1'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '13.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '13.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: simplecov
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 0.17.1
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.17.1
83
+ description: Service Objects...mariiillo's way
84
+ email:
85
+ - marioeviapiano@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".ruby-version"
93
+ - ".travis.yml"
94
+ - CODE_OF_CONDUCT.md
95
+ - Gemfile
96
+ - Gemfile.lock
97
+ - LICENSE.txt
98
+ - README.md
99
+ - Rakefile
100
+ - bin/console
101
+ - bin/setup
102
+ - lib/oha.rb
103
+ - lib/oha/binder.rb
104
+ - lib/oha/errors/event_not_defined.rb
105
+ - lib/oha/errors/no_block_given_error.rb
106
+ - lib/oha/version.rb
107
+ - oha.gemspec
108
+ homepage: https://rubygems.org/gems/oha
109
+ licenses:
110
+ - MIT
111
+ metadata:
112
+ allowed_push_host: https://rubygems.org/
113
+ homepage_uri: https://rubygems.org/gems/oha
114
+ source_code_uri: http://www.github.com/mariiillo/oha
115
+ changelog_uri: http://www.github.com/mariiillo/oha
116
+ post_install_message:
117
+ rdoc_options: []
118
+ require_paths:
119
+ - lib
120
+ required_ruby_version: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '3.0'
125
+ required_rubygems_version: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - ">="
128
+ - !ruby/object:Gem::Version
129
+ version: '0'
130
+ requirements: []
131
+ rubygems_version: 3.2.3
132
+ signing_key:
133
+ specification_version: 4
134
+ summary: Service Objects...mariiillo's way
135
+ test_files: []