decko 0.11.5 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c726ee70f0d8daba2891b23aab64090c43d088cc3300290a52eddee922dc7d0
-  data.tar.gz: c3e610b82510c510d2dfb16ecd1c408fe0be17c7e0b1d1209ce92432d52513e9
+  metadata.gz: 563f8b4de0ed787b40924054ae28cf77715706b1432823dd0d08d13d3d22cc63
+  data.tar.gz: 44512dca21464c88c0eb5b1920afa12cc3645e478f843680761b72f353d44cba
 SHA512:
-  metadata.gz: 8c18ed07879923d174cea1cc75a860406a5f6548dfbc56dfe4d27610ee64d29ce0df3cbfdd500362b2ce2780948d48f2e54aac487d437141e0b91c29a78d9935
-  data.tar.gz: a76d39182e7d95ac2192a4a90017dd337f07d786379379dc3a5166765a2f7241b3abc8b025ae8a7210aa0dd7431552dab7c1ce877acc4c394801d4cd410e2250
+  metadata.gz: eb06c6d1d8b6f1639199c0dd10c27f14191769109948da5a4fc3a797eaf784130457acac8f66ced45de49827ae737705e883342212c974083bf555bf35394fec
+  data.tar.gz: 9c0e95dbd4f8903afe755f415543e33fa934d6ae7b58bd4da8b44b46b0c3c8f25200c867ad77a6a3d24ae73511da7a4d52ba10a4dccf4575e299f9956aacaa7a

data/lib/card_controller.rb

@@ -6,6 +6,7 @@ class CardController < ActionController::Base
   include Rest
   include Response
   include Errors
+  extend Errors::Rescue
 
   # NOTE: including Card::Env::Location triggers card loading, which triggers mod loading,
   # which can include initializers that add to the CardController class.
@@ -22,4 +23,7 @@ class CardController < ActionController::Base
   before_action :load_card, except: [:asset]
   before_action :load_action, only: [:read]
   before_action :refresh_card, only: %i[create update delete]
+
+  rescue_from_class(*Card::Error::UserError.user_error_classes)
+  rescue_from_class StandardError if rescue_all?
 end

data/lib/card_controller/errors.rb

@@ -1,19 +1,20 @@
 # Decko's only controller.
 class CardController
-  class << self
-    def rescue_from_class *klasses
-      klasses.each do |klass|
-        rescue_from(klass) { |exception| handle_exception exception }
+  # controller error handling
+  module Errors
+    # controller class method to handle top-level error rescuing
+    module Rescue
+      def rescue_from_class *klasses
+        klasses.each do |klass|
+          rescue_from(klass) { |exception| handle_exception exception }
+        end
       end
-    end
 
-    def rescue_all?
-      Cardio.config.rescue_all_in_controller
+      def rescue_all?
+        Cardio.config.rescue_all_in_controller
+      end
     end
-  end
 
-  # controller error handling
-  module Errors
     def handle_exception exception
       raise exception if debug_exception?(exception)
 
@@ -30,7 +31,4 @@ class CardController
         Card[:debugger]&.content =~ /on/  # && !Card::Env.ajax?
     end
   end
-
-  rescue_from_class(*Card::Error::UserError.user_error_classes)
-  rescue_from_class StandardError if rescue_all?
 end

data/lib/card_controller/response.rb

@@ -76,18 +76,6 @@ class CardController
       raise Card::Error, "tried to do soft redirect without a card"
     end
 
-    def asset_file_path filename
-      path = Decko::Engine.paths["gem-assets"].existent.first
-      path = File.join path, filename
-      validate_path filename, path
-      path
-    end
-
-    def validate_path filename, path
-      # for security, block relative paths
-      raise Card::Error::BadAddress if filename.include?("../") || !::File.exist?(path)
-    end
-
     # TODO: everything below should go in a separate file
     # below is about beginning (initialization).  above is about end (response)
     # Both this file and that would make sense as submodules of CardController

data/lib/card_controller/rest.rb

@@ -1,6 +1,8 @@
 class CardController
   # RESTful action methods for card
   module Rest
+    include ActionController::HttpAuthentication::Token
+
     # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     #  PUBLIC METHODS
 
@@ -22,8 +24,8 @@ class CardController
 
     # @deprecated
     def asset
-      body = "Decko installation error: missing asset symlinks"
-      Rails.logger.info "#{body}.\n  >>> Try `rake decko:update_assets_symlink`"
+      body = "Decko installation error: missing public directory symlinks"
+      Rails.logger.info "#{body}.\n  >>> Try `rake card:mod:symlink`"
       render body: body, status: 404
     end
 
@@ -33,13 +35,21 @@ class CardController
     private
 
     def setup
-      Card::Machine.refresh_script_and_style unless params[:explicit_file]
+      Card::Machine.refresh_assets unless params[:explicit_file]
       Card::Cache.renew
       Card::Env.reset controller: self
     end
 
     def authenticate
-      Card::Auth.signin_with params
+      Card::Auth.signin_with(**authenticators)
+    end
+
+    def authenticators
+      { token: token_from_header || params[:token] }
+    end
+
+    def token_from_header
+      token_and_options(request)&.first
     end
 
     def load_card

