settis 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +4 -0
- data/.rspec +1 -0
- data/.rvmrc +1 -0
- data/Gemfile +2 -0
- data/LICENSE +202 -0
- data/NOTICE +2 -0
- data/Rakefile +22 -0
- data/lib/settis.rb +37 -0
- data/lib/settis/container.rb +61 -0
- data/lib/settis/settings.rb +23 -0
- data/lib/settis/settings/boolean.rb +29 -0
- data/lib/settis/settings/integer.rb +25 -0
- data/lib/settis/settings/scalar.rb +70 -0
- data/lib/settis/version.rb +19 -0
- data/settis.gemspec +23 -0
- data/spec/settis/container_spec.rb +57 -0
- data/spec/settis/settings/boolean_spec.rb +43 -0
- data/spec/settis/settings/integer_spec.rb +34 -0
- data/spec/settis/settings/scalar_spec.rb +84 -0
- data/spec/settis_spec.rb +39 -0
- data/spec/spec_helper.rb +21 -0
- metadata +109 -0
data/.gitignore
ADDED
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color --format=documentation
|
data/.rvmrc
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
rvm 1.9.2@settis --create
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/NOTICE
ADDED
data/Rakefile
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'bundler/gem_tasks'
|
18
|
+
require 'rspec/core/rake_task'
|
19
|
+
|
20
|
+
task :default => :spec
|
21
|
+
|
22
|
+
RSpec::Core::RakeTask.new
|
data/lib/settis.rb
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'redis/namespace'
|
18
|
+
|
19
|
+
require 'settis/container'
|
20
|
+
require 'settis/settings'
|
21
|
+
require 'settis/version'
|
22
|
+
|
23
|
+
module Settis
|
24
|
+
class << self
|
25
|
+
# Gets the global Redis client used by Settis.
|
26
|
+
def redis
|
27
|
+
@redis ||= Redis.new
|
28
|
+
end
|
29
|
+
|
30
|
+
# Sets the global Redis client used by Settis.
|
31
|
+
# @param value Should be or act like `Redis` from the `redis` gem.
|
32
|
+
def redis=(value)
|
33
|
+
@redis.disconnect unless @redis.nil? or !@redis.connected?
|
34
|
+
@redis = value
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,61 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
module Settis
|
18
|
+
module Container
|
19
|
+
# @private
|
20
|
+
def redis
|
21
|
+
@redis ||= Redis::Namespace.new(root, :redis => Settis.redis)
|
22
|
+
end
|
23
|
+
|
24
|
+
# @overload root(value)
|
25
|
+
# Sets the root namespace prefix to be added before all Redis key names.
|
26
|
+
# @param [String] value The prefix to add.
|
27
|
+
# @overload root
|
28
|
+
# Gets the root namespace prefix to be added before all Redis key names.
|
29
|
+
def root(value = nil)
|
30
|
+
if value.nil?
|
31
|
+
@root ||= 'settings'
|
32
|
+
else
|
33
|
+
@root = value
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
# Defines a new setting.
|
38
|
+
#
|
39
|
+
# @param [Symbol, String] name The name of the setting.
|
40
|
+
# @param [Symbol, Class] type The type of the setting.
|
41
|
+
# @param [Hash] options
|
42
|
+
# @option options :default The default value of the setting. Not supported for lists, sets, and hashes.
|
43
|
+
def setting(name, type, options = {})
|
44
|
+
@settings ||= {}
|
45
|
+
|
46
|
+
name = name.to_s
|
47
|
+
|
48
|
+
raise ArgumentError, "The setting '#{name}' already exists." if @settings.key?(name)
|
49
|
+
|
50
|
+
klass = case type
|
51
|
+
when :string then Settings::Scalar
|
52
|
+
when :integer then Settings::Integer
|
53
|
+
when :boolean then Settings::Boolean
|
54
|
+
else
|
55
|
+
raise ArgumentError, "Unknown type '#{type}'."
|
56
|
+
end
|
57
|
+
|
58
|
+
@settings[name] = klass.new(name, self, options)
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
module Settis
|
18
|
+
module Settings
|
19
|
+
autoload :Scalar, 'settis/settings/scalar'
|
20
|
+
autoload :Integer, 'settis/settings/integer'
|
21
|
+
autoload :Boolean, 'settis/settings/boolean'
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
module Settis
|
18
|
+
module Settings
|
19
|
+
class Boolean < Scalar
|
20
|
+
def serialize(value)
|
21
|
+
value ? '1' : '0'
|
22
|
+
end
|
23
|
+
|
24
|
+
def deserialize(value)
|
25
|
+
value != '0'
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
module Settis
|
18
|
+
module Settings
|
19
|
+
class Integer < Scalar
|
20
|
+
def deserialize(value)
|
21
|
+
value.to_i
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,70 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
module Settis
|
18
|
+
module Settings
|
19
|
+
class Scalar
|
20
|
+
attr_reader :name
|
21
|
+
|
22
|
+
def initialize(name, klass, options = {})
|
23
|
+
@name = name
|
24
|
+
@class = klass
|
25
|
+
@default = options[:default]
|
26
|
+
|
27
|
+
define_methods
|
28
|
+
end
|
29
|
+
|
30
|
+
def get
|
31
|
+
value = @class.redis.get(@name)
|
32
|
+
|
33
|
+
if value.nil?
|
34
|
+
@default
|
35
|
+
else
|
36
|
+
deserialize(value.to_s)
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
def set(value)
|
41
|
+
if value.nil?
|
42
|
+
@class.redis.del(@name)
|
43
|
+
else
|
44
|
+
@class.redis.set(@name, serialize(value))
|
45
|
+
end
|
46
|
+
|
47
|
+
value
|
48
|
+
end
|
49
|
+
|
50
|
+
protected
|
51
|
+
|
52
|
+
def serialize(value) ; value.to_s ; end
|
53
|
+
def deserialize(value) ; value ; end
|
54
|
+
|
55
|
+
def define_methods
|
56
|
+
setting = self
|
57
|
+
|
58
|
+
class << @class ; self ; end.instance_eval do
|
59
|
+
define_method setting.name do
|
60
|
+
setting.get
|
61
|
+
end
|
62
|
+
|
63
|
+
define_method :"#{setting.name}=" do |value|
|
64
|
+
setting.set(value)
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
module Settis
|
18
|
+
VERSION = '0.1.0'
|
19
|
+
end
|
data/settis.gemspec
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
$:.push(File.expand_path('../lib', __FILE__))
|
4
|
+
require 'settis/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = 'settis'
|
8
|
+
s.version = Settis::VERSION
|
9
|
+
s.authors = ['Brennan Frydl']
|
10
|
+
s.email = ['me@bfrydl.com']
|
11
|
+
s.homepage = 'http://github.com/bfrydl/settis'
|
12
|
+
s.summary = %q{Redis-powered settings storage for web applications.}
|
13
|
+
s.description = %q{Settis provides simple settings storage for web applications using Redis. It is intended as a replacement for single-row tables and other relational database solutions to the same problem.}
|
14
|
+
|
15
|
+
s.files = `git ls-files`.split("\n")
|
16
|
+
s.test_files = `git ls-files -- spec/*`.split("\n")
|
17
|
+
s.require_paths = ['lib']
|
18
|
+
|
19
|
+
s.add_dependency 'redis-namespace'
|
20
|
+
|
21
|
+
s.add_development_dependency 'rspec'
|
22
|
+
s.add_development_dependency 'rr'
|
23
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'spec_helper'
|
18
|
+
|
19
|
+
describe Settis::Container do
|
20
|
+
before :each do
|
21
|
+
@class = Class.new do
|
22
|
+
extend Settis::Container
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
describe '#root' do
|
27
|
+
it 'stores the root namespace prefix for Redis keys' do
|
28
|
+
@class.root.should == 'settings'
|
29
|
+
@class.root 'test'
|
30
|
+
@class.root.should == 'test'
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
describe '#redis' do
|
35
|
+
it 'returns a Redis::Namespace specific to the container' do
|
36
|
+
stub(@class).root { 'configuration' }
|
37
|
+
|
38
|
+
@class.redis.should be_a(Redis::Namespace)
|
39
|
+
@class.redis.namespace.should == 'configuration'
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
describe '#setting' do
|
44
|
+
it 'defines a new setting' do
|
45
|
+
mock(Settis::Settings::Scalar).new('title', @class, :default => 'Hello World')
|
46
|
+
|
47
|
+
@class.setting :title, :string, :default => 'Hello World'
|
48
|
+
end
|
49
|
+
|
50
|
+
it 'does not allow duplicate names' do
|
51
|
+
stub(Settis::Settings::Scalar).new.once
|
52
|
+
@class.setting :title, :string
|
53
|
+
|
54
|
+
expect { @class.setting :title, :integer }.to raise_error(ArgumentError)
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'spec_helper'
|
18
|
+
|
19
|
+
describe Settis::Settings::Boolean do
|
20
|
+
before :each do
|
21
|
+
any_instance_of(Settis::Settings::Boolean) do |boolean|
|
22
|
+
stub(boolean).define_methods
|
23
|
+
end
|
24
|
+
|
25
|
+
@boolean = Settis::Settings::Boolean.new('test', Object)
|
26
|
+
end
|
27
|
+
|
28
|
+
describe '#serialize' do
|
29
|
+
it 'converts the value to either 1 or 0' do
|
30
|
+
@boolean.send(:serialize, false).should == '0'
|
31
|
+
@boolean.send(:serialize, true).should == '1'
|
32
|
+
@boolean.send(:serialize, Object.new).should == '1'
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
describe '#deserialize' do
|
37
|
+
it 'converts the value to true or false' do
|
38
|
+
@boolean.send(:deserialize, '0').should be_false
|
39
|
+
@boolean.send(:deserialize, '1').should be_true
|
40
|
+
@boolean.send(:deserialize, 'HI').should be_true
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'spec_helper'
|
18
|
+
|
19
|
+
describe Settis::Settings::Integer do
|
20
|
+
before :each do
|
21
|
+
any_instance_of(Settis::Settings::Integer) do |integer|
|
22
|
+
stub(integer).define_methods
|
23
|
+
end
|
24
|
+
|
25
|
+
@integer = Settis::Settings::Integer.new('test', Object)
|
26
|
+
end
|
27
|
+
|
28
|
+
describe '#deserialize' do
|
29
|
+
it 'converts the value to an integer' do
|
30
|
+
@integer.send(:deserialize, '34').should == 34
|
31
|
+
@integer.send(:deserialize, 'not an int').should == 0
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,84 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'spec_helper'
|
18
|
+
|
19
|
+
describe Settis::Settings::Scalar do
|
20
|
+
describe '#new' do
|
21
|
+
before { @class = Class.new }
|
22
|
+
|
23
|
+
it 'adds accessor methods to the target class' do
|
24
|
+
scalar = Settis::Settings::Scalar.new('test', @class)
|
25
|
+
|
26
|
+
@class.should respond_to(:test)
|
27
|
+
@class.should respond_to(:test=)
|
28
|
+
|
29
|
+
mock(scalar).get { :get }
|
30
|
+
mock(scalar).set(:value)
|
31
|
+
|
32
|
+
@class.test.should == :get
|
33
|
+
@class.test = :value
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
describe '#get' do
|
38
|
+
before do
|
39
|
+
any_instance_of(Settis::Settings::Scalar) do |scalar|
|
40
|
+
stub(scalar).define_methods
|
41
|
+
end
|
42
|
+
|
43
|
+
@class = Object.new
|
44
|
+
@scalar = Settis::Settings::Scalar.new('test', @class, :default => 'default')
|
45
|
+
end
|
46
|
+
|
47
|
+
it 'retrieves and deserializes the value from Redis' do
|
48
|
+
stub(@class).redis.stub!.get('test') { 'value' }
|
49
|
+
stub(@scalar).deserialize('value') { 'deserialized' }
|
50
|
+
|
51
|
+
@scalar.get.should == 'deserialized'
|
52
|
+
end
|
53
|
+
|
54
|
+
it 'returns the default value if the key does not exist' do
|
55
|
+
stub(@class).redis.stub!.get('test')
|
56
|
+
|
57
|
+
@scalar.get.should == 'default'
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
describe '#set' do
|
62
|
+
before do
|
63
|
+
any_instance_of(Settis::Settings::Scalar) do |scalar|
|
64
|
+
stub(scalar).define_methods
|
65
|
+
end
|
66
|
+
|
67
|
+
@class = Object.new
|
68
|
+
@scalar = Settis::Settings::Scalar.new('test', @class)
|
69
|
+
end
|
70
|
+
|
71
|
+
it 'serializes and stores the value in Redis' do
|
72
|
+
stub(@scalar).serialize('value') { 'serialized' }
|
73
|
+
mock(@class).redis.mock!.set('test', 'serialized')
|
74
|
+
|
75
|
+
@scalar.set('value')
|
76
|
+
end
|
77
|
+
|
78
|
+
it 'deletes the key if set to nil' do
|
79
|
+
mock(@class).redis.mock!.del('test')
|
80
|
+
|
81
|
+
@scalar.set(nil)
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
data/spec/settis_spec.rb
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'spec_helper'
|
18
|
+
|
19
|
+
describe Settis do
|
20
|
+
context '#redis' do
|
21
|
+
after do
|
22
|
+
Settis.class_eval { @redis = nil }
|
23
|
+
end
|
24
|
+
|
25
|
+
it 'stores a global Redis client connection' do
|
26
|
+
dont_allow(Redis).new
|
27
|
+
|
28
|
+
Settis.redis = :test
|
29
|
+
Settis.redis.should == :test
|
30
|
+
end
|
31
|
+
|
32
|
+
it 'by default creates a new Redis instance' do
|
33
|
+
mock(Redis).new.once { :redis_client }
|
34
|
+
|
35
|
+
Settis.redis.should == :redis_client
|
36
|
+
Settis.redis
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
#
|
3
|
+
# Copyright 2011 Brennan Frydl (http://bfrydl.com/)
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'settis'
|
18
|
+
|
19
|
+
RSpec.configure do |config|
|
20
|
+
config.mock_framework = :rr
|
21
|
+
end
|
metadata
ADDED
@@ -0,0 +1,109 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: settis
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Brennan Frydl
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2011-08-02 00:00:00.000000000 -04:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: redis-namespace
|
17
|
+
requirement: &18645380 !ruby/object:Gem::Requirement
|
18
|
+
none: false
|
19
|
+
requirements:
|
20
|
+
- - ! '>='
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: '0'
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: *18645380
|
26
|
+
- !ruby/object:Gem::Dependency
|
27
|
+
name: rspec
|
28
|
+
requirement: &18644940 !ruby/object:Gem::Requirement
|
29
|
+
none: false
|
30
|
+
requirements:
|
31
|
+
- - ! '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: *18644940
|
37
|
+
- !ruby/object:Gem::Dependency
|
38
|
+
name: rr
|
39
|
+
requirement: &18644520 !ruby/object:Gem::Requirement
|
40
|
+
none: false
|
41
|
+
requirements:
|
42
|
+
- - ! '>='
|
43
|
+
- !ruby/object:Gem::Version
|
44
|
+
version: '0'
|
45
|
+
type: :development
|
46
|
+
prerelease: false
|
47
|
+
version_requirements: *18644520
|
48
|
+
description: Settis provides simple settings storage for web applications using Redis.
|
49
|
+
It is intended as a replacement for single-row tables and other relational database
|
50
|
+
solutions to the same problem.
|
51
|
+
email:
|
52
|
+
- me@bfrydl.com
|
53
|
+
executables: []
|
54
|
+
extensions: []
|
55
|
+
extra_rdoc_files: []
|
56
|
+
files:
|
57
|
+
- .gitignore
|
58
|
+
- .rspec
|
59
|
+
- .rvmrc
|
60
|
+
- Gemfile
|
61
|
+
- LICENSE
|
62
|
+
- NOTICE
|
63
|
+
- Rakefile
|
64
|
+
- lib/settis.rb
|
65
|
+
- lib/settis/container.rb
|
66
|
+
- lib/settis/settings.rb
|
67
|
+
- lib/settis/settings/boolean.rb
|
68
|
+
- lib/settis/settings/integer.rb
|
69
|
+
- lib/settis/settings/scalar.rb
|
70
|
+
- lib/settis/version.rb
|
71
|
+
- settis.gemspec
|
72
|
+
- spec/settis/container_spec.rb
|
73
|
+
- spec/settis/settings/boolean_spec.rb
|
74
|
+
- spec/settis/settings/integer_spec.rb
|
75
|
+
- spec/settis/settings/scalar_spec.rb
|
76
|
+
- spec/settis_spec.rb
|
77
|
+
- spec/spec_helper.rb
|
78
|
+
has_rdoc: true
|
79
|
+
homepage: http://github.com/bfrydl/settis
|
80
|
+
licenses: []
|
81
|
+
post_install_message:
|
82
|
+
rdoc_options: []
|
83
|
+
require_paths:
|
84
|
+
- lib
|
85
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
86
|
+
none: false
|
87
|
+
requirements:
|
88
|
+
- - ! '>='
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
92
|
+
none: false
|
93
|
+
requirements:
|
94
|
+
- - ! '>='
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
requirements: []
|
98
|
+
rubyforge_project:
|
99
|
+
rubygems_version: 1.6.2
|
100
|
+
signing_key:
|
101
|
+
specification_version: 3
|
102
|
+
summary: Redis-powered settings storage for web applications.
|
103
|
+
test_files:
|
104
|
+
- spec/settis/container_spec.rb
|
105
|
+
- spec/settis/settings/boolean_spec.rb
|
106
|
+
- spec/settis/settings/integer_spec.rb
|
107
|
+
- spec/settis/settings/scalar_spec.rb
|
108
|
+
- spec/settis_spec.rb
|
109
|
+
- spec/spec_helper.rb
|