pair-kit-miniflector 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 (10) 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 +135 -0
  6. data/Rakefile +22 -0
  7. data/lib/pair_kit/miniflector/version.rb +7 -0
  8. data/lib/pair_kit/miniflector.rb +35 -0
  9. data/pair_kit_miniflector.gemspec +41 -0
  10. metadata +215 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: feed91b13929c4bb5faabc3e96509a00f93dcc95047844bc91f536442300f2ad
4
+ data.tar.gz: 5401c671899856fd44013041431379983f600877396094e477c8a31866f24b4c
5
+ SHA512:
6
+ metadata.gz: '04628f5e1f5f01ab193774b8889ea668403e24271a2a55430cecec970b48e610c058828de5edaf5ac4bb1f90daefe3a88451c3526d9b6a6e7c1ff5b3d5eac06f'
7
+ data.tar.gz: b9e0ec59d643bc3e6a0bc91b1f5e8c830b2f36c2b40bebfe570a2828456754bed46764a5175e7e1e05363474525628195cb225e644a60741235f54e2d6a31d62
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,135 @@
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
+ @dsl.(@subject, builder: :property, name: name, &block)
84
+ end
85
+ end
86
+
87
+ configure_builder(:array, SchemaDsl) do
88
+ def item(&block)
89
+ @dsl.(@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
+ def required
101
+ (@subject[:required] ||= []) << @options[:name]
102
+ end
103
+
104
+ private
105
+
106
+ def _schema
107
+ @subject[:properties][@options[:name]]
108
+ end
109
+ end
110
+ end
111
+
112
+ class_attribute :json_schema
113
+
114
+ def self.draw_schema(&block)
115
+ self.json_schema ||= {}
116
+ JSON_SCHEMA_BUILDER.builder(json_schema).struct(&block)
117
+ end
118
+ end
119
+
120
+ ```
121
+
122
+ ### Step 3: Use your DSL
123
+
124
+ ```ruby
125
+ class User < ApplicationModel
126
+ draw_schema do
127
+ prop(:first_name).required.string
128
+ prop(:last_name).required.string
129
+ prop(:balance).required.number
130
+ prop(:tags).required.array.string
131
+ end
132
+ end
133
+ ```
134
+
135
+
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/miniflector/version.rb ADDED
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PairKit
4
+ module Miniflector
5
+ VERSION = '0.0.1'
6
+ end
7
+ end
data/lib/pair_kit/miniflector.rb ADDED
@@ -0,0 +1,35 @@
1
+ module PairKit
2
+ module Miniflector
3
+ class << self
4
+ def camel_case(str)
5
+ split(str).map.with_index { |x, i| i.positive? ? x.capitalize : x }.join
6
+ end
7
+
8
+ def snake_case(str)
9
+ split(str).join('_')
10
+ end
11
+
12
+ def pascal_case(str)
13
+ split(str).map(&:capitalize).join
14
+ end
15
+
16
+ def kebab_case(str)
17
+ split(str).join('-')
18
+ end
19
+
20
+ def screaming_snake_case(str)
21
+ split(str).map(&:upcase).join('_')
22
+ end
23
+
24
+ def screaming_kebab_case(str)
25
+ split(str).map(&:upcase).join('-')
26
+ end
27
+
28
+ SPLIT_RE = /(?=[A-Z][a-z]+)|[_\- ]/.freeze
29
+
30
+ def split(str)
31
+ str.to_s.split(SPLIT_RE).map(&:downcase).map { |x| x.empty? ? nil : x }.compact
32
+ end
33
+ end
34
+ end
35
+ end
data/pair_kit_miniflector.gemspec ADDED
@@ -0,0 +1,41 @@
1
+ require File.expand_path('lib/pair_kit/miniflector/version', __dir__)
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = 'pair-kit-miniflector'
5
+ spec.version = PairKit::Miniflector::VERSION
6
+ spec.authors = ['Dmitry Sharkov']
7
+ spec.email = %w(dmitry.sharkov@gmail.com dmitry.sharkov@pairfinance.com)
8
+ spec.summary = 'Minimalistic Inflector'
9
+ spec.description = 'This is minimalistic inflector. It allows Pair Kit to be an independent library'
10
+ spec.homepage = 'https://github.com/pair-finance/pair_kit_miniflector'
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_miniflector.gemspec', '.github/*.md',
24
+ 'Gemfile', 'Rakefile']
25
+
26
+ spec.extra_rdoc_files = ['README.md']
27
+
28
+ spec.add_development_dependency 'pry-byebug', '~> 3.10', '>= 3.10.1'
29
+ spec.add_development_dependency 'pry-alias', '~> 0.0', '>= 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,215 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: pair-kit-miniflector
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: '3.10'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 3.10.1
23
+ type: :development
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '3.10'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 3.10.1
33
+ - !ruby/object:Gem::Dependency
34
+ name: pry-alias
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '0.0'
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ version: 0.0.1
43
+ type: :development
44
+ prerelease: false
45
+ version_requirements: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - "~>"
48
+ - !ruby/object:Gem::Version
49
+ version: '0.0'
50
+ - - ">="
51
+ - !ruby/object:Gem::Version
52
+ version: 0.0.1
53
+ - !ruby/object:Gem::Dependency
54
+ name: rubocop
55
+ requirement: !ruby/object:Gem::Requirement
56
+ requirements:
57
+ - - "~>"
58
+ - !ruby/object:Gem::Version
59
+ version: '1.64'
60
+ type: :development
61
+ prerelease: false
62
+ version_requirements: !ruby/object:Gem::Requirement
63
+ requirements:
64
+ - - "~>"
65
+ - !ruby/object:Gem::Version
66
+ version: '1.64'
67
+ - !ruby/object:Gem::Dependency
68
+ name: rubocop-performance
69
+ requirement: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - "~>"
72
+ - !ruby/object:Gem::Version
73
+ version: '1.20'
74
+ type: :development
75
+ prerelease: false
76
+ version_requirements: !ruby/object:Gem::Requirement
77
+ requirements:
78
+ - - "~>"
79
+ - !ruby/object:Gem::Version
80
+ version: '1.20'
81
+ - !ruby/object:Gem::Dependency
82
+ name: rubocop-rspec
83
+ requirement: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - "~>"
86
+ - !ruby/object:Gem::Version
87
+ version: '3.0'
88
+ type: :development
89
+ prerelease: false
90
+ version_requirements: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - "~>"
93
+ - !ruby/object:Gem::Version
94
+ version: '3.0'
95
+ - !ruby/object:Gem::Dependency
96
+ name: rake
97
+ requirement: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - "~>"
100
+ - !ruby/object:Gem::Version
101
+ version: '13.0'
102
+ type: :development
103
+ prerelease: false
104
+ version_requirements: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - "~>"
107
+ - !ruby/object:Gem::Version
108
+ version: '13.0'
109
+ - !ruby/object:Gem::Dependency
110
+ name: rspec
111
+ requirement: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - "~>"
114
+ - !ruby/object:Gem::Version
115
+ version: '3.4'
116
+ type: :development
117
+ prerelease: false
118
+ version_requirements: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - "~>"
121
+ - !ruby/object:Gem::Version
122
+ version: '3.4'
123
+ - !ruby/object:Gem::Dependency
124
+ name: rspec-rails
125
+ requirement: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - "~>"
128
+ - !ruby/object:Gem::Version
129
+ version: '3.4'
130
+ - - ">="
131
+ - !ruby/object:Gem::Version
132
+ version: 3.4.2
133
+ type: :development
134
+ prerelease: false
135
+ version_requirements: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - "~>"
138
+ - !ruby/object:Gem::Version
139
+ version: '3.4'
140
+ - - ">="
141
+ - !ruby/object:Gem::Version
142
+ version: 3.4.2
143
+ - !ruby/object:Gem::Dependency
144
+ name: simplecov
145
+ requirement: !ruby/object:Gem::Requirement
146
+ requirements:
147
+ - - "~>"
148
+ - !ruby/object:Gem::Version
149
+ version: '0.19'
150
+ type: :development
151
+ prerelease: false
152
+ version_requirements: !ruby/object:Gem::Requirement
153
+ requirements:
154
+ - - "~>"
155
+ - !ruby/object:Gem::Version
156
+ version: '0.19'
157
+ - !ruby/object:Gem::Dependency
158
+ name: simplecov-cobertura
159
+ requirement: !ruby/object:Gem::Requirement
160
+ requirements:
161
+ - - "~>"
162
+ - !ruby/object:Gem::Version
163
+ version: '2.1'
164
+ type: :development
165
+ prerelease: false
166
+ version_requirements: !ruby/object:Gem::Requirement
167
+ requirements:
168
+ - - "~>"
169
+ - !ruby/object:Gem::Version
170
+ version: '2.1'
171
+ description: This is minimalistic inflector. It allows Pair Kit to be an independent
172
+ library
173
+ email:
174
+ - dmitry.sharkov@gmail.com
175
+ - dmitry.sharkov@pairfinance.com
176
+ executables: []
177
+ extensions: []
178
+ extra_rdoc_files:
179
+ - README.md
180
+ files:
181
+ - CHANGELOG.md
182
+ - Gemfile
183
+ - LICENSE
184
+ - README.md
185
+ - Rakefile
186
+ - lib/pair_kit/miniflector.rb
187
+ - lib/pair_kit/miniflector/version.rb
188
+ - pair_kit_miniflector.gemspec
189
+ homepage: https://github.com/pair-finance/pair_kit_miniflector
190
+ licenses:
191
+ - MIT
192
+ metadata:
193
+ homepage_uri: https://github.com/pair-finance/pair_kit_miniflector
194
+ source_code_uri: https://github.com/pair-finance/pair_kit_miniflector
195
+ changelog_uri: https://github.com/pair-finance/pair_kit_miniflector/blob/main/CHANGELOG.md
196
+ post_install_message:
197
+ rdoc_options: []
198
+ require_paths:
199
+ - lib
200
+ required_ruby_version: !ruby/object:Gem::Requirement
201
+ requirements:
202
+ - - ">="
203
+ - !ruby/object:Gem::Version
204
+ version: 2.5.0
205
+ required_rubygems_version: !ruby/object:Gem::Requirement
206
+ requirements:
207
+ - - ">="
208
+ - !ruby/object:Gem::Version
209
+ version: '0'
210
+ requirements: []
211
+ rubygems_version: 3.1.6
212
+ signing_key:
213
+ specification_version: 4
214
+ summary: Minimalistic Inflector
215
+ test_files: []