data/lib/decko.rb

@@ -2,21 +2,8 @@ module Decko
   DECKO_GEM_ROOT = File.expand_path("..", __dir__)
 
   class << self
-    def root
-      Rails.root
-    end
-
-    def application
-      Rails.application
-    end
-
-    def config
-      application.config
-    end
-
-    def paths
-      application.paths
-    end
+    delegate :application, :root, to: :Rails
+    delegate :config, :paths, to: :application
 
     def gem_root
       DECKO_GEM_ROOT

data/lib/decko/all.rb

@@ -1 +1,3 @@
+# backwards compatibility for old decks that require decko/all
+
 require "decko/application"

data/lib/decko/application.rb

@@ -1,93 +1,12 @@
 # -*- encoding : utf-8 -*-
 
-require "decko/engine"
-require_relative "config/initializers/sedate_parser"
-
-Bundler.require :default, *Rails.groups
-
-module Decko
-  class Application < Rails::Application
-    initializer :load_decko_environment_config,
-                before: :load_environment_config, group: :all do
-      add_path paths, "lib/decko/config/environments", glob: "#{Rails.env}.rb"
-      paths["lib/decko/config/environments"].existent.each do |environment|
-        require environment
-      end
-    end
-
-    class << self
-      def inherited base
-        super
-        Rails.app_class = base
-        add_lib_to_load_path!(find_root(base.called_from))
-        ActiveSupport.run_load_hooks(:before_configuration, base.instance)
-      end
-    end
-
-    def add_path paths, path, options={}
-      root = options.delete(:root) || Decko.gem_root
-      options[:with] = File.join(root, (options[:with] || path))
-      paths.add path, options
-    end
-
-    def config
-      @config ||= begin
-        config = super
-
-        Cardio.set_config config
-
-        # any config settings below:
-        # (a) do not apply to Card used outside of a Decko context
-        # (b) cannot be overridden in a deck's application.rb, but
-        # (c) CAN be overridden in an environment file
-
-        # therefore, in general, they should be restricted to settings that
-        # (1) are specific to the web environment, and
-        # (2) should not be overridden
-        # ..and we should address (c) above!
+require "cardio/all"
+require "action_controller/railtie"
+require "decko/railtie"
+require "cardio/application"
 
-        # general card settings (overridable and not) should be in cardio.rb
-        # overridable decko-specific settings don't have a place yet
-        # but should probably follow the cardio pattern.
-
-        # config.load_defaults "6.0"
-        config.autoloader = :zeitwerk
-        config.load_default = "6.0"
-        config.i18n.enforce_available_locales = true
-        # config.active_record.raise_in_transactional_callbacks = true
-
-        config.allow_concurrency = false
-        config.assets.enabled = false
-        config.assets.version = "1.0"
-
-        config.filter_parameters += [:password]
-
-        # Rails.autoloaders.log!
-        Rails.autoloaders.main.ignore(
-          File.join(Cardio.gem_root, "lib/card/seed_consts.rb")
-        )
-        config
-      end
-    end
-
-    def paths
-      @paths ||= begin
-        paths = super
-        Cardio.set_paths paths
-
-        paths.add "files"
-
-        paths["app/models"] = []
-        paths["app/mailers"] = []
-        paths["app/controllers"] = []
-
-        unless paths["config/routes.rb"].existent.present?
-          add_path paths, "config/routes.rb",
-                   with: "rails/application-routes.rb"
-        end
+# require_relative "config/initializers/sedate_parser"
+require "decko/engine"
 
-        paths
-      end
-    end
-  end
-end
+# The application class from which decko applications inherit
+Decko::Application = Rails::Application

data/lib/decko/cli.rb

@@ -6,12 +6,6 @@ require "decko/script_decko_loader"
 Decko::ScriptDeckoLoader.exec!
 
 require "rails/ruby_version_check"
-Signal.trap("INT") { puts; exit(1) }
-
-# if ARGV.first == 'plugin'
-#  ARGV.shift
-#  require 'decko/commands/plugin_new'
-# else
+Signal.trap("INT") { exit(1) }
 
 require "decko/commands/application"
-# end

data/lib/decko/commands.rb

@@ -1,121 +1,28 @@
-# add method in? to Object class
-require "active_support/core_ext/object/inclusion"
+ENV["CARDIO_COMMANDS"] = "NO_RUN"
 
-def load_rake_tasks
-  require "./config/environment"
-  require "rake"
-  Decko::Application.load_tasks
-end
-
-RAILS_COMMANDS = %w[ generate destroy plugin benchmarker profiler console
-                     server dbconsole application runner ].freeze
-DECKO_COMMANDS = %w[new cucumber rspec jasmine].freeze
-DECKO_DB_COMMANDS = %w[seed reseed load update].freeze
-
-ALIAS = {
-  "rs" => "rspec",
-  "cc" => "cucumber",
-  "jm" => "jasmine",
-  "g" => "generate",
-  "d" => "destroy",
-  "c" => "console",
-  "s" => "server",
-  "db" => "dbconsole",
-  "r" => "runner"
-}.freeze
-
-def supported_rails_command? arg
-  arg.in?(RAILS_COMMANDS) || ALIAS[arg].in?(RAILS_COMMANDS)
-end
-
-ARGV << "--help" if ARGV.empty?
+require "cardio/commands"
 
 module Decko
-  module Commands
-    class << self
-      def run_new
-        if ARGV.first.in?(["-h", "--help"])
-          require "decko/commands/application"
-        else
-          puts "Can't initialize a new deck within the directory of another, " \
-           "please change to a non-deck directory first.\n"
-          puts "Type 'decko' for help."
-          exit(1)
-        end
-      end
-
-      def run_rspec
-        require "decko/commands/rspec_command"
-        RspecCommand.new(ARGV).run
-      end
-
-      def run_cucumber
-        require "decko/commands/cucumber_command"
-        CucumberCommand.new(ARGV).run
-      end
+  class Commands < Cardio::Commands
+    extend Cardio::Commands::Accessors
 
-      def run_db_task command
-        require "decko/commands/rake_command"
-        RakeCommand.new("decko:#{command}", ARGV).run
-      end
+    commands[:rails] << (aliases["s"] = "server")
+    commands[:custom] << (aliases["cc"] = "cucumber")
 
-      def run_jasmine
-        require "decko/commands/rake_command"
-        RakeCommand.new("spec:javascript", envs: "test").run
-      end
+    def run_cucumber
+      require "decko/commands/cucumber_command"
+      CucumberCommand.new(args).run
     end
-  end
-end
-
-command = ARGV.first
-command = ALIAS[command] || command
-if supported_rails_command? command
-  ENV["PRY_RESCUE_RAILS"] = "1" if ARGV.delete("--rescue")
-
-  # without this, the card generators don't list with: decko g --help
-  require "generators/card" if command == "generate"
-  require "rails/commands"
-else
-  ARGV.shift
-  case command
-  when "--version", "-v"
-    puts "Decko #{Card::Version.release}"
-  when *DECKO_COMMANDS
-    Decko::Commands.send("run_#{command}")
-  when *DECKO_DB_COMMANDS
-    Decko::Commands.run_db_task command
-  else
-    puts "Error: Command not recognized" unless command.in?(["-h", "--help"])
-    puts <<-EOT
-  Usage: decko COMMAND [ARGS]
 
-  The most common decko commands are:
-   new         Create a new Decko deck. "decko new my_deck" creates a
-               new deck called MyDeck in "./my_deck"
-   seed        Create and seed the database specified in config/database.yml
-
-   server      Start the Rails server (short-cut alias: "s")
-   console     Start the Rails console (short-cut alias: "c")
-   dbconsole   Start a console for the database specified in config/database.yml
-               (short-cut alias: "db")
-
-  For core developers
-   cucumber     Run cucumber features (short-cut alias: "cc")
-   rspec        Run rspec tests (short-cut alias: "rs")
-   update       Run card migrations
-   load         Load bootstrap data into database
+    def rake_prefix
+      "decko"
+    end
 
-  In addition to those, there are the standard rails commands:
-   generate     Generate new code (short-cut alias: "g")
-   application  Generate the Rails application code
-   destroy      Undo code generated with "generate" (short-cut alias: "d")
-   benchmarker  See how fast a piece of code runs
-   profiler     Get profile information from a piece of code
-   plugin       Install a plugin
-   runner       Run a piece of code in the application environment (short-cut alias: "r")
+    def run_rails
+      require "decko/generators" if command == "generate"
+      super
+    end
 
-  All commands can be run with -h (or --help) for more information.
-    EOT
-    exit(1)
+    new(ARGV).run
   end
 end

data/lib/decko/commands/application.rb

@@ -1,5 +1,5 @@
 require "rails/generators"
-require File.expand_path("../generators/deck/deck_generator", __dir__)
+require File.expand_path("../../../generators/deck/deck_generator", __FILE__)
 
 if ARGV.first != "new"
   ARGV[0] = "--help"
@@ -7,4 +7,4 @@ else
   ARGV.shift
 end
 
-Decko::Generators::Deck::DeckGenerator.start
+Cardio::Generators::Deck::DeckGenerator.start

data/lib/decko/commands/cucumber_command.rb

@@ -1,11 +1,14 @@
-require File.expand_path("command", __dir__)
+# load the application so we can look in mods
+require APP_PATH
+require "cardio/commands/command"
+require "cardio/mod/dirs"
 
 module Decko
-  module Commands
-    class CucumberCommand < Command
+  class Commands
+    class CucumberCommand < Cardio::Commands::Command
+      require "decko/commands/cucumber_command/parser"
+
       def initialize args
-        require "decko"
-        require "./config/environment"
         @decko_args, @cucumber_args = split_args args
         @opts = {}
         Parser.new(@opts).parse!(@decko_args)
@@ -44,5 +47,3 @@ module Decko
     end
   end
 end
-
-require File.expand_path("cucumber_command/parser", __dir__)