administrate-field-jsontable 0.0.1 → 0.1.0

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 DisruptiveAngels
+Copyright (c) 2019 Valiot
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,33 +1,21 @@
 # Administrate::Field::Jsontable
 
-A plugin to show JSON to table attributes in [Administrate].
+A plugin to display the values of a JSON into a table. If the JSON has no data
+of a field it will display a "-". This gem only displays 1 or 2 rows.
 
-This repository is the first field plugin extracted out of Administrate.
-Although its structure may change,
-it's designed to act as a template for other Administrate field plugins.
+![JsonTable](https://user-images.githubusercontent.com/7603314/29417081-9fa39038-832d-11e7-9189-b1baaccd8ec6.png)
 
-## FAQs
+This repository is a field plugin for Administrate.
 
-**Q: How should I name my gem?**
+## Installation
 
-A: Administrate field gems must be named according to the [Rubygems naming guidelines].
+Add to your gemfile `gem 'administrate-field-jsontable'`
 
-Essentially, name your gem after the field class that it defines.
-If there's a namespace in the class name, that gets translated to a dash (`-`) in the gem name.
-If the class name is CamelCased, that translates to an underscore (`_`) in the gem name.
-
-Since all administrate field gems are under the namespace `Administrate::Field`,
-every field gem name should start with the prefix `administrate-field-`.
-
-Here are some examples (these don't correspond to actual gems):
+[Administrate]: https://github.com/thoughtbot/administrate
 
-| Gem Name | Field Name |
-|----------------------------|------------------------------|
-| `administrate-field-enum` | `Administrate::Field::Enum` |
-| `administrate-field-file_upload` | `Administrate::Field::FileUpload` |
-| `administrate-field-geocoding-region` | `Administrate::Field::Geocoding::Region` |
-| `administrate-field-geocoding-geo_json` | `Administrate::Field::Geocoding::GeoJson` |
+## Contributing
 
-[Rubygems naming guidelines]: http://guides.rubygems.org/name-your-gem/
+Run `bundle exec rake db:setup` to set up example rails app on development environment
+Run `bundle exec rspec` to run tests
+Run `bundle exec rubocop` to linting tests
 
-[Administrate]: https://github.com/thoughtbot/administrate

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require File.expand_path('spec/example_app/config/application', __dir__)
+
+Rails.application.load_tasks

data/administrate-field-jsontable.gemspec

@@ -1,11 +1,13 @@
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name = 'administrate-field-jsontable'
-  s.version = '0.0.1'
-  s.authors = ['Enrique Barragan', 'Esteban Arocha']
-  s.email = ['enrique@disruptiveangels.com','esteban@disruptiveangels.com']
-  s.homepage = 'https://github.com/DisruptiveAngels/administrate-field-jsontable'
+  s.version = '0.1.0'
+  s.authors = ['Adrian Rangel', 'Enrique Barragan']
+  s.email = ['adrian@valiot.io', 'enrique@valiot.io']
+  s.homepage = 'https://github.com/Valiot/administrate-field-jsontable'
   s.summary = 'JSON to table field plugin for Administrate'
   s.description = s.summary
   s.license = 'MIT'
@@ -15,5 +17,5 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 
   s.add_dependency 'administrate'
-  s.add_dependency 'rails', '>= 4.2', '< 5.1'
+  s.add_dependency 'rails', '>= 4.2'
 end

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

@@ -0,0 +1,18 @@
+<%#
+# Enum Show Partial
+
+This partial renders an enum attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered as a text tag.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Enum][1].
+  A wrapper around the enum attributes pulled from the model.
+
+%>
+
+
+<%= render partial: '/fields/jsontable/json_table_field',  locals: { data: field.data } %>

data/app/views/fields/jsontable/_json_table_field.html.erb

@@ -0,0 +1,30 @@
+<%#
+# Enum Show Partial
+
+This partial renders an enum attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered as a text tag.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Enum][1].
+  A wrapper around the enum attributes pulled from the model.
+
+%>
+
+<% if data.kind_of?(Hash) %>
+  <table>
+    <tbody>
+      <% data.each do |key, value| %>
+        <tr>
+          <td><%= key %></td>
+          <td><%= if value.blank? then "-" else render partial: '/fields/jsontable/json_table_field', locals: { data: value } end %></td>
+        </tr>
+      <% end %>
+    <tbody>
+  </table>
+<% else %>
+  <%= if data.blank? then "-" else data end %>
+<% end %>

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

@@ -1,7 +1,7 @@
 <%#
-# JSON to table Show Partial
+# Enum Show Partial
 
