activeadmin_dynamic_table 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec7d176dc20e3cb34be2eae984bf87e6c790a3fa79bc61fde512e27b67ce15c9
-  data.tar.gz: bcc2afb91378be40321f206d2ac9d8d284ed22ad213864d1540f542f090e25f1
+  metadata.gz: 537aa432d0b52c8cf60622622c7893ccfb26094b9da6b48d3b529812266358e7
+  data.tar.gz: 5b7fdde7f367a01c537a3134e6db65c6e62478005bcc297db0dba9f13bea24a7
 SHA512:
-  metadata.gz: ab184ef277fda19e363634353292983632793e88009ebdd08a071b9f92c226d1bce53461dc43f9c1f42fa19c4a8f1ef954befcd0370b2723b8c6d73b4667f1cf
-  data.tar.gz: e550f74ca22cd8099454e7790c0119803f8a07bb823282c42b9b7aa6d1249a24e4e4f87e6acc0315e39c7acd06a5e0c08f40920e76337750fd2f44c80ef36436
+  metadata.gz: f1153e6d83dcea9a7a21607cda3dc34d72e6775bf3a0c5237135bcdbe9c8e01abce4bd97628578d876f025849f6f9c03071db31455cc594d667ccd64b08242a7
+  data.tar.gz: e0fed908ba563f7513d675136094f4b7a6acb649ef55697c75c0e9e7deb4474f0e921bf8e339ca129600e4a4a42bc32f129477bef59a6d55b392259d6a312ed5

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    activeadmin_dynamic_table (0.1.0)
-      activeadmin (~> 2.9)
+    activeadmin_dynamic_table (0.2.0)
+      activeadmin (>= 2.9, < 4.0)
 
 GEM
   remote: https://rubygems.org/

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) extension that allows managing 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`
+
+Example:
+
+```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.
@@ -31,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "activeadmin", "~> 2.9"
+  spec.add_dependency "activeadmin", ">= 2.9", "< 4.0"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

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/dynamic_csv_builder.rb

@@ -0,0 +1,34 @@
+module ActiveAdmin
+  class DynamicCSVBuilder < CSVBuilder
+    def exec_columns(view_context = nil)
+      @view_context = view_context
+      settings = ActiveadminDynamicTable::SettingStringParser.new(@view_context.params[:columns])
+
+      @configurator = ActiveadminDynamicTable::Configurator.new(self, settings.parse)
+      @columns = [] # we want to re-render these every instance
+
+      instance_exec &@block
+      @configurator.columns
+
+      columns
+    end
+
+    def build_row(resource, columns, options)
+      columns.map do |column|
+        content = call_method_or_proc_on(resource, column.data)
+        encode view_context.strip_tags(content.to_s), options
+      end
+    end
+
+    def register_column(*args, &block)
+      @configurator.register_column(:column, *args, &block)
+    end
+
+    def register_id_column(*args, &block)
+      @configurator.register_column(:column, :id, key: :id)
+    end
+
+    def register_actions(*args, &block); end
+    def selectable_column; end
+  end
+end

data/lib/activeadmin_dynamic_table/resource_dsl.rb

@@ -0,0 +1,11 @@
+module ActiveAdmin
+  class ResourceDSL
+    def use_dynamic_csv(options = {})
+      options[:resource] = config
+
+      presenter = config.page_presenters[:index][:table]
+
+      config.csv_builder = DynamicCSVBuilder.new(options, &presenter.block)
+    end
+  end
+end

data/lib/activeadmin_dynamic_table/version.rb

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

data/lib/activeadmin_dynamic_table.rb

@@ -5,6 +5,8 @@ require_relative "activeadmin_dynamic_table/version"
 require_relative "activeadmin_dynamic_table/configurator"
 require_relative "activeadmin_dynamic_table/setting_string_parser"
 require_relative "activeadmin_dynamic_table/column_settings"
+require_relative "activeadmin_dynamic_table/resource_dsl"
+require_relative "activeadmin_dynamic_table/dynamic_csv_builder"
 require_relative "activeadmin_dynamic_table/views/index_as_dynamic_table"
 
 module ActiveadminDynamicTable

metadata

@@ -1,30 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_dynamic_table
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton Biliaiev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
-description: ''
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Allow to controll activeadmin table columns from the UI. (Show/hide/resize/reorder
+  table columns)
 email:
 - amdj15@gmail.com
 executables: []
@@ -42,17 +49,22 @@ 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
+- lib/activeadmin_dynamic_table/dynamic_csv_builder.rb
+- lib/activeadmin_dynamic_table/resource_dsl.rb
 - lib/activeadmin_dynamic_table/setting_string_parser.rb
 - 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 +83,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: ''
+summary: Config activeadmin index tables on demand
 test_files: []