punk 0.3.2 → 0.4.1

data/README.md

@@ -1,6 +1,8 @@
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![test](https://github.com/kranzky/punk/workflows/test/badge.svg)](https://github.com/kranzky/punk/actions?query=workflow%3Atest)
 [![Coverage Status](https://coveralls.io/repos/github/kranzky/punk/badge.svg?branch=main)](https://coveralls.io/github/kranzky/punk?branch=main)
 [![Gem Version](https://badge.fury.io/rb/punk.svg)](https://badge.fury.io/rb/punk)
+[![Western Australia](https://corona.kranzky.com/oc/anz/au/wa/badge.svg)](https://corona.kranzky.com?region=oc&subregion=anz&country=au&state=wa)
 
 # Punk!
 
@@ -8,9 +10,11 @@ Punk! is an omakase web framework for rapid prototyping.
 
 ## Release Process
 
-1. `rake version:bump:whatever`
-2. `rake git:release BRANCH=main`
-3. Create new release on GitHub to trigger ship workflow
+1. `rake standard:fix`
+2. `rake version:bump:whatever`
+3. `rake gemspec:release BRANCH=main`
+4. `rake git:release BRANCH=main`
+5. Create new release on GitHub to trigger ship workflow
 
 ## Copyright
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,8 +9,8 @@ rescue Bundler::BundlerError => e
   warn "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
-require 'juwelier'
+require "rake"
+require "juwelier"
 Juwelier::Tasks.new do |gem|
   gem.name = "punk"
   gem.homepage = "https://github.com/kranzky/punk"
@@ -19,11 +19,13 @@ Juwelier::Tasks.new do |gem|
   gem.description = ""
   gem.email = "lloyd@kranzky.com"
   gem.authors = ["Lloyd Kranzky"]
-  gem.required_ruby_version = ">= 2.1"
+  gem.required_ruby_version = ">= 2.6"
 end
 Juwelier::RubygemsDotOrgTasks.new
 
-require 'yard'
+require "yard"
 YARD::Rake::YardocTask.new
 
-task default: :clean
+require "standard/rake"
+
+task default: [:clean, "standard:fix"]

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.1

data/app/migrations/001_lets_punk.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require_relative '../../lib/punk/migrations/001_punk'
+require_relative "../../lib/punk/migrations/001_punk"

data/app/routes/hello.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 # route: GET /hello
-PUNK.route('hello') { perform "world" }
+PUNK.route("hello") { perform "world" }

data/bin/punk

@@ -2,15 +2,15 @@
 
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'commander/import'
-require_relative '../lib/punk'
+require "bundler/setup"
+require "commander/import"
+require_relative "../lib/punk"
 
-PUNK.init(task: 'script', config: { app: { name: 'Punk!' } }).config
+PUNK.init(task: "script", config: {app: {name: "Punk!"}}).config
 
 program :name, PUNK.get.app.name
 program :version, PUNK.version
-program :description, 'An omakase web framework for rapid prototyping.'
+program :description, "An omakase web framework for rapid prototyping."
 
 PUNK.commands(:commander)
 

data/env/defaults.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+export RACK_ENV=development

data/lib/punk.rb

@@ -1,25 +1,24 @@
 # frozen_string_literal: true
 
-require 'bootsnap'
+require "bootsnap"
 
-env = ENV.fetch('PUNK_ENV') { ENV.store('PUNK_ENV', 'development') }
+env = ENV.fetch("PUNK_ENV") { ENV.store("PUNK_ENV", "development") }
 
 if defined?(Bootsnap)
+  # TODO: update gem and check setup options
   Bootsnap.setup(
-    cache_dir: 'tmp/cache',
-    development_mode: env == 'development',
+    cache_dir: "tmp/cache",
+    development_mode: env == "development",
     load_path_cache: true,
-    autoload_paths_cache: true,
-    disable_trace: false,
     compile_cache_iseq: true,
     compile_cache_yaml: true
   )
 end
 
 module PUNK
-  def self.init(task: 'server', path: './app', config: {})
-    require_relative 'punk/core/interface'
-    raise InternalServerError, 'Cannot call PUNK.init multiple times!' if state != :included
+  def self.init(task: "server", path: "./app", config: {})
+    require_relative "punk/core/interface"
+    raise InternalServerError, "Cannot call PUNK.init multiple times!" if state != :included
     store.args = OpenStruct.new(
       task: task,
       path: path,

data/lib/punk/actions/sessions/create.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'uri'
-require 'phony'
+require "uri"
+require "phony"
 
 module PUNK
   class CreateSessionAction < Action
@@ -56,7 +56,7 @@ module PUNK
         claim.downcase.strip
       when :phone
         phone = claim.strip
-        phone = "+1#{phone}" if phone !~ /^[+]/
+        phone = "+1#{phone}" unless /^[+]/.match?(phone)
         "+#{Phony.normalize(phone)}"
       end
     end

data/lib/punk/actions/sessions/verify.rb

@@ -17,8 +17,8 @@ module PUNK
 
     def process
       verify = ProveClaimService.run(session: session, secret: secret)
-      raise BadRequest, 'Secret is incorrect' unless verify.result == true
-      present Info, message: 'We have succesfully verified your identity.  Welcome to GroupFire!'
+      raise BadRequest, "Secret is incorrect" unless verify.result == true
+      present Info, message: "We have succesfully verified your identity.  Welcome to GroupFire!"
     end
   end
 end

data/lib/punk/commands/auth.rb

@@ -15,7 +15,7 @@ PUNK::Command.create "login" do
         "PATH_INFO" => "/sessions",
         "CONTENT_TYPE" => "text/json",
         "SCRIPT_NAME" => "",
-        "rack.input" => StringIO.new({ claim: claim }.to_json)
+        "rack.input" => StringIO.new({claim: claim}.to_json)
       )
     response = ActiveSupport::JSON.decode(response[-1].first).deep_symbolize_keys
     return if response[:errors].present?
@@ -23,17 +23,17 @@ PUNK::Command.create "login" do
     authenticated = false
     while authenticated == false
       SemanticLogger.flush
-      secret = ask("Secret: ") { |q| q.echo = '*' }
+      secret = ask("Secret: ") { |q| q.echo = "*" }
       response =
         PUNK.app.call(
           "REQUEST_METHOD" => "PATCH",
           "PATH_INFO" => "/sessions/#{slug}",
           "CONTENT_TYPE" => "text/json",
           "SCRIPT_NAME" => "",
-          "rack.input" => StringIO.new({ secret: secret }.to_json)
+          "rack.input" => StringIO.new({secret: secret}.to_json)
         )
       response = ActiveSupport::JSON.decode(response[-1].first).deep_symbolize_keys
-      break if response[:errors].present? && response[:errors].first != 'Secret is incorrect'
+      break if response[:errors].present? && response[:errors].first != "Secret is incorrect"
       authenticated = response[:message].present?
     end
     response[:message]

data/lib/punk/commands/generate.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 PUNK::Command.create "generate" do
-  shortcut 'g'
+  shortcut "g"
   description "Generate routes, actions, models, views, services or workers"
 
   def process
-    case args.join(' ')
-    when 'route', 'action', 'model', 'view', 'service', 'worker', 'scaffold'
+    case args.join(" ")
+    when "route", "action", "model", "view", "service", "worker", "scaffold"
       "TBD"
-    when '', 'help'
+    when "", "help"
       "? specify one of: routes, actions, models, views, services, scaffold"
     else
-      "? unkown arguments: #{args.join(',')}"
+      "? unkown arguments: #{args.join(",")}"
     end
   end
 end

data/lib/punk/commands/http.rb

@@ -4,7 +4,7 @@ PUNK::Command.create "GET" do
   description "Perform a HTTP GET request"
 
   def process
-    path, query = args[0].split('?')
+    path, query = args[0].split("?")
     PUNK.app.call(
       "REQUEST_METHOD" => "GET",
       "PATH_INFO" => path,
@@ -24,7 +24,7 @@ PUNK::Command.create "PATCH" do
       "PATH_INFO" => args[0],
       "CONTENT_TYPE" => "text/json",
       "SCRIPT_NAME" => "",
-      "rack.input" => StringIO.new(args[1..-1].join)
+      "rack.input" => StringIO.new(args[1..].join)
     )
   end
 end
@@ -38,7 +38,7 @@ PUNK::Command.create "POST" do
       "PATH_INFO" => args[0],
       "CONTENT_TYPE" => "text/json",
       "SCRIPT_NAME" => "",
-      "rack.input" => StringIO.new(args[1..-1].join)
+      "rack.input" => StringIO.new(args[1..].join)
     )
   end
 end
@@ -52,7 +52,7 @@ PUNK::Command.create "PUT" do
       "PATH_INFO" => args[0],
       "CONTENT_TYPE" => "text/json",
       "SCRIPT_NAME" => "",
-      "rack.input" => StringIO.new(args[1..-1].join)
+      "rack.input" => StringIO.new(args[1..].join)
     )
   end
 end

data/lib/punk/commands/list.rb

@@ -1,30 +1,30 @@
 # frozen_string_literal: true
 
 PUNK::Command.create "list" do
-  shortcut 'l'
+  shortcut "l"
   description "List routes, actions, models, views, services or workers"
 
   option shortcut: :a, name: :all, description: "Include Punk!", type: nil
 
   def process
-    case args.join(' ')
-    when 'routes'
+    case args.join(" ")
+    when "routes"
       PUNK.app
       PUNK::App.route_list # TODO: exclude PUNK routes by default
-    when 'actions'
+    when "actions"
       ObjectSpace.each_object(PUNK::Action.singleton_class).map(&:name).reject { |name| _hide?(name) }
-    when 'models'
+    when "models"
       ObjectSpace.each_object(PUNK::Model.singleton_class).map(&:name).reject { |name| _hide?(name) }
-    when 'views'
+    when "views"
       ObjectSpace.each_object(PUNK::View.singleton_class).map(&:name).reject { |name| _hide?(name) }
-    when 'services'
+    when "services"
       ObjectSpace.each_object(PUNK::Service.singleton_class).select { |klass| klass.superclass == PUNK::Service }.map(&:name).reject { |name| _hide?(name) }
-    when 'workers'
+    when "workers"
       ObjectSpace.each_object(PUNK::Worker.singleton_class).select { |klass| klass.superclass == PUNK::Worker }.map(&:name).reject { |name| _hide?(name) }
-    when '', 'help'
+    when "", "help"
       "? specify one of: routes, actions, models, views, services, workers"
     else
-      "? unkown arguments: #{args.join(',')}"
+      "? unkown arguments: #{args.join(",")}"
     end
   end
 

data/lib/punk/core/app.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'roda'
-require 'sidekiq/web'
-require 'sidekiq/cron/web'
-require 'rack/protection'
+require "roda"
+require "sidekiq/web"
+require "sidekiq/cron/web"
+require "rack/protection"
 
-require_relative '../plugins/all'
+require_relative "../plugins/all"
 
 # don't use rack session for sidekiq (we do our own auth when routing)
 Sidekiq::Web.set(:sessions, false)
 # TODO: need custom roda route csrf in sidekiq web forms
-Sidekiq::Web.use(::Rack::Protection, use: :none, logging: true, logger: SemanticLogger['PUNK::RPT'])
+Sidekiq::Web.use(::Rack::Protection, use: :none, logging: true, logger: SemanticLogger["PUNK::RPT"])
 
 module PUNK
   def self.route(name, &block)
@@ -23,15 +23,15 @@ module PUNK
 
   ROUTES = Tempfile.new("routes.json").path
   PUNK.profile_info("generate", path: ROUTES) do
-    system "roda-parse_routes -f #{ROUTES} #{File.expand_path(File.join(PUNK.get.app.path, 'routes', '*'))} #{File.expand_path(File.join(__dir__, '..', 'routes', '*'))}"
+    system "roda-parse_routes -f #{ROUTES} #{File.expand_path(File.join(PUNK.get.app.path, "routes", "*"))} #{File.expand_path(File.join(__dir__, "..", "routes", "*"))}"
   end
 
   class App < Roda
     include Loggable
 
     REMOTE = PUNK.env.staging? || PUNK.env.production?
-    PUBLIC = File.join(PUNK.get.app.path, '..', 'www')
-    index_path = File.join(PUBLIC, 'index.html')
+    PUBLIC = File.join(PUNK.get.app.path, "..", "www")
+    index_path = File.join(PUBLIC, "index.html")
     INDEX =
       if File.exist?(index_path)
         File.read(index_path)
@@ -50,7 +50,7 @@ module PUNK
         INDEX_HTML
       end
 
-    plugin :sessions, secret: [PUNK.get.cookie.secret].pack('H*'),
+    plugin :sessions, secret: [PUNK.get.cookie.secret].pack("H*"),
                       key: PUNK.get.cookie.key,
                       max_seconds: 1.year.to_i,
                       max_idle_sessions: 1.month.to_i,
@@ -70,12 +70,12 @@ module PUNK
     plugin :path_rewriter
     plugin :slash_path_empty
     plugin :multi_route
-    plugin :type_routing, types: { csv: 'text/csv' }, default_type: :json
+    plugin :type_routing, types: {csv: "text/csv"}, default_type: :json
     plugin :route_list, file: ROUTES
     plugin :disallow_file_uploads
     plugin :public, root: PUBLIC
 
-    plugin :default_headers, 'Content-Type' => 'text/html', 'Content-Security-Policy' => "default-src 'self';img-src *", 'Strict-Transport-Security' => 'max-age=16070400;', 'X-Frame-Options' => 'deny', 'X-Content-Type-Options' => 'nosniff', 'X-XSS-Protection' => '1; mode=block'
+    plugin :default_headers, "Content-Type" => "text/html", "Content-Security-Policy" => "default-src 'self';img-src *", "Strict-Transport-Security" => "max-age=16070400;", "X-Frame-Options" => "deny", "X-Content-Type-Options" => "nosniff", "X-XSS-Protection" => "1; mode=block"
 
     plugin :error_handler
     plugin :not_found
@@ -83,24 +83,24 @@ module PUNK
 
     request_delegate :root, :on, :is, :get, :post, :redirect, :patch, :delete
 
-    rewrite_path(/\A\/?\z/, '/index.html')
-    rewrite_path(/\A\/api\/?\z/, '/api/index.html')
+    rewrite_path(/\A\/?\z/, "/index.html")
+    rewrite_path(/\A\/api\/?\z/, "/api/index.html")
 
     def require_session!
       begin
-        @_current_session = Session[request.session['session_id']]
+        @_current_session = Session[request.session["session_id"]]
         if @_current_session&.active?
           @_current_session.touch
         else
           clear_session
           @_current_session = nil
         end
-      rescue StandardError => e
+      rescue => e
         exception(e)
         raise Unauthorized, e.message
       end
-      raise Unauthorized, 'Session does not exist' if @_current_session.nil?
-      PUNK.logger.info "require_session!", { current_session: current_session.inspect, current_identity: current_identity.inspect, current_user: current_user.inspect }.inspect
+      raise Unauthorized, "Session does not exist" if @_current_session.nil?
+      PUNK.logger.info "require_session!", {current_session: current_session.inspect, current_identity: current_identity.inspect, current_user: current_user.inspect}.inspect
     end
 
     def require_anonymous!
@@ -109,9 +109,9 @@ module PUNK
     end
 
     def require_tenant!
-      raise Unauthorized, 'Session does not exist' if @_current_session.nil?
+      raise Unauthorized, "Session does not exist" if @_current_session.nil?
       @_current_tenant = current_user.tenants_dataset[id: params[:tenant_id]]
-      PUNK.logger.info "require_tenant!", { current_tenant: @_current_tenant.inspect }.inspect
+      PUNK.logger.info "require_tenant!", {current_tenant: @_current_tenant.inspect}.inspect
     end
 
     def args
@@ -145,17 +145,17 @@ module PUNK
     end
 
     PUNK_CONTENT_TYPE_LOOKUP = {
-      csv: 'text/csv',
-      html: 'text/html',
-      json: 'application/json',
-      xml: 'application/xml'
+      csv: "text/csv",
+      html: "text/html",
+      json: "application/json",
+      xml: "application/xml"
     }.freeze
     def render(view)
       raise InternalServerError, "Not a view: #{view}" unless view.is_a?(View)
       format = request.requested_type
       view.profile_info("render", format: format) do
         response.status = view.status if view.is_a?(Fail)
-        response['Content-Type'] = PUNK_CONTENT_TYPE_LOOKUP[format]
+        response["Content-Type"] = PUNK_CONTENT_TYPE_LOOKUP[format]
         view.render(format)
       end
     end
@@ -164,7 +164,7 @@ module PUNK
       exception(e, current_user: current_user)
       case e
       when BadRequest
-        present Fail, message: 'Bad Request', error_messages: [e.message], status: 400
+        present Fail, message: "Bad Request", error_messages: [e.message], status: 400
       when Unauthorized
         present Fail, message: "Unauthorized", error_messages: [e.message], status: 401
       when Forbidden
@@ -190,10 +190,10 @@ module PUNK
       @_started = Time.now.utc
       name = "#{request.request_method} #{request.path}"
       logger.info "Started #{name} for #{request.ip}", params.deep_symbolize_keys.sanitize.inspect
-      logger.trace request.env['HTTP_USER_AGENT']
+      logger.trace request.env["HTTP_USER_AGENT"]
       logger.info "Started #{name} for #{request.ip || Session.default_values[:remote_addr].to_s}", params.deep_symbolize_keys.sanitize.inspect
-      logger.trace request.env['HTTP_USER_AGENT'] || Session.default_values[:user_agent]
-      logger.trace request.env['HTTP_COOKIE']
+      logger.trace request.env["HTTP_USER_AGENT"] || Session.default_values[:user_agent]
+      logger.trace request.env["HTTP_COOKIE"]
       logger.push_tags(name)
       _set_cookie(request.env)
     end
@@ -203,14 +203,14 @@ module PUNK
       name = logger.pop_tags(1).join
       duration = 1000.0 * (Time.now.utc - @_started)
       logger.pop_tags
-      logger.trace((headers.present? ? headers['Set-Cookie'] : nil) || "(no cookie set)")
+      logger.trace((headers.present? ? headers["Set-Cookie"] : nil) || "(no cookie set)")
       logger.info message: "Completed #{name} status #{status}", duration: duration
       _store_cookie(headers)
     end
 
     route do |r|
       r.public
-      r.on 'jobs' do
+      r.on "jobs" do
         require_session!
         r.run Sidekiq::Web
       end
@@ -222,26 +222,26 @@ module PUNK
     def _set_cookie(headers)
       return if REMOTE
       return if headers.blank?
-      return if headers['HTTP_USER_AGENT'].present?
-      return if headers['HTTP_COOKIE'].present?
-      cookie_file = 'tmp/.cookie-jar'
-      cookie_file += '-test' if PUNK.env.test?
+      return if headers["HTTP_USER_AGENT"].present?
+      return if headers["HTTP_COOKIE"].present?
+      cookie_file = "tmp/.cookie-jar"
+      cookie_file += "-test" if PUNK.env.test?
       cookie = File.read(cookie_file) if File.exist?(cookie_file)
       return if cookie.blank?
-      headers['HTTP_COOKIE'] = cookie
+      headers["HTTP_COOKIE"] = cookie
     end
 
     def _store_cookie(headers)
       return if REMOTE
       return if headers.blank?
-      cookie = headers['Set-Cookie']
+      cookie = headers["Set-Cookie"]
       return if cookie.blank?
-      cookie_file = 'tmp/.cookie-jar'
-      cookie_file += '-test' if PUNK.env.test?
-      if cookie =~ /max-age=0/
+      cookie_file = "tmp/.cookie-jar"
+      cookie_file += "-test" if PUNK.env.test?
+      if /max-age=0/.match?(cookie)
         File.delete(cookie_file)
       else
-        File.open(cookie_file, 'w') { |file| file << cookie }
+        File.open(cookie_file, "w") { |file| file << cookie }
       end
     end
   end