clockface 1.0.0.beta

data/config/routes.rb

@@ -0,0 +1,15 @@
+Clockface::Engine.routes.draw do
+  root to: "root#index"
+
+  resources :tasks, except: [:show] do
+    # Rails routes don't include a visible deletion page, only a `#destroy`
+    # endpoint. Define a custom one
+    get :delete, to: "tasks#delete"
+  end
+
+  resources :events, except: [:show] do
+    # Rails routes don't include a visible deletion page, only a `#destroy`
+    # endpoint. Define a custom one
+    get :delete, to: "events#delete"
+  end
+end

data/db/migrate/20170528230549_create_clockface_tasks.rb

@@ -0,0 +1,10 @@
+class CreateClockfaceTasks < ActiveRecord::Migration[5.1]
+  def change
+    create_table :clockface_tasks do |t|
+      t.timestamps
+      t.string :name, null: false
+      t.text :description
+      t.string :command, null: false
+    end
+  end
+end

data/db/migrate/20170528234810_create_clockface_events.rb

@@ -0,0 +1,20 @@
+class CreateClockfaceEvents < ActiveRecord::Migration[5.1]
+  def change
+    create_table :clockface_events do |t|
+      t.timestamps
+
+      t.references :clockface_task, foreign_key: true
+      t.boolean :enabled, default: false
+      t.boolean :skip_first_run, default: false
+      t.string :tenant
+      t.datetime :last_triggered_at
+      t.integer :period_value, null: false
+      t.string :period_units, null: false
+      t.integer :day_of_week
+      t.integer :hour
+      t.integer :minute
+      t.string :time_zone
+      t.string :if_condition
+    end
+  end
+end

data/lib/clockface.rb

@@ -0,0 +1,135 @@
+require "clockwork"
+require "clockwork/database_events"
+
+require_relative "./clockwork/database_events/synchronizer"
+require_relative "../app/helpers/clockface/config_helper"
+require_relative "../app/helpers/clockface/logging_helper"
+
+require "clockface/engine"
+require "clockface/version"
+
+# This file is the glue that ties together the clockwork gem with the Clockface
+# Engine functionality.
+#
+# Clockface uses the `sync_database_events` method provided by Clockwork to
+# periodically refresh the list of events from a DB table.
+#
+# In the case of multi-tenancy, there needs to be one refresh event for each
+# individual tenant, but the same concept applies.
+#
+# Here's what happens -
+#
+# 1. Users require this file in their individual `clock.rb` files
+#    which in turn loads the engine directly. The engine is called by Rails
+#    during the startup process but we also need to load it here as part of the
+#    environment that's loaded by the clock process
+#
+# 2. As mentioned above, Clockwork provides the `sync_database_events` method
+#    as part of its API. However, we want to make things as easy as possible for
+#    each user and we want to take care of error handling, logging, and updating
+#    records as well in a predictable fashion. The solution to that is to define
+#    *another* custom `sync_database_events` below, which calls the original
+#    Clockwork method. When users call `sync_database_events` it will hit this
+#    wrapper which will take care of all the above tasks and defer execution to
+#    the Clockwork method.
+#
+# 3. Clockwork doesn't support schema-based multi-tenancy. In order
+#    to get that we need to override the Synchronizer it uses to create a synch
+#    event for each individual tenant. That overriden synchronizer is loaded at
+#    the top of this file. See that file for further background
+
+module Clockface
+  module Methods
+    # rubocop:disable Metrics/MethodLength
+    def sync_database_events(opts = {}, &block)
+      ::Clockwork.manager = ::Clockwork::DatabaseEvents::Manager.new
+
+      unless block_given?
+        raise "Please specify a block to Clockface::sync_database_events"
+      end
+
+      #
+      # Configure Clockwork
+      #
+
+      Clockwork.manager.configure do |config|
+        # The underlying Clockwork gem tries to set time zone in the following
+        # order
+        #
+        #   a. Event-specific time
+        #   b. Clockwork Configured time (Clockwork.manager.config[:tz])
+        #   c. System Time
+        #
+        # Clockface enforces that each event *must* have a time zone. It
+        # defaults to the `clockface_time_zone` when the user doesn't choose one
+        #
+        # Clockface also sets the Clockwork configured time to be
+        # `clockface_time_zone` in case for some reason a user updates the DB
+        # record directly and bypasses our validations.
+        #
+        # Howevever this doesn't work as expected right now. See -
+        #   https://github.com/Rykian/clockwork/issues/35
+        #
+        # As far as format, see explanation for time zone format in
+        # `Clockface::Event#tz`
+        config[:tz] = ActiveSupport::TimeZone::MAPPING[clockface_time_zone]
+      end
+
+      clockwork_opts =
+        { model: Clockface::Event, every: opts[:every] }
+
+      ::Clockwork.sync_database_events(clockwork_opts) do |event|
+        event_name = "\"#{event.name}\" (Event.id: #{event.id})"
+        tenant_tag = "[#{event.tenant}] " if event.tenant
+
+        unless event.enabled?
+          clockface_log(
+            :info,
+            "#{tenant_tag}Skipping disabled Event #{event_name}"
+          )
+
+          # This whole block is eventually invoked from
+          # `Clockwork::Event#execute` using `block.call(...)`. Using `return`
+          # inside a called object returns from the whole process, so we have
+          # to use `next` instead to return from just the block itself
+          # Further explanation: https://stackoverflow.com/a/1435781/2490003
+          next
+        end
+
+        begin
+          # We want to do 2 things here -
+          #
+          #   1. Update the timestamp. Do this before any event execution so
+          #      that if this fails, we don't continue with execution
+          #   2. Execute the event
+          #
+          #
+          # In the case of multi-tenancy we want to execute both of the
+          # above in the context of the correct tenant.
+
+          clockface_log(:info, "#{tenant_tag}Running Event #{event_name}")
+
+          cmd = proc { event.update!(last_triggered_at: Time.zone.now) }
+
+          if clockface_multi_tenancy_enabled?
+            clockface_execute_in_tenant(event.tenant, cmd)
+            clockface_execute_in_tenant(event.tenant, block, [event])
+          else
+            cmd.call
+            yield(event)
+          end
+        rescue StandardError => e
+          clockface_log(
+            :error,
+            "#{tenant_tag}Error running Event #{event_name} -> #{e.message}"
+          )
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+
+  extend ::Clockface::ConfigHelper
+  extend ::Clockface::LoggingHelper
+  extend Methods
+end

