card 1.104.1 → 1.105.0

data/lib/cardio/railtie.rb

@@ -1,70 +1,31 @@
 module Cardio
   # primary railtie for cards
   class Railtie < Rails::Railtie
+    config.encoding = "utf-8"
+
+    config.seed_mods = [:core]
+    config.seed_type = :real
+    config.extra_seed_tables = []
+
     # if you disable inline styles tinymce's formatting options stop working
     config.allow_inline_styles = true
     config.token_expiry = 2.days
 
-    config.recaptcha_public_key = nil  # deprecated; use recaptcha_site_key instead
-    config.recaptcha_private_key = nil # deprecated; use recaptcha_secret_key instead
-
-    config.recaptcha_proxy = nil
-    config.recaptcha_site_key = nil
-    config.recaptcha_secret_key = nil
-    config.recaptcha_minimum_score = 0.5
-
-    config.google_analytics_key = nil
-    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"
 
     config.max_char_count = 200
     config.max_depth = 20
     config.email_defaults = nil
 
-    config.acts_per_page = 10
     config.space_last_in_multispace = true
-    config.closed_search_limit = 10
-    config.paging_limit = 20
-
-    config.delaying = false
-    config.active_job.queue_adapter = :delayed_job
-
-    config.non_createable_types = %w[
-      signup
-      setting
-      set
-      session
-      bootswatch_skin
-      customized_bootswatch_skin
-      local_folder_group
-      local_manifest_group
-      local_script_folder_group
-      local_script_manifest_group
-      local_style_folder_group
-      local_style_manifest_group
-      remote_manifest_group
-      mod
-    ]
 
     config.view_cache = false
-    config.rss_enabled = false
-    config.double_click = :signed_in
 
-    config.encoding = "utf-8"
     config.request_logger = false
     config.performance_logger = false
     config.sql_comments = false
 
-    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
 
@@ -76,13 +37,12 @@ module Cardio
     config.allow_irreversible_admin_tasks = false
     config.raise_all_rendering_errors = false
     config.rescue_all_in_controller = true
-    config.navbox_match_start_only = true
 
     config.cache_set_module_list = false
 
     config.i18n.enforce_available_locales = true
     config.read_only = !ENV["DECKO_READ_ONLY"].nil?
-    config.load_strategy = (ENV["REPO_TMPSETS"] || ENV["TMPSETS"] ? :tmp_files : :eval)
+    config.load_strategy = ENV["CARD_LOAD_STRATEGY"]&.to_sym || :eval
 
     # TODO: support mod-specific railties
 
@@ -100,8 +60,7 @@ module Cardio
 
           p["lib/tasks"] << "#{card_root}/lib/tasks"
 
-          p.add "mod", with: "#{card_root}/mod"
-          p["mod"] << "mod"
+          p.add "mod"
           p.add "files"
 
           p.add "lib/graph_q_l/types/query.rb"
@@ -115,7 +74,7 @@ module Cardio
           p.add "db/migrate_deck", with: "db/migrate"
           p.add "db/migrate_deck_cards", with: "db/migrate_cards"
 
-          Cardio::Mod.each_path do |mod_path|
+          Cardio::Mod.dirs.each do |mod_path|
             c.autoload_paths += Dir["#{mod_path}/lib"]
             c.watchable_dirs["#{mod_path}/set"] = %i[rb haml]
 
@@ -123,11 +82,12 @@ module Cardio
               "#{mod_path}/lib/graph_q_l/types/query.rb"
             p["config/initializers"] << "#{mod_path}/init/early"
             p["late/initializers"] << "#{mod_path}/init/late"
-            p["config/locales"] << "#{mod_path}/locales"
             p["lib/tasks"] << "#{mod_path}/lib/tasks"
             p["mod-data"] << "#{mod_path}/data"
+            p["config/locales"] << "#{mod_path}/locales"
           end
 
