json_representations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0f4c994f61bcb22f373780675d65c19c61da4763303faaf18f7c3195c91577b
+  data.tar.gz: aa1436306ae60776d0f0033c29f1e5708582be34f13b2a16c1b2d2ef28a00f66
+SHA512:
+  metadata.gz: cbce25129dcfa28384c1339149f0284090cd93b35a60bb5f7fc63bdb3f19a0f5440b45f1822ec8d271278056a9097c5661208cc00e577b6b3ce4279f175cd1eb
+  data.tar.gz: d1d782de80c1e91bfeb256911aad10231980f397f7afcd64ffe85d09fa9921e4505c8756b26fbd4b3b29a7ed8de73721c398634e484de9afccef354ea6bffb61

data/.github/workflows/rspec.yml

@@ -0,0 +1,26 @@
+---
+name: RSpec
+
+on:
+  push:
+    branches: [ '**' ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.7.2, 2.6.6]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

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

data/.rspec

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

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.2

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    json_representations (1.0.0)
+      activesupport (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (13.0.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.2.14)
+  byebug
+  json_representations!
+  rake (~> 13.0)
+  rspec (~> 3.10)
+
+BUNDLED WITH
+   2.2.14

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,182 @@
+# JsonRepresentations
+[![Gem Version](https://badge.fury.io/rb/json_representations.svg)](https://badge.fury.io/rb/json_representations)
+![Build Status](https://github.com/nosolosoftware/json_representations/actions/workflows/rspec.yml/badge.svg)
+
+Creates representations of your model data in a simple and clean way.
+
+## Features
+
+* Easy to use
+* Easy to define representations
+* Support representations hinheritance
+* Support module definition
+* Support options
+* Support ActiveRecord collection options
+* Faster
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_representations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_representations
+
+## Usage
+
+Includes the `JsonRepresentations` 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 JsonRepresentations
+
+  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 another representations
+    {
+      age: age,
+      city: city.representation(:basic)
+    }
+  end
+end
+
+# you can define representations in a module
+module CityRepresentations
+  include JsonRepresentations
+
+  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.representation(:private, date: '2017-12-21')
+# {:full_name=>"John Doe", :date=>"2017-12-21", :age=>30, :city=>{:name=>"Madrid"}}
+
+user.representation(:private, date: '2017-12-21') # short form
+# {:full_name=>"John Doe", :date=>"2017-12-21", :age=>30, :city=>{:name=>"Madrid"}}
+```
+
+## Modules Inheritance
+
+You can include a module representation into other module like this example:
+
+```ruby
+module ParentRepresentations
+  include JsonRepresentations
+
+  representation :a do {name: name} end
+  representation :b do {name: name} end
+  representation :c do {name: name} end
+end
+
+module ChildRepresentations
+  include ParentRepresentations
+
+  representation :a do # overwrite
+    {color: color}
+  end
+
+  representation :b, extend: true do # extend parent representation with same name
+    {color: color}
+  end
+
+  representation :d, extend: :c do # extend parent representation
+    {color: color}
+  end
+end
+
+class Child
+  include ChildRepresentations
+
+  attr_accessor :color
+
+  def initialize(name, color)
+    @name = name
+    @color = color
+  end
+end
+
+child = Child.new('child', 'red')
+child.representation(:a) # {color: 'red'}
+child.representation(:b) # {name: 'child', color: 'red'}
+child.representation(:c) # {name: 'child'}
+child.representation(:d) # {name: 'child', color: 'red'}
+```
+
+When you includes representation module (parent) into other module (child):
+
+* Parent representations are included
+* If a representation is redefined, it is overwritten
+* You can extend parent representations
+* You must use `extend: true` when use the same name
+
+## ActiveRecord collection options
+
+You can use this ActiveRecord option when you define a representation:
+
+* [includes](https://apidock.com/rails/ActiveRecord/QueryMethods/includes)
+* [eager_load](https://apidock.com/rails/ActiveRecord/QueryMethods/eager_load)
+* [preload](https://apidock.com/rails/ActiveRecord/QueryMethods/preload)
+
+```
+representation :private, includes: [:city]
+  {
+    age: age,
+    city: city.representation(:basic)
+  }
+end
+```
+
+This options will be used on the collection before to serializing it automatically.
+
+## 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/nosolosoftware/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require '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/json_representations.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_representations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'json_representations'
+  spec.version       = JsonRepresentations::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/nosolosoftware/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_dependency 'activesupport', '~> 6.0'
+  spec.add_development_dependency 'bundler', '~> 2.2.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+end

data/lib/json_representations.rb

@@ -0,0 +1,88 @@
+require 'active_support/core_ext/object'
+require 'json_representations/collection.rb'
+
+module JsonRepresentations
+  QUERY_METHODS = %i[includes eager_load preload].freeze
+
+  module ClassMethods
+    def representation(name, options={}, &block)
+      @representations ||= {}
+      @representations[name] = options.merge(name: name, class: self, block: block)
+
+      # copy parent representation options that should be inherited
+      return unless options[:extend]
+      extend_representation_name = options[:extend] == true ? name : options[:extend]
+      extend_representation = (parent_entity || self).representations[extend_representation_name]
+
+      QUERY_METHODS.each do |option|
+        next unless (extend_option_value = extend_representation[option])
+        @representations[name][option] = extend_option_value + (options[option] || [])
+      end
+    end
+
+    def representations
+      @representations
+    end
+
+    def parent_entity
+      @parent_entity
+    end
+
+    def find_representation(name)
+      representations[name] || @parent_entity&.find_representation(name) if name
+    end
+
+    def render_representation(object, representation_name, options)
+      return {} unless (representation = find_representation(representation_name))
+
+      data = {}
+      loop do
+        data = object.instance_exec(
+          options,
+          &representation[:block]
+        ).merge(data)
+
+        representation =
+          if representation[:extend] == true
+            representation[:class].parent_entity&.find_representation(representation[:name])
+          else
+            find_representation(representation[:extend])
+          end
+
+        return data.as_json unless representation
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+
+    base.class_eval do
+      eval %{
+        def representation(name, options={})
+          #{base}.render_representation(self, name.to_sym, options.dup)
+        end
+      }
+
+      def self.included(base)
+        if base.class == Module
+          JsonRepresentations.send(:included, base)
+          base.instance_variable_set :@parent_entity, self
+        else
+          context = self
+          base.define_singleton_method(:representations) { context.representations }
+        end
+      end
+    end
+  end
+end
+
+Array.include(JsonRepresentations::Collection)
+
+if defined?(Mongoid::Criteria)
+  Mongoid::Criteria.include(JsonRepresentations::Collection)
+end
+
+if defined?(ActiveRecord::Relation)
+  ActiveRecord::Relation.include(JsonRepresentations::Collection)
+end

data/lib/json_representations/collection.rb

@@ -0,0 +1,29 @@
+module JsonRepresentations
+  module Collection
+    def self.included(base)
+      base.class_eval do
+        def representation(name=nil, options={})
+          subject = self
+
+          if respond_to?(:klass) && klass.respond_to?(:representations)
+            # call supported methods of ActiveRecord::QueryMethods
+            QUERY_METHODS.each do |method|
+              next unless respond_to? method
+
+              args = klass.representations.dig(name, method)
+
+              # we need to reassign because ActiveRecord returns new object
+              subject = subject.public_send(method, args) if args
+            end
+          end
+
+          return super if respond_to? :super
+
+          subject.map do |item|
+            item.respond_to?(:representation) ? item.representation(name, options) : item
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json_representations/version.rb

@@ -0,0 +1,3 @@
+module JsonRepresentations
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: json_representations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- rjurado01
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.14
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Creates representations of your model data in a simple and clean way
+email:
+- rjurado01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".tool-versions"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_representations.gemspec
+- lib/json_representations.rb
+- lib/json_representations/collection.rb
+- lib/json_representations/version.rb
+homepage: https://github.com/nosolosoftware/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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Creates representations of your model data
+test_files: []