babl-json 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9465c242a044d65452c010e57c73b913e02191e9
-  data.tar.gz: 9de5d1761abe484d99ab4dbcd63a02e3a48c4004
+  metadata.gz: 5ba5482718ee00f9ac1b05baf788ccd39843509a
+  data.tar.gz: 1fe2a5916eff6f5e589c9e77c30815aee64f8dd2
 SHA512:
-  metadata.gz: f6cfe7ee5e5a957f12b33791b34e6db6bc2980ec533e4975bac8a7de380a551d9d5a1923e65c60bf2406928275a118ae79eb85c987c958b710fdfe19eb5c1500
-  data.tar.gz: df646dfc2fe0dd1e64cd8f6da9ca71f1d478fa93267f8141869c5bef7f4af17c2af3edc282a346b6b527cd4203fbefea7049d349e61d336520121264ff2c3767
+  metadata.gz: 2cefeca1a634f8392ebdff3743606a8a2e3b6e2fbd1e13159426ffc1ad353a29fe96cbbdb7929a739f051e1c1d6015b7e1424008f9a920f70b9084d4eb849266
+  data.tar.gz: 898b5da6cd62aed43df0350106d7f9ceaf65a4cd4359c3081768a1f86040b392d82ae590551ee44036557cc4cfdafd1dfe63d3ca9820f0620710e27cf6dec290

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # BABL Changelog
 
+## 0.1.3 (June 19, 2017)
+
+- Added #null operator, in order to make any JSON file a valid BABL template.
+
 ## 0.1.2 (May 22, 2017)
 
 - Fixed a bug in #call(primitive)

data/README.md

@@ -4,20 +4,20 @@
 
 BABL (Bannerman API Builder Language) is a templating langage for generating JSON in APIs.
 
-It plays a role similar to [RABL](https://github.com/nesquena/rabl), [JBuilder](https://github.com/rails/jbuilder), [Grape Entity](https://github.com/ruby-grape/grape-entity), and many others. However, unlike  existing tools, BABL has several advantages :
+It plays a role similar to [RABL](https://github.com/nesquena/rabl), [JBuilder](https://github.com/rails/jbuilder), [Grape Entity](https://github.com/ruby-grape/grape-entity), and many others. However, unlike existing tools, BABL has several advantages.
 
 
 ### Static compilation
 
-BABL is a simple Ruby DSL. Unlike RABL, the template code is fully parsed and executed before any data is available. The approach makes it possible to detect errors earlier and document the output schema automatically, without data.
+BABL is a simple Ruby DSL. Unlike RABL, the template code is fully parsed and executed before any data is available. This approach makes it possible to detect errors earlier and document the output schema automatically, without data. Experimentally, it also makes partials evaluation much faster, because partials are loaded only once.
 
 ### Automatic preloading
 
-BABL is also able to infer the "input schema". It can loosely be seen as the list of properties we need to read from the models to construct the JSON output. These *dependencies* can be used to retrieve data more efficiently. For instance,all ActiveRecord associations can be preloaded automatically using this mechanism.
+BABL is also able to infer the "input schema". It can loosely be seen as the list of properties we need to read from the models to construct the JSON output. These *dependencies* can be used to retrieve data more efficiently. For instance, all ActiveRecord associations can be preloaded automatically using this mechanism.
 
 ### Simple syntax
 
-JSON is simple, and generating JSON should be as simple as possible. We do not rely on `#method_missing`.
+JSON is simple, and generating JSON should be as simple as possible.
 
 BABL template:
 
@@ -50,6 +50,8 @@ Output:
 }
 ```
 
+Interestingly, this JSON output is also a valid BABL template. It makes it very easy to mix static JSON and dynamic content during developpement.
+
 ## Documentation
 
 TODO
@@ -60,13 +62,13 @@ TODO
 
 This feature only works if BABL is configured to use an external preloader.
 
-As of today, the only compatible preloader implementation *has not been released* yet. Hopefully, it will be available soon :-)
+As of today, the only compatible preloader implementation *has not been released* yet, because it has severe limitations. Hopefully, it will be available soon :-)
 
 ### Automatic documentation
 
 Support for automatic documentation is very limited, and the output is indecently ugly. It is more a proof-of-concept than a useful feature.
 
-The mid-term goal is to generate a [JSON schema](http://json-schema.org/) documentation.
+Mid-term goal is to generate a [JSON schema](http://json-schema.org/) documentation.
 
 ### Rails integration
 

data/lib/babl/operators/null.rb

@@ -0,0 +1,15 @@
+module Babl
+    module Operators
+        module Null
+            module DSL
+                # This operator always produces a JSON 'null'.
+                # We need it because a JSON file is also a valid
+                # BABL file (only if it is also a valid Ruby file,
+                # of course)
+                def null
+                    static(nil)
+                end
+            end
+        end
+    end
+end

data/lib/babl/operators/switch.rb

@@ -5,7 +5,7 @@ module Babl
                 # To be used as a switch(...) condition. It is strictly equivalent to write 'true' instead,
                 # but convey more meaning.
                 def default
-                    unscoped.static(true)
+                    static(true)
                 end
 
                 # Return a special placeholder that can be used as a switch(...) value. It tells BABL to continue

data/lib/babl/template.rb

@@ -7,6 +7,7 @@ require 'babl/operators/each'
 require 'babl/operators/enter'
 require 'babl/operators/merge'
 require 'babl/operators/nav'
+require 'babl/operators/null'
 require 'babl/operators/nullable'
 require 'babl/operators/object'
 require 'babl/operators/parent'
@@ -35,6 +36,7 @@ module Babl
         include Operators::Enter::DSL
         include Operators::Merge::DSL
         include Operators::Nav::DSL
+        include Operators::Null::DSL
         include Operators::Nullable::DSL
         include Operators::Object::DSL
         include Operators::Parent::DSL

data/lib/babl/version.rb

@@ -1,3 +1,3 @@
 module Babl
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
 end

data/spec/operators/null_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe ::Babl::Operators::Null do
+    include SpecHelper::Operators
+
+    describe '#null' do
+        let(:template) { dsl.source { { val: null } } }
+        let(:object) { {} }
+
+        it { expect(documentation).to eq(val: nil) }
+        it { expect(dependencies).to eq({}) }
+        it { expect(json).to eq('val' => nil) }
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: babl-json
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Frederic Terrazzoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -92,6 +92,7 @@ files:
 - lib/babl/operators/enter.rb
 - lib/babl/operators/merge.rb
 - lib/babl/operators/nav.rb
+- lib/babl/operators/null.rb
 - lib/babl/operators/nullable.rb
 - lib/babl/operators/object.rb
 - lib/babl/operators/parent.rb
@@ -117,6 +118,7 @@ files:
 - spec/operators/enter_spec.rb
 - spec/operators/merge_spec.rb
 - spec/operators/nav_spec.rb
+- spec/operators/null_spec.rb
 - spec/operators/nullable_spec.rb
 - spec/operators/object_spec.rb
 - spec/operators/parent_spec.rb
@@ -159,6 +161,7 @@ test_files:
 - spec/operators/enter_spec.rb
 - spec/operators/merge_spec.rb
 - spec/operators/nav_spec.rb
+- spec/operators/null_spec.rb
 - spec/operators/nullable_spec.rb
 - spec/operators/object_spec.rb
 - spec/operators/parent_spec.rb