administrate-field-jsonb 0.1.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 74b6d21a2f93c23b057e873aaad220655c3c817d
-  data.tar.gz: 606946be845f50d6b98b5553c5148c812ddad650
+SHA256:
+  metadata.gz: '00360160780ad78be533891d768702812fbb1dde867179a3e29ec4a5c642fa0a'
+  data.tar.gz: 488b361fffa40de1517a2ca7c9e9b526b02212b54bef930faf4463b37d3c86f4
 SHA512:
-  metadata.gz: 3eba72e6e53ec34666eb55b23884d9a9f41f41ed112e82fbb06e16c3d1e6c8083474d476e11b4800b2ed10e09b10788d61724b277178cce6b03837ecadc7fdbf
-  data.tar.gz: 22faae00b2abff4c56d1a4e538ddb4a7213c0d83831e2a2987bf0c4ecc7dce6ac79243b6768131d1a88b76113f462cbd9b2ad79042e7c1a39770c3a9a4305826
+  metadata.gz: c987c1cb1269330ccec85f0ddd61562bc8e7bb1f68ad9bb643475a9e127082ff2e676b1e9608df901c0961316b1b69e501571f300e102eaf96579eeefac8241f
+  data.tar.gz: 7b864d81e23944aa57e9fd7330877610d582b36732d0d41df3ea21144a70bd6d6bd7e74936a815033e0025fc54549653f8880244c340a406f8cfaabce61c2a7f

data/.gitignore

@@ -1,3 +1,9 @@
+!.keep
+*.DS_Store
+*.swo
+*.swp
+/.bundle
+/.env
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -6,6 +12,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
+/.idea
+.byebug_history
 .rspec_status

data/README.md

@@ -1,8 +1,8 @@
 # Administrate::Field::Jsonb
 
