mr_common 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a96c4b6f4f61d5073ff29366c45604d11f17e3940f0281337b00bee5395331b4
+  data.tar.gz: fb3a6d23c9e14d6b9fb136ded3280c5c57b4593037d58794b1f18c083ed654f5
+SHA512:
+  metadata.gz: d8f9d5fb2b93cd18513765055a8d1ea859e296122586feb780c675789c36f40a7038defd5fd097a496cac17f864d41d96e516a0b9eb4e0203bfad1795a508364
+  data.tar.gz: 771f6d4bda282aa3707814f8a0d313c4e8ca932554116d74cfb681b1f0e1cea195b57118936e8097367433c5faaaa45a9616f81479ffe74db8c3597784e0b3ad

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Corey Smedstad
+
+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,57 @@
+# MrCommon
+Common utilities extracted from starter-reg-site for use elsewhere
+
+## Features
+* Dashboard at the mount point that relies on the host app for authentication
+* [MrCommon::Registration](/doc/mr_common/registration.md) - default registration model and controller with csv export exposed via the dashboard
+* [MrCommon::Reminder](/doc/mr_common/reminder.md) - model for generating downloadable ical reminders
+* MrCommon::Country - convenient wrapper around the Carmen gem
+* MrCommon::Pattern - a utility class for sharing common regex patterns
+* MrCommon::Concerns::CSVExportable - include to add `.as_csv` to any ActiveRecord model
+
+## Installation
+Add to Gemfile
+
+```ruby
+# Gemfile
+gem 'mr_common', '~> 1'
+```
+
+Add to routes.rb
+```ruby
+# config/routes.rb
+mount MrCommon::Engine, at: '/common'
+# If you plan to use the default registration model, 
+# set the host app's root route to the default registration 
+# form, and override the the templates. (See MrCommon::Reminder for more instructions )
+# root to: "mr_common/registrations/public#new"
+```
+
+Configure initializer
+```ruby
+# config/initializers/mr_common.rb
+MrCommon.base_controller_name = "::ApplicationController"
+MrCommon.user_class_name = "::User"
+MrCommon.authentication_method_name = :authenticate_user!
+MrCommon.current_user_method_name = :current_user
+MrCommon.current_user_authorization_method_name = :mr_common_admin?
+MrCommon.logout_path_helper = :destroy_user_session_path
+MrCommon.logout_path_method = :delete
+MrCommon.sign_in_path_helper = :new_user_session_path
+MrCommon.registration_success_notice = "Registration completed successfully."
+MrCommon.registration_failure_alert = "Registration could not be completed."
+MrCommon.host_app_layout = "application"
+MrCommon.registration_confirmation_subject = "Your registration confirmation."
+MrCommon.registration_reminder_slug = "reminder"
+```
+
+## Development
+
+1. `gem install foreman mailcatcher`
+1. Clone
+1. Bundle Install
+1. Don't yarn. Engines have to use old school sprockets manifests
+1. run `bin/rails run` to start the app + mailcatcher.
+
+## 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,61 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "MrCommon"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(spec: "app:db:test:prepare")
+
+task default: :spec
+
+desc "Run rubocop linter"
+task "lint" do
+  Bundler.with_clean_env do
+    exec "bin/rubocop"
+  end
+end
+
+desc "Run rubocop linter"
+task "lint:fix" do
+  Bundler.with_clean_env do
+    exec "bin/rubocop -a"
+  end
+end
+
+desc "Reformat CSS"
+task "comb" do
+  Bundler.with_clean_env do
+    exec "yarn comb"
+  end
+end
+
+desc "run dev env"
+task "run" do
+  Bundler.with_clean_env do
+    exec "foreman start -f Procfile.dev"
+  end
+end

data/app/assets/javascripts/mr_common/mr_common.js

@@ -0,0 +1 @@
+//= require rails-ujs

data/app/assets/stylesheets/mr_common/_badges.scss

@@ -0,0 +1,15 @@
+span.badge {
+  @include badge($secondary);
+
+  &-success {
+    @include badge($notice);
+  }
+
+  &-alert {
+    @include badge($alert);
+  }
+
+  &-primary {
+    @include badge($primary-light);
+  }
+}

