ark 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.
@@ -0,0 +1,18 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ data.git
data/.rvmrc ADDED
@@ -0,0 +1 @@
1
+ rvm 1.9.2@ark_dev --create
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'http://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in ark.gemspec
4
+ gemspec
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,119 @@
1
+ # Ark
2
+
3
+ Ark is a breakout of the ideas around the persistence mechanism for [Noah](https://github.com/lusis/noah).
4
+ You can read some of the discussions around these ideas here:
5
+
6
+ - [Noah Wiki Entry - Jordan's Ideas](https://github.com/lusis/Noah/wiki/Noah-Features-in-General-(scratchpad\))
7
+ - [Noah Wiki Entry - My Ideas](https://github.com/lusis/Noah/wiki/Possible-changes-in-Noah)
8
+ - [Gist with more Ideas](https://gist.github.com/1358889)
9
+
10
+ I am VERY thankful for the work done by @mattsears on [Gaga](https://github.com/mattsears/gaga).
11
+ I've wanted to do something Git-backed for a while but Gaga prompted me to consider it again. Noah, however, has some different requirements so I've hijacked his original code to roll Ark.
12
+
13
+ ## Schemas
14
+ Unlike most key/value systems, objects in Ark are defined with a schema. This fits better into Noah.
15
+
16
+ Schemas are defined in the following format:
17
+
18
+ ```json
19
+ {"id":"<String>",
20
+ "key":"<optional String>"
21
+ "attributes":"<Array>",
22
+ "validations":{
23
+ "required":"<optional Array>",
24
+ "unique":"<optional Array>",
25
+ "member":{
26
+ "<attribute>":"<Array>"
27
+ }
28
+ }
29
+ }
30
+ ```
31
+
32
+ The only requirements are that your schema must define
33
+
34
+ - an `id`
35
+ - either an attribute called `name` or a `key`
36
+
37
+ This would look like
38
+
39
+ ```json
40
+ {"id":"host","key":"name"}
41
+ ```
42
+ OR
43
+ ```json
44
+ {"id":"host","attributes":["name"]}
45
+ ```
46
+
47
+ Everything else is optional. The `name` attribute, should it exist, will automatically become the unique identifier for records using the schema. You can override this with the `key` attribute.
48
+
49
+ ### Validations
50
+ Validations are, again, optional but should you choose to use them there are further requirements.
51
+
52
+ - Any validation must contain a valid attribute
53
+ - Attribute for validation must be an array (excluding `member` which is a valid attribute and array)
54
+
55
+ Using our previous example, if you wanted to ensure that every `host` had a status:
56
+
57
+ ```json
58
+ {"id":"host",
59
+ "attributes":["name", "status"],
60
+ "validations":{
61
+ "required":["name","status"],
62
+ "unique":["name"]
63
+ }
64
+ }
65
+ ```
66
+ If you wanted to ensure that every host had a `status` and that it was one of `up`,`down` or `pending` you would also add a `member` validation:
67
+
68
+ ```json
69
+ {"id":"host",
70
+ "attributes":["name", "status"],
71
+ "validations":{
72
+ "required":["name","status"],
73
+ "unique":["name"],
74
+ "member":{
75
+ "status":["up","down","pending"]
76
+ }
77
+ }
78
+ }
79
+ ```
80
+
81
+ ## Git layout
82
+ The actual on-disk persistence is handled as a bare Git repo via Grit. It contains the following structure:
83
+
84
+ ```
85
+ <root>
86
+ _schema
87
+ /<id>.json
88
+ _objects
89
+ /<id>
90
+ /<key>.json
91
+ ```
92
+
93
+ Each schema is stored as a JSON file (`<id>.json`) in the `_schema` directory.
94
+ Each object created with a given schema is stored as a JSON file (`<key>.json`) in the `_objects/<id>` directory.
95
+
96
+ The reason for storing as a bare repo is to eliminate the temptation and confusion around it being a working repo. You could check out the repo elsewhere and make changes but this currently would bypass all validation (of both schemas and created objects).
97
+
98
+ ## Object creation
99
+ Initial experiments around this idea were done in my person experiments repo. The general flow would work something like this:
100
+
101
+ - Schemas are loaded from disk
102
+ - Classes are dynamically created from schemas
103
+ - Classes subclass a base class that defines validation and persistence
104
+ - Classes gain various git-friendly abilities (versioning, checksum and the like)
105
+
106
+ So if you use our `host` example from above, you would get a new class called `Host` to work with.
107
+
108
+ # TODO
109
+ I've still got more code to move over from my experiments. I'm trying to keep the Noah-specific stuff OUT of this code base. For instance, the sinatra application in the experiments won't be a part of this.
110
+
111
+ Other things:
112
+
113
+ - Expose symlinks (while this is for Noah, it's still appropriate here)
114
+ - Modify `Ark::Repo` to take the schema name on operations.
115
+ - Flesh out pre/post CRUD hooks. (Either use git hooks or my own similar to ohm-contrib)
116
+ - Figure out where cluster consistency fits. (Noah is the user but it's probably a separate repo - ark-cluster maybe?)
117
+
118
+ # Contributions
119
+ I welcome any and all contributions. Wiki entries, bug reports, code...it's all valuable.
@@ -0,0 +1,9 @@
1
+ #!/usr/bin/env rake
2
+ require "bundler/gem_tasks"
3
+ require "rake/testtask"
4
+
5
+ Rake::TestTask.new do |t|
6
+ t.libs << "test"
7
+ t.test_files = FileList['test/ts_*.rb']
8
+ t.verbose = true
9
+ end
@@ -0,0 +1,19 @@
1
+ # -*- encoding: utf-8 -*-
2
+ require File.expand_path('../lib/ark/version', __FILE__)
3
+
4
+ Gem::Specification.new do |gem|
5
+ gem.authors = ["John E. Vincent"]
6
+ gem.email = ["lusis.org+github.com@gmail.com"]
7
+ gem.description = %q{Special purpose data store built on Git}
8
+ gem.summary = ""
9
+ gem.homepage = "https://github.com/lusis/ark"
10
+
11
+ gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
12
+ gem.files = `git ls-files`.split("\n")
13
+ gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
14
+ gem.name = "ark"
15
+ gem.require_paths = ["lib"]
16
+ gem.version = Ark::VERSION
17
+ gem.add_dependency("grit", "= 2.4.1")
18
+ gem.add_dependency("slop", "= 2.3.1")
19
+ end
data/bin/ark ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'ark'
@@ -0,0 +1,12 @@
1
+ require "json"
2
+ require "grit"
3
+ require "ark/exceptions"
4
+ require "ark/version"
5
+ require 'ark/validations'
6
+ require "ark/repo"
7
+ require "ark/record"
8
+ require "ark/schema"
9
+
10
+ module Ark
11
+ # Your code goes here.
12
+ end
@@ -0,0 +1,4 @@
1
+ module Ark
2
+ class SchemaNotFoundError < StandardError
3
+ end
4
+ end
@@ -0,0 +1,48 @@
1
+ module Ark
2
+ module Record
3
+ # Ignore this for now
4
+ # I've been dithering back and forth on the API all night
5
+ # The way you use this is:
6
+ # class Host; include Ark::Record; end
7
+ # As long as there's a valid schema for `host`,
8
+ # you'll have a workable class
9
+ #
10
+ # However, I think there's a use case for combo record+schema creation..
11
+
12
+ def self.included(base)
13
+ db = Ark::Repo.db || Ark::Repo.connect
14
+ base.extend ClassMethods
15
+ klass = base.to_s.gsub(/^.*::/, '').downcase
16
+ begin
17
+ record = db.get("_schema/#{klass}.json")
18
+ raise Ark::SchemaNotFoundError if record.nil?
19
+ data = ::JSON.parse(record)
20
+ end
21
+ base.class_eval do
22
+ attr_accessor *data['attributes']
23
+ attr_reader :schema, :basepath, :errors, :record_type, :db
24
+
25
+ define_method("schema") { instance_variable_set("@schema", data) }
26
+ define_method("basepath") { instance_variable_set("@basepath", "_objects") }
27
+ define_method("record_type") { instance_variable_set("@record_type", data['id']) }
28
+ define_method("db") { instance_variable_set("@db", db) }
29
+ end
30
+ end
31
+
32
+ module ClassMethods
33
+ include Ark::Validations::Record
34
+
35
+ def valid?
36
+ validate_record
37
+ end
38
+
39
+ def save
40
+ self.valid? ? @db.set("#{@basepath}/#{@name}.json", data, "Setting #{@record_type} - #{@name}") : false
41
+ end
42
+
43
+ def self.[](key)
44
+ end
45
+
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,101 @@
1
+ module Ark
2
+ class Repo
3
+
4
+ class << self
5
+ def db=(db)
6
+ @db = db
7
+ end
8
+
9
+ def db
10
+ @db
11
+ end
12
+
13
+ def connect(path='/tmp/ark.git')
14
+ self.db = self.new(:repo => path)
15
+ end
16
+ end
17
+
18
+ def initialize(options = {})
19
+ @options = options
20
+ ::Grit::Repo.init_bare_or_open(path)
21
+ end
22
+
23
+ def set(key, value, message = nil)
24
+ message ||= "set '#{key}'"
25
+ save(message) do |index|
26
+ index.add(key, value)
27
+ true
28
+ end
29
+ end
30
+
31
+ def get(key, value = nil, *)
32
+ if head && blob = head.commit.tree / key
33
+ blob.data
34
+ end
35
+ end
36
+
37
+ def delete(key, message = nil, *)
38
+ message ||= "deleted '#{key}'"
39
+ self.get(key).tap do
40
+ save(message) {|index| index.delete(key) }
41
+ end
42
+ end
43
+
44
+ def clear(message = nil)
45
+ # This is not working. Need to investigate
46
+ message ||= "purged repo"
47
+ save(message) do |index|
48
+ if tree = index.current_tree
49
+ tree.contents.each do |entry|
50
+ index.delete(entry.name)
51
+ end
52
+ end
53
+ end
54
+ end
55
+
56
+ def log(key)
57
+ git.log(branch, key).map{|commit| commit.to_hash }
58
+ end
59
+
60
+ def keys
61
+ begin
62
+ head.commit.tree.contents.map {|blob| blob.name }
63
+ rescue NoMethodError
64
+ # Repo isn't populated yet
65
+ []
66
+ end
67
+ end
68
+
69
+ def git
70
+ @git ||= ::Grit::Repo.new(path)
71
+ end
72
+
73
+ def inspect
74
+ %Q{#<Ark::Repo "path=#{path}">}
75
+ end
76
+
77
+ private
78
+ def branch
79
+ @options[:branch] || 'master'
80
+ end
81
+
82
+ def head
83
+ git.get_head(branch)
84
+ end
85
+
86
+ def save(message)
87
+ index = git.index
88
+ if head
89
+ commit = head.commit
90
+ index.current_tree = commit.tree
91
+ end
92
+ yield index
93
+ index.commit(message, :parents => Array(commit), :head => branch) if index.tree.any?
94
+ end
95
+
96
+ def path(key='')
97
+ @path ||= File.join(File.expand_path(@options[:repo]), key)
98
+ end
99
+
100
+ end
101
+ end
@@ -0,0 +1,39 @@
1
+ module Ark
2
+ class Schema
3
+ include Ark::Validations::Schema
4
+
5
+ attr_accessor :errors, :definition
6
+ attr_reader :db, :parsed_schema
7
+
8
+ class << self
9
+
10
+ def add(definition)
11
+ s = self.new
12
+ s.definition = definition
13
+ s.save
14
+ end
15
+
16
+ def basepath
17
+ "_schema"
18
+ end
19
+
20
+ end
21
+
22
+ def initialize
23
+ @db = Ark::Repo.db || Ark::Repo.connect
24
+ end
25
+
26
+ def valid?
27
+ validate_schema
28
+ end
29
+
30
+ def save
31
+ if valid?
32
+ @db.set("#{self.class.basepath}/#{@parsed_schema['id']}.json", @definition, "Adding schema - #{@parsed_schema['id']}")
33
+ else
34
+ false
35
+ end
36
+ end
37
+
38
+ end
39
+ end
@@ -0,0 +1,6 @@
1
+ module Ark
2
+ module Validations
3
+ end
4
+ end
5
+ require 'ark/validations/schema_validations'
6
+ require 'ark/validations/record_validations'
@@ -0,0 +1,2 @@
1
+ module Ark::Validations::Record
2
+ end
@@ -0,0 +1,68 @@
1
+ module Ark::Validations::Schema
2
+
3
+ private
4
+ def required_keys
5
+ ["id", "attributes"]
6
+ end
7
+
8
+ def optional_keys
9
+ ["validations", "key"]
10
+ end
11
+
12
+ def validation_keys
13
+ ["required", "unique", "member"]
14
+ end
15
+
16
+ def validate_schema(schema_def=self.definition)
17
+ errors = []
18
+ begin
19
+ schema = ::JSON.parse(schema_def)
20
+ @parsed_schema = schema
21
+
22
+ keys = schema.keys
23
+ schema_id = schema['id']
24
+ attributes = schema['attributes']
25
+ validations = schema['validations']
26
+ key = schema['key']
27
+
28
+ required_keys.each do |key|
29
+ errors << [:schema, "missing_required_key_#{key}".to_sym] unless keys.member?(key)
30
+ end
31
+
32
+ errors << [:id, :not_string] if schema_id.class != String
33
+
34
+ errors << [:primary_key, :not_defined] if key.nil? && attributes.member?('name').nil?
35
+
36
+ unless validations.nil?
37
+ validations.each do |type, values|
38
+ errors << [type.to_sym, :unknown_validation_type] unless validation_keys.member?(type)
39
+ if type == "member"
40
+ values.each do |member_key, member_opts|
41
+ if member_opts.class != Array
42
+ errors << [:member, :member_must_be_array]
43
+ else
44
+ errors << [:member, :unknown_attribute_in_validation] unless attributes.member?(member_key)
45
+ end
46
+ end
47
+ else
48
+ if validations[type].class != Array
49
+ errors << [type.to_sym, "#{type}_must_be_array".to_sym]
50
+ else
51
+ validations[type].each do |attr|
52
+ errors << [type.to_sym, :unknown_attribute_in_validation] unless attributes.member?(attr)
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
58
+ rescue NoMethodError
59
+ # bad form, I know..
60
+ @errors = errors
61
+ rescue JSON::ParserError
62
+ errors << [:schema, :not_valid_json]
63
+ end
64
+ @errors = errors
65
+ errors.size > 0 ? false : true
66
+ end
67
+
68
+ end
@@ -0,0 +1,3 @@
1
+ module Ark
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,55 @@
1
+ # API Braindump
2
+ Just some random stuff to help me clear my head
3
+
4
+ ## Schema
5
+
6
+ ```ruby
7
+ Ark::Schema.add(schema_json)
8
+ ```
9
+
10
+ or
11
+
12
+ ```ruby
13
+ s = Ark::Schema.new
14
+ s.definition = schema_json
15
+ s.valid?
16
+ s.save # also calls Ark::Schema#valid?
17
+ ```
18
+
19
+ ## Record
20
+
21
+ ```ruby
22
+ class Host; include Ark::Record; end
23
+ # works if host is a valid schema
24
+ # this also works
25
+ class My::Random::Namespace::Host; include Ark::Record; end
26
+ ```
27
+ however you might want to use a class name different from the schema name:
28
+
29
+ ```ruby
30
+ class MyHost
31
+ include Ark::Record
32
+ validates_as :host
33
+ end
34
+ # this should give validate you against the `host` schema
35
+ ```
36
+
37
+ I think there's a valid use case for schema+record creation at once like so
38
+
39
+ ```ruby
40
+ class Host
41
+ include Ark::Record
42
+
43
+ attributes ["name","status"]
44
+
45
+ validation :unique, ["name"]
46
+ validation :require, ["name"]
47
+ validation :member, "status", ["up","down","pending"]
48
+
49
+ end
50
+ ```
51
+ ## RecordCollection
52
+ This doesn't even exist yet but I need to do it.
53
+
54
+ ## Repo
55
+ I'm not entirely happy with how this is API works but it's fine for now
@@ -0,0 +1 @@
1
+ {"foo":"bar"}
@@ -0,0 +1,3 @@
1
+ {"id":["foo"],
2
+ "attributes":["name"]
3
+ }
@@ -0,0 +1,7 @@
1
+ {
2
+ "id":"host",
3
+ "attributes":["name","status"],
4
+ "validations":{
5
+ "member":["name"]
6
+ }
7
+ }
@@ -0,0 +1,7 @@
1
+ {"id":"host",
2
+ "attributes":["name","status"],
3
+ "validations":{
4
+ "member":{"foobar":["up","down","pending"]}
5
+ }
6
+ }
7
+
@@ -0,0 +1 @@
1
+ {"id":"host"}
@@ -0,0 +1,6 @@
1
+ {"id":"host",
2
+ "attributes":["name"],
3
+ "validations":{
4
+ "required":"name"
5
+ }
6
+ }
@@ -0,0 +1,7 @@
1
+ {"id":"host",
2
+ "attributes":["name"],
3
+ "validations":{
4
+ "required":["foobar"]
5
+ }
6
+ }
7
+
@@ -0,0 +1,7 @@
1
+ {"id":"host",
2
+ "attributes":["name"],
3
+ "validations":{
4
+ "unique":"name"
5
+ }
6
+ }
7
+
@@ -0,0 +1,8 @@
1
+ {"id":"host",
2
+ "attributes":["name"],
3
+ "validations":{
4
+ "unique":["foobar"]
5
+ }
6
+ }
7
+
8
+
@@ -0,0 +1,6 @@
1
+ {"id":"host",
2
+ "attributes":["name"],
3
+ "validations":{
4
+ "foobar":["name"]
5
+ }
6
+ }
@@ -0,0 +1,11 @@
1
+ {
2
+ "id":"host",
3
+ "attributes":["name","status"],
4
+ "validations":{
5
+ "required":["name"],
6
+ "unique":["name"],
7
+ "member":{
8
+ "status":["up","down","pending"]
9
+ }
10
+ }
11
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "id":"host",
3
+ "key":"hostname",
4
+ "attributes":["name","status"],
5
+ "validations":{
6
+ "required":["name"],
7
+ "unique":["name"],
8
+ "member":{
9
+ "status":["up","down","pending"]
10
+ }
11
+ }
12
+ }
File without changes
File without changes
@@ -0,0 +1,58 @@
1
+ class TestSchema < Test::Unit::TestCase
2
+ FIXTURE_PATH = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
3
+
4
+ def test_not_json
5
+ expected_errors = [[:schema, :not_valid_json]]
6
+ json = "foo"
7
+ s = Ark::Schema.new
8
+ s.definition = json
9
+ assert_equal(false, s.valid?, "Schema should be invalid")
10
+ assert_equal(expected_errors, s.errors, "Error should be :not_valid_json")
11
+ end
12
+
13
+ def test_valid_no_key_schema
14
+ expected_errors = []
15
+ json = File.open("#{FIXTURE_PATH}/valid_no_key.json", 'r') {|f| f.read}
16
+ s = Ark::Schema.new
17
+ s.definition = json
18
+ assert_equal(true, s.valid?, "Schema should be valid")
19
+ assert_equal(expected_errors, s.errors, "Errors should be empty")
20
+ end
21
+
22
+ def test_valid_key_schema
23
+ expected_errors = []
24
+ json = File.open("#{FIXTURE_PATH}/valid_with_key.json", 'r') {|f| f.read}
25
+ s = Ark::Schema.new
26
+ s.definition = json
27
+ assert_equal(true, s.valid?, "Schema should be valid")
28
+ assert_equal(expected_errors, s.errors, "Errors should be empty")
29
+ end
30
+
31
+ def test_invalid_schema
32
+ expected_errors = [[:schema, :missing_required_key_id],[:schema, :missing_required_key_attributes],[:id, :not_string]]
33
+ json = File.open("#{FIXTURE_PATH}/invalid.json", 'r') {|f| f.read}
34
+ s = Ark::Schema.new
35
+ s.definition = json
36
+ assert_equal(false, s.valid?, "Schema should be invalid")
37
+ assert_equal(expected_errors, s.errors, "Errors should not be empty")
38
+ end
39
+
40
+ def test_missing_attributes
41
+ expected_errors = [[:schema, :missing_required_key_attributes]]
42
+ json = File.open("#{FIXTURE_PATH}/missing_attributes.json", 'r') {|f| f.read}
43
+ s = Ark::Schema.new
44
+ s.definition = json
45
+ assert_equal(false, s.valid?, "Schema should be invalid")
46
+ assert_equal(expected_errors, s.errors, "Error should not be empty")
47
+ end
48
+
49
+ def test_invalid_id
50
+ expected_errors = [[:id, :not_string]]
51
+ json = File.open("#{FIXTURE_PATH}/invalid_id.json", 'r') {|f| f.read}
52
+ s = Ark::Schema.new
53
+ s.definition = json
54
+ assert_equal(false, s.valid?, "Schema should be invalid")
55
+ assert_equal(expected_errors, s.errors, "Error should not be empty")
56
+ end
57
+
58
+ end
@@ -0,0 +1,67 @@
1
+ class TestSchemaValidations < Test::Unit::TestCase
2
+ FIXTURE_PATH = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
3
+
4
+ def test_unknown_validation_type
5
+ expected_errors = [[:foobar, :unknown_validation_type]]
6
+ json = File.open("#{FIXTURE_PATH}/unknown_validation.json", 'r') {|f| f.read}
7
+ s = Ark::Schema.new
8
+ s.definition = json
9
+ assert_equal(false, s.valid?)
10
+ assert_equal(expected_errors, s.errors)
11
+ end
12
+
13
+ def test_members_is_array
14
+ expected_errors = [[:member, :member_must_be_array]]
15
+ json = File.open("#{FIXTURE_PATH}/members_is_array.json", 'r') {|f| f.read}
16
+ s = Ark::Schema.new
17
+ s.definition = json
18
+ assert_equal(false, s.valid?)
19
+ assert_equal(expected_errors, s.errors)
20
+ end
21
+
22
+ def test_required_is_array
23
+ expected_errors = [[:required, :required_must_be_array]]
24
+ json = File.open("#{FIXTURE_PATH}/required_is_array.json", 'r') {|f| f.read}
25
+ s = Ark::Schema.new
26
+ s.definition = json
27
+ assert_equal(false, s.valid?)
28
+ assert_equal(expected_errors, s.errors)
29
+ end
30
+
31
+ def test_unique_is_array
32
+ expected_errors = [[:unique, :unique_must_be_array]]
33
+ json = File.open("#{FIXTURE_PATH}/unique_is_array.json", 'r') {|f| f.read}
34
+ s = Ark::Schema.new
35
+ s.definition = json
36
+ assert_equal(false, s.valid?)
37
+ assert_equal(expected_errors, s.errors)
38
+ end
39
+
40
+ def test_unique_is_attribute
41
+ expected_errors = [[:unique, :unknown_attribute_in_validation]]
42
+ json = File.open("#{FIXTURE_PATH}/unique_is_attribute.json", 'r') {|f| f.read}
43
+ s = Ark::Schema.new
44
+ s.definition = json
45
+ assert_equal(false, s.valid?)
46
+ assert_equal(expected_errors, s.errors)
47
+ end
48
+
49
+ def test_required_is_attribute
50
+ expected_errors = [[:required, :unknown_attribute_in_validation]]
51
+ json = File.open("#{FIXTURE_PATH}/required_is_attribute.json", 'r') {|f| f.read}
52
+ s = Ark::Schema.new
53
+ s.definition = json
54
+ assert_equal(false, s.valid?)
55
+ assert_equal(expected_errors, s.errors)
56
+ end
57
+
58
+ def test_members_is_attribute
59
+ expected_errors = [[:member, :unknown_attribute_in_validation]]
60
+ json = File.open("#{FIXTURE_PATH}/members_is_attribute.json", 'r') {|f| f.read}
61
+ s = Ark::Schema.new
62
+ s.definition = json
63
+ assert_equal(false, s.valid?)
64
+ assert_equal(expected_errors, s.errors)
65
+ end
66
+
67
+ end
@@ -0,0 +1,7 @@
1
+ $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
2
+ $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "test")))
3
+ require 'test/unit'
4
+ require 'ark'
5
+
6
+ require 'tc_schema'
7
+ require 'tc_schema_validations'
metadata ADDED
@@ -0,0 +1,110 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ark
3
+ version: !ruby/object:Gem::Version
4
+ prerelease:
5
+ version: 0.0.1
6
+ platform: ruby
7
+ authors:
8
+ - John E. Vincent
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+
13
+ date: 2011-11-15 00:00:00 Z
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: grit
17
+ prerelease: false
18
+ requirement: &id001 !ruby/object:Gem::Requirement
19
+ none: false
20
+ requirements:
21
+ - - "="
22
+ - !ruby/object:Gem::Version
23
+ version: 2.4.1
24
+ type: :runtime
25
+ version_requirements: *id001
26
+ - !ruby/object:Gem::Dependency
27
+ name: slop
28
+ prerelease: false
29
+ requirement: &id002 !ruby/object:Gem::Requirement
30
+ none: false
31
+ requirements:
32
+ - - "="
33
+ - !ruby/object:Gem::Version
34
+ version: 2.3.1
35
+ type: :runtime
36
+ version_requirements: *id002
37
+ description: Special purpose data store built on Git
38
+ email:
39
+ - lusis.org+github.com@gmail.com
40
+ executables:
41
+ - ark
42
+ extensions: []
43
+
44
+ extra_rdoc_files: []
45
+
46
+ files:
47
+ - .gitignore
48
+ - .rvmrc
49
+ - Gemfile
50
+ - LICENSE.txt
51
+ - README.md
52
+ - Rakefile
53
+ - ark.gemspec
54
+ - bin/ark
55
+ - lib/ark.rb
56
+ - lib/ark/exceptions.rb
57
+ - lib/ark/record.rb
58
+ - lib/ark/repo.rb
59
+ - lib/ark/schema.rb
60
+ - lib/ark/validations.rb
61
+ - lib/ark/validations/record_validations.rb
62
+ - lib/ark/validations/schema_validations.rb
63
+ - lib/ark/version.rb
64
+ - notes.md
65
+ - test/fixtures/invalid.json
66
+ - test/fixtures/invalid_id.json
67
+ - test/fixtures/members_is_array.json
68
+ - test/fixtures/members_is_attribute.json
69
+ - test/fixtures/missing_attributes.json
70
+ - test/fixtures/required_is_array.json
71
+ - test/fixtures/required_is_attribute.json
72
+ - test/fixtures/unique_is_array.json
73
+ - test/fixtures/unique_is_attribute.json
74
+ - test/fixtures/unknown_validation.json
75
+ - test/fixtures/valid_no_key.json
76
+ - test/fixtures/valid_with_key.json
77
+ - test/tc_record.rb
78
+ - test/tc_repo.rb
79
+ - test/tc_schema.rb
80
+ - test/tc_schema_validations.rb
81
+ - test/ts_all.rb
82
+ homepage: https://github.com/lusis/ark
83
+ licenses: []
84
+
85
+ post_install_message:
86
+ rdoc_options: []
87
+
88
+ require_paths:
89
+ - lib
90
+ required_ruby_version: !ruby/object:Gem::Requirement
91
+ none: false
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: "0"
96
+ required_rubygems_version: !ruby/object:Gem::Requirement
97
+ none: false
98
+ requirements:
99
+ - - ">="
100
+ - !ruby/object:Gem::Version
101
+ version: "0"
102
+ requirements: []
103
+
104
+ rubyforge_project:
105
+ rubygems_version: 1.8.6
106
+ signing_key:
107
+ specification_version: 3
108
+ summary: ""
109
+ test_files: []
110
+