delay_henka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8976109f2133f416e0e81dbab3c03e101e100dff
+  data.tar.gz: b6a2fc83de719b7a333aa4b7fdb4d584af0c5b82
+SHA512:
+  metadata.gz: 2ea718d1951b2bed9ae1b852567aa8668a56ad02d2c04c2f7d36670444906b2c52cdfafb959fa32329ac47606065e619bdcaf8eaf82cb3b506caeb95beda2697
+  data.tar.gz: 27be8e5efb7253009ad6d4c7e2ebdc6b69b3436547d5e56cbf420c790d86e4d24ee1a47331fff3c807902d2fa1f5e7905983afade71ce01a0182a7f2c6cb4acc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 zino
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Delay Henka
+
+'Henka' is Japanese for 'change'.
+
+`DelayHenka` is a Rails engine for managing delayed update of attributes. This is built to ensure that important attributes (such as price of a product, for instance) can be updated anytime but will not impact users until a specific time later in the day (maybe 2am in the morning, when it's safe to apply those changes).
+
+Granted, there're other strategies with higher level of integrity (such as versioning the resources). This implementation is merely a low-cost solution that solves the problem to a reasonable extent.
+
+## Usage
+
+In the including application,
+```ruby
+# copy over migrations
+`bundle exec rails delay_henka:install:migrations`
+`bundle exec rails db:migrate`
+
+# config/routes.rb
+mount DelayHenka::Engine, at: '/delay_henka'
+
+# Create an initilazer delay_henka.rb
+DelayHenka.setup do |config|
+  # Sets the base controller of the engine views
+  config.base_view_controller = 'Backend::BaseController'
+end
+
+# In your model that you want to have delayed updates,
+class SomeModel < ApplicationRecord
+  # This gives instances of this class `#upcoming_changes` association with staged ScheduledChange
+  include DelayHenka::Model
+end
+
+# In your controller (or factory service),
+class SomeController
+  def update
+    product = SomeModel.find(params[:id])
+    delayed_changes = some_params.extract!(:discount_pct, :price)
+    if product.update some_params.except(:discount_pct, :price)
+      DelayHenka::ScheduledChange.schedule(record: product, changes: delayed_changes, by_id: current_user.id)
+      redirect_to #..., success
+    else
+      render :edit
+    end
+  end
+end
+
+# To view scheduled changes associated with a record,
+# some_view.html.haml
+- if @product.upcoming_changes.any?
+  = render 'delay_henka/web/admin/scheduled_changes/summary_table', scheduled_changes: @product.upcoming_changes
+
+# To view all scheduled changes, use this link:
+delay_henka.web_admin_scheduled_changes_path
+
+# To schedule the worker that applies all changes,
+# in your sidekiq config/schedule.yml,
+apply_scheduled_changes:
+  cron: "0 1 * * *"
+  class: DelayHenka::ApplyChangesWorker
+  queue: default
+```
+
+### States of ScheduledChange
+
+* STAGED:     initial state
+* REPLACED:   replaced by another record updating the same attribute
+* COMPLETED:  change is applied successfully
+* ERRORED:    change failed to be applied
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delay_henka'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Development
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Note that a mock AR class - `Foo` - is created dynamically in rails_helper.rb for testing.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DelayHenka'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/delay_henka_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/delay_henka .js
+//= link_directory ../stylesheets/delay_henka .css

data/app/assets/javascripts/delay_henka/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/delay_henka/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/delay_henka/application_controller.rb

@@ -0,0 +1,5 @@
+module DelayHenka
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/delay_henka/web/admin/scheduled_changes_controller.rb

@@ -0,0 +1,26 @@
+module DelayHenka
+  module Web
+    module Admin
+      class ScheduledChangesController < DelayHenka.base_view_controller.constantize
+
+        before_action :set_scheduled_change, only: %i(destroy)
+
+        def index
+          @changes = ScheduledChange.order('created_at DESC')
+        end
+
+        def destroy
+          @change.destroy!
+          redirect_back fallback_location: web_admin_scheduled_changes_path, flash: {success: 'Destroy succeeded'}
+        end
+
+        private
+
+        def set_scheduled_change
+          @change = ScheduledChange.find(params[:id])
+        end
+
+      end
+    end
+  end
+end

data/app/helpers/delay_henka/application_helper.rb

@@ -0,0 +1,4 @@
+module DelayHenka
+  module ApplicationHelper
+  end
+end

data/app/models/delay_henka/application_record.rb

@@ -0,0 +1,5 @@
+module DelayHenka
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/delay_henka/scheduled_change.rb

@@ -0,0 +1,46 @@
+module DelayHenka
+  class ScheduledChange < ApplicationRecord
+
+    STATES = {
+      STAGED: 'staged',
+      REPLACED: 'replaced',
+      COMPLETED: 'completed',
+      ERRORED: 'errored'
+    }
+
+    belongs_to :changeable, polymorphic: true
+
+    validates :submitted_by_id, :attribute_name, presence: true
+    validates :state, inclusion: { in: STATES.values }
+    after_initialize :set_initial_state, if: :new_record?
+
+    scope :staged, -> { where(state: STATES[:STAGED]) }
+
+    def self.schedule(record:, changes:, by_id:)
+      changes.each do |attribute, new_val|
+        old_val = record.public_send(attribute)
+        next if old_val == new_val
+        create!(changeable: record, submitted_by_id: by_id, attribute_name: attribute, old_value: old_val, new_value: new_val)
+      end
+    end
+
+    def apply_change
+      if changeable.update(attribute_name => new_value)
+        update(state: STATES[:COMPLETED])
+      else
+        update(state: STATES[:ERRORED], error_message: changeable.errors.full_messages.join(', '))
+      end
+    end
+
+    def replace_change
+      update(state: STATES[:REPLACED])
+    end
+
+    private
+
+    def set_initial_state
+      self.state ||= STATES[:STAGED]
+    end
+
+  end
+end

data/app/views/delay_henka/web/admin/scheduled_changes/_summary_table.html.haml

@@ -0,0 +1,20 @@
+-# This partial is rendered by including application.
+-# Required local variables:
+-#  * scheduled_changes
+-# To render this partial:
+-#  = render 'delay_henka/web/admin/scheduled_changes/summary_table', scheduled_changes: @changes
+
+%table.table.table-bordered
+  %thead
+    %tr
+      %th Attribute
+      %th Old Value
+      %th New Value
+      %th Action
+  %tbody
+    - scheduled_changes.each do |change|
+      %tr
+        %td= change.attribute_name.humanize
+        %td= change.old_value
+        %td= change.new_value
+        %td= link_to 'Delete', delay_henka.web_admin_scheduled_change_path(change), method: :delete

data/app/views/delay_henka/web/admin/scheduled_changes/index.html.haml

@@ -0,0 +1,21 @@
+%h1 Scheduled Changes
+%table.table
+  %thead
+    %tr
+      %th Type
+      %th Id
+      %th Attribute
+      %th State
+      %th Old Value
+      %th New Value
+      %th Submitted By
+  %tbody
+    - @changes.each do |change|
+      %tr
+        %td= change.changeable_type
+        %td= change.changeable_id
+        %td= change.attribute_name
+        %td= change.state
+        %td= change.old_value
+        %td= change.new_value
+        %td= change.submitted_by_id

data/app/views/layouts/delay_henka/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Delay henka</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "delay_henka/application", media: "all" %>
+  <%= javascript_include_tag "delay_henka/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/workers/delay_henka/apply_changes_worker.rb

@@ -0,0 +1,19 @@
+module DelayHenka
+  class ApplyChangesWorker
+
+    include Sidekiq::Worker
+
+    def perform
+      ScheduledChange.staged
+        .includes(:changeable)
+        .group_by{ |change| [change.changeable_type, change.changeable_id, change.attribute_name] }
+        .values
+        .each do |changes_for_attribute|
+          latest_change = changes_for_attribute.sort_by(&:created_at).last
+          (changes_for_attribute - [latest_change]).each(&:replace_change)
+          latest_change.apply_change
+        end
+    end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+DelayHenka::Engine.routes.draw do
+  namespace :web do
+    namespace :admin do
+      resources :scheduled_changes, only: %i(index destroy)
+    end
+  end
+end

data/db/migrate/20181228205218_create_delay_henka_scheduled_changes.rb

@@ -0,0 +1,15 @@
+class CreateDelayHenkaScheduledChanges < ActiveRecord::Migration[5.2]
+  def change
+    create_table :delay_henka_scheduled_changes do |t|
+      t.string :changeable_type, null: false
+      t.integer :changeable_id, null: false
+      t.string :attribute_name, null: false
+      t.integer :submitted_by_id, null: false
+      t.string :state, null: false
+      t.text :error_message
+      t.jsonb :old_value
+      t.jsonb :new_value
+      t.timestamps
+    end
+  end
+end

data/lib/delay_henka/engine.rb

@@ -0,0 +1,9 @@
+module DelayHenka
+  class Engine < ::Rails::Engine
+    isolate_namespace DelayHenka
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/delay_henka/version.rb

@@ -0,0 +1,3 @@
+module DelayHenka
+  VERSION = '0.1.0'
+end

data/lib/delay_henka.rb

@@ -0,0 +1,24 @@
+require "delay_henka/engine"
+require 'haml'
+require 'pry'
+
+module DelayHenka
+
+  module Model
+    extend ActiveSupport::Concern
+    included do
+      has_many :upcoming_changes,
+        ->{ staged.order('created_at DESC') },
+        class_name: 'DelayHenka::ScheduledChange',
+        as: :changeable
+    end
+  end
+
+  mattr_accessor :base_view_controller
+  @@base_view_controller = 'DelayHenka::ApplicationController'
+
+  def self.setup
+    yield self
+  end
+
+end

data/lib/tasks/delay_henka_tasks.rake

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

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: delay_henka
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+description: ActiveRecord-based engine for scheduled changes
+email:
+- rhu5@u.rochester.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/delay_henka_manifest.js
+- app/assets/javascripts/delay_henka/application.js
+- app/assets/stylesheets/delay_henka/application.css
+- app/controllers/delay_henka/application_controller.rb
+- app/controllers/delay_henka/web/admin/scheduled_changes_controller.rb
+- app/helpers/delay_henka/application_helper.rb
+- app/models/delay_henka/application_record.rb
+- app/models/delay_henka/scheduled_change.rb
+- app/views/delay_henka/web/admin/scheduled_changes/_summary_table.html.haml
+- app/views/delay_henka/web/admin/scheduled_changes/index.html.haml
+- app/views/layouts/delay_henka/application.html.erb
+- app/workers/delay_henka/apply_changes_worker.rb
+- config/routes.rb
+- db/migrate/20181228205218_create_delay_henka_scheduled_changes.rb
+- lib/delay_henka.rb
+- lib/delay_henka/engine.rb
+- lib/delay_henka/version.rb
+- lib/tasks/delay_henka_tasks.rake
+homepage: https://github.com/zinosama/delay_henka
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Rails engine for scheduled changes
+test_files: []