data/app/assets/stylesheets/mr_common/_buttons.scss

@@ -0,0 +1,32 @@
+button,
+a.button {
+  @include button($secondary);
+}
+
+input[type=submit] {
+  @include button($primary);
+}
+
+a,
+button,
+input[type=submit] {
+  &.button-primary {
+    @include button($primary);
+  }
+
+  &.button-secondary {
+    @include button($secondary);
+  }
+
+  &.button-alert {
+    @include button(mix($alert, black, 80%));
+  }
+
+  &.button-notice {
+    @include button(mix($notice, black, 80%));
+  }
+}
+
+.button-group {
+  padding: 0rem 2rem;
+}

data/app/assets/stylesheets/mr_common/_flash.scss

@@ -0,0 +1,28 @@
+.flash {
+  width: 100%;
+  height: 1.5rem;
+  margin-bottom: 0.5rem;
+  background-color: $secondary-light;
+  padding: 0.25rem 0.5rem;
+
+  span {
+    font-size: 1rem;
+    line-height: 1rem;
+  }
+
+  &.notice {
+    background-color: $notice-bg;
+
+    span.notice {
+      color: $notice-text;
+    }
+  }
+
+  &.alert {
+    background-color: $alert-bg;
+
+    span.alert {
+      color: $alert-text;
+    }
+  }
+}

data/app/assets/stylesheets/mr_common/_forms.scss

