pul_rails_template 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 490252911b1e008363cf03cf43f96a5afb3a7e96ba4d3835512d020bfee445b1
+  data.tar.gz: 6d994c224f677f86c9c7132c4939784b6c3c9c3c743642d7846936fd2300c86d
+SHA512:
+  metadata.gz: 304971553c0ff8a1994382c4861061300413e54c6ed3d105e3792e3b408e5c7fc3d7c9b1a524765ed0756ae08e008ab85d89169b73f1ef985603efd1dac4d3c0
+  data.tar.gz: 3bfb93d13ef132f26cf7b55fbdfb9e6894ca496b39ec5d064a2f1a3e076b3451edd08cbe538f05bac46653f18b98e62301ccd5cc06b5e346a218574e04b831bf

data/.railsrc

@@ -0,0 +1,3 @@
+--database=postgresql
+--skip-test
+--template=https://raw.githubusercontent.com/pulibrary/pul_rails_template/main/template.rb

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/.tool-versions

@@ -0,0 +1,2 @@
+ruby 3.1.0
+nodejs 16.15.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pul_rails_template.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,11 @@
+# pul_rails_template
+
+This project is a template for generating new DLS Rails applications.
+
+Installation:
+`gem install pul_rails_template`
+
+To generate a local test application from this template:
+1. `git clone https://github.com/pulibrary/pul_rails_template`
+2. `cd pul_rails_template`
+3. `./bin/generate`

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/pul_rails_template/install_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module PulRailsTemplate
+  class Install < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def asdf_tool_versions
+      copy_file ".tool-versions", ".tool-versions"
+    end
+
+    def rubocop
+      copy_file ".rubocop.yml", ".rubocop.yml"
+    end
+
+    def rspec
+      run "bin/rails generate rspec:install"
+    end
+
+    def circle_ci
+      directory ".circleci", ".circleci"
+      inject_into_file "config/database.yml",
+        "  username: <%= ENV[\"lando_database_creds_user\"] || \"pul_rails_template_user\" %>\n",
+        after: "database: db/test.sqlite3\n"
+      gsub_file ".circleci/config.yml", "pul_rails_template", Rails.application.class.to_s.gsub("::Application", "").underscore
+    end
+
+    def simplecov
+      inject_into_file "spec/rails_helper.rb",
+        "require \"spec_helper\"\nSimpleCov.start \"rails\"\n",
+        after: "require 'spec_helper'\n"
+    end
+
+    def capistrano
+      run "bundle exec cap install"
+      inject_into_file "config/deploy.rb",
+        "\n# Default branch is :main\nset :branch, ENV[\"BRANCH\"] || \"main\"\n",
+        after: "set :repo_url, \"git@example.com:me/my_repo.git\"\n"
+    end
+
+    def axe
+      inject_into_file "spec/rails_helper.rb", "require 'axe-rspec'\n", after: "require 'spec_helper'\n"
+      gsub_file "app/views/layouts/application.html.erb", "<html>", "<html lang=\"en\">"
+      run "mkdir ./spec/features"
+      copy_file "accessibility_spec.rb", "./spec/features/accessibility_spec.rb"
+    end
+  end
+end

data/lib/generators/pul_rails_template/templates/.circleci/config.yml

@@ -0,0 +1,103 @@
+version: 2.1
+orbs:
+  browser-tools: circleci/browser-tools@1.2.5
+  node: circleci/node@5.0.2
+
+commands:
+  install_dependencies:
+    steps:
+      - run: gem install bundler -v '2.3.18'
+      - restore_cache:
+          keys:
+            - pul_rails_template-{{ checksum "Gemfile.lock" }}
+      - run: bundle install --path ./vendor/bundle
+      - save_cache:
+          key: pul_rails_template-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ./vendor/bundle
+      - restore_cache:
+          name: Restore Yarn Package Cache
+          key: pul_rails_template-yarn-{{ checksum "yarn.lock" }}
+      - run:
+          name: Install NPM Dependencies via Yarn
+          command: yarn install --frozen-lockfile
+      - save_cache:
+          name: Save Yarn Package Cache
+          key: pul_rails_template-yarn-{{ checksum "yarn.lock" }}
+          paths:
+            - ~/.cache/yarn
+jobs:
+  build:
+    working_directory: ~/pul_rails_template
+    docker:
+      - image: cimg/ruby:3.1.0-browsers
+        environment:
+          RAILS_ENV: test
+    steps:
+      - browser-tools/install-browser-tools
+      - run:
+          name: remove errant LICENSE file
+          command: rm LICENSE.chromedriver
+      - checkout
+      - node/install:
+          install-yarn: true
+          node-version: '16.15.0'
+      - run: sudo apt update && sudo apt install postgresql-client
+      - install_dependencies
+      - persist_to_workspace:
+          root: '~/pul_rails_template'
+          paths: '*'
+
+  rubocop:
+    working_directory: ~/pul_rails_template
+    docker:
+      - image: cimg/ruby:3.1.0-browsers
+        environment:
+          RAILS_ENV: test
+    steps:
+      - attach_workspace:
+          at: '~/pul_rails_template'
+      - install_dependencies
+      - run:
+          name: Run rubocop
+          command: bundle exec rubocop
+
+  test:
+    working_directory: ~/pul_rails_template
+    docker:
+      - image: cimg/ruby:3.1.0-browsers
+        environment:
+          RAILS_ENV: test
+      - image: postgres:10.6-alpine
+        environment:
+          POSTGRES_USER: pul_rails_template_user
+          POSTGRES_DB: test_db
+          POSTGRES_HOST_AUTH_METHOD: trust
+    steps:
+      - browser-tools/install-browser-tools
+      - attach_workspace:
+          at: '~/pul_rails_template'
+      - install_dependencies
+      - run:
+          name: Wait for PostgreSQL
+          command: dockerize -wait tcp://localhost:5432 -timeout 1m
+      - run: bundle exec rake db:create
+      - run: bundle exec rake db:migrate
+      - run: bundle exec rake db:migrate RAILS_ENV=test
+      - run:
+          name: Run Rspec
+          command: bundle exec rspec
+      - store_artifacts:
+          path: coverage
+
+workflows:
+  version: 2
+  build_accept_deploy:
+    jobs:
+      - build
+      - test:
+          requires:
+            - build
+      - rubocop:
+          requires:
+            - build

