ladder 0.0.3 → 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 00fc4391dcf2414bcf4860ab935b515ab87f8eac
4
- data.tar.gz: ec42ff2b6807d58a367e7d107671fde08d41a032
3
+ metadata.gz: 729a779241a06f62279c1ef03e9130493efb041c
4
+ data.tar.gz: 07d064bdaced47a7068a3d9c31571fc502071d42
5
5
  SHA512:
6
- metadata.gz: 24e9a32ea6b5a50051595ce730b45ad740d1fa98e277143657d2106660af299632beec4da0158049bbcea735f20e5aca2e93d42c19f27c90f64905fa07a8987a
7
- data.tar.gz: 323ecda92093ba662cffbe5e36ba6913f4bc0a448bd4ecfa42d228e9b643d381e79d9afda2a16f07bbc6d981abeedd1e1b4cc16f734b7e423345110d6e8bf022
6
+ metadata.gz: 85554fdf53fa8d9443e42cc61851f0a5929c3c5635e2e4f6787924ecb36517375ee1d2d1d2d8160ae9c35067422b6662d54a41b32d6fa6f1406f0e0ae1f73491
7
+ data.tar.gz: 8f714d9de28373f08589f2070e2dde82c8e9ef119cb452acd9a646daa841feb5971bd84ae6aaa142c6df9d86e7c060f230df97b4d475072e9bb07c5977121af9
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.bundle
11
+ *.so
12
+ *.o
13
+ *.a
14
+ mkmf.log
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --require spec_helper
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.1.2
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in ladder.gemspec
4
+ gemspec
5
+
6
+ # We are pulling a specific ActiveTriples branch at the moment
7
+ gem 'active-triples', git: 'https://github.com/mjsuhonos/ActiveTriples.git', branch: 'feature/identifiable'
data/LICENSE.txt CHANGED
@@ -1,22 +1,202 @@
1
- Copyright (c) 2014 MJ Suhonos
2
-
3
- MIT License
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
-
13
- The above copyright notice and this permission notice shall be
14
- included in all copies or substantial portions of the Software.
15
-
16
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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/README.md CHANGED
@@ -11,11 +11,11 @@ Ladder is a highly scalable metadata framework written in Ruby using well-known
11
11
 
