card 1.105.0 → 1.105.1

data/lib/card.rb

@@ -47,7 +47,7 @@ ActiveSupport.run_load_hooks(:before_card, self)
 #       @card.type_code    # returns codename of type card [Symbol]
 #       @card.type_card    # returns Cardtype card associated with @card's type [Card]
 #
-# {file:mod/core/set/all/type.rb Common type methods}
+#   - {Set::All::Type Common type methods}
 #
 # ## Content
 #
@@ -57,9 +57,8 @@ ActiveSupport.run_load_hooks(:before_card, self)
 #       @card.content      # the "official" content, which may be different from
 # db_content when db_content is overridden with a structure rule.
 #
-# {Card::Content Processing card content}
-#
-# {file:mod/core/set/all/content.rb Common content methods}
+#   - {Content Processing card content}
+#   - {Set::All::Content Common content methods}
 #
 # ## Fetch
 #
@@ -68,15 +67,35 @@ ActiveSupport.run_load_hooks(:before_card, self)
 #
 # Any of the above marks (name, key, id, codename) can be used to fetch a card, eg:
 #
-#      @card = Card.fetch "Garden" # returns the card with the name "Garden" (or, more
+#      @card1 = Card.fetch "Garden" # returns the card with the name "Garden" (or, more
 # precisely, with the key "garden")
-#      @card = Card.fetch 100      # returns the card with the id 100
-#      @card = Card.fetch :help    # returns the card with the codename help
+#      @card2 = Card.fetch 100      # returns the card with the id 100
+#      @card3 = Card.fetch :help    # returns the card with the codename help
 #
 # The fetch API will first try to find the card in the cache and will only look in the
 # database if necessary.
 #
-# {file:mod/core/set/all/fetch.rb More on fetching.}
+# The `Card[]` shortcut will return the same results but does not support the full range
+# of advanced options and will not return virtual cards
+# (cards that can be constructed from naming patterns but are not actually in the
+# database).
+#
+#      # equivalent to the above but more concise
+#      @card1 = Card["Garden"]
+#      @card2 = Card[100]
+#      @card3 = Card[:help]
+#
+# Better still, you can use the `#card` method on Strings, Integers, Symbols, and Arrays
+#
+#      # equivalent to the above but even more concise
+#      @card1 = "Garden".card
+#      @card2 = 100.card
+#      @card3 = :help.card
+#
+# The `#card_id`, `#cardname`, and `#codename` methods work on all the same objects and
+# provide convenient shortcuts for quickly fetching and returning card attributes.
+#
+#   - {Card::Fetch::CardClass More on fetching.}
 #
 # ## Query
 #
@@ -84,7 +103,7 @@ ActiveSupport.run_load_hooks(:before_card, self)
 #
 #       Card.search type_id: 4 # returns an Array of cards with the type_id of 4.
 #
-# {Card::Query More on queries}
+#   - {Card::Query More on queries}
 #
 # ## Views and Events
 #
@@ -95,9 +114,8 @@ ActiveSupport.run_load_hooks(:before_card, self)
 # Both views and events are defined in {Cardio::Mod mods}, short for modules or
 # modifications.
 #
-# {Card::Set::Format::AbstractFormat More on views}
-#
-# {Card::Set::Event::Api More on events}
+#   - {Set::Format::AbstractFormat#view More on views}
+#   - {Set::Event::Api#event More on events}
 #
 # ## Accounts and Permissions
 #

data/lib/cardio/command/custom.rb

@@ -9,6 +9,7 @@ module Cardio
 
       def run_new
         if !["-h", "--help"].intersection(args).empty?
+          ARGV.unshift "new"
           require "cardio/command/application"
         else
           puts "Can't initialize a new deck within the directory of another, " \

data/lib/cardio/command/rake_command.rb

@@ -14,7 +14,7 @@ module Cardio
         # else
         #   opts = args
         # end
-        # @envs = Array(opts[:envs])
+        # # @envs = Array(opts[:envs])
       end
 
       def run

data/lib/cardio/command/rspec_command/parser.rb

@@ -9,21 +9,22 @@ module Cardio
       class Parser < OptionParser
         RSPEC_PATH_MESSAGE = <<~MESSAGE.freeze
 
-          DECKO ARGS
+          #{Command.bin_name.upcase} ARGS
 
           You don't have to give a full path for FILENAME; the basename is enough.
           If FILENAME does not include '_spec', then rspec searches for the
