pragmatic_context 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 172596b7b54c27b64dd8387556afab2ea83ed373
-  data.tar.gz: e55900a1261bdc44770b36325c73643dce742fd6
+  metadata.gz: a60bf7a2275e2574efef334b737bd33f8f906257
+  data.tar.gz: 7af80e83673d61cfa2878280783ac29fd0be7bf5
 SHA512:
-  metadata.gz: 1933a9be02c54a3a9057aa253c8f3b2171b83a370b24d43245483b08097d87dadc51a9995bb07952e60ade4889b29f8fb9188a0b7e2793c325774e2bfe3b2692
-  data.tar.gz: 6081281c6c0cddaefc9f64f0ba317eb0a8c750c90c47fc0ac0f41933a4200fe45b4df02656accb3833b184c046fcf49e26362fcfa9e9d05078eb75d69f985a57
+  metadata.gz: 00e267df94129526296bd61a1e810b45c87c29e71121f95deb93272a8203ebfade3f94750746f4eaace246ba0afdb2d450bc6ace4f65421471c472468f414fd5
+  data.tar.gz: fb7bbae5beda4427d6ca15551ce7aa01a3782e21e03dc3bdf992d3f50aebc29e6c2d61eb01b2c862657f111d114acb87ddea6f46450a45e18dad97f3823249ff

data/README.md

@@ -1,6 +1,6 @@
 # PragmaticContext
 
-PragmaticContext lets declaratively contextualize your
+PragmaticContext allows you to declaratively contextualize your
 ActiveModel objects in terms of Linked Data concepts, giving you an easy way to
 get your models talking JSON-LD.
 
@@ -111,9 +111,11 @@ it like so:
       field :last_name
       field :email
 
-      contextualize :first_name, :as => 'http://xmlns.com/foaf/0.1/givenName'
-      contextualize :last_name, :as => 'http://xmlns.com/foaf/0.1/familyName'
-      contextualize :email, :as => 'http://xmlns.com/foaf/0.1/mbox'
+      contextualize_as_type 'https://schema.org/Person'
+
+      contextualize :first_name, :as => 'http://schema.org/givenName'
+      contextualize :last_name, :as => 'http://schema.org/familyName'
+      contextualize :email, :as => 'http://schema.org/email'
     end
 
 This gives Pragmatic Context everything it needs to be able to create JSON-LD
@@ -128,10 +130,11 @@ the `Person` object described above will produce the following JSON-LD document:
 
     { 
       "@context": {
-        "first_name": { "@id", "http://xmlns.com/foaf/0.1/givenName" },
-        "last_name": { "@id", "http://xmlns.com/foaf/0.1/familyName" },
-        "email": { "@id", "http://xmlns.com/foaf/0.1/mbox" },
+        "first_name": { "@id", "http://schema.org/givenName" },
+        "last_name": { "@id", "http://schema.org/familyName" },
+        "email": { "@id", "http://schema.org/email" },
       },
+      "@type": "http://schema.org/Person",
       "first_name": "Mat",
       "last_name": "Trudel",
       "email": "mat@geeky.net"
@@ -144,6 +147,9 @@ A couple of things to note about this implementation:
   a document which do not have a context defined.
 * The produced JSON-LD document embeds the context directly in the document,
   within the `@context` field.
+* If a type is given for the contextualized class (via the
+  `contextualize_as_type` statement), it will have a matching `@type` field in
+  its JSON-LD representation.
 * For each field present in your object's `as_json` method *that has a matching
   `contextualize` statement*, `as_jsonld` will:
     * If the field is a primitive value (string, number, boolean, nil), its

data/lib/pragmatic_context/contextualizable.rb

@@ -8,6 +8,7 @@ module PragmaticContext
 
     module ClassMethods
       attr_accessor :contextualizer
+      attr_accessor :contextualized_type
 
       def contextualize_with(klass)
         self.contextualizer = klass.new
@@ -18,6 +19,10 @@ module PragmaticContext
         self.contextualizer.add_term(field, params)
       end
 
+      def contextualize_as_type(type)
+        self.contextualized_type = type
+      end
+
       private
 
       def setup_default_contextualizer
@@ -35,6 +40,7 @@ module PragmaticContext
       terms_with_context = self.class.contextualizer.definitions_for_terms(terms).keys
       json_results = as_json(opts).slice(*terms_with_context)
       results = {}
+      results['@type'] = self.class.contextualized_type if self.class.contextualized_type
       terms_with_context.each do |term|
         # Don't use idiomatic case here since Mongoid relations return proxies
         # that fail the Contextualizable test

data/lib/pragmatic_context/version.rb

@@ -1,3 +1,3 @@
 module PragmaticContext
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/lib/pragmatic_context/contextualizable_spec.rb

@@ -44,6 +44,13 @@ describe PragmaticContext::Contextualizable do
         subject.contextualize :bacon, :as => 'http://bacon.yum'
       end
     end
+
+    describe 'contextualize_as_type' do
+      it 'should set the type on the class' do
+        subject.contextualize_as_type 'bacon'
+        subject.contextualized_type.should eq 'bacon'
+      end
+    end
   end
 
   describe 'included instance methods' do
@@ -53,10 +60,17 @@ describe PragmaticContext::Contextualizable do
       @contextualizer = double('contextualizer')
       contextualizer_class = double('contextualizer class')
       contextualizer_class.stub(:new) { @contextualizer }
+      subject.class.contextualize_as_type nil
       subject.class.contextualize_with contextualizer_class
     end
 
     describe 'as_jsonld' do
+      it 'should respond with @type if it has been set' do
+        @contextualizer.stub(:definitions_for_terms) { {} }
+        subject.class.contextualize_as_type 'Food'
+        subject.as_jsonld.should == { "@type" => "Food", "@context" => {} }
+      end
+
       it 'should respond with only contextualized terms plus their context' do
         @contextualizer.stub(:definitions_for_terms) do |terms|
           { 'bacon' => { "@id" => "http://bacon.yum" } }.slice(*terms)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pragmatic_context
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mat Trudel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler