render_json_rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 567856bf688b4a87ee7a035fc524dd787207586ad4d0d4ca1f68fd744f4d46a6
-  data.tar.gz: 5bb5f2432aacbf4fc845a047ed908bd51f6baabd8955d35e8956561358bf7520
+  metadata.gz: 90cc1574d9f07dd9306bb4416625ad680c8a2777bd62de9529b7a110576d6928
+  data.tar.gz: be85fbe2ca6984d1efe32ad8531b6913d755761259c9cbb143b007663fb59340
 SHA512:
-  metadata.gz: b074eec3f1814117676089f1358b90326740ca3549d9d63acc955da4cfec7dc40561077ae3a6c5e1755b1ce29af906750cfdf2b005bdfc353c5182eb48ea87da
-  data.tar.gz: ea6691bdbbc4a007e781dc79c85d9b4e20c508eb3035cf37589da840c9d186444a04148f20a74301875a6ae460901317190d2215021c626afda08c76b1da96a5
+  metadata.gz: b533b034543b5bbce37a7d8d1a039fb94d8c64557c8635a998c7459499868c70cfdd2d593110ca2389d9724dd7f436cfc14d506287e01967e7a9ab0fa3f2347d
+  data.tar.gz: b9ca7bd1f3221de4739824db73dfb5a868bd5725d3528103eee5ff368825d7477eb7700398aef46804d64efccdc749d75da2806d4d01b1150d42c0f255a6fbd6

data/README.md

@@ -1,45 +1,102 @@
 # 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
+  
+  include RenderJsonRails::Concern
+  
+  render_json_config name: :team,
+                     includes: {
+                       users: User
+                     }
+end
+
+class User < ActiveRecord::Base
+  belongs_to :team
+  
+  include RenderJsonRails::Concern
+  
+  render_json_config name: :user,
+                     includes: {
+                       team: Team
+                     }
+end
+```
+
+Dodajemy też w kontrolerze ```teams_controller.rb```
 
 ```ruby
-gem 'render_json_rails', git: 'https://github.com/intum/render_json_rails'
+  include RenderJsonRails::Helper
+  
+  def index
+    @team = Team.all
+    respond_to do |format|
+      format.html
+      format.json { render_json @team }
+    end
+  end
+```  
+  
+i możemy już otrzymać JSON team-u wraz z userami
+
+```html
+http://example.test/teams/1.json?include=users
+```
 
-# or
+możemy też określić jakie pola mają być w json
 
-source "https://rubygems.pkg.github.com/intum" do
-  gem "render_json_rails"
-end
+```html
+http://example.test/teams/1.json?fields[team]=name,description
 ```
 
-And then execute:
+i możemy łączyć to z include
 
-    $ bundle install
+```html
+http://example.text/teams/1.json?fields[team]=name,description&fields[user]=email,name&include=users
+```
 
-Or install it yourself as:
+## Pełny opis ```render_json_config```
 
-    $ gem install render_json_rails
+```ruby
+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
+   users: Users,
+   cateogry: Category
+  }
+```
 
-## Usage
+## Installation
 
-TODO: Write usage instructions here
+Add this line to your application's Gemfile:
 
-## Development
+```ruby
+gem 'render_json_rails', git: 'https://github.com/intum/render_json_rails'
+```
 
-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.
+And then execute:
+
+    $ bundle install
 
-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).
+Or install it yourself as:
+
+    $ gem install render_json_rails
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/render_json_rails.
+Bug reports and pull requests are welcome on GitHub at https://github.com/intum/render_json_rails.
+
 
+## TMP
 
 Tworzenie gema
 

data/lib/render_json_rails/version.rb

@@ -1,3 +1,3 @@
 module RenderJsonRails
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 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'"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_json_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Marcin
@@ -29,7 +29,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: {}