action_table 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6e8c82366ee5b6617d572217e5fe97b46b899ec4b0c56d427c4684488901b76
-  data.tar.gz: d0a6e30baf0df782de4d3f49db62b5511bcb3b176cdd77e1fcb76223e4ae7f9e
+  metadata.gz: 764eb83721f4fdcb2d2ba4d83b4e475193dfd942ba092ba66fa51d9b99500792
+  data.tar.gz: 28cf0551ac9a6db16b109c45e9fd480876112989480dc87d3b7a5e77604e8ccc
 SHA512:
-  metadata.gz: 906cab2332e2eee5af9642e44ec5f12d2634b1202ec0b1a72fa743898c3f1789a452d413901616b02d1ebbf40ff5ff70058c986473240ad9d2b5ffd1e5e924db
-  data.tar.gz: 2c30d01e88ea05929947f753e454eb518957941ca5be2a8716d2ae694fbeba8a607dfc79f07bdead36c0e59d37065aa725815338ba739081b7e25f2e9d8cf139
+  metadata.gz: 2c54233fa2ff645ba5068bad3dec99e22f77459f400fc559e828c48c998a6d40529847cebcf110df09fbaae6055f20461edd4685ce6290ed6708528e5a8bfec2
+  data.tar.gz: 0b4595270ccfb5cbff0e08d51614eabc82658e0a949d02d174f2c785b1c6cc511bce64c9ec47f837993855abe8cd610782d09e62541ceef56784b3186546f7b5

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# ActionTable - Change Log
+
+## HEAD
+
+
+## v0.3.0
+
+- Validate styles params against known Bootstrap styles
+- Add support for responsive tables
+- Remove `View#styles_class` in favor of `View#styles` that returns an instance of `BootstrapStyles`
+- Update default value of `Configuration#links` to be empty
+- Change `View#cols` to `View#columns`
+- Change `Configuration#link_method` to `Configuration#links`
+
+---
+
+_The rest is history.._

data/README.md

@@ -1,6 +1,6 @@
 # ActionTable
 
-Render ActiveModel or ActiveRecord objects as HTML tables with one line of Ruby - supports some simple configuration options.
+Render ActiveRecord objects as HTML tables with one line of Ruby - supports some simple configuration options.
 
 :warning: Only works with Ruby on Rails.
 

data/action_table.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jacob Burenstam']
   spec.email         = ['burenstam@gmail.com']
 
-  spec.summary       = 'Render ActiveModel or ActiveRecord objects as HTML tables with one line of Ruby.'
-  spec.description   = 'Render ActiveModel or ActiveRecord objects as HTML tables with one line of Ruby - supports some simple configuration options.'
+  spec.summary       = 'Render ActiveRecord objects as HTML tables with one line of Ruby.'
+  spec.description   = 'Render ActiveRecord objects as HTML tables with one line of Ruby - supports some simple configuration options.'
   spec.homepage      = 'https://github.com/buren/action_table'
   spec.license       = 'MIT'
 

data/lib/action_table.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'action_table/version'
-require 'action_table/railtie'
+require 'action_table/railtie' if defined?(Rails)
 
 module ActionTable
   def self.configuration
@@ -18,14 +18,14 @@ module ActionTable
   end
 
   class Configuration
-    attr_accessor :styles, :actions, :link_method
+    attr_accessor :styles, :actions, :links
     attr_writer :rails_host_app
 
     def initialize
       @rails_host_app = nil
       @styles = []
       @actions = []
-      @link_method = :name
+      @links = []
     end
 
     def rails_host_app

data/lib/action_table/bootstrap_styles.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ActionTable
+  class BootstrapStyles
+    BOOTSTRAP_TABLE_WRAPERS = Set.new(
+      %w[
+        responsive
+        responsive-sm
+        responsive-md
+        responsive-lg
+        responsive-xl
+      ],
+    ).freeze
+
+    # All the below can be used on <table>, <thead>, <tr>, <td>
+    BOOTSTRAP_UTILS = Set.new(
+      %w[
+        dark
+        light
+        primary
+        success
+        danger
+        info
+        warning
+        active
+        secondary
+      ],
+    )
+
+    # .thead-light or .thead-dark
+    #       <th scope="row">1</th>
+    #   <caption>List of users</caption> # directly under <table>
+    BOOTSTRAP_TABLE_STYLES = (
+      Set.new(
+        %w[
+          striped
+          sm
+          bordered
+          hover
+          borderless
+        ],
+      ) + BOOTSTRAP_UTILS
+    ).freeze
+
+    def initialize(styles)
+      @styles = Array(styles).map { |style| style.to_s.tr('_', '-') }
+      @responsive_wrapper_class = nil
+      @table_classes = nil
+
+      validate_styles!(@styles)
+    end
+
+    def responsive_wrapper_class
+      return @responsive_wrapper_class if @responsive_wrapper_class
+
+      wrappers = BOOTSTRAP_TABLE_WRAPERS.select { |style| @styles.include?(style) }
+      return if wrappers.empty?
+
+      @responsive_wrapper_class = wrappers.map do |style|
+        "table-#{style}" if wrapper_class?(style)
+      end.join(' ')
+    end
+
+    def table_classes
+      return @table_classes if @table_classes
+
+      style_classes = @styles.map do |style|
+        "table-#{style}" if table_class?(style)
+      end.compact
+
+      @table_classes = "table #{style_classes.join(' ')}"
+    end
+
+    private
+
+    def table_class?(style)
+      BOOTSTRAP_TABLE_STYLES.include?(style)
+    end
+
+    def wrapper_class?(style)
+      BOOTSTRAP_TABLE_WRAPERS.include?(style)
+    end
+
+    def validate_styles!(styles)
+      styles.each do |style|
+        next if table_class?(style) || wrapper_class?(style)
+
+        raise(
+          ArgumentError,
+          "unknown bootstrap style #{style}, must be in #{BOOTSTRAP_TABLE_STYLES}",
+        )
+      end
+    end
+  end
+end

