activeadmin_dynamic_table 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec7d176dc20e3cb34be2eae984bf87e6c790a3fa79bc61fde512e27b67ce15c9
-  data.tar.gz: bcc2afb91378be40321f206d2ac9d8d284ed22ad213864d1540f542f090e25f1
+  metadata.gz: ba7175e5769ce38921f670c993df131448bc7b1b87087abd1d58befb05ea5df0
+  data.tar.gz: bfe6d0ca3328fe82c084a5c283b59bf8719c7114350aee2bbc76eed8879f6a49
 SHA512:
-  metadata.gz: ab184ef277fda19e363634353292983632793e88009ebdd08a071b9f92c226d1bce53461dc43f9c1f42fa19c4a8f1ef954befcd0370b2723b8c6d73b4667f1cf
-  data.tar.gz: e550f74ca22cd8099454e7790c0119803f8a07bb823282c42b9b7aa6d1249a24e4e4f87e6acc0315e39c7acd06a5e0c08f40920e76337750fd2f44c80ef36436
+  metadata.gz: f45638282a9d3eae1f882128623ee1a43afad08194ef05af73fd28435f85ffc4615415d6d4bb153ef8ffe5b2953dde6b51d301abbf9d125ca9e5fb43dc3a3faa
+  data.tar.gz: 04ef3684e999f357f3e600b1a10c7d1e9a7bc5c2507d0b57573ac6ce7c790e71fbbeddf2d3236784cb89cad7955a03a77029f4b45806c6a64f99b8df84722c93

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activeadmin_dynamic_table (0.1.0)
+    activeadmin_dynamic_table (0.1.1)
       activeadmin (~> 2.9)
 
 GEM

data/README.md

@@ -1,8 +1,13 @@
 # ActiveadminDynamicTable
 
-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/activeadmin_dynamic_table`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is an [ActiveAdmin](https://github.com/activeadmin/activeadmin) extansion which allows to manage index table columns from the activeadmin UI.
 
-TODO: Delete this and the text above, and describe your gem
+## Goals
+- Show/hide table columns from UI
+- Resize columns
+- Reorder columns
+
+<img src="demo.gif" width="800" height="600">
 
 ## Installation
 
@@ -20,19 +25,77 @@ Or install it yourself as:
 
     $ gem install activeadmin_dynamic_table
 
+Add at the end of your ActiveAdmin styles (app/assets/stylesheets/active_admin.scss):
+
+```scss
+@import 'activeadmin_dynamic_table/all';
+```
+
+Add at the end of your ActiveAdmin javascripts (app/assets/javascripts/active_admin.js):
+
+```
+//= require activeadmin_dynamic_table/config
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+For `index` block specify `dynamic_table` to be used instead of default `table`
+
+```ruby
+index as: :dynamic_table do
+  # ...
+end
+```
+
+Inside configuration block register columns that will be configurable through UI
+
+### register_column
 
-## Development
+Method follows standard `column` dsl but also requires to provide at least `key` among options. This is key of the column in the provided URL params to detect whether or not column should be rendered.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+`default: true` - specify column should be rendered by default (when columns are not specified in url params)
+`width: 100` - default width of the column if it's not specified in the url params
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### register_id_column
+
+Method follows standard `id_column` dsl but also requires to provide at least `key` among options.
+All other options are the same as for `register_column`
+
+### register_actions
+
+Method follows standard `column` dsl but also requires to provide at least `key` among options.
+All other options are the same as for `register_column`
+
+Expample:
+
+```ruby
+index as: :dynamic_table do
+  selectable_column
+
+  register_id_column 'Student ID', key: :id, default: true, width: 30
+
+  register_column :name, key: :name, default: true, width: 200, &:full_name
+  register_column :user_phone, key: :phone, default: true, width: 200, &proc { |st| link_to st.phone, user_path(st.user) }
+
+  register_column :teacher, key: :teacher, default: true, width: 200
+  register_column :country, key: :country, width: 150
+  register_column :updated_at, key: :updated_at, width: 100
+
+  register_column 'LPD', key: :lpd, &proc { |st| st.last_payment_date&.strftime('%d.%m.%y %H:%M') }
+
+  register_column 'SC', key: :sc, width: 200, default: true do |student|
+    student.schedule_slots.map do |slot|
+      "#{slot.day_of_week.capitalize}: #{slot.time_slot.utc.strftime('%H:%M')}"
+    end.join(', ')
+  end
+
+  register_actions 'Actions', key: :actions, default: true, width: 130
+end
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activeadmin_dynamic_table.
+Bug reports and pull requests are welcome on GitHub at https://github.com/amdj15/activeadmin_dynamic_table.
 
 ## License
 

data/activeadmin_dynamic_table.gemspec

@@ -8,16 +8,14 @@ Gem::Specification.new do |spec|
   spec.authors = ["Anton Biliaiev"]
   spec.email = ["amdj15@gmail.com"]
 
-  spec.summary = ""
-  spec.description = ""
-  spec.homepage = ""
+  spec.summary = "Config activeadmin index tables on demand"
+  spec.description = "Allow to controll activeadmin table columns from the UI. (Show/hide/resize/reorder table columns)"
+  spec.homepage = "https://github.com/amdj15/activeadmin_dynamic_table"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
 
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
 
   # 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.

data/app/assets/stylesheets/activeadmin_dynamic_table/all.scss

@@ -7,7 +7,9 @@
   }
 
   .col-table-preferences {
-    cursor: pointer;
+    span {
+      cursor: pointer;
+    }
   }
 
   .dynamic_table_configuration {

data/lib/activeadmin_dynamic_table/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveadminDynamicTable
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_dynamic_table
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Anton Biliaiev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -24,7 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
-description: ''
+description: Allow to controll activeadmin table columns from the UI. (Show/hide/resize/reorder
+  table columns)
 email:
 - amdj15@gmail.com
 executables: []
@@ -42,6 +43,7 @@ files:
 - app/assets/stylesheets/activeadmin_dynamic_table/all.scss
 - bin/console
 - bin/setup
+- demo.gif
 - lib/activeadmin_dynamic_table.rb
 - lib/activeadmin_dynamic_table/column_settings.rb
 - lib/activeadmin_dynamic_table/configurator.rb
@@ -49,10 +51,12 @@ files:
 - lib/activeadmin_dynamic_table/version.rb
 - lib/activeadmin_dynamic_table/views/index_as_dynamic_table.rb
 - sig/activeadmin_dynamic_table.rbs
-homepage: ''
+homepage: https://github.com/amdj15/activeadmin_dynamic_table
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/amdj15/activeadmin_dynamic_table
+  source_code_uri: https://github.com/amdj15/activeadmin_dynamic_table
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -71,5 +75,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: ''
+summary: Config activeadmin index tables on demand
 test_files: []