sql_view 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7e04a9a62b624adce19a6462f76ddea7548e82aead8a8e639de633f4fa7279
-  data.tar.gz: a19ed68c58a457aac9aa4e65e38f247ed9fd0176fc9eb4aa8bf5b1a42722f3dd
+  metadata.gz: 453bfcdc70b0ca2eba4be95d6eca062e840e9e3f4950f8fca7471421216d1de9
+  data.tar.gz: 14d65cba7bbcc28dc6741622abef7b91a8863ed8e738b35de373c1758e21f045
 SHA512:
-  metadata.gz: eedc2c396f6d43e3a954889a4f66b6416b71ad2d98fd3bb44e50599069a6791998e873a22ad88f6c80f3add2f70abd3a7d19df86702a745a1e1494836cc54892
-  data.tar.gz: 6cd70bb813ce62ea92d7754601fb57df410b0bb1946bd8c251085d20ce18d2b5125f853bd9a6b7f6bcb538175979b923d49573611a855816c563e5160a92e9c4
+  metadata.gz: 99a4e50942b3322d2a86e04b5c5b56e060718788beee10af35ca79de9331bf882d16f0311c9908d97bd8c5d88926e29fd1360fcaf30c90d5d3fd17b77813a238
+  data.tar.gz: d502bab08d5c44d183f6c741ed2d12c53cd5b27962c9a3eca384c66e213a0d1c5bdbce058184a13fdaf3495fca65f13f7e469a0a2fc59da861f4e8cffc18335d

data/README.md

@@ -1,11 +1,86 @@
-# SqlView
-Short description and motivation.
+# Rails + SQL View
+
+[![Listed on OpenSource-Heroes.com](https://opensource-heroes.com/badge-v1.svg)](https://opensource-heroes.com/r/igorkasyanchuk/sql_view)
+
+## The easist way to add and work with SQL view in your app.
+
+If you are lazy and don't like to write SQL to create SQL view but you know AR use your skills to create views.
+
+Production-ready.
+
+![Demo](docs/sql_view.gif?raw=true "Demo")
 
 ## Usage
-How to use my plugin.
+
+The most simple way to add a view is to call a generator (examples below):
+
+```bash
+rails g sql_view:view DeletedProjects 'Project.only_deleted'
+rails g sql_view:view ActiveUsers 'User.confirmed.where(active: true)' --materialized
+```
+
+Depending on whether you need a materialized view or not add `--materialized` flag (later you can change in "view" class). Materialized views works in Postgres.
+
+Generator will create a file similar to:
+
+```ruby
+class ActiveUserView < SQLView::Model
+  materialized
+
+  schema -> { User.where(age: 18..60) }
+
+  extend_model_with do
+    # sample how you can extend it, similar to regular AR model
+    #
+    # include SomeConcern
+    #
+    # belongs_to :user
+    # has_many :posts
+    #
+    # scope :ordered, -> { order(:created_at) }
+    # scope :by_role, ->(role) { where(role: role) }
+  end
+end
+```
+
+or if you want to use SQL to create a regular view:
+
+
+```ruby
+class ActiveUserView < SQLView::Model
+  schema -> { "SELECT * FROM users WHERE active = TRUE" }
+end
+```
+
+or the same but materialized:
+
+```ruby
+class ActiveUserView < SQLView::Model
+  materialized
+  schema -> { "SELECT * FROM users WHERE active = TRUE" }
+end
+```
+
+Later with view you can work same way as with any model(ActiveRecord class). For example:
+
+```ruby
+ActiveUserView.model.count
+# or
+ActiveUserView.count
+# ----
+ActiveUserView.find(42)
+# you can apply scopes, relations, methods, BUT add them in extend_model_with block
+
+ActiveUserView.model.by_role("admin").count
+ActiveUserView.where(role: "admin").exists?
+ActiveUserView.model.includes(:profile)
+```
+
+If you need to refresh materialized view - `ActiveUserView.sql_view.refresh` (if you need to do it concerrently - `.refresh(concurrently: false)`.
+
+More examples in this file: `./test/sql_view_test.rb`
 
 ## Installation
-Add this line to your application's Gemfile:
 
 ```ruby
 gem "sql_view"
@@ -16,17 +91,67 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install sql_view
+And use generator. Or you can connect it to existing view with `view_name=`:
+
+```ruby
+class OldUserView < SqlView::Model
+  self.view_name = "all_old_users"
+
+  materialized
+
+  schema -> {  User.where("age > 18") }
+
+  extend_model_with do
+    scope :ordered, -> { order(:id) }
+
+    def test_instance_method
+      42
+    end
+  end
+end
+```
+
+## Materialized view + concurrent update
+
+1. add index
+
+```ruby
+  add_index SomeView.view_name, :user_id, unique: true
 ```
 
+2. refresh with parameter
+
+```ruby
+  SomeView.sql_view.refresh(concurrently: true)
+```
+
+3. profit :)
+
+## TODO
+
+- CI with different versions of Rails/Ruby
+- make unit tests works with `rake test`
+- `cascade` option
+- move classes to own files
+- code coverage
+- verify how it works with other DB's
+- check if schema was changed on migrate or schema dump?
+
 ## Testing
 
 `ruby ./test/sql_view_test.rb` (because somehow `rake test` not works, not critical for now)
 
 ## Contributing
-Contribution directions go here.
+
+You are welcome to contribute.
+
+## Credits
+
+I know about and actually using `gem scenic`, which is very nice and I tool some examples from it how to dump view into schema.rb but this gem was created to simplify life and reduce amount of time needed to write SQL to create a sql view.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
+/>](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=sql_view)

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

@@ -11,7 +11,7 @@ module SqlView
 
       def create_everything
         create_file "app/sql_views/#{file_name}_view.rb", <<-FILE
-class #{class_name}View < SqlView::Model
+class #{class_name}View < SQLView::Model
 #{top_code}
 
   schema ->#{schema_code}

data/lib/sql_view/schema_dumper.rb

@@ -8,20 +8,21 @@ module SqlView
     class DBView < OpenStruct
       def to_schema
         <<-DEFINITION
-  create_sql_view "#{self.viewname}", sql: <<-\SQL
-    CREATE #{materialized_or_not} VIEW "#{self.viewname}" AS
+  create_sql_view "#{viewname}", sql: <<-\SQL
+    CREATE#{materialized_or_not}VIEW "#{viewname}" AS
     #{escaped_definition.indent(2)}
   SQL\n
         DEFINITION
       end
 
       private
+
       def materialized?
-        self.kind == "m"
+        kind == "m"
       end
 
       def materialized_or_not
-        materialized? ? " MATERIALIZED " : nil
+        materialized? ? " MATERIALIZED " : " "
       end
 
       def escaped_definition
@@ -35,40 +36,18 @@ module SqlView
     end
 
     def views(stream)
-      if dumpable_views_in_database.any?
-        stream.puts
-      end
+      stream.puts if sql_views.any?
 
-      dumpable_views_in_database.each do |viewname|
-        next if already_indexed?(viewname)
-        view = DBView.new(get_view_info(viewname))
+      sql_views.each do |view|
         stream.puts(view.to_schema)
-        indexes(viewname, stream)
+        indexes(view.viewname, stream)
       end
     end
 
     private
 
-    # make sure view was added one time, because somehow was adding views two times
-    def already_indexed?(viewname)
-      @already_indexed ||= []
-      return true if @already_indexed.include?(viewname)
-      @already_indexed << viewname
-      false
-    end
-
-    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)
+    def sql_views
+      @sql_views ||= ActiveRecord::Base.connection.execute(<<-SQL)
         SELECT
           c.relname as viewname,
           pg_get_viewdef(c.oid) AS definition,
@@ -79,10 +58,11 @@ module SqlView
         WHERE
           c.relkind IN ('m', 'v')
           AND c.relname NOT IN (SELECT extname FROM pg_extension)
+          AND c.relname != 'pg_stat_statements_info'
           AND n.nspname = ANY (current_schemas(false))
         ORDER BY c.oid
       SQL
-    .to_a
+    .to_a.map(&DBView.method(:new)).reject { |view| ignored?(view.viewname) }
     end
 
     unless ActiveRecord::SchemaDumper.private_instance_methods(false).include?(:ignored?)
@@ -100,3 +80,5 @@ module SqlView
     end
   end
 end
+
+SQLView = SqlView

data/lib/sql_view/version.rb

@@ -1,3 +1,3 @@
 module SqlView
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/sql_view.rb

@@ -7,6 +7,7 @@ require "sql_view/railtie"
 #
 #
 # TODO for now in a single file
+# move to separate files
 #
 #
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_view
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Igor Kasyanchuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,13 +84,12 @@ files:
 - 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key: 
+rubygems_version: 3.4.13
+signing_key:
 specification_version: 4
 summary: Simple way to create and interact with your SQL views using ActiveRecord.
 test_files: []

data/lib/tasks/sql_view_tasks.rake

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