better_service 1.0.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.
Files changed (78) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +1321 -0
  4. data/Rakefile +15 -0
  5. data/lib/better_service/cache_service.rb +310 -0
  6. data/lib/better_service/concerns/instrumentation.rb +242 -0
  7. data/lib/better_service/concerns/serviceable/authorizable.rb +106 -0
  8. data/lib/better_service/concerns/serviceable/cacheable.rb +97 -0
  9. data/lib/better_service/concerns/serviceable/messageable.rb +30 -0
  10. data/lib/better_service/concerns/serviceable/presentable.rb +66 -0
  11. data/lib/better_service/concerns/serviceable/transactional.rb +51 -0
  12. data/lib/better_service/concerns/serviceable/validatable.rb +58 -0
  13. data/lib/better_service/concerns/serviceable/viewable.rb +49 -0
  14. data/lib/better_service/concerns/serviceable.rb +12 -0
  15. data/lib/better_service/concerns/workflowable/callbacks.rb +116 -0
  16. data/lib/better_service/concerns/workflowable/context.rb +108 -0
  17. data/lib/better_service/concerns/workflowable/step.rb +141 -0
  18. data/lib/better_service/concerns/workflowable.rb +12 -0
  19. data/lib/better_service/configuration.rb +113 -0
  20. data/lib/better_service/errors/better_service_error.rb +271 -0
  21. data/lib/better_service/errors/configuration/configuration_error.rb +21 -0
  22. data/lib/better_service/errors/configuration/invalid_configuration_error.rb +28 -0
  23. data/lib/better_service/errors/configuration/invalid_schema_error.rb +28 -0
  24. data/lib/better_service/errors/configuration/nil_user_error.rb +37 -0
  25. data/lib/better_service/errors/configuration/schema_required_error.rb +29 -0
  26. data/lib/better_service/errors/runtime/authorization_error.rb +38 -0
  27. data/lib/better_service/errors/runtime/database_error.rb +38 -0
  28. data/lib/better_service/errors/runtime/execution_error.rb +27 -0
  29. data/lib/better_service/errors/runtime/resource_not_found_error.rb +38 -0
  30. data/lib/better_service/errors/runtime/runtime_error.rb +22 -0
  31. data/lib/better_service/errors/runtime/transaction_error.rb +34 -0
  32. data/lib/better_service/errors/runtime/validation_error.rb +42 -0
  33. data/lib/better_service/errors/workflowable/configuration/duplicate_step_error.rb +27 -0
  34. data/lib/better_service/errors/workflowable/configuration/invalid_step_error.rb +12 -0
  35. data/lib/better_service/errors/workflowable/configuration/step_not_found_error.rb +29 -0
  36. data/lib/better_service/errors/workflowable/configuration/workflow_configuration_error.rb +24 -0
  37. data/lib/better_service/errors/workflowable/runtime/rollback_error.rb +46 -0
  38. data/lib/better_service/errors/workflowable/runtime/step_execution_error.rb +47 -0
  39. data/lib/better_service/errors/workflowable/runtime/workflow_execution_error.rb +40 -0
  40. data/lib/better_service/errors/workflowable/runtime/workflow_runtime_error.rb +25 -0
  41. data/lib/better_service/railtie.rb +6 -0
  42. data/lib/better_service/services/action_service.rb +60 -0
  43. data/lib/better_service/services/base.rb +249 -0
  44. data/lib/better_service/services/create_service.rb +60 -0
  45. data/lib/better_service/services/destroy_service.rb +57 -0
  46. data/lib/better_service/services/index_service.rb +56 -0
  47. data/lib/better_service/services/show_service.rb +44 -0
  48. data/lib/better_service/services/update_service.rb +58 -0
  49. data/lib/better_service/subscribers/log_subscriber.rb +131 -0
  50. data/lib/better_service/subscribers/stats_subscriber.rb +208 -0
  51. data/lib/better_service/version.rb +3 -0
  52. data/lib/better_service/workflows/base.rb +106 -0
  53. data/lib/better_service/workflows/dsl.rb +59 -0
  54. data/lib/better_service/workflows/execution.rb +89 -0
  55. data/lib/better_service/workflows/result_builder.rb +67 -0
  56. data/lib/better_service/workflows/rollback_support.rb +44 -0
  57. data/lib/better_service/workflows/transaction_support.rb +32 -0
  58. data/lib/better_service.rb +28 -0
  59. data/lib/generators/serviceable/action_generator.rb +29 -0
  60. data/lib/generators/serviceable/create_generator.rb +27 -0
  61. data/lib/generators/serviceable/destroy_generator.rb +27 -0
  62. data/lib/generators/serviceable/index_generator.rb +27 -0
  63. data/lib/generators/serviceable/scaffold_generator.rb +70 -0
  64. data/lib/generators/serviceable/show_generator.rb +27 -0
  65. data/lib/generators/serviceable/templates/action_service.rb.tt +42 -0
  66. data/lib/generators/serviceable/templates/create_service.rb.tt +33 -0
  67. data/lib/generators/serviceable/templates/destroy_service.rb.tt +40 -0
  68. data/lib/generators/serviceable/templates/index_service.rb.tt +54 -0
  69. data/lib/generators/serviceable/templates/service_test.rb.tt +23 -0
  70. data/lib/generators/serviceable/templates/show_service.rb.tt +37 -0
  71. data/lib/generators/serviceable/templates/update_service.rb.tt +50 -0
  72. data/lib/generators/serviceable/update_generator.rb +27 -0
  73. data/lib/generators/workflowable/WORKFLOW_README +27 -0
  74. data/lib/generators/workflowable/templates/workflow.rb.tt +72 -0
  75. data/lib/generators/workflowable/templates/workflow_test.rb.tt +62 -0
  76. data/lib/generators/workflowable/workflow_generator.rb +60 -0
  77. data/lib/tasks/better_service_tasks.rake +4 -0
  78. metadata +180 -0
