decko 0.11.0 → 0.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7224a35bbfe70eb0161da009005fed740cc35ee689af6adfa980b3ed0f2170df
-  data.tar.gz: 289ac9de6b45e6eda87c7e4348eafc92d08c8fb7d8b83702f15c1c3ad4b74f51
+  metadata.gz: 1c726ee70f0d8daba2891b23aab64090c43d088cc3300290a52eddee922dc7d0
+  data.tar.gz: c3e610b82510c510d2dfb16ecd1c408fe0be17c7e0b1d1209ce92432d52513e9
 SHA512:
-  metadata.gz: cc0b3db286b9c49e7011d6be0a5392203393eb95621ee3b19abdc06bec656be1820fb7f845e2e2fddb3d03fae7c21710dcd9f7a38a9dcbb2b3190adb10a72644
-  data.tar.gz: f2bfe942fed37c30724f92f7bd7048af9445de4dcb8a41b66491c52016b0192974e24b674010022f51b341fdbd847479e595ac774b4685de7138403d97865329
+  metadata.gz: 8c18ed07879923d174cea1cc75a860406a5f6548dfbc56dfe4d27610ee64d29ce0df3cbfdd500362b2ce2780948d48f2e54aac487d437141e0b91c29a78d9935
+  data.tar.gz: a76d39182e7d95ac2192a4a90017dd337f07d786379379dc3a5166765a2f7241b3abc8b025ae8a7210aa0dd7431552dab7c1ce877acc4c394801d4cd410e2250

data/bin/decko

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-git_path = File.expand_path("../../../.git", __FILE__)
+git_path = File.expand_path("../../.git", __dir__)
 
 if File.exist?(git_path)
-  railties_path = File.expand_path("../../lib", __FILE__)
+  railties_path = File.expand_path("../lib", __dir__)
   $LOAD_PATH.unshift(railties_path)
 end
 require "decko/cli"

data/lib/card_controller.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+
+# Decko's only controller.
+class CardController < ActionController::Base
+  include Mark
+  include Rest
+  include Response
+  include Errors
+
+  # NOTE: including Card::Env::Location triggers card loading, which triggers mod loading,
+  # which can include initializers that add to the CardController class.
+  # It's important that it come *after* the modules above, so that mod modules
+  # can override them.
+  include ::Card::Env::Location
+
+  layout nil
+  attr_reader :card
+
+  before_action :setup, except: [:asset]
+  before_action :authenticate, except: [:asset]
+  before_action :load_mark, only: [:read]
+  before_action :load_card, except: [:asset]
+  before_action :load_action, only: [:read]
+  before_action :refresh_card, only: %i[create update delete]
+end

data/lib/card_controller/errors.rb

@@ -0,0 +1,36 @@
+# Decko's only controller.
+class CardController
+  class << self
+    def rescue_from_class *klasses
+      klasses.each do |klass|
+        rescue_from(klass) { |exception| handle_exception exception }
+      end
+    end
+
+    def rescue_all?
+      Cardio.config.rescue_all_in_controller
+    end
+  end
+
+  # controller error handling
+  module Errors
+    def handle_exception exception
+      raise exception if debug_exception?(exception)
+
+      @card ||= Card.new
+      error = Card::Error.report exception, card
+      show error.class.view, error.class.status_code
+    end
+
+    # TODO: move to exception object
+    def debug_exception? e
+      !e.is_a?(Card::Error::UserError) &&
+        !e.is_a?(ActiveRecord::RecordInvalid) &&
+        Card::Codename[:debugger] &&
+        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/mark.rb