data/lib/clockface/engine.rb

@@ -0,0 +1,79 @@
+require "bootstrap-sass"
+require "inline_svg"
+require "interactor"
+
+module Clockface
+  class Engine < ::Rails::Engine
+    isolate_namespace Clockface
+
+    config.generators do |generate|
+      generate.factory_girl true
+      generate.helper false
+      generate.javascript_engine false
+      generate.request_specs false
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+    end
+
+    # Ensure this initializer runs before the host applications initializers
+    # so that the config structure gets defined.
+    initializer "clockface.config", before: :load_config_initializers do |app|
+      ClockfaceConfig = Struct.new(
+        :time_zone,
+        :logger,
+        :tenant_list,
+        :current_tenant_proc,
+        :execute_in_tenant_proc
+      )
+
+      app.config.clockface = ClockfaceConfig.new
+      app.config.clockface.time_zone = Rails.application.config.time_zone
+      app.config.clockface.logger = Rails.logger
+
+      # Multi Tenancy
+      app.config.clockface.tenant_list = []
+      app.config.clockface.current_tenant_proc = nil
+      app.config.clockface.execute_in_tenant_proc = nil
+    end
+
+    # Ensure this initializer runs after the host applications initializers
+    # so it can verify what was configured
+    initializer "clockface.validate", after: :load_config_initializers do |app|
+      # Time Zone
+      time_zone = app.config.clockface.time_zone
+      valid_time_zones = ActiveSupport::TimeZone::MAPPING.keys
+      unless valid_time_zones.include?(time_zone)
+        raise "Invalid time zone #{time_zone}"
+      end
+
+      # Log
+      loggers = app.config.clockface.logger
+      loggers = [loggers] unless loggers.is_a?(Array)
+      methods = %i[debug info warn error fatal]
+      loggers.each do |logger|
+        methods.each do |m|
+          unless logger.respond_to?(m)
+            raise "At least one logger is invalid. Did not respond to `:#{m}`"
+          end
+        end
+      end
+
+      # Tenant List
+      app.config.clockface.tenant_list = app.config.clockface.tenant_list.uniq
+
+      # Current Tenant
+      p = app.config.clockface.current_tenant_proc
+      if app.config.clockface.tenant_list.any? && p.blank?
+        raise "`current_tenant_proc` must be defined for multi-tenant mode"
+      end
+
+      # Execute In Tenant
+      p = app.config.clockface.execute_in_tenant_proc
+      if app.config.clockface.tenant_list.any? && p.blank?
+        raise "`execute_in_tenant_proc` must be defined for multi-tenant mode"
+      end
+    end
+  end
+end

data/lib/clockface/version.rb

@@ -0,0 +1,3 @@
+module Clockface
+  VERSION = "1.0.0.beta".freeze
+end

data/lib/clockwork/database_events/synchronizer.rb