@@ -0,0 +1,60 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "rails/generators/named_base"
4
+
5
+ module Workflowable
6
+ module Generators
7
+ class WorkflowGenerator < Rails::Generators::NamedBase
8
+ source_root File.expand_path("templates", __dir__)
9
+
10
+ desc "Generate a Workflow for composing multiple services into a pipeline"
11
+
12
+ class_option :steps,
13
+ type: :array,
14
+ default: [],
15
+ desc: "List of step names to include in the workflow (e.g., --steps create_order charge_payment send_email)"
16
+
17
+ class_option :transaction,
18
+ type: :boolean,
19
+ default: false,
20
+ desc: "Enable database transactions for the workflow"
21
+
22
+ class_option :skip_test,
23
+ type: :boolean,
24
+ default: false,
25
+ desc: "Skip test file generation"
26
+
27
+ def create_workflow_file
28
+ template "workflow.rb.tt", File.join("app/workflows", class_path, "#{workflow_file_name}.rb")
29
+ end
30
+
31
+ def create_test_file
32
+ return if options[:skip_test]
33
+
34
+ template "workflow_test.rb.tt", File.join("test/workflows", class_path, "#{workflow_file_name}_test.rb")
35
+ end
36
+
37
+ def show_readme
38
+ readme "WORKFLOW_README" if behavior == :invoke
39
+ end
40
+
41
+ private
42
+
43
+ def workflow_file_name
44
+ "#{file_name}_workflow"
45
+ end
46
+
47
+ def workflow_class_name
48
+ "#{class_name}Workflow"
49
+ end
50
+
51
+ def workflow_steps
52
+ @workflow_steps ||= options[:steps].map(&:underscore).map(&:to_sym)
53
+ end
54
+
55
+ def use_transaction
56
+ options[:transaction]
57
+ end
58
+ end
59
+ end
60
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :better_service do
3
+ # # Task goes here
4
+ # end
metadata ADDED
@@ -0,0 +1,180 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: better_service
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - alessiobussolari
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2025-11-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 8.1.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 8.1.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: dry-schema
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.13'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.13'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rubocop-rails-omakase
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.0'
69
+ description: A powerful DSL-based framework for building Service Objects in Rails
70
+ with built-in support for validation, caching, presenters, and more.
71
+ email:
72
+ - alessio@cosmic.tech
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - MIT-LICENSE
78
+ - README.md
79
+ - Rakefile
80
+ - lib/better_service.rb
81
+ - lib/better_service/cache_service.rb
82
+ - lib/better_service/concerns/instrumentation.rb
83
+ - lib/better_service/concerns/serviceable.rb
84
+ - lib/better_service/concerns/serviceable/authorizable.rb
85
+ - lib/better_service/concerns/serviceable/cacheable.rb
86
+ - lib/better_service/concerns/serviceable/messageable.rb
87
+ - lib/better_service/concerns/serviceable/presentable.rb
88
+ - lib/better_service/concerns/serviceable/transactional.rb
89
+ - lib/better_service/concerns/serviceable/validatable.rb
90
+ - lib/better_service/concerns/serviceable/viewable.rb
91
+ - lib/better_service/concerns/workflowable.rb
92
+ - lib/better_service/concerns/workflowable/callbacks.rb
93
+ - lib/better_service/concerns/workflowable/context.rb
94
+ - lib/better_service/concerns/workflowable/step.rb
95
+ - lib/better_service/configuration.rb
96
+ - lib/better_service/errors/better_service_error.rb
97
+ - lib/better_service/errors/configuration/configuration_error.rb
98
+ - lib/better_service/errors/configuration/invalid_configuration_error.rb
99
+ - lib/better_service/errors/configuration/invalid_schema_error.rb
100
+ - lib/better_service/errors/configuration/nil_user_error.rb
101
+ - lib/better_service/errors/configuration/schema_required_error.rb
102
+ - lib/better_service/errors/runtime/authorization_error.rb
103
+ - lib/better_service/errors/runtime/database_error.rb
104
+ - lib/better_service/errors/runtime/execution_error.rb
105
+ - lib/better_service/errors/runtime/resource_not_found_error.rb
106
+ - lib/better_service/errors/runtime/runtime_error.rb
107
+ - lib/better_service/errors/runtime/transaction_error.rb
108
+ - lib/better_service/errors/runtime/validation_error.rb
109
+ - lib/better_service/errors/workflowable/configuration/duplicate_step_error.rb
110
+ - lib/better_service/errors/workflowable/configuration/invalid_step_error.rb
111
+ - lib/better_service/errors/workflowable/configuration/step_not_found_error.rb
112
+ - lib/better_service/errors/workflowable/configuration/workflow_configuration_error.rb
113
+ - lib/better_service/errors/workflowable/runtime/rollback_error.rb
114
+ - lib/better_service/errors/workflowable/runtime/step_execution_error.rb
115
+ - lib/better_service/errors/workflowable/runtime/workflow_execution_error.rb
116
+ - lib/better_service/errors/workflowable/runtime/workflow_runtime_error.rb
117
+ - lib/better_service/railtie.rb
118
+ - lib/better_service/services/action_service.rb
119
+ - lib/better_service/services/base.rb
120
+ - lib/better_service/services/create_service.rb
121
+ - lib/better_service/services/destroy_service.rb
122
+ - lib/better_service/services/index_service.rb
123
+ - lib/better_service/services/show_service.rb
124
+ - lib/better_service/services/update_service.rb
125
+ - lib/better_service/subscribers/log_subscriber.rb
126
+ - lib/better_service/subscribers/stats_subscriber.rb
127
+ - lib/better_service/version.rb
128
+ - lib/better_service/workflows/base.rb
129
+ - lib/better_service/workflows/dsl.rb
130
+ - lib/better_service/workflows/execution.rb
131
+ - lib/better_service/workflows/result_builder.rb
132
+ - lib/better_service/workflows/rollback_support.rb
133
+ - lib/better_service/workflows/transaction_support.rb
134
+ - lib/generators/serviceable/action_generator.rb
135
+ - lib/generators/serviceable/create_generator.rb
136
+ - lib/generators/serviceable/destroy_generator.rb
137
+ - lib/generators/serviceable/index_generator.rb
138
+ - lib/generators/serviceable/scaffold_generator.rb
139
+ - lib/generators/serviceable/show_generator.rb
140
+ - lib/generators/serviceable/templates/action_service.rb.tt
141
+ - lib/generators/serviceable/templates/create_service.rb.tt
142
+ - lib/generators/serviceable/templates/destroy_service.rb.tt
143
+ - lib/generators/serviceable/templates/index_service.rb.tt
144
+ - lib/generators/serviceable/templates/service_test.rb.tt
145
+ - lib/generators/serviceable/templates/show_service.rb.tt
146
+ - lib/generators/serviceable/templates/update_service.rb.tt
147
+ - lib/generators/serviceable/update_generator.rb
148
+ - lib/generators/workflowable/WORKFLOW_README
149
+ - lib/generators/workflowable/templates/workflow.rb.tt
150
+ - lib/generators/workflowable/templates/workflow_test.rb.tt
151
+ - lib/generators/workflowable/workflow_generator.rb
152
+ - lib/tasks/better_service_tasks.rake
153
+ homepage: https://github.com/alessiobussolari/better_service
154
+ licenses:
155
+ - MIT
156
+ metadata:
157
+ homepage_uri: https://github.com/alessiobussolari/better_service
158
+ source_code_uri: https://github.com/alessiobussolari/better_service
159
+ changelog_uri: https://github.com/alessiobussolari/better_service/blob/main/CHANGELOG.md
160
+ rubygems_mfa_required: 'true'
161
+ post_install_message:
162
+ rdoc_options: []
163
+ require_paths:
164
+ - lib
165
+ required_ruby_version: !ruby/object:Gem::Requirement
166
+ requirements:
167
+ - - ">="
168
+ - !ruby/object:Gem::Version
169
+ version: 3.0.0
170
+ required_rubygems_version: !ruby/object:Gem::Requirement
171
+ requirements:
172
+ - - ">="
173
+ - !ruby/object:Gem::Version
174
+ version: '0'
175
+ requirements: []
176
+ rubygems_version: 3.5.22
177
+ signing_key:
178
+ specification_version: 4
179
+ summary: DSL-based Service Objects framework for Rails
180
+ test_files: []