render_json_rails 0.1.8 → 0.2

data/Gemfile

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

data/README.md

@@ -25,6 +25,7 @@ class User < ActiveRecord::Base
 
   render_json_config name: :user,
                      except: [:account_id, :id],
+                     # only: [:login, :email], # jesli wolelibyśmy wymienić pola zamiast je wykluczać przy pomocy "except"
                      default_fields: [:login, :email, :calculated_age],
                      allowed_methods: [:calculated_age],
                      includes: {
@@ -69,15 +70,23 @@ i możemy łączyć to z include
 http://example.text/teams/1.json?fields[team]=name,description&fields[user]=email,name&include=users
 ```
 
+include mogą być zagnieżdżane (po kropce)
+
+```html
+http://example.text/teams/1.json?fields[team]=name,description&fields[user]=email,name&fields[role]=name&include=users,users.roles
+```
+
+Więcej przykładów jest w testach: [test/render_json_rails_test.rb](test/render_json_rails_test.rb)
+
 ## Pełny opis ```render_json_config```
 
 ```ruby
 render_json_config name: :team,
   except: [:account_id, :config], # tych pól nie będzie w json-ie
-  only: [:id, :name], # tylko te pola będą w jsonie (wymiennie z except)
+  only: [:id, :name], # dozwolone pola będą w jsonie (wymiennie z except)
+  methods: [:image], # dozwolone i domyślnie wyświetlone metody, ten parametr warto uzywac tylko, gdy nie ma parametru "default_fields" - przy ustawionym "default_fields" trzeba metody wymienic w allowed_methods
   default_fields: [:id, :name, :members], # domyślnie wyświetlone pola + metody
-  methods: [:image], # ten parametr warto uzywac tylko, gdy nie ma parametru "default_fields" - przy ustawionym "default_fields" trzeba metody wymienic w allowed_methods
-  allowed_methods: [:members], # te metody mogą być dodane przez parametr fileds np: fields[team]=id,members
+  allowed_methods: [:members], # dozwolone metody, mogą być dodane przez parametr fileds np: fields[team]=id,members
   includes: { # to mozna dołączać za pomoca parametru include np include=users,category
    users: Users,
    category: Category

data/Rakefile

@@ -9,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/lib/render_json_rails/concern.rb

@@ -26,7 +26,9 @@ module RenderJsonRails
         if fields && fields[name].present?
           options[:only] = fields[name].split(',').map{ |e| e.to_s.strip.to_sym }.find_all { |el| !except&.include?(el) }
           if only.present?
-            options[:only] = options[:only].find_all { |el| only.include?(el) || allowed_methods&.include?(el) || methods&.include?(el) }
+            options[:only] = options[:only].find_all do |el|
+              only.include?(el) || allowed_methods&.include?(el) || methods&.include?(el)
+            end
           end
           options[:methods] = methods&.find_all { |el| options[:only].include?(el) }
           if allowed_methods
@@ -68,14 +70,14 @@ module RenderJsonRails
 
         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)
-              include_options << { name => klass.render_json_options(includes: includes2, fields: fields) }
+          @render_json_config[:includes]&.each do |model_name, klass|
+            if includes.include?(model_name.to_s)
+              includes2 = RenderJsonRails::Concern.includes_for_model(includes: includes, model: model_name.to_s)
+              include_options << { model_name => klass.render_json_options(includes: includes2, fields: fields) }
             end
-          end if @render_json_config[:includes]
+          end
 
-          options[:include] = include_options
+          options[:include] = include_options if include_options.present?
         end
 
         options = RenderJsonRails::Concern.deep_meld(options, additional_config) if additional_config
@@ -87,23 +89,15 @@ module RenderJsonRails
     end # class_methods
 
     def self.includes_for_model(includes:, model:)
-      includes = includes.map do |el|
-        if el.start_with?(model + '.')
-          el = el.gsub(/^#{model}\./, '')
-        else
-          el = nil
-        end
-      end
+      includes = includes.map { |el| el.gsub(/^#{model}\./, '') if el.start_with?(model + '.') }
       includes.find_all { |el| el.present? }
     end
 
-    private
-
-    def self.deep_meld(h1, h2)
-      h1.deep_merge(h2) do |key, this_val, other_val|
-        if this_val != nil && other_val == nil
+    def self.deep_meld(hh1, hh2)
+      hh1.deep_merge(hh2) do |_key, this_val, other_val|
+        if !this_val.nil? && other_val == nil
           this_val
-        elsif this_val == nil && other_val != nil
+        elsif this_val == nil && !other_val.nil?
           other_val
         elsif this_val.is_a?(Array) && other_val.is_a?(Array)
           this_val | other_val

data/lib/render_json_rails/version.rb

@@ -1,3 +1,3 @@
 module RenderJsonRails
-  VERSION = "0.1.8"
+  VERSION = "0.2"
 end

data/render_json_rails.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   # 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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_json_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: '0.2'
 platform: ruby
 authors:
 - Marcin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md