-This partial renders an JSON to table attribute,
+This partial renders an enum attribute,
 to be displayed on a resource's show page.
 
 By default, the attribute is rendered as a text tag.
@@ -9,37 +9,10 @@ By default, the attribute is rendered as a text tag.
 ## Local variables:
 
 - `field`:
-  An instance of [Administrate::Field::Jsontable][1].
-  A wrapper around the JSON to table attributes pulled from the model.
+  An instance of [Administrate::Field::Enum][1].
+  A wrapper around the enum attributes pulled from the model.
 
 %>
 
-<table>
-  <thead>
-    <tr>
-    <% field.data.each do |k,v| %>
-        <th><%= k %></th>
-    <% end %>
-  </tr>
-  </thead>
-<tbody>
-<% if field.data.first[1].kind_of?(Array) %>
-    <tr>
-<% field.data.each do |k,v| %>
-      <td><%= if v[0].blank? then "-" else v[0] end %></td>
-<% end %>
-    </tr>
-    <tr>
-<% field.data.each do |k,v| %>
-      <td><%= if v[1].blank? then "-" else v[1] end %></td>
-<% end %>
-    </tr>
-<% else %>
-    <tr>
-<% field.data.each do |k,v| %>
-      <td><%= if v.blank? then "-" else v end %></td>
-<% end %>
-    </tr>
-<% end %>
-</tbody>
-</table>
+
+<%= render partial: '/fields/jsontable/json_table_field',  locals: { data: field.data } %>

data/lib/administrate/field/jsontable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'administrate/field/base'
 require 'rails'
 

data/spec/example_app/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link administrate/application.css
+//= link administrate/application.js

data/spec/example_app/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// 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 any plugin's vendor/assets/javascripts directory 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
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/example_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/example_app/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/example_app/app/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/example_app/app/views/layouts/application.html.erb

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="ROBOTS" content="NOODP" />
+  <meta name="viewport" content="initial-scale=1" />
+  <%#
+    Configure default and controller-, and view-specific titles in
+    config/locales/en.yml. For more see:
+    https://github.com/calebthompson/title#usage
+  %>
+  <title><%= title %></title>
+  <%= stylesheet_link_tag "//fonts.googleapis.com/css?family=Lato:300,400,900", media: "all" %>
+  <%= stylesheet_link_tag :application, media: "all" %>
+  <%= csrf_meta_tags %>
+</head>
+
+<body class="<%= body_class %>">
+  <main class="main">
+    <%= render "navigation" -%>
+
+    <div class="content">
+      <%= render "flashes" -%>
+
+      <%= yield %>
+
+      <%= render "javascript" %>
+    </div>
+  </main>
+</body>
+</html>

data/spec/example_app/config.ru

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('config/environment', __dir__)
+run Rails.application

data/spec/example_app/config/application.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require File.expand_path('boot', __dir__)
+
+require 'active_model/railtie'
+require 'active_record/railtie'
+require 'active_job/railtie'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module AdministrateJsontablePrototype
+  class Application < Rails::Application
+    config.i18n.enforce_available_locales = true
+
+    config.generators do |generate|
+      generate.helper false
+      generate.javascript_engine false
+      generate.request_specs false
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+    end
+
+    config.action_controller.action_on_unpermitted_parameters = :raise
+
+    if Rails::VERSION::MAJOR < 5
+      # Do not swallow errors in after_commit/after_rollback callbacks.
+      config.active_record.raise_in_transactional_callbacks = true
+    end
+
+    config.active_record.time_zone_aware_types = %i[datetime time] if Rails::VERSION::MAJOR >= 5
+  end
+end

data/spec/example_app/config/boot.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+require 'bundler/setup'

data/spec/example_app/config/database.yml

@@ -0,0 +1,11 @@
+development: &default
+  adapter: postgresql
+  database: administrate-jsontable_prototype_development
+  encoding: utf8
+  min_messages: warning
+  pool: 2
+  timeout: 5000
+
+test:
+  <<: *default
+  database: administrate-jsontable_prototype_test

data/spec/example_app/config/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/example_app/config/environments/development.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local = true
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+  config.i18n.default_locale = :tr
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  config.action_view.raise_on_missing_translations = true
+end

data/spec/example_app/config/environments/production.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Ensures that a master key has been made available in either
+  # ENV["RAILS_MASTER_KEY"] or in config/master.key. This key is used to
+  # decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress CSS using a preprocessor.
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [:request_id]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per
+  # environment).
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "administrate_prototype_production"
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+  config.i18n.default_locale = :tr
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  if ENV['RAILS_LOG_TO_STDOUT'].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end