sequent-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4e22995fdd50ae7ac93569a69bb4fea414079f0dba7f0d6271ba61c1c6aa143
+  data.tar.gz: 66802970375645cd5df85d6fb6e78b127674cc467ffdd976338722fd3e743a8b
+SHA512:
+  metadata.gz: 770e604dcd3953f4c68ff1e716a48602b1f57e1c6489f0b43b357569cb1501d3604477631189ad0a89de1051d0e58b95ee778c5a23ca629bbc76ba025d42251d
+  data.tar.gz: 7f676ff3085b24a681188ba369f74030e74852374499986befd079f854703ab6d0ea3f9c2f0f330d5f9347804ba550af6a3df5b4b00a6480e9d0846824e59732

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Sophie Déziel
+
+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,27 @@
+# Sequent-Rails
+Warning: This is an experiment gem, not sutable for production use.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequent-rails'
+```
+
+And then execute:
+```bash
+bundle
+rails generate sequent:install
+rails db:migrate
+```
+
+This will generate a migration file to create Sequent's event store in the database and then run it.
+
+## Contributing
+Contribution directions go here.
+
+## 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,30 @@
+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    = 'Sequent-Rails'
+  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'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/config/sequent_rails_manifest.js

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

data/app/assets/stylesheets/sequent/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/assets/stylesheets/sequent/events.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/sequent/application_controller.rb

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

data/app/controllers/sequent/commands_controller.rb

@@ -0,0 +1,13 @@
+require_dependency "sequent/application_controller"
+
+module Sequent
+  class CommandsController < ApplicationController
+    def index
+      @commands = Sequent::Core::CommandRecord.all.order(id: :desc)
+    end
+
+    def show
+      @command = Sequent::Core::CommandRecord.find(params[:id])
+    end
+  end
+end

data/app/controllers/sequent/events_controller.rb

@@ -0,0 +1,23 @@
+require_dependency "sequent/application_controller"
+
+module Sequent
+  class EventsController < ApplicationController
+    def index
+      @grouped_events = get_events.limit(100).order(id: :desc).includes(:command_record).group_by(&:command_record)
+    end
+
+    def show
+      @event = Sequent::Core::EventRecord.find(params[:id])
+    end
+
+    private
+
+    def get_events
+      if params[:stream_id].present?
+        Sequent::Core::StreamRecord.find(params[:stream_id]).event_records
+      else
+        Sequent::Core::EventRecord.all
+      end
+    end
+  end
+end

data/app/controllers/sequent/streams_controller.rb

@@ -0,0 +1,19 @@
+require_dependency "sequent/application_controller"
+
+module Sequent
+  class StreamsController < ApplicationController
+    def index
+      @streams = get_streams.order(id: :desc)
+    end
+
+    private
+
+    def get_streams
+      if params[:aggregate_type].present?
+        Sequent::Core::StreamRecord.where(aggregate_type: params[:aggregate_type])
+      else
+        Sequent::Core::StreamRecord.all
+      end
+    end
+  end
+end

data/app/helpers/sequent/application_helper.rb

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

data/app/helpers/sequent/events_helper.rb

@@ -0,0 +1,4 @@
+module Sequent
+  module EventsHelper
+  end
+end

data/app/jobs/sequent/application_job.rb

@@ -0,0 +1,4 @@
+module Sequent
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/sequent/application_mailer.rb

@@ -0,0 +1,6 @@
+module Sequent
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/sequent/application_record.rb

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

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

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+        <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <title>Sequent rails</title>
+
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.3.0/css/bootstrap.min.css">
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
+
+    <%= stylesheet_link_tag    "sequent/application", media: "all" %>
+
+
+    <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!-- Leave those next 4 lines if you care about users using IE8 -->
+    <!--[if lt IE 9]>
+      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class='container'>
+      <ul class="nav nav-tabs">
+        <li class="nav-item">
+          <%= link_to "Streams", streams_path, class: 'nav-link' %>
+        </li>
+        <li class="nav-item">
+          <%= link_to "Events", events_path, class: 'nav-link' %>
+        </li>
+      </ul>
+      <%= yield %>
+    </div>
+
+    <!-- Including Bootstrap JS (with its jQuery dependency) so that dynamic components work -->
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
+    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.3.0/js/bootstrap.min.js"></script>
+  </body>
+</html>

data/app/views/sequent/commands/show.html.erb

@@ -0,0 +1,45 @@
+<table class="table table-bordered">
+  <thead class="thead-dark">
+    <tr>
+      <th scope="col">Attribute</th>
+      <th scope="col">Value</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <tr>
+      <th scope="row">id</th>
+      <td><%= @command.id %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">Type</th>
+      <td><%= @command.command_type %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">User</th>
+      <td><%= @command.user_id %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">Created At</th>
+      <td><%= @command.created_at %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">aggregate_id</th>
+      <td><%= @command.aggregate_id %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">event_json</th>
+      <td>
+        <code>
+          <%= simple_format JSON.pretty_generate(JSON.parse @command.command_json) %>
+        </code>
+      </td>
+    </tr>
+  </tbody>
+</table>
+

data/app/views/sequent/events/_event_record.html.erb

@@ -0,0 +1,11 @@
+<tr>
+  <th scope="row"> <%= event_record.id %></th>
+  <td><%= link_to event_record.event_type, event_path(event_record) %></td>
+  <td><%= link_to event_record.aggregate_id, stream_events_path(stream_id: event_record.stream_record_id) %></td>
+  <td><%= event_record.sequence_number %></td>
+  <td>
+    <code>
+      <%= JSON.parse(event_record.event_json).except("sequence_number", "aggregate_id").to_json %>
+    </code>
+  </td>
+</tr>

data/app/views/sequent/events/index.html.erb

@@ -0,0 +1,30 @@
+<%= link_to "Aggregate:" + params[:aggregate_id], url_for(aggregate_id: nil), class: 'badge badge-secondary' if params[:aggregate_id] %>
+<%= link_to "Stream: " + params[:stream_id], url_for(stream_id: nil), class: 'badge badge-secondary' if params[:stream_id] %>
+
+<table class="table table-striped table-hover">
+  <thead class="thead-dark">
+    <tr>
+      <th scope="col"> id</th>
+      <th scope="col"> event_type</th>
+      <th scope="col"> aggregate_id</th>
+      <th scope="col"> sequence_number</th>
+      <th scope="col"> event_json</th>
+    </tr>
+  </thead>
+
+  <% @grouped_events.each do |command, events| %>
+    <thead class="thead-light">
+      <tr>
+        <th colspan="4">
+          <%= link_to command.command_type, command_path(command) %>
+        </th>
+        <th colspan="4">
+          User: <%= command.user_id %>
+        </th>
+      </tr>
+    </thead>
+    <tbody class="events">
+      <%= render collection: events, partial: 'event_record' %>
+    </tbody>
+  <% end %>
+</table>

data/app/views/sequent/events/show.html.erb

@@ -0,0 +1,45 @@
+<table class="table table-bordered">
+  <thead  class="thead-dark">
+    <tr>
+      <th scope="col">Attribute</th>
+      <th scope="col">Value</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <tr>
+      <th scope="row">Id</th>
+      <td><%= @event.id %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">Type</th>
+      <td><%= @event.event_type %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">Aggregate Id</th>
+      <td><%= @event.aggregate_id %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">Sequence Number</th>
+      <td><%= @event.sequence_number %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">Command</th>
+      <td><%= link_to @event.command_record.command_type, command_path(@event.command_record) %></td>
+    </tr>
+
+    <tr>
+      <th scope="row">JSON</th>
+      <td>
+        <code>
+          <%= simple_format JSON.pretty_generate(JSON.parse @event.event_json) %>
+        </code>
+      </td>
+    </tr>
+  </tbody>
+</table>
+

data/app/views/sequent/streams/_stream_record.html.erb

@@ -0,0 +1,10 @@
+<tr>
+  <th scope="row"> <%= stream_record.id %></th>
+  <td><%= link_to stream_record.aggregate_id, stream_events_path(stream_record.id) %></td>
+  <td><%= link_to stream_record.aggregate_type, url_for(aggregate_type: stream_record.aggregate_type) %></td>
+  <td>
+    <code>
+      <%= stream_record.attributes.to_json %>
+    </code>
+  </td>
+</tr>

data/app/views/sequent/streams/index.html.erb

@@ -0,0 +1,16 @@
+<%= link_to "Type: " + params[:aggregate_type], url_for(aggregate_type: nil), class: 'badge badge-secondary' if params[:aggregate_type] %>
+
+<table class="table table-striped table-hover">
+  <thead class="thead-dark">
+    <tr>
+      <th scope="col">id</th>
+      <th scope="col">aggregate_id</th>
+      <th scope="col">aggregate_type</th>
+      <th scope="col">data</th>
+    </tr>
+  </thead>
+
+  <tbody class="events">
+    <%= render partial: 'stream_record', collection: @streams %>
+  </tbody>
+</table>

data/config/routes.rb

@@ -0,0 +1,7 @@
+Sequent::Engine.routes.draw do
+  resources :events, only: [:index, :show]
+  resources :commands, only: [:show]
+  resources :streams, only: [:index, :show] do
+    resources :events, only: [:index]
+  end
+end

data/lib/generators/sequent_install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/active_record'
+
+class Sequent::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  include ActiveRecord::Generators::Migration
+
+  source_root File.expand_path('lib/generators/templates/db/', Gem.loaded_specs['sequent-rails'].full_gem_path)
+  desc "Copies a migration file to create the Event Store in the database of your application"
+
+  def create_initializer_file
+    migration_template 'create_event_store.rb', "db/migrate/create_event_store.rb"
+  end
+
+  private
+
+  def migration_exists?
+    Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_create_event_store.rb$/).first
+  end
+
+  def migration_version
+    if rails5_and_up?
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+  end
+
+  def rails5_and_up?
+    Rails::VERSION::MAJOR >= 5
+  end
+end