@@ -0,0 +1,167 @@
+label {
+  display: block;
+  font-family: $heading-font;
+  font-weight: bold;
+}
+
+.form-group {
+  display: block;
+  margin-bottom: 1.4rem;
+
+  &.required {
+    label {
+      &::after {
+        content: $sixpoint-star;
+        color: $alert-text;
+      }
+    }
+  }
+
+  &:last-child {
+    margin-bottom: 0;
+  }
+
+  ul {
+    margin-left: -1rem;
+  }
+
+  ul li {
+    display: inline-block;
+    margin-left: 1rem;
+  }
+}
+
+div.error-message {
+  margin-bottom: -1rem;
+  line-height: 1rem;
+  font-size: 0.8rem;
+  color: $alert-text;
+}
+
+input[type=text],
+input[type=tel],
+input[type=date],
+input[type=datetime],
+input[type=datetime-local],
+input[type=email],
+input[type=password],
+input[type=number],
+input[type=search],
+input[type=url],
+input[type=time],
+textarea {
+  display: block;
+  border-radius: 2px;
+  border: 1px solid $primary;
+  padding: 0.4rem 0.8rem;
+  width: 100%;
+
+  &:focus {
+    box-shadow: 0 0 3px $primary-shadow;
+  }
+
+  &:disabled {
+    background-color: mix($primary, white, 10%);
+    cursor: not-allowed;
+  }
+}
+
+textarea {
+  min-height: 4rem;
+  max-height: 20rem;
+  resize: vertical;
+}
+
+select {
+  -webkit-appearance: none;
+     -moz-appearance: none;
+          appearance: none;
+  border-radius: 2px;
+  border: 1px solid $primary;
+  padding: 0.4rem 2rem 0.3rem 0.8rem;
+  background-image: $down-chevron;
+  background-position: center;
+  background-position-x: calc(100% - 0.5rem);
+  background-repeat: no-repeat;
+
+  &:focus {
+    box-shadow: 0 0 3px $primary-shadow;
+  }
+
+  &:disabled {
+    background-color: mix($primary, white, 5%);
+    cursor: not-allowed;
+  }
+}
+
+input[type=submit] {
+  @include button($primary);
+}
+
+input[type=checkbox] {
+  -webkit-appearance: none;
+     -moz-appearance: none;
+          appearance: none;
+  line-height: 1rem;
+  margin: 0 0.25rem 0 0;
+  padding: 0;
+
+  &:before {
+    position: relative;
+    top: -0.1rem;
+    margin: 0;
+    padding: 0;
+    display: inline-block;
+    content: "✓";
+    color: transparent;
+    border: 1px solid $primary;
+    font-size: 0.8rem;
+    line-height: 1.15rem;
+    width: 1.15rem;
+    text-align: center;
+    border-radius: 2px;
+  }
+
+  &:checked:before {
+    position: relative;
+    top: -0.1rem;
+    margin: 0;
+    padding: 0;
+    display: inline-block;
+    content: $check-mark;
+    color: $secondary-text-light;
+    border: 1px solid $primary;
+    font-size: 0.8rem;
+    line-height: 1.15rem;
+    width: 1.15rem;
+    text-align: center;
+    background-color: $primary;
+    border-radius: 2px;
+    box-shadow: none;
+  }
+}
+
+input[type=checkbox] + label {
+  width: auto;
+  display: inline-block;
+  line-height: 1.15;
+  margin: -0.25rem;
+  padding: 0.25rem;
+}
+
+input[type=checkbox]:focus + label {
+  box-shadow: 0 0 3px $primary-shadow;
+  border-radius: 3px;
+}
+
+fieldset {
+  padding: 2rem;
+  border: 1px solid mix(#333333, white, 25%);
+  border-radius: 2px;
+  margin-bottom: 1rem;
+
+  legend {
+    font-family: "Montserrat", sans-serif;
+    color: mix(#333333, white, 25%);
+  }
+}

data/app/assets/stylesheets/mr_common/_grid.scss

@@ -0,0 +1,29 @@
+
+.container {
+  max-width: 900px;
+  margin: 0 auto;
+
+  .row {
+    display: flex;
+  }
+
+  .col {
+    padding: 1rem;
+    width: calc(100%/1);
+  }
+
+  .col-2 {
+    padding: 1rem;
+    width: calc(100%/2);
+  }
+
+  .col-3 {
+    padding: 1rem;
+    width: calc(100%/3);
+  }
+
+  .col-4 {
+    padding: 1rem;
+    width: calc(100%/4);
+  }
+}

data/app/assets/stylesheets/mr_common/_layout.scss

@@ -0,0 +1,36 @@
+html {
+  height: 100%;
+  margin: 0;
+  padding: 0;
+  width: 100%;
+}
+
+body {
+  min-height: 100vh;
+  padding: 0;
+  margin: 0;
+  position: relative;
+  width: 100%;
+}
+
+body::after {
+  content: "";
+  display: block;
+  height: 5vh; /* Set same as footer's height */
+}
+
+footer {
+  font-size: 0.8rem;
+  font-weight: bold;
+  color: $primary-dark;
+  background-color: $primary-light;
+  min-height: 20vh;
+  padding: 1rem 0.5rem;
+  position: absolute;
+  bottom: -15vh;
+  width: 100%;
+}
+
+* {
+  box-sizing: border-box;
+}

data/app/assets/stylesheets/mr_common/_mixins.scss

@@ -0,0 +1,60 @@
+@mixin button($color) {
+  transition: box-shadow 0.2s;
+  cursor: pointer;
+  display: inline-block;
+  border-radius: 2px;
+  border: 1px solid $color;
+  padding: 0.4rem 0.8rem;
+  background-color: $color;
+  color: mix($secondary-text, white, 50%);
+  font-weight: bold;
+  box-shadow: 0 3px 3px transparentize($secondary-text, 0.25);
+
+  &:hover {
+    color: mix($secondary-text, white, 50%);
+    cursor: pointer;
+    position: relative;
+    box-shadow: 0 3px 3px 3px transparentize($secondary-text, 0);
+    background-color: mix($color, white, 80%);
+    border: 1px solid mix($color, white, 80%);
+    top: -1px;
+  }
+
+  &:active {
+    outline: none;
+  }
+
+  &[disabled] {
+    transition: box-shadow 0.2s;
+    cursor: not-allowed;
+    display: inline-block;
+    border-radius: 2px;
+    padding: 0.4rem 0.8rem;
+    background-color: mix($color, white, 30%);
+    border: 1px solid mix($color, white, 30%);
+    color: mix($secondary-text, white, 50%);
+    font-weight: bold;
+    box-shadow: 0 3px 3px transparentize($secondary-text, 0.25);
+  }
+
+  &[disabled]:hover {
+    color: mix($secondary-text, white, 50%);
+    cursor: not-allowed;
+    position: relative;
+    box-shadow: 0 3px 3px transparentize($secondary-text, 0.25);
+    background-color: mix($color, white, 30%);
+    border: 1px solid mix($color, white, 30%);
+    top: 0;
+  }
+}
+
+@mixin badge($color) {
+  $accent-size: 4px;
+  padding: 0.25rem 0.5rem 0.25rem calc(0.5rem - #{$accent-size});
+  border-radius: 0 6px 6px 6px;
+  border-left: $accent-size solid mix($color, white, 80%);
+  color: $secondary-text-light;
+  background-color: mix($color, white, 50%);
+  font-weight: bold;
+  font-size: 0.8rem;
+}

data/app/assets/stylesheets/mr_common/_navigation.scss

@@ -0,0 +1,40 @@
+.navbar {
+  padding: 0.5rem;
+  background-color: $primary-text;
+  color: $secondary-text-light;
+  font-size: 1rem;
+
+  nav {
+    li {
+      display: inline-block;
+
+      a,
+      a:visited {
+        color: $secondary-text;
+        text-decoration: none;
+      }
+
+      a:hover,
+      a:visited:hover {
+        color: $secondary-text-light;
+        text-decoration: none;
+      }
+
+      a:visited:active,
+      a:active {
+        outline: solid 2px $secondary-text-light;
+        text-decoration: none;
+      }
+
+      &.brand {
+        font-weight: bold;
+        color: $primary-light;
+        font-family: $heading-font;
+      }
+    }
+
+    li + li {
+      margin-left: 1rem;
+    }
+  }
+}

data/app/assets/stylesheets/mr_common/_tables.scss

@@ -0,0 +1,41 @@
+table {
+  width: 100%;
+
+  thead,
+  tbody {
+    th,
+    td {
+      padding: 0.5rem 1rem;
+    }
+
+    th {
+      text-align: left;
+      font-family: "Roboto", sans-serif;
+      font-weight: bold;
+      padding: 0.5rem 1rem;
+    }
+
+    td {
+      font-family: "Roboto", sans-serif;
+    }
+
+    td:last-child,
+    th:last-child {
+      text-align: right;
+    }
+  }
+}
+
+table.attributes-table {
+  th,
+  td {
+    vertical-align: top;
+    text-align: left;
+    padding: 0;
+  }
+
+  td:last-child,
+  th:last-child {
+    text-align: left;
+  }
+}

data/app/assets/stylesheets/mr_common/_type.scss

@@ -0,0 +1,84 @@
+@import url("https://fonts.googleapis.com/css?family=Montserrat|Roboto|Roboto+Mono");
+
+html {
+  font-family: sans-serif;
+  font-size: $base-font-size;
+  color: $primary-text;
+}
+
+strong {
+  color: $primary-text-dark;
+}
+
+small {
+  font-size: 0.8rem;
+  color: $primary-text-light;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  font-family: $heading-font;
+  margin: 0 0 1rem 0;
+}
+
+p,
+span {
+  font-family: $body-font;
+}
+
+p {
+  margin: 0 0 1rem 0;
+}
+
+pre,
+code {
+  font-family: $mono-font;
+}
+
+a {
+  color: $primary;
+  text-decoration: none;
+
+  &:visited {
+    color: $primary;
+    text-decoration: none;
+  }
+
+  &:hover,
+  :visited:hover {
+    color: $primary-light;
+  }
+
+  &:active,
+  :visited:active {
+    outline: solid 2px $primary-light;
+  }
+}
+
+ul {
+  margin: 0 0 2rem 0;
+  padding: 0;
+  list-style: none;
+
+  li {
+    display: block;
+    padding: 0.1rem 0;
+    margin-bottom: 0.1rem;
+  }
+}
+
+.reading-column {
+  max-width: 40rem;
+}
+
+.reading-column-md {
+  max-width: 60rem;
+}
+
+.reading-column-lg {
+  max-width: 80rem;
+}