fustrate-rails 0.4.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 75f3e16d4415d2f05ab4f21f67359a8963e49ffe
-  data.tar.gz: ff2d47763cf43d7259269ceeb79ff8831e2abbbf
+SHA256:
+  metadata.gz: 881e74c991300471aafa028edfad4b01f100244396234b0da2688db01e2073be
+  data.tar.gz: 6cf4952d8518fe41835ea8bb4c13f6764c8aed89a97c43e6814af3d61cc787a9
 SHA512:
-  metadata.gz: 68ced5f9d51d6cf972c81ce3b16e1fd5021fac7ae30a64b7df2b40e104431cc7edbaab19e2ab6a119bdc6c726c075444dc1e5e0425b734bf171641a12e9abd1d
-  data.tar.gz: d242938ab2900d2f0889fe5f640c7c65572f6410400165fca2a1b0762096f9d4a368d70de0c8ff20091e862a2fe8691bd2c4f359410bb03b11011b16602f76cc
+  metadata.gz: 0da0314b9449d2dd31c7ad36dfb515094e91564b0805c8618d9a18bca6a9ff7930e154575f29070f7eff24a3df666d4c967a3af0ed7366234ed79b82ea7f9226
+  data.tar.gz: 8f0cd3d69cc37559f7c011f49e50396abb4f535b2cd665b8bb3d5926f765c6dd67abd75c93080686d5166f7bce3df4b7898684532a6a20365cc5395d0b3f8f3b

data/config/initializers/jbuilder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+class Jbuilder
+  def pagination!(results)
+    _set_value :currentPage,  results.current_page
+    _set_value :totalPages,   results.total_pages
+    _set_value :totalEntries, results.total_entries
+    _set_value :perPage,      results.per_page
+  end
+end

data/config/initializers/renderers.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+::ActionController::Renderers.add :excel do |data, options|
+  name = options[:filename] || 'export'
+
+  xlsx_options = { filename: "#{name}.xlsx", disposition: 'attachment', type: :xlsx }
+
+  case data
+  when ::Axlsx::Package
+    send_data(data.to_stream.read, **xlsx_options)
+  when ::Array
+    send_data(::Fustrate::Rails::Services::GenerateExcel.new.call(data, options[:sheet] || name), **xlsx_options)
+  when ::Pathname
+    xlsx_options[:filename] = data.basename.to_s if xlsx_options[:filename] == 'export'
+
+    send_file(data, **xlsx_options)
+  else
+    send_data(data, **xlsx_options)
+  end
+end
+
+::ActionController::Renderers.add :csv do |data, options|
+  name = options[:filename] || 'export'
+
+  csv_options = { filename: "#{name}.csv", disposition: 'attachment', type: :csv }
+
+  case data
+  when ::Array, ::Hash
+    send_data(::Fustrate::Rails::Services::GenerateCsv.new.call(data), **csv_options)
+  else
+    send_data(data, **csv_options)
+  end
+end
+
+::ActionController::Renderers.add :zip do |path, options|
+  send_file path, type: :zip, filename: "#{options[:filename]}.zip"
+end

