venduitz 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6dac980ab2b8be2b8abf9dbeb46e7d3cfc65a12
+  data.tar.gz: 313d678a9e19b38b8974cf7e4b87b81e287839cd
+SHA512:
+  metadata.gz: c65507fd4c7003b689382b8e863f2ea5ae0071035df5a18046df8e0144cfcd1a44f40d64392ec8e6b708deb195c7e9c8c60e83cc05caa46fe0bf8b545b468057
+  data.tar.gz: 311d28bda3f9754a84dc59c354dc623f8b84f06ad6512626152ede825c8f9801b28e2a77ea96d722b749f4336df12540fd752638f5231e8546497d9f0488b211

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+script:
+  - bundle exec rspec

data/Dockerfile

@@ -0,0 +1,17 @@
+# Ruby image
+FROM ruby
+
+# Install bundler
+RUN gem install bundler --no-ri --no-rdoc
+
+# Make app folder
+RUN mkdir venduitz/
+
+# Set as workdir
+WORKDIR venduitz/
+
+# Add the full source
+ADD . .
+
+# Install!
+RUN bundle install

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    venduitz (0.0.0)
+      multi_json
+      oj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    multi_json (1.11.3)
+    oj (2.15.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.0)
+  venduitz!
+
+BUNDLED WITH
+   1.12.1

data/README.md

@@ -0,0 +1,55 @@
+# Venduitz [![Build Status](https://travis-ci.org/gabrielcorado/venduitz.svg?branch=develop)](https://travis-ci.org/gabrielcorado/venduitz)
+A simple JSON-only(until now) template engine, with focus on performance for better Restful-APIs.
+
+## How to use it
+
+### Install
+```ruby
+gem install venduitz
+# OR...
+gem 'venduitz'
+```
+
+### Define your views
+```ruby
+require 'venduitz'
+
+# Image view
+class ImageView < Venduitz::View
+  # Define the view properties
+  prop :url
+  prop :width
+  prop :height
+  prop :alt
+end
+
+# Product view
+class ProductView < Venduitz::View
+  # Define the view properties
+  prop :name
+  prop :sku
+  prop :price
+
+  # Also some collections
+  collection :images, ImageView, -> (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
+
+# Get your Object ready
+product = Product.first
+
+# Transform it to JSON!
+res = ProductView.to_json(product)
+
+# Return to your framwork
+[200, {'Content-Type' => 'application/json'}, res]
+```
+
+## Development
+* Building the docker container: `docker build -t venduitz .`
+* Running the tests:
+  * With volume: `docker run --rm -it -v (PWD):/venduitz venduitz bundle exec rspec`
+  * Without volume: `docker run --rm -it venduitz bundle exec rspec`

data/lib/venduitz/version.rb

@@ -0,0 +1,7 @@
+#
+module Venduitz
+  # Gem version
+  def self.version
+    '0.0.0'.freeze
+  end
+end

data/lib/venduitz/view.rb

@@ -0,0 +1,70 @@
+#
+module Venduitz
+  #
+  class View
+    # Static methods
+    class << self
+      # Properties
+      attr_reader :props, :collects
+
+      # Define a property for the view
+      # @param {Symbol/String} name Name used as the JSON field
+      # @param {Proc} prc If its necessary pass a Proc to generate
+      #                   the value used  by the generator
+      def prop(name, prc = nil)
+        # Initialize it if its necessary
+        @props = {} if @props.nil?
+
+        # Define!
+        @props[name] = prc.nil? ? name : prc
+      end
+
+      # Define a collection for it
+      def collection(name, view, prc = nil)
+        # Initialize it if its necessary
+        @collects = {} if @collects.nil?
+
+        # Define the collection
+        @collects[name] = {
+          view: view,
+          value: (prc.nil? ? name : prc)
+        }
+      end
+
+      # This method will generate the hash object
+      # based on the properties and the colletions
+      # for the specific argument
+      # @param {Object} obj This must contain the declared properies and collections
+      # @return {Hash} JSON ready hash containing the specified view fields
+      def generate(obj)
+        # Reset the values to prevent errors
+        @props = {} if @props.nil?
+        @collects = {} if @collects.nil?
+
+        # Return the properties
+        res = @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|
+          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) }]
+        end
+
+        # Return the full hash
+        Hash[res].merge(Hash[coll])
+      end
+
+      # Parse it
+      # @param {Object} obj This must contain the declared properies and collections
+      # @return {Hash} The JSON string itself
+      def to_json(obj)
+        # Transform the result into json
+        MultiJson.dump generate(obj)
+      end
+    end
+  end
+end

