administrate-field-json_array 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38560ba496736377787310288687799a8a963c56091035bc7d3ab9e59cbeed40
+  data.tar.gz: 90e15cf3dac4330f5395d93eedd265ae8c3e82997023de76a1afebf49ec73e7d
+SHA512:
+  metadata.gz: 37b1cf2269f4d3525b22d4259304d99b258f9cd47b7594ab26355f04ece02efa74e85c8b21be6273b2b2531e413c5c08a352bb2d6f47f2e4c0631bda89c90b3d
+  data.tar.gz: 2f5c91a95d601de3c53e10d0ac47566d5449760b9ce41208f7a76cdd97e3ad01aa80d5714e384825917a69f082c9d8ed504068344c78807a25239fe2391d0f98

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in administrate-field-json_array.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dmitry Davydov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Administrate::Field::JSONArray
+
+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).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'administrate-field-json_array'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+If you are using asset pipeline, add the following lines to your `manifest.js`:
+
+```js
+//= link administrate-field-json_array/application.css
+//= link administrate-field-json_array/application.js
+```
+
+The manifest file is at `app/assets/config` by default.
+
+## Usage
+
+You shoud pass `schema` to describe what inputs will be generate.
+Currently supported `:number`, `:text`(textarea) and `:string`.
+
+```ruby
+ATTRIBUTE_TYPES = {
+  # ...
+  details: Field::JSONArray.with_options(schema: { recipe: :number, description: :text }),
+}.freeze
+```
+
+## How it looks like
+
+### Form
+
+<img src="docs/images/form.png">
+
+### Show
+
+<img src="docs/images/show.png">
+
+## Recipes
+
+### Store in jsonb
+
+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
+```
+
+### I18n
+
+You can translate table headers like this
+
+```yaml
+ru:
+  activerecord:
+    attributes:
+      your_model:
+      recipe_field:
+        add: Добавить строку
+        keys:
+          rank: Номер
+          description: Описание
+```
+
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT).

data/administrate-field-json_array.gemspec

@@ -0,0 +1,21 @@
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'administrate-field-json_array'
+  gem.version = '0.1.1'
+  gem.authors = ['Dmitry Davydov']
+  gem.email = ['haudvd@gmail.com']
+  gem.homepage = 'https://github.com/haukot/administrate-field-json_array'
+  gem.summary = 'Field plugin for Administrate to edit JSON array as table of inputs'
+  gem.description = gem.summary
+  gem.license = 'MIT'
+
+  gem.require_paths = ['lib']
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.add_runtime_dependency 'administrate', '< 1.0.0'
+  gem.add_runtime_dependency 'rails', '>= 4.2', '< 7'
+
+  gem.add_development_dependency 'rspec', '~> 3.7'
+end

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

@@ -0,0 +1,69 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .
+
+$(function() {
+  function processJsonArrayData($field, callback) {
+    var $base = $field.parents('.json_array_field__base')
+    var $dataField = $base.find('.json_array_field__data_field')
+    var fieldValue = $dataField.val()
+    var parsed = JSON.parse(fieldValue)
+
+    var inputKey = $field.data('key')
+    var index = $field.parents('tr').index() - 1 // 1 - because template row is first
+
+    callback(parsed, index, inputKey)
+
+    $dataField.val(JSON.stringify(parsed))
+  }
+
+  // Json array field interactions
+  $(document).on('click', '.json_array_field__remove_row', function() {
+    var $field = $(this)
+    processJsonArrayData($field, (data, index) => {
+      data.splice(index, 1)
+    })
+
+    $field.parents('tr').remove()
+
+    return false
+  })
+
+  $(document).on('click', '.json_array_field__add_row', function(e) {
+    var $base = $(this).parents('.json_array_field__base');
+    var $templateRow = $base.find('.json_array_field__template_row')
+    var $field = $templateRow.find('input') // FIXME: Bad, to save interface processJsonArrayData.
+    var template = $templateRow.html()
+    $base.find('tbody').append('<tr>' + template + '</tr>')
+
+    processJsonArrayData($field, (data) => {
+      data.push({}) // default values?..
+    })
+
+    e.preventDefault()
+    return false
+  })
+
+  $(document).on('input', '.json_array_field__input', function() {
+    var $field = $(this)
+    processJsonArrayData($field, (data, index, inputKey) => {
+      var value = $field.val()
+      // TODO: more types? Maybe send a schema to js?
+      if ($field.attr('type') === 'number') {
+        value = parseFloat(value)
+      }
+      data[index][inputKey] = value
+    })
+  })
+
+})

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

@@ -0,0 +1,12 @@
+/*
+*= require_self
+*= require_tree .
+*/
+
+.json_array_field__add_row {
+    float: right;
+}
+
+.json_array_field__template_row {
+    display: none;
+}

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

@@ -0,0 +1,34 @@
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+
+<div class="field-unit__field json_array_field__base">
+  <table>
+    <thead>
+
+      <%= render 'fields/json_array/header', field: field %>
+      <th></th>
+
+    </thead>
+
+    <tbody>
+      <tr class="json_array_field__template_row">
+        <%= render 'fields/json_array/row', row: {}, field: field %>
+      </tr>
+
+      <% field.values.each do |row| %>
+      <tr>
+        <%= render 'fields/json_array/row', row: row, field: field %>
+      </tr>
+      <% end %>
+
+    </tbody>
+  </table>
+
+  <button class="json_array_field__add_row" type='button'>
+    <%= I18n.t("activerecord.attributes.#{field.resource.class.name.underscore}.#{field.attribute.to_s}_field.add", default: 'Add') %>
+  </button>
+
+
+  <%= f.hidden_field field.attribute, value: field.values.to_json, class: 'json_array_field__data_field' %>
+</div>

data/app/views/fields/json_array/_header.html.erb

@@ -0,0 +1,3 @@
+<% field.schema.keys.each do |k| %>
+<th><%= I18n.t("activerecord.attributes.#{field.resource.class.name.underscore}.#{field.attribute.to_s}_keys.#{k}", default: k) %></th>
+<% end %>

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

@@ -0,0 +1 @@
+<%= field.to_s %>

data/app/views/fields/json_array/_row.html.erb

@@ -0,0 +1,14 @@
+<% field.schema.each.with_index do |(k, type), key_i| %>
+<td>
+  <%= field.input type, nil, row[k], class: 'json_array_field__input', data: { key: k } %>
+</td>
+
+<% if key_i == field.schema.size - 1 %>
+<td>
+  <a class="text-color-red json_array_field__remove_row" href="#">
+    <%= I18n.t('administrate.actions.destroy') %>
+  </a>
+</td>
+<% end %>
+
+<% end %>

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

@@ -0,0 +1,14 @@
+<table>
+  <thead>
+    <%= render 'fields/json_array/header', field: field %>
+  </thead>
+  <tbody>
+    <% field.values.each do |row| %>
+      <tr>
+      <% field.schema.keys.each do |k| %>
+        <td><%= row[k] %></td>
+      <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/administrate/field/json_array.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+require 'administrate/engine'
+require 'administrate/field/base'
+require 'rails'
+
+module Administrate
+  module Field
+    class JSONArray < Administrate::Field::Base
+      include ActionView::Helpers::FormTagHelper
+
+      def to_s
+        return '-' unless data
+
+        data.to_s
+      end
+
+      def values
+        return [] unless data.is_a? Array
+
+        data
+      end
+
+      def input(schema_type, *args)
+        case schema_type
+        when :number
+          number_field_tag(*args)
+        when :text
+          text_area_tag(*args)
+        else
+          text_field_tag(*args)
+        end
+      end
+
+      def schema
+        raise 'Schema is required' unless options || options[:schema].empty?
+
+        @_json_array_schema ||= options[:schema].map { |k, v| [k.to_s, v] }.to_h
+      end
+
+      class Engine < ::Rails::Engine
+        Administrate::Engine.add_javascript 'administrate-field-json_array/application'
+        Administrate::Engine.add_stylesheet 'administrate-field-json_array/application'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-json_array
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dmitry Davydov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Field plugin for Administrate to edit JSON array as table of inputs
+email:
+- haudvd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- administrate-field-json_array.gemspec
+- app/assets/javascripts/administrate-field-json_array/application.js
+- app/assets/stylesheets/administrate-field-json_array/application.css
+- app/views/fields/json_array/_form.html.erb
+- app/views/fields/json_array/_header.html.erb
+- app/views/fields/json_array/_index.html.erb
+- app/views/fields/json_array/_row.html.erb
+- app/views/fields/json_array/_show.html.erb
+- lib/administrate/field/json_array.rb
+homepage: https://github.com/haukot/administrate-field-json_array
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Field plugin for Administrate to edit JSON array as table of inputs
+test_files: []