LuckyDiff - v1.0.0-rc1 to v1.0.0

Files changed (15) show

.crystal-version CHANGED Viewed

	@@ -1 +1 @@
1	- 1.5.1
1	+ 1.7.3

.github/workflows/ci.yml CHANGED Viewed

@@ -1,54 +1,54 @@
 name: my_app CI
 on:
   push:
     branches: "*"
   pull_request:
     branches: "*"
 jobs:
   check-format:
     strategy:
       fail-fast: false
       matrix:
         crystal_version:
-          - 1.5.1
+          - 1.7.3
         experimental:
           - false
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.experimental }}
     steps:
       - uses: actions/checkout@v2
       - name: Install Crystal
         uses: crystal-lang/install-crystal@v1
         with:
           crystal: ${{ matrix.crystal_version }}
       - name: Format
         run: crystal tool format --check
   specs:
     strategy:
       fail-fast: false
       matrix:
         crystal_version:
-          - 1.5.1
+          - 1.7.3
         experimental:
           - false
     runs-on: ubuntu-latest
     env:
       LUCKY_ENV: test
       DB_HOST: localhost
     continue-on-error: ${{ matrix.experimental }}
     services:
       postgres:
         image: postgres:12-alpine
         env:
           POSTGRES_PASSWORD: postgres
         ports:
           - 5432:5432
        # Set health checks to wait until postgres has started
         options: >-
           --health-cmd pg_isready
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5

README.md CHANGED Viewed