+          # Card doesn't use these rails patterns
           p["app/models"] = []
           p["app/mailers"] = []
           p["app/controllers"] = []
@@ -138,15 +98,16 @@ module Cardio
     config.before_initialize do |app|
       app.config.tap do |c|
         if c.load_strategy == :tmp_files
-          %w[set set_pattern].each do |dir|
-            if ENV["REPO_TMPSETS"]
-              c.paths.add "tmp/#{dir}", with: "#{Cardio.gem_root}/tmpsets/#{dir}"
-            else
-              c.paths.add "tmp/#{dir}"
-            end
-          end
+          %w[set set_pattern].each { |dir| c.paths.add "tmp/#{dir}" }
         end
       end
     end
+
+    def self.require_mod_gem mod_name
+      require mod_name.name.to_s.tr("-", "/")
+    rescue LoadError
+    end
+
+    Cardio::Mod.gem_specs.each_value { |mod_name| require_mod_gem mod_name }
   end
 end

data/lib/cardio/schema.rb

@@ -31,7 +31,8 @@ module Cardio
       end
 
       def version type=nil
-        File.read(stamp_path(type)).strip
+        path = stamp_path type
+        File.exist?(path) ? File.read(path).strip : nil
       end
 
       def stamp_path type

data/lib/cardio/script_loader.rb

@@ -8,8 +8,10 @@ module Cardio
       RUBY = File.join(*RbConfig::CONFIG.values_at("bindir", "ruby_install_name")) +
              RbConfig::CONFIG["EXEEXT"]
 
+      attr_accessor :script_name
+
       def script
-        File.join("script", "card")
+        File.join "script", script_name
       end
 
       def exec!

data/lib/cardio/seed.rb

@@ -6,16 +6,109 @@ module Cardio
                 schema_migrations_deck schema_migrations_deck_cards].freeze
 
     class << self
-      attr_accessor :path, :test_path, :test_script_path
+      def default_path
+        db_path Cardio.config.seed_type, 0
+      end
 
-      def db_path *args
-        parts = [Cardio.gem_root, "db"] + args
-        File.join(*parts)
+      def path
+        if update_seed?
+          db_path :real, (Rails.env.test? ? 0 : 1)
+        else
+          default_path
+        end
+      end
+
+      def load
+        ActiveRecord::FixtureSet.create_fixtures path, load_tables
+
+        return unless update_seed?
+
+        Cardio::Migration.assume_current
+        Cardio::Migration::Core.assume_current
+        Cardio::Migration::DeckStructure.assume_current
+        # Cardio::Migration::Core.assume_current
+      end
+
+      def dump
+        dump_tables.each do |table|
+          i = "000" # TODO: use card keys instead (this is just a label)
+          write_seed_file table do
+            yamlize_records table do |record, hash|
+              hash["#{table}_#{i.succ!}"] = record
+            end
+          end
+        end
+      end
+
+      def clean
+        Card::Act.update_all actor_id: author_id
+        clean_history
+        clean_time_and_user_stamps
+      end
+
+      private
+
+      def update_seed?
+        ENV["CARD_UPDATE_SEED"]
+      end
+
+      # TODO: make this more robust. only handles simple case of extra seed tables
+      def load_tables
+        update_seed? && !Rails.env.test? ? TABLES : dump_tables
+      end
+
+      def dump_tables
+        TABLES + Cardio.config.extra_seed_tables
       end
-    end
 
