scenic-jets 1.5.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and
+expression, level of experience, education, socio-economic status, nationality,
+personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at derekprior@gmail.com. All complaints
+will be reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. The project team is obligated to
+maintain confidentiality with regard to the reporter of an incident. Further
+details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+
+We love contributions from everyone.  By participating in this project, you
+agree to abide by our [code of conduct].
+
+[code of conduct]: CODE_OF_CONDUCT.md
+
+## Contributing Code
+
+1. Fork the repository.
+2. Run `bin/setup`, which will install dependencies and create the dummy
+   application database.
+3. Run `rake` to verify that the tests pass against the version of Rails you are
+   running locally.
+4. Make your change with new passing tests, following existing style.
+5. Write a [good commit message], push your fork, and submit a pull request.
+6. CI will run the test suite on all configured versions of Ruby and Rails.
+   Address any failures.
+
+[good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+Others will give constructive feedback.  This is a time for discussion and
+improvements, and making the necessary changes will be required before we can
+merge the contribution.

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in scenic.gemspec
+gemspec
+
+rails_version = ENV.fetch("RAILS_VERSION", "6.0")
+
+if rails_version == "master"
+  rails_constraint = { github: "rails/rails" }
+else
+  rails_constraint = "~> #{rails_version}.0"
+end
+
+gem "rails", rails_constraint
+gem "sprockets", "< 4.0.0"
+gem "pg", "~> 1.1"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2020 Derek Prior, Caleb Hearth, and thoughtbot.
+
+MIT License
+
+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,5 @@
+# Scenic
+
+Version of Scenic gem for Ruby on Jets
+
+u need to add Scenic.load to your initializer

data/Rakefile

@@ -0,0 +1,29 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :smoke do
+  exec "spec/smoke"
+end
+
+namespace :dummy do
+  require_relative "spec/dummy/config/application"
+  Dummy::Application.load_tasks
+end
+
+task(:spec).clear
+desc "Run specs other than spec/acceptance"
+RSpec::Core::RakeTask.new("spec") do |task|
+  task.exclude_pattern = "spec/acceptance/**/*_spec.rb"
+  task.verbose = false
+end
+
+desc "Run acceptance specs in spec/acceptance"
+RSpec::Core::RakeTask.new("spec:acceptance") do |task|
+  task.pattern = "spec/acceptance/**/*_spec.rb"
+  task.verbose = false
+end
+
+desc "Run the specs and acceptance tests"
+task default: %w(spec spec:acceptance)

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+Scenic maintainenance is a volunteer effort. We will do our best to fix
+forward but do not offer backported fixes. As such, the only "supported" version of Scenic is whichever was most recently released.
+
+## Reporting a Vulnerability
+
+Please report any discovered security vulnerabilities to Scenic's primary
+volunteer maintainers, derekprior@gmail.com and caleb@calebhearth.com.
+
+We will respond as soon as possible with any follow-up questions or details
+on how we plan to handle the issue.

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+set -e
+
+# CI-specific setup
+if [ -n "$GITHUB_ACTIONS" ]; then
+  bundle config path vendor/bundle
+  bundle config jobs 4
+  bundle config retry 3
+  git config --global user.name 'GitHub Actions'
+  git config --global user.email 'github-actions@example.com'
+fi
+
+gem install bundler --conservative
+bundle check || bundle install
+
+bundle exec rake dummy:db:drop
+bundle exec rake dummy:db:create

data/bin/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/lib/generators/scenic/generators.rb

@@ -0,0 +1,12 @@
+module Scenic
+  # Scenic provides generators for creating and updating views and ActiveRecord
+  # models that are backed by views.
+  #
+  # See:
+  #
+  # * {file:lib/generators/scenic/model/USAGE Model Generator}
+  # * {file:lib/generators/scenic/view/USAGE View Generator}
+  # * {file:README.md README}
+  module Generators
+  end
+end

data/lib/generators/scenic/materializable.rb

@@ -0,0 +1,31 @@
+module Scenic
+  module Generators
+    # @api private
+    module Materializable
+      extend ActiveSupport::Concern
+
+      included do
+        class_option :materialized,
+          type: :boolean,
+          required: false,
+          desc: "Makes the view materialized",
+          default: false
+        class_option :no_data,
+          type: :boolean,
+          required: false,
+          desc: "Adds WITH NO DATA when materialized view creates/updates",
+          default: false
+      end
+
+      private
+
+      def materialized?
+        options[:materialized]
+      end
+
+      def no_data?
+        options[:no_data]
+      end
+    end
+  end
+end

data/lib/generators/scenic/model/USAGE

@@ -0,0 +1,12 @@
+Description:
+  Create a new database view and ActiveRecord::Base subclass for your
+  application.
+
+  To create a materialized view, pass the '--materialized' option.
+
+Examples:
+    rails generate scenic:model search
+
+      create: app/models/search.rb
+      create: db/views/searches_v1.sql
+      create: db/migrate/20140803191158_create_searches.rb

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

@@ -0,0 +1,52 @@
+require "rails/generators"
+require "rails/generators/rails/model/model_generator"
+require "generators/scenic/view/view_generator"
+require "generators/scenic/materializable"
+
+module Scenic
+  module Generators
+    # @api private
+    class ModelGenerator < Rails::Generators::NamedBase
+      include Scenic::Generators::Materializable
+      source_root File.expand_path("templates", __dir__)
+
+      def invoke_rails_model_generator
+        invoke "model",
+          [file_path.singularize],
+          options.merge(
+            fixture_replacement: false,
+            migration: false,
+          )
+      end
+
+      def inject_model_methods
+        if materialized? && generating?
+          inject_into_class "app/models/#{file_path.singularize}.rb", class_name do
+            evaluate_template("model.erb")
+          end
+        end
+      end
+
+      def invoke_view_generator
+        invoke "scenic:view", [table_name], options
+      end
+
+      private
+
+      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)
+      end
+
+      def generating?
+        behavior != :revoke
+      end
+    end
+  end
+end

data/lib/generators/scenic/model/templates/model.erb

@@ -0,0 +1,3 @@
+  def self.refresh
+    Scenic.database.refresh_materialized_view(table_name, concurrently: false, cascade: false)
+  end

data/lib/generators/scenic/view/USAGE

@@ -0,0 +1,20 @@
+Description:
+  Create a new database view for your application. This will create a new
+  view definition file and the accompanying migration.
+
+  If a view of the given name already exists, create a new version of the view
+  and a migration to replace the old version with the new.
+
+  To create a materialized view, pass the '--materialized' option.
+  To create a materialized view with NO DATA, pass '--no-data' option.
+
+Examples:
+    rails generate scenic:view searches
+
+      create: db/views/searches_v01.sql
+      create: db/migrate/20140803191158_create_searches.rb
+
+    rails generate scenic:view searches
+
+      create: db/views/searches_v02.sql
+      create: db/migrate/20140804191158_update_searches_to_version_2.rb

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

@@ -0,0 +1,5 @@
+class <%= migration_class_name %> < <%= activerecord_migration_class %>
+  def change
+    create_view <%= formatted_plural_name %><%= create_view_options %>
+  end
+end

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

@@ -0,0 +1,12 @@
+class <%= migration_class_name %> < <%= activerecord_migration_class %>
+  def change
+  <%- if materialized? -%>
+    update_view <%= 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 %>
+  <%- end -%>
+  end
+end

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

@@ -0,0 +1,127 @@
+require "rails/generators"
+require "rails/generators/active_record"
+require "generators/scenic/materializable"
+
+module Scenic
+  module Generators
+    # @api private
+    class ViewGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      include Scenic::Generators::Materializable
+      source_root File.expand_path("templates", __dir__)
+
+      def create_views_directory
+        unless views_directory_path.exist?
+          empty_directory(views_directory_path)
+        end
+      end
+
+      def create_view_definition
+        if creating_new_view?
+          create_file definition.path
+        else
+          copy_file previous_definition.full_path, definition.full_path
+        end
+      end
+
+      def create_migration_file
+        if creating_new_view? || destroying_initial_view?
+          migration_template(
+            "db/migrate/create_view.erb",
+            "db/migrate/create_#{plural_file_name}.rb",
+          )
+        else
+          migration_template(
+            "db/migrate/update_view.erb",
+            "db/migrate/update_#{plural_file_name}_to_version_#{version}.rb",
+          )
+        end
+      end
+
+      def self.next_migration_number(dir)
+        ::ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      no_tasks do
+        def previous_version
+          @previous_version ||=
+            Dir.entries(views_directory_path)
+              .map { |name| version_regex.match(name).try(:[], "version").to_i }
+              .max
+        end
+
+        def version
+          @version ||= destroying? ? previous_version : previous_version.next
+        end
+
+        def migration_class_name
+          if creating_new_view?
+            "Create#{class_name.tr('.', '').pluralize}"
+          else
+            "Update#{class_name.pluralize}ToVersion#{version}"
+          end
+        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
+
+      def views_directory_path
+        @views_directory_path ||= Jets.root.join("db", "views")
+      end
+
+      def version_regex
+        /\A#{plural_file_name}_v(?<version>\d+)\.sql\z/
+      end
+
+      def creating_new_view?
+        previous_version.zero?
+      end
+
+      def definition
+        Scenic::Definition.new(plural_file_name, version)
+      end
+
+      def previous_definition
+        Scenic::Definition.new(plural_file_name, previous_version)
+      end
+
+      def destroying?
+        behavior == :revoke
+      end
+
+      def formatted_plural_name
+        if plural_name.include?(".")
+          "\"#{plural_name}\""
+        else
+          ":#{plural_name}"
+        end
+      end
+
+      def create_view_options
+        if materialized?
+          ", materialized: #{no_data? ? '{ no_data: true }' : true}"
+        else
+          ""
+        end
+      end
+
+      def destroying_initial_view?
+        destroying? && version == 1
+      end
+    end
+  end
+end