plok 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79336cf5991e14af6e352e3d80b16f8acdd84351a55b746e16a50281e93fc74d
-  data.tar.gz: 27e9ce0535aa34efe754ef698110e9d4178e1f7f63420cc89e625c7ba6967416
+  metadata.gz: 7c83d448013e7832bf4b624c51592b39f336a642b9edf197135792ac4418a63e
+  data.tar.gz: c7ea5c310c9f68f4005b04750bc1bc93696846ec0f8c6b4ec7147c298d978af7
 SHA512:
-  metadata.gz: e82b8263bcd29fbaf48dad8dc30f45d458c46d8cdf3bad552c5bc568dec7678090645c06c9bf03d0fb25aa437556b610ff957b3e3ef57a26266fdb5ceb5a12a8
-  data.tar.gz: de6a608365e8b62cad80cbc6435ecb3f76f9569fb8df2d67255701a559c54bc99a9a59c8c5ec83aab4cdc11e6d704b4b82b3901a52c9b8d73f36ad881abb99c4
+  metadata.gz: 48743033cccfda8512c87be249cf4e1441e47821183aeb95a6fe1451b0a301daff5bbd7c0543f121e9742ac5009f68ae9c3adf74ddf7791ec27ba0fa5c42407a
+  data.tar.gz: 13da11c0ed6a34dda6acae4f9d28a7d3db3cf20f549d2cbfd0365d9e60ebaac7c8f15c8c06e951ea7f545bfee75fdc9d2cade0261fb0c074ac567cecd07cfe9b

data/app/models/concerns/plok/loggable.rb

@@ -0,0 +1,17 @@
+module Plok::Loggable
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :logs, as: :loggable, dependent: :nullify
+  end
+
+  def log(message, category = nil, data = {})
+    data = data.permit!.to_h if data.is_a?(ActionController::Parameters)
+
+    logs.create!(
+      content: message,
+      category: category,
+      data: data
+    )
+  end
+end

data/app/models/log.rb

@@ -0,0 +1,24 @@
+class Log < ActiveRecord::Base
+  belongs_to :loggable, polymorphic: true
+
+  serialize :data, Hash
+
+  # TODO: A file column is currently used in Raamwinkel to link either PDFs or
+  # images to a log message. We'd prefer not use Uploader classes in Plok, so
+  # I'll leave this comment as a reference until assets become available in
+  # Plok.
+  #mount_uploader :file, LogFileUploader
+
+  default_scope { order('created_at DESC, id DESC') }
+  scope :status, -> { where(category: 'status') }
+
+  validate :some_content_present?
+
+  def self.latest
+    Log.first # default_scope sorts in descending order.
+  end
+
+  def some_content_present?
+    errors.add(:content, :blank) if file.blank? && content.blank?
+  end
+end

data/db/migrate/20211008130809_create_plok_logs.rb

@@ -0,0 +1,16 @@
+class CreatePlokLogs < ActiveRecord::Migration[6.1]
+  def change
+    return if table_exists?(:logs)
+
+    create_table :logs do |t|
+      t.string :category
+      t.string :loggable_type
+      t.integer :loggable_id
+      t.string :file
+      t.text :content
+      t.text :data
+
+      t.timestamps
+    end
+  end
+end

data/lib/plok/engine.rb

@@ -1,4 +1,46 @@
+# Can't use Plok::Engine.root yet at this point.
+engine_root = File.expand_path('../..', __dir__)
+Dir.glob("#{engine_root}/app/models/**/*.rb").each { |file| require file }
+
 module Plok
   class Engine < ::Rails::Engine
+    # https://hocnest.com/blog/testing-an-engine-with-rspec/
+    # https://edgeguides.rubyonrails.org/engines.html#critical-files
+    # This makes it so generators, helpers,... always reside in the engine's
+    # namespace. So when a model gets generated, it gets put into
+    # app/models/plok/log.rb.
+    #
+    # As you can see this is off for now, but if you do want it turned on
+    # you can always do "Log = Plok::Log" in an initializer file to ease the
+    # transition.
+    #isolate_namespace Plok
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def class_exists?(class_name)
+      klass = Module.const_get(class_name.to_s)
+      klass.is_a?(Class)
+    rescue NameError
+      return false
+    end
+
+    def module_exists?(module_name)
+      # By casting to a string and making a constant, we can assume module_name
+      # can be either one without it being a problem.
+      module_name.to_s.constantize.is_a?(Module)
+    rescue NameError
+      return false
+    end
+
+    # You can call this in your spec/rails_helper.rb file so you can make use
+    # of the spec supports to test concerns.
+    #
+    # You cannot call it in the engine itself, because RSpec won't have the same
+    # context available when tests are ran.
+    def load_spec_supports
+      Dir.glob("#{root}/spec/{factories,support}/**/*.rb").each { |f| require f }
+    end
   end
 end

data/lib/plok/version.rb

@@ -1,3 +1,3 @@
 module Plok
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/plok.rb

@@ -1,6 +1,5 @@
-require "plok/version"
-require "plok/engine"
+require 'plok/version'
+require 'plok/engine'
 
 module Plok
-  # Your code goes here...
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: plok
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Davy Hellemans
 - Dave Lens
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,6 +39,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: Some basics used for setting up rails projects
 email:
 - davy@blimp.be
@@ -52,8 +80,10 @@ files:
 - app/assets/config/plok_manifest.js
 - app/controllers/catch_all_controller.rb
 - app/controllers/plok/version_controller.rb
-- config/plok.yml
+- app/models/concerns/plok/loggable.rb
+- app/models/log.rb
 - config/routes.rb
+- db/migrate/20211008130809_create_plok_logs.rb
 - lib/plok.rb
 - lib/plok/engine.rb
 - lib/plok/version.rb
@@ -63,7 +93,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,8 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: CMS basics
 test_files: []

data/config/plok.yml

@@ -1,9 +0,0 @@
-development:
-  modules:
-    - flexible_content
-    - snippets
-    - settings
-    - queued_tasks
-    - email_templates
-    - pages
-    - redirects