data/config/initializers/sanitize.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+class Sanitize
+  class CSS
+    def properties(css)
+      tree = ::Crass.parse_properties(
+        css,
+        preserve_comments: @config[:allow_comments],
+        preserve_hacks: @config[:allow_hacks]
+      )
+
+      tree!(tree)
+
+      ::CSSTreeStringifier.new.stringify(tree)
+    end
+  end
+
+  SELF_CLOSING = %w[br td img hr input].freeze
+
+  class << self
+    def clean_nodes(node)
+      # Replace non-root empty nodes with a blank space
+      return node.replace(' ') if empty_element?(node)
+
+      # Replace root empty nodes with a newline
+      if node.text? && !node.parent&.parent && node.text.blank?
+        # Replacing a newline with a newline causes an infinite loop
+        return node.text == "\n" ? node : node.replace("\n")
+      end
+
+      clean_style_attribute(node)
+      clean_attributes(node)
+      clean_whitespace(node)
+    end
+
+    def clean_page_breaks(node)
+      return unless node.element?
+
+      if node.content.match?(/↡/)
+        node.content = '↡'
+        node['class'] = 'pagebreak'
+        node.remove_attribute 'style'
+      elsif node['class']
+        node.remove_attribute 'class'
+      end
+    end
+
+    protected
+
+    # Remove useless padding and text-align attributes
+    def clean_style_attribute(node)
+      return unless node['style']
+
+      style = node['style']
+        .gsub(/padding: 0(?:px|rem|in|em|);/, '')
+        .gsub(/text-align: (?:start|justify|left);/, '')
+        .strip
+
+      if style.present?
+        node['style'] = style
+      else
+        node.remove_attribute 'style'
+      end
+    end
+
+    # Remove empty attributes from a node, e.g. alt=""
+    def clean_attributes(node)
+      return unless node.element?
+
+      node.attributes.each do |key, value|
+        node.remove_attribute(key) if value.text.empty?
+      end
+    end
+
+    def clean_whitespace(node)
+      return clean_element_whitespace(node) unless node.text?
+
+      node.content = node.content.gsub(/[[:space:]]+/, ' ')
+    end
+
+    def clean_element_whitespace(node)
+      return unless node.name.casecmp('p').zero?
+
+      clean_paragraph_tag(node.children.first, true)
+      clean_paragraph_tag(node.children.last, false)
+    end
+
+    def clean_paragraph_tag(node, is_first)
+      return unless node&.text?
+
+      return node.content = '' if node.text.blank?
+
+      # Remove all leading whitespace and replace all space-like chars with a single space
+      node.content = node.content
+        .gsub(is_first ? /\A[[:space:]]+/ : /[[:space:]]+\z/, '')
+        .gsub(/[[:space:]]+/, ' ')
+    end
+
+    def empty_element?(node) = node.element? && !self_closing?(node) && !content?(node)
+
+    def content?(node) = text?(node) || (node.element? && node.children.any? { content_or_self_closing?(_1) })
+
+    def content_or_self_closing?(node) = self_closing?(node) || text?(node) || content?(node)
+
+    def self_closing?(node) = self::SELF_CLOSING.include?(node.name.downcase)
+
+    def text?(node) = node.text? && node.text.present?
+  end
+end

data/config/rubocop/default.yml

@@ -0,0 +1,96 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  # Always enable new cops, disabling manually when they don't fit.
+  EnabledByDefault: true
+  NewCops: enable
+  SuggestExtensions: false
+
+# ----------------------------------------------------------------------------------------------------------------------
+# Coding Style
+# ----------------------------------------------------------------------------------------------------------------------
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/SuppressedException:
+  AllowComments: true
+
+Performance/FlatMap:
+  EnabledForFlattenWithoutParams: true
+
+Style/DateTime:
+  AllowCoercion: true
+
+# ----------------------------------------------------------------------------------------------------------------------
+# Cops that should not be run
+# ----------------------------------------------------------------------------------------------------------------------
+
+# Recommends each array item be on its own line.
+Layout/MultilineArrayLineBreaks:
+  Enabled: false
+
+# Recommends right hand side of multi-line assignment be on a new line
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+# Wants every argument in a multi-line method call to be on its own line
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: false
+
+# Recommends squishing a multi-line hash into one line. I don't like that. It's not readable.
+Layout/RedundantLineBreak:
+  Enabled: false
+
+# Recommends `::File` instead of `File`
+Lint/ConstantResolution:
+  Enabled: false
+
+# Recommends Integer(xxx, 10) instead of xxx.to_i
+Lint/NumberConversion:
+  Enabled: false
+
+# Seriously? "Postmaster" is racist now?
+Naming/InclusiveLanguage:
+  Enabled: false
+
+# String#drop is not a function, and besides, arr.drop(n) doesn't read better than arr[n..]
+Performance/ArraySemiInfiniteRangeSlice:
+  Enabled: false
+
+# I want to chain flatten/compact/uniq
+Performance/ChainArrayAllocation:
+  Enabled: false
+
+# Converts if-elsif to case-when.
+Style/CaseLikeIf:
+  Enabled: false
+
+# Wants every constant to be listed in #public_constant or #private_constant
+Style/ConstantVisibility:
+  Enabled: false
+
+# Converts [1, 2, three: 3] to [1, 2, { three: 3 }]
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Prefers `if !condition` over `unless condition`
+Style/InvertibleUnlessCondition:
+  Enabled: false
+
+# Converts `a_method 1` to `a_method(1)`
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+# Not every `if` needs an `else`
+Style/MissingElse:
+  Enabled: false
+
+# Hashes that come from a database JSON column use strings for keys
+Style/StringHashKeys:
+  Enabled: false
+
+# I consider myself capable of understanding logical operators in an unless
+Style/UnlessLogicalOperators:
+  Enabled: false