data/lib/generators/pul_rails_template/templates/.rubocop.yml

@@ -0,0 +1,42 @@
+inherit_gem:
+  bixby: bixby_default.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  DisabledByDefault: true
+  DisplayCopNames: true
+  Exclude:
+    - "db/**/*"
+    - "script/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+    - "node_modules/**/*"
+    - "bin/*"
+
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+Metrics/BlockLength:
+  Exclude:
+    - "config/environments/**/*"
+    - "lib/tasks/**/*"
+    - "spec/**/*"
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+RSpec/DescribeClass:
+  Exclude:
+    - "spec/views/**/*"
+    - "spec/system/**/*"
+
+RSpec/ExampleLength:
+  Enabled: false
+  Exclude:
+  - "spec/features/accessibility_spec.rb"

data/lib/generators/pul_rails_template/templates/.tool-versions

@@ -0,0 +1,2 @@
+ruby 3.1.0
+nodejs 16.15.0

data/lib/generators/pul_rails_template/templates/accessibility_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "accessibility", type: :feature, js: true do
+  context "home page" do
+    it "complies with WCAG" do
+      visit "/"
+      expect(page).to be_axe_clean
+        .according_to(:wcag2a, :wcag2aa, :wcag21a, :wcag21aa)
+    end
+  end
+end

data/lib/pul_rails_template/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PulRailsTemplate
+  VERSION = "0.2.0"
+end

data/lib/pul_rails_template.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "pul_rails_template/version"
+require_relative "generators/pul_rails_template/install_generator"
+
+module PulRailsTemplate
+  class Error < StandardError; end
+
+  def self.root
+    File.expand_path "../..", __FILE__
+  end
+end

data/template.rb

@@ -0,0 +1,33 @@
+if ENV["GEM_TEST"]
+  gem "pul_rails_template", path: "../."
+else
+  gem "pul_rails_template"
+end
+
+gem_group :development, :test do
+  gem "bixby"
+  gem "pry-byebug"
+  gem "pry-rails"
+  gem "rspec-rails", "~> 5.0.0"
+end
+
+gem_group :test do
+  gem "simplecov", require: false
+  gem "axe-core-rspec"
+end
+
+gem_group :development do
+  gem "capistrano"
+  gem "capistrano-passenger"
+  gem "capistrano-rails"
+  gem "capistrano-rails-console"
+end
+
+generate "pul_rails_template:install", "-f"
+
+# Remove unneeded pul_rails_template gem from Gemfile.
+gemfile = File.expand_path("Gemfile")
+File.write(gemfile, File.open(gemfile) do |f|
+                      text = f.read
+                      text.gsub(/^gem "pul_rails_template".*$/, "")
+                    end)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: pul_rails_template
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Eliot Jordan
+- Taylor Yamashita
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".railsrc"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/pul_rails_template/install_generator.rb
+- lib/generators/pul_rails_template/templates/.circleci/config.yml
+- lib/generators/pul_rails_template/templates/.rubocop.yml
+- lib/generators/pul_rails_template/templates/.tool-versions
+- lib/generators/pul_rails_template/templates/accessibility_spec.rb
+- lib/pul_rails_template.rb
+- lib/pul_rails_template/version.rb
+- template.rb
+homepage:
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: Template for generating new DLS Rails applications.
+test_files: []