cmdx 0.5.0 → 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 (126) hide show
  1. checksums.yaml +4 -4
  2. data/.DS_Store +0 -0
  3. data/.cursor/rules/cursor-instructions.mdc +6 -0
  4. data/.rubocop.yml +16 -1
  5. data/.ruby-version +1 -1
  6. data/CHANGELOG.md +31 -1
  7. data/README.md +72 -25
  8. data/docs/ai_prompts.md +309 -0
  9. data/docs/basics/call.md +225 -14
  10. data/docs/basics/chain.md +271 -0
  11. data/docs/basics/context.md +232 -33
  12. data/docs/basics/setup.md +76 -12
  13. data/docs/callbacks.md +273 -0
  14. data/docs/configuration.md +158 -28
  15. data/docs/getting_started.md +134 -22
  16. data/docs/interruptions/exceptions.md +189 -11
  17. data/docs/interruptions/faults.md +187 -44
  18. data/docs/interruptions/halt.md +179 -35
  19. data/docs/logging.md +194 -53
  20. data/docs/middlewares.md +735 -0
  21. data/docs/outcomes/result.md +296 -10
  22. data/docs/outcomes/states.md +203 -31
  23. data/docs/outcomes/statuses.md +275 -30
  24. data/docs/parameters/coercions.md +402 -29
  25. data/docs/parameters/defaults.md +249 -25
  26. data/docs/parameters/definitions.md +238 -72
  27. data/docs/parameters/namespacing.md +250 -27
  28. data/docs/parameters/validations.md +193 -168
  29. data/docs/testing.md +550 -0
  30. data/docs/tips_and_tricks.md +95 -43
  31. data/docs/workflows.md +319 -0
  32. data/lib/cmdx/.DS_Store +0 -0
  33. data/lib/cmdx/callback.rb +69 -0
  34. data/lib/cmdx/callback_registry.rb +106 -0
  35. data/lib/cmdx/chain.rb +190 -0
  36. data/lib/cmdx/chain_inspector.rb +149 -0
  37. data/lib/cmdx/chain_serializer.rb +175 -0
  38. data/lib/cmdx/coercions/array.rb +37 -0
  39. data/lib/cmdx/coercions/big_decimal.rb +33 -0
  40. data/lib/cmdx/coercions/boolean.rb +41 -1
  41. data/lib/cmdx/coercions/complex.rb +31 -0
  42. data/lib/cmdx/coercions/date.rb +39 -0
  43. data/lib/cmdx/coercions/date_time.rb +39 -0
  44. data/lib/cmdx/coercions/float.rb +31 -0
  45. data/lib/cmdx/coercions/hash.rb +42 -0
  46. data/lib/cmdx/coercions/integer.rb +32 -0
  47. data/lib/cmdx/coercions/rational.rb +31 -0
  48. data/lib/cmdx/coercions/string.rb +31 -0
  49. data/lib/cmdx/coercions/time.rb +39 -0
  50. data/lib/cmdx/coercions/virtual.rb +31 -0
  51. data/lib/cmdx/configuration.rb +217 -9
  52. data/lib/cmdx/context.rb +173 -2
  53. data/lib/cmdx/core_ext/hash.rb +72 -0
  54. data/lib/cmdx/core_ext/module.rb +94 -0
  55. data/lib/cmdx/core_ext/object.rb +105 -0
  56. data/lib/cmdx/correlator.rb +217 -0
  57. data/lib/cmdx/error.rb +210 -8
  58. data/lib/cmdx/errors.rb +256 -1
  59. data/lib/cmdx/fault.rb +177 -2
  60. data/lib/cmdx/faults.rb +158 -2
  61. data/lib/cmdx/immutator.rb +121 -2
  62. data/lib/cmdx/lazy_struct.rb +261 -18
  63. data/lib/cmdx/log_formatters/json.rb +46 -0
  64. data/lib/cmdx/log_formatters/key_value.rb +46 -0
  65. data/lib/cmdx/log_formatters/line.rb +54 -0
  66. data/lib/cmdx/log_formatters/logstash.rb +64 -0
  67. data/lib/cmdx/log_formatters/pretty_json.rb +57 -0
  68. data/lib/cmdx/log_formatters/pretty_key_value.rb +51 -0
  69. data/lib/cmdx/log_formatters/pretty_line.rb +60 -0
  70. data/lib/cmdx/log_formatters/raw.rb +54 -0
  71. data/lib/cmdx/logger.rb +85 -0
  72. data/lib/cmdx/logger_ansi.rb +93 -7
  73. data/lib/cmdx/logger_serializer.rb +116 -0
  74. data/lib/cmdx/middleware.rb +74 -0
  75. data/lib/cmdx/middleware_registry.rb +106 -0
  76. data/lib/cmdx/middlewares/correlate.rb +266 -0
  77. data/lib/cmdx/middlewares/timeout.rb +232 -0
  78. data/lib/cmdx/parameter.rb +228 -1
  79. data/lib/cmdx/parameter_inspector.rb +61 -0
  80. data/lib/cmdx/parameter_registry.rb +125 -0
  81. data/lib/cmdx/parameter_serializer.rb +83 -0
  82. data/lib/cmdx/parameter_validator.rb +62 -0
  83. data/lib/cmdx/parameter_value.rb +109 -1
  84. data/lib/cmdx/parameters_inspector.rb +59 -0
  85. data/lib/cmdx/parameters_serializer.rb +102 -0
  86. data/lib/cmdx/railtie.rb +123 -3
  87. data/lib/cmdx/result.rb +367 -25
  88. data/lib/cmdx/result_ansi.rb +105 -9
  89. data/lib/cmdx/result_inspector.rb +76 -0
  90. data/lib/cmdx/result_logger.rb +90 -3
  91. data/lib/cmdx/result_serializer.rb +137 -0
  92. data/lib/cmdx/rspec/result_matchers.rb +917 -0
  93. data/lib/cmdx/rspec/task_matchers.rb +570 -0
  94. data/lib/cmdx/task.rb +405 -37
  95. data/lib/cmdx/task_serializer.rb +74 -2
  96. data/lib/cmdx/utils/ansi_color.rb +95 -0
  97. data/lib/cmdx/utils/log_timestamp.rb +48 -0
  98. data/lib/cmdx/utils/monotonic_runtime.rb +71 -4
  99. data/lib/cmdx/utils/name_affix.rb +78 -0
  100. data/lib/cmdx/validators/custom.rb +82 -0
  101. data/lib/cmdx/validators/exclusion.rb +94 -0
  102. data/lib/cmdx/validators/format.rb +102 -8
  103. data/lib/cmdx/validators/inclusion.rb +104 -0
  104. data/lib/cmdx/validators/length.rb +128 -0
  105. data/lib/cmdx/validators/numeric.rb +128 -0
  106. data/lib/cmdx/validators/presence.rb +93 -7
  107. data/lib/cmdx/version.rb +7 -1
  108. data/lib/cmdx/workflow.rb +394 -0
  109. data/lib/cmdx.rb +25 -64
  110. data/lib/generators/cmdx/install_generator.rb +37 -1
  111. data/lib/generators/cmdx/task_generator.rb +69 -1
  112. data/lib/generators/cmdx/templates/install.rb +8 -12
  113. data/lib/generators/cmdx/workflow_generator.rb +109 -0
  114. metadata +54 -15
  115. data/docs/basics/run.md +0 -34
  116. data/docs/batch.md +0 -53
  117. data/docs/example.md +0 -82
  118. data/docs/hooks.md +0 -62
  119. data/lib/cmdx/batch.rb +0 -43
  120. data/lib/cmdx/parameters.rb +0 -35
  121. data/lib/cmdx/run.rb +0 -39
  122. data/lib/cmdx/run_inspector.rb +0 -26
  123. data/lib/cmdx/run_serializer.rb +0 -20
  124. data/lib/cmdx/task_hook.rb +0 -18
  125. data/lib/generators/cmdx/batch_generator.rb +0 -30
  126. /data/lib/generators/cmdx/templates/{batch.rb.tt → workflow.rb.tt} +0 -0