12
12
  Ladder was loosely conceived over the course of several years prior to 2011. In early 2012, Ladder began existence as an opportunity to escape from a decade of LAMP development and become familiar with Ruby. From 2012 to late 2013, a closed prototype was built under the auspices of [Deliberate Data](http://deliberatedata.com) as a proof-of-concept to test the feasibility of the design.
13
13
 
14
- From mid-2014, Ladder is being re-architected as a series of Ruby gems that can be used individually and incorporated within existing Ruby frameworks (eg. [Project Hydra](http://projecthydra.org)), or used together as a comprehensive stack. Ladder is intended to encourage the LAM community to think less dogmatically about our established (often monolithic and/or niche) toolsets and instead embrace a broader vision of using non-LAM specific technologies.
14
+ From mid-2014, Ladder is being re-architected as a series of Ruby modules that can be used individually and incorporated within existing Ruby frameworks (eg. [Project Hydra](http://projecthydra.org)), or used together as a comprehensive stack. Ladder is intended to encourage the LAM community to think less dogmatically about our established (often monolithic and/or niche) toolsets and instead embrace a broader vision of using non-LAM specific technologies.
15
15
 
16
- ### There's Nothing Here!
16
+ ### There's Not Much Here!
17
17
 
18
- The original [prototype](https://github.com/mjsuhonos/ladder/tree/prototype) branch is available, as is an [experimental](https://github.com/mjsuhonos/ladder/tree/l2) branch. Core modules will be committed shortly once the gem structure (likely under the name ActiveLadder) is completed and the first gem is refactored out.
18
+ The original [prototype](https://github.com/mjsuhonos/ladder/tree/prototype) branch is available, as is an [experimental](https://github.com/mjsuhonos/ladder/tree/l2) branch. Core functionality is being refactored as modules in the "ladder" gem (see below).
19
19
 
20
20
  ## Installation
21
21
 
@@ -35,13 +35,322 @@ Or install it yourself as:
35
35
 
36
36
  ## Usage
37
37
 
38
- TODO: Write usage instructions here
38
+ * [Ladder::Resource](#ladderresource)
39
+ * [Configuring Resources](#configuring-resources)
40
+ * [Ladder::Searchable](#laddersearchable)
41
+
42
+ ### Ladder::Resource
43
+
44
+ Much like ActiveTriples, Resources are the core of Ladder. Resources implement all the functionality of a Mongoid::Document and an ActiveTriples::Resource. To add Ladder integration for your model, require
45
+ and include the main module in your class:
46
+
47
+ ```ruby
48
+ require 'ladder'
49
+
50
+ class Person
51
+ include Ladder::Resource
52
+
53
+ configure type: RDF::FOAF.Person
54
+
55
+ property :name, predicate: RDF::FOAF.name
56
+ property :description, predicate: RDF::DC.description
57
+ end
58
+
59
+ steve = Person.new
60
+ steve.name = 'Steve'
61
+ steve.description = 'Funny-looking'
62
+
63
+ steve.as_document
64
+ => {"_id"=>BSON::ObjectId('542f0c124169720ea0000000'), "name"=>{"en"=>"Steve"}, "description"=>{"en"=>"Funny-looking"}}
65
+
66
+ steve.as_jsonld
67
+ # => {
68
+ # "@context": {
69
+ # "dc": "http://purl.org/dc/terms/",
70
+ # "foaf": "http://xmlns.com/foaf/0.1/"
71
+ # },
72
+ # "@id": "http://example.org/people/542f0c124169720ea0000000",
73
+ # "@type": "foaf:Person",
74
+ # "dc:description": {
75
+ # "@language": "en",
76
+ # "@value": "Funny-looking"
77
+ # },
78
+ # "foaf:name": {
79
+ # "@language": "en",
80
+ # "@value": "Steve"
81
+ # }
82
+ # }
83
+ ```
84
+
85
+ The `#property` method takes care of setting both Mongoid fields and ActiveTriples properties. Properties with literal values are localized by default. Properties with a supplied `:class_name` will create a has-and-belongs-to-many (HABTM) relation:
86
+
87
+ ```ruby
88
+ class Person
89
+ include Ladder::Resource
90
+
91
+ configure type: RDF::FOAF.Person
92
+
93
+ property :name, predicate: RDF::FOAF.name
94
+ property :books, predicate: RDF::FOAF.made, class_name: 'Book'
95
+ end
96
+
97
+ class Book
98
+ include Ladder::Resource
99
+
100
+ configure type: RDF::DC.BibliographicResource
101
+
102
+ property :title, predicate: RDF::DC.title
103
+ property :people, predicate: RDF::DC.creator, class_name: 'Person'
104
+ end
105
+
106
+ b = Book.new(title: 'Heart of Darkness')
107
+ => #<Book _id: 542f28d44169721941000000, title: {"en"=>"Heart of Darkness"}, person_ids: nil>
108
+
109
+ b.people << Person.new(name: 'Joseph Conrad')
110
+ => [#<Person _id: 542f28dd4169721941010000, name: {"en"=>"Joseph Conrad"}, book_ids: [BSON::ObjectId('542f28d44169721941000000')]>]
111
+
112
+ b.as_jsonld
113
+ # => {
114
+ # "@context": {
115
+ # "dc": "http://purl.org/dc/terms/"
116
+ # },
117
+ # "@id": "http://example.org/books/542f28d44169721941000000",
118
+ # "@type": "dc:BibliographicResource",
119
+ # "dc:creator": {
120
+ # "@id": "http://example.org/people/542f28dd4169721941010000"
121
+ # },
122
+ # "dc:title": {
123
+ # "@language": "en",
124
+ # "@value": "Heart of Darkness"
125
+ # }
126
+ # }
127
+ ```
128
+
129
+ You'll notice that only the RDF node for the Book object on which `#as_jsonld` was called is serialized. To include the entire graph for related objects, use the `related: true` option:
130
+
131
+ ```ruby
132
+ b.as_jsonld related: true
133
+ # => {
134
+ # "@context": {
135
+ # "dc": "http://purl.org/dc/terms/",
136
+ # "foaf": "http://xmlns.com/foaf/0.1/"
137
+ # },
138
+ # "@graph": [
139
+ # {
140
+ # "@id": "http://example.org/books/542f28d44169721941000000",
141
+ # "@type": "dc:BibliographicResource",
142
+ # "dc:creator": {
143
+ # "@id": "http://example.org/people/542f28dd4169721941010000"
144
+ # },
145
+ # "dc:title": {
146
+ # "@language": "en",
147
+ # "@value": "Heart of Darkness"
148
+ # }
149
+ # },
150
+ # {
151
+ # "@id": "http://example.org/people/542f28dd4169721941010000",
152
+ # "@type": "foaf:Person",
153
+ # "foaf:made": {
154
+ # "@id": "http://example.org/books/542f28d44169721941000000"
155
+ # },
156
+ # "foaf:name": {
157
+ # "@language": "en",
158
+ # "@value": "Joseph Conrad"
159
+ # }
160
+ # }
161
+ # ]
162
+ # }
163
+ ```
164
+
165
+ If you want more control over how relations are defined (eg. in the case of embedded or 1:n relations), you can just use regular Mongoid and ActiveTriples syntax:
166
+
167
+ ```ruby
168
+ class Person
169
+ include Ladder::Resource
170
+
171
+ configure type: RDF::FOAF.Person
172
+
173
+ property :name, predicate: RDF::FOAF.name
174
+
175
+ embeds_one :address, class_name: 'Place'
176
+ property :address, predicate: RDF::FOAF.based_near
177
+ end
178
+
179
+ class Place
180
+ include Ladder::Resource
181
+
182
+ configure type: RDF::VCARD.Address
183
+
184
+ property :city, predicate: RDF::VCARD.locality
185
+ property :country, predicate: RDF::VCARD.send('country-name')
186
+
187
+ embedded_in :resident, class_name: 'Person', inverse_of: :address
188
+ property :resident, predicate: RDF::VCARD.agent
189
+ end
190
+
191
+ steve = Person.new(name: 'Steve')
192
+ => #<Person _id: 542f341e41697219a2000000, name: {"en"=>"Steve"}, address: nil>
193
+
194
+ steve.address = Place.new(city: 'Toronto', country: 'Canada')
195
+ => #<Place _id: 542f342741697219a2010000, city: {"en"=>"Toronto"}, country: {"en"=>"Canada"}, resident: nil>
196
+
197
+ steve.as_jsonld
198
+ # => {
199
+ # "@context": {
200
+ # "foaf": "http://xmlns.com/foaf/0.1/",
201
+ # "vcard": "http://www.w3.org/2006/vcard/ns#"
202
+ # },
203
+ # "@graph": [
204
+ # {
205
+ # "@id": "http://example.org/places/542f342741697219a2010000",
206
+ # "@type": "vcard:Address",
207
+ # "vcard:agent": {
208
+ # "@id": "http://example.org/people/542f341e41697219a2000000"
209
+ # },
210
+ # "vcard:country-name": {
211
+ # "@language": "en",
212
+ # "@value": "Canada"
213
+ # },
214
+ # "vcard:locality": {
215
+ # "@language": "en",
216
+ # "@value": "Toronto"
217
+ # }
218
+ # },
219
+ # {
220
+ # "@id": "http://example.org/people/542f341e41697219a2000000",
221
+ # "@type": "foaf:Person",
222
+ # "foaf:based_near": {
223
+ # "@id": "http://example.org/places/542f342741697219a2010000"
224
+ # },
225
+ # "foaf:name": {
226
+ # "@language": "en",
227
+ # "@value": "Steve"
228
+ # }
229
+ # }
230
+ # ]
231
+ # }
232
+ ```
233
+
234
+ Note in this case that both objects are included in the RDF graph, thanks to embedded relations. This can be useful to avoid additional queries to the database for objects that are tightly coupled.
235
+
236
+ ### Configuring Resources
237
+
238
+ If the LADDER_BASE_URI global constant is set, base URIs are dynamically generated based on the name of the model class. However, you can still set the base URI for a class explicitly just as you would in ActiveTriples:
239
+
240
+ ```ruby
241
+ LADDER_BASE_URI = 'http://example.org'
242
+
243
+ Person.resource_class.base_uri
244
+ => #<RDF::URI:0x3fecf69da274 URI:http://example.org/people>
245
+
246
+ Person.configure base_uri: 'http://some.other.uri/'
247
+
248
+ Person.resource_class.base_uri
249
+ => "http://some.other.uri/"
250
+ ```
251
+
252
+ ### Ladder::Searchable
253
+
254
+ You can also index your model classes for keyword searching through ElasticSearch by mixing in the Ladder::Searchable module:
255
+
256
+ ```ruby
257
+ class Person
258
+ include Ladder::Resource
259
+ include Ladder::Searchable
260
+
261
+ configure type: RDF::FOAF.Person
262
+
263
+ property :name, predicate: RDF::FOAF.name
264
+ property :description, predicate: RDF::DC.description
265
+ end
266
+
267
+ kimchy = Person.new
268
+ kimchy.name = 'Shay'
269
+ kimchy.description = 'Real genius'
270
+ ```
271
+
272
+ In order to enable indexing, call the `#index` method on the class:
273
+
274
+ ```ruby
275
+ Person.index
276
+ => :as_indexed_json
277
+
278
+ kimchy.as_indexed_json
279
+ => {"description"=>"Real genius", "name"=>"Shay"}
280
+
281
+ kimchy.save
282
+ => true
283
+
284
+ results = Person.search 'shay'
285
+ # => #<Elasticsearch::Model::Response::Response:0x007fa2ca82a9f0
286
+ # @klass=[PROXY] Person,
287
+ # @search=
288
+ # #<Elasticsearch::Model::Searching::SearchRequest:0x007fa2ca830a58
289
+ # @definition={:index=>"people", :type=>"person", :q=>"Shay"},
290
+ # @klass=[PROXY] Person,
291
+ # @options={}>>
292
+
293
+ results.count
294
+ => 1
295
+
296
+ results.first._source
297
+ => {"description"=>"Real genius", "name"=>"Shay"}
298
+
299
+ results.records.first == kimchy
300
+ => true
301
+ ```
302
+
303
+ When indexing, you can control how your model is stored in the index by supplying the `as: :jsonld` or `as: :qname` options:
304
+
305
+ ```ruby
306
+ Person.index as: :jsonld
307
+ => :as_indexed_json
308
+
309
+ kimchy.as_indexed_json
310
+ # => {
311
+ # "@context": {
312
+ # "dc": "http://purl.org/dc/terms/",
313
+ # "foaf": "http://xmlns.com/foaf/0.1/"
314
+ # },
315
+ # "@id": "http://example.org/people/543b457b41697231c5000000",
316
+ # "@type": "foaf:Person",
317
+ # "dc:description": {
318
+ # "@language": "en",
319
+ # "@value": "Real genius"
320
+ # },
321
+ # "foaf:name": {
322
+ # "@language": "en",
323
+ # "@value": "Shay"
324
+ # }
325
+ # }
326
+
327
+ Person.index as: :qname
328
+ => :as_indexed_json
329
+
330
+ kimchy.as_indexed_json
331
+ # {
332
+ # "dc": {
333
+ # "description": {
334
+ # "en": "Real genius"
335
+ # }
336
+ # },
337
+ # "foaf": {
338
+ # "name": {
339
+ # "en": "Shay"
340
+ # }
341
+ # },
342
+ # "rdf": {
343
+ # "type": "foaf:Person"
344
+ # }
345
+ # }
346
+ ```
347
+
39
348
 
40
349
  ## Contributing
41
350
 
42
351
  Anyone and everyone is welcome to contribute. Go crazy.
43
352
 
44
- 1. Fork it ( https://github.com/[my-github-username]/ladder/fork )
353
+ 1. Fork it ( https://github.com/mjsuhonos/ladder/fork )
45
354
  2. Create your feature branch (`git checkout -b my-new-feature`)
46
355
  3. Commit your changes (`git commit -am 'Add some feature'`)
47
356
  4. Push to the branch (`git push origin my-new-feature`)
@@ -49,7 +358,7 @@ Anyone and everyone is welcome to contribute. Go crazy.
49
358
 
50
359
  ### Authors
51
360
 
52
- MJ Suhonos [@mjsuhonos](http://twitter.com/mjsuhonos) / [@cyxohoc](http://twitter.com/cyxohoc) / mj@suhonos.ca
361
+ MJ Suhonos / mj@suhonos.ca
53
362
 
54
363
  ## Acknowledgements
55
364
 
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
data/ladder.gemspec ADDED
@@ -0,0 +1,33 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'ladder/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "ladder"
8
+ spec.version = Ladder::VERSION
9
+ spec.platform = Gem::Platform::RUBY
10
+ spec.authors = "MJ Suhonos"
11
+ spec.email = "mj@suhonos.ca"
12
+ spec.summary = %q{Opinionated ActiveModel framework.}
13
+ spec.description = %q{Ladder is a metadata framework for RDF modelling, persistence, and full-text indexing.}
14
+ spec.homepage = "https://github.com/mjsuhonos/ladder"
15
+ spec.license = "APACHE2"
16
+ spec.required_ruby_version = '>= 1.9.3'
17
+
18
+ spec.files = `git ls-files -z`.split("\x0")
19
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
20
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_dependency "mongoid", "~> 4.0"
24
+ spec.add_dependency "active-triples", "~> 0.2"
25
+ spec.add_dependency "elasticsearch-model", "~> 0.1"
26
+
27
+ spec.add_development_dependency "bundler", "~> 1.7"
28
+ spec.add_development_dependency "pry", "~> 0.10"
29
+ spec.add_development_dependency "wirble", "~> 0.1"
30
+ spec.add_development_dependency "rspec", "~> 3.1"
31
+ spec.add_development_dependency "rake", "~> 10.3"
32
+ spec.add_development_dependency "yard", "~> 0.8"
33
+ end