subflag-rails 0.1.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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +21 -0
- data/LICENSE.txt +21 -0
- data/README.md +245 -0
- data/lib/generators/subflag/install_generator.rb +56 -0
- data/lib/generators/subflag/templates/initializer.rb +28 -0
- data/lib/subflag/rails/client.rb +143 -0
- data/lib/subflag/rails/configuration.rb +83 -0
- data/lib/subflag/rails/context_builder.rb +62 -0
- data/lib/subflag/rails/evaluation_result.rb +97 -0
- data/lib/subflag/rails/flag_accessor.rb +129 -0
- data/lib/subflag/rails/helpers.rb +108 -0
- data/lib/subflag/rails/railtie.rb +45 -0
- data/lib/subflag/rails/request_cache.rb +80 -0
- data/lib/subflag/rails/test_helpers.rb +149 -0
- data/lib/subflag/rails/version.rb +7 -0
- data/lib/subflag/rails.rb +96 -0
- data/lib/subflag-rails.rb +3 -0
- metadata +221 -0
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "openfeature/sdk"
|
|
4
|
+
require "subflag"
|
|
5
|
+
|
|
6
|
+
require_relative "rails/version"
|
|
7
|
+
require_relative "rails/configuration"
|
|
8
|
+
require_relative "rails/context_builder"
|
|
9
|
+
require_relative "rails/evaluation_result"
|
|
10
|
+
require_relative "rails/request_cache"
|
|
11
|
+
require_relative "rails/client"
|
|
12
|
+
require_relative "rails/flag_accessor"
|
|
13
|
+
require_relative "rails/helpers"
|
|
14
|
+
require_relative "rails/railtie" if defined?(Rails::Railtie)
|
|
15
|
+
|
|
16
|
+
# Test helpers are loaded separately: require "subflag/rails/test_helpers"
|
|
17
|
+
|
|
18
|
+
module Subflag
|
|
19
|
+
module Rails
|
|
20
|
+
class << self
|
|
21
|
+
# Access the configuration
|
|
22
|
+
#
|
|
23
|
+
# @return [Configuration]
|
|
24
|
+
def configuration
|
|
25
|
+
@configuration ||= Configuration.new
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# Configure Subflag for Rails
|
|
29
|
+
#
|
|
30
|
+
# @example
|
|
31
|
+
# Subflag::Rails.configure do |config|
|
|
32
|
+
# config.api_key = Rails.application.credentials.subflag_api_key
|
|
33
|
+
# config.user_context do |user|
|
|
34
|
+
# { targeting_key: user.id.to_s, email: user.email, plan: user.plan }
|
|
35
|
+
# end
|
|
36
|
+
# end
|
|
37
|
+
#
|
|
38
|
+
# @yield [Configuration]
|
|
39
|
+
def configure
|
|
40
|
+
yield(configuration)
|
|
41
|
+
setup_provider
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# Access the client for flag evaluation
|
|
45
|
+
#
|
|
46
|
+
# @return [Client]
|
|
47
|
+
def client
|
|
48
|
+
@client ||= Client.new
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Reset configuration (primarily for testing)
|
|
52
|
+
def reset!
|
|
53
|
+
@configuration = Configuration.new
|
|
54
|
+
@client = nil
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
private
|
|
58
|
+
|
|
59
|
+
def setup_provider
|
|
60
|
+
return unless configuration.api_key
|
|
61
|
+
|
|
62
|
+
provider = ::Subflag::OpenFeature::Provider.new(
|
|
63
|
+
api_key: configuration.api_key,
|
|
64
|
+
api_url: configuration.api_url
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
OpenFeature::SDK.configure do |config|
|
|
68
|
+
config.set_provider(provider)
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Top-level convenience method for flag access
|
|
75
|
+
class << self
|
|
76
|
+
# Get a flag accessor for evaluating flags
|
|
77
|
+
#
|
|
78
|
+
# @param user [Object, nil] The user object for targeting
|
|
79
|
+
# @param context [Hash, nil] Additional context attributes
|
|
80
|
+
# @return [FlagAccessor] A flag accessor with method_missing DSL
|
|
81
|
+
#
|
|
82
|
+
# @example Basic usage
|
|
83
|
+
# Subflag.flags.new_checkout?(default: false)
|
|
84
|
+
# Subflag.flags.homepage_headline(default: "Welcome")
|
|
85
|
+
#
|
|
86
|
+
# @example With user targeting
|
|
87
|
+
# Subflag.flags(user: current_user).max_projects(default: 3)
|
|
88
|
+
#
|
|
89
|
+
# @example Bracket access for exact flag names
|
|
90
|
+
# Subflag.flags["my-exact-flag", default: "value"]
|
|
91
|
+
#
|
|
92
|
+
def flags(user: nil, context: nil)
|
|
93
|
+
Rails::FlagAccessor.new(user: user, context: context)
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: subflag-rails
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Subflag
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2025-11-30 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: subflag-openfeature-provider
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '0.1'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '0.1'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: railties
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - ">="
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '6.1'
|
|
34
|
+
type: :runtime
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - ">="
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '6.1'
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: actionview
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - ">="
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '6.1'
|
|
48
|
+
type: :runtime
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - ">="
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '6.1'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: bundler
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '2.0'
|
|
62
|
+
type: :development
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '2.0'
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: rake
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '13.0'
|
|
76
|
+
type: :development
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '13.0'
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: rspec
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '3.12'
|
|
90
|
+
type: :development
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: '3.12'
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: rspec-rails
|
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - "~>"
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: '6.0'
|
|
104
|
+
type: :development
|
|
105
|
+
prerelease: false
|
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
+
requirements:
|
|
108
|
+
- - "~>"
|
|
109
|
+
- !ruby/object:Gem::Version
|
|
110
|
+
version: '6.0'
|
|
111
|
+
- !ruby/object:Gem::Dependency
|
|
112
|
+
name: rubocop
|
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
|
114
|
+
requirements:
|
|
115
|
+
- - "~>"
|
|
116
|
+
- !ruby/object:Gem::Version
|
|
117
|
+
version: '1.50'
|
|
118
|
+
type: :development
|
|
119
|
+
prerelease: false
|
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
121
|
+
requirements:
|
|
122
|
+
- - "~>"
|
|
123
|
+
- !ruby/object:Gem::Version
|
|
124
|
+
version: '1.50'
|
|
125
|
+
- !ruby/object:Gem::Dependency
|
|
126
|
+
name: rubocop-rails
|
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
|
128
|
+
requirements:
|
|
129
|
+
- - "~>"
|
|
130
|
+
- !ruby/object:Gem::Version
|
|
131
|
+
version: '2.19'
|
|
132
|
+
type: :development
|
|
133
|
+
prerelease: false
|
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
135
|
+
requirements:
|
|
136
|
+
- - "~>"
|
|
137
|
+
- !ruby/object:Gem::Version
|
|
138
|
+
version: '2.19'
|
|
139
|
+
- !ruby/object:Gem::Dependency
|
|
140
|
+
name: webmock
|
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
|
142
|
+
requirements:
|
|
143
|
+
- - "~>"
|
|
144
|
+
- !ruby/object:Gem::Version
|
|
145
|
+
version: '3.18'
|
|
146
|
+
type: :development
|
|
147
|
+
prerelease: false
|
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
149
|
+
requirements:
|
|
150
|
+
- - "~>"
|
|
151
|
+
- !ruby/object:Gem::Version
|
|
152
|
+
version: '3.18'
|
|
153
|
+
- !ruby/object:Gem::Dependency
|
|
154
|
+
name: rails
|
|
155
|
+
requirement: !ruby/object:Gem::Requirement
|
|
156
|
+
requirements:
|
|
157
|
+
- - ">="
|
|
158
|
+
- !ruby/object:Gem::Version
|
|
159
|
+
version: '6.1'
|
|
160
|
+
type: :development
|
|
161
|
+
prerelease: false
|
|
162
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
163
|
+
requirements:
|
|
164
|
+
- - ">="
|
|
165
|
+
- !ruby/object:Gem::Version
|
|
166
|
+
version: '6.1'
|
|
167
|
+
description: Rails integration for Subflag feature flags. Get typed values (boolean,
|
|
168
|
+
string, integer, double, object) with user targeting. Includes generators, view
|
|
169
|
+
helpers, and ActiveRecord context integration.
|
|
170
|
+
email:
|
|
171
|
+
- support@subflag.com
|
|
172
|
+
executables: []
|
|
173
|
+
extensions: []
|
|
174
|
+
extra_rdoc_files: []
|
|
175
|
+
files:
|
|
176
|
+
- CHANGELOG.md
|
|
177
|
+
- LICENSE.txt
|
|
178
|
+
- README.md
|
|
179
|
+
- lib/generators/subflag/install_generator.rb
|
|
180
|
+
- lib/generators/subflag/templates/initializer.rb
|
|
181
|
+
- lib/subflag-rails.rb
|
|
182
|
+
- lib/subflag/rails.rb
|
|
183
|
+
- lib/subflag/rails/client.rb
|
|
184
|
+
- lib/subflag/rails/configuration.rb
|
|
185
|
+
- lib/subflag/rails/context_builder.rb
|
|
186
|
+
- lib/subflag/rails/evaluation_result.rb
|
|
187
|
+
- lib/subflag/rails/flag_accessor.rb
|
|
188
|
+
- lib/subflag/rails/helpers.rb
|
|
189
|
+
- lib/subflag/rails/railtie.rb
|
|
190
|
+
- lib/subflag/rails/request_cache.rb
|
|
191
|
+
- lib/subflag/rails/test_helpers.rb
|
|
192
|
+
- lib/subflag/rails/version.rb
|
|
193
|
+
homepage: https://subflag.com
|
|
194
|
+
licenses:
|
|
195
|
+
- MIT
|
|
196
|
+
metadata:
|
|
197
|
+
homepage_uri: https://subflag.com
|
|
198
|
+
source_code_uri: https://github.com/subflag/sdk
|
|
199
|
+
changelog_uri: https://github.com/subflag/sdk/blob/main/packages/subflag-rails/CHANGELOG.md
|
|
200
|
+
documentation_uri: https://subflag.com/docs/ruby
|
|
201
|
+
rubygems_mfa_required: 'true'
|
|
202
|
+
post_install_message:
|
|
203
|
+
rdoc_options: []
|
|
204
|
+
require_paths:
|
|
205
|
+
- lib
|
|
206
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
207
|
+
requirements:
|
|
208
|
+
- - ">="
|
|
209
|
+
- !ruby/object:Gem::Version
|
|
210
|
+
version: 3.1.0
|
|
211
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
212
|
+
requirements:
|
|
213
|
+
- - ">="
|
|
214
|
+
- !ruby/object:Gem::Version
|
|
215
|
+
version: '0'
|
|
216
|
+
requirements: []
|
|
217
|
+
rubygems_version: 3.5.22
|
|
218
|
+
signing_key:
|
|
219
|
+
specification_version: 4
|
|
220
|
+
summary: Typed feature flags for Rails - booleans, strings, numbers, and JSON
|
|
221
|
+
test_files: []
|