@@ -0,0 +1,66 @@
+class CardController
+  # methods for interpretation of card marks requested
+  module Mark
+    private
+
+    def load_mark
+      params[:mark] = interpret_mark params[:mark]
+    end
+
+    def interpret_mark mark
+      case mark
+      when "*previous"
+        # Why support this? It's only needed in Success, right? Deprecate?
+        hard_redirect Card::Env.previous_location
+      when nil
+        implicit_mark
+      else
+        explicit_mark mark
+      end
+    end
+
+    def explicit_mark mark
+      # we should find the place where we produce these bad urls
+      mark.valid_encoding? ? mark : mark.force_encoding("ISO-8859-1").encode("UTF-8")
+    end
+
+    def implicit_mark
+      case
+      when initial_setup
+        ""
+      when (name = mark_from_card_hash)
+        name
+      when view_does_not_require_name?
+        ""
+      else
+        home_mark
+      end
+    end
+
+    def home_mark
+      Card::Rule.global_setting(:home) || "Home"
+    end
+
+    def view_does_not_require_name?
+      return false unless (view = params[:view]&.to_sym)
+
+      Card::Set::Format::AbstractFormat::ViewOpts.unknown_ok[view]
+    end
+
+    def mark_from_card_hash
+      params.dig :card, :name
+    end
+
+    # alters params
+    def initial_setup
+      return unless Card::Auth.needs_setup? && Card::Env.html?
+
+      prepare_setup_card!
+    end
+
+    def prepare_setup_card!
+      params[:card] = { type_id: Card.default_accounted_type_id }
+      params[:view] = "setup"
+    end
+  end
+end

data/lib/{decko → card_controller}/response.rb

@@ -1,4 +1,4 @@
-module Decko
+class CardController
   # methods for managing decko responses
   module Response
     def response_format
@@ -72,13 +72,8 @@ module Decko
 
     def require_card_for_soft_redirect!
       return if card.is_a? Card
-      raise Card::Error, "tried to do soft redirect without a card"
-    end
 
-    # (obviously) deprecated
-    def send_deprecated_asset
-      filename = [params[:mark], params[:format]].compact.join(".")
-      send_file asset_file_path(filename), x_sendfile: true
+      raise Card::Error, "tried to do soft redirect without a card"
     end
 
     def asset_file_path filename
@@ -97,9 +92,9 @@ module Decko
     # below is about beginning (initialization).  above is about end (response)
     # Both this file and that would make sense as submodules of CardController
 
-    def load_format
+    def load_format status
       request.format = :html if implicit_html?
-      card.format response_format
+      card.format(response_format).tap { |fmt| fmt.error_status = status }
     end
 
     def implicit_html?
@@ -107,64 +102,13 @@ module Decko
     end
 
     def format_name_from_params
-      if explicit_file_format?       then :file
-      elsif params[:format].present? then params[:format].to_sym
-      else                                request.format.to_sym
-      end
+      return :file if explicit_file_format?
+
+      (params[:format].present? ? params[:format] : request.format).to_sym
     end
 
     def explicit_file_format?
       params[:explicit_file] || !Card::Format.registered.member?(request.format)
     end
-
-    def interpret_mark mark
-      case mark
-      when "*previous"
-        # Why support this? It's only needed in Success, right? Deprecate?
-        return hard_redirect(Card::Env.previous_location)
-      when nil
-        implicit_mark
-      else
-        explicit_mark mark
-      end
-    end
-
-    def explicit_mark mark
-      # we should find the place where we produce these bad urls
-      mark.valid_encoding? ? mark : mark.force_encoding("ISO-8859-1").encode("UTF-8")
-    end
-
-    def implicit_mark
-      case
-      when initial_setup                    then ""
-      when (name = params.dig :card, :name) then name
-      when view_does_not_require_name?      then ""
-      else                                       home_mark
-      end
-    end
-
-    def home_mark
-      Card::Rule.global_setting(:home) || "Home"
-    end
-
-    def view_does_not_require_name?
-      return false unless (view = params[:view]&.to_sym)
-      Card::Set::Format::AbstractFormat::ViewOpts.unknown_ok[view]
-    end
-
-    # alters params
-    def initial_setup
-      return unless initial_setup?
-      prepare_setup_card!
-    end
-
-    def initial_setup?
-      Card::Auth.needs_setup? && Card::Env.html?
-    end
-
-    def prepare_setup_card!
-      params[:card] = { type_id: Card.default_accounted_type_id }
-      params[:view] = "setup"
-    end
   end
 end

data/lib/card_controller/rest.rb

@@ -0,0 +1,105 @@
+class CardController
+  # RESTful action methods for card
+  module Rest
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    #  PUBLIC METHODS
+
+    def create
+      handle { card.save! }
+    end
+
+    def read
+      show
+    end
+
+    def update
+      card.new_card? ? create : handle { card.update! params[:card]&.to_unsafe_h }
+    end
+
+    def delete
+      handle { card.delete! }
+    end
+
+    # @deprecated
+    def asset
+      body = "Decko installation error: missing asset symlinks"
+      Rails.logger.info "#{body}.\n  >>> Try `rake decko:update_assets_symlink`"
+      render body: body, status: 404
+    end
+
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    #  PRIVATE METHODS
+
+    private
+
+    def setup
+      Card::Machine.refresh_script_and_style unless params[:explicit_file]
+      Card::Cache.renew
+      Card::Env.reset controller: self
+    end
+
+    def authenticate
+      Card::Auth.signin_with params
+    end
+
+    def load_card
+      @card = Card.uri_fetch params
+      raise Card::Error::NotFound unless card
+
+      record_as_main
+    end
+
+    def load_action
+      card.select_action_by_params params
+      return unless params[:edit_draft] && card.drafts.present?
+
+      card.content = card.last_draft_content
+    end
+
+    # TODO: refactor this away this when new layout handling is ready
+    def record_as_main
+      Card::Env[:main_name] = params[:main] || card&.name || ""
+    end
+
+    def refresh_card
+      @card = card.refresh
+    end
+
+    # ----------( HELPER METHODS ) -------------
+
+    def handle
+      Card::Env.success card.name
+      yield ? cud_success : raise(Card::Error::UserError)
+    end
+
+    # successful create, update, or delete act
+    def cud_success
+      success = Card::Env.success.in_context card.name
+      if success.reload?
+        reload # instruct JSON to reload
+      else
+        redirect_cud_success success
+      end
+    end
+
+    def show view=nil, status=200
+      card.action = :read
+      format = load_format status
+      result = render_page format, view
+      status = format.error_status || status
+      respond format, result, status
+    end
+
+    def render_page format, view
+      view ||= view_from_params
+      card.act do
+        format.page self, view, Card::Env.slot_opts
+      end
+    end
+
+    def view_from_params
+      %i[view v].each { |k| return params[k] if params[k].present? }
+      nil
+    end
+  end
+end

data/lib/decko.rb

@@ -1,6 +1,5 @@
-
 module Decko
-  DECKO_GEM_ROOT = File.expand_path("../..", __FILE__)
+  DECKO_GEM_ROOT = File.expand_path("..", __dir__)
 
   class << self
     def root

data/lib/decko/application.rb

@@ -63,7 +63,9 @@ module Decko
         config.filter_parameters += [:password]
 
         # Rails.autoloaders.log!
-        Rails.autoloaders.main.ignore(File.join(Cardio.gem_root, "lib/card/seed_consts.rb"))
+        Rails.autoloaders.main.ignore(
+          File.join(Cardio.gem_root, "lib/card/seed_consts.rb")
+        )
         config
       end
     end
@@ -77,6 +79,7 @@ module Decko
 
         paths["app/models"] = []
         paths["app/mailers"] = []
+        paths["app/controllers"] = []
 
         unless paths["config/routes.rb"].existent.present?
           add_path paths, "config/routes.rb",

data/lib/decko/cli.rb

@@ -3,7 +3,7 @@ require "decko/script_decko_loader"
 
 # If we are inside a Decko application this method performs an exec and thus
 # the rest of this script is not run.
-Decko::ScriptDeckoLoader.exec_script_decko!
+Decko::ScriptDeckoLoader.exec!
 
 require "rails/ruby_version_check"
 Signal.trap("INT") { puts; exit(1) }

data/lib/decko/commands.rb

@@ -7,21 +7,21 @@ def load_rake_tasks
   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
+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",
+  "g" => "generate",
+  "d" => "destroy",
+  "c" => "console",
+  "s" => "server",
   "db" => "dbconsole",
-  "r"  => "runner"
+  "r" => "runner"
 }.freeze
 
 def supported_rails_command? arg