scenic 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23461e20bd94ffe9d2466098b04141ef8b8256d83f6c05cf5c5d9f26cca08231
-  data.tar.gz: 6c331ddfc7c4d658b342367e2f2fcf703bf2b376314c32520d55afdbc05e936a
+  metadata.gz: b378292bd7d642dcd235d01f5a31d94c74065b798ab469a9c091f68e936f4d9c
+  data.tar.gz: b97f6e156685d4c03761543d5748f1381447c94cfcc42f7d6ddb8714e16791d0
 SHA512:
-  metadata.gz: 23e1ab6998fb898eebdc91691684bffc694fe51001ada435593cb9e6a3857074e13e6d1ba90333acf3a76069f2e687c129595389ce60ac7790bbb82cdfdd68c2
-  data.tar.gz: 2d91d5a48e68ef856ea9ffb14c3abb503fcaa1c588e17f55775ef32d2ae5f4f2862fd68aa53a99b2c666a0a81d88cba026fa21cdf2f4cc5b5e8a3f8062eb4779
+  metadata.gz: 4ffb0c73e52da5122a8ce3092b7f280d1a1dcaac9ca03a5f8ea63fe361d1b011d3c71f54706ff17d8ee1768fbdc1ba32c38bfebbcda320271e0b751eaea340f3
+  data.tar.gz: 846d53ffe8c0d0209ab6517c47e0447ee3b40a81e5f55f845f16a1b3f697cebd44ad38550a5fe8d10016ab19b3c1197f36ea9f3f5f7f42395a1431790684e0c1

data/.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ["2.7", "3.0", "3.1"]
-        rails: ["6.1", "7.0", "master"]
+        rails: ["6.1", "7.0"]
         continue-on-error: [false]
 
     runs-on: ubuntu-latest

data/CHANGELOG.md

@@ -5,21 +5,29 @@ changelog, see the [commits] for each version via the version links.
 
 [commits]: https://github.com/scenic-views/scenic/commits/master
 
-## [1.6.0] - February 13, 2021
+## [1.7.0] - December 8, 2022
 
-### Fixed
+[1.7.0]: https://github.com/scenic-views/scenic/compare/v1.6.0...v1.7.0
+
+### Added
 
-* Exclude pg_stat_statements_info (#349) 76bface
+* Added the `--replace` CLI flag to generate a migration that uses the
+  `replace_view` schema statement - *Dan Hixon*
 
-  *Caleb Hearth*
+### Fixed
+
+* Fixed deprecation notice from newer versions of ERB when using scenic
+  generators - *Ali Ismayilov*
 
-* Fix serialization of views with backslashes c625d1b
+## [1.6.0] - February 13, 2022
 
-  *Ben Sheldon*
+[1.6.0]: https://github.com/scenic-views/scenic/compare/v1.5.5...v1.6.0
 
-* Handle ActiveRecord table name prefix and suffix b1544dc
+### Fixed
 
-  *Derek Prior*
+* Exclude pg_stat_statements_info (#349) 76bface - *Caleb Hearth*
+* Fix serialization of views with backslashes c625d1b - *Ben Sheldon*
+* Handle ActiveRecord table name prefix and suffix b1544dc - *Derek Prior*
 
 ## [1.5.5] - December 15, 2021
 

data/README.md

@@ -92,30 +92,19 @@ a new version of it.
 This is not desirable when you have complicated hierarchies of views, especially
 when some of those views may be materialized and take a long time to recreate.
 
-You can use `replace_view` to generate a CREATE OR REPLACE VIEW SQL statement.
-
-See Postgres documentation on how this works:
-http://www.postgresql.org/docs/current/static/sql-createview.html
-
-To start replacing a view run the generator like for a regular change:
+You can use `replace_view` to generate a CREATE OR REPLACE VIEW SQL statement
+instead by adding the `--replace` option to the generate command:
 
 ```sh
-$ rails generate scenic:view search_results
+$ rails generate scenic:view search_results --replace
       create  db/views/search_results_v02.sql
       create  db/migrate/[TIMESTAMP]_update_search_results_to_version_2.rb
 ```
 
-Now, edit the migration. It should look something like:
-
-```ruby
-class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
-  def change
-    update_view :search_results, version: 2, revert_to_version: 1
-  end
-end
-```
+See Postgres documentation on how this works:
+http://www.postgresql.org/docs/current/static/sql-createview.html
 
-Update it to use replace view:
+The migration will look something like this:
 
 ```ruby
 class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
@@ -125,7 +114,7 @@ class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
 end
 ```
 
-Now you can run the migration like normal.
+You can run the migration and the view will be replaced instead.
 
 ## Can I use this view to back a model?
 
@@ -252,16 +241,21 @@ accommodate adapter gems.
 We are aware of the following existing adapter libraries for Scenic which may
 meet your needs:
 
-* [scenic_sqlite_adapter](https://github.com/pdebelak/scenic_sqlite_adapter)
-* [scenic-mysql_adapter](https://github.com/EmpaticoOrg/scenic-mysql_adapter)
-* [scenic-sqlserver-adapter](https://github.com/ClickMechanic/scenic_sqlserver_adapter)
-* [scenic-oracle_adapter](https://github.com/cdinger/scenic-oracle_adapter)
+* [`scenic_sqlite_adapter`](<https://github.com/pdebelak/scenic_sqlite_adapter>)
+* [`scenic-mysql_adapter`](<https://github.com/EmpaticoOrg/scenic-mysql_adapter>)
+* [`scenic-sqlserver-adapter`](<https://github.com/ClickMechanic/scenic_sqlserver_adapter>)
+* [`scenic-oracle_adapter`](<https://github.com/cdinger/scenic-oracle_adapter>)
 
 Please note that the maintainers of Scenic make no assertions about the
 quality or security of the above adapters.
 
 ## About
 
+Scenic is used by some popular open source Rails apps:
+[Mastodon](<https://github.com/mastodon/mastodon/>),
+[Code.org](<https://github.com/code-dot-org/code-dot-org>), and
+[Lobste.rs](<https://github.com/lobsters/lobsters/>).
+
 Scenic is maintained by [Derek Prior], [Caleb Hearth], and you, our
 contributors.
 

data/lib/generators/scenic/materializable.rb

@@ -15,6 +15,11 @@ module Scenic
           required: false,
           desc: "Adds WITH NO DATA when materialized view creates/updates",
           default: false
+        class_option :replace,
+          type: :boolean,
+          required: false,
+          desc: "Uses replace_view instead of update_view",
+          default: false
       end
 
       private
@@ -23,6 +28,10 @@ module Scenic
         options[:materialized]
       end
 
+      def replace_view?
+        options[:replace]
+      end
+
       def no_data?
         options[:no_data]
       end

data/lib/generators/scenic/model/model_generator.rb

@@ -36,12 +36,23 @@ module Scenic
       def evaluate_template(source)
         source  = File.expand_path(find_in_source_paths(source.to_s))
         context = instance_eval("binding", __FILE__, __LINE__)
-        ERB.new(
-          ::File.binread(source),
-          nil,
-          "-",
-          "@output_buffer",
-        ).result(context)
+
+        if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
+          erb = ERB.new(
+            ::File.binread(source),
+            trim_mode: "-",
+            eoutvar: "@output_buffer",
+          )
+        else
+          erb = ERB.new(
+            ::File.binread(source),
+            nil,
+            "-",
+            "@output_buffer",
+          )
+        end
+
+        erb.result(context)
       end
 
       def generating?

data/lib/generators/scenic/view/templates/db/migrate/update_view.erb

@@ -1,12 +1,13 @@
 class <%= migration_class_name %> < <%= activerecord_migration_class %>
   def change
+  <% method_name = replace_view? ? 'replace_view' : 'update_view' %>
   <%- if materialized? -%>
-    update_view <%= formatted_plural_name %>,
+    <%= method_name %> <%= formatted_plural_name %>,
       version: <%= version %>,
       revert_to_version: <%= previous_version %>,
       materialized: <%= no_data? ? "{ no_data: true }" : true %>
   <%- else -%>
-    update_view <%= formatted_plural_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
+    <%= method_name %> <%= formatted_plural_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
   <%- end -%>
   end
 end

data/lib/scenic/version.rb

@@ -1,3 +1,3 @@
 module Scenic
-  VERSION = "1.6.0".freeze
+  VERSION = "1.7.0".freeze
 end

data/lib/scenic/view.rb

@@ -26,7 +26,7 @@ module Scenic
     #
     # @param name [String] The name of the view.
     # @param definition [String] The SQL for the query that defines the view.
-    # @param materialized [String] `true` if the view is materialized.
+    # @param materialized [Boolean] `true` if the view is materialized.
     def initialize(name:, definition:, materialized:)
       @name = name
       @definition = definition

data/spec/generators/scenic/view/view_generator_spec.rb

@@ -37,6 +37,18 @@ describe Scenic::Generators::ViewGenerator, :generator do
     end
   end
 
+  it "uses 'replace_view' instead of 'update_view' if replace flag is set" do
+    with_view_definition("aired_episodes", 1, "hello") do
+      allow(Dir).to receive(:entries).and_return(["aired_episodes_v01.sql"])
+
+      run_generator ["aired_episode", "--replace"]
+      migration = migration_file(
+        "db/migrate/update_aired_episodes_to_version_2.rb",
+      )
+      expect(migration).to contain "replace_view"
+    end
+  end
+
   context "for views created in a schema other than 'public'" do
     it "creates a view definition" do
       view_definition = file("db/views/non_public_searches_v01.sql")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scenic
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Derek Prior
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -277,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Support for database views in Rails migrations