pg_eventstore 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 337db5e3df424d6d72b3e08367a730af7c77ebfd907d38b309309e30a563e81e
-  data.tar.gz: 71c36ea38c4d756adea73939ab15e75a2b4500d17768416e0f37013160f0b696
+  metadata.gz: ff514958069cbf4b819b2ad959eac80ca9f24445bca19690ed4cb3ff23989804
+  data.tar.gz: bd91be800c3739a43edf4c17c996156642f00f0d977446201c84784a1bcc6e74
 SHA512:
-  metadata.gz: 70699c2d05ddb69f64922c6e0e67d46a523b5ed2f70d9278134435a144bc002013fe0657a408a0657ccb9f0fe2d1f9cd7a1521a50e128375b1c1d8ec1e127584
-  data.tar.gz: c1125f8dc9af55a1ce1752b94a9bb3273e1153c70e726845867bb91cad9a4b407bcc63537d2bb5859bef20508ce5bfb4391ed56218a690bef2119cf1351597d7
+  metadata.gz: 1d4946c58c314f0bfb04c0c20ca1308e4c8afe915adacee8722fcd703404b26dbc429bdda5bc5a44f94654cb366813065226b42c930620bf30fcd4a345f592b1
+  data.tar.gz: 89738f55a626cbcd4eab9d336b7f4b9ff2e3520fc30a7fc7d87dfac5e755cd6431392438d1522cec706188aa855942db4cfd6fa96bc83c5e0b67086d6e05cef8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [1.7.0]
+- Implement reading from `"$streams"` system stream
+- Disable Host authorization introduced in sinatra v4.1
+
 ## [1.6.0]
 - Introduce subscriptions CLI. Type `pg-eventstore subscriptions --help` to see available commands. The main purpose of it is to provide the single way to start/stop subscription processes. Check [Subscriptions](docs/subscriptions.md#creating-a-subscription) docs about the new way to start and keep running a subscriptions process.
 

data/README.md

@@ -53,6 +53,51 @@ Documentation chapters:
 
 The gem is shipped with its own CLI. Use `pg-eventstore --help` to find out its capabilities.
 
+## RSpec
+
+### Clean up test db
+
+The gem provides a class to clean up your `pg_eventstore` test db between tests. Example usage(in your `spec/spec_helper.rb`:
+
+```ruby
+require 'pg_eventstore/rspec/test_helpers'
+
+RSpec.configure do |config|
+  config.before do
+    PgEventstore::TestHelpers.clean_up_db
+  end
+end
+```
+
+### RSpec matcher for OptionsExtension
+
+If you would like to be able to test the functional, provided by `PgEventstore::Extensions::OptionsExtension` extension - there is a rspec matcher. Load custom matcher in you `spec_helper.rb`:
+
+```ruby
+require 'pg_eventstore/rspec/has_option_matcher'
+```
+
+Let's say you have next class:
+```ruby
+class SomeClass
+  include PgEventstore::Extensions::OptionsExtension
+
+  option(:some_opt, metadata: { foo: :bar }) { '1' }
+end
+```
+
+To test that its instance has the proper option with the proper default value and proper metadata you can use this matcher:
+```ruby
+RSpec.describe SomeClass do
+  subject { described_class.new }
+
+  # Check that :some_opt is present
+  it { is_expected.to have_option(:some_opt) }
+  # Check that :some_opt is present and has the correct default value
+  it { is_expected.to have_option(:some_opt).with_default_value('1').with_metadata(foo: :bar) }
+end
+```
+
 ## Development
 
 After checking out the repo, run:

data/db/migrations/7_support_reading_streams_system_stream.sql

@@ -0,0 +1,2 @@
+CREATE INDEX idx_events_0_stream_revision_global_position ON events USING btree (stream_revision, global_position) WHERE stream_revision = 0;
+CREATE VIEW "$streams" AS SELECT * FROM events WHERE stream_revision = 0;

data/docs/reading_events.md

@@ -53,7 +53,7 @@ In case a stream with given name does not exist, a `PgEventstore::StreamNotFound
 ```ruby
 begin
   stream = PgEventstore::Stream.new(context: 'non-existing-context', stream_name: 'User', stream_id: 'f37b82f2-4152-424d-ab6b-0cc6f0a53aae')
-  PgEventstore.client.read(stream)
+  PgEventstore.client.read(stream, options: { max_count: 1 })
 rescue PgEventstore::StreamNotFoundError => e
   puts e.message # => Stream #<PgEventstore::Stream:0x01> does not exist.
   puts e.stream # => #<PgEventstore::Stream:0x01>
@@ -80,6 +80,15 @@ You can read from a specific position of the "all" stream. This is very similar
 PgEventstore.client.read(PgEventstore::Stream.all_stream, options: { from_position: 9023, direction: 'Backwards' })
 ```
 
+## Reading from "$streams" system stream
+
+`"$streams"` is a special stream which consists of events with `stream_revision == 0`. This allows you to effectively query all streams. Example:
+
+```ruby
+stream = PgEventstore::Stream.system_stream("$streams")
+PgEventstore.client.read(stream).map(&:stream) # => array of unique streams
+```
+
 ## Middlewares
 
 If you would like to skip some of your registered middlewares from processing events after they being read from a stream - you should use the `:middlewares` argument which allows you to override the list of middlewares you would like to use.
@@ -160,6 +169,12 @@ You can also mix filtering by stream's attributes and event types. The result wi
 PgEventstore.client.read(PgEventstore::Stream.all_stream, options: { filter: { streams: [{ context: 'MyAwesomeContext' }], event_types: %w[Foo Bar] } })
 ```
 
+### "$streams" stream filtering
+
+When reading from `"$streams"` same rules apply as when reading from "all" stream. For example, read all streams which have `context == "MyAwesomeContext"` and start from events with event type either `"Foo"` or `"Bar"`:
+```ruby
+PgEventstore.client.read(PgEventstore::Stream.system_stream("$streams"), options: { filter: { streams: [{ context: 'MyAwesomeContext' }], event_types: %w[Foo Bar] } })
+```
 
 ## Pagination
 

data/lib/pg_eventstore/commands/read.rb

@@ -15,7 +15,7 @@ module PgEventstore
       # @return [Array<PgEventstore::Event>]
       # @raise [PgEventstore::StreamNotFoundError]
       def call(stream, options: {})
-        queries.events.stream_revision(stream) || raise(StreamNotFoundError, stream) unless stream.all_stream?
+        queries.events.stream_revision(stream) || raise(StreamNotFoundError, stream) unless stream.system?
 
         queries.events.stream_events(stream, options)
       end

data/lib/pg_eventstore/queries/event_queries.rb

@@ -70,7 +70,7 @@ module PgEventstore
     # @param options [Hash]
     # @return [Array<PgEventstore::Event>]
     def stream_events(stream, options)
-      exec_params = events_filtering(stream, options).to_exec_params
+      exec_params = QueryBuilders::EventsFiltering.events_filtering(stream, options).to_exec_params
       raw_events = connection.with do |conn|
         conn.exec_params(*exec_params)
       end.to_a
@@ -128,15 +128,6 @@ module PgEventstore
       [sql_rows_for_insert, values]
     end
 
-    # @param stream [PgEventstore::Stream]
-    # @param options [Hash]
-    # @return [PgEventstore::EventsFiltering]
-    def events_filtering(stream, options)
-      return QueryBuilders::EventsFiltering.all_stream_filtering(options) if stream.all_stream?
-
-      QueryBuilders::EventsFiltering.specific_stream_filtering(stream, options)
-    end
-
     # @return [PgEventstore::LinksResolver]
     def links_resolver
       LinksResolver.new(connection)

data/lib/pg_eventstore/query_builders/events_filtering.rb

@@ -21,6 +21,18 @@ module PgEventstore
       SUBSCRIPTIONS_OPTIONS = %i[from_position resolve_link_tos filter max_count].freeze
 
       class << self
+        # @param stream [PgEventstore::Stream]
+        # @param options [Hash]
+        # @return [PgEventstore::EventsFiltering]
+        def events_filtering(stream, options)
+          return all_stream_filtering(options) if stream.all_stream?
+          if stream.system? && Stream::KNOWN_SYSTEM_STREAMS.include?(stream.context)
+            return system_stream_filtering(stream, options)
+          end
+
+          specific_stream_filtering(stream, options)
+        end
+
         # @param options [Hash]
         # @return [PgEventstore::QueryBuilders::EventsFiltering]
         def subscriptions_events_filtering(options)
@@ -54,6 +66,15 @@ module PgEventstore
           event_filter.add_stream_direction(options[:direction])
           event_filter
         end
+
+        # @param stream [PgEventstore::Stream] system stream
+        # @param options [Hash]
+        # @return [PgEventstore::QueryBuilders::EventsFiltering]
+        def system_stream_filtering(stream, options)
+          all_stream_filtering(options).tap do |event_filter|
+            event_filter.set_source(stream.context)
+          end
+        end
       end
 
       def initialize
@@ -139,6 +160,12 @@ module PgEventstore
         @sql_builder.to_exec_params
       end
 
+      # @param table_name [String] system stream view name
+      # @return [void]
+      def set_source(table_name)
+        @sql_builder.from(%{ "#{PG::Connection.escape(table_name)}" events })
+      end
+
       private
 
       # @param stream_attrs [Hash]

data/lib/pg_eventstore/rspec/has_option_matcher.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 # This matcher is defined to test options which are defined by using
-# EventStoreClient::Extensions::OptionsExtension option. Example:
+# PgEventstore::Extensions::OptionsExtension option. Example:
 # Let's say you have next class
 # class SomeClass
 #   include PgEventstore::Extensions::OptionsExtension
 #
-#   option(:some_opt) { '1' }
+#   option(:some_opt, metadata: { foo: :bar }) { '1' }
 # end
 #
-# To test that its instance has the proper option with the proper default value you can use this
+# To test that its instance has the proper option with the proper default value and proper metadata you can use this
 # matcher:
 # RSpec.describe SomeClass do
 #   subject { described_class.new }
@@ -17,31 +17,7 @@
 #   # Check that :some_opt is present
 #   it { is_expected.to have_option(:some_opt) }
 #   # Check that :some_opt is present and has the correct default value
-#   it { is_expected.to have_option(:some_opt).with_default_value('1') }
-# end
-#
-# If you have more complex implementation of default value of your option - you should handle it
-# customly. For example:
-# class SomeClass
-#   include PgEventstore::Extensions::OptionsExtension
-#
-#   option(:some_opt) { calc_value }
-# end
-# You could test it like so:
-# RSpec.described SomeClass do
-#   let(:instance) { described_class.new }
-#
-#   describe ':some_opt default value' do
-#     subject { instance.some_opt }
-#
-#     let(:value) { 'some val' }
-#
-#     before do
-#       allow(instance).to receive(:calc_value).and_return(value)
-#     end
-#
-#     it { is_expected.to eq(value) }
-#   end
+#   it { is_expected.to have_option(:some_opt).with_default_value('1').with_metadata(foo: :bar) }
 # end
 RSpec::Matchers.define :has_option do |option_name|
   match do |obj|

data/lib/pg_eventstore/stream.rb

@@ -8,6 +8,8 @@ module PgEventstore
     SYSTEM_STREAM_PREFIX = '$'
     # @return [Integer]
     NON_EXISTING_STREAM_REVISION = -1
+    # @return [Array<String>]
+    KNOWN_SYSTEM_STREAMS = %w[$streams].freeze
 
     class << self
       # Produces "all" stream instance. "all" stream does not represent any specific stream. Instead, it indicates that
@@ -18,6 +20,12 @@ module PgEventstore
           stream.instance_variable_set(:@all_stream, true)
         end
       end
+
+      # @param name [String]
+      # @return [PgEventstore::Stream]
+      def system_stream(name)
+        new(context: name, stream_name: '', stream_id: '')
+      end
     end
 
     # @!attribute context

data/lib/pg_eventstore/version.rb

@@ -2,5 +2,5 @@
 
 module PgEventstore
   # @return [String]
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/lib/pg_eventstore/web/application.rb

@@ -9,6 +9,7 @@ module PgEventstore
       set :environment, -> { (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || ENV['APP_ENV'])&.to_sym || :development }
       set :logging, -> { environment == :development || environment == :test }
       set :erb, layout: :'layouts/application'
+      set :host_authorization, { allow_if: ->(_env) { true } }
 
       helpers(Paginator::Helpers, Subscriptions::Helpers) do
         # @return [Array<Hash>, nil]
@@ -19,6 +20,12 @@ module PgEventstore
           end&.reject { _1.empty? }
         end
 
+        # @return [String, nil]
+        def system_stream
+          params in { filter: { system_stream: String => system_stream } }
+          system_stream if Stream::KNOWN_SYSTEM_STREAMS.include?(system_stream)
+        end
+
         # @return [Array<String>, nil]
         def events_filter
           params in { filter: { events: Array => events } }
@@ -31,6 +38,8 @@ module PgEventstore
           PgEventstore.available_configs.include?(config) ? config : :default
         end
 
+        # @param val [Object]
+        # @return [void]
         def current_config=(val)
           response.set_cookie('current_config', { value: val.to_s, http_only: true, same_site: :lax })
         end
@@ -40,7 +49,7 @@ module PgEventstore
           PgEventstore.connection(current_config)
         end
 
-        # @param collection [PgEventstore::Paginator::BaseCollection]
+        # @param collection [PgEventstore::Web::Paginator::BaseCollection]
         # @return [void]
         def paginated_json_response(collection)
           halt 200, {
@@ -85,7 +94,8 @@ module PgEventstore
           options: {
             filter: { event_types: events_filter, streams: streams_filter },
             resolve_link_tos: resolve_link_tos?
-          }
+          },
+          system_stream: system_stream
         )
 
         if request.xhr?

data/lib/pg_eventstore/web/paginator/events_collection.rb

@@ -19,10 +19,21 @@ module PgEventstore
         #   count instead because of the potential performance degradation.
         MAX_NUMBER_TO_COUNT = 10_000
 
+        # @param config_name [Symbol]
+        # @param starting_id [String, Integer, nil]
+        # @param per_page [Integer]
+        # @param order [Symbol] :asc or :desc
+        # @param options [Hash] additional options to filter the collection
+        # @param system_stream [String, nil] a name of system stream
+        def initialize(config_name, starting_id:, per_page:, order:, options: {}, system_stream: nil)
+          super(config_name, starting_id: starting_id, per_page: per_page, order: order, options: options)
+          @stream = system_stream ? PgEventstore::Stream.system_stream(system_stream) : PgEventstore::Stream.all_stream
+        end
+
         # @return [Array<PgEventstore::Event>]
         def collection
           @_collection ||= PgEventstore.client(config_name).read(
-            PgEventstore::Stream.all_stream,
+            @stream,
             options: options.merge(from_position: starting_id, max_count: per_page, direction: order),
             middlewares: []
           )
@@ -33,7 +44,8 @@ module PgEventstore
           return unless collection.size == per_page
 
           from_position = event_global_position(collection.first)
-          sql_builder = QueryBuilders::EventsFiltering.all_stream_filtering(
+          sql_builder = QueryBuilders::EventsFiltering.events_filtering(
+            @stream,
             options.merge(from_position: from_position, max_count: 1, direction: order)
           ).to_sql_builder.unselect.select('global_position').offset(per_page)
           global_position(sql_builder)
@@ -42,7 +54,8 @@ module PgEventstore
         # @return [Integer, nil]
         def prev_page_starting_id
           from_position = event_global_position(collection.first) || starting_id
-          sql_builder = QueryBuilders::EventsFiltering.all_stream_filtering(
+          sql_builder = QueryBuilders::EventsFiltering.events_filtering(
+            @stream,
             options.merge(from_position: from_position, max_count: per_page, direction: order == :asc ? :desc : :asc)
           ).to_sql_builder.unselect.select('global_position').offset(1)
           sql, params = sql_builder.to_exec_params
@@ -57,7 +70,7 @@ module PgEventstore
           @_total_count ||=
             begin
               sql_builder =
-                QueryBuilders::EventsFiltering.all_stream_filtering(options).
+                QueryBuilders::EventsFiltering.events_filtering(@stream, options).
                   to_sql_builder.remove_limit.remove_group.remove_order
               count = estimate_count(sql_builder)
               return count if count > MAX_NUMBER_TO_COUNT
@@ -68,7 +81,7 @@ module PgEventstore
 
         private
 
-        # @param event [PgEventstore::Event]
+        # @param event [PgEventstore::Event, nil]
         # @return [Integer, nil]
         def event_global_position(event)
           event&.link&.global_position || event&.global_position

data/lib/pg_eventstore/web/public/javascripts/pg_eventstore.js

@@ -60,6 +60,13 @@ $(function(){
         });
     }
 
+    let initSystemStreamFilterAutocomplete = function($filter){
+        let $streamNameSelect = $filter.find('select');
+        $streamNameSelect.select2({
+            allowClear: true
+        });
+    }
+
     let initEventTypeFilterAutocomplete = function($filter) {
         let $eventTypeSelect = $filter.find('select');
         $eventTypeSelect.select2({
@@ -86,6 +93,8 @@ $(function(){
     let $filtersForm = $('#filters-form');
     // Stream filter template
     let streamFilterTmpl = $('#stream-filter-tmpl').text();
+    // System stream filter template
+    let systemStreamFilterTmpl = $('#system-stream-filter-tmpl').text();
     // Event type filter template
     let eventFilterTmpl = $('#event-type-filter-tmpl').text();
 
@@ -93,21 +102,34 @@ $(function(){
     $filtersForm.on('click', '.remove-filter', function(){
         $(this).parents('.form-row').remove();
     });
-    // Add stream filter button
+    // "Add stream filter" button
     $filtersForm.on('click', '.add-stream-filter', function(){
         let filtersNum = $filtersForm.find('.stream-filters').children().length + '';
         $filtersForm.find('.stream-filters').append(streamFilterTmpl.replace(/%NUM%/g, filtersNum));
         initStreamFilterAutocomplete($filtersForm.find('.stream-filters').children().last());
     });
-    // Add event type filter button
+    // "Add system stream filter" button
+    $filtersForm.on('click', '.add-system-stream-filter', function(){
+        if($filtersForm.find('.system-stream-filter').children().length > 0)
+            return;
+
+        $filtersForm.find('.system-stream-filter').append(systemStreamFilterTmpl);
+        initSystemStreamFilterAutocomplete($filtersForm.find('.system-stream-filter').children().last());
+    });
+    // "Add event type filter" button
     $filtersForm.on('click', '.add-event-filter', function(){
         $filtersForm.find('.event-filters').append(eventFilterTmpl);
         initEventTypeFilterAutocomplete($filtersForm.find('.event-filters').children().last());
     });
+
     // Init select2 for stream filters which were initially rendered
     $filtersForm.find('.stream-filters').children().each(function(){
         initStreamFilterAutocomplete($(this));
     });
+    // Init select2 for system stream filter which were initially rendered
+    $filtersForm.find('.system-stream-filter').children().each(function(){
+        initSystemStreamFilterAutocomplete($(this));
+    });
     // Init select2 for event type filters which were initially rendered
     $filtersForm.find('.event-filters').children().each(function(){
         initEventTypeFilterAutocomplete($(this));

data/lib/pg_eventstore/web/views/home/dashboard.erb

@@ -1,6 +1,9 @@
 <script type="text/html" id="stream-filter-tmpl">
   <%= erb :'home/partials/stream_filter', { layout: false }, { stream: {} } %>
 </script>
+<script type="text/html" id="system-stream-filter-tmpl">
+  <%= erb :'home/partials/system_stream_filter', { layout: false }, { stream: nil } %>
+</script>
 <script type="text/html" id="event-type-filter-tmpl">
   <%= erb :'home/partials/event_filter', { layout: false }, { event_type: '' } %>
 </script>
@@ -27,6 +30,11 @@
             <form id="filters-form" action="<%= url('/') %>" method="GET" data-parsley-validate class="form-horizontal form-label-left">
               <input type="hidden" name="per_page" value="<%= params[:per_page].to_i %>">
               <input type="hidden" name="resolve_link_tos" value="<%= resolve_link_tos? %>">
+              <div class="system-stream-filter">
+                <% if system_stream %>
+                  <%= erb :'home/partials/system_stream_filter', { layout: false }, { stream: system_stream } %>
+                <% end %>
+              </div>
               <div class="stream-filters">
                 <% streams_filter&.each do |attrs| %>
                   <%= erb :'home/partials/stream_filter', { layout: false }, { stream: attrs } %>
@@ -48,6 +56,7 @@
                       </button>
                       <div class="dropdown-menu">
                         <a class="dropdown-item add-stream-filter" href="javascript: void(0)">Add stream filter</a>
+                        <a class="dropdown-item add-system-stream-filter" href="javascript: void(0)">Add system stream filter</a>
                         <a class="dropdown-item add-event-filter" href="javascript: void(0)">Add event filter</a>
                       </div>
                     </div>

data/lib/pg_eventstore/web/views/home/partials/events.erb

@@ -6,10 +6,13 @@
     <td><%= h event.stream.stream_name %></td>
     <td><a href="<%= stream_path(event) %>"><%= event.stream.stream_id %></a></td>
     <td>
-      <%= h event.type %>
+      <p class="float-left"><%= h event.type %></p>
       <% if event.link %>
-        <i class="fa fa-link"></i>
+        <p class="float-left ml-2">
+          <i class="fa fa-link"></i>
+        </p>
       <% end %>
+      <div class="clearfix"></div>
     </td>
     <td><%= event.created_at.strftime('%F %T') %></td>
     <td><%= event.id %></td>

data/lib/pg_eventstore/web/views/home/partials/system_stream_filter.erb

@@ -0,0 +1,15 @@
+<div class="form-row align-items-center">
+  <div class="col-3">
+    <select name="filter[system_stream]" class="form-control mb-2" data-placeholder="Select system stream">
+      <option></option>
+      <% PgEventstore::Stream::KNOWN_SYSTEM_STREAMS.each do |stream_name| %>
+        <option value="<%= stream_name %>" <% if stream == stream_name %> selected <% end %>><%= stream_name %></option>
+      <% end %>
+    </select>
+  </div>
+  <div class="col-1">
+    <a class="btn btn-default remove-filter" href="javascript: void(0);">
+      <i class="fa fa-minus-circle"></i>
+    </a>
+  </div>
+</div>

data/lib/pg_eventstore/web/views/layouts/application.erb

@@ -87,7 +87,7 @@
               <div class="dropdown-menu dropdown-usermenu pull-right" aria-labelledby="navbarDropdown">
                 <% PgEventstore.available_configs.each do |config| %>
                   <form action="<%= url('/change_config') %>" method="POST">
-                    <input type="hidden" name="config" value="<%= h config %>">
+                    <input type="hidden" name="config" value="<%= h config.to_s %>">
                     <button type="submit" class="dropdown-item"><%= h config.inspect %></button>
                   </form>
                 <% end %>

data/sig/pg_eventstore/queries/event_queries.rbs

@@ -31,11 +31,6 @@ module PgEventstore
     # _@param_ `events`
     def prepared_statements: (PgEventstore::Stream stream, ::Array[PgEventstore::Event] events) -> ::Array[(::Array[String] | ::Array[Object])]
 
-    # _@param_ `stream`
-    #
-    # _@param_ `options`
-    def events_filtering: (PgEventstore::Stream stream, ::Hash[untyped, untyped] options) -> PgEventstore::QueryBuilders::EventsFiltering
-
     def links_resolver: () -> PgEventstore::LinksResolver
 
     # Returns the value of attribute connection.

data/sig/pg_eventstore/query_builders/events_filtering_query.rbs

@@ -6,6 +6,10 @@ module PgEventstore
       SQL_DIRECTIONS: Hash[String | Symbol, String]
       SUBSCRIPTIONS_OPTIONS: ::Array[Symbol]
 
+      @sql_builder: PgEventstore::SQLBuilder
+
+      def self.events_filtering: (PgEventstore::Stream stream, ::Hash[untyped, untyped] options) -> PgEventstore::QueryBuilders::EventsFiltering
+      
       # _@param_ `options`
       def self.subscriptions_events_filtering: (::Hash[untyped, untyped] options) -> PgEventstore::QueryBuilders::EventsFiltering
 
@@ -17,6 +21,8 @@ module PgEventstore
       # _@param_ `options`
       def self.specific_stream_filtering: (PgEventstore::Stream stream, ::Hash[untyped, untyped] options) -> PgEventstore::QueryBuilders::EventsFiltering
 
+      def self.system_stream_filtering: (PgEventstore::Stream stream, Hash[untyped, untyped] options) -> PgEventstore::QueryBuilders::EventsFiltering
+
       def initialize: () -> void
 
       # _@param_ `context`

data/sig/pg_eventstore/stream.rbs

@@ -1,10 +1,13 @@
 module PgEventstore
   class Stream
+    KNOWN_SYSTEM_STREAMS: Array[String]
     SYSTEM_STREAM_PREFIX: String
     NON_EXISTING_STREAM_REVISION: Integer
 
     def self.all_stream: () -> PgEventstore::Stream
 
+    def self.system_stream: (String) -> PgEventstore::Stream
+
     # _@param_ `context`
     #
     # _@param_ `stream_name`

data/sig/pg_eventstore/web/application.rbs

@@ -0,0 +1,27 @@
+module PgEventstore
+  module Web
+    class Application
+      def asset_url: (String path) -> String
+
+      def connection: -> PgEventstore::Connection
+
+      def current_config: -> Symbol
+
+      def current_config=: (untyped val) -> void
+
+      def events_filter: -> Array[String]?
+
+      def h: (String text) -> String
+
+      def paginated_json_response: (PgEventstore::Web::Paginator::BaseCollection collection) -> void
+
+      def redirect_back_url: (fallback_url: String) -> String
+
+      def resolve_link_tos?: -> bool
+
+      def streams_filter: -> Array[Hash[untyped, untyped]]?
+
+      def system_stream: -> String?
+    end
+  end
+end

data/sig/pg_eventstore/web/paginator/base_collection.rbs

@@ -2,15 +2,6 @@ module PgEventstore
   module Web
     module Paginator
       class BaseCollection
-        # _@param_ `config_name`
-        #
-        # _@param_ `starting_id`
-        #
-        # _@param_ `per_page`
-        #
-        # _@param_ `order` — :asc or :desc
-        #
-        # _@param_ `options` — additional options to filter the collection
         def initialize: (
             Symbol config_name,
             starting_id: (String | Integer)?,

data/sig/pg_eventstore/web/paginator/event_types_collection.rbs

@@ -4,6 +4,15 @@ module PgEventstore
       class EventTypesCollection < PgEventstore::Web::Paginator::BaseCollection
         PER_PAGE: Integer
 
+        def initialize: (
+            Symbol config_name,
+            starting_id: (String | Integer)?,
+            per_page: Integer,
+            order: Symbol,
+            ?options: ::Hash[untyped, untyped],
+            ?system_stream: String?
+          ) -> void
+
         def collection: () -> ::Array[::Hash[String, String]]
 
         def next_page_starting_id: () -> String?

data/sig/pg_eventstore/web/paginator/events_collection.rbs

@@ -6,6 +6,8 @@ module PgEventstore
         PER_PAGE: ::Hash[String, Integer]
         MAX_NUMBER_TO_COUNT: Integer
 
+        @stream: PgEventstore::Stream
+
         def collection: () -> ::Array[PgEventstore::Event]
 
         def next_page_starting_id: () -> Integer?
@@ -15,7 +17,7 @@ module PgEventstore
         def total_count: () -> Integer
 
         # _@param_ `event`
-        def event_global_position: (PgEventstore::Event event) -> Integer?
+        def event_global_position: (PgEventstore::Event? event) -> Integer?
 
         # _@param_ `sql_builder`
         def estimate_count: (PgEventstore::SQLBuilder sql_builder) -> Integer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_eventstore
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Ivan Dzyzenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -77,6 +77,7 @@ files:
 - db/migrations/4_create_subscriptions_set_commands.sql
 - db/migrations/5_partitions.sql
 - db/migrations/6_add_commands_data.sql
+- db/migrations/7_support_reading_streams_system_stream.sql
 - docs/admin_ui.md
 - docs/appending_events.md
 - docs/configuration.md
@@ -226,6 +227,7 @@ files:
 - lib/pg_eventstore/web/views/home/partials/events.erb
 - lib/pg_eventstore/web/views/home/partials/pagination_links.erb
 - lib/pg_eventstore/web/views/home/partials/stream_filter.erb
+- lib/pg_eventstore/web/views/home/partials/system_stream_filter.erb
 - lib/pg_eventstore/web/views/layouts/application.erb
 - lib/pg_eventstore/web/views/subscriptions/index.erb
 - pg_eventstore.gemspec
@@ -331,6 +333,7 @@ files:
 - sig/pg_eventstore/subscriptions/subscriptions_set_lifecycle.rbs
 - sig/pg_eventstore/utils.rbs
 - sig/pg_eventstore/version.rbs
+- sig/pg_eventstore/web/application.rbs
 - sig/pg_eventstore/web/paginator/base_collection.rbs
 - sig/pg_eventstore/web/paginator/event_types_collection.rbs
 - sig/pg_eventstore/web/paginator/events_collection.rbs