-    self.path = db_path "seed", "new"
-    self.test_path = db_path "seed", "test", "fixtures"
-    self.test_script_path = db_path "test_seed.rb"
+      def db_path env, index
+        Mod.fetch(Cardio.config.seed_mods[index]).subpath "data", "fixtures", env.to_s
+      end
+
+      def write_seed_file table
+        filename = File.join default_path, "#{table}.yml"
+        File.open(filename, "w") { |file| file.write yield }
+      end
+
+      def yamlize_records table
+        data = ActiveRecord::Base.connection.select_all "select * from #{table}"
+        YAML.dump(
+          data.each_with_object({}) do |record, hash|
+            try "clean_#{table}_record", record
+            yield record, hash
+          end
+        )
+      end
+
+      def clean_card_actions_record record
+        record["draft"] = false # needed?
+      end
+
+      def clean_card_record record
+        record["trash"] = false # needed?
+        %w[created_at updated_at current_revision_id references_expired].each do |key|
+          record.delete key
+        end
+      end
+
+      def clean_history
+        puts "clean history"
+        act = Card::Act.create! actor_id: author_id, card_id: author_id
+        Card::Action.make_current_state_the_initial_state act
+        Card::Act.where("id <> #{act.id}").delete_all
+        ActiveRecord::Base.connection.execute("truncate sessions")
+      end
+
+      def clean_time_and_user_stamps
+        puts "clean time and user stamps"
+        conn = ActiveRecord::Base.connection
+        conn.update "UPDATE cards SET creator_id=#{author_id}, updater_id=#{author_id}"
+        conn.update "UPDATE card_acts SET actor_id=#{author_id}"
+      end
+
+      def author_id
+        Card::WagnBotID
+      end
+    end
   end
 end

data/lib/cardio/utils.rb

@@ -2,8 +2,18 @@ module Cardio
   # Utilities that may need to be run even when mods are not loaded.
   module Utils
     class << self
+      def empty_trash
+        delete_trashed_files
+        Card.where(trash: true).in_batches.update_all(left_id: nil, right_id: nil)
+        Card.where(trash: true).in_batches.delete_all
+        Card::Action.delete_cardless
+        Card::Change.delete_actionless
+        Card::Act.delete_actionless
+        Card::Reference.clean
+      end
+
       def seed_test_db
-        system "env RAILS_ENV=test bundle exec rake db:fixtures:load"
+        system "env RAILS_ENV=test bundle exec rake db:seed:replant"
       end
 
       # deletes tmp directory within files directory
@@ -20,6 +30,23 @@ module Cardio
 
       private
 
+      # deletes any file not associated with a real card.
+      def delete_trashed_files
+        dir = Cardio.paths["files"].existent.first
+        # TODO: handle cloud files
+        return unless dir
+
+        (all_trashed_card_ids & all_file_ids).each do |file_id|
+          delete_files_with_id dir, file_id
+        end
+      end
+
+      def delete_files_with_id dir, file_id
+        raise Card::Error, t(:core_exception_almost_deleted) if Card.exists?(file_id)
+
+        ::FileUtils.rm_rf "#{dir}/#{file_id}", secure: true
+      end
+
       def delete_tmp_files id=nil
         dir = [files_dir, "tmp", id.to_s].compact.join "/"
         FileUtils.rm_rf dir, secure: true
@@ -28,6 +55,17 @@ module Cardio
       def files_dir
         @files_dir ||= Cardio.paths["files"].existent.first
       end
+
+      def all_file_ids
+        dir = Card.paths["files"].existent.first
+        Dir.entries(dir)[2..-1].map(&:to_i)
+      end
+
+      def all_trashed_card_ids
+        trashed_card_sql = %( select id from cards where trash is true )
+        sql_results = Card.connection.select_all(trashed_card_sql)
+        sql_results.map(&:values).flatten.map(&:to_i)
+      end
     end
   end
 end

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/deck_generator.rb

@@ -1,4 +1,5 @@
 require "rails/generators/app_base"
+require "cardio/generators/deck_generator_loader"
 
 module Cardio
   module Generators
@@ -11,6 +12,8 @@ module Cardio
         include RailsOverrides
         include DeckHelper
 
+        extend ClassMethods
+
         source_root File.expand_path("templates", __dir__)
 
         # All but the first aliases should be considered deprecated
