reptar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b697d0d18295900df2f1722cb51d71c0a4ce8365
+  data.tar.gz: af8f219da49b99b8ef1fd6d6c09151064e926b8b
+SHA512:
+  metadata.gz: 702b20eaab9fab83269f7596d51f4bef7522a3fdd85539834e5c61140e11152690464688b581d71caf4fe8cc93e39941b94198fc321c90c3dffccebe5d21d6a6
+  data.tar.gz: 68fff94ebf9cfe8be3a8f0487912d156a574203273941af58eba0d40067c6023335696ad724bd097677befa95a8cdc6c3653e995b5a774600ad618a663d42261

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Julio Lopez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,219 @@
+Reptar
+====
+
+Microlibrary for write representations of objects to your JSON APIs.
+
+![Reptar](http://vignette3.wikia.nocookie.net/godzilla/images/4/4c/Reptar.png)
+
+## Installation
+
+Installing Reptar is as simple as running:
+
+```
+$ gem install reptar
+```
+
+Include Reptar in your Gemfile with gem 'reptar' or require it with require 'reptar'.
+
+Usage
+-----
+
+### Attributes
+
+Inherit `Reptar to build your representation, initialize your Reptar class with your object and get your json output with `to_json`. Declare the fields you want to return with `attribute`
+
+```ruby
+UserRep < Reptar
+  attribute :name
+end
+
+user = User.new(name: "Julio")
+UserRep.new(user).to_json
+# => "{\"name\":\"Julio\"}"
+```
+
+You can define multiple attributes with `attributes`
+
+```ruby
+UserRep < Reptar
+  attributes :first_name, :last_name, :email
+end
+
+user = User.new(first_name: "Julio", last_name: "Piero", email: "julio@example.com")
+UserRep.new(user).to_json
+
+# => The json output is:
+{
+  "first_name": "Julio",
+  "last_name": "Piero",
+  "email": "julio@example.com"
+}
+```
+
+If you want to rename an attribute to send a different name in the json output you can use the `key` option.
+
+```ruby
+UserRep < Reptar
+  attribute :name
+  attribute :city, key: :location
+end
+
+user = User.new(name: "Julio", city: "Lima")
+UserRep.new(user).to_json
+
+# => The json output is:
+{
+  "name": "Julio",
+  "location": "Lima"
+}
+```
+
+### Methods
+
+Send your custom methods as attributes to return their results to the json output.
+
+```ruby
+PostRep < Reptar
+  attributes :title, :slug
+
+  def slug
+    title.downcase.gsub(' ', '-')
+  end
+end
+
+post = Post.new(title: "My awesome post")
+PostRep.new(post).to_json
+
+# => The json output is:
+{
+  "title": "My awesome post",
+  "slug": "my-awesome-post"
+}
+```
+
+### Set your root
+
+You can specify a root for prepend a keyname to your ouput, use the `root` option for that.
+
+```ruby
+UserRep.new(user).to_json(root: :user)
+# => The json output is:
+{ 
+  "user": {
+    "first_name": "Julio",
+    "last_name": "Piero",
+    "email": "julio@example.com"
+  }
+}
+```
+
+### Start with an array
+
+You can initialize your representation class with an array of objects to return the output of each one.
+
+```ruby
+UserRep < Reptar
+  attributes :name
+end
+
+user1 = User.new(name: "Julio")
+user2 = User.new(name: "Abel")
+user3 = User.new(name: "Piero")
+users = [user1, user2, user3]
+UserRep.new(users).to_json
+
+# => The json output is:
+[
+  { name: "Julio" },
+  { name: "Abel" },
+  { name: "Piero" }
+]
+```
+
+### Collections
+
+`collection` method is available to be more explicit in your representation.
+
+```ruby
+UserRep < Reptar
+  attribute :name
+  collection :languages
+end
+
+user = User.new(name: "Julio", languages: ["Ruby", "Js", "Go"])
+UserRep.new(user).to_json
+
+# => The json output is:
+{
+  name: "Julio", 
+  languages: ["Ruby", "Js", "Go"]
+}
+```
+
+### Associations
+
+You can associate your representation class with another using the `with` option, this is useful for return a nested output.
+
+```ruby
+UserRep < Reptar
+  attributes :name, :email
+  attribute :company, with: "CompanyRep"
+end
+
+CompanyRep < Reptar  
+  attributes :name, :city
+end
+
+user = User.new(name: "Julio", email: "julio@example.com")
+user.company = Company.new(name: "Codalot", city: "Lima")
+UserRep.new(user).to_json
+
+# => The json output is:
+{
+  name: "Julio",
+  email: "julio@example.com",
+  company: {
+    name: "Codalot",
+    city: "Lima"
+  }
+}
+```
+
+You are free to also use `collection for define your asocciations.
+
+```ruby
+UserRep < Reptar
+  attributes :name, :email
+  collection :posts, with: "PostRep"
+end
+
+PostRep < Reptar
+  attributes :title, :content
+end
+
+user = User.new(name: "Julio", email: "julio@example.com")
+user.posts << Post.new(title: "Awesome title 1", content: "lorem lipsum")
+user.posts << Post.new(title: "Awesome title 2", content: "lorem lipsum")
+user.posts << Post.new(title: "Awesome title 3", content: "lorem lipsum")
+UserRep.new(user).to_json
+
+# => The json output is:
+{
+  name: "Julio",
+  email: "julio@example.com",
+  posts: [
+    {
+      title: "Awesome title 1",
+      content: "lorem lipsum"
+    },
+    {
+      title: "Awesome title 2",
+      content: "lorem lipsum"
+    },
+    {
+      title: "Awesome title 3",
+      content: "lorem lipsum"
+    }
+  ]
+}
+```

data/lib/reptar.rb

@@ -0,0 +1,70 @@
+# Copyright (c) 2015 Julio Lopez
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+require "json"
+
+class Reptar
+  VERSION = "1.0.0"
+
+  class << self; attr_reader :nodes; end
+
+  def self.inherited(klass)
+    klass.instance_variable_set("@nodes", {})
+  end
+
+  def self.attribute(name, options = {})
+    @nodes[name] = options
+  end
+
+  def self.attributes(*attributes)
+    attributes.each{ |e| @nodes[e] = nil }
+  end
+
+  def self.method_missing(method_name, *args)
+    method_name == :collection ? self.send(:attribute, *args) : super
+  end
+
+  def initialize(object)
+    @object = object
+  end
+
+  def method_missing(method_name)
+    @object.respond_to?(method_name) ? @object.send(method_name) : super
+  end
+
+  def to_json(options = {})
+    root = options[:root]
+    (root ? { root => representable } : representable).to_json
+  end
+
+  def representable
+    return nil unless @object
+    @object.is_a?(Array) ? @object.map{|e| self.class.new(e).build_hash } : build_hash
+  end
+
+  def build_hash
+    self.class.nodes.each_with_object({}) do |(name, options), hash|
+      rep = options[:with] if options
+      res = @object.respond_to?(name) ? @object.send(name) : self.send(name)
+      res = Object.const_get(rep).new(res).representable if rep
+      name = options[:key] if options && options[:key]
+      hash[name] = res
+    end
+  end
+end

data/reptar.gemspec

@@ -0,0 +1,20 @@
+require "./lib/reptar"
+
+Gem::Specification.new do |s|
+  s.name              = "reptar"
+  s.version           = Reptar::VERSION
+  s.summary           = "Microlibrary for write representations of objects to your JSON APIs."
+  s.description       = "Microlibrary for write representations of objects to your JSON APIs."
+  s.authors           = ["Julio Lopez"]
+  s.email             = ["ljuliom@gmail.com"]
+  s.homepage          = "http://github.com/TheBlasfem/reptar"
+  s.files = Dir[
+    "LICENSE",
+    "README.md",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/**/*.rb"
+  ]
+  s.license           = "MIT"
+  s.add_development_dependency "cutest", "1.1.3"
+end

data/test/test_reptar.rb

@@ -0,0 +1,287 @@
+require File.expand_path("../lib/reptar", File.dirname(__FILE__))
+require "ostruct"
+
+User = OpenStruct
+Post = OpenStruct
+Company = OpenStruct
+
+test "single attribute" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+  end
+
+  user = User.new(name: "Julio")
+  result = {name: "Julio"}.to_json
+  assert_equal UserReptar.new(user).to_json, result
+end
+
+test "nil attribute" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+  end
+
+  user = User.new(name: nil)
+  result = {name: nil}.to_json
+  assert_equal UserReptar.new(user).to_json, result
+end
+
+test "changing the key attribute" do
+  PostReptar = Class.new(Reptar) do
+    attribute :slug, key: :url
+  end
+
+  post = Post.new(slug: "this-is-cool")
+  result = {url: "this-is-cool"}.to_json
+  assert_equal PostReptar.new(post).to_json, result
+end
+
+test "multiple attributes" do
+  UserReptar = Class.new(Reptar) do
+    attributes :name, :email
+  end
+
+  user = User.new(name: "Julio", email: "julio@example.com")
+  result = {name: "Julio", email: "julio@example.com"}.to_json
+  assert_equal UserReptar.new(user).to_json, result
+end
+
+test "method as attribute" do
+  PostReptar = Class.new(Reptar) do
+    attribute :slug
+
+    def slug
+      "#{name}-#{id}"
+    end
+  end
+
+  post = Post.new(name: "a-demo-post", id: 1)
+  result = {slug: "a-demo-post-1"}.to_json
+  assert_equal PostReptar.new(post).to_json, result
+end
+
+test "aplying root to single element" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+  end
+
+  user = User.new(name: "Julio")
+  result = {user: {name: "Julio"}}.to_json
+  assert_equal UserReptar.new(user).to_json(root: :user), result
+end
+
+test "aplying root to a multiple elements" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+  end
+
+  users = [User.new(name: "Julio"), User.new(name: "Piero")]
+  result = {
+    users: [
+      { name: "Julio" },
+      { name: "Piero" }
+    ]
+  }.to_json
+  assert_equal UserReptar.new(users).to_json(root: :users), result
+end
+
+test "initialize with an array" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+  end
+
+  users = [User.new(name: "Julio"), User.new(name: "Piero")]
+  
+  result = [
+    { name: "Julio" },
+    { name: "Piero" }
+  ].to_json
+
+  assert_equal UserReptar.new(users).to_json, result
+end
+
+test "array collection" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+    collection :languages
+  end
+
+  user = User.new(name: "Julio", languages: ["Ruby", "Js", "Go"])
+  
+  result = {
+    name: "Julio", 
+    languages: ["Ruby", "Js", "Go"]
+  }.to_json
+
+  assert_equal UserReptar.new(user).to_json, result
+end
+
+test "a single representable association" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+    attribute :company, with: "CompanyReptar"
+  end
+
+  CompanyReptar = Class.new(Reptar) do
+    attribute :name
+  end
+  user = User.new(name: "Julio")
+  user.company = Company.new(name: "Codalot")
+
+  result = {
+    name: "Julio",
+    company: {
+      name: "Codalot"
+    }
+  }.to_json
+
+  assert_equal UserReptar.new(user).to_json, result
+end
+
+test "single representable association as nil" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+    attribute :company, with: "CompanyReptar"
+  end
+  user = User.new(name: "Julio")
+  user.company = nil
+
+  result = {
+    name: "Julio",
+    company: nil
+  }.to_json
+
+  assert_equal UserReptar.new(user).to_json, result
+end
+
+test "array with association" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+    attribute :company, with: "CompanyReptar"
+  end
+
+  CompanyReptar = Class.new(Reptar) do
+    attribute :name
+  end
+
+  users = [
+    User.new(name: "Julio", company: Company.new(name: "Codalot")),
+    User.new(name: "Piero", company: Company.new(name: "Velocis"))
+  ]
+
+  result = [
+    {
+      name: "Julio",
+      company: {
+        name: "Codalot"
+      }
+    },
+    {
+      name: "Piero",
+      company: {
+        name: "Velocis"
+      }
+    }
+  ].to_json
+
+  assert_equal UserReptar.new(users).to_json, result
+end
+
+test "serializes object with collection" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+    collection :posts, with: "PostReptar"
+  end
+
+  PostReptar = Class.new(Reptar) do
+    attribute :title
+  end
+
+  user = User.new(name: "Julio")
+  user.posts = [
+    Post.new(title: "Awesome title"),
+    Post.new(title: "Cats are dominating the world right now")
+  ]
+
+  result = {
+    name: "Julio",
+    posts: [
+      {
+        title: "Awesome title"
+      },
+      {
+        title: "Cats are dominating the world right now"
+      }
+    ]
+  }.to_json
+
+  assert_equal UserReptar.new(user).to_json, result
+end
+
+test "array with representable collections" do
+  UserReptar = Class.new(Reptar) do
+    attribute :name
+    collection :posts, with: "PostReptar"
+  end
+
+  PostReptar = Class.new(Reptar) do
+    attribute :title
+  end
+
+  users = [
+    User.new(
+      name: "Julio",
+      posts: [
+        Post.new(title: "Hi, I'm a dog")
+      ]
+    ),
+    User.new(
+      name: "Piero",
+      posts: [
+        Post.new(title: "I like turtles"),
+        Post.new(title: "Please come back PT!"),
+      ]
+    )
+  ]
+
+  result = [
+    {
+      name: "Julio",
+      posts: [
+        {
+          title: "Hi, I'm a dog"
+        }
+      ]
+    },
+    {
+      name: "Piero",
+      posts: [
+        {
+          title: "I like turtles"
+        },
+        {
+          title: "Please come back PT!"
+        }
+      ]
+    }
+  ].to_json
+
+  assert_equal UserReptar.new(users).to_json, result
+end
+
+test "custom association method" do
+  PostReptar = Class.new(Reptar) do
+    attribute :title
+  end
+
+  UserReptar = Class.new(Reptar) do
+    collection :posts, with: "PostReptar"
+
+    def posts
+      [Post.new(title: "I like turtles")]
+    end
+  end
+
+  user = User.new
+  result = { posts: [{title: "I like turtles" }] }.to_json
+  assert_equal UserReptar.new(user).to_json, result
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: reptar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julio Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+description: Microlibrary for write representations of objects to your JSON APIs.
+email:
+- ljuliom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/reptar.rb
+- reptar.gemspec
+- test/test_reptar.rb
+homepage: http://github.com/TheBlasfem/reptar
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Microlibrary for write representations of objects to your JSON APIs.
+test_files: []