@@ -1,14 +1,23 @@
 # my_app
 This is a project written using [Lucky](https://luckyframework.org). Enjoy!
 ### Setting up the project
 1. [Install required dependencies](https://luckyframework.org/guides/getting-started/installing#install-required-dependencies)
 1. Update database settings in `config/database.cr`
 1. Run `script/setup`
 1. Run `lucky dev` to start the app
+### Using Docker for development
+1. [Install Docker](https://docs.docker.com/engine/install/)
+1. Run `docker compose up`
+The Docker container will boot all of the necessary components needed to run your Lucky application.
+To configure the container, update the `docker-compose.yml` file, and the `docker/development.dockerfile` file.
 ### Learning Lucky
 Lucky uses the [Crystal](https://crystal-lang.org) programming language. You can learn about Lucky from the [Lucky Guides](https://luckyframework.org/guides/getting-started/why-lucky).

docker/dev_entrypoint.sh CHANGED Viewed

@@ -1,53 +1,46 @@
 #!/bin/bash
 set -euo pipefail
-# This is the entrypoint script used for development docker workflows. By
+# This is the entrypoint script used for development docker workflows.
-# default it will:
+# By default it will:
-#  - Install shards.
+#  - Install dependencies.
 #  - Run migrations.
 #  - Start the dev server.
 # It also accepts any commands to be run instead.
 warnfail () {
   echo "$@" >&2
   exit 1
 }
 case ${1:-} in
   "") # If no arguments are provided, start lucky dev server.
     ;;
   *) # If any arguments are provided, execute them instead.
     exec "$@"
 esac
 if ! [ -d bin ] ; then
   echo "Creating bin directory"
   mkdir bin
 fi
 echo "Installing npm packages..."
 yarn install
 if ! shards check ; then
   echo "Installing shards..."
   shards install
 fi
 echo "Waiting for postgres to be available..."
 ./docker/wait-for-it.sh -q postgres:5432
 if ! psql -d "$DATABASE_URL" -c '\d migrations' > /dev/null ; then
   echo "Finishing database setup..."
   lucky db.migrate
 fi
-if [ -S .overmind.sock ] ; then
-  echo "Removing old overmind socket file..."
-  rm .overmind.sock
-fi
 echo "Starting lucky dev server..."
 exec lucky dev

docker/development.dockerfile CHANGED Viewed

@@ -1,40 +1,34 @@
-FROM crystallang/crystal:1.4.1
+FROM crystallang/crystal:1.7.3
 # Install utilities required to make this Dockerfile run
 RUN apt-get update && \
-    apt-get install -y wget gunzip
+    apt-get install -y wget
 # Add the nodesource ppa to apt. Update this to change the nodejs version.
 RUN wget https://deb.nodesource.com/setup_16.x -O- | bash
 # Apt installs:
 # - nodejs (from above ppa) is required for front-end apps.
 # - Postgres cli tools are required for lucky-cli.
 # - tmux is required for the Overmind process manager.
 RUN apt-get update && \
     apt-get install -y nodejs postgresql-client tmux && \
     rm -rf /var/lib/apt/lists/*
 # NPM global installs:
 #  - Yarn is the default package manager for the node component of a lucky
 #    browser app.
 #  - Mix is the default asset compiler.
 RUN npm install -g yarn mix
-# Installs overmind, not needed if nox is the process manager.
-RUN wget https://github.com/DarthSim/overmind/releases/download/v2.2.2/overmind-v2.2.2-linux-amd64.gz && \
-    gunzip overmind-v2.2.2-linux-amd64.gz && \
-    mv overmind-v2.2.2-linux-amd64 /usr/bin/overmind && \
-    chmod +x /usr/bin/overmind
-# Install lucky cli, TODO: fetch current lucky version from source code.
+# Install lucky cli
 WORKDIR /lucky/cli
 RUN git clone https://github.com/luckyframework/lucky_cli . && \
-    git checkout v0.30.0 && \
+    git checkout v1.0.0 && \
     shards build --without-development && \
     cp bin/lucky /usr/bin
 WORKDIR /app
 ENV DATABASE_URL=postgres://postgres:postgres@host.docker.internal:5432/postgres
+EXPOSE 3000
-EXPOSE 5001
+EXPOSE 3001

docker-compose.yml CHANGED Viewed

@@ -1,42 +1,44 @@
 version: '3.8'
 services:
   lucky:
     build:
       context: .
       dockerfile: docker/development.dockerfile
     environment:
       DATABASE_URL: postgres://lucky:password@postgres:5432/lucky
+      DEV_HOST: "0.0.0.0"
     volumes:
       - type: bind
         source: .
         target: /app
       - type: volume
         source: node_modules
         target: /app/node_modules
       - type: volume
         source: shards_lib
         target: /app/lib
     depends_on:
       - postgres
     ports:
-      - 5001:5001
+      - 3000:3000 # This is the Lucky Server port
+      - 3001:3001 # This is the Lucky watcher reload port
     entrypoint: ["docker/dev_entrypoint.sh"]
   postgres:
     image: postgres:14-alpine
     environment:
       POSTGRES_USER: lucky
       POSTGRES_PASSWORD: password
     volumes:
       - type: volume
         source: postgres_data
         target: /var/lib/postgresql
     ports:
       # The postgres database container is exposed on the host at port 6543 to
       # allow connecting directly to it with postgres clients. The port differs
       # from the postgres default to avoid conflict with existing postgres
       # servers. Connect to a running postgres container with:
       # postgres://lucky:password@localhost:6543/lucky
       - 6543:5432

shard.yml CHANGED Viewed

@@ -1,41 +1,41 @@
 name: my_app
 version: 0.1.0
 authors:
   - your-name-here <your-email-here>
 targets:
   app:
     main: src/my_app.cr
-crystal: 1.5.1
+crystal: 1.7.3
 dependencies:
   lucky:
     github: luckyframework/lucky
-    version: ~> 1.0.0-rc1
+    version: ~> 1.0.0
   avram:
     github: luckyframework/avram
-    version: ~> 1.0.0-rc1
+    version: ~> 1.0.0
   carbon:
     github: luckyframework/carbon
     version: ~> 0.3.0
   carbon_sendgrid_adapter:
     github: luckyframework/carbon_sendgrid_adapter
     version: ~> 0.3.0
   lucky_env:
     github: luckyframework/lucky_env
     version: ~> 0.1.4
   lucky_task:
     github: luckyframework/lucky_task
     version: ~> 0.1.1
   authentic:
     github: luckyframework/authentic
-    version: ~> 0.9.0
+    version: ~> 1.0.0
   jwt:
     github: crystal-community/jwt
     version: ~> 1.6.0
 development_dependencies:
   lucky_flow:
     github: luckyframework/lucky_flow
     version: ~> 0.9.0

spec/support/flows/reset_password_flow.cr CHANGED Viewed

@@ -17,26 +17,26 @@
     end
   end
   def should_have_sent_reset_email
     with_fake_token do
       user = UserQuery.new.email(email).first
       PasswordResetRequestEmail.new(user).should be_delivered
     end
   end
   def reset_password(password)
     user = UserQuery.new.email(email).first
     token = Authentic.generate_password_reset_token(user)
     visit PasswordResets::New.with(user.id, token)
     fill_form ResetPassword,
       password: password,
       password_confirmation: password
     click "@update-password-button"
   end
-  private def with_fake_token
+  private def with_fake_token(&)
     PasswordResetRequestEmail.temp_config(stubbed_token: "fake") do
       yield
     end
   end
 end

src/actions/browser_action.cr CHANGED Viewed

@@ -21,24 +21,25 @@
   # When testing you can skip normal sign in by using `visit` with the `as` param
   #
   # flow.visit Me::Show, as: UserFactory.create
   include Auth::TestBackdoor
   # By default all actions that inherit 'BrowserAction' require sign in.
   #
   # You can remove the 'include Auth::RequireSignIn' below to allow anyone to
   # access actions that inherit from 'BrowserAction' or you can
   # 'include Auth::AllowGuests' in individual actions to skip sign in.
   include Auth::RequireSignIn
   # `expose` means that `current_user` will be passed to pages automatically.
   #
   # In default Lucky apps, the `MainLayout` declares it `needs current_user : User`
   # so that any page that inherits from MainLayout can use the `current_user`
   expose current_user
   # This method tells Authentic how to find the current user
+  # The 'memoize' macro makes sure only one query is issued to find the user
-  private def find_current_user(id) : User?
+  private memoize def find_current_user(id : String | User::PrimaryKeyType) : User?
     UserQuery.new.id(id).first?
   end
 end

src/actions/mixins/api/auth/helpers.cr CHANGED Viewed

@@ -1,22 +1,23 @@
 module Api::Auth::Helpers
+  # The 'memoize' macro makes sure only one query is issued to find the user
-  def current_user? : User?
+  memoize def current_user? : User?
     auth_token.try do |value|
       user_from_auth_token(value)
     end
   end
   private def auth_token : String?
     bearer_token || token_param
   end
   private def bearer_token : String?
     context.request.headers["Authorization"]?
       .try(&.gsub("Bearer", ""))
       .try(&.strip)
   end
   private def token_param : String?
     params.get?(:auth_token)
   end
   private def user_from_auth_token(token : String) : User?

src/actions/mixins/api/auth/require_auth_token.cr CHANGED Viewed

@@ -12,23 +12,23 @@
   end
   private def auth_error_json
     ErrorSerializer.new(
       message: "Not authenticated.",
       details: auth_error_details
     )
   end
   private def auth_error_details : String
     if auth_token
       "The provided authentication token was incorrect."
     else
       "An authentication token is required. Please include a token in an 'auth_token' param or 'Authorization' header."
     end
   end
   # Tells the compiler that the current_user is not nil since we have checked
   # that the user is signed in
   private def current_user : User
-    current_user?.not_nil!
+    current_user?.as(User)
   end
 end

src/actions/mixins/auth/require_sign_in.cr CHANGED Viewed

@@ -1,21 +1,21 @@
 module Auth::RequireSignIn
   macro included
     before require_sign_in
   end
   private def require_sign_in
     if current_user?
       continue
     else
       Authentic.remember_requested_path(self)
       flash.info = "Please sign in first"
       redirect to: SignIns::New
     end
   end
   # Tells the compiler that the current_user is not nil since we have checked
   # that the user is signed in
   private def current_user : User
-    current_user?.not_nil!
+    current_user?.as(User)
   end
 end

src/components/shared/field.cr CHANGED Viewed

@@ -18,40 +18,40 @@
 #
 # You can customize this component so that fields render like you expect.
 # For example, you might wrap it in a div with a "field-wrapper" class.
 #
 #    div class: "field-wrapper"
 #      label_for field
 #      yield field
 #      mount Shared::FieldErrors, field
 #    end
 #
 # You may also want to have more components if your fields look
 # different in different parts of your app, e.g. `CompactField` or
 # `InlineTextField`
 class Shared::Field(T) < BaseComponent
   # Raises a helpful error if component receives an unpermitted attribute
   include Lucky::CatchUnpermittedAttribute
   needs attribute : Avram::PermittedAttribute(T)
   needs label_text : String?
-  def render
+  def render(&)
     label_for attribute, label_text
     # You can add more default options here. For example:
     #
     #    tag_defaults field: attribute, class: "input"
     #
     # Will add the class "input" to the generated HTML.
     tag_defaults field: attribute do |tag_builder|
       yield tag_builder
     end
     mount Shared::FieldErrors, attribute
   end
   # Use a text_input by default
   def render
     render &.text_input
   end
 end

src/components/shared/layout_head.cr CHANGED Viewed

@@ -1,19 +1,18 @@
 class Shared::LayoutHead < BaseComponent
   needs page_title : String
   def render
     head do
       utf8_charset
       title "My App - #{@page_title}"
       css_link asset("css/app.css")
       js_link asset("js/app.js"), defer: "true"
       csrf_meta_tags
       responsive_meta_tag
-      # Used only in development when running `lucky watch`.
+      # Development helper used with the `lucky watch` command.
-      # Will reload browser whenever files change.
+      # Reloads the browser when files are updated.
-      # See [docs]()
-      live_reload_connect_tag
+      live_reload_connect_tag if LuckyEnv.development?
     end
   end
 end

src/models/user_token.cr CHANGED Viewed

@@ -5,26 +5,26 @@
   def self.generate(user : User) : String
     payload = {"user_id" => user.id}
     settings.stubbed_token || create_token(payload)
   end
   def self.create_token(payload)
     JWT.encode(payload, Lucky::Server.settings.secret_key_base, ALGORITHM)
   end
   def self.decode_user_id(token : String) : Int64?
     payload, _header = JWT.decode(token, Lucky::Server.settings.secret_key_base, ALGORITHM)
     payload["user_id"].to_s.to_i64
   rescue e : JWT::Error
     Lucky::Log.dexter.error { {jwt_decode_error: e.message} }
     nil
   end
   # Used in tests to return a fake token to test against.
-  def self.stub_token(token : String)
+  def self.stub_token(token : String, &)
     temp_config(stubbed_token: token) do
       yield
     end
   end
 end