-          corresponding spec file.
-          The line number always refers to the example in the spec file.
+          corresponding spec file. The line number always refers to the example in the
+          spec file.
 
         MESSAGE
 
         RSPEC_BANNER = <<~BANNER.freeze
 
-          Usage: decko rspec [DECKO ARGS] -- [RSPEC ARGS]
+          Usage: #{Command.bin_name} rspec [#{Command.bin_name.upcase} ARGS] -- [RSPEC ARGS]
 
           RSPEC ARGS
 
+          See https://relishapp.com/rspec/rspec-core/docs/command-line
         BANNER
 
         DESC = {
@@ -90,6 +91,8 @@ module Cardio
         end
 
         def find_mod_file filename, base_dir
+          # FIXME: - use Cardio::Mod lookup
+
           if File.exist?("mod/#{filename}") || File.exist?("#{base_dir}/mod/#{filename}")
             "#{base_dir}/mod/#{filename}"
           elsif (files = find_spec_file(filename, "mod"))&.present?

data/lib/cardio/generators.rb

@@ -50,7 +50,7 @@ module Rails
       end
 
       def help command="generate"
-        caller = Command.bin_name
+        caller = Cardio::Command.bin_name
         puts "Usage:"
         puts "  #{caller} #{command} GENERATOR [args] [options]".green
         puts

data/lib/cardio/mod/class_methods.rb

@@ -27,12 +27,12 @@ module Cardio
         name.to_s.sub(/^card-mod-/, "")
       end
 
-      def missing
+      def leftover
         Card.search(type: :mod).reject { |mod_card| fetch mod_card.modname }
       end
 
       def ensure_uninstalled
-        missing.each do |mod_card|
+        leftover.each do |mod_card|
           Card::Auth.as_bot do
             delete_auto_installed_cards mod_card
           end

data/lib/cardio/mod/dirs.rb

@@ -65,7 +65,7 @@ module Cardio
       # Add a mod to mod load paths
       def add_mod mod_name, path: nil, group: nil
         if @mods_by_name.key? Mod.normalize_name(mod_name)
-          raise ::Card::Error,
+          raise StandardError,
                 "name conflict: mod with name \"#{mod_name}\" already loaded"
         end
 

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

@@ -6,11 +6,31 @@ module Cardio
         # list of card attribute hashes
         # @return [Array <Hash>]
         def edibles
-          mods_with_data.map { |mod| mod_edibles mod }.flatten
+          explicit_edibles { mods_with_data.map { |mod| mod_edibles mod }.flatten }
         end
 
         private
 
+        def explicit_edibles
+          return yield unless @name
+
+          yield.reject do |edible|
+            if @name.match?(/^\:/)
+              explicit_codename_match? edible[:codename]
+            else
+              explicit_name_match? edible[:name]
+            end
+          end
+        end
+
+        def explicit_codename_match? codename
+          codename && (codename == @name[1..-1])
+        end
+
+        def explicit_name_match? name
+          name && (name.to_name == @name.to_name)
+        end
+
         # if mod is specified, consider only that mod
         # @return [Array <Cardio::Mod>]
         def mods_with_data

data/lib/cardio/mod/eat.rb

@@ -11,9 +11,10 @@ module Cardio
     class Eat
       include Edibles
 
-      def initialize mod: nil, type: nil, user: nil, verbose: nil
+      def initialize mod: nil, podtype: nil, user: nil, verbose: nil, name: nil
         @mod = mod
-        @pod_type = type&.to_sym
+        @pod_type = podtype&.to_sym
+        @name = name
         @user_id = user&.card_id
         @verbose = !verbose.nil?
       end
@@ -24,6 +25,7 @@ module Cardio
             track edible do
               current_user edible.delete(:user)
               time_machine edible.delete(:time) do
+                # binding.pry if edible[:type] == :link_list
                 Card.ensure edible
               end
             end

data/lib/cardio/mod/modfile_api.rb

@@ -2,8 +2,8 @@ module Cardio
   class Mod
     # Methods used via "eval" in Modfiles
     module ModfileApi
-      def mod *args
-        @dirs.add_mod(*args)
+      def mod modname, **args
+        @dirs.add_mod modname, **args
       end
 
       # def gem_mod name

data/lib/cardio/mod/sow.rb

@@ -9,14 +9,27 @@ module Cardio
         @mod = args[:mod]
         @name = args[:name]
         @cql = args[:cql]
-        @env = args[:env] || (Rails.env.test? ? :test : :production)
+        @podtype = args[:podtype] || (Rails.env.test? ? :test : :real)
         @items = args[:items]
         @field_tags = args[:field_tags]
       end
 
+      # if output mod given,
+      def out
+        Card::Cache.reset_all
+        @mod ? dump : puts(new_data.to_yaml.yellow)
+        :success
+      rescue Card::Error::NotFound => e
+        e.message
+      rescue JSON::ParserError => e
+        e.message
+      end
+
+      private
+
       # @return [Array <Hash>]
       def new_data
-        @new_data ||= cards.map { |c| c.export_hash field_tags: field_tag_marks }
+        @new_data ||= cards.map { |c| c.pod_hash field_tags: field_tag_marks }
       end
 
       def field_tag_marks
@@ -27,18 +40,7 @@ module Cardio
 
       # @return [String] -- MOD_DIR/data/ENVIRONMENT.yml
       def filename
-        @filename ||= File.join mod_path, "#{@env}.yml"
-      end
-
-      # if output mod given,
-      def out
-        Card::Cache.reset_all
-        @mod ? dump : puts(new_data.to_yaml.yellow)
-        :success
-      rescue Card::Error::NotFound => e
-        e.message
-      rescue JSON::ParserError => e
-        e.message
+        @filename ||= File.join mod_path, "#{@podtype}.yml"
       end
 
       # write yaml to file
@@ -48,8 +50,6 @@ module Cardio
         puts "#{filename} now contains #{hash.size} items".green
       end
 
-      private
-
       def cards
         if @name
           cards_from_name

data/lib/cardio/mod.rb

@@ -1,65 +1,44 @@
 require "cardio/mod/class_methods"
 
 module Cardio
-  # A Card Mod (short for "module" or "modification") is a discrete piece of Decko
-  # functionality. Mods are how the Decko community develops and shares code.
-  # If you want to customize a deck in a way that can't be done on the site itself,
+  # A Card Mod (short for "module" or "modification") is a library containing discrete
+  # chunk of card functionality. Mods are how the Decko community develops and shares
+  # code. If you want to customize a deck in a way that can't be done on the site itself,
   # try a mod.
   #
   # The simplest way to add a mod is to run this command in your deck:
   #
-  #     decko generate card:mod MOD_NAME
+  #     card generate mod MOD_NAME
+  #
+  #     # or, for short:
+  #     card g mod MOD_NAME
   #
   # 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:
-  #
-  # - **assets** - for JavaScript, CSS, and variants (CoffeeScript, SCSS, etc)
-  # - **data** - for seed and test data. see {file:SEEDME.md}.
-  # - **lib** - for standard code libraries
+  # a README.md file and the subdirectories in **bold** below:
+  #
+  # - {file:mod/assets/README.md **assets**}
+  #   - **script** - JavaScript, CoffeeScript, etc
+  #   - **style** - CSS, SCSS, etc
+  # - **config**
+  #    - **early** ruby init files loaded before Card
+  #    - **late** ruby init files loaded after Card
+  #    - **locales** i18n yml files
+  # - {file:SEEDME.md **data**} - seed and test data.
+  # - **lib** - standard ruby libraries
+  #   - task - rake tasks
   # - **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
-  #
-  # Set modules define methods for a given set of cards and their format objects.
-  # They are defined in a mod's _set_ directory. For example, suppose you've created a
-  # mod that called *biz*, your deck has Company cards, and you want to extend the
-  # behavior of those cards.
-  #
-  # You can add a set module like so:
-  #
-  #       decko generate set biz type company
-  #
-  # This will create the following two files:
-  #
-  #       mod/biz/set/type/company.rb
-  #       mod/biz/spec/set/type/company.rb
+  # - **{Card::Set set}** - the mod's focal point where card sets are configured
+  # - {Card::Set::Pattern set_pattern} - (advanced) for adding types of sets.
+  # - {file:CONTRIBUTING.md#Testing **spec**} - for rspec tests
+  # - vendor - for external code, especially git submodules
   #
-  # If you would like to break this code into smaller files, you can extend this
-  # pattern into another directory, eg:
-  #
-  #       mod/biz/set/type/company/foo.rb
-  #       mod/biz/set/type/company/bar.rb
-  #
-  # The general pattern can be expressed as follows:
-  #
-  #       DECKNAME/mod/MODNAME/set/SET_PATTERN/ANCHOR[/FREENAME].rb
+  # Mods also often contain a .gemspec file to specify the mod as a ruby gem.
   #
   # Learn more:
-  #   - {Card} introduces card objects
-  #   - {Card::Set} provides an overview of how set modules work
-  #   - {Card::Set::Format} explains the basics of the format API
-  #   - {Card::Set::Format::AbstractFormat} explains the basics of the view definition API
-  #   - {Card::Set::Event::Api} explains the basics of the event API
   #
-  # ## Other Directories
-  #
-  # Other ways your mod can extend Decko functionality include:
-  #   - **set_pattern** for additional {Card::Set::Pattern set patterns},
-  #     or types of sets.
-  #   - **file** for fixed initial card content
+  #   - {Card} introduces card objects
+  #   - {Card::Set} explains of how set modules work
   class Mod
     extend ClassMethods
 
@@ -105,7 +84,10 @@ module Cardio
     def required_path path
       return path if File.exist? path
 
-      raise Card::Error::NotFound, "mod not found: #{@name}"
+      raise StandardError, "mod not found: #{@name}"
+
+      # FIXME: - need non-Card based error class
+      # raise Card::Error::NotFound,
     end
   end
 end

data/lib/cardio/railtie.rb

@@ -80,11 +80,11 @@ module Cardio
 
             p["lib/graph_q_l/types/query.rb"] <<
               "#{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/initializers"] << "#{mod_path}/config/early"
