ridgepole-view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69fdd1019a8766f9e1d4518915f2bb35dd8c396e1667f4bd92e731ed6edc3e35
+  data.tar.gz: 769a340d1ac813e6c02546124e55caca5bc2d6c964afa95d53bac24a5fa2b005
+SHA512:
+  metadata.gz: 1785451331df5dc46efb40feb52878897d953cdba7355c7ad0ed2e7a1b54eefbef2a9c3eb22c84978a2b04df4cfbeca4dc573530489ece91d4e97f74f29a9cc4
+  data.tar.gz: 53a60e1f9ccac14ae825a35df3d07d7a6a796514def981b685ae8867050e3767a7bee48ba3354d041aadb7cc2665832a4740ae8d0fa0a5be79028a66f139c8fa

data/lib/ridgepole/view/delta.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Ridgepole
+  module View
+    module Delta
+      def script
+        table_script = super
+        view_script = generate_view_script
+        [table_script, view_script].map(&:strip).reject(&:empty?).join("\n\n")
+      end
+
+      def differ?
+        !!(super || view_delta_present?)
+      end
+
+      private
+
+      def view_delta_present?
+        vd = @delta[:views]
+        vd && (vd[:add]&.any? || vd[:change]&.any? || vd[:delete]&.any?)
+      end
+
+      def generate_view_script
+        buf = StringIO.new
+        views = @delta[:views] || {}
+
+        (views[:delete] || {}).each do |name, attrs|
+          append_drop_view(name, attrs, buf)
+        end
+
+        (views[:change] || {}).each do |name, change_attrs|
+          append_drop_view(name, change_attrs[:from], buf)
+        end
+
+        (views[:add] || {}).each do |name, attrs|
+          append_create_view(name, attrs, buf)
+        end
+
+        (views[:change] || {}).each do |name, change_attrs|
+          append_create_view(name, change_attrs[:to], buf)
+        end
+
+        buf.string
+      end
+
+      def append_create_view(name, attrs, buf)
+        mat = attrs[:materialized] ? ", materialized: true" : ""
+        sql = attrs[:sql_definition]
+        buf.puts "create_view #{name.inspect}, sql_definition: #{sql.inspect}#{mat}"
+      end
+
+      def append_drop_view(name, attrs, buf)
+        mat = attrs[:materialized] ? ", materialized: true" : ""
+        buf.puts "drop_view #{name.inspect}#{mat}"
+      end
+    end
+  end
+end

