raes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6043ba9c36590180a011fbf26a25f7c84e20c6f9817bc580b7c0f50fd9b1e44
+  data.tar.gz: 259f6da4d4546da83eb11a874e2ce08d5db951065e372b22270d0e3ae6923386
+SHA512:
+  metadata.gz: 0e7e932f79f460e372e505f86e39446736536050d7dd9e637815e945147f42eab26866321c39701143b5ad8e0959421dac6b2ed32f340696eeef54652ebb517d
+  data.tar.gz: f2568c2639857b90b49df2a52e3f1e557126de3ab256bc9e923b9c3867fba0b396966d603b2600791f1788e57f2ef277e149802ad220d10ea82d6e6773ae9b70

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 ogom
+
+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,97 @@
+# Raes
+
+Raes is Rails Async Event Store. Executes a class method call asynchronously.
+Others use Rails' [Active Job](https://edgeguides.rubyonrails.org/active_job_basics.html) and [Active Storage](https://edgeguides.rubyonrails.org/active_storage_overview.html) services to store files.
+
+- Raes (※)
+
+![rice](https://4.bp.blogspot.com/-q86BWyQStFw/WWNAvW36HNI/AAAAAAABFWc/hzm92utRk6AJzd0z2sRYc_WYJ-n3jQKNQCLcBGAs/s100/kome_hakumai.png)
+
+## Usage
+
+Dispatch a class name that has a call method.
+
+### Simple Echo
+
+Same echo call method.
+
+```ruby
+class SimpleEcho
+  include Raes::UseCaller
+
+  def initialize(params)
+    @params = params
+  end
+
+  def call
+    @params
+  end
+end
+```
+
+When executed, `{ message:'Hi' }` is saved in state.
+
+```ruby
+Raes.dispatch(SimpleEcho, { message: 'Hi' })
+Raes.search(SimpleEcho).last.state # "{\"message\":\"Hi\"}"
+```
+
+### File Maker
+
+Rewrite old file newly.
+
+```ruby
+class FileMaker
+  include Raes::UseCaller
+  include Raes::UseStorage
+
+  def initialize(params)
+    @raes_storage_id = params[:raes_storage_id]
+  end
+
+  def call
+    old_file = raes_storage_content
+    new_file = old_file + 'bar'
+
+    raes_storage_attach({ io: StringIO.new(new_file), filename: 'new_file.txt', content_type: 'text/plain' })
+  end
+end
+```
+
+Content will be changed to the new file.
+
+```ruby
+Raes.dispatch(FileMaker, raes_storage: { io: StringIO.new('foo'), filename: 'old_file.txt', content_type: 'text/plain' })
+Raes.search(FileMaker).last.storages.first.content.download # foobar
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'raes'
+```
+
+And then execute:
+
+```bash
+$ bundle
+$ rails raes:install:migrations
+```
+
+If use storage, then execute:
+
+```bash
+$ rails active_storage:install
+```
+
+## Test
+
+```bash
+$ rails app:spec
+```
+
+## 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,24 @@
+# frozen_string_literal: true
+
+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    = 'Raes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/raes_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/raes .css

data/app/assets/stylesheets/raes/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/raes/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Raes
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/async_event_store/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Raes
+  module ApplicationHelper
+  end
+end

data/app/jobs/raes/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Raes
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/raes/subscribe_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Raes
+  class SubscribeJob < ApplicationJob
+    def perform(action)
+      Reducer.call(action)
+    end
+  end
+end

data/app/mailers/raes/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Raes
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/raes/action.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Raes
+  class Action < ApplicationRecord
+    has_many :storages, as: :record
+    enum status: { queued: 0, working: 1, completed: 2, failed: 3 }
+    scope :search, ->(name) { where(name: name.to_s) }
+  end
+end

data/app/models/raes/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Raes
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/raes/storage.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Raes
+  class Storage < ApplicationRecord
+    belongs_to :record, polymorphic: true
+    has_one_attached :content
+    enum status: { created: 0 }
+    scope :search, ->(name) { where(name: name.to_s) }
+  end
+end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Interactor event store</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "raes/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Raes::Engine.routes.draw do
+end

data/db/migrate/20200628202001_create_raes_actions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateRaesActions < ActiveRecord::Migration[6.0]
+  def change
+    create_table :raes_actions do |t|
+      t.integer :status, null: false, default: 0, index: true
+      t.string :name, null: false, default: '', index: true
+      t.json :payload, null: false, default: {}
+      t.json :state, null: false, default: {}
+
+      t.timestamps
+    end
+    add_index :raes_actions, %i[status name]
+  end
+end

data/db/migrate/20200628202002_create_raes_storages.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateRaesStorages < ActiveRecord::Migration[6.0]
+  def change
+    create_table :raes_storages do |t|
+      t.integer :status, null: false, default: 0, index: true
+      t.string :name, null: false, default: '', index: true
+      t.references :record, null: false, polymorphic: true
+
+      t.timestamps
+    end
+    add_index :raes_storages, %i[status name]
+  end
+end

data/lib/raes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'raes/engine'
+require 'raes/use_caller'
+require 'raes/use_storage'
+require 'raes/dispatch'
+require 'raes/reducer'
+
+module Raes
+  def self.dispatch(name, payload = {})
+    Dispatch.call(name, payload)
+  end
+
+  def self.search(name)
+    Action.search(name)
+  end
+end

data/lib/raes/dispatch.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Raes
+  class Dispatch
+    include UseCaller
+
+    def initialize(name, payload = {})
+      @action = Action.create(name: name)
+      @payload = payload
+    end
+
+    def call
+      @action.payload = create_payload.to_json
+      SubscribeJob.perform_later(@action) if @action.save
+      @action
+    end
+
+    def create_payload
+      if @payload[:raes_storage].present?
+        storage = @action.storages.create(name: @action.name, content: @payload[:raes_storage])
+        @payload.delete(:raes_storage)
+        @payload[:raes_storage_id] = storage.id
+      end
+      @payload
+    end
+  end
+end

data/lib/raes/engine.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Raes
+  class Engine < ::Rails::Engine
+    isolate_namespace Raes
+
+    config.generators do |g|
+      g.test_framework :rspec,
+                       controller_specs: false,
+                       helper_specs: false,
+                       request_specs: false,
+                       routing_specs: false,
+                       view_specs: false
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+  end
+end

data/lib/raes/reducer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Raes
+  class Reducer
+    include UseCaller
+
+    def initialize(action)
+      @action = action
+    end
+
+    def call
+      return @action unless @action.queued!
+
+      @action.working!
+      @action.state = create_state.to_json
+      @action.status = :completed
+    rescue StandardError => e
+      @action.state = { message: e }
+      @action.status = :failed
+    ensure
+      @action.save!
+      @action
+    end
+
+    def create_state
+      if @action.name.constantize.method(:call).arity.zero?
+        @action.name.constantize.call
+      else
+        @action.name.constantize.call(JSON.parse(@action.payload).symbolize_keys)
+      end
+    end
+  end
+end

data/lib/raes/use_caller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Raes
+  module UseCaller
+    extend ActiveSupport::Concern
+
+    included do
+      private_class_method :new
+    end
+
+    class_methods do
+      def call(*params)
+        new(*params).send(:call)
+      end
+    end
+
+    private
+
+    def initialize(*params)
+      return if params.empty?
+
+      raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+    end
+
+    def call
+      raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+    end
+  end
+end

data/lib/raes/use_storage.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Raes
+  module UseStorage
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :raes_storage_id
+    end
+
+    private
+
+    def raes_storage_content
+      Storage.find(raes_storage_id).content.download
+    end
+
+    def raes_storage_attach(content)
+      Storage.find(raes_storage_id).content.attach(content)
+    end
+  end
+end

data/lib/raes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Raes
+  VERSION = '0.1.0'
+end

data/lib/tasks/raes_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :raes do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: raes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ogom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: Description of Rails Async Event Store.
+email:
+- ogom@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/raes_manifest.js
+- app/assets/stylesheets/raes/application.css
+- app/controllers/raes/application_controller.rb
+- app/helpers/async_event_store/application_helper.rb
+- app/jobs/raes/application_job.rb
+- app/jobs/raes/subscribe_job.rb
+- app/mailers/raes/application_mailer.rb
+- app/models/raes/action.rb
+- app/models/raes/application_record.rb
+- app/models/raes/storage.rb
+- app/views/layouts/raes/application.html.erb
+- config/routes.rb
+- db/migrate/20200628202001_create_raes_actions.rb
+- db/migrate/20200628202002_create_raes_storages.rb
+- lib/raes.rb
+- lib/raes/dispatch.rb
+- lib/raes/engine.rb
+- lib/raes/reducer.rb
+- lib/raes/use_caller.rb
+- lib/raes/use_storage.rb
+- lib/raes/version.rb
+- lib/tasks/raes_tasks.rake
+homepage: https://github.com/ogom/raes
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Summary of Rails Async Event Store.
+test_files: []