@@ -28,7 +31,7 @@ module Cardio
                      type: :string, aliases: %w[-R -g --gem-path],
                      default: "", group: :runtime,
                      desc: "Path to local decko repository " \
-                           "(Default, use env DECKO_REPO_PATH)"
+                           "(Can also set via DECKO_REPO_PATH)"
 
         class_option :database,
                      type: :string, aliases: %w[-D -d], default: "mysql",
@@ -43,7 +46,7 @@ module Cardio
         public_task :create_root
 
         def self.banner
-          "decko new #{arguments.map(&:usage).join(' ')} [options]"
+          "#{banner_command} new #{arguments.map(&:usage).join(' ')} [options]"
         end
 
         # Generator works its way through each public method below

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

data/lib/generators/deck/templates/config/puma.rb

@@ -5,7 +5,7 @@ threads min_threads_count, max_threads_count
 
 preload_app!
 
-rackup      DefaultRackup
+# rackup      DefaultRackup
 port        ENV["PORT"]     || 3000
 environment ENV["RACK_ENV"] || "development"
 

data/lib/generators/deck/templates/script/decko_rspec

@@ -4,5 +4,5 @@
 ENV["RAILS_ENV"] = "test"
 ENV["RAILS_ROOT"] = "."
 BUNDLE_GEMFILE = File.expand_path "../../Gemfile",  __FILE__
-ARGV.insert 0, "rspec", "--no-simplecov", "--"
+ARGV.insert 0, "rspec", "--"
 load File.expand_path("../decko",  __FILE__)

data/lib/generators/deck/templates/simplecov.rb.erb

@@ -1,5 +1,5 @@
 
-if ENV["<%= 'REPO_' if platypus? %>TMPSETS"] && ENV["COVERAGE"] != "false"
+if (ENV["CARD_LOAD_STRATEGY"] == "tmp_files") && ENV["CARD_SIMPLECOV"] != "false"
   SimpleCov.start do
     def add_mod_groups dir_pattern
       Dir[dir_pattern].each do |path|
@@ -9,18 +9,20 @@ if ENV["<%= 'REPO_' if platypus? %>TMPSETS"] && ENV["COVERAGE"] != "false"
     end
     <% if platypus? %>
     root "<%= expanded_repo_path %>"
+    add_mod_groups "#{root}/{card/,}/mod/*"
+
+    add_group "Cardname", "cardname/lib"
+    add_group "Card", "card/lib"
+    add_group "Decko", "decko/lib"
+    add_group "Set Patterns", "tmp/set_pattern"
 
     add_filter "/generators/"
     add_filter "_spec_helper"
-    add_filter "test_seed"
-
-    add_group "Card", "card/"
-    add_group "Cardname", "cardname"
-    add_group "Decko", "decko"
-
-    add_mod_groups "#{root}/{card/,}/mod/*"
     <% else %>
     add_mod_groups "mod/*"
+
+    add_filter "tmp/set/gem"
+    add_filter "tmp/set_pattern"
     <% end %>
     add_filter "/spec/"
     add_filter "/features/"

data/lib/generators/mod/USAGE

@@ -2,7 +2,7 @@ Description:
     Generates new mod
 
 Example:
-    <%= banner_command %> generate card:mod clothing
+    <%= banner_command %> generate mod clothing
 
     This will create:
 

data/lib/generators/set/USAGE

@@ -2,7 +2,7 @@ Description:
     Generates new set files in mods and matching specs.
 
 Examples:
-    <%= banner_command %> generate card:set clothing type tshirt
+    <%= banner_command %> generate set clothing type tshirt
 
     This will create:
 
@@ -17,7 +17,7 @@ Examples:
                 tshirt_spec.rb
 
 
-    <%= banner_command %> generate card:set clothing type_plus_right basic about tshirt
+    <%= banner_command %> generate set clothing type_plus_right basic about tshirt
 
     This will create: