as_json_representations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a524e14de5c1fa45c7f5593476e800e2de0203b
+  data.tar.gz: 38ad660a2b052693ff40b16d99bb7e57da0dcd1f
+SHA512:
+  metadata.gz: 836ce2034db29b36953c6b34ff1f9aeb430a73bc29297fedcdb28aea1e3a745a220c5db7f00094b5f0c7fb726c48d774fc857ca0f7c4d938f8b525ea52de0385
+  data.tar.gz: eb628c99afabb85a16b74c64d2b40615976325ac6d22035adfc0f023c980d1268e3fbe3311cd4c0a8f18c9f73f88b9f605ed173236d2a78f875292a1dd2e1e25

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in as_json_representations.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    as_json_representations (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  as_json_representations!
+  bundler (~> 1.15)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0.pre.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 rjurado01
+
+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,93 @@
+# AsJsonRepresentations
+
+Creates representations of your model data in a simple and clean way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'as_json_representations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install as_json_representations
+
+## Usage
+
+Includes the `AsJsonRepresentations` module into your class and define your representations.  
+Representations are evaluated into class instance object and must returns a `json` object.
+
+```ruby
+class User
+  include AsJsonRepresentations
+
+  attr_accessor :first_name, :last_name, :age, :city
+
+  def initialize(first_name, last_name, age, city)
+    @first_name = first_name
+    @last_name = last_name
+    @age = age
+    @city = city
+  end
+
+  representation :public do |options| # you can pass options
+    {
+      full_name: "#{first_name} #{last_name}",
+      date: options[:date]
+    }
+  end
+
+  representation :private, extend: :public do # you can extends other representations
+    {
+      age: age,
+      city: city.as_json(representation: :basic)
+    }
+  end
+end
+
+# you can define representations in a module
+module CityRepresentations
+  include AsJsonRepresentations
+
+  representation :basic do
+    {
+      name: name
+    }
+  end
+end
+
+class City
+  include CityRepresentations
+
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
+end
+
+city = City.new('Madrid')
+user = User.new('John', 'Doe', 30, city)
+user.as_json(representation: :private, date: '2017-12-21')
+# {:full_name=>"John Doe", :date=>"2017-12-21", :age=>30, :city=>{:name=>"Madrid"}}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/as_json_representations.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/as_json_representations.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'as_json_representations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'as_json_representations'
+  spec.version       = AsJsonRepresentations::VERSION
+  spec.authors       = ['rjurado01']
+  spec.email         = ['rjurado01@gmail.com']
+
+  spec.summary       = 'Creates representations of your model data'
+  spec.description   = 'Creates representations of your model data in a simple and clean way'
+  spec.homepage      = 'https://github.com/rjurado01/as_json_representations'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "as_json_representations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/as_json_representations.rb

@@ -0,0 +1,39 @@
+module AsJsonRepresentations
+  module ClassMethods
+    def representation(name, options={}, &block)
+      @representations ||= {}
+      @representations[name] = options.merge(block: block)
+    end
+
+    def representations
+      @representations
+    end
+
+    def render_representation(object, options)
+      return {} unless (representation = representations[options.delete :representation])
+
+      data = object.instance_exec(options, &representation[:block])
+
+      while representation[:extend] && (representation = representations[representation[:extend]])
+        data = object.instance_exec(
+          options,
+          &representation[:block]
+        ).merge(data)
+      end
+
+      data
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+
+    base.class_eval do
+      eval %{
+        def as_json(options={})
+          #{base}.render_representation(self, options)
+        end
+      }
+    end
+  end
+end

data/lib/as_json_representations/version.rb

@@ -0,0 +1,3 @@
+module AsJsonRepresentations
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: as_json_representations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rjurado01
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: Creates representations of your model data in a simple and clean way
+email:
+- rjurado01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- as_json_representations.gemspec
+- bin/console
+- bin/setup
+- lib/as_json_representations.rb
+- lib/as_json_representations/version.rb
+homepage: https://github.com/rjurado01/as_json_representations
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Creates representations of your model data
+test_files: []