potassium 5.2.2 → 6.3.0

data/lib/potassium/assets/.stylelintrc.json

@@ -0,0 +1,46 @@
+{
+  "rules": {
+    "declaration-bang-space-before": "always",
+    "declaration-bang-space-after": "never",
+    "declaration-property-value-blacklist": {
+      "/^border/": ["none"]
+    },
+    "color-named": "never",
+    "declaration-block-no-duplicate-properties": true,
+    "rule-empty-line-before": ["always-multi-line", {
+      "except": ["after-single-line-comment", "first-nested"]
+    }],
+    "block-no-empty": true,
+    "no-missing-end-of-source-newline": true,
+    "color-hex-length": "short",
+    "color-hex-case": "lower",
+    "color-no-invalid-hex": true,
+    "selector-max-id": 0,
+    "declaration-no-important": true,
+    "indentation": 2,
+    "number-leading-zero": "never",
+    "no-duplicate-selectors": true,
+    "max-nesting-depth": 3,
+    "selector-pseudo-element-colon-notation": "double",
+    "selector-no-qualifying-type": true,
+    "shorthand-property-no-redundant-values": true,
+    "declaration-block-semicolon-newline-after": "always-multi-line",
+    "selector-list-comma-newline-after": "always",
+    "function-comma-space-after": "always-single-line",
+    "declaration-colon-space-after": "always",
+    "declaration-colon-space-before": "never",
+    "block-opening-brace-space-before": "always",
+    "function-parentheses-space-inside": "never",
+    "string-quotes": "single",
+    "declaration-block-trailing-semicolon": "always",
+    "no-eol-whitespace": true,
+    "number-no-trailing-zeros": true,
+    "function-url-quotes": "always",
+    "property-no-vendor-prefix": true,
+    "selector-no-vendor-prefix": true,
+    "media-feature-name-no-vendor-prefix": true,
+    "at-rule-no-vendor-prefix": true,
+    "value-no-vendor-prefix": true,
+    "length-zero-no-unit": true
+  }
+}

data/lib/potassium/assets/Makefile.erb

@@ -1,7 +1,4 @@
-PROJECT ?= <%= get(:underscorized_app_name) %>
-DOCKER_COMPOSE_FILE ?= docker-compose.yml
-
-DOCKER_COMPOSE_ARGS ?= -p $(PROJECT) -f $(DOCKER_COMPOSE_FILE)
+PROJECT ?= <%= get(:dasherized_app_name) %>
 
 SHELL := /bin/bash
 
@@ -11,36 +8,28 @@ BOLD ?= $(shell tput bold)
 NORMAL ?= $(shell tput sgr0)
 
 help:
-	@echo Install dependencies:
-	@echo "  ${BOLD}make setup${NORMAL}"
-	@echo ""
-	@echo Runing the services like mysql:
-	@echo "  ${BOLD}make services-up${NORMAL}"
+	@echo "Generate a backup in the environment (staging|production) database:"
+	@echo "  ${BOLD}make backup-<environment>${NORMAL}"
 	@echo ""
-	@echo "Reset the environment (rm mysql db):"
-	@echo "  ${BOLD}make services-down${NORMAL}"
+	@echo "Copy latest database backup from the environment (staging|production) to local database:"
+	@echo "  ${BOLD}make restore-from-<environment>${NORMAL}"
 	@echo ""
 
-setup:
-	bin/setup
-
-services: services-up
-
-services-ps:
-	docker-compose $(DOCKER_COMPOSE_ARGS) ps
-
-services-up:
-	docker-compose $(DOCKER_COMPOSE_ARGS) up -d
-
-services-stop:
-	docker-compose $(DOCKER_COMPOSE_ARGS) stop
-
-services-down:
-	docker-compose $(DOCKER_COMPOSE_ARGS) down --volumes
-
-services-logs:
-	docker-compose $(DOCKER_COMPOSE_ARGS) logs -f
-
 services-port:
 	@set -o pipefail; \
-	docker-compose $(DOCKER_COMPOSE_ARGS) port ${SERVICE} ${PORT} 2> /dev/null | cut -d':' -f2 || echo ${PORT}
+	docker-compose port ${SERVICE} ${PORT} 2> /dev/null | cut -d':' -f2 || echo ${PORT}
+
+backup-staging: ROLE=staging
+backup-production: ROLE=production
+backup-%:
+	@echo Capturing $(ROLE)....
+	@heroku pg:backups:capture --remote $(ROLE)
+
+restore-from-staging: ROLE=staging
+restore-from-production: ROLE=production
+restore-from-%:
+	$(eval TEMP_FILE=$(shell mktemp))
+	@echo Restoring from $(ROLE)....
+	@heroku pg:backups:download --remote $(ROLE) --output $(TEMP_FILE)
+	@pg_restore --verbose --clean --no-acl --no-owner -h localhost \
+		-U postgres -p $(shell make services-port SERVICE=postgresql PORT=5432) -d $(PROJECT)_development $(TEMP_FILE)

