administrate-field-csv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d0bc12f55975b3d35da5912592c74e8c1b404b4fbed86673a11e089adea35ae
+  data.tar.gz: c33ae11bc894d7ab91eadfdac5f0c311f233c782f75c25bd839982ce8e5ffbad
+SHA512:
+  metadata.gz: a5c31d011e7c071a15691fb327068ca3ae5018fb166575070dd567e1c111ac77d8ac8db8c155f3531ea5fc11ed6fdfdfbf78e8757a5a49e6df0f1ca32843c4d0
+  data.tar.gz: bb83b65f4aa379d78223a74b862122f536247bfe801448599505a9339e5b7add408bcfd220f7571f1ce697d51774d4c69cf5f1f41b78c14e0b4dbb82ab7bf376

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-08
+
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,199 @@
+PATH
+  remote: .
+  specs:
+    administrate-field-csv (0.1.0)
+      administrate (< 1.0.0)
+      rails (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activejob (= 7.0.4.2)
+      activerecord (= 7.0.4.2)
+      activestorage (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      actionview (= 7.0.4.2)
+      activejob (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4.2)
+      actionview (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activerecord (= 7.0.4.2)
+      activestorage (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4.2)
+      activesupport (= 7.0.4.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4.2)
+      activesupport (= 7.0.4.2)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4.2)
+      activesupport (= 7.0.4.2)
+    activerecord (7.0.4.2)
+      activemodel (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+    activestorage (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activejob (= 7.0.4.2)
+      activerecord (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    administrate (0.18.0)
+      actionpack (>= 5.0)
+      actionview (>= 5.0)
+      activerecord (>= 5.0)
+      jquery-rails (>= 4.0)
+      kaminari (>= 1.0)
+      sassc-rails (~> 2.1)
+      selectize-rails (~> 0.6)
+    builder (3.2.4)
+    concurrent-ruby (1.2.0)
+    crass (1.0.6)
+    date (3.3.3)
+    erubi (1.12.0)
+    ffi (1.15.5)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jquery-rails (4.5.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.8)
+    nokogiri (1.14.1-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.6.2)
+    rack (2.2.6.2)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.4.2)
+      actioncable (= 7.0.4.2)
+      actionmailbox (= 7.0.4.2)
+      actionmailer (= 7.0.4.2)
+      actionpack (= 7.0.4.2)
+      actiontext (= 7.0.4.2)
+      actionview (= 7.0.4.2)
+      activejob (= 7.0.4.2)
+      activemodel (= 7.0.4.2)
+      activerecord (= 7.0.4.2)
+      activestorage (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4.2)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sassc-rails (2.1.2)
+      railties (>= 4.0.0)
+      sassc (>= 2.0)
+      sprockets (> 3.0)
+      sprockets-rails
+      tilt
+    selectize-rails (0.12.6)
+    sprockets (4.2.0)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    tilt (2.0.11)
+    timeout (0.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  administrate-field-csv!
+  minitest (~> 5.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 James Stubblefield
+
+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,55 @@
+# Administrate::Field::CSV
+
+A custom [Administrate](https://github.com/thoughtbot/administrate) field to present Strings with CSV content in a table format on you show views.
+This field uses truncated text for index views, and a text area for form views.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'administrate-field-csv'
+```
+
+And then execute:
+
+    $ bundle install
+
+Add the below to your `app/assets/config/manifest.js` if your administrate configuration is using the asset pipeline.
+
+```javascript
+//= link administrate-field-csv/application.css
+```
+
+## Usage
+
+```
+ATTRIBUTE_TYPES = {
+    # ...
+    csv_text: Field::CSV.with_options(
+      headers: true,
+      col_sep: ',',
+      row_sep: "\r\n",
+      quote_char: '"',
+      return_headers: false,
+      truncate: 50,
+      blank_sign: "--"
+    )
+}
+```
+
+All possible options for the field are shown above along with their default values.  Refer to the ruby CSV documentation for details around the possible values for `headers`, `col_sep`, `row_sep`, `quote_char` and `return_headers`.
+
+## Development
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `administrate-field-csv.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on Bitbucket at [https://bitbucket.org/eightbitdevelopers/administrate-field-csv](https://bitbucket.org/eightbitdevelopers/administrate-field-csv).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*.rb"]
+end
+
+task default: :test

data/administrate-field-csv.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |spec|
+  spec.name = "administrate-field-csv"
+  spec.version = "0.1.0"
+  spec.authors = ["James Stubblefield"]
+  spec.email = ["james@eightbitstudios.com"]
+
+  spec.summary = "CSV field plugin for Administrate"
+  spec.description = spec.summary
+  spec.homepage = "https://bitbucket.org/eightbitdevelopers/administrate-field-csv"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/src/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "administrate", "< 1.0.0"
+  spec.add_runtime_dependency "rails", ">= 4.2"
+
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

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

@@ -0,0 +1,5 @@
+/*
+*= require_self
+*= require csv_field
+*= require_tree .
+*/

data/app/views/fields/csv/_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/csv/_form.html.erb

@@ -0,0 +1,6 @@
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.text_area field.attribute, rows: '15' %>
+</div>

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

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

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

@@ -0,0 +1,32 @@
+<% if field.transform %>
+  <table class="csvtable">
+    <% if field.headers.any? %>
+      <thead>
+        <tr>
+          <% field.headers.each do |header| %>
+            <th class="cell-label"><%= header %></th>
+          <% end %>
+        </tr>
+      </thead>
+    <% end %>
+
+    <tbody>
+      <% field.transform.each do |row| %>
+        <tr>
+          <% row.each do |k,v| %>
+            <td class="cell-data cell-data--string">
+              <% if field.has_headers? %>
+                <%= v %>
+              <% else %>
+                <%= k %>
+              <% end %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+<% else %>
+  <%= field.blank_sign %>
+<% end %>

data/bitbucket-pipelines.yml

@@ -0,0 +1,28 @@
+# This is a sample build configuration for Ruby.
+# Check our guides at https://confluence.atlassian.com/x/8r-5Mw for more examples.
+# Only use spaces to indent your .yml configuration.
+# -----
+# You can specify a custom docker image from Docker Hub as your build environment.
+image: ruby:3.1.2
+
+definitions:
+  caches:
+    bundler: ./vendor
+    assets: tmp/cache/assets
+  steps:
+    - step: &build-and-test
+        name: Unit tests
+        caches:
+          - bundler
+          - assets
+        script:
+          - gem update --system
+          - gem install bundler -v 2.2.7
+          - bundle config set --local path 'vendor'
+          - bundle install
+          - bundle exec rake test
+
+pipelines:
+  pull-requests:
+    '**':
+      - step: *build-and-test

data/lib/administrate/field/csv.rb

@@ -0,0 +1,64 @@
+require 'rails'
+require 'administrate/engine'
+require 'administrate/field/text'
+require 'csv'
+
+module Administrate
+  module Field
+    class CSV < Administrate::Field::Base
+
+      def transform
+        return nil if data.blank?
+
+        @transform ||= ::CSV.new(data, **csv_args)
+      end
+
+      def rewind
+        return nil if data.blank?
+
+        transform.rewind
+      end
+
+      def headers
+        return [] unless has_headers?
+
+        rewind
+        @headers ||= transform.first&.headers || []
+      end
+
+      def has_headers?
+        options[:headers] == true
+      end
+
+      def to_partial_path(partial = page)
+        "/fields/csv/#{partial}"
+      end
+
+      def blank_sign
+        options[:blank_sign] || '-'
+      end
+
+      def truncate
+        data.to_s.truncate(truncation_length)
+      end
+
+      private
+
+      def truncation_length
+        options.fetch(:truncate, 50)
+      end
+
+      def csv_args
+        args = %i[col_sep row_sep quote_char headers return_headers]
+        args.inject({}) { |res, arg| res.merge arg => options[arg] }.compact
+      end
+
+      class Engine < ::Rails::Engine
+        Administrate::Engine.add_stylesheet 'administrate-field-csv/application'
+        engine_root = root
+        isolate_namespace Administrate
+      end
+
+    end
+  end
+end

data/vendor/assets/stylesheets/csv_field.scss

@@ -0,0 +1,29 @@
+.attribute-data--csv {
+  max-width: 100%;
+  max-height: 350px;
+  overflow: scroll;
+  word-break: normal;
+}
+
+table.csvtable {
+  width: 100%;
+
+  thead {
+    border-collapse: separate;
+
+    tr {
+      position: sticky;
+      top: 0;
+      border: none;
+
+      th {
+        background-color: #f6f7f7;
+        white-space: nowrap;
+        padding-top: 0.7rem;
+        box-shadow: inset 0 1px 0 #dfe0e1, inset 0 -1px 0 #dfe0e1;
+      }
+
+    }
+  }
+
+}

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-csv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Stubblefield
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-10 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: CSV field plugin for Administrate
+email:
+- james@eightbitstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- administrate-field-csv.gemspec
+- app/assets/stylesheets/administrate-field-csv/application.css
+- app/views/fields/csv/_field.html.erb
+- app/views/fields/csv/_form.html.erb
+- app/views/fields/csv/_index.html.erb
+- app/views/fields/csv/_show.html.erb
+- bitbucket-pipelines.yml
+- lib/administrate/field/csv.rb
+- vendor/assets/stylesheets/csv_field.scss
+homepage: https://bitbucket.org/eightbitdevelopers/administrate-field-csv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/eightbitdevelopers/administrate-field-csv
+  source_code_uri: https://bitbucket.org/eightbitdevelopers/administrate-field-csv
+  changelog_uri: https://bitbucket.org/eightbitdevelopers/administrate-field-csv/src/master/CHANGELOG.md
+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: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: CSV field plugin for Administrate
+test_files: []