as_json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96ce10484b45434f155d000e40655a2311edce8a7695ca3897a789c257d4a093
+  data.tar.gz: 11f911f102ed127fc2b0524353a57526b1d5bdc28945206ddf2427dc9ea06751
+SHA512:
+  metadata.gz: c210a1a2719335ab603e6e44baa59e2563b98bbd3f82c0790011ae3598edb0a0e56ee9507f333c36cf2515fda91cb4cbaa8737ef1e8521a8e5562763ddf6fba3
+  data.tar.gz: 5e316966a72e7113d57c8c53fe567b23ab6409f2ab53962bb9a6776b55bffcea3982db7fe79f25dc6c74797a8c864ece61387899455e0863786073f288950cbf

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in as_json.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+
+group :development, :test do
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    as_json (0.1.0)
+      activemodel (>= 5.0.7.2)
+      activesupport (>= 5.0.7.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 5.0.7.2)
+  as_json!
+  pry
+  rake (~> 12.0)
+  sqlite3 (>= 1.4.2)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Upscope
+
+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,57 @@
+# AsJson
+[![Build Status](https://travis-ci.org/upscopeio/as_json.svg?branch=master)](https://travis-ci.org/upscopeio/as_json)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/as_json`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'as_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install as_json
+
+## Usage
+Including the `AsJson` module in your models you will have access to the `json_with` method, allowing you to define which attributes/methods should be converted to JSON 
+
+``` ruby
+# app/models/team.rb
+class Team < ApplicationRecord
+  include AsJson
+  
+  json_with :name
+end
+
+
+# app/models/user.rb
+class User < ApplicationRecord
+  include AsJson
+  
+  belongs_to :team
+  
+  json_with :name, team: [:name]
+end
+
+team = Team.create name: 'Acme'
+user = User.create name: 'John Doe', team: team
+user.as_json
+# => {'name' => 'John Doe', 'team' => { 'name' => 'Acme', '_type' => 'team'}, '_type' => 'user' }
+```
+
+## 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/upscopeio/as_json.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc "Run unit tests"
+task default: :test
+
+desc "Test AsJson"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end

data/as_json.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/as_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "as_json"
+  spec.version       = AsJson::VERSION
+  spec.authors       = ["Pablo Fonseca", "Joe d'Elia"]
+  spec.email         = ["pablofonseca777@gmail.com", "joe@delia.is"]
+
+  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/upscopeio/as_json"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", ">= 5.0.7.2"
+  spec.add_dependency "activemodel", ">= 5.0.7.2"
+
+  spec.add_development_dependency "activerecord", ">= 5.0.7.2"
+  spec.add_development_dependency "sqlite3", ">= 1.4.2"
+end

data/bin/console

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'as_json/version'
+require 'as_json/json_encoder'
+require 'as_json/scoped_json_mapper'
+
+require 'active_support/concern'
+require 'active_support/json'
+require 'active_support/core_ext/object'
+
+module AsJson
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def default_json_attributes
+      @default_json_attributes
+    end
+
+    def json_with(*attributes, **kargs)
+      if @default_json_attributes.blank?
+        kargs = { _base: attributes }.merge(kargs)
+        @default_json_attributes = kargs
+      else
+        @default_json_attributes[:_base] += attributes
+        @default_json_attributes = AsJson.merge_default_attributes(
+          @default_json_attributes, kargs
+        )
+      end
+      ScopedJsonMapper.new self
+    end
+  end
+
+  def self.merge_default_attributes(existing, new_attributes)
+    existing.deep_merge(new_attributes) do |_k, oldval, newval|
+      if [oldval, newval].all? { |value| value.is_a?(Array) }
+        oldval + newval
+      elsif oldval.is_a?(Array) && newval.is_a?(Hash)
+        oldval = oldval.map { |k| [k, true] }.to_h
+        oldval.deep_merge newval
+      elsif newval.is_a?(Array) && oldval.is_a?(Hash)
+        newval = newval.map { |k| [k, true] }.to_h
+        oldval.deep_merge newval
+      else
+        newval
+      end
+    end
+  end
+
+  def as_json(opts = {})
+    JsonEncoder.new(self, opts).json
+  end
+end

data/lib/as_json/json_encoder.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module AsJson
+  class JsonEncoder
+    def initialize(object, options)
+      @object = object
+      @options = as_json_options(options)
+      @subobject_attributes = {}
+    end
+
+    def json
+      json = attributes_to_encode.map do |attribute, method|
+        if attribute == method && @object.respond_to?(method)
+          [clean_json_key(attribute.to_s), @object.send(method).as_json(subobjects_as_json_options(attribute))]
+        else
+          value = method.is_a?(Proc) ? @object.instance_exec(&method) : @object.send(method)
+          [clean_json_key(attribute.to_s), value.as_json(subobjects_as_json_options)]
+        end
+      end.to_h
+
+      json['id'] = @object.hashed_id if @object.respond_to?(:hashed_id) && json['id'].blank?
+      json = json.sort_by { |k, _v| k == 'id' ? '_id' : k }.to_h
+      json['_type'] = @object.class.name.underscore
+      json.except(*[@options[:without] || []].flatten.map(&:to_s))
+    end
+
+    private
+
+    def subobjects_as_json_options(object = nil)
+      options = {}
+      options.merge!({ _default_attributes: @subobject_attributes[object.to_sym] }) if object && @subobject_attributes[object.to_sym]
+      options.merge!(@options.except(:_default_attributes, :only, :without, :with))
+    end
+
+    def clean_json_key(key)
+      key = key[0..-2] if key.end_with?('?')
+      key
+    end
+
+    def as_json_options(opts)
+      opts[:_default_attributes] ||= @object.class.default_json_attributes
+      return opts if opts[:with_only].blank?
+
+      opts[:with] = opts[:with_only]
+      opts[:only] = opts[:with_only]
+      opts
+    end
+
+    def attributes_to_encode
+      attrs = [@options[:with] || []].flatten.map { |attr| [attr, attr] }
+      add_defaults_to_attributes(attrs, @options[:_default_attributes]) if @options[:_default_attributes].present?
+
+      attrs = attrs.select { |attr, _| attr.in? [@options[:only]].flatten } if @options[:only].present?
+      attrs = attrs.reject { |attr, _| attr.in? [@options[:without]].flatten } if @options[:without].present?
+      attrs
+    end
+
+    def add_defaults_to_attributes(attrs, default_attributes)
+      default_attributes.each do |scope, scoped_attributes|
+        if scope == :_base
+          # These are just default attributes
+          attrs.push(*scoped_attributes.map { |a| [a, a] })
+        elsif (scoped_attributes.is_a?(Array) || scoped_attributes.is_a?(Hash)) && !scope.to_s.start_with?('with_')
+          # These are associations with sub configuration
+          attrs.push([scope, scope])
+          @subobject_attributes[scope] = if scoped_attributes.is_a?(Hash)
+                                           scoped_attributes
+                                         else
+                                           { _base: scoped_attributes }
+                                         end
+        elsif !scope.to_s.start_with?('with_')
+          # These are aliases for a different method
+          attrs.push([scope, scoped_attributes == true ? scope : scoped_attributes])
+        elsif @options[scope] || @options[:with_everything] == true
+          # This is if the options include with_xyz
+          scoped_attributes = { _base: [scoped_attributes].flatten } unless scoped_attributes.is_a?(Hash)
+          add_defaults_to_attributes attrs, scoped_attributes
+        end
+      end
+    end
+  end
+end

data/lib/as_json/scoped_json_mapper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module AsJson
+  class ScopedJsonMapper
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def method_missing(name, *args, **kargs)
+      @klass.json_with "with_#{name}": kargs.merge(args.map { |key| [key, true] }.to_h)
+    end
+
+    def respond_to_missing?
+      true
+    end
+  end
+end

data/lib/as_json/version.rb

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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: as_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pablo Fonseca
+- Joe d'Elia
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.7.2
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.7.2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.7.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description: Write a longer description or delete this line.
+email:
+- pablofonseca777@gmail.com
+- joe@delia.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- as_json.gemspec
+- bin/console
+- bin/setup
+- lib/as_json.rb
+- lib/as_json/json_encoder.rb
+- lib/as_json/scoped_json_mapper.rb
+- lib/as_json/version.rb
+homepage: https://github.com/upscopeio/as_json
+licenses: []
+metadata:
+  homepage_uri: https://github.com/upscopeio/as_json
+  source_code_uri: https://github.com/upscopeio/as_json
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: Write a short summary, because RubyGems requires one.
+test_files: []