venduitz 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6dac980ab2b8be2b8abf9dbeb46e7d3cfc65a12
-  data.tar.gz: 313d678a9e19b38b8974cf7e4b87b81e287839cd
+  metadata.gz: 6cc6a028fa63bd40f96535d661fc2a8452d96148
+  data.tar.gz: b583d6e4bf160b0b4b7c705439ef9f43711aed07
 SHA512:
-  metadata.gz: c65507fd4c7003b689382b8e863f2ea5ae0071035df5a18046df8e0144cfcd1a44f40d64392ec8e6b708deb195c7e9c8c60e83cc05caa46fe0bf8b545b468057
-  data.tar.gz: 311d28bda3f9754a84dc59c354dc623f8b84f06ad6512626152ede825c8f9801b28e2a77ea96d722b749f4336df12540fd752638f5231e8546497d9f0488b211
+  metadata.gz: 96466bc3eb64cc8bdb8b6f3f244168c644c19d617c8db78d0a0f8e9229ee3e5754a9156ea7e6c3574455ed55fe093ed4c0431c6817a412f50fb0acef051afa94
+  data.tar.gz: ee9aeb8158cb506316a62471ee525f205bdc4b184f65e518268942f524bf368dfc836a9ff5346374b6112f5637d60f2b2bbf1dc0482c0a8c96ae9a15b6c29b52

data/.gitignore

@@ -1,2 +1,2 @@
-*.gemspec
+*.gem
 .DS_Store

data/Gemfile

@@ -1,2 +1,9 @@
+# Source
 source 'https://rubygems.org'
+
+# Some test dependencies
+gem 'grape'
+gem 'rack-test'
+
+# Add the Gem dependencies
 gemspec

data/Gemfile.lock

@@ -1,16 +1,56 @@
 PATH
   remote: .
   specs:
-    venduitz (0.0.0)
+    venduitz (0.1.0)
       multi_json
       oj
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
-    multi_json (1.11.3)
+    enumerable-lazy (0.0.1)
+    equalizer (0.0.11)
+    grape (0.16.2)
+      activesupport
+      builder
+      hashie (>= 2.1.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      mustermann19 (~> 0.4.3)
+      rack (>= 1.3.0)
+      rack-accept
+      virtus (>= 1.0.0)
+    hashie (3.4.4)
+    i18n (0.7.0)
+    ice_nine (0.11.2)
+    json (1.8.3)
+    minitest (5.8.4)
+    multi_json (1.12.0)
+    multi_xml (0.5.5)
+    mustermann19 (0.4.3)
+      enumerable-lazy
     oj (2.15.0)
+    rack (1.6.4)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -24,11 +64,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  grape
+  rack-test
   rspec (~> 3.0)
   venduitz!
 

data/README.md

@@ -1,4 +1,4 @@
-# Venduitz [![Build Status](https://travis-ci.org/gabrielcorado/venduitz.svg?branch=develop)](https://travis-ci.org/gabrielcorado/venduitz)
+# Venduitz [![Build Status](https://travis-ci.org/gabrielcorado/venduitz.svg?branch=develop)](https://travis-ci.org/gabrielcorado/venduitz) [![Gem Version](https://badge.fury.io/rb/venduitz.svg)](https://badge.fury.io/rb/venduitz)
 A simple JSON-only(until now) template engine, with focus on performance for better Restful-APIs.
 
 ## How to use it
@@ -14,6 +14,14 @@ gem 'venduitz'
 ```ruby
 require 'venduitz'
 
+class MetaView < Venduitz::View
+  # Define the MEta view properties
+  prop :current, -> (search) { search.current_page }
+  prop :total, -> (search) { search.total_count }
+  prop :total_pages
+  prop :per_page
+end
+
 # Image view
 class ImageView < Venduitz::View
   # Define the view properties
@@ -31,18 +39,32 @@ class ProductView < Venduitz::View
   prop :price
 
   # Also some collections
-  collection :images, ImageView, -> (product) { product.variants.images }
+  collection :images, ImageView, value: -> (product) { product.variants.images }
 
   # You could also pass a property as a proc
   # In this case I will use the ImageView again
   prop :cover, -> (product) { ImageView.generate(product.cover) }
 end
 
+# Its also possible to exclude collection/prop values when generating it
+# in this way you could generate a Ember-like result
+class SearchView < Venduitz::View
+  # Define the view properties
+  prop :meta, -> (search) { MetaView.generate(search) }
+
+  collection :products, ProductView, value: -> (search) { search.products }, exclude: [:images]
+  collection :images, ImageView, value: -> (search) { search.products.images }
+end
+
 # Get your Object ready
-product = Product.first
+search = Product.search 'Hello'
 
 # Transform it to JSON!
-res = ProductView.to_json(product)
+res = SearchView.to_json(search)
+
+# OR... If you don't want to show the images for this search
+# just exclude them in the generation method
+res = SearchView.to_json(search, [:images])
 
 # Return to your framwork
 [200, {'Content-Type' => 'application/json'}, res]

data/lib/venduitz/grape.rb

@@ -0,0 +1,17 @@
+#
+module Venduitz
+  #
+  module Grape
+    # Call method
+    def self.call(object, env)
+      # Define the Venduitz representer
+      representer = env['api.endpoint'].options.fetch(:route_options, {})[:venduitz]
+
+      # Must define the Representer in the endpoint
+      raise 'Must define the Venduitz in the endpoind' if representer.nil?
+
+      # Render it!
+      representer.to_json object
+    end
+  end
+end

data/lib/venduitz/version.rb

@@ -2,6 +2,6 @@
 module Venduitz
   # Gem version
   def self.version
-    '0.0.0'.freeze
+    '0.2.0'.freeze
   end
 end

data/lib/venduitz/view.rb

@@ -20,14 +20,15 @@ module Venduitz
       end
 
       # Define a collection for it
-      def collection(name, view, prc = nil)
+      def collection(name, view, opts = {})
         # Initialize it if its necessary
         @collects = {} if @collects.nil?
 
         # Define the collection
         @collects[name] = {
           view: view,
-          value: (prc.nil? ? name : prc)
+          value: (opts.key?(:value) ? opts[:value] : name),
+          excluded: (opts.key?(:exclude) ? opts[:exclude] : [])
         }
       end
 
@@ -35,35 +36,41 @@ module Venduitz
       # based on the properties and the colletions
       # for the specific argument
       # @param {Object} obj This must contain the declared properies and collections
+      # @param {Array} excluded This array contain the keys that will not be added to the result
       # @return {Hash} JSON ready hash containing the specified view fields
-      def generate(obj)
+      def generate(obj, excluded = [])
         # Reset the values to prevent errors
         @props = {} if @props.nil?
         @collects = {} if @collects.nil?
 
+        # Map both props and collects
+        props = @props.select { |prop, value| !excluded.include?(prop) }
+        coll = @collects.select { |prop, value| !excluded.include?(prop) }
+
         # Return the properties
-        res = @props.map do |prop, value|
+        props = props.map do |prop, value|
           next [prop, obj.send(value)] if value.is_a?(Symbol)
           [prop, value.call(obj)]
         end
 
         # Return the collections
-        coll = @collects.map do |collect, info|
+        coll = coll.map do |collect, info|
           values = info[:value].is_a?(Symbol) ? obj.send(info[:value]) : info[:value].call(obj)
           next [collect, []] if values.nil? || values.empty?
-          [collect, values.map {|val| info[:view].to_json(val) }]
+          [collect, values.map {|val| info[:view].generate(val, info[:excluded]) }]
         end
 
         # Return the full hash
-        Hash[res].merge(Hash[coll])
+        Hash[props].merge(Hash[coll])
       end
 
       # Parse it
       # @param {Object} obj This must contain the declared properies and collections
+      # @param {Array} excluded This array contain the keys that will not be added to the result
       # @return {Hash} The JSON string itself
-      def to_json(obj)
+      def to_json(obj, excluded = [])
         # Transform the result into json
-        MultiJson.dump generate(obj)
+        MultiJson.dump generate(obj, excluded)
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,8 +1,54 @@
 # Include Venduitz
 require 'venduitz'
+require 'rack/test'
 
 # Rspec conf
 RSpec.configure do |config|
   config.order = 'random'
   config.seed = '12345'
+  config.include Rack::Test::Methods
+end
+
+# Nested
+class NestedView < Venduitz::View
+  prop :kind
+  prop :main, -> (o) { SubSampleView.generate(o.main) }
+end
+
+# Sub sample view
+class SubSampleView < Venduitz::View
+  prop :name
+  prop :other
+end
+
+# Sample view
+class SampleView < Venduitz::View
+  # Define the property
+  prop :kind
+  prop :class, -> (o) { o.class }
+  collection :subs, SubSampleView, exclude: [:other]
+end
+
+# Excluded SampleView
+
+# Sample Class
+class Sample
+  #
+  attr_accessor :subs, :main
+
+  #
+  def kind
+    'Nice!'
+  end
+end
+
+# Sub Sample class
+class SubSample
+  def name
+    'Wow!'
+  end
+
+  def other
+    'Here I come!'
+  end
 end

data/spec/venduitz/grape_spec.rb

@@ -0,0 +1,31 @@
+# Dependencies
+require 'spec_helper'
+require 'venduitz/grape'
+require 'grape'
+
+#
+describe Venduitz::Grape do
+  # Create a Grape APP
+  let(:app) { Class.new(Grape::API) }
+
+  # Define the app configs
+  before do
+    app.format :json
+    app.formatter :json, Venduitz::Grape
+  end
+
+  #
+  it 'should generate the response for the Grape endpoint' do
+    # Generate the JSON object
+    app.get('/venduitz', venduitz: SubSampleView) do
+      # Return the proper object
+      SubSample.new
+    end
+
+    # Execute it
+    get '/venduitz'
+
+    # Expectations
+    expect(last_response.body).to eq("{\"name\":\"Wow!\",\"other\":\"Here I come!\"}")
+  end
+end

data/spec/venduitz/view_spec.rb

@@ -1,45 +1,12 @@
 # Include the helper
 require 'spec_helper'
 
-# Nested
-class NestedView < Venduitz::View
-  prop :kind
-  prop :main, -> (o) { SubSampleView.generate(o.main) }
-end
-
-# Sub sample view
-class SubSampleView < Venduitz::View
-  prop :name
-end
-
-# Sample view
-class SampleView < Venduitz::View
-  # Define the property
-  prop :kind
-  prop :class, -> (o) { o.class }
-  collection :subs, SubSampleView
-end
-
-# Sample Class
-class Sample
-  #
-  attr_accessor :subs, :main
-
-  #
-  def kind
-    'Nice!'
-  end
-end
-
-# Sub Sample class
-class SubSample
-  def name
-    'Wow!'
-  end
-end
-
 #
 describe Venduitz::View do
+  #
+  let(:obj) { Sample.new }
+  let(:sub_obj) { o = Sample.new; o.subs = [SubSample.new]; o }
+
   #
   it 'should define the properties' do
     expect(SampleView.props[:kind]).to eq(:kind)
@@ -58,22 +25,25 @@ describe Venduitz::View do
     res = SubSampleView.to_json(SubSample.new)
 
     # Expectations
-    expect(res).to eq("{\"name\":\"Wow!\"}")
+    expect(res).to eq("{\"name\":\"Wow!\",\"other\":\"Here I come!\"}")
   end
 
   #
-  it 'should generate the JSON of a compund view' do
-    # Initialize the object
-    obj = Sample.new
+  it 'should exclude values from the view' do
+    # Gen the JSON
+    res = SubSampleView.to_json(SubSample.new, [:other])
 
-    # Add a sub object
-    obj.subs = [SubSample.new]
+    # Expectations
+    expect(res).to eq("{\"name\":\"Wow!\"}")
+  end
 
+  #
+  it 'should generate the JSON of a compund view' do
     # Generate the JSON object
-    res = SampleView.to_json(obj)
+    res = SampleView.to_json(sub_obj)
 
     # Expectations
-    expect(res).to eq("{\"kind\":\"Nice!\",\"class\":\"Sample\",\"subs\":[\"{\\\"name\\\":\\\"Wow!\\\"}\"]}")
+    expect(res).to eq("{\"kind\":\"Nice!\",\"class\":\"Sample\",\"subs\":[{\"name\":\"Wow!\"}]}")
   end
 
   #
@@ -90,7 +60,7 @@ describe Venduitz::View do
       res = NestedView.to_json(obj)
 
       # Expectations
-      expect(res).to eq("{\"kind\":\"Nice!\",\"main\":{\"name\":\"Wow!\"}}")
+      expect(res).to eq("{\"kind\":\"Nice!\",\"main\":{\"name\":\"Wow!\",\"other\":\"Here I come!\"}}")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: venduitz
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gabriel Corado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -65,9 +65,11 @@ files:
 - Gemfile.lock
 - README.md
 - lib/venduitz.rb
+- lib/venduitz/grape.rb
 - lib/venduitz/version.rb
 - lib/venduitz/view.rb
 - spec/spec_helper.rb
+- spec/venduitz/grape_spec.rb
 - spec/venduitz/view_spec.rb
 - venduitz.gemspec
 homepage: http://github.com/gabrielcorado/venduitz