+            p["late/initializers"] << "#{mod_path}/config/late"
             p["lib/tasks"] << "#{mod_path}/lib/tasks"
             p["mod-data"] << "#{mod_path}/data"
-            p["config/locales"] << "#{mod_path}/locales"
+            p["config/locales"] << "#{mod_path}/config/locales"
           end
 
           # Card doesn't use these rails patterns

data/lib/generators/mod/mod_generator.rb

@@ -7,11 +7,10 @@ module Cardio
       def create_mod
         inside mod_path do
           assets_dir
-          init_dir
+          config_dir
           set_dir
           spec_dir
           empty_directory "public"
-          empty_directory "locales"
         end
       end
 
@@ -42,11 +41,12 @@ module Cardio
         end
       end
 
-      def init_dir
-        inside "init" do
-          empty_directory "before"
+      def config_dir
+        inside "config" do
+          # empty_directory "before"
           empty_directory "early"
           empty_directory "late"
+          empty_directory "locales"
         end
       end
     end

data/mod/core/lib/tasks/card/mod.rake

@@ -1,5 +1,6 @@
 namespace :card do
   namespace :mod do
+    desc "list current mods in load order"
     task list: :environment do
       Cardio.mods.each { |m| puts "#{m.name}: #{m.path}".green }
     end
@@ -15,10 +16,12 @@ namespace :card do
       end
     end
 
-    task missing: :environment do
-      Cardio::Mod.missing.each { |m| puts m.modname.yellow }
+    desc "list mods still installed but not configured for use"
+    task leftover: :environment do
+      Cardio::Mod.leftover.each { |m| puts m.modname.yellow }
     end
 
+    desc "uninstall leftover mods"
     task uninstall: :environment do
       Cardio::Mod.ensure_uninstalled
     end

data/mod/core/lib/tasks/card/seed.rake

@@ -1,3 +1,5 @@
+require "colorize"
+
 namespace :card do
   namespace :seed do
     desc "regenerate seed fixtures quickly from current fixtures. " \
@@ -13,7 +15,7 @@ namespace :card do
          "(alias for db:seed:replant)"
     task replant: ["db:seed:replant"]
 
-    desc "finalize seed data with migrations, installations, asset coding, and cleaning"
+    # desc "finalize seed data with migrations, installations, asset coding, and cleaning"
     task polish: :environment do
       ENV["STAMP_MIGRATIONS"] = "true"
 
@@ -22,14 +24,14 @@ namespace :card do
       # It's important NOT to clean the test data and lose history, creator info, etc.
     end
 
-    desc "remove unneeded cards, acts, actions, changes, and references"
+    # desc "remove unneeded cards, acts, actions, changes, and references"
     task clean: :environment do
       Cardio::Seed.clean
       Cardio::Utils.empty_trash
       Card::Cache.reset_all
     end
 
-    desc "dump db to bootstrap fixtures"
+    # desc "dump db to fixtures"
     task dump: :environment do
       Card::Cache.reset_all
       Cardio::Seed.dump
@@ -38,7 +40,7 @@ namespace :card do
     desc "completely regenerate seed fixtures starting with dependee seed fixtures"
     task build: %i[plow polish dump]
 
-    desc "reseed from the fixtures of the dependee seed mod"
+    # desc "reseed from the fixtures of the dependee seed mod"
     task plow: :environment do
       ENV["CARD_UPDATE_SEED"] = "true"
       # tells Cardio::Seed to use fixtures upon which the seeds being updated depend

data/mod/core/lib/tasks/card.rake

@@ -24,8 +24,12 @@ namespace :card do
   task eat: :environment do
     parse_options :eat do
       add_opt :m, :mod, "only eat cards in given mod"
+      add_opt :n, :name, "only eat card with name"
+      # FIXME: - name seems not to work, especially in combination with other options
+
       add_opt :u, :user, "user to credit unless specified (otherwise uses Decko Bot)"
-      add_opt :t, :type, "pod type: real, test, or all"
+      add_opt :p, :podtype, "pod type: real, test, or all " \
+                            "(defaults to all in test env, otherwise real)"
       flag_opt :v, :verbose, "output progress info and error backtraces"
     end
     rake_result(:eat) { Cardio::Mod::Eat.new(**options).up }
@@ -36,10 +40,10 @@ namespace :card do
     parse_options :sow do
       add_opt :n, :name, "export card with name/mark (handles : and ~ prefixes)"
       flag_opt :i, :items, "also export card items (with -n)"
-      flag_opt :o, :only_items, "also export card items (with -n)", items: :only
+      flag_opt :o, :only_items, "only export card items (with -n)", items: :only
       add_opt :c, :cql, "export cards found by CQL (in JSON format)"
-      add_opt :m, :mod, "output yaml to data/environment.yml file in mod"
-      add_opt :e, :env, "environment to dump to (default is current env)"
+      add_opt :m, :mod, "output yaml file in mod"
+      add_opt :p, :podtype, "podtype to dump (real or test. default based on current env)"
       add_opt :t, :field_tags, "comma-separated list of field tag marks"
     end
     rake_result(:sow) { Cardio::Mod::Sow.new(**options).out }

data/mod/core/set/all/states.rb

@@ -84,9 +84,15 @@ end
 
 # has not been edited directly by human users.  bleep blorp.
 def pristine?
-  new_card? ||
-    (created_at == updated_at && creator_id == WagnBotID) ||
+  if new_card?
+    true
+  elsif subcards? && subcards.cards.find(&:altered?)
+    false
+  elsif (created_at == updated_at) && (creator_id == WagnBotID)
+    true
+  else
     !user_changes?
+  end
 end
 
 def altered?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: card
 version: !ruby/object:Gem::Version
-  version: 1.105.0
+  version: 1.105.1
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cardname
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -731,6 +731,8 @@ files:
 - lib/generators/set/set_generator.rb
 - lib/generators/set/templates/set_spec_template.erb
 - lib/generators/set/templates/set_template.erb
+- mod/core/config/locales/de.yml
+- mod/core/config/locales/en.yml
 - mod/core/data/fixtures/real/card_actions.yml
 - mod/core/data/fixtures/real/card_acts.yml
 - mod/core/data/fixtures/real/card_changes.yml
@@ -746,13 +748,9 @@ files:
 - mod/core/data/test/sample.yml
 - mod/core/data/test/user.yml
 - mod/core/lib/tasks/card.rake
-- mod/core/lib/tasks/card/assets.rake
-- mod/core/lib/tasks/card/create.rake
 - mod/core/lib/tasks/card/migrate.rake
 - mod/core/lib/tasks/card/mod.rake
 - mod/core/lib/tasks/card/seed.rake
-- mod/core/locales/de.yml
-- mod/core/locales/en.yml
 - mod/core/set/all/admin.rb
 - mod/core/set/all/assign_attributes.rb
 - mod/core/set/all/autoname.rb

data/mod/core/lib/tasks/card/assets.rake

@@ -1,17 +0,0 @@
-namespace :card do
-  namespace :assets do
-    task refresh: :environment do
-      Card::Assets.refresh force: true
-    end
-
-    task code: :environment do
-      Cardio.config.compress_assets = true
-      Card::Cache.reset_all
-      Card::Assets.make_output_coded
-    end
-
-    task wipe: :environment do
-      Card::Assets.wipe
-    end
-  end
-end