data/lib/potassium/assets/README.yml

@@ -22,16 +22,27 @@ readme:
             $ heroku local
 
         [Heroku Local]: https://devcenter.heroku.com/articles/heroku-local
+    webpack:
+      title: "Development"
+      body: |
+        For hot-reloading and fast webpacker compilation you need to run webpack's dev server along with the rails server:
+
+            $ ./bin/webpack-dev-server
+
+        Running the dev server will also solve problems with the cache not refreshing between changes and provide better error messages if something fails to compile.
+
+        For even faster in-place component refreshing (with no page reloads), you can enable Hot Module Reloading in `config/webpacker.yml`
+
+            development:
+              dev_server:
+                hmr: true
     ci:
       title: "Continuous Integrations"
       body: |
         The project is setup to run tests
         in [CircleCI](https://circleci.com/gh/platanus/<%= get(:dasherized_app_name) %>/tree/master)
 
-        You can also run the test locally simulating the production environment using docker.
-        Just make sure you have docker installed and run:
-
-            bin/cibuild
+        You can also run the test locally simulating the production environment using [CircleCI's method](https://circleci.com/docs/2.0/local-cli/).
     deployment:
       title: "Deployment"
       body: |
@@ -61,10 +72,17 @@ readme:
     style_guide:
       title: "Style Guides"
       body: |
-        The style guides are enforced through a self hosted version of [Hound CI](http://monkeyci.platan.us). The style configuration can also be used locally
-        in development runing `rubocop` or just using the rubocop integration for your text editor of choice.
+        Style guides are enforced through a CircleCI [job](.circleci/config.yml) with [reviewdog](https://github.com/reviewdog/reviewdog) as a reporter, using per-project dependencies and style configurations.
+        Please note that this reviewdog implementation requires a GitHub user token to comment on pull requests. A token can be generated [here](https://github.com/settings/tokens), and it should have at least the `repo` option checked.
+        The included `config.yml` assumes your CircleCI organization has a context named `org-global` with the required token under the environment variable `REVIEWDOG_GITHUB_API_TOKEN`.
+
+        The project comes bundled with configuration files available in this repository.
+
+        Linting dependencies like `rubocop` or `rubocop-rspec` must be locked in your `Gemfile`. Similarly, packages like `eslint` or `eslint-plugin-vue` must be locked in your `package.json`.
 
-        You can add custom rules to this project just adding them to the `.ruby-style.yml` file.
+        You can add or modify rules by editing the [`.rubocop.yml`](.rubocop.yml), [`.eslintrc.json`](.eslintrc.json) or [`.stylelintrc.json`](.stylelintrc.json) files.
+
+        You can (and should) use linter integrations for your text editor of choice, using the project's configuration.
     mailing:
       title: "Sending Emails"
       body: |
@@ -82,18 +100,15 @@ readme:
         devise:
           title: "Authentication"
           body: "We are using the great [Devise](https://github.com/plataformatec/devise) library by [PlataformaTec](http://plataformatec.com.br/)"
-        paperclip:
-          title: "Uploads"
-          body: "For managing uploads, this project uses [Paperclip](https://github.com/thoughtbot/paperclip), a gem made by the awesome [Thoughbot](https://thoughtbot.com/) team."
-        storage:
-          title: "Active Storage"
+        active_storage:
+          title: "File Storage"
           body: "For managing uploads, this project uses [Active Storage](https://github.com/rails/rails/tree/master/activestorage)."
+        shrine:
+          title: "File Storage"
+          body: "For managing uploads, this project uses [Shrine](https://github.com/shrinerb/shrine)."
         pundit:
           title: "Authorization"
           body: "For defining which parts of the system each user has access to, we have chosen to include the [Pundit](https://github.com/elabs/pundit) gem, by [Elabs](http://elabs.se/)."
-        delayed_job:
-          title: "Queue System"
-          body: "For managing tasks in the background, this project uses [DelayedJob](https://github.com/collectiveidea/delayed_job)"
         sidekiq:
           title: "Queue System"
           body: "For managing tasks in the background, this project uses [Sidekiq](https://github.com/mperham/sidekiq)"
@@ -109,6 +124,35 @@ readme:
         power_types:
           title: "Rails pattern enforcing types"
           body: "This projects uses [Power-Types](https://github.com/platanus/power-types) to generate Services, Commands, Utils and Values."
+        power_api:
+          title: "API Support"
+          body: "This projects uses [Power API](https://github.com/platanus/power_api). It's a Rails engine that gathers a set of gems and configurations designed to build incredible REST APIs."
+        graphql:
+          title: "API Support"
+          body: "This projects uses [graphql-ruby](https://graphql-ruby.org/) to generate a GraphQL API."
+        active_admin:
+          title: "Administration"
+          body: |
+            This project uses [Active Admin](https://github.com/activeadmin/activeadmin) which is a Ruby on Rails framework for creating elegant backends for website administration.
+            <% if get(:vue_admin) %>
+            This project supports Vue inside ActiveAdmin
+            - The main package is located in `app/javascript/packs/admin_application.js`, here you will declare the components you want to include in your ActiveAdmin views as you would in a normal Vue App.
+            - Additionally, to be able to use Vue components as [Arbre](https://github.com/activeadmin/arbre) Nodes the component names are also declared in `config/initializers/active_admin.rb`
+            - The generator includes an example component called `admin_component`, you can use this component inside any ActiveAdmin view by just writing `admin_component` as you would with any `html` tag.
+              - For example:
+                ```
+                admin_component(class:"myCustomClass",id:"myCustomId") do
+                  admin_component(id:"otherCustomId")
+                end
+                ```
+              - (Keep in mind that the example works with ruby blocks because `AdminComponent` has a `<slot>` tag defined, therefore children can be added to the component)
+            - The integration supports passing props to the components and converts them to their corresponing javascript objects.
+              - For example, the following works
+              ```
+              admin_component(testList:[1,2,3,4],testObject:{"name":"Vue component"})
+              ```
+              - You can also use **any** vue bindings such as `v-for` , `:key` etc.
+            <% end %>
     seeds:
       title: "Seeds"
       body: |

data/lib/potassium/assets/active_admin/admin-component.vue

@@ -0,0 +1,35 @@
+<template>
+  <div>
+    I am a Vue Component {{ test }} {{ message }}
+    <slot />
+  </div>
+</template>
+
+<script>
+export default {
+  props: {
+    test: {
+      type: String,
+      default: '',
+    },
+    testNumber: {
+      type: Number,
+      default: 0,
+    },
+    testObject: {
+      type: Object,
+      default: null,
+    },
+    testList: {
+      type: Array,
+      default: null,
+    },
+  },
+
+  data() {
+    return {
+      message: 'Hello World',
+    };
+  },
+};
+</script>

data/lib/potassium/assets/active_admin/admin_application.js

@@ -0,0 +1,14 @@
+import Vue from 'vue/dist/vue.esm';
+import AdminComponent from '../components/admin-component';
+
+Vue.component('admin_component', AdminComponent);
+
+document.addEventListener('DOMContentLoaded', () => {
+  if (document.getElementById('wrapper') !== null) {
+    return new Vue({
+      el: '#wrapper',
+    });
+  }
+
+  return null;
+});

data/lib/potassium/assets/active_admin/init_activeadmin_vue.rb

@@ -0,0 +1,10 @@
+module AdminPageLayoutOverride
+  def build_page(*args)
+    within head do
+      text_node(javascript_packs_with_chunks_tag('admin_application'))
+    end
+    super
+  end
+end
+
+ActiveAdmin::Views::Pages::Base.send :prepend, AdminPageLayoutOverride

data/lib/potassium/assets/app/graphql/graphql_controller.rb

@@ -0,0 +1,55 @@
+class GraphqlController < ApplicationController
+  # If accessing from outside this domain, nullify the session
+  # This allows for outside API access while preventing CSRF attacks,
+  # but you'll have to authenticate your user separately
+  # protect_from_forgery with: :null_session
+
+  def execute
+    variables = prepare_variables(params[:variables])
+    query = params[:query]
+    operation_name = params[:operationName]
+    context = { current_user: get_current_user }
+    result = GqlSampleSchema.execute(query, variables: variables, context: context, operation_name: operation_name)
+    render json: result
+  rescue => e
+    raise e unless Rails.env.development?
+    handle_error_in_development e
+  end
+
+  private
+
+  # Handle variables in form data, JSON body, or a blank value
+  def prepare_variables(variables_param)
+    case variables_param
+    when String
+      if variables_param.present?
+        JSON.parse(variables_param) || {}
+      else
+        {}
+      end
+    when Hash
+      variables_param
+    when ActionController::Parameters
+      variables_param.to_unsafe_hash # GraphQL-Ruby will validate name and type of incoming variables.
+    when nil
+      {}
+    else
+      raise ArgumentError, "Unexpected parameter: #{variables_param}"
+    end
+  end
+
+  def handle_error_in_development(e)
+    logger.error e.message
+    logger.error e.backtrace.join("\n")
+
+    render json: { errors: [{ message: e.message, backtrace: e.backtrace }], data: {} }, status: 500
+  end
+
+  def get_current_user
+    if request.headers['Authorization']
+      _, token = request.headers['Authorization'].split
+      decoded_token = JWT.decode token, ENV['HMAC_SECRET'], true, { algorithm: 'HS256' }
+      User.find(decoded_token.first["id"])
+    end
+  end
+end

data/lib/potassium/assets/app/graphql/mutations/login_mutation.rb

@@ -0,0 +1,23 @@
+require 'jwt'
+
+class Mutations::LoginMutation < Mutations::BaseMutation
+  null true
+
+  argument :email, String, required: true
+  argument :password, String, required: true
+
+
+  field :token, String, null: true
+
+  def resolve(email:, password:)
+    user = User.find_by(email: email)
+    if user&.valid_password?(password)
+      payload = { id: user.id, email: user.email, exp: (Time.zone.now + 24.hours).to_i }
+      token = JWT.encode payload, ENV['HMAC_SECRET'], 'HS256'
+      return { token: token }
+    end
+    GraphQL::ExecutionError.new("User or Password invalid")
+  rescue ActiveRecord::RecordInvalid => e
+    GraphQL::ExecutionError.new("Invalid input: #{e.record.errors.full_messages.join(', ')}")
+  end
+end

data/lib/potassium/assets/app/graphql/queries/base_query.rb

@@ -0,0 +1,4 @@
+module Queries
+  class BaseQuery < GraphQL::Schema::Resolver
+  end
+end

data/lib/potassium/assets/app/graphql/types/base/base_argument.rb

@@ -0,0 +1,4 @@
+module Types::Base
+  class BaseArgument < GraphQL::Schema::Argument
+  end
+end

data/lib/potassium/assets/app/graphql/types/base/base_enum.rb

@@ -0,0 +1,4 @@
+module Types::Base
+  class BaseEnum < GraphQL::Schema::Enum
+  end
+end

data/lib/potassium/assets/app/graphql/types/base/base_field.rb

@@ -0,0 +1,5 @@
+module Types::Base
+  class BaseField < GraphQL::Schema::Field
+    argument_class Types::Base::BaseArgument
+  end
+end

data/lib/potassium/assets/app/graphql/types/base/base_input_object.rb

@@ -0,0 +1,5 @@
+module Types::Base
+  class BaseInputObject < GraphQL::Schema::InputObject
+    argument_class Types::Base::BaseArgument
+  end
+end

data/lib/potassium/assets/app/graphql/types/base/base_interface.rb

@@ -0,0 +1,7 @@
+module Types::Base
+  module BaseInterface
+    include GraphQL::Schema::Interface
+
+    field_class Types::Base::BaseField
+  end
+end

data/lib/potassium/assets/app/graphql/types/base/base_object.rb

@@ -0,0 +1,5 @@
+module Types::Base
+  class BaseObject < GraphQL::Schema::Object
+    field_class Types::Base::BaseField
+  end
+end

data/lib/potassium/assets/app/graphql/types/base/base_scalar.rb

@@ -0,0 +1,4 @@
+module Types::Base
+  class BaseScalar < GraphQL::Schema::Scalar
+  end
+end

data/lib/potassium/assets/app/graphql/types/base/base_union.rb

@@ -0,0 +1,4 @@
+module Types::Base
+  class BaseUnion < GraphQL::Schema::Union
+  end
+end

data/lib/potassium/assets/app/graphql/types/mutation_type.rb

@@ -0,0 +1,10 @@
+module Types
+  class MutationType < Types::Base::BaseObject
+    # TODO: remove me
+    field :test_field, String, null: false,
+      description: "An example field added by the generator"
+    def test_field
+      "Hello World"
+    end
+  end
+end

data/lib/potassium/assets/app/graphql/types/query_type.rb

@@ -0,0 +1,13 @@
+module Types
+  class QueryType < Types::Base::BaseObject
+    # Add root-level fields here.
+    # They will be entry points for queries on your schema.
+
+    # TODO: remove me
+    field :test_field, String, null: false,
+      description: "An example field added by the generator"
+    def test_field
+      "Hello World!"
+    end
+  end
+end