json_factory 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4514793bfcddf9c571232e5cf6bef2f4f0e3604
-  data.tar.gz: e6370cc5a01e97d48237e9ae60b6f23f6acd6d13
+  metadata.gz: 454931a891f470c353038999c80a2ec56bcb6123
+  data.tar.gz: 5a56f375ce2338492bc71e6994cbed1dca3dce20
 SHA512:
-  metadata.gz: 7c49593eaacc118a094cec4ec95bd5a15c359507f870d2b7911e0445e1c2aeb5f87b065d38cfa67741368f187657dd623ba935bade271d0d7ea455e0ab3e9ce2
-  data.tar.gz: f4ed8f8663d43b36e5f5a4c23af22f6a151470655e4766c27869a12ac1594d62db271aafd67b6853c5760586248485f13e146b7b513b75dc131f9a1431cc7562
+  metadata.gz: 4d83cf336f0a24cac3e33b7593b3c80b29531ae4edbca150fa59d7113c99b2e5beadeae88fa294ddadc86cb3fa8ed84b26bbe9039c68f2e5c4d611817d12c14f
+  data.tar.gz: 1bcf40a03c5647c892ab7738d0c420f244a978b76d9fb8a784c04022f382b362880713df43610d9e6b75faac22b8b957ac558844d5e78ff5972dbf2ce1b2c99c

data/README.md

@@ -2,7 +2,7 @@
 
 # JsonFactory
 
-JsonFactory is a Easy DSL to create JSON structures with the development focus on performance. 
+JsonFactory is a Easy DSL to create JSON with focus on performance and flexibility. 
 
 ## Installation
 
@@ -22,108 +22,123 @@ Or install it yourself as:
 
 ## Usage
 
-| DSL Method | Description                                                         | 
-| ---------- |:------------------------------------------------------------------- |  
-| value      | Generates a JSON value.                                             |   
-| object     | Generates a JSON object structure.                                  |   
-| member     | Adds a key-value pair to a JSON object.                             |
-| array      | Generates a JSON array structure.                                   | 
-| element    | Adds a value to a JSON array.                                        | 
-| partial    | Loads the given partial and evaluates it using the local variables. |
-| cache      | Caches the given content under the specified key.                   |
+| DSL Method                           | Description                                                         | 
+| ------------------------------------ |:------------------------------------------------------------------- |  
+| [value](#value-method)               | Generates a JSON value.                                             |   
+| [object](#object-method)             | Generates a JSON object.                                            |   
+| [member](#member-method)             | Adds a key-value pair to a JSON object.                             |
+| [array](#array-method)               | Generates a JSON array.                                             | 
+| [object_array](#object_array-method) | Generates a JSON array.                                             |
+| [element](#element-method)           | Adds a value to a JSON array.                                       | 
+| [partial](#partial-method)           | Loads the given partial and evaluates it using the local variables. |
+| [cache](#cache-method)               | Caches the given content under the specified key.                   |
+| [object_if](#object_if-method)       | Generates a JSON object if condition is true.                       |
 
-##### Top level object  JSON structure
+##### value method 
 
 ```ruby
 factory = <<-RUBY
-  json.object do
-    json.member :data do
-      json.object do
-        json.member :id, object.id
-        json.member :name, object.name
-        json.member :test_array do
-          json.object_array(object.test_objects) do |test_object|
-            json.member :id, test_object.id)
-            json.member :name, test_object.name
-          end
-        end
+  value nil
+RUBY
+
+puts JSONFactory.build(factory) # => null
+```
+
+##### object method 
+
+```ruby
+factory = <<-RUBY
+  object do
+    member :data do
+      object do
+        member :id, object.id
       end
     end 
   end
 RUBY
 
 # test data 
-test_object_1 = OpenStruct.new(id: '001', name: 'TestObject2')
-test_object_2 = OpenStruct.new(id: '002', name: 'TestObject3')
-test_object = OpenStruct.new(id: '1', name: 'TestObject1', test_objects: [test_object_1, test_object_2])
+test_object = OpenStruct.new(id: 1)
 
-puts JSONFactory.build(factory, object: test_object)
+puts JSONFactory.build(factory, object: test_object) # => {"data":{"id":1}}
 ```
 
-```json
-{
-  "data": {
-    "id": "1",
-    "name": "TestObject1",
-    "test_array": [
-      { "id": "001", "name": "TestObject2" },
-      { "id": "002", "name": "TestObject3" }
-    ]
-  }
-}
+##### member method 
+
+```ruby
+factory = <<-RUBY
+  object do 
+    member :foo, 'bar' 
+  end
+RUBY
+
+puts JSONFactory.build(factory) # => {"foo":"bar"}
 ```
 
-##### Top level array JSON structure
+##### array method
 
 ```ruby
 factory = <<-RUBY
-  json.object_array objects  do |test_object|
-    json.member :id, test_object.id
-    json.member :name, test_object.name
+  array
+    objects.each do |test_object|   
+      element :id, test_object.id
+    end
   end
 RUBY
 
 # test data 
-test_object_1 = OpenStruct.new(id: '001', name: 'TestObject2')
-test_object_2 = OpenStruct.new(id: '002', name: 'TestObject3')
+test_object_1 = OpenStruct.new(id: 1)
+test_object_2 = OpenStruct.new(id: 2)
 
-puts JSONFactory.build(factory, objects: [test_object_1, test_object_2])
+puts JSONFactory.build(factory, objects: [test_object_1, test_object_2]) # => [{"id": 1},{"id":2}]
 ```
 
-```json
-[
-  { "id": "001", "name": "TestObject2" },
-  { "id": "002", "name": "TestObject3" }
-]
+##### object_array method
+
+```ruby
+factory = <<-RUBY
+  object_array objects do |test_object|
+    member :id, test_object.id
+  end
+RUBY
+
+# test data 
+test_object_1 = OpenStruct.new(id: 1)
+test_object_2 = OpenStruct.new(id: 2)
+
+puts JSONFactory.build(factory, objects: [test_object_1, test_object_2]) # => [{"id":1},{"id":2}]
 ```
 
-##### Load jfactory files
+##### element method
 
 ```ruby
-# tmp/test.jfactory
-json.member :id, test_object.id
-json.member :name, test_object.name
-``` 
+factory = <<-RUBY
+  array
+    objects.each do |test_object|   
+      element :id, test_object.id
+    end
+  end
+RUBY
 
-```ruby
-# test data
-test_object = OpenStruct.new(id: '1', name: 'TestObject1')
+# test data 
+test_object_1 = OpenStruct.new(id: 1)
+test_object_2 = OpenStruct.new(id: 2)
 
-puts JSONFactory.build('tmp/test.jfactory', object: test_object).build # => { "id": 1, name: "TestObject1" }
-```        
+puts JSONFactory.build(factory, objects: [test_object_1, test_object_2]) # => [{"id": 1},{"id":2}]
+```
 
-##### Load partials 
+##### partial method
 
 ```ruby
 # tmp/_test_partial.jfactory
-json.member :id, test_object.id
-json.member :name, test_object.name
+member :id, test_object.id
+member :name, test_object.name
 ```  
 
 ```ruby
 # tmp/test.jfactory
-json.object do
-  json.partial 'tmp/test_partial', test_object: object
+object do
+  partial 'tmp/test_partial', test_object: object
 end
 ``` 
 
@@ -134,16 +149,16 @@ test_object = OpenStruct.new(id: '1', name: 'TestObject1')
 puts JSONFactory.build('tmp/test.jfactory', object: test_object).build # => { "id": 1, name: "TestObject1" }
 ```  
 
-##### Use cache stores
+##### cache method
 
 ```ruby
 factory = <<-RUBY
-  json.object do
-    json.member :data do
-      json.object do
-        json.cache 'test-cache-key' do
-          json.member :id, object.id
-          json.member :name, object.name
+  object do
+    member :data do
+      object do
+        cache 'test-cache-key' do
+          member :id, object.id
+          member :name, object.name
         end
       end
     end
@@ -153,11 +168,56 @@ RUBY
 # test data 
 test_object = OpenStruct.new(id: '1', name: 'TestObject1')
 
+# set cache store
 JSONFactory::Cache.instance.store = ActiveSupport::Cache::MemoryStore.new
 
 puts JSONFactory.build(factory, object: test_object) # => { "data": { "id": "1", "name": "TestObject1" } }
 ```
 
+##### object_if method
+
+```ruby
+factory = <<-RUBY
+  object do
+    member :data do
+      object_if true do
+        member :foo, 'bar'
+      end
+    end 
+  end
+RUBY
+
+puts JSONFactory.build(factory) # => { "data": { "foo": "bar" } }
+```
+```ruby
+factory = <<-RUBY
+  object do
+    member :data do
+      object_if false do
+        member :foo, 'bar'
+      end
+    end 
+  end
+RUBY
+
+puts JSONFactory.build(factory) # => { "data": null }
+```
+
+##### Load jfactory files
+
+```ruby
+# tmp/test.jfactory
+member :id, test_object.id
+member :name, test_object.name
+``` 
+
+```ruby
+# test data
+test_object = OpenStruct.new(id: '1', name: 'TestObject1')
+
+puts JSONFactory.build('tmp/test.jfactory', object: test_object).build # => { "id": 1, name: "TestObject1" }
+```   
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`. 

data/lib/json_factory.rb

@@ -11,7 +11,6 @@ require_relative 'json_factory/errors'
 require_relative 'json_factory/state'
 require_relative 'json_factory/converter'
 require_relative 'json_factory/dsl'
-require_relative 'json_factory/dsl/object_array'
 require_relative 'json_factory/template_store'
 require_relative 'json_factory/json_builder'
 require_relative 'json_factory/builder'

data/lib/json_factory/configuration.rb

@@ -15,5 +15,9 @@ module JSONFactory
     def include_helper(mod)
       @helpers.push(mod)
     end
+
+    def extend_dsl(mod)
+      JSONFactory::DSL.include(mod)
+    end
   end
 end

data/lib/json_factory/dsl.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative 'dsl/object_array'
+require_relative 'dsl/object_if'
+
 module JSONFactory
   class DSL
     def self.check_arity(argc, expected)

data/lib/json_factory/dsl/object_array.rb

@@ -14,7 +14,7 @@ module JSONFactory
     #   json.array do
     #     [1,2,3].each do |id|
     #       json.object do
-    #         json.member :id, id
+    #         json.element :id, id
     #       end
     #     end
     #   end

data/lib/json_factory/dsl/object_if.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module JSONFactory
+  class DSL
+    # Helper method to generate an object.
+    #
+    #   json.object_if(true) do |id|
+    #     json.member :foo, 'bar'
+    #   end
+    #   # generates: {"foo":"bar"}
+    #
+    #   json.object_if(false) do |id|
+    #     json.member :foo, 'bar'
+    #   end
+    #   # generates: null
+    def object_if(value, &block)
+      value ? object(&block) : value(nil)
+    end
+  end
+end

data/lib/json_factory/json_builder.rb

@@ -84,11 +84,12 @@ module JSONFactory
     end
 
     def evaluate(string, local_variables, filename)
-      binding = jfactory
+      dsl = DSL.new(self)
+      binding = jfactory(dsl)
       local_variables.each_pair do |key, value|
         binding.local_variable_set(key, value)
       end
-      binding.local_variable_set(BUILDER_VARIABLE_NAME, DSL.new(self))
+      binding.local_variable_set(BUILDER_VARIABLE_NAME, dsl)
       eval(string, binding, filename.to_s) # rubocop:disable Security/Eval
     end
 
@@ -145,7 +146,7 @@ end
 
 JSONFactory::JSONBuilder.class_eval do
   # Returns an empty evaluation context, similar to Ruby's main object.
-  def jfactory
+  def jfactory(__dsl__)
     Object.allocate.instance_eval do
       class << self
         JSONFactory.configure.helpers.each { |mod| include mod }
@@ -155,6 +156,19 @@ JSONFactory::JSONBuilder.class_eval do
         end
         alias inspect to_s
       end
+
+      define_singleton_method(:__dsl__) do
+        __dsl__
+      end
+
+      def method_missing(method_name, *args, &block)
+        if __dsl__.respond_to?(method_name)
+          __dsl__.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+      
       return binding
     end
   end

data/lib/json_factory/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSONFactory
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_factory
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Alexander Klaiber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,7 +171,6 @@ files:
 - examples/benchmark.rb
 - examples/fixtures/_test_partial.jfactory
 - examples/fixtures/test.jfactory
-- examples/readme_examples.rb
 - json_factory.gemspec
 - lib/json_factory.rb
 - lib/json_factory/builder.rb
@@ -180,6 +179,7 @@ files:
 - lib/json_factory/converter.rb
 - lib/json_factory/dsl.rb
 - lib/json_factory/dsl/object_array.rb
+- lib/json_factory/dsl/object_if.rb
 - lib/json_factory/errors.rb
 - lib/json_factory/json_builder.rb
 - lib/json_factory/railtie.rb

data/examples/readme_examples.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/json_factory'
-
-# test data
-test_object1 = OpenStruct.new(id: '001', name: 'TestObject2')
-test_object2 = OpenStruct.new(id: '002', name: 'TestObject3')
-test_object = OpenStruct.new(id: '1', name: 'TestObject1', description: 'Test2', test_objects: [test_object1, test_object2])
-
-factory = <<-RUBY
-  object! do
-    object!(:data) do
-      member!(:id, object.id)
-      member!(:name, object.name)
-      member!(:test_array) do
-        array!(object.test_objects) do |test_object|
-          member!(:id, test_object.id)
-          member!(:name, test_object.name)
-        end
-      end
-    end
-  end
-RUBY
-
-# create context object
-context = JSONFactory::Context.new(object: test_object)
-
-puts JSONFactory::JSONBuilder.new(factory, context).build
-
-factory = <<-RUBY
-  array! objects do |test_object|
-    member!(:id, test_object.id)
-    member!(:name, test_object.name)
-  end
-RUBY
-# create context object
-context = JSONFactory::Context.new(objects: [test_object1, test_object2])
-
-puts JSONFactory::JSONBuilder.new(factory, context).build