card 1.104.1 → 1.104.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae1fc116c9fb870d1d6b8a27a566d7aca5313f249b4bf4784209b677a8589ab7
-  data.tar.gz: b8ede92d2f96959e197a87fc8a4d3af678a0bfc1426683a8af8c29545444e224
+  metadata.gz: c315f9b25036d3cfe0a8689bf7f8bde71a68715a4dbacf742e5d1cffe999e8f5
+  data.tar.gz: fb9f8e44f73b7a8236d14a33b04ba653adaac3eadad49db3abb5bfbb11d03eb6
 SHA512:
-  metadata.gz: a192861e2d5fec66e431f55a80aaa840a45d77b4ebc10a2c16bca1af4a51a249f3cd655877c82c8ddc51e74c356a8c5da75e02347b1c80b1d6fb01e7c79bb808
-  data.tar.gz: 7ec8399cc23e2339d03fab541614347aa37110f12dcc0bf73fd13dc93bc98bd63e4a46434dbbcad7c09ecc6efeef2aad93963a8ed62d975965d9e5c2fb483c56
+  metadata.gz: 3e72cb6beab5d390e721a574d861cc4de210888fbc2f6b9a1f59f30f7b3c4f578e70871f6418dd31d0ed6264192bbd05d74f91cf877f5938312fc0d1648a3c58
+  data.tar.gz: 47d0f5bbefbeabdf939a65074e91f46f3b917c6c4f9508d7bb63ed012f1e6e2ddc71fbe69bed6482139fc11f5c009f10e2be7704d6350091535ce6c688e042fc

data/VERSION

@@ -1 +1 @@
-0.14.1
+0.14.2

data/db/migrate_core_cards/20140307231621_user_data_to_cards.rb

@@ -38,7 +38,6 @@ class UserDataToCards < Cardio::Migration::Core
     Card[oldname].update! name: newname
 
     puts "importing all user details (for those not in trash) into +*account attributes"
-    Card::Env[:no_password_encryptions] = true
     User.all.each do |user|
       base = Card[user.card_id]
       next unless base && !base.trash

data/lib/card/env/location.rb

@@ -12,16 +12,12 @@ class Card
         if rel_path.match? %r{^(https?:)?/}
           rel_path
         else
-          "#{Card.config.relative_url_root}/#{rel_path}"
+          "#{relative_url_root}/#{rel_path}"
         end
       end
 
       def card_url rel
-        rel.match?(/^https?:/) ? rel : "#{protocol_and_host}#{card_path rel}"
-      end
-
-      def protocol_and_host
-        Card.config.protocol_and_host || "#{Env[:protocol]}#{Env[:host]}"
+        rel.match?(/^https?:/) ? rel : "#{Env.origin}#{card_path rel}"
       end
 
       def cardname_from_url url
@@ -31,12 +27,16 @@ class Card
         m ? Card::Name[m[:mark]] : nil
       end
 
+      def relative_url_root
+        Cardio.config.relative_url_root
+      end
+
       private
 
       def cardname_from_url_regexp
-        return unless Env[:host]
+        return unless Env.origin
 
-        %r{#{Regexp.escape Env[:host]}/(?<mark>[^?]+)}
+        %r{#{Regexp.escape Env.origin}/(?<mark>[^?]+)}
       end
 
       extend Location # allows calls on Location constant, eg Location.card_url

data/lib/card/env/serializable.rb

@@ -0,0 +1,33 @@
+class Card
+  module Env
+    # These methods are all handled in serialization and are thus preserved for the
+    # integrate_with_delay phase
+    module Serializable
+      def ip
+        request&.remote_ip
+      end
+
+      def protocol
+        request&.protocol
+      end
+
+      def host
+        request&.host
+      end
+
+      def origin
+        Cardio.config.deck_origin || "#{protocol}#{request&.host_with_port}"
+      end
+
+      def ajax
+        request&.xhr? || params[:simulate_xhr]
+      end
+      alias_method :ajax?, :ajax
+
+      def html
+        !controller || params[:format].in?([nil, "html"])
+      end
+      alias_method :html?, :html
+    end
+  end
+end

data/lib/card/env/serialization.rb

@@ -2,13 +2,15 @@ class Card
   module Env
     # serializing environment (eg for delayed jobs)
     module Serialization
-      SERIALIZABLE_ATTRIBUTES = ::Set.new %i[
-        main_name params ip ajax html host protocol salt
-      ]
+      def serialize
+        @serialized = Serializable.instance_methods.each_with_object({}) do |attr, hash|
+          hash[attr] = send attr
+        end
+      end
 
       # @param serialized_env [Hash]
       def with serialized_env
-        tmp_env = serialize if @env
+        tmp_env = serialize
         @env ||= {}
         @env.update serialized_env
         yield
@@ -16,8 +18,14 @@ class Card
         @env.update tmp_env if tmp_env
       end
 
-      def serialize
-        @env.select { |k, _v| SERIALIZABLE_ATTRIBUTES.include?(k) }
+      # supercede serializable methods when serialized values are available
+      #
+      # note - at present this must be done manually when adding serializable methods
+      # in mods.
+      Serializable.instance_methods.each do |attrib|
+        define_method attrib do
+          @serialized&.key?(attrib) ? @serialized[attrib] : super()
+        end
       end
     end
   end

data/lib/card/env/slot_options.rb

@@ -4,7 +4,7 @@ class Card
     module SlotOptions
       def slot_opts
         # FIXME:  upgrade to safe parameters
-        self[:slot_opts] ||= interpret_slot_options
+        @slot_opts ||= interpret_slot_options
       end
 
       private

data/lib/card/env/support.rb

@@ -0,0 +1,30 @@
+class Card
+  module Env
+    # utility methods for Card::Env
+    module Support
+      def with_params hash
+        old_params = params.clone
+        params.merge! hash
+        yield
+      ensure
+        @params = old_params
+      end
+
+      def hash hashish
+        case hashish
+        when Hash then hashish.clone
+        when ActionController::Parameters then hashish.to_unsafe_h
+        else {}
+        end
+      end
+
+      def reset_session
+        if session.is_a? Hash
+          @session = {}
+        else
+          controller&.reset_session
+        end
+      end
+    end
+  end
+end

data/lib/card/env.rb

@@ -5,90 +5,35 @@ class Card
   # Env can differ for each request; Card.config should not.
   module Env
     extend LocationHistory
-    extend RequestAssignments
     extend SlotOptions
+    extend Support
+    extend Serializable
     extend Serialization
 
     class << self
-      def reset args={}
-        @env = { main_name: nil }
-        return self unless (c = args[:controller])
+      attr_accessor :controller, :main_name, :params
+      attr_writer :session
 
-        self[:controller] = c
-        self[:session]    = c.request.session
-        self[:params]     = c.params
-        self[:ip]         = c.request.remote_ip
-        self[:ajax]       = assign_ajax(c)
-        self[:html]       = assign_html(c)
-        self[:host]       = assign_host(c)
-        self[:protocol]   = assign_protocol(c)
-        self
-      end
-
-      def [] key
-        @env[key.to_sym]
-      end
-
-      def []= key, value
-        @env[key.to_sym] = value
-      end
-
-      def params
-        self[:params] ||= {} # .with_indifferent_access
-      end
-
-      def with_params hash
-        old_params = params.clone
-        params.merge! hash
-        yield
-      ensure
-        self[:params] = old_params
-      end
-
-      def hash hashish
-        case hashish
-        when Hash then hashish.clone
-        when ActionController::Parameters then hashish.to_unsafe_h
-        else {}
-        end
+      def request
+        controller&.request
       end
 
       def session
-        self[:session] ||= {}
+        @session ||= request&.session || {}
       end
 
-      def reset_session
-        if session.is_a? Hash
-          self[:session] = {}
-        else
-          self[:controller]&.reset_session
-        end
+      def reset controller=nil
+        @controller = controller
+        @params = controller&.params || {}
+        @session = @success = @serialized = @slot_opts = nil
       end
 
       def success cardname=nil
-        self[:success] ||= Env::Success.new(cardname, params[:success])
+        @success ||= Env::Success.new(cardname, params[:success])
       end
 
       def localhost?
-        self[:host]&.match?(/^localhost/)
-      end
-
-      def ajax?
-        self[:ajax]
-      end
-
-      def html?
-        !self[:controller] || self[:html]
-      end
-
-      private
-
-      def method_missing method_id, *args
-        case args.length
-        when 0 then self[method_id]
-        when 1 then self[method_id] = args[0]
-        else super
-        end
+        host&.match?(/^localhost/)
       end
     end
   end

data/lib/card/format.rb

@@ -70,7 +70,7 @@ class Card
     end
 
     def controller
-      @controller || Env[:controller] ||= CardController.new
+      @controller || Env.controller ||= CardController.new
     end
 
     def mime_type

data/lib/cardio/railtie.rb

@@ -17,9 +17,6 @@ module Cardio
     config.google_analytics_tracker_key = nil
     config.google_analytics_four_key = nil
 
-    config.override_host = nil
-    config.override_protocol = nil
-
     config.no_authentication = false
     config.files_web_path = "files"
 
@@ -64,7 +61,8 @@ module Cardio
     config.file_storage = :local
     config.file_buckets = {}
     config.file_default_bucket = nil
-    config.protocol_and_host = nil
+
+    config.deck_origin = nil
 
     config.rich_text_editor = :tinymce
 

data/lib/cardio/version.rb

@@ -6,7 +6,7 @@ module Cardio
       CARD_MINOR = { 0 => 90, 1 => 1000 }.freeze # can remove and hardcode after 1.0
 
       def release
-        @version ||= File.read(File.expand_path("../../../card/VERSION", __dir__)).strip
+        @version ||= File.read(File.expand_path("../../VERSION", __dir__)).strip
       end
 
       def card_release

data/lib/cardio.rb

@@ -45,5 +45,13 @@ module Cardio
     def mods
       Mod.dirs.mods
     end
+
+    def with_config tmp
+      keep = tmp.keys.each_with_object({}) { |k, h| h[k] = config.send k }
+      tmp.each { |k, v| config.send "#{k}=", v }
+      yield
+    ensure
+      keep.each { |k, v| config.send "#{k}=", v }
+    end
   end
 end

data/lib/generators/deck/templates/config/application.rb.erb

@@ -4,55 +4,75 @@ require "decko/application"
 
 module <%= app_const_base %>
   class Application < Decko::Application
-    config.performance_logger = nil
-
     # Decko inherits most Ruby-on-Rails configuration options.
     # See http://guides.rubyonrails.org/configuring.html
 
     # EMAIL
-    # Email is not turned on by default.  To turn it on, you need to change the
-    # following to `true` and then add configuration specific to your site.
-    # Learn more:
+    # Outgoing email, which is used by a lot of account processes (signup,
+    # forgot password, notifications, etc) is not turned on by default.
+    # To turn it on, you need to change the following to `true` and add
+    # configuration specific to your site.
+    #
+    # Learn more about Rails email configuration:
     #  https://guides.rubyonrails.org/configuring.html#configuring-action-mailer
-
+    #
     config.action_mailer.perform_deliveries = false
     # config.action_mailer.delivery_method  = ...
     # config.action_mailer.smtp_settings    = ...
-
-    # Example configuration for mailcatcher, a simple smtp server.
-    # See http://mailcatcher.me for more information
+    #
+    # Example configuration for mailcatcher, a simple development-friendly
+    # smtp server (but not an option for production sites):
+    #
     # config.action_mailer.delivery_method = :smtp
     # config.action_mailer.smtp_settings = { address: "localhost", port: 1025 }
-
-
-    # BACKGROUND
-    # Decko lets you run some card events (like follower notifications) in the
-    # background. This is off by default but can be turned on by changing the
-    # `delaying` setting to `true`
-    config.active_job.queue_adapter = :delayed_job
-    config.delaying = false
-
+    #
+    # Learn more about mailcatcher:
+    #   http://mailcatcher.me for more information
 
     # CACHING
+    # Cards make heavy use of caching to improve performance. Caching storage
+    # options include: file_store (default), memory_store, mem_cache_store...
+    #
     # config.cache_store = :file_store, "tmp/cache"
-    # determines caching mechanism.  options include: file_store, memory_store,
-    # mem_cache_store...
     #
     # for production, we highly recommend memcache
-    # here's a sample configuration for use with the dalli gem
+    # here's a sample configuration for use with the "dalli" gem
+    # (which you can install by adding `gem "dalli"` to your Gemfile and then
+    # running `bundle install`.
+    #
     # config.cache_store = :mem_cache_store, []
-
+    #
+    # Learn more about Rails caching configuration:
+    #   https://guides.rubyonrails.org/caching_with_rails.html#cache-stores
 
     # FILES
-    # config.paths["files"] = "files"
-    # directory in which uploaded files are actually stored. (eg Image and File cards)
-
+    # Some card content (eg for Image and File cards) is stored in files
+    # rather than in the database.
+    #
+    # Most will want to set file_storage to use either :local or :cloud.
+    #
+    # By default storage is set to :local, and files are stored in the "files"
+    # directory in the deck root.
+    #
     # config.file_storage = :local
-    # File storage options (see http://decko.org/file_storage_options)
-    # options include: local, cloud, web, coded
-    # defaults to local
-    # For cloud storage use the following config options and add the corresponding fog gem
-    # for your cloud service. For example for AWS add "fog-aws" to your Gemfile.
+    # config.paths["files"] = "files"
+    #
+    <% if platypus? %>
+    config.file_buckets = {
+      test_bucket: {
+        provider: "AWS",
+        aws_access_key_id: ENV["TEST_BUCKET_AWS_ACCESS_KEY_ID"],
+        aws_secret_access_key: ENV["TEST_BUCKET_AWS_SECRET_ACCESS_KEY"],
+        region: "us-east-1"
+      }
+    }
+    <% else %>
+    # For cloud storage use the following config options and add the
+    # corresponding fog gem for your cloud service. For example for AWS add
+    # `gem "fog-aws"` to your Gemfile. IMPORTANT: also see protocol and host
+    # below.
+    #
+    # config.file_storage = :cloud
     # config.file_default_bucket = :my_bucket
     # config.file_buckets = {
     #   my_bucket: {
@@ -63,7 +83,7 @@ module <%= app_const_base %>
     #        aws_access_key_id: "key",                # required
     #        aws_secret_access_key: "secret-key",     # required
     #        use_iam_profile: true,             # optional, defaults to false
-    #        region: "eu-central-1",                   # optional, defaults to "us-east-1"
+    #        region: "eu-central-1",                  # optional, defaults to "us-east-1"
     #        host: "s3.example.com",                  # optional, defaults to nil
     #        endpoint: "https://s3.example.com:8080"  # optional, defaults to nil
     #     },
@@ -76,32 +96,31 @@ module <%= app_const_base %>
     #                                        # option is needed
     #   }
     # }
+    #
+    # Learn more about file storage options:
+    #   http://decko.org/file_storage_options)
+    <% end %>
+
+    # ORIGIN AND RELATIVE_ROOT
+    # The following option is used when generating absolute links and
+    # are necessary when using cloud file storage, especially when using
+    # commands (like `decko update`) in a non-web context.
+    #
+    # Without it your generated CSS (which is stored on the cloud) will not
+    # be able to find permanent resources (which are stored with the deck).
+    # This usually shows up as broken icons.
+    #
+    # config.deck_origin = "https://mysite.com"
+    #
+    # If your deck is not at the url's root but in a subdirectory, such as
+    # mysite.com/mydeck, then you must configure the relative_url_root:
+    #
+    # config.relative_url_root = "/mydeck"
 
     # MISCELLANEOUS
+    # You can use the following to disallow creating, updating, and deleting
+    # cards:
+    #
     # config.read_only = true
-    # defaults to false
-    # disallows creating, updating, and deleting cards.
-
-    # config.paths["mod"] << "my-mod-dir"
-    # add a new directory for code customizations, or "mods"
-
-    # config.allow_inline_styles = false
-    # don't strip style attributes (not recommended)
-
-    # config.override_host = "example.com"
-    # overrides host auto-detected from web requests
-
-    # config.override_protocol = "https"
-    # overrides protocol auto-detected from web requests
-    <% if platypus? %>
-    config.file_buckets = {
-      test_bucket: {
-        provider: "AWS",
-        aws_access_key_id: ENV["TEST_BUCKET_AWS_ACCESS_KEY_ID"],
-        aws_secret_access_key: ENV["TEST_BUCKET_AWS_SECRET_ACCESS_KEY"],
-        region: "us-east-1"
-      }
-    }
-    <% end %>
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: card
 version: !ruby/object:Gem::Version
-  version: 1.104.1
+  version: 1.104.2
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cardname
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.14.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -662,11 +662,12 @@ files:
 - lib/card/env.rb
 - lib/card/env/location.rb
 - lib/card/env/location_history.rb
-- lib/card/env/request_assignments.rb
+- lib/card/env/serializable.rb
 - lib/card/env/serialization.rb
 - lib/card/env/slot_options.rb
 - lib/card/env/success.rb
 - lib/card/env/success/target.rb
+- lib/card/env/support.rb
 - lib/card/error.rb
 - lib/card/fetch.rb
 - lib/card/fetch/all.rb

data/lib/card/env/request_assignments.rb

@@ -1,24 +0,0 @@
-class Card
-  module Env
-    # environmental variables assigned based on request
-    module RequestAssignments
-      private
-
-      def assign_ajax c
-        c.request.xhr? || c.request.params[:simulate_xhr]
-      end
-
-      def assign_html c
-        [nil, "html"].member?(c.params[:format])
-      end
-
-      def assign_host c
-        Card.config.override_host || c.request.env["HTTP_HOST"]
-      end
-
-      def assign_protocol c
-        Card.config.override_protocol || c.request.protocol
-      end
-    end
-  end
-end