card 1.104.1 → 1.105.0

data/lib/cardio/migration.rb

@@ -1,7 +1,7 @@
 # -*- encoding : utf-8 -*-
 
 module Cardio
-  class Migration < ActiveRecord::Migration[4.2]
+  class Migration < ActiveRecord::Migration[6.1]
     include Card::Model::SaveHelper unless ENV["NO_CARD_LOAD"]
     @type = :deck_cards
 
@@ -47,7 +47,8 @@ module Cardio
         migration_context do |mc|
           versions = mc.migrations.map(&:version)
           migrated = mc.get_all_versions
-          mark_as_migrated versions - migrated
+          to_mark = versions - migrated
+          mark_as_migrated to_mark if to_mark.present?
         end
       end
 
@@ -83,53 +84,6 @@ module Cardio
       end
     end
 
-    # def disable_ddl_transaction #:nodoc:
-    #   true
-    # end
-
-    def import_json filename, merge_opts={}
-      Card::Mailer.perform_deliveries = false
-      output_file = File.join data_path, "unmerged_#{filename}"
-      merge_opts[:output_file] ||= output_file
-      Card.merge_list read_json(filename), merge_opts
-    end
-
-    def import_cards filename, merge_opts={}
-      Card::Mailer.perform_deliveries = false
-      output_file = File.join data_path, "unmerged_#{filename}"
-      merge_opts[:output_file] ||= output_file
-      meta_data = JSON.parse(File.read(data_path(filename)))
-      full_data =
-        meta_data.map do |hash|
-          hash["content"] =
-            File.read data_path(File.join("cards", hash["name"].to_name.key))
-          hash
-        end
-      Card.merge_list full_data, merge_opts
-    end
-
-    # uses the data in cards.yml and the card content in db/migrate_cards/data/cards
-    # to update or create the cards given by name or key in names_or_keys
-    def merge_cards names_or_keys
-      names_or_keys = Array(names_or_keys)
-      Card::Mailer.perform_deliveries = false
-
-      Migration::Import.new(data_path).merge only: names_or_keys
-    end
-
-    def merge_pristine_cards names_or_keys
-      names_or_keys = Array(names_or_keys)
-
-      pristine = names_or_keys.select { |n| !Card.exists?(n) || Card.fetch(n)&.pristine? }
-      merge_cards pristine
-    end
-
-    def read_json filename
-      raw_json = File.read data_path(filename)
-      json = JSON.parse raw_json
-      json.is_a?(Hash) ? json["card"]["value"] : json
-    end
-
     def data_path filename=nil
       self.class.data_path filename
     end
@@ -154,10 +108,6 @@ module Cardio
     def down
       raise ActiveRecord::IrreversibleMigration
     end
-
-    def update_machine_output
-      Card.search(right: { codename: "machine_output" }).each(&:delete)
-    end
   end
 end
 

data/lib/cardio/mod/class_methods.rb

@@ -1,3 +1,5 @@
+require "cardio/mod/dirs"
+
 module Cardio
   class Mod
     # class methods for Cardio::Mod
@@ -32,17 +34,20 @@ module Cardio
       def ensure_uninstalled
         missing.each do |mod_card|
           Card::Auth.as_bot do
-            Card[:all, :style].drop_item mod_card
             delete_auto_installed_cards mod_card
           end
         end
       end
 
       def ensure_installed
-        Card::Cache.reset_all
-        puts "installing card mods".green
-        Cardio.mods.each(&:ensure)
-        Card::Assets.refresh_assets force: true
+        Card::Auth.as_bot do
+          Card::Cache.reset_all
+          puts "installing card mods".green
+          ensure_asset_lists do |hash|
+            puts "ensuring mod and asset cards"
+            Cardio.mods.each { |mod| ensure_asset_cards mod.ensure_card, hash }
+          end
+        end
       end
 
       def dependencies name, nickname=true
@@ -53,11 +58,6 @@ module Cardio
         (dep_names << spec).flatten.compact.uniq
       end
 
-      def each_path &block
-        each_simple_path(&block)
-        each_gem_path(&block)
-      end
-
       # @return [Hash] in the form{ modname(String) => Gem::Specification }
       def gem_specs
         Bundler.definition.specs.each_with_object({}) do |gem_spec, h|
@@ -67,6 +67,22 @@ module Cardio
 
       private
 
+      def ensure_asset_cards modcard, hash
+        %i[script style].each do |asset_type|
+          hash[asset_type] << modcard.ensure_mod_asset_card(asset_type)
+        end
+      end
+
+      def ensure_asset_lists
+        hash = { script: [], style: [] }
+        yield hash
+        # puts "updating asset lists"
+        Card[:all, :script].update! content: hash[:script].compact
+        Card[:style_mods].update! content: hash[:style].compact
+        # puts "refreshing assets"
+        Card::Assets.refresh force: true
+      end
+
       # it would be nice if this were easier...
       def delete_auto_installed_cards mod_card
         auto_installed_cards(mod_card).each do |card|
@@ -89,18 +105,6 @@ module Cardio
         gem_spec?(spec) ? spec : nil
       end
 
-      def each_simple_path &block
-        Cardio.paths["mod"].each do |mods_path|
-          Dir.glob("#{mods_path}/*").each(&block)
-        end
-      end
-
-      def each_gem_path
-        gem_specs.each_value do |spec|
-          yield spec.full_gem_path
-        end
-      end
-
       # @return [True/False]
       def gem_spec? spec
         return unless spec

data/lib/cardio/mod/dirs.rb

@@ -52,34 +52,27 @@ module Cardio
         @mods = []
         @mods_by_name = {}
         @loaded_gem_mods = ::Set.new
-        mod_paths = Array(mod_paths)
-        mod_paths.each do |mp|
+        add_core_mods
+        add_gem_mods
+        Array(mod_paths).each do |mp|
           @current_path = mp
-          load_from_modfile || load_from_dir
+          add_from_modfile || add_from_dir
         end
-        load_from_gemfile
         super()
-        @mods.each do |mod|
-          self << mod.path
-        end
-      end
-
-      def add_gem_mod mod_name, mod_path
-        return if @loaded_gem_mods.include?(mod_name)
-
-        @loaded_gem_mods << mod_name
-        add_mod mod_name, mod_path
+        @mods.each { |mod| self << mod.path }
       end
 
       # Add a mod to mod load paths
-      def add_mod mod_name, path=nil
+      def add_mod mod_name, path: nil, group: nil
         if @mods_by_name.key? Mod.normalize_name(mod_name)
           raise ::Card::Error,
                 "name conflict: mod with name \"#{mod_name}\" already loaded"
         end
 
         path ||= File.join @current_path, mod_name
-        mod = Mod.new mod_name, path, @mods.size
+        group ||= @current_group
+
+        mod = Mod.new mod_name, path, group, @mods.size
         @mods << mod
         @mods_by_name[mod.name] = mod
       end
@@ -142,15 +135,29 @@ module Cardio
         end
       end
 
-      def load_from_gemfile
-        Cardio::Mod.gem_specs.each do |mod_name, mod_spec|
-          add_gem_mod mod_name, mod_spec.full_gem_path
+      private
+
+      def add_gem_mods
+        Cardio::Mod.gem_specs.each do |mod_name, spec|
+          add_gem_mod mod_name, spec.full_gem_path, spec.metadata["card-mod-group"]
         end
       end
 
-      private
+      def add_gem_mod mod_name, mod_path, group
+        return if @loaded_gem_mods.include?(mod_name)
+
+        @loaded_gem_mods << mod_name
+        add_mod mod_name, path: mod_path, group: (group || "gem")
+      end
+
+      def add_core_mods
+        @current_path = File.join Cardio.gem_root, "mod"
+        @current_group = "gem-card"
+        add_from_dir
+        @current_group = nil
+      end
 
-      def load_from_modfile
+      def add_from_modfile
         modfile_path = File.join @current_path, "Modfile"
         return unless File.exist? modfile_path
 
@@ -159,7 +166,7 @@ module Cardio
         true
       end
 
-      def load_from_dir
+      def add_from_dir
         Dir.entries(@current_path).sort.each do |filename|
           add_mod filename unless filename.match?(/^\./)
         end

data/lib/cardio/mod/eat/edibles.rb

@@ -27,14 +27,14 @@ module Cardio
 
         # @return [Array <Hash>]
         def mod_edibles mod
-          environments.map { |env| items_for_environment mod, env }.compact
+          pod_types.map { |type| items_for_type mod, type }.compact
         end
 
-        def items_for_environment mod, env
-          return unless (items = items_from_yaml mod, env)
+        def items_for_type mod, type
+          return unless (items = items_from_yaml mod, type)
 
           items = items.map do |item|
-            item.is_a?(String) ? items_from_yaml(mod, env, item) : item
+            item.is_a?(String) ? items_from_yaml(mod, type, item) : item
           end.flatten.compact
           interpret_items mod, items
         end
@@ -43,8 +43,8 @@ module Cardio
           each_card_hash(items) { |hash| handle_attachments mod, hash }
         end
 
-        def items_from_yaml mod, env, filename=nil
-          source = "#{env}#{'/' if filename.present?}#{filename}.yml"
+        def items_from_yaml mod, type, filename=nil
+          source = "#{type}#{'/' if filename.present?}#{filename}.yml"
           return unless (path = mod.subpath "data", source)
 
           YAML.load_file path
@@ -54,7 +54,7 @@ module Cardio
         def each_card_hash items
           items.each do |item|
             yield item
-            item[:subfields]&.values&.each { |val| yield val if val.is_a? Hash }
+            item[:fields]&.values&.each { |val| yield val if val.is_a? Hash }
           end
           items
         end
@@ -71,20 +71,27 @@ module Cardio
         end
 
         def mod_file mod, filename
-          File.open mod.subpath("data/files", filename)
+          unless (mod_file_path = mod.subpath "data/files", filename)
+            raise StandardError, "#{filename} not found. "\
+                                 "Should be in data/files in #{mod.name} mod."
+          end
+          File.open mod_file_path
         end
 
         def attachment_keys
           @attachment_keys ||= Card.uploaders.keys
         end
 
-        # @return [Array <Symbol>]
-        # holarchical. each includes the previous
-        # production = [:production],
-        # development = [:production, :development], etc.
-        def environments
-          index = DATA_ENVIRONMENTS.index(@env&.to_sym || Rails.env.to_sym) || -1
-          DATA_ENVIRONMENTS[0..index]
+        def pod_types
+          if @pod_type == :all
+            %i[real test]
+          elsif @pod_type
+            [@pod_type]
+          elsif Rails.env.test?
+            %i[real test]
+          else
+            [:real]
+          end
         end
       end
     end

data/lib/cardio/mod/eat.rb

@@ -1,8 +1,6 @@
 require "timecop"
+# require "pry"
 
-require "pry"
-
-DATA_ENVIRONMENTS = %i[production development test].freeze
 ENV["STORE_CODED_FILES"] = "true"
 
 module Cardio
@@ -11,25 +9,22 @@ module Cardio
     # (list of card attributes)
     # https://docs.google.com/document/d/13K_ynFwfpHwc3t5gnLeAkZJZHco1wK063nJNYwU8qfc/edit#
     class Eat
-      include Card::Model::SaveHelper
       include Edibles
 
-      def initialize mod: nil, env: nil, user: nil, verbose: nil
+      def initialize mod: nil, type: nil, user: nil, verbose: nil
         @mod = mod
-        @env = env
+        @pod_type = type&.to_sym
         @user_id = user&.card_id
         @verbose = !verbose.nil?
       end
 
       def up
-        Card::Cache.reset_all
-        Card::Mailer.perform_deliveries = false
-        Card::Auth.as_bot do
+        handle_up do
           edibles.each do |edible|
             track edible do
               current_user edible.delete(:user)
               time_machine edible.delete(:time) do
-                ensure_card edible
+                Card.ensure edible
               end
             end
           end
@@ -38,21 +33,30 @@ module Cardio
 
       private
 
+      # if output mod given,
+      def handle_up
+        Card::Cache.reset_all
+        Card::Mailer.perform_deliveries = false
+        Card::Auth.as_bot { yield }
+        :success
+      rescue StandardError => e
+        e.message
+      end
+
       def track edible
         rescuing edible do
-          # puts "eat: #{edible}" if @verbose
+          # puts "eating: #{edible}" if @verbose
           card = yield
-          puts "eaten: #{card.name}".green # if @verbose
+          puts "eaten: #{card.name}".cyan if @verbose
         end
       end
 
       def rescuing edible
         yield
       rescue StandardError => e
-        # binding.pry
         puts edible
         puts e.message.red
-        puts e.backtrace.join("\n") if @verbose
+        puts e.backtrace[0..10].join("\n") if @verbose
       end
 
       def current_user item_user

data/lib/cardio/mod/load_strategy/set_tmp_files.rb

@@ -9,7 +9,7 @@ module Cardio
           return unless prepare_tmp_dir "tmp/set"
 
           mod_dirs.each_with_tmp(:set) do |mod_dir, mod_tmp_dir|
-            Dir.mkdir mod_tmp_dir
+            FileUtils.mkdir_p mod_tmp_dir
             Dir.glob("#{mod_dir}/**/*.rb").each do |abs_path|
               rel_path = abs_path.sub "#{mod_dir}/", ""
               tmp_filename = File.join mod_tmp_dir, rel_path

data/lib/cardio/mod/load_strategy.rb

@@ -1,5 +1,15 @@
 module Cardio
   class Mod
+    # The main way to enhance cards' appearance and behavior is through the card set DSL.
+    #
+    # The default mechanism for loading DSL code is live evaluation, or Eval. Eval is
+    # fast and efficient and preferred for a wide range of scenarios, including
+    # production and live debugging. But Eval is problematic for generating both test
+    # coverage reports with Simplecov and documentation sites with YARD.
+    #
+    # For those two reasons, we make it possible to load the DSL code by generating
+    # fully explicit ruby modules in tmp files.
+    #
     # Shared code for the three different load strategies: Eval, TmpFiles and BindingMagic
     class LoadStrategy
       class << self
@@ -7,9 +17,9 @@ module Cardio
 
         def class_for_set strategy
           case strategy
-          when :tmp_files     then SetTmpFiles
+          when :tmp_files then SetTmpFiles
           when :binding_magic then SetBindingMagic
-          else                     Eval
+          else Eval
           end
         end
 

data/lib/cardio/mod/modfile_api.rb

@@ -2,26 +2,26 @@ module Cardio
   class Mod
     # Methods used via "eval" in Modfiles
     module ModfileApi
-      def mod mod_name, path=nil
-        @dirs.add_mod mod_name, path
+      def mod *args
+        @dirs.add_mod(*args)
       end
 
-      def gem_mod name
-        deps = Mod.dependencies name
-        unknown_gem_mod!(name) if deps.blank?
-        deps.each { |spec| @dirs.add_gem_mod spec.name, spec.full_gem_path }
-      end
-
-      # load all gem mods
-      def gem_mods
-        @dirs.load_from_gemfile
-      end
-
-      private
-
-      def unknown_gem_mod! name
-        raise Card::Error, %(Unknown gem "#{name}". Make sure it is in your Gemfile.)
-      end
+      # def gem_mod name
+      #   deps = Mod.dependencies name
+      #   unknown_gem_mod!(name) if deps.blank?
+      #   deps.each { |spec| @dirs.add_gem_mod spec.name, spec.full_gem_path }
+      # end
+      #
+      # # add all gem mods
+      # def gem_mods
+      #   @dirs.add_from_gemfile
+      # end
+      #
+      # private
+      #
+      # def unknown_gem_mod! name
+      #   raise Card::Error, %(Unknown gem "#{name}". Make sure it is in your Gemfile.)
+      # end
     end
   end
 end

data/lib/cardio/mod/{poop.rb → sow.rb}

@@ -1,18 +1,15 @@
 module Cardio
   class Mod
-    # POOP (or Plain Old OutPut) is our nickname for our standard card YAML,
-    # used to define cards associated with mods.
-    #
-    # Monkeys throw it around, and Sharks can eat it (if you believe this guy:
-    # https://www.youtube.com/watch?v=VvEa4NSqw7I).
+    # The Sow class is for exporting data to mods' data directories so that they can
+    # be used as seed data when the mod is installed.
     #
     # https://docs.google.com/document/d/13K_ynFwfpHwc3t5gnLeAkZJZHco1wK063nJNYwU8qfc/edit#
-    class Poop
+    class Sow
       def initialize **args
         @mod = args[:mod]
         @name = args[:name]
         @cql = args[:cql]
-        @env = args[:env] || Rails.env
+        @env = args[:env] || (Rails.env.test? ? :test : :production)
         @items = args[:items]
         @field_tags = args[:field_tags]
       end
@@ -65,17 +62,14 @@ module Cardio
 
       def cards_from_name
         case @items
-        when :only
-          item_cards
-        when true
-          main_cards + item_cards
-        else
-          main_cards
+        when :only then item_cards
+        when true  then main_cards + item_cards
+        else            main_cards
         end
       end
 
       def item_cards
-        main_cards.map { |mc| mc.item_cards }.flatten
+        main_cards.map(&:item_cards).flatten
       end
 
       def main_cards
@@ -116,13 +110,11 @@ module Cardio
       end
 
       def target
-        @target ||= old_data
+        @target ||= (old_data || nil)
       end
 
       def old_data
-        return nil unless File.exist? filename
-
-        YAML.safe_load File.read(filename), [Symbol]
+        YAML.safe_load File.read(filename), [Symbol] if File.exist? filename
       end
 
       # @return Path

data/lib/cardio/mod.rb

@@ -10,17 +10,16 @@ module Cardio
   #
   #     decko generate card:mod MOD_NAME
   #
-  # This will create the following directories:
+  # This will create a directory following the pattern `DECK_NAME/mod/MOD_NAME`. This
+  # directory contains all the specifications of your mod. By default that includes
+  # a README.md file and the following subdirectories:
   #
-  #     DECK_NAME/mod/MOD_NAME
-  #     DECK_NAME/mod/MOD_NAME/lib
-  #     DECK_NAME/mod/MOD_NAME/public
-  #     DECK_NAME/mod/MOD_NAME/set
-  #
-  # The lib directory contains libraries, of course. And files in the public directory
-  # are public and served directly.
-  #
-  # But in most mods, the focal point is the *set* directory.
+  # - **assets** - for JavaScript, CSS, and variants (CoffeeScript, SCSS, etc)
+  # - **data** - for seed and test data. see {file:SEEDME.md}.
+  # - **lib** - for standard code libraries
+  # - **public** - accessible via the web at DECK_URL_ROOT/mod/MOD_NAME/
+  # - **set** - the mod's focal point where card sets are configured (see below)
+  # - **spec** - for rspec tests
   #
   # ## Set Modules
   #
@@ -64,16 +63,17 @@ module Cardio
   class Mod
     extend ClassMethods
 
-    attr_reader :name, :path, :index
+    attr_reader :name, :path, :group, :index
 
-    def initialize name, path, index
+    def initialize name, path, group, index
       @name = Mod.normalize_name name
       @path = required_path path
+      @group = group || :custom
       @index = index
     end
 
     def mod_card_name
-      "mod: #{name}"
+      "mod: #{name.tr '_', ' '}"
     end
 
     def codename
@@ -86,16 +86,17 @@ module Cardio
     end
 
     def tmp_dir type
-      File.join Cardio.paths["tmp/#{type}"].first,
+      File.join Cardio.paths["tmp/#{type}"].first, @group.to_s,
                 "mod#{'%03d' % (@index + 1)}-#{@name}"
     end
 
-    def ensure
-      Card::Auth.as_bot do
-        card = ensure_card
-        card.ensure_mod_script_card
-        card.ensure_mod_style_card
-        Card::Cache.reset_all
+    def ensure_card
+      if Card::Codename.exists? codename
+        card = Card.fetch codename.to_sym
+        card.update type: :mod unless card.type_code == :mod
+        card
+      else
+        Card.create name: mod_card_name, type: :mod, codename: codename
       end
     end
 
@@ -106,15 +107,5 @@ module Cardio
 
       raise Card::Error::NotFound, "mod not found: #{@name}"
     end
-
-    def ensure_card
-      if Card::Codename.exists? codename
-        card = Card.fetch codename.to_sym
-        card.update type: :mod unless card.type_code == :mod
-        card
-      else
-        Card.create name: mod_card_name, type: :mod, codename: codename
-      end
-    end
   end
 end