render_json_rails 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b82eabebc8a9b20c855e8f75f77fce6bf92105cd07de76f5e377a935114bb6b1
+  data.tar.gz: 175b1a4817a38e2c768c5b8827fe0d020043721d6998d73c9c0fafe063479cbf
+SHA512:
+  metadata.gz: 2dfaad84541f4d4e07e1dd4b16695ab06ae8345f768ac1defe288d188f3e4771a82d5d56812d3d14198d9ab1d66de84fc8138e7a5a9ff228993e680da1546c41
+  data.tar.gz: a7d110349b9fd3e84366676f42963914cc74cd071e9af54da9181bf3761e786516405427331bea4a648c14844b085f505ec488371ad2c81c5981b8980e4aef8d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in render_json_rails.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marcin
+
+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,51 @@
+# RenderJsonRails
+
+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/render_json_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'render_json_rails', git: 'https://github.com/intum/render_json_rails'
+
+# or
+
+source "https://rubygems.pkg.github.com/intum" do
+  gem "render_json_rails"
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install render_json_rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/render_json_rails.
+
+
+Tworzenie gema
+
+```
+gem build render_json_rails.gemspec
+
+gem push --key github --host https://rubygems.pkg.github.com/intum render_json_rails-0.1.XXX.gem
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,7 @@
+require "render_json_rails/version"
+require "render_json_rails/helper"
+require "render_json_rails/concern"
+
+module RenderJsonRails
+  class Error < StandardError; end
+end

data/lib/render_json_rails/concern.rb

@@ -0,0 +1,95 @@
+module RenderJsonRails
+  module Concern
+    extend ActiveSupport::Concern
+
+    # http://marcin.xxx.test/api/organize/questions/2.json?formatted=yes&include=last_answers,last_answers.user&fields[question]=id&fields[user]=email,login,get_name
+    # http://marcin.xxx.test/api/organize/questions/2.json?formatted=yes&include=last_answers,team,team.questions
+
+    # http://marcin.yyy.test/xx/55200174.json?formatted=yes&mass_fiscal_print=yes
+    # http://marcin.yyy.test/xx/55200174.json?formatted=yes&fields[invoice_position]=id,fiscal_short_name
+    # http://marcin.yyy.test/yy/uu.json?formatted=yes&fields[payment]=id
+    # http://marcin.yyy.test/yy/uu.json?formatted=yes&fields[payment]=id&include=invoices,payment_connections
+
+    class_methods do
+      # Metoda przygotowuje parametry `options` do generowania json-a
+      # `methods` to dodatkowe metody które domyślnie będą wyświetlane w jsonie
+      # `allowed_methods` definiuje metody, które możemy wymienić w `fields` i wtedy
+      #  zostaną one wyświelone w json-ie
+      # TODO:
+      # [ ] spradzanie czy parametry "fields" i "include" sa ok i jesli nie to error
+      def default_json_options(name:, fields: nil, except: nil, methods: nil, allowed_methods: nil)
+        # name ||= self.name.underscore.gsub('/', '_')
+        # raise self.name.underscore.gsub('/', '_')
+        except ||= [:account_id, :agent, :ip]
+
+        options = {}
+        if fields && fields[name].present?
+          options[:only] = fields[name].split(',').find_all{ |el| !except.include?(el.to_sym) }
+          options[:methods] = methods&.find_all{ |el| options[:only].include?(el.to_s) }
+          if allowed_methods
+            options[:methods] = (options[:methods] || []) | allowed_methods.find_all{ |el| options[:only].include?(el.to_s) }
+          end
+        else
+          options[:except] = except
+          options[:methods] = methods
+        end
+        options
+      end
+
+      def render_json_config(config)
+        @render_json_config = config
+        # @render_json_config[:methods] = [:image]
+      end
+
+      # rubocop:disable Lint/UnusedMethodArgument
+      def render_json_options(includes: nil, fields: nil, additional_config: nil)
+        raise "należy skonfigurowac render_json metodą: render_json_config" if !defined?(@render_json_config)
+
+        options = default_json_options(
+          name: @render_json_config[:name].to_s,
+          fields: fields,
+          except: @render_json_config[:except],
+          methods: @render_json_config[:methods],
+          allowed_methods: @render_json_config[:allowed_methods]
+        )
+
+        if includes
+          include_options = []
+          @render_json_config[:includes].each do |name, klass|
+            if includes.include?(name.to_s)
+              includes2 = RenderJsonRails::Concern.includes_for_model(includes: includes, model: name.to_s)
+              # raise includes2.inspect + ' ' + includes.inspect
+              include_options << { name => klass.render_json_options(includes: includes2, fields: fields) }
+            end
+          end if @render_json_config[:includes]
+
+          # if includes.include?('questions')
+          #   includes2 = RenderJsonRails::Concern.includes_for_model(includes: includes, model: 'questions')
+          #   # raise includes2.inspect + ' ' + includes.inspect
+          #   include_options << { questions: Organize::Question.render_json_options(includes: includes2, fields: fields) }
+          # end
+          options[:include] = include_options
+        end
+
+        options
+      end # render_json_options
+      # rubocop:enable Lint/UnusedMethodArgument
+
+
+    end # class_methods
+
+    def self.includes_for_model(includes:, model:)
+      # include.split(',')
+      # includes.delete(to_remove)
+      includes = includes.map do |el|
+        if el.start_with?(model + '.')
+          el = el.gsub(/^#{model}\./, '')
+        else
+          el = nil
+        end
+      end
+      includes.find_all{ |el| el.present? }
+      # raise includes.to_json
+    end
+  end
+end

data/lib/render_json_rails/helper.rb

@@ -0,0 +1,47 @@
+module RenderJsonRails
+  module Helper
+    # https://jsonapi.org/format/#fetching-sparse-fieldsets
+    # https://jsonapi.org/examples/
+    # https://jsonapi-resources.com/v0.10/guide/serializer.html#include
+    # http://xxx.yyyy.test/banking/object1/758449.json?formatted=1&fields[payment]=id,price&fields[invoice]=price_gross&fields[payment_connection]=amount&include=payment_connections,connectable
+    # parametry:
+    # formatted=1
+    # fields[payment]=id,price
+    # fields[invoice]=price_gross
+    # fields[payment_connection]=amount&
+    # include=payment_connections,connectable
+
+    # http://xxx.yyyy.test/object.json?formatted=yes&fields[invoice]=number,sales_code&fields[invoice_position]=price_gross&include=positions
+    # parametry:
+    # formatted=yes&
+    # fields[invoice]=number,sales_code
+    # fields[invoice_position]=price_gross
+    # include=positions
+    def render_json(object, additional_config: nil, status: nil, location: nil)
+      raise "objekt nie moze byc null" if object == nil
+
+      if object.class.to_s.include?('ActiveRecord_Relation')
+        return render json: [] if !object[0]
+
+        class_object = object[0].class
+      else
+        class_object = object.class
+      end
+      includes = params[:include].to_s.split(',').map{ |el| el.to_s.strip } if params[:include]
+      options = class_object.render_json_options(
+        includes: includes,
+        fields: params[:fields],
+        additional_config: additional_config
+      )
+      if params[:formatted] && !Rails.env.development? || params[:formatted] != 'no' && Rails.env.development?
+        json = JSON.pretty_generate(object.as_json(options))
+        render json: json, status: status, location: location
+      else
+        options[:json] = object
+        options[:status] = status
+        options[:location] = location
+        render options
+      end
+    end
+  end
+end

data/lib/render_json_rails/version.rb

@@ -0,0 +1,3 @@
+module RenderJsonRails
+  VERSION = "0.1.3"
+end

data/render_json_rails.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/render_json_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "render_json_rails"
+  spec.version       = RenderJsonRails::VERSION
+  spec.licenses      = ['MIT']
+  spec.authors       = ["Marcin"]
+  spec.email         = ["marcin@radgost.com"]
+
+  spec.summary       = "Simle JSON render like JonApi"
+  spec.description   = "render json with 'includes' and 'fields' with simple config"
+  spec.homepage      = "https://radgost.com/gems/render_json_rails"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["https://radgost.pl/gems"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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"]
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: render_json_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Marcin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-01 00:00:00.000000000 Z
+dependencies: []
+description: render json with 'includes' and 'fields' with simple config
+email:
+- marcin@radgost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/render_json_rails.rb
+- lib/render_json_rails/concern.rb
+- lib/render_json_rails/helper.rb
+- lib/render_json_rails/version.rb
+- render_json_rails.gemspec
+homepage: https://radgost.com/gems/render_json_rails
+licenses:
+- MIT
+metadata: {}
+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.2
+signing_key: 
+specification_version: 4
+summary: Simle JSON render like JonApi
+test_files: []