data/lib/ridgepole/view/diff.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "ridgepole/view/view_definition"
+
+module Ridgepole
+  module View
+    module Diff
+      def diff(from, to, options = {})
+        from = (from || {}).deep_dup
+        to = (to || {}).deep_dup
+
+        # Ridgepole::Diff#diff iterates all keys in the definition hash as table names,
+        # accessing table-specific attributes (:definition, :options) via scan_change etc.
+        # The :views data structure differs from tables, so passing it through causes NoMethodError.
+        # Extract :views before calling super and handle view diffing separately.
+        from_views = from.delete(:views) || {}
+        to_views = to.delete(:views) || {}
+
+        delta = super(from, to, options)
+
+        view_delta = diff_views(from_views, to_views)
+        unless view_delta.values.all?(&:empty?)
+          delta.instance_variable_get(:@delta)[:views] = view_delta
+        end
+
+        delta
+      end
+
+      private
+
+      def diff_views(from_views, to_views)
+        result = { add: {}, change: {}, delete: {} }
+        all_names = (from_views.keys + to_views.keys).uniq
+
+        all_names.each do |name|
+          from = from_views[name]
+          to = to_views[name]
+
+          if from.nil? && to
+            result[:add][name] = to
+          elsif from && to.nil?
+            result[:delete][name] = from
+          elsif ViewDefinition.changed?(from, to)
+            result[:change][name] = { from: from, to: to }
+          end
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/ridgepole/view/dsl_parser/context.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Ridgepole
+  module View
+    module DSLParser
+      module Context
+        def create_view(name, sql_definition:, materialized: false)
+          name = name.to_s
+          @__definition[:views] ||= {}
+
+          raise "View `#{name}` already defined" if @__definition[:views][name]
+
+          @__definition[:views][name] = {
+            sql_definition: sql_definition,
+            materialized: materialized,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ridgepole/view/dsl_parser.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ridgepole
+  module View
+    module DSLParser
+      private
+
+      def check_definition(definition)
+        # Ridgepole::DSLParser#check_definition iterates all keys as table names and
+        # validates table-specific attributes via check_orphan_index etc.
+        # Temporarily remove :views to prevent false validation errors, then restore after super.
+        views = definition.delete(:views)
+        super(definition)
+      ensure
+        definition[:views] = views if views
+      end
+    end
+  end
+end

data/lib/ridgepole/view/dumper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Ridgepole
+  module View
+    module Dumper
+      def dump(&block)
+        result = super(&block)
+        view_dsl = dump_views
+        view_dsl.empty? ? result : [result, view_dsl].join("\n\n")
+      end
+
+      private
+
+      def dump_views
+        views = Scenic.database.views
+        views = views.reject { |v| ignored_view?(v.name) }
+        views.map(&:to_schema).join("\n")
+      end
+
+      def ignored_view?(name)
+        return false unless @options[:ignore_tables]
+
+        @options[:ignore_tables].any? { |pattern| pattern =~ name }
+      end
+    end
+  end
+end

data/lib/ridgepole/view/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ridgepole
+  module View
+    VERSION = "0.1.0"
+  end
+end

data/lib/ridgepole/view/view_definition.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Ridgepole
+  module View
+    module ViewDefinition
+      module_function
+
+      # Normalize SQL for comparison so that semantically identical definitions
+      # written differently in the Schemafile vs dumped from PostgreSQL are not
+      # treated as changes (which would cause unnecessary drop_view + create_view).
+      #
+      # e.g. Schemafile:  "SELECT  name\n  FROM  users;"
+      #      PG dump:     "select name from users"
+      def normalize(sql)
+        sql.to_s
+           .gsub(/\s+/, " ")       # collapse newlines, tabs, multiple spaces into single space
+           .gsub(/;\s*\z/, "")     # strip trailing semicolons
+           .strip                  # remove leading/trailing whitespace
+           .downcase               # PG may dump keywords in lowercase
+      end
+
+      def changed?(from, to)
+        from[:materialized] != to[:materialized] ||
+          normalize(from[:sql_definition]) != normalize(to[:sql_definition])
+      end
+    end
+  end
+end

data/lib/ridgepole-view.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "tsort"
+require "ridgepole"
+require "scenic"
+
+require "ridgepole/view/version"
+require "ridgepole/view/view_definition"
+require "ridgepole/view/dsl_parser/context"
+require "ridgepole/view/dsl_parser"
+require "ridgepole/view/dumper"
+require "ridgepole/view/diff"
+require "ridgepole/view/delta"
+
+Ridgepole::DSLParser::Context.prepend(Ridgepole::View::DSLParser::Context)
+Ridgepole::DSLParser.prepend(Ridgepole::View::DSLParser)
+Ridgepole::Dumper.prepend(Ridgepole::View::Dumper)
+Ridgepole::Diff.prepend(Ridgepole::View::Diff)
+Ridgepole::Delta.prepend(Ridgepole::View::Delta)

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ridgepole-view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuhi-Sato
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ridgepole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: scenic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Ridgepole plugin that adds database view management using the Scenic
+  gem
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ridgepole-view.rb
+- lib/ridgepole/view/delta.rb
+- lib/ridgepole/view/diff.rb
+- lib/ridgepole/view/dsl_parser.rb
+- lib/ridgepole/view/dsl_parser/context.rb
+- lib/ridgepole/view/dumper.rb
+- lib/ridgepole/view/version.rb
+- lib/ridgepole/view/view_definition.rb
+homepage: https://github.com/Yuhi-Sato/ridgepole-view
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Yuhi-Sato/ridgepole-view
+  source_code_uri: https://github.com/Yuhi-Sato/ridgepole-view
+  changelog_uri: https://github.com/Yuhi-Sato/ridgepole-view/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Scenic view support for Ridgepole
+test_files: []