render_json_rails 0.1.6 → 0.2.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

@@ -9,9 +9,9 @@ Dzięki temu łatwo jest stworzyć backend Json API np. do pracy z Reactem lub V
 
 class Team < ActiveRecord::Base
   has_many :users
-  
+
   include RenderJsonRails::Concern
-  
+
   render_json_config name: :team,
                      includes: {
                        users: User
@@ -20,13 +20,21 @@ end
 
 class User < ActiveRecord::Base
   belongs_to :team
-  
+
   include RenderJsonRails::Concern
-  
+
   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: {
                        team: Team
                      }
+
+  def calculated_age
+    rand(100)
+  end
 end
 ```
 
@@ -34,7 +42,7 @@ Dodajemy też w kontrolerze ```teams_controller.rb```
 
 ```ruby
   include RenderJsonRails::Helper
-  
+
   def index
     @team = Team.all
     respond_to do |format|
@@ -42,8 +50,8 @@ Dodajemy też w kontrolerze ```teams_controller.rb```
       format.json { render_json @team }
     end
   end
-```  
-  
+```
+
 i możemy już otrzymać JSON team-u wraz z userami
 
 ```html
@@ -62,16 +70,28 @@ i możemy łączyć to z include
 http://example.text/teams/1.json?fields[team]=name,description&fields[user]=email,name&include=users
 ```
 
-## Pełny opis ```render_json_config```
+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
+```
+
+## Wiecej przykładów użycia
+
+Więcej przykładów jest w testach: [test/render_json_rails_test.rb](test/render_json_rails_test.rb)
+
+## Wszystkie opcje ```render_json_config```
 
 ```ruby
-render_json_config name: :team, 
+render_json_config name: :team,
   except: [:account_id, :config], # tych pól nie będzie w json-ie
-  methods: [:image], # te metody zostaną dołączone 
-  allowed_methods: [:members], # te 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
+  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
+  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.roles
    users: Users,
-   cateogry: Category
+   category: Category
   }
 ```
 
@@ -91,6 +111,13 @@ Or install it yourself as:
 
     $ gem install render_json_rails
 
+## Tests
+
+```
+rake test
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/intum/render_json_rails.

data/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+# require 'active_support/core_ext/object/blank'
+# require 'active_support'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,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

@@ -17,20 +17,29 @@ module RenderJsonRails
       #  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)
+      def default_json_options(name:, fields: nil, only: nil, except: nil, methods: nil, allowed_methods: nil)
         # name ||= self.name.underscore.gsub('/', '_')
         # raise self.name.underscore.gsub('/', '_')
-        except ||= [:account_id, :agent, :ip]
+        # 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) }
+          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 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
-            options[:methods] = (options[:methods] || []) | allowed_methods.find_all { |el| options[:only].include?(el.to_s) }
+            options[:methods] = (options[:methods] || []) | allowed_methods.find_all { |el| options[:only].include?(el) }
+          end
+          if options[:methods].present? && options[:only].present?
+            options[:methods].each { |method| options[:only].delete(method) }
           end
         else
           options[:except] = except
+          options[:only] = only if only.present?
           options[:methods] = methods
         end
         options
@@ -40,52 +49,61 @@ module RenderJsonRails
         @render_json_config = config
       end
 
-      def render_json_options(includes: nil, fields: nil, additional_config: nil)
+      def render_json_options(includes: nil, fields: nil, override_render_json_config: nil, additional_config: nil)
         raise "należy skonfigurowac render_json metodą: render_json_config" if !defined?(@render_json_config)
 
+        if override_render_json_config
+          current_json_config = @render_json_config.merge(override_render_json_config)
+        else
+          current_json_config = @render_json_config
+        end
+
+        name = current_json_config[:name].to_s
+
+        if (fields.blank? || fields[name].blank?) && current_json_config[:default_fields].present?
+          fields ||= {}
+          fields[name] = current_json_config[:default_fields].join(',')
+        end
+
         options = default_json_options(
-          name: @render_json_config[:name].to_s,
+          name: name,
           fields: fields,
-          except: @render_json_config[:except],
-          methods: @render_json_config[:methods],
-          allowed_methods: @render_json_config[:allowed_methods]
+          only: current_json_config[:only],
+          except: current_json_config[:except],
+          methods: current_json_config[:methods],
+          allowed_methods: current_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)
-              include_options << { name => klass.render_json_options(includes: includes2, fields: fields) }
+          current_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
+
+        options.delete(:methods) if options[:methods].blank?
+
         options
       end # render_json_options
     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/helper.rb

@@ -17,7 +17,7 @@ module RenderJsonRails
     # fields[invoice]=number,sales_code
     # fields[invoice_position]=price_gross
     # include=positions
-    def render_json(object, additional_config: nil, status: nil, location: nil)
+    def render_json(object, override_render_json_config: nil, additional_config: nil, status: nil, location: nil)
       raise "objekt nie moze byc null" if object == nil
 
       if object.class.to_s.include?('ActiveRecord_Relation')
@@ -31,6 +31,7 @@ module RenderJsonRails
       options = class_object.render_json_options(
         includes: includes,
         fields: params[:fields],
+        override_render_json_config: override_render_json_config,
         additional_config: additional_config
       )
       if params[:formatted] && !Rails.env.development? || params[:formatted] != 'no' && Rails.env.development?

data/lib/render_json_rails/version.rb

@@ -1,3 +1,3 @@
 module RenderJsonRails
-  VERSION = "0.1.6"
+  VERSION = "0.2.2"
 end

data/render_json_rails.gemspec

@@ -20,10 +20,12 @@ 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"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "byebug"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: render_json_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.2
 platform: ruby
 authors:
 - Marcin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
-dependencies: []
+date: 2020-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: render json with 'includes' and 'fields' with simple config
 email:
 - marcin@radgost.com
@@ -18,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md