card 1.104.2 → 1.105.1

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
@@ -27,14 +47,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 +63,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 +74,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 +91,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,24 @@ 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, podtype: nil, user: nil, verbose: nil, name: nil
         @mod = mod
-        @env = env
+        @pod_type = podtype&.to_sym
+        @name = name
         @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
+                # binding.pry if edible[:type] == :link_list
+                Card.ensure edible
               end
             end
           end
@@ -38,21 +35,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 modname, **args
+        @dirs.add_mod modname, **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,25 +1,35 @@
 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
+        @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
@@ -30,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
@@ -51,8 +50,6 @@ module Cardio
         puts "#{filename} now contains #{hash.size} items".green
       end
 
-      private
-
       def cards
         if @name
           cards_from_name
@@ -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

@@ -1,79 +1,58 @@
 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
-  #
-  # This will create the following directories:
-  #
-  #     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.
-  #
-  # ## 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
-  #
-  # 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
+  #     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 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/
+  # - **{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
+  #
+  # 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
 
-    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 +65,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
 
@@ -104,17 +84,10 @@ module Cardio
     def required_path path
       return path if File.exist? path
 
-      raise Card::Error::NotFound, "mod not found: #{@name}"
-    end
+      raise StandardError, "mod not found: #{@name}"
 
-    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
+      # FIXME: - need non-Card based error class
+      # raise Card::Error::NotFound,
     end
   end
 end