Skip to content

Commit

Permalink
docs(yard): remove since cause it confuses
Browse files Browse the repository at this point in the history
  • Loading branch information
marian13 committed Jan 8, 2024
1 parent f4d5f7f commit b96b885
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 36 deletions.
1 change: 0 additions & 1 deletion lib/convenient_service/examples/standard/request_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
require_relative "request_params/utils"

##
# @since 0.3.0
#
# @internal
# Usage example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
require_relative "request_params/utils"

##
# @since 0.3.0
#
# @internal
# Usage example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ class ResultSpec
# @param service_class [Class]
# @param chain [Hash]
# @return [void]
# @since 0.1.0
#

def initialize(status:, service_class: nil, chain: {})
@status = status
@service_class = service_class
Expand All @@ -27,17 +26,15 @@ def initialize(status:, service_class: nil, chain: {})
##
# @param service_class [Class]
# @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
# @since 0.1.0
#

def for(service_class)
self.class.new(status: status, service_class: service_class, chain: chain)
end

##
# @param data [Hash]
# @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
# @since 0.1.0
#

def with_data(data)
chain[:data] = data

Expand All @@ -47,8 +44,7 @@ def with_data(data)
##
# @param message [String]
# @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
# @since 0.1.0
#

def with_message(message)
chain[:message] = message

Expand All @@ -58,8 +54,7 @@ def with_message(message)
##
# @param code [String]
# @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
# @since 0.1.0
#

def with_code(code)
chain[:code] = code

Expand All @@ -69,8 +64,7 @@ def with_code(code)
##
# @param data [Hash]
# @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
# @since 0.1.0
#

def and_data(data)
chain[:data] = data

Expand All @@ -80,8 +74,7 @@ def and_data(data)
##
# @param message [String]
# @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
# @since 0.1.0
#

def and_message(message)
chain[:message] = message

Expand All @@ -91,8 +84,7 @@ def and_message(message)
##
# @param code [String]
# @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
# @since 0.1.0
#

def and_code(code)
chain[:code] = code

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ module Concern
instance_methods do
##
# @return [String]
# @since 0.2.0
#

def inspect
"<#{inspect_values[:name]}>"
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,64 +10,56 @@ module Concern
class_methods do
##
# @return [Boolean]
# @since 0.2.0
#

def success?(...)
result(...).success?
end

##
# @return [Boolean]
# @since 0.2.0
#

def error?(...)
result(...).error?
end

##
# @return [Boolean]
# @since 0.2.0
#

def failure?(...)
result(...).failure?
end

##
# @return [Boolean]
# @since 0.2.0
#

def not_success?(...)
result(...).not_success?
end

##
# @return [Boolean]
# @since 0.2.0
#

def not_error?(...)
result(...).not_error?
end

##
# @return [Boolean]
# @since 0.2.0
#

def not_failure?(...)
result(...).not_failure?
end

##
# @return [Boolean]
# @since 0.12.0
#

def ok?(...)
result(...).success?
end

##
# @return [Boolean]
# @since 0.12.0
#

def not_ok?(...)
result(...).not_success?
end
Expand Down

0 comments on commit b96b885

Please sign in to comment.