data/config/rubocop/rails.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rails
+
+AllCops:
+  # Exclude auto-generated files and uploads
+  Exclude:
+    - 'bin/**/*'
+    - 'db/schema.rb'
+    - 'node_modules/**/*'
+    - 'public/**/*'
+    - 'storage/**/*'
+
+Rails:
+  Enabled: true
+
+# There are a ton of times I don't want to validate!
+Rails/SkipsModelValidations:
+  Enabled: false
+
+# This cop "may detect #to_s calls that are not related to Active Support"
+Rails/ToSWithArgument:
+  Enabled: false

data/lib/fustrate/rails/concerns/clean_attributes.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+module Fustrate
+  module Rails
+    module Concerns
+      module CleanAttributes
+        extend ::ActiveSupport::Concern
+
+        STRING_TYPES = %i[string text citext].freeze
+
+        # Collapse multiple spaces, remove leading/trailing whitespace, and remove carriage returns
+        def self.strip(text)
+          return text.map { strip(_1) } if text.is_a?(::Array)
+
+          return if text.blank?
+
+          text.strip.gsub(/ {2,}/, ' ').gsub(/^[ \t]+|[ \t]+$/, '').gsub(/\r\n?/, "\n").gsub(/\n{3,}/, "\n\n")
+        end
+
+        def self.string_columns(klass)
+          # There's no reason to clean polymorphic type columns
+          polymorphic_type_columns = klass.reflect_on_all_associations
+            .select { _1.options[:polymorphic] }
+            .map { "#{_1.name}_type" }
+
+          klass.columns
+            .select { self::STRING_TYPES.include?(_1.sql_type_metadata.type) }
+            .reject { polymorphic_type_columns.include?(_1.name) }
+            .map(&:name)
+        end
+
+        def self.clean_record(record)
+          string_columns(record.class).each do |attribute|
+            next unless record[attribute]
+
+            record[attribute] = strip record[attribute]
+          end
+        end
+
+        included do
+          before_validation { ::Fustrate::Rails::Concerns::CleanAttributes.clean_record(self) }
+        end
+      end
+    end
+  end
+end

data/lib/fustrate/rails/concerns/model.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+module Fustrate
+  module Rails
+    module Concerns
+      module Model
+        extend ::ActiveSupport::Concern
+
+        module ClassMethods
+          # Allow models to define a more reasonable name, usually used to remove a module/namespace.
+          def human_name(new_name = nil)
+            @human_name = new_name.to_s if new_name
+
+            @human_name ||= to_s.underscore.gsub(%r{\A.*/}, '')
+          end
+
+          def build_from_params(permitted_params, **attributes)
+            key = attributes.delete(:params_key)
+
+            new(**attributes) { _1.assign_params(permitted_params, key:) }
+          end
+        end
+
+        included do
+          self.abstract_class = true
+          self.inheritance_column = :_disabled
+
+          # Assign strong parameters based on the class name - just a convenience method for services.
+          def assign_params(permitted_params, key: nil)
+            if key == false
+              assign_attributes ::Current.params.permit(permitted_params)
+            else
+              assign_attributes ::Current.params.require(key || default_param_key).permit(permitted_params)
+            end
+          end
+
+          # Define a different Editable record to log edits on
+          def log_edits_on = self
+
+          def default_param_key = ::ActiveModel::Naming.param_key(self.class)
+        end
+      end
+    end
+  end
+end

