pair-kit-dsl-factory 0.0.1

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 (12) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +4 -0
  3. data/Gemfile +7 -0
  4. data/LICENSE +20 -0
  5. data/README.md +136 -0
  6. data/Rakefile +22 -0
  7. data/lib/pair_kit/dsl_factory/builder.rb +19 -0
  8. data/lib/pair_kit/dsl_factory/version.rb +7 -0
  9. data/lib/pair_kit/dsl_factory/wrapper.rb +27 -0
  10. data/lib/pair_kit/dsl_factory.rb +43 -0
  11. data/pair_kit_dsl_factory.gemspec +41 -0
  12. metadata +204 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 48396edf98fe1d900b089952ad7b7fb9817ad3c53ac247c32ce4814e9a455883
4
+ data.tar.gz: ba752937c41de3c94bdac73eb325398c74aa1f3d6297a8ca3d3e3de944e0fb72
5
+ SHA512:
6
+ metadata.gz: 536ea00e45e1d6f10188d5dfef00bfb11407841dc285af7a1bb0ac2ccc8c752ea247a26b478eb3d0e2e9e3386daa5d98968d8f96a2deede23a098bd743bbd03c
7
+ data.tar.gz: 568c3fbdb77270564e04e0e7d3c3eb76f39edbe3505644e5fccf81f4a3ab0ad74d0ba6e5c8628a13b6d0658216d9d58e308f88c522c815c35b619193cdff2d48
data/CHANGELOG.md ADDED
@@ -0,0 +1,4 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0 (01-Jul-24)
4
+ * Initial release
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'http://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :test do
6
+ gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
7
+ end
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 PairFinance team, Dmitry Sharkov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+ The above copyright notice and this permission notice shall be
13
+ included in all copies or substantial portions of the Software.
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,136 @@
1
+ # DSL Factory
2
+
3
+ This gem helps to build custom DSL. More documentation coming later.
4
+
5
+ ---
6
+ **NOTE**
7
+
8
+ More documentation coming soon.
9
+
10
+ ---
11
+
12
+ ## Usage
13
+
14
+ In your gemfile
15
+
16
+ ```ruby
17
+
18
+ gem 'pair-kit-dsl-factory'
19
+
20
+ ```
21
+
22
+ In your code
23
+
24
+ ```ruby
25
+
26
+ require 'pair_kit/dsl_factory'
27
+
28
+ ```
29
+
30
+
31
+ ## Example
32
+
33
+ This example show how to build simple JSON Schema DSL.
34
+
35
+ ### Step 1: Define your DSL parts as modules
36
+
37
+ ```ruby
38
+ module SchemaDsl
39
+ def struct(&block)
40
+ _schema[:type] = :object
41
+ _schema[:properties] = {}
42
+ _schema[:required] = []
43
+
44
+ build(:struct, _schema, &block)
45
+ end
46
+
47
+ def array(&block)
48
+ _schema[:type] = :array
49
+ _schema[:item] ||= {}
50
+
51
+ build(:array, _schema, &block)
52
+ end
53
+
54
+ def number
55
+ _schema[:type] = :number
56
+ end
57
+
58
+ def string
59
+ _schema[:type] = :string
60
+ end
61
+ end
62
+
63
+ ```
64
+
65
+ ### Step 2: Configure your factory
66
+
67
+ ```ruby
68
+ class ApplicationModel < ActiveRecord::Model
69
+ JSON_SCHEMA_BUILDER = DslFactory.new do
70
+ configure_builder(:schema, SchemaDsl) do
71
+ private
72
+
73
+ def _schema
74
+ subject
75
+ end
76
+ end
77
+
78
+ configure_builder(:struct, SchemaDsl) do
79
+ def prop(name, &block)
80
+ name = name.to_sym
81
+ subject[:properties][name] = {}
82
+
83
+ build(subject, builder: :property, name: name, &block)
84
+ end
85
+ end
86
+
87
+ configure_builder(:array, SchemaDsl) do
88
+ def item(&block)
89
+ build(subject[:item], builder: :schema &block)
90
+ end
91
+
92
+ private
93
+
94
+ def _schema
95
+ subject[:item]
96
+ end
97
+ end
98
+
99
+ configure_builder(:property, SchemaDsl) do
100
+
101
+ def required
102
+ (subject[:required] ||= []) << options[:name]
103
+ end
104
+
105
+ private
106
+
107
+ def _schema
108
+ subject[:properties][options[:name]]
109
+ end
110
+ end
111
+ end
112
+
113
+ class_attribute :json_schema
114
+
115
+ def self.draw_schema(&block)
116
+ self.json_schema = {}
117
+ JSON_SCHEMA_BUILDER.build(json_schema).struct(&block)
118
+ end
119
+ end
120
+
121
+ ```
122
+
123
+ ### Step 3: Use your DSL
124
+
125
+ ```ruby
126
+ class User < ApplicationModel
127
+ draw_schema do
128
+ prop(:first_name).required.string
129
+ prop(:last_name).required.string
130
+ prop(:balance).required.number
131
+ prop(:tags).required.array.string
132
+ end
133
+ end
134
+ ```
135
+
136
+
data/Rakefile ADDED
@@ -0,0 +1,22 @@
1
+ require 'rake'
2
+ require 'debug'
3
+
4
+ begin
5
+ require 'bundler/setup'
6
+ Bundler::GemHelper.install_tasks
7
+ rescue LoadError
8
+ puts 'although not required, bundler is recommended for running the tests'
9
+ end
10
+
11
+ task default: :spec
12
+
13
+ require 'rspec/core/rake_task'
14
+
15
+ RSpec::Core::RakeTask.new(:spec)
16
+
17
+ require 'rubocop/rake_task'
18
+
19
+ RuboCop::RakeTask.new do |task|
20
+ task.requires << 'rubocop-performance'
21
+ task.requires << 'rubocop-rspec'
22
+ end
data/lib/pair_kit/dsl_factory/builder.rb ADDED
@@ -0,0 +1,19 @@
1
+ module PairKit
2
+ class DslFactory
3
+ class Builder
4
+ def initialize(factory, subject, **options)
5
+ @factory = factory
6
+ @subject = subject
7
+ @options = options
8
+ end
9
+
10
+ private
11
+
12
+ attr_accessor :subject, :factory, :options
13
+
14
+ def build(new_thing, **options, &block)
15
+ factory.build(new_thing, **options, &block)
16
+ end
17
+ end
18
+ end
19
+ end
data/lib/pair_kit/dsl_factory/version.rb ADDED
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PairKit
4
+ class DslFactory
5
+ VERSION = '0.0.1'
6
+ end
7
+ end
data/lib/pair_kit/dsl_factory/wrapper.rb ADDED
@@ -0,0 +1,27 @@
1
+ module PairKit
2
+ class DslFactory
3
+ class Wrapper
4
+ def initialize(name, builder)
5
+ @name = name
6
+ @builder = builder
7
+ end
8
+
9
+ def respond_to_missing?(method_name, include_private = false)
10
+ @builder.respond_to?(method_name) || super
11
+ end
12
+
13
+ def method_missing(method_name, *args, **kw_args, &block)
14
+ if @builder.respond_to?(method_name)
15
+ builder_return = @builder.public_send(method_name, *args, **kw_args, &block)
16
+ if block
17
+ self
18
+ else
19
+ builder_return.is_a?(Wrapper) ? builder_return : self
20
+ end
21
+ else
22
+ raise "Method missing #{method_name} for builder #{@name}"
23
+ end
24
+ end
25
+ end
26
+ end
27
+ end
data/lib/pair_kit/dsl_factory.rb ADDED
@@ -0,0 +1,43 @@
1
+ module PairKit
2
+ class DslFactory
3
+ require_relative 'dsl_factory/version'
4
+ require_relative 'dsl_factory/builder'
5
+ require_relative 'dsl_factory/wrapper'
6
+
7
+ attr_reader :builders, :default_builder
8
+
9
+ def initialize(&block)
10
+ @builders = {}
11
+ instance_exec(&block) if block
12
+ end
13
+
14
+ def configure_builder(name, *modules, &block)
15
+ (@builders[name.to_sym] ||= Class.new(Builder))
16
+ .tap { |builder| modules.flatten.each { |mod| builder.class_exec { include mod }}}
17
+ .tap { |builder| builder.class_exec(&block) if block }
18
+
19
+ @default_builder = @builders.keys.first if @builders.size == 1
20
+ self
21
+ end
22
+
23
+ def build(thing, **options, &block)
24
+ builder_name = options[:builder] || @default_builder
25
+ builder_class = builders[builder_name] || raise("Unknown builder #{builder_name}")
26
+
27
+ Wrapper.new(builder_name, builder_class.new(self, thing, **options))
28
+ .tap { |x| x.instance_exec(&block) if block }
29
+ end
30
+
31
+ def branch(&block)
32
+ self.class.new
33
+ .tap { |x| builders.each { |k, v| x.builders[k] = Class.new(v) } }
34
+ .tap { |x| x.default_builder = default_builder }
35
+ .tap { |x| x.instance_exec(&block) if block }
36
+
37
+ end
38
+
39
+ protected
40
+
41
+ attr_writer :default_builder
42
+ end
43
+ end
data/pair_kit_dsl_factory.gemspec ADDED
@@ -0,0 +1,41 @@
1
+ require File.expand_path('lib/pair_kit/dsl_factory/version', __dir__)
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = 'pair-kit-dsl-factory'
5
+ spec.version = PairKit::DslFactory::VERSION
6
+ spec.authors = ['Dmitry Sharkov']
7
+ spec.email = %w(dmitry.sharkov@gmail.com dmitry.sharkov@pairfinance.com)
8
+ spec.summary = 'DSL factory'
9
+ spec.description = 'This gem allows build custom DSL'
10
+ spec.homepage = 'https://github.com/pair-finance/pair_kit_dsl_factory'
11
+ spec.license = 'MIT'
12
+ spec.platform = Gem::Platform::RUBY
13
+ spec.required_ruby_version = '>= 2.5.0'
14
+
15
+ spec.metadata['homepage_uri'] = spec.homepage
16
+ spec.metadata['source_code_uri'] = spec.homepage
17
+ spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
18
+ # spec.metadata['rubygems_mfa_required'] = 'true'
19
+
20
+ spec.files = Dir['README.md', 'LICENSE',
21
+ 'CHANGELOG.md', 'lib/**/*.rb',
22
+ 'lib/**/*.rake',
23
+ 'pair_kit_dsl_factory.gemspec', '.github/*.md',
24
+ 'Gemfile', 'Rakefile']
25
+
26
+ spec.extra_rdoc_files = ['README.md']
27
+
28
+ spec.add_development_dependency 'pry-byebug', '~> 0.13'
29
+ spec.add_development_dependency 'pry-alias', '>= 0.0.1'
30
+
31
+ spec.add_development_dependency 'rubocop', '~> 1.64'
32
+ spec.add_development_dependency 'rubocop-performance', '~> 1.20'
33
+ spec.add_development_dependency 'rubocop-rspec', '~> 3.0'
34
+
35
+ spec.add_development_dependency 'rake', '~> 13.0'
36
+ spec.add_development_dependency 'rspec', '~> 3.4'
37
+ spec.add_development_dependency 'rspec-rails', '~> 3.4', '>= 3.4.2'
38
+
39
+ spec.add_development_dependency 'simplecov', '~> 0.19'
40
+ spec.add_development_dependency 'simplecov-cobertura', '~> 2.1'
41
+ end
metadata ADDED
@@ -0,0 +1,204 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: pair-kit-dsl-factory
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Dmitry Sharkov
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2024-07-03 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: pry-byebug
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: pry-alias
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 0.0.1
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 0.0.1
41
+ - !ruby/object:Gem::Dependency
42
+ name: rubocop
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.64'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.64'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rubocop-performance
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.20'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.20'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop-rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rake
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '13.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '13.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rspec
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '3.4'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '3.4'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rspec-rails
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '3.4'
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: 3.4.2
121
+ type: :development
122
+ prerelease: false
123
+ version_requirements: !ruby/object:Gem::Requirement
124
+ requirements:
125
+ - - "~>"
126
+ - !ruby/object:Gem::Version
127
+ version: '3.4'
128
+ - - ">="
129
+ - !ruby/object:Gem::Version
130
+ version: 3.4.2
131
+ - !ruby/object:Gem::Dependency
132
+ name: simplecov
133
+ requirement: !ruby/object:Gem::Requirement
134
+ requirements:
135
+ - - "~>"
136
+ - !ruby/object:Gem::Version
137
+ version: '0.19'
138
+ type: :development
139
+ prerelease: false
140
+ version_requirements: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - "~>"
143
+ - !ruby/object:Gem::Version
144
+ version: '0.19'
145
+ - !ruby/object:Gem::Dependency
146
+ name: simplecov-cobertura
147
+ requirement: !ruby/object:Gem::Requirement
148
+ requirements:
149
+ - - "~>"
150
+ - !ruby/object:Gem::Version
151
+ version: '2.1'
152
+ type: :development
153
+ prerelease: false
154
+ version_requirements: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - "~>"
157
+ - !ruby/object:Gem::Version
158
+ version: '2.1'
159
+ description: This gem allows build custom DSL
160
+ email:
161
+ - dmitry.sharkov@gmail.com
162
+ - dmitry.sharkov@pairfinance.com
163
+ executables: []
164
+ extensions: []
165
+ extra_rdoc_files:
166
+ - README.md
167
+ files:
168
+ - CHANGELOG.md
169
+ - Gemfile
170
+ - LICENSE
171
+ - README.md
172
+ - Rakefile
173
+ - lib/pair_kit/dsl_factory.rb
174
+ - lib/pair_kit/dsl_factory/builder.rb
175
+ - lib/pair_kit/dsl_factory/version.rb
176
+ - lib/pair_kit/dsl_factory/wrapper.rb
177
+ - pair_kit_dsl_factory.gemspec
178
+ homepage: https://github.com/pair-finance/pair_kit_dsl_factory
179
+ licenses:
180
+ - MIT
181
+ metadata:
182
+ homepage_uri: https://github.com/pair-finance/pair_kit_dsl_factory
183
+ source_code_uri: https://github.com/pair-finance/pair_kit_dsl_factory
184
+ changelog_uri: https://github.com/pair-finance/pair_kit_dsl_factory/blob/main/CHANGELOG.md
185
+ post_install_message:
186
+ rdoc_options: []
187
+ require_paths:
188
+ - lib
189
+ required_ruby_version: !ruby/object:Gem::Requirement
190
+ requirements:
191
+ - - ">="
192
+ - !ruby/object:Gem::Version
193
+ version: 2.5.0
194
+ required_rubygems_version: !ruby/object:Gem::Requirement
195
+ requirements:
196
+ - - ">="
197
+ - !ruby/object:Gem::Version
198
+ version: '0'
199
+ requirements: []
200
+ rubygems_version: 3.1.6
201
+ signing_key:
202
+ specification_version: 4
203
+ summary: DSL factory
204
+ test_files: []