-A plugin to show and edit JSON objects within [Administrate](https://github.com/thoughtbot/administrate). inspired by [Administrate::Field::JSON](https://github.com/eddietejeda/administrate-field-json)
+A plugin to show and edit JSON objects within [Administrate](https://github.com/thoughtbot/administrate). inspired by [Administrate::Field::JSON](https://github.com/eddietejeda/administrate-field-json).
 
-This gem uses [jsoneditor](https://github.com/josdejong/jsoneditor)
+This gem uses [jsoneditor](https://github.com/josdejong/jsoneditor).
 
 ## Installation
 
@@ -18,12 +18,21 @@ And then execute:
 bundle
 ```
 
+If you are using asset pipeline, add the following lines to your `manifest.js`:
+
+```js
+//= link administrate-field-jsonb/application.css
+//= link administrate-field-jsonb/application.js
+```
+
+The manifest file is at `app/assets/config` by default.
+
 ## Usage
 
 ```ruby
 ATTRIBUTE_TYPES = {
   # ...
-  data: Field::JSONB
+  details: Field::JSONB
 }.freeze
 ```
 
@@ -32,8 +41,41 @@ If you have some kind of serialization, you can call methods on your object with
 ```ruby
 ATTRIBUTE_TYPES = {
   # ...
-  data: Field::JSONB.with_options(
-    transform: %w[to_h]
+  details: Field::JSONB.with_options(
+    transform: %w[to_h symbolize_keys]
+  )
+}.freeze
+```
+
+If you want to edit json displaying on `show` page, you can use `advanced_view` option (both JSON and arrays are supported).
+
+```ruby
+ATTRIBUTE_TYPES = {
+  # ...
+  details: Field::JSONB.with_options(transform: %i[to_h symbolize_keys], advanced_view: {
+    company:  Field::String,
+    position: Field::String,
+    skills: Field::JSONB.with_options(advanced_view: {
+      'name'  => Field::String,
+      'years' => Field::Number.with_options(suffix: ' years')
+    })
+  }),
+  languages: Field::JSONB.with_options(advanced_view: {
+    'title' => Field::String,
+    'code'  => Field::String,
+  })
+}.freeze
+```
+
+NOTE: don't define `advanced_view` option if you want to display JSON with the [jsoneditor](https://github.com/josdejong/jsoneditor).
+
+To customize what to display if you have an empty value, use `blank_sign` option, by default it's `-`.
+
+```ruby
+ATTRIBUTE_TYPES = {
+  # ...
+  details: Field::JSONB.with_options(
+    blank_sign: 'oops, missed'
   )
 }.freeze
 ```
@@ -48,16 +90,65 @@ ATTRIBUTE_TYPES = {
 
 ### Show
 
+#### jsoneditor mode
+
 <p align="center">
- <img src="docs/images/show.png">
+ <img src="docs/images/show_jsoneditor.png">
 </p>
 
-### Index
+#### advanced_view mode
 
 <p align="center">
- <img src="docs/images/index.png">
+ <img src="docs/images/advanced_view_full.png">
 </p>
 
+#### advanced_view object
+
+<p align="center">
+ <img src="docs/images/advanced_view_object.png">
+</p>
+
+#### advanced_view array
+
+<p align="center">
+ <img src="docs/images/advanced_view_array.png">
+</p>
+
+## Recipes
+
+If you want to store your JSON in hash format and not a string add this to your model.
+
+```ruby
+def your_field_name=(value)
+  self[:your_field_name] = value.is_a?(String) ? JSON.parse(value) : value
+end
+```
+
+Example:
+
+```ruby
+def details=(value)
+  self[:details] = value.is_a?(String) ? JSON.parse(value) : value
+end
+```
+
+<hr>
+
+If you don't see details in `advanced_view`, try to add this
+
+```ruby
+transform: %i[to_h symbolize_keys]
+```
+
+or use string keys.
+
+```ruby
+languages: Field::JSONB.with_options(advanced_view: {
+  'title' => Field::String,
+  'code'  => Field::String,
+})
+```
+
 ## License
 
 Copyright © 2015-2019 Codica. It is released under the [MIT License](https://opensource.org/licenses/MIT).
@@ -66,6 +157,6 @@ Copyright © 2015-2019 Codica. It is released under the [MIT License](https://op
 
 [![Codica logo](https://www.codica.com/assets/images/logo/logo.svg)](https://www.codica.com)
 
-Timebot is maintained and funded by Codica. The names and logos for Codica are trademarks of Codica.
+Administrate::Field::Jsonb is maintained by Codica. The names and logos for Codica are trademarks of Codica.
 
 We love open source software! See [our other projects](https://github.com/codica2) or [hire us](https://www.codica.com/) to design, develop, and grow your product.

data/administrate-field-jsonb.gemspec

@@ -2,7 +2,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |gem|
   gem.name = 'administrate-field-jsonb'
-  gem.version = '0.1.0'
+  gem.version = '0.4.2'
   gem.authors = ['Sergey Volkov', 'Codica']
   gem.email = ['sergvolkov.codica@gmail.com']
   gem.homepage = 'https://github.com/codica2/administrate-field-jsonb'

data/app/assets/javascripts/administrate-field-jsonb/application.js

@@ -11,4 +11,4 @@
 // GO AFTER THE REQUIRES BELOW.
 //
 //= require jsoneditor-minimalist.min
-//= require_tree .
+//= require_tree .

data/app/assets/javascripts/administrate-field-jsonb/components/accordion.js

@@ -0,0 +1,7 @@
+$(document).on(typeof Turbolinks === 'undefined' ? 'ready' : 'turbolinks:load', function() {
+  $(".administrate-field-jsonb-accordion").each(function() {
+    $(this).click(function() {
+      $(this).toggleClass("administrate-field-jsonb-active").next().toggle();
+    });
+  });
+});

data/app/assets/javascripts/administrate-field-jsonb/components/editor.js

@@ -1,6 +1,6 @@
-$(function () {
+$(document).on(typeof Turbolinks === 'undefined' ? 'ready' : 'turbolinks:load', function() {
   let editor, updatedJson;
-  $('.administrate-jsoneditor').each(function (index) {
+  $('.administrate-jsoneditor').each(function(index) {
 
     let $current = $(this).find("textarea");
 
@@ -14,7 +14,7 @@ $(function () {
 
         $current.val(JSON.stringify(updatedJson));
       },
-      onError: function (err) {
+      onError: function(err) {
         alert(err.toString());
       },
       navigationBar: false,
@@ -29,4 +29,4 @@ $(function () {
 
     editor.set(JSON.parse($current.val()));
   });
-});
+});

data/app/assets/javascripts/administrate-field-jsonb/components/viewer.js

@@ -1,4 +1,4 @@
-$(function () {
+$(document).on(typeof Turbolinks === 'undefined' ? 'ready' : 'turbolinks:load', function() {
   let viewer;
   $('.administrate-jsoneditor-viewer').each(function (index) {
 
@@ -17,4 +17,4 @@ $(function () {
 
     viewer.set(JSON.parse($current.val()));
   });
-});
+});

data/app/assets/stylesheets/administrate-field-jsonb/accordion.css

@@ -0,0 +1,54 @@
+.administrate-field-jsonb-wrapper {
+  float: left;
+  width: 100%;
+  margin-top: 0;
+  border: 1px solid #ccc;
+  padding: 10px;
+}
+
+.administrate-field-jsonb-box {
+  margin-bottom: 0;
+  float: left;
+  width: 100%;
+}
+
+.administrate-field-jsonb-accordion {
+  width: 100%;
+  text-align: left;
+  padding: 5px 15px;
+  background-color: #eee;
+  color: #444;
+  cursor: pointer;
+  outline: none;
+  transition: 0.4s;
+  margin-bottom: 0;
+  margin-top: 15px;
+}
+
+.administrate-field-jsonb-accordion:first-child {
+  margin-top: 0;
+}
+
+.administrate-field-jsonb-active, .administrate-field-jsonb-accordion:hover {
+  background-color: #ccc;
+}
+
+.administrate-field-jsonb-panel {
+  padding: 0 18px 15px;
+  background-color: white;
+  display: none;
+  overflow: hidden;
+  border: 1px solid #ccc;
+}
+
+.administrate-field-jsonb-accordion:after {
+  content: '\02795'; /* Unicode character for "plus" sign (+) */
+  font-size: 13px;
+  color: #777;
+  float: right;
+  margin-left: 5px;
+}
+
+.administrate-field-jsonb-active:after {
+  content: "\2796"; /* Unicode character for "minus" sign (-) */
+}

data/app/assets/stylesheets/administrate-field-jsonb/application.css

@@ -2,4 +2,4 @@
 *= require_self
 *= require jsoneditor.min
 *= require_tree .
-*/
+*/

data/app/assets/stylesheets/administrate-field-jsonb/editor.css

@@ -21,4 +21,4 @@ textarea.jsoneditor-text {
 
 table.jsoneditor-values tbody > tr {
   border: none;
-}
+}

data/app/views/fields/jsonb/_array.html.erb

@@ -0,0 +1,10 @@
+<% label ||= nil %>
+
+<% data.each.with_index(1) do |d, index| %>
+  <dt class='attribute-label administrate-field-jsonb-accordion'><%= "#{label || field.attribute.to_s.singularize.titleize} - #{index}" %></dt>
+  <dd class='administrate-field-jsonb-panel'>
+    <dl class='administrate-field-jsonb-box'>
+      <%= render field.to_partial_path('hash'), field: field, structure: structure, data: d %>
+    <dl>
+  </dd>
+<% end %>

data/app/views/fields/jsonb/_field.html.erb

@@ -0,0 +1,9 @@
+<% field = type.new(key, value, :show) %>
+<dt class='attribute-label'><%= t(
+    "helpers.label.#{resource_name}.#{key}",
+    default: key.to_s.titleize,
+  ) %>
+</dt>
+<dd class='attribute-data'>
+  <%= render_field field, page: :show %>
+</dd>

data/app/views/fields/jsonb/_form.html.erb

@@ -1,13 +1,7 @@
-
-<%#
-  # JSONB Form Partial
-  This partial renders an JSON database into structured form
-%>
-
 <div class="field-unit__label">
   <%= f.label field.attribute %>
 </div>
 
 <div class="field-unit__field administrate-jsoneditor">
-  <%= f.text_area field.attribute, value: field.data.to_json.html_safe.squish %>
+  <%= f.text_area field.attribute, value: field.transform.to_json.html_safe.squish %>
 </div>

data/app/views/fields/jsonb/_hash.html.erb

@@ -0,0 +1,17 @@
+<% structure.each do |sk, sv| %>
+  <% if sv.is_a?(Hash) %>
+    <dt class='attribute-label administrate-field-jsonb-accordion'><%= sk.to_s.titleize %></dt>
+    <dd class='administrate-field-jsonb-panel'>
+      <dl class='administrate-field-jsonb-box'>
+        <% if data[sk].is_a?(Array) %>
+          <%= render field.to_partial_path('array'),
+            field: field, structure: structure[sk], data: data[sk], label: sk.to_s.singularize.titleize %>
+        <% else %>
+          <%= render field.to_partial_path('hash'), field: field, structure: structure[sk], data: data[sk] %>
+        <% end %>
+      <dl>
+    </dd>
+  <% else %>
+    <%= render field.to_partial_path('field'), type: sv, key: sk, value: data[sk] %>
+  <% end %>
+<% end %>

data/app/views/fields/jsonb/_index.html.erb

@@ -1 +1 @@
-<%= JSON.pretty_generate field.transform %>
+<%= JSON.pretty_generate field.transform %>

data/app/views/fields/jsonb/_show.html.erb

@@ -1,3 +1,15 @@
-<div class="administrate-jsoneditor-viewer">
-  <%= text_area_tag field.attribute, field.transform.to_json.html_safe.squish %>
-</div>
+<% if field.transform.blank? %>
+  <%= field.blank_sign %>
+<% elsif field.advanced_view? %>
+  <dl class='administrate-field-jsonb-wrapper'>
+    <% if field.array? %>
+      <%= render field.to_partial_path('array'), field: field, structure: field.advanced_view, data: field.transform %>
+    <% else %>
+      <%= render field.to_partial_path('hash'), field: field, structure: field.advanced_view, data: field.transform %>
+    <% end %>
+  </dl>
+<% else %>
+  <div class='administrate-jsoneditor-viewer'>
+    <p><%= text_area_tag field.attribute, field.transform.to_json.html_safe.squish %></p>
+  </div>
+<% end %>

data/lib/administrate/field/jsonb.rb

@@ -9,15 +9,36 @@ module Administrate
     class JSONB < Administrate::Field::Base
 
       def transform
+        return nil if data.blank?
         return data unless options[:transform].present? && options[:transform].is_a?(Array)
 
         result = data
         options[:transform].each do |method|
-          result = data.public_send(method)
+          result = result.is_a?(Array) ? result.map(&method) : result.public_send(method)
         end
         result
       end
 
+      def array?
+        transform.is_a?(Array)
+      end
+
+      def advanced_view?
+        advanced_view.present? && advanced_view.is_a?(Hash)
+      end
+
+      def advanced_view
+        options[:advanced_view]
+      end
+
+      def to_partial_path(partial = page)
+        "/fields/jsonb/#{partial}"
+      end
+
+      def blank_sign
+        options[:blank_sign] || '-'
+      end
+
       class Engine < ::Rails::Engine
 
         Administrate::Engine.add_javascript 'administrate-field-jsonb/application'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: administrate-field-jsonb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Sergey Volkov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -73,18 +73,24 @@ files:
 - README.md
 - administrate-field-jsonb.gemspec
 - app/assets/javascripts/administrate-field-jsonb/application.js
+- app/assets/javascripts/administrate-field-jsonb/components/accordion.js
 - app/assets/javascripts/administrate-field-jsonb/components/editor.js
 - app/assets/javascripts/administrate-field-jsonb/components/viewer.js
+- app/assets/stylesheets/administrate-field-jsonb/accordion.css
 - app/assets/stylesheets/administrate-field-jsonb/application.css
 - app/assets/stylesheets/administrate-field-jsonb/editor.css
+- app/views/fields/jsonb/_array.html.erb
+- app/views/fields/jsonb/_field.html.erb
 - app/views/fields/jsonb/_form.html.erb
+- app/views/fields/jsonb/_hash.html.erb
 - app/views/fields/jsonb/_index.html.erb
 - app/views/fields/jsonb/_show.html.erb
+- docs/images/advanced_view_array.png
+- docs/images/advanced_view_full.png
+- docs/images/advanced_view_object.png
 - docs/images/form.png
-- docs/images/index.png
-- docs/images/show.png
+- docs/images/show_jsoneditor.png
 - lib/administrate/field/jsonb.rb
-- vendor/assets/.DS_Store
 - vendor/assets/images/jsoneditor-icons.svg
 - vendor/assets/javascripts/jsoneditor-minimalist.min.js
 - vendor/assets/stylesheets/jsoneditor.min.css
@@ -107,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: JSONb field plugin for Administrate