render_json_rails 0.1.4 → 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

@@ -1,51 +1,122 @@
 # 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.
+RenderJsonRails pozwala w łatwy sposób dodać możliwość renderowania JSON z ActiveRecord-ów z zależnościami (has_many itp).
+Dzięki temu łatwo jest stworzyć backend Json API np. do pracy z Reactem lub Vue.js
 
-TODO: Delete this and the text above, and describe your gem
+## Przykład
 
-## Installation
+```ruby
 
-Add this line to your application's Gemfile:
+class Team < ActiveRecord::Base
+  has_many :users
 
-```ruby
-gem 'render_json_rails', git: 'https://github.com/intum/render_json_rails'
+  include RenderJsonRails::Concern
+
+  render_json_config name: :team,
+                     includes: {
+                       users: User
+                     }
+end
+
+class User < ActiveRecord::Base
+  belongs_to :team
+
+  include RenderJsonRails::Concern
 
-# or
+  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
+                     }
 
-source "https://rubygems.pkg.github.com/intum" do
-  gem "render_json_rails"
+  def calculated_age
+    rand(100)
+  end
 end
 ```
 
-And then execute:
+Dodajemy też w kontrolerze ```teams_controller.rb```
 
-    $ bundle install
+```ruby
+  include RenderJsonRails::Helper
+
+  def index
+    @team = Team.all
+    respond_to do |format|
+      format.html
+      format.json { render_json @team }
+    end
+  end
+```
 
-Or install it yourself as:
+i możemy już otrzymać JSON team-u wraz z userami
 
-    $ gem install render_json_rails
+```html
+http://example.test/teams/1.json?include=users
+```
 
-## Usage
+możemy też określić jakie pola mają być w json
 
-TODO: Write usage instructions here
+```html
+http://example.test/teams/1.json?fields[team]=name,description
+```
 
-## Development
+i możemy łączyć to z include
 
-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.
+```html
+http://example.text/teams/1.json?fields[team]=name,description&fields[user]=email,name&include=users
+```
 
-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).
+include mogą być zagnieżdżane (po kropce)
 
-## Contributing
+```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)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/render_json_rails.
+## 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], # 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: Users,
+   category: Category
+  }
+```
 
-Tworzenie gema
+## Installation
+
+Add this line to your application's Gemfile:
 
+```ruby
+gem 'render_json_rails'
 ```
-gem build render_json_rails.gemspec
 
-gem push --key github --host https://rubygems.pkg.github.com/intum render_json_rails-0.1.XXX.gem
+And then execute:
+
+    $ bundle install
+
+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
@@ -38,16 +47,22 @@ module RenderJsonRails
 
       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)
 
+        name = @render_json_config[:name].to_s
+
+        if (fields.blank? || fields[name].blank?) && @render_json_config[:default_fields].present?
+          fields ||= {}
+          fields[name] = @render_json_config[:default_fields].join(',')
+        end
+
         options = default_json_options(
-          name: @render_json_config[:name].to_s,
+          name: name,
           fields: fields,
+          only: @render_json_config[:only],
           except: @render_json_config[:except],
           methods: @render_json_config[:methods],
           allowed_methods: @render_json_config[:allowed_methods]
@@ -55,41 +70,43 @@ 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)
-              # raise includes2.inspect + ' ' + includes.inspect
-              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]
-
-          # 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[:include] = include_options if include_options.present?
         end
 
-        options
-      end # render_json_options
-      # rubocop:enable Lint/UnusedMethodArgument
+        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:)
-      # include.split(',')
-      # includes.delete(to_remove)
-      includes = includes.map do |el|
-        if el.start_with?(model + '.')
-          el = el.gsub(/^#{model}\./, '')
+      includes = includes.map { |el| el.gsub(/^#{model}\./, '') if el.start_with?(model + '.') }
+      includes.find_all { |el| el.present? }
+    end
+
+    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?
+          other_val
+        elsif this_val.is_a?(Array) && other_val.is_a?(Array)
+          this_val | other_val
+        elsif this_val.is_a?(Hash) && other_val.is_a?(Hash)
+          deep_meld(this_val, other_val)
         else
-          el = nil
+          [this_val, other_val]
         end
       end
-      includes.find_all{ |el| el.present? }
-      # raise includes.to_json
     end
   end
-end
+end

data/lib/render_json_rails/helper.rb

@@ -27,7 +27,7 @@ module RenderJsonRails
       else
         class_object = object.class
       end
-      includes = params[:include].to_s.split(',').map{ |el| el.to_s.strip } if params[:include]
+      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],
@@ -44,4 +44,4 @@ module RenderJsonRails
       end
     end
   end
-end
+end

data/lib/render_json_rails/version.rb

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

data/render_json_rails.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Simle JSON API render like JonApi"
   spec.description   = "render json with 'includes' and 'fields' with simple config"
-  spec.homepage      = "https://radgost.com/gems/render_json_rails"
+  spec.homepage      = "https://github.com/intum/render_json_rails"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
@@ -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.4
+  version: '0.2'
 platform: ruby
 authors:
 - Marcin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-01 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
@@ -29,7 +58,7 @@ files:
 - lib/render_json_rails/helper.rb
 - lib/render_json_rails/version.rb
 - render_json_rails.gemspec
-homepage: https://radgost.com/gems/render_json_rails
+homepage: https://github.com/intum/render_json_rails
 licenses:
 - MIT
 metadata: {}
@@ -48,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simle JSON API render like JonApi