@@ -1,35 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module CMDx
4
- class Parameters < Array
5
-
6
- def invalid?
7
- !valid?
8
- end
9
-
10
- def valid?
11
- all?(&:valid?)
12
- end
13
-
14
- def validate!(task)
15
- each { |p| recursive_validate!(task, p) }
16
- end
17
-
18
- def to_h
19
- ParametersSerializer.call(self)
20
- end
21
- alias to_a to_h
22
-
23
- def to_s
24
- ParametersInspector.call(self)
25
- end
26
-
27
- private
28
-
29
- def recursive_validate!(task, parameter)
30
- task.send(parameter.method_name)
31
- parameter.children.each { |cp| recursive_validate!(task, cp) }
32
- end
33
-
34
- end
35
- end
data/lib/cmdx/run.rb DELETED
@@ -1,39 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module CMDx
4
- class Run
5
-
6
- __cmdx_attr_delegator :index, to: :results
7
- __cmdx_attr_delegator :state, :status, :outcome, :runtime, to: :first_result
8
-
9
- attr_reader :id, :results
10
-
11
- def initialize(attributes = {})
12
- @id = attributes[:id] || SecureRandom.uuid
13
- @results = Array(attributes[:results])
14
- end
15
-
16
- def freeze
17
- first_result
18
- super
19
- end
20
-
21
- def to_h
22
- RunSerializer.call(self)
23
- end
24
- alias to_a to_h
25
-
26
- def to_s
27
- RunInspector.call(self)
28
- end
29
-
30
- private
31
-
32
- def first_result
33
- return @first_result if defined?(@first_result)
34
-
35
- @first_result = @results.first
36
- end
37
-
38
- end
39
- end
@@ -1,26 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module CMDx
4
- module RunInspector
5
-
6
- FOOTER_KEYS = %i[
7
- state status outcome runtime
8
- ].freeze
9
-
10
- module_function
11
-
12
- def call(run)
13
- header = "\nrun: #{run.id}"
14
- footer = FOOTER_KEYS.map { |key| "#{key}: #{run.send(key)}" }.join(" | ")
15
- spacer = "=" * [header.size, footer.size].max
16
-
17
- run
18
- .results
19
- .map { |r| r.to_h.except(:run_id).pretty_inspect }
20
- .unshift(header, "#{spacer}\n")
21
- .push(spacer, "#{footer}\n\n")
22
- .join("\n")
23
- end
24
-
25
- end
26
- end
@@ -1,20 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module CMDx
4
- module RunSerializer
5
-
6
- module_function
7
-
8
- def call(run)
9
- {
10
- id: run.id,
11
- state: run.state,
12
- status: run.status,
13
- outcome: run.outcome,
14
- runtime: run.runtime,
15
- results: run.results.map(&:to_h)
16
- }
17
- end
18
-
19
- end
20
- end
@@ -1,18 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module CMDx
4
- module TaskHook
5
-
6
- module_function
7
-
8
- def call(task, hook)
9
- Array(task.class.cmd_hooks[hook]).each do |callables, options|
10
- next unless task.__cmdx_eval(options)
11
-
12
- hooks = Array(callables)
13
- hooks.each { |h| task.__cmdx_try(h) }
14
- end
15
- end
16
-
17
- end
18
- end
@@ -1,30 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Cmdx
4
- class BatchGenerator < Rails::Generators::NamedBase
5
-
6
- source_root File.expand_path("templates", __dir__)
7
- check_class_collision prefix: "Batch"
8
-
9
- desc "Generates a batch task with the given NAME (if one does not exist)."
10
-
11
- def copy_files
12
- name = file_name.sub(/^batch_?/i, "")
13
- path = File.join("app/cmds", class_path, "batch_#{name}.rb")
14
- template("batch.rb.tt", path)
15
- end
16
-
17
- private
18
-
19
- def class_name
20
- @class_name ||= super.delete_prefix("Batch")
21
- end
22
-
23
- def parent_class_name
24
- ApplicationBatch
25
- rescue StandardError
26
- CMDx::Batch
27
- end
28
-
29
- end
30
- end