data/lib/fustrate/rails/concerns/sanitize_html.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+module Fustrate
+  module Rails
+    module Concerns
+      module SanitizeHtml
+        extend ::ActiveSupport::Concern
+
+        def self.sanitize(html, config) = smart_strip ::Sanitize.fragment(normalize(html), config)
+
+        # Remove non-breaking & ideographic spaces before sanitizing, and un-fancy quotes.
+        def self.normalize(html) = html.tr('‘’“”', %q(''"")).gsub(/(?:[\u00A0\u3000]| ) ?/, ' ')
+
+        # There shouldn't be whitespace or newlines at the beginning or end of the text
+        def self.smart_strip(html) = html.gsub(/\A(?:[[:space:]]|<br>)+|(?:[[:space:]]|<br>)+\z/, '')
+
+        module ClassMethods
+          def sanitize_html(*attributes, config)
+            before_validation do
+              attributes.flatten.each do |attribute|
+                next unless self[attribute]
+
+                self[attribute] = ::Fustrate::Rails::Concerns::SanitizeHtml.sanitize(self[attribute], config)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fustrate/rails/engine.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
 require 'rails/engine'
 
-require 'bourbon'
-require 'js-routes'
-require 'modernizr-rails'
-require 'momentjs-rails'
-require 'font-awesome-rails'
+require 'fustrate/rails/concerns/clean_attributes'
+require 'fustrate/rails/concerns/model'
+require 'fustrate/rails/concerns/sanitize_html'
+
+require 'fustrate/rails/services/base'
+require 'fustrate/rails/services/generate_csv'
+require 'fustrate/rails/services/generate_excel'
+require 'fustrate/rails/services/log_edit'
 
 module Fustrate
   module Rails
-    class Engine < ::Rails::Engine
-    end
+    class Engine < ::Rails::Engine; end
   end
 end

data/lib/fustrate/rails/services/base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+module Fustrate
+  module Rails
+    module Services
+      class Base
+        # Lets us use `t` and `l` helpers.
+        include ::ActionView::Helpers::TranslationHelper
+
+        protected
+
+        def service(service_class) = service_class.new
+
+        def authorize(action, resource) = ::Authority.enforce(action, resource, ::Current.user)
+
+        def transaction(&) = ::ActiveRecord::Base.transaction(&)
+
+        class LoadPage < self
+          DEFAULT_ORDER = nil
+          DEFAULT_INCLUDES = nil
+          RESULTS_PER_PAGE = 25
+
+          def call(page: nil, includes: nil, scope: nil, order: nil)
+            (scope || default_scope)
+              .reorder(order || default_order)
+              .paginate(page: page || params[:page], per_page: self.class::RESULTS_PER_PAGE)
+              .includes(includes || self.class::DEFAULT_INCLUDES)
+          end
+
+          protected
+
+          def default_scope = (raise ::NotImplementedError, '#default_scope not defined')
+
+          def default_order
+            return self.class::DEFAULT_ORDER.call if self.class::DEFAULT_ORDER.is_a? ::Proc
+
+            self.class::DEFAULT_ORDER
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fustrate/rails/services/generate_csv.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+module Fustrate
+  module Rails
+    module Services
+      class GenerateCsv
+        def call(data) = data.first.is_a?(::Hash) ? csv_from_hash(data) : csv_from_array(data)
+
+        protected
+
+        def csv_from_hash(data)
+          ::CSV.generate do |csv|
+            csv << data.first.keys
+
+            data.each do |row|
+              csv << (row.values.map { _1&.to_s&.tr("\n", "\v") })
+            end
+          end
+        end
+
+        def csv_from_array(data)
+          ::CSV.generate do |csv|
+            # It's just an array of arrays; the first row is likely the header
+            data.each do |row|
+              csv << (Array(row).map { _1&.to_s&.tr("\n", "\v") })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fustrate/rails/services/generate_excel.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Copyright (c) Steven Hoffman
+# All rights reserved.
+
+module Fustrate
+  module Rails
+    module Services
+      class GenerateExcel
+        def call(data, name = 'Sheet 1')
+          ::Axlsx::Package.new do |package|
+            package.use_shared_strings = true
+
+            @wrap = package.workbook.styles.add_style(alignment: { wrap_text: true })
+
+            package.workbook.add_worksheet(name:) { add_data_to_sheet(data, _1) }
+
+            return package.to_stream.read
+          end
+        end
+
+        protected
+
+        def add_data_to_sheet(data, sheet)
+          sheet.add_row data.first.keys if data.any?
+
+          data.each { sheet.add_row _1.values, style: @wrap }
+        end
+      end
+    end
+  end
+end