sql_view 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0c483bd4b3381f12564e802d7e4169de63644dee304521156471397e5214e4e
+  data.tar.gz: c720532cb86979da70f0bcade52e1e74e5240ebe42e82f21288781511aa73861
+SHA512:
+  metadata.gz: 0613cd3a590e6a163c4f035cc6ff8361f2432c155e536dff873f5f6d8d60a78eceb6f9a2946512291c06bbe6d603e0c8da4c4c548e41fbc26079544fe3a6cfb8
+  data.tar.gz: e9c49cfcac2404cd093a88e280d6bb4f8968cb40662bd04aec6ed3893b5bc68aedb108f194f3545add3946a82eb7e5b2c9abf997b241d535519d95b7dae96a95

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Igor Kasyanchuk
+
+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,32 @@
+# SqlView
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sql_view"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install sql_view
+```
+
+## Testing
+
+`ruby ./test/sql_view_test.rb` (because somehow `rake test` not works, not critical for now)
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/generators/sql_view/generators.rb

@@ -0,0 +1,4 @@
+module SqlView
+  module Generators
+  end
+end

data/lib/generators/sql_view/view/USAGE

@@ -0,0 +1,16 @@
+Description:
+  Create a new database view in your application.
+
+  To create a materialized view, pass the '--materialized' option.
+
+Examples:
+    rails generate sql_view:view ActiveUser 'User.where(active: true)'
+
+      create: app/sql_views/search_view.rb
+      create: db/migrate/20140803191158_create_active_users_views.rb
+
+Examples:
+    rails generate sql_view:view ArchivedAccount Account.archived --materialized --view-name=inactive_accounts
+
+      create: app/sql_views/search_view.rb
+      create: db/migrate/20140803191158_create_search_views.rb

data/lib/generators/sql_view/view/view_generator.rb

@@ -0,0 +1,88 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module SqlView
+  module Generators
+    class ViewGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      class_option :"view-name", type: :string, default: nil
+      class_option :materialized, type: :boolean, default: false
+
+      def create_everything
+        create_file "app/sql_views/#{file_name}_view.rb", <<-FILE
+class #{class_name}View < SqlView::Model
+#{top_code}
+
+  schema -> {#{schema_code} }
+
+  extend_model_with do
+    # sample how you can extend it, similar to regular AR model
+    #
+    # belongs_to :user
+    # has_many :posts
+    #
+    # scope :ordered, -> { order(:created_at) }
+    # scope :by_role, ->(role) { where(role: role) }
+  end
+end
+FILE
+
+        create_file "db/migrate/#{self.class.next_migration_number("db/migrate")}_create_#{file_name}s_view.rb", <<-FILE
+class #{migration_class_name} < #{activerecord_migration_class}
+  def up
+    #{class_name}View.sql_view.up
+  end
+
+  def down
+    #{class_name}View.sql_view.down
+  end
+end
+FILE
+      end
+
+      def self.next_migration_number(dir)
+        ::ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      no_tasks do
+        def top_code
+          [view_name_code, materialized_code].compact.join("\n\n")
+        end
+
+        def view_name_code
+          options["view-name"] ? "  self.view_name = '#{options["view-name"]}'" : nil
+        end
+
+        def materialized_code
+          options[:materialized] ? "  materialized" : nil
+        end
+
+        def schema_code
+          " #{args[0].presence || "\n    # ActiveRecord::Relation or SQL\n    # for example: User.where(active: true)\n " }"
+        end
+
+        def migration_class_name
+          "Create#{class_name.tr('.', '').pluralize}View"
+        end
+
+        def activerecord_migration_class
+          if ActiveRecord::Migration.respond_to?(:current_version)
+            "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+          else
+            "ActiveRecord::Migration"
+          end
+        end
+      end
+
+      private
+
+      alias singular_name file_name
+
+      def file_name
+        super.tr(".", "_")
+      end
+
+    end
+  end
+end

data/lib/sql_view/railtie.rb

@@ -0,0 +1,10 @@
+module SqlView
+  class Railtie < ::Rails::Railtie
+    initializer "sql_view.load" do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.include SqlView::Statements
+        ActiveRecord::SchemaDumper.prepend SqlView::SchemaDumper
+      end
+    end
+  end
+end

data/lib/sql_view/schema_dumper.rb

@@ -0,0 +1,94 @@
+require "rails"
+
+# Copy-pasted from scenic game. Scenic is a very nice gem
+
+module SqlView
+  # @api private
+  module SchemaDumper
+    class DBView < OpenStruct
+
+      def materialized?
+        self.kind == "m"
+      end
+
+      def materialized_or_not
+        materialized? ? " MATERIALIZED " : nil
+      end
+
+      def to_schema
+        <<-DEFINITION
+    create_sql_view "#{self.viewname}", sql: <<-\SQL
+      CREATE #{materialized_or_not} VIEW "#{self.viewname}" AS
+      #{escaped_definition.indent(2)}
+    SQL
+        DEFINITION
+      end
+
+      def escaped_definition
+        definition.gsub("\\", "\\\\\\")
+      end
+    end
+
+    def tables(stream)
+      super
+      views(stream)
+    end
+
+    def views(stream)
+      if dumpable_views_in_database.any?
+        stream.puts
+      end
+
+      dumpable_views_in_database.each do |viewname|
+        view = DBView.new(get_view_info(viewname))
+        #puts view.to_schema
+        stream.puts(view.to_schema)
+        #indexes(view.name, stream)
+      end
+    end
+
+    private
+
+    def dumpable_views_in_database
+      @dumpable_views_in_database ||= ActiveRecord::Base.connection.views.reject do |viewname|
+        ignored?(viewname)
+      end
+    end
+
+    def get_view_info(viewname)
+      views_schema.detect{|e| e['viewname'] == viewname}
+    end
+
+    def views_schema
+      @views_schema ||= ActiveRecord::Base.connection.execute(<<-SQL)
+        SELECT
+          c.relname as viewname,
+          pg_get_viewdef(c.oid) AS definition,
+          c.relkind AS kind,
+          n.nspname AS namespace
+        FROM pg_class c
+          LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
+        WHERE
+          c.relkind IN ('m', 'v')
+          AND c.relname NOT IN (SELECT extname FROM pg_extension)
+          AND n.nspname = ANY (current_schemas(false))
+        ORDER BY c.oid
+      SQL
+    .to_a
+    end
+
+    unless ActiveRecord::SchemaDumper.private_instance_methods(false).include?(:ignored?)
+      # This method will be present in Rails 4.2.0 and can be removed then.
+      def ignored?(table_name)
+        ["schema_migrations", ignore_tables].flatten.any? do |ignored|
+          case ignored
+          when String then remove_prefix_and_suffix(table_name) == ignored
+          when Regexp then remove_prefix_and_suffix(table_name) =~ ignored
+          else
+            raise StandardError, "ActiveRecord::SchemaDumper.ignore_tables accepts an array of String and / or Regexp values."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sql_view/statements.rb

@@ -0,0 +1,7 @@
+module SqlView
+  module Statements
+    def create_sql_view(viewname, sql:)
+      ActiveRecord::Base.connection.execute(sql)
+    end
+  end
+end

data/lib/sql_view/version.rb

@@ -0,0 +1,3 @@
+module SqlView
+  VERSION = "0.0.1"
+end

data/lib/sql_view.rb

@@ -0,0 +1,110 @@
+require "singleton"
+require_relative "./sql_view/schema_dumper.rb"
+require_relative "./sql_view/statements.rb"
+require "sql_view/version"
+require "sql_view/railtie"
+
+module SqlView
+  # mattr_accessor :klasses
+  # @@klasses = {}
+
+  class Model
+    class_attribute :view, :sql_view_options
+
+    class << self
+      delegate_missing_to :model
+    end
+
+    def self.inherited(subclass)
+      # puts subclass
+      subclass.sql_view_options = {}
+      # SqlView.klasses[subclass] = subclass.sql_view
+    end
+
+    def self.view_name=(name)
+      @view_name = name
+    end
+
+    def self.view_name
+      @view_name.presence || (self.view_name=self.to_s.underscore.pluralize)
+    end
+
+    def self.model
+      @model ||= ClassBuilder.create_model(self)
+    end
+
+    def self.sql_view
+      @sql_view ||= Migration.new(self)
+    end
+
+    def self.materialized
+      self.sql_view_options[:materialized] = true
+    end
+
+    def self.schema(sql_or_proc)
+      self.sql_view_options[:sql_or_proc] = sql_or_proc
+    end
+
+    def self.extend_model_with(&block)
+      self.sql_view_options[:extend_model_with] = block
+    end
+  end
+
+  class Migration
+    attr_reader :parent
+
+    def initialize(parent)
+      @parent = parent
+    end
+
+    def refresh
+      down
+      up
+    end
+
+    def up
+      view_sql = parent.sql_view_options[:sql_or_proc].call
+      sql = <<-SQL
+      CREATE #{materialized_or_not} VIEW #{parent.view_name} AS
+      #{view_sql.respond_to?(:to_sql) ? view_sql.to_sql : view_sql };
+    SQL
+      puts sql if Rails.env.development?
+      ActiveRecord::Base.connection.execute sql#.wp
+    end
+
+    def down
+      sql = <<-SQL
+      drop #{materialized_or_not} view if exists #{parent.view_name};
+    SQL
+      puts sql if Rails.env.development?
+      ActiveRecord::Base.connection.execute sql#.wp
+    end
+
+    private
+
+    def materialized_or_not
+      parent.sql_view_options[:materialized] ? "MATERIALIZED" : nil
+    end
+
+  end
+
+  class ClassBuilder
+    def ClassBuilder.create_model(parent)
+      klass = Class.new(ActiveRecord::Base) do
+        def self.model_name
+          ActiveModel::Name.new(self, nil, parent.view_name)
+        end
+        def readonly?
+          true
+        end
+        self.table_name = parent.view_name
+        self.inheritance_column = nil
+      end
+      if parent.sql_view_options[:extend_model_with].present?
+        klass.class_eval(&parent.sql_view_options[:extend_model_with])
+      end
+      klass
+    end
+  end
+
+end

data/lib/tasks/sql_view_tasks.rake

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sql_view
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: wrapped_print
+  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: Simple way to create and interact with your SQL views using ActiveRecord.
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/sql_view/generators.rb
+- lib/generators/sql_view/view/USAGE
+- lib/generators/sql_view/view/view_generator.rb
+- lib/sql_view.rb
+- lib/sql_view/railtie.rb
+- lib/sql_view/schema_dumper.rb
+- lib/sql_view/statements.rb
+- lib/sql_view/version.rb
+- lib/tasks/sql_view_tasks.rake
+homepage: https://github.com/igorkasyanchuk/sql_view
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/igorkasyanchuk/sql_view
+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.3.3
+signing_key: 
+specification_version: 4
+summary: Simple way to create and interact with your SQL views using ActiveRecord.
+test_files: []