data/lib/action_table/helper.rb

@@ -13,8 +13,8 @@ module ActionTable
     #   table columns (must map to methods on each ActiveRecord instance)
     # @param styles [Array<String>, Array<Symbol>]
     #   no, one or many of bootstrap table styles (table- prefix will be added)
-    # @param link [Symbol]
-    #   method name for the default name to use for anchor-tags
+    # @param link [String, Symbol, Array<String>, Array<Symbol>]
+    #   field(s) that will link to the resource
     # @param paginate [true, false]
     #   whether to render pagination links (default: false)
     # @param actions [Array<String>, Array<Symbol>]
@@ -23,15 +23,15 @@ module ActionTable
       records,
       fields,
       paginate: false,
-      link: ActionTable.config.link_method,
+      links: ActionTable.config.links,
       actions: ActionTable.config.actions,
       styles: ActionTable.config.styles
     )
       action_table = View.new(
-        cols: fields,
+        columns: fields,
         records: records,
         paginate: paginate,
-        link: link,
+        links: links,
         actions: actions,
         styles: styles,
       )

data/lib/action_table/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionTable
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/action_table/view.rb

@@ -1,34 +1,35 @@
 # frozen_string_literal: true
 
 require 'set'
+require 'action_table/bootstrap_styles'
 
 module ActionTable
   class View
     include ActionView::Helpers::UrlHelper
     include ActionTable.config.rails_host_app.routes.url_helpers
 
-    attr_reader :model_name, :rows
+    attr_reader :model_name, :rows, :styles
 
     def initialize(
-      cols:,
+      columns:,
       records:,
       paginate: false,
-      link: ActionTable.config.link_method,
+      links: ActionTable.config.links,
       actions: ActionTable.config.actions,
       styles: ActionTable.config.styles
     )
-      @col_names  = cols.map(&:to_s)
+      @columns    = columns.map(&:to_s)
       @rows       = records
       @table_name = records.table_name
       @model_name = @table_name.singularize
       @paginate   = paginate
-      @link       = Set.new(Array(link.to_s)).reject(&:empty?)
+      @links      = Set.new(Array(links).map(&:to_s)).reject(&:empty?)
       @actions    = Array(actions).map(&:to_s)
-      @styles     = Array(styles)
+      @styles     = BootstrapStyles.new(styles)
     end
 
     def headers
-      @headers ||= @col_names.map { |name| t_col(name) }
+      @headers ||= @columns.map { |name| t_col(name) }
     end
 
     # add header column padding for actions
@@ -36,17 +37,17 @@ module ActionTable
       @actions_header ||= [''] * @actions.length
     end
 
-    def cols(record)
-      attribute_columns = @col_names.map do |name|
+    def columns(record)
+      attribute_columns = @columns.map do |name|
         title = record.public_send(name)
-        if title.present? && @link.include?(name)
+        if title.present? && @links.include?(name)
           link_to(title, record_path(record))
         else
           title
         end
       end
 
-      actions = t_actions.zip(@actions).map do |data|
+      actions = t_actions.zip(@actions).map! do |data|
         title, name = data
         link_to(title, record_path(record, action: name))
       end
@@ -54,10 +55,6 @@ module ActionTable
       attribute_columns + actions
     end
 
-    def styles_class
-      @styles.map { |style| "table-#{style}" }.join(' ')
-    end
-
     def paginate?
       @paginate
     end

data/lib/action_table/views/action_table/_table.html.erb

@@ -1,4 +1,10 @@
-<table class="table <%= table.styles_class %>">
+<% wrapper_class = table.styles.responsive_wrapper_class %>
+
+<% if wrapper_class %>
+<div class="<%= wrapper_class %>">
+<% end %>
+
+<table class="<%= table.styles.table_classes %>">
   <thead>
     <% table.headers.each do |header| %>
       <th><%= header %></th>
@@ -10,7 +16,7 @@
   <tbody>
     <% table.rows.each do |row| %>
       <tr>
-        <% table.cols(row).each do |col| %>
+        <% table.columns(row).each do |col| %>
           <td><%= col %></td>
         <% end %>
       </tr>
@@ -18,6 +24,10 @@
   </tbody>
 </table>
 
+<% if wrapper_class %>
+</div>
+<% end %>
+
 <% if table.paginate? %>
   <%= paginate table.rows, param_name: table.paginate_param_name %>
 <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_table
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jacob Burenstam
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Render ActiveModel or ActiveRecord objects as HTML tables with one line
-  of Ruby - supports some simple configuration options.
+description: Render ActiveRecord objects as HTML tables with one line of Ruby - supports
+  some simple configuration options.
 email:
 - burenstam@gmail.com
 executables: []
@@ -79,6 +79,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-style-guide.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -87,6 +88,7 @@ files:
 - bin/console
 - bin/setup
 - lib/action_table.rb
+- lib/action_table/bootstrap_styles.rb
 - lib/action_table/helper.rb
 - lib/action_table/railtie.rb
 - lib/action_table/version.rb
@@ -115,6 +117,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Render ActiveModel or ActiveRecord objects as HTML tables with one line of
-  Ruby.
+summary: Render ActiveRecord objects as HTML tables with one line of Ruby.
 test_files: []