@@ -0,0 +1,73 @@
+require "clockwork/database_events"
+require_relative "../../../app/helpers/clockface/config_helper"
+require_relative "../../../app/helpers/clockface/logging_helper"
+
+# Loaded from lib/clockface as part of the clock configuration
+#
+# Clockwork doesn't support schema-based multi-tenancy by default. To acheive
+# functionality we need to have it create a synch event for each individual
+# tenant
+#
+# This overrides the Synchronizer class in the native Clockwork implementation
+# to do the following -
+#
+#   1. If multi-tenancy is enabled, create a synch event for each tenant
+#   2. If not, just create one synch event (same Clockwork functionality)
+
+module Clockwork
+  module DatabaseEvents
+    class Synchronizer
+      extend ::Clockface::ConfigHelper
+      extend ::Clockface::LoggingHelper
+
+      def self.setup(options = {}, &block_to_perform_on_event_trigger)
+        every = options.fetch(:every) do
+          raise KeyError, ":every must be set to the database sync frequency"
+        end
+
+        task_name = "sync_database_events"
+
+        #
+        # Multi-Tenant
+        #
+
+        if clockface_multi_tenancy_enabled?
+          clockface_tenant_list.each do |t|
+            event_store = EventStore.new(block_to_perform_on_event_trigger)
+
+            Clockwork.manager.every(every, "#{t}.#{task_name}") do
+              cmd = proc do
+                # 1. Pre-load `:task` association so it doesn't need to be
+                #    re-queried
+                # 2. ActiveRecord lazily evaluates the query, so #all won't
+                #    actually run against the DB when executed. Force it to
+                #    execute by calling something on it (e.g. #to_a)
+                Clockface::Event.
+                  includes(:task).
+                  all.
+                  tap(&:to_a)
+              end
+              models = clockface_execute_in_tenant(t, cmd)
+
+              clockface_log(:info, "[#{t}] Running #{t}.#{task_name}")
+              event_store.update(models)
+            end
+          end
+
+          return
+        end
+
+        #
+        # Single Tenant
+        #
+
+        event_store = EventStore.new(block_to_perform_on_event_trigger)
+
+        Clockwork.manager.every(every, task_name) do
+          clockface_log(:info, "Running #{task_name}")
+          event_store.update(Clockface::Event.all)
+        end
+      end
+    end
+  end
+end

data/lib/tasks/clockface_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :clockface do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: clockface
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+platform: ruby
+authors:
+- Abhishek Chandrasekhar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: clockwork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: inline_svg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A Configuration UI for the Clockwork gem
+email:
+- me@abhchand.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/clockface_manifest.js
+- app/assets/images/clockface/clockface.svg
+- app/assets/javascripts/clockface/application.js
+- app/assets/javascripts/clockface/flash.js
+- app/assets/javascripts/clockface/sorttable.js
+- app/assets/stylesheets/clockface/application.scss
+- app/assets/stylesheets/clockface/application/_fonts.scss
+- app/assets/stylesheets/clockface/application/colors.scss
+- app/assets/stylesheets/clockface/application/flash.scss
+- app/assets/stylesheets/clockface/application/footer.scss
+- app/assets/stylesheets/clockface/application/nav.scss
+- app/assets/stylesheets/clockface/events/delete.scss
+- app/assets/stylesheets/clockface/events/event_form.scss
+- app/assets/stylesheets/clockface/events/index.scss
+- app/assets/stylesheets/clockface/tasks/delete.scss
+- app/assets/stylesheets/clockface/tasks/index.scss
+- app/assets/stylesheets/clockface/tasks/task_form.scss
+- app/controllers/clockface/application_controller.rb
+- app/controllers/clockface/events_controller.rb
+- app/controllers/clockface/root_controller.rb
+- app/controllers/clockface/tasks_controller.rb
+- app/events/clockface/application_job.rb
+- app/helpers/clockface/application_helper.rb
+- app/helpers/clockface/config_helper.rb
+- app/helpers/clockface/events_helper.rb
+- app/helpers/clockface/logging_helper.rb
+- app/mailers/clockface/application_mailer.rb
+- app/models/clockface/application_record.rb
+- app/models/clockface/event.rb
+- app/models/clockface/task.rb
+- app/presenters/clockface/events_presenter.rb
+- app/services/clockface/event_validation_interactor.rb
+- app/services/clockface/task_validation_interactor.rb
+- app/views/clockface/application/_flash.html.erb
+- app/views/clockface/application/_footer.html.erb
+- app/views/clockface/application/_nav.html.erb
+- app/views/clockface/events/_event_form.html.erb
+- app/views/clockface/events/delete.html.erb
+- app/views/clockface/events/edit.html.erb
+- app/views/clockface/events/index.html.erb
+- app/views/clockface/events/new.html.erb
+- app/views/clockface/tasks/_task_form.html.erb
+- app/views/clockface/tasks/delete.html.erb
+- app/views/clockface/tasks/edit.html.erb
+- app/views/clockface/tasks/index.html.erb
+- app/views/clockface/tasks/new.html.erb
+- app/views/layouts/clockface/application.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20170528230549_create_clockface_tasks.rb
+- db/migrate/20170528234810_create_clockface_events.rb
+- lib/clockface.rb
+- lib/clockface/engine.rb
+- lib/clockface/version.rb
+- lib/clockwork/database_events/synchronizer.rb
+- lib/tasks/clockface_tasks.rake
+homepage: https://gitlab.com/abhchand/clockface
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: A Configuration UI for the Clockwork gem
+test_files: []