data/lib/venduitz.rb

@@ -0,0 +1,10 @@
+# Initialize the module
+module Venduitz
+end
+
+# Dependencies
+require 'oj'
+require 'multi_json'
+
+# Core
+require 'venduitz/view'

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# Include Venduitz
+require 'venduitz'
+
+# Rspec conf
+RSpec.configure do |config|
+  config.order = 'random'
+  config.seed = '12345'
+end

data/spec/venduitz/view_spec.rb

@@ -0,0 +1,96 @@
+# 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
+  #
+  it 'should define the properties' do
+    expect(SampleView.props[:kind]).to eq(:kind)
+    expect(SampleView.props[:class]).to be_a(Proc)
+  end
+
+  #
+  it 'should define the collections' do
+    expect(SampleView.collects[:subs][:view]).to eq(SubSampleView)
+    expect(SampleView.collects[:subs][:value]).to eq(:subs)
+  end
+
+  #
+  it 'should generate the JSON of a simple view' do
+    # Generate the JSON object
+    res = SubSampleView.to_json(SubSample.new)
+
+    # Expectations
+    expect(res).to eq("{\"name\":\"Wow!\"}")
+  end
+
+  #
+  it 'should generate the JSON of a compund view' do
+    # Initialize the object
+    obj = Sample.new
+
+    # Add a sub object
+    obj.subs = [SubSample.new]
+
+    # Generate the JSON object
+    res = SampleView.to_json(obj)
+
+    # Expectations
+    expect(res).to eq("{\"kind\":\"Nice!\",\"class\":\"Sample\",\"subs\":[\"{\\\"name\\\":\\\"Wow!\\\"}\"]}")
+  end
+
+  #
+  context 'nested' do
+    #
+    it 'should generate the JSON of a simple view' do
+      # Initialize the object
+      obj = Sample.new
+
+      # Add a sub object
+      obj.main = SubSample.new
+
+      # Generate the JSON object
+      res = NestedView.to_json(obj)
+
+      # Expectations
+      expect(res).to eq("{\"kind\":\"Nice!\",\"main\":{\"name\":\"Wow!\"}}")
+    end
+  end
+end

data/venduitz.gemspec

@@ -0,0 +1,27 @@
+#
+require './lib/venduitz/version'
+
+#
+Gem::Specification.new do |s|
+  s.name = 'venduitz'
+  s.version = Venduitz.version
+
+  s.summary = ''
+  s.description = ''
+
+  s.author = 'Gabriel Corado'
+  s.email = 'gabrielcorado@mail.com'
+  s.homepage = 'http://github.com/gabrielcorado/venduitz'
+
+  s.files = `git ls-files`.strip.split("\n")
+  s.executables = Dir["bin/*"].map { |f| File.basename(f) }
+
+  # Dependencies
+  # s.add_dependency 'concurrent-ruby', '~> 1.0'
+  # s.add_dependency 'docker-api', '~> 1.26'
+  s.add_dependency 'multi_json'
+  s.add_dependency 'oj'
+
+  # Development depencies
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: venduitz
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Gabriel Corado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email: gabrielcorado@mail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/venduitz.rb
+- lib/venduitz/version.rb
+- lib/venduitz/view.rb
+- spec/spec_helper.rb
+- spec/venduitz/view_spec.rb
+- venduitz.gemspec
+homepage: http://github.com/gabrielcorado/venduitz
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []