card 1.19.4 → 1.19.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2438311a0c0d3270f1d65eb41fbe38914740135f
-  data.tar.gz: 75fa9bdbf0fd463f171b47875624bb96025b50c9
+  metadata.gz: 4de6e0031d77758dbc7c4ca11a084e2e24cd13ae
+  data.tar.gz: e33dd67fb7b2c868d12d4db50e574c0bc6cfb69b
 SHA512:
-  metadata.gz: bec0abeaa624791be2ba54a2709fd6c3d75f39b07c53f758e7464c75ede3573eb84c16c048be5f3843141f9e4d715d5744004f3009c6a935c370d405fd4f02fe
-  data.tar.gz: 49c9dcec44ea2e97f112e14c8e5f7c1b7281fb07445172c2b7b3eda79cba2ea67116dc1a32b133039387050674b4c6cf8b96087f700066126fafe3e8b36ac8bd
+  metadata.gz: eeaafba60cf7defa62e9d63756bcfb184cc84705191fef1503e44d4e60bd4229a1f727f6b7eaa618720781fb62e6899f6676e6bfae6452da7d0a5d00800a026f
+  data.tar.gz: 023ddaf342ae2eed8174132b2a438b7b663809195806e85fd24c3535cd26f0d36352b01e8bfe7c4598f0c0659034c4f2cab77b238048142be3dd724b29193d9a

data/VERSION

@@ -1 +1 @@
-1.19.4
+1.19.5

data/config/initializers/01_core_extensions/module.rb

@@ -7,6 +7,10 @@ module CoreExtensions
       const_get(*args) if const_defined?(*args)
     end
 
+    def const_remove_if_defined const
+      remove_const const if const_defined? const
+    end
+
     def const_get_or_set const
       const_get_if_defined(const) || const_set(const, yield)
     end

data/lib/card.rb

@@ -8,7 +8,7 @@ require "carrierwave"
 #   end
 # end
 
-Object.send :remove_const, :Card if Object.send(:const_defined?, :Card)
+Object.const_remove_if_defined :Card
 
 # Cards are wiki-inspired building blocks.
 #
@@ -69,7 +69,7 @@ class Card < ActiveRecord::Base
   attr_accessor :follower_stash
 
   define_callbacks(
-    :select_action, :show_page, :handle, :act,
+    :select_action, :show_page, :act,
 
     # VALIDATION PHASE
     :initialize_stage, :prepare_to_validate_stage, :validate_stage,

data/lib/card/content/diff/lcs.rb

@@ -3,7 +3,7 @@ require_dependency "card/content/diff/processor"
 class Card
   class Content
     class Diff
-      # Use LCS algorithm to create a Diff::Result
+      # Use LCS algorithm to create a {Diff::Result}
       class LCS
         def initialize opts
           # regex; remove matches completely from diff

data/lib/card/model/save_helper.rb

@@ -1,48 +1,113 @@
 class Card
   module Model
+    # API to create and update cards.
+    # It is intended as a helper for "external" scripts
+    # (seeding, testing, migrating, etc) and not for internal application code.
+    # The general pattern is:
+    # All methods use the ActiveRecord !-methods that throw exceptions if
+    # somethings fails.
+    # All !-methods in this module rename existing cards
+    # to resolve name conflicts)
     module SaveHelper
-      def create_card args
+      def create_card name_or_args, content_or_args=nil
+        args = standardize_args name_or_args, content_or_args
         resolve_name_conflict args
         Card.create! args
       end
 
+      def update_card name, content_or_args
+        args = standardize_update_args content_or_args
+        resolve_name_conflict args
+        Card[name].update_attributes! args
+      end
+
+      def create_or_update_card name_or_args, content_or_args=nil
+        args = standardize_args name_or_args, content_or_args
+        if Card[args[:name]]
+          update_card(args.delete(:name), args)
+        else
+          create_card(args)
+        end
+      end
+
+      def delete_card name
+        return unless (card = Card[name])
+        card.delete!
+      end
+
+      def delete_code_card name
+        update name, codename: nil
+        delete name
+      end
+
+      # create if card doesn't exist
+      # updates existing card only if given attributes are different except the
+      # name
+      # For example if a card with name "under_score" exists
+      # then `ensure_card "Under Score"` doesn't change anything
+      def ensure_card name_or_args, content_or_args=nil
+        args = standardize_args name_or_args, content_or_args
+        name = args.delete(:name)
+        if (card = Card[name])
+          ensure_attributes card, args
+        else
+          Card.create! args.merge(name: name)
+        end
+      end
+
+      # create if card doesn't exist
+      # updates existing card only if given attributes are different including
+      # the name
+      # For example if a card with name "under_score" exists
+      # then `ensure_card "Under Score"` renames it to "Under Score"
+      def ensure_card! name_or_args, content_or_args=nil
+        args = standardize_args name_or_args, content_or_args
+        if (card = Card[args[:name]])
+          ensure_attributes card, args
+        else
+          Card.create! args
+        end
+      end
+
       # if card with same name exists move it out of the way
-      def create_card! args
+      def create_card! name_or_args, content_or_args=nil
+        args = standardize_args name_or_args, content_or_args
         create_card args.reverse_merge(rename_if_conflict: :old)
       end
 
-      def update_card name, args
-        resolve_name_conflict args
-        Card[name].update_attributes! args
+      def update_card! name, content_or_args
+        args = standardize_update_args content_or_args
+        update_card name, args.reverse_merge(rename_if_conflict: :new)
       end
 
-      def update_card! args
-        update_card args.reverse_merge(rename_if_conflict: :new)
+      def create_or_update_card! name_or_args, content_or_args=nil
+        args = standardize_args name_or_args, content_or_args
+        create_or_update args.reverse_merge(rename_if_conflict: :new)
       end
 
-      def create_or_update name_or_args, args={}
+      # @return args
+      def standardize_args name_or_args, content_or_args
         if name_or_args.is_a?(Hash)
-          name = name_or_args.delete :name
-          args = name_or_args
+          name_or_args
         else
-          name = name_or_args
+          add_name name_or_args, content_or_args
         end
-        if Card[name]
-          update_card name, args
+      end
+
+      def standardize_update_args content_or_args
+        if content_or_args.is_a?(String)
+          { content: content_or_args }
         else
-          create_card args.merge(name: name)
+          content_or_args
         end
       end
 
-      def create_or_update! name_or_args, args=nil
-        if name_or_args.is_a?(Hash)
-          name = name_or_args.delete(:name)
-          args = name_or_args
+      def add_name name, content_or_args
+        if content_or_args.is_a?(String)
+          { content: content_or_args, name: name }
         else
-          name = name_or_args
-          args ||= {}
+          content_or_args.merge name: name
         end
-        create_or_update name, args.reverse_merge(rename_if_conflict: :new)
       end
 
       def resolve_name_conflict args
@@ -51,11 +116,21 @@ class Card
         args[:name] = Card.uniquify_name args[:name], rename
       end
 
-      # create if it doesn't exist
-      def ensure_card args
-        return if Card[args[:name]]
-        Card.create! args
+      def ensure_attributes card, args
+        update_args = args.select { |key, value| card.send(key) != value }
+        return if update_args.empty?
+        card.update_attributes! update_args
       end
+
+      alias_method :create, :create_card
+      alias_method :update, :update_card
+      alias_method :create_or_update, :create_or_update_card
+      alias_method :create!, :create_card!
+      alias_method :update!, :update_card!
+      alias_method :create_or_update!, :create_or_update_card!
+      alias_method :ensure, :ensure_card
+      alias_method :ensure!, :ensure_card!
+      alias_method :delete, :delete_card
     end
   end
 end

data/lib/card/name.rb

@@ -11,6 +11,14 @@ class Card
     self.session = proc { Card::Auth.current.name }
     self.banned_array = ["/"]
 
+    def self.cardish mark
+      case mark
+      when Card            then mark.cardname
+      when Symbol, Integer then Card.quick_fetch(mark).cardname
+      else                      mark.to_name
+      end
+    end
+
     def star?
       simple? && "*" == s[0, 1]
     end

data/lib/card/set/event.rb

@@ -62,12 +62,10 @@ class Card
 
         if with_delay? opts
           delaying_method = "#{event}_with_delay"
-          define_event_delaying_method event, delaying_method
-          define_event_method event, delaying_method
-          define_active_job event, final_method_name, opts[:queue_as]
-        else
-          define_event_method event, final_method_name
+          define_event_delaying_method event, delaying_method, final_method_name
+          final_method_name = delaying_method
         end
+        define_event_method event, final_method_name
       end
 
       def with_delay? opts
@@ -84,17 +82,6 @@ class Card
         opts[:on] = [:create, :update] if opts[:on] == :save
       end
 
-      def define_event_delaying_method event, method_name
-        class_eval do
-          define_method(method_name, proc do
-            Object.const_get(event.to_s.camelize).perform_later(
-              self, serialize_for_active_job, Card::Env.serialize,
-              Card::Auth.current_id
-            )
-          end)
-        end
-      end
-
       def define_event_method event, call_method
         class_eval do
           define_method event do
@@ -106,38 +93,31 @@ class Card
         end
       end
 
-      # creates an Active Job.
+      # creates an ActiveJob.
       # The scheduled job gets the card object as argument and all serializable
       # attributes of the card.
       # (when the job is executed ActiveJob fetches the card from the database
       # so all attributes get lost)
-      # @param name [String] the name for the ActiveJob child class
-      # @param final_method [String] the name of the card instance method to be
-      # queued
-      # @option queue [Symbol] (:default) the name of the queue
-      def define_active_job name, final_method, queue=:integrate_with_delay
-        class_name = name.to_s.camelize
-        define_active_job_class class_name, queue || :integrate_with_delay
-        define_active_job_perform_method class_name, final_method
-      end
-
-      def define_active_job_class class_name, queue
-        eval %(
-          class ::#{class_name} < ActiveJob::Base
-            queue_as :#{queue}
-          end
-        )
+      # @param event [String] the event used as queue name
+      # @param method_name [String] the name of the method we define to trigger
+      #   the actjve job
+      # @param final_method_name [String] the name of the method that get called
+      #   by the active job and finally executes the event
+      def define_event_delaying_method event, method_name, final_method_name
+        class_eval do
+          define_method(method_name, proc do
+            IntegrateWithDelayJob.set(queue: event).perform_later(
+              self, serialize_for_active_job, Card::Env.serialize,
+              Card::Auth.current_id, final_method_name
+            )
+          end)
+        end
       end
 
-      def define_active_job_perform_method class_name, method_name
-        Object.const_get(class_name).class_eval do
-          define_method(
-            :perform,
-            proc do |card, card_attribs, env, current_id|
-              card.deserialize_for_active_job! card_attribs, env, current_id
-              card.send method_name
-            end
-          )
+      class IntegrateWithDelayJob < ActiveJob::Base
+        def perform card, card_attribs, env, current_id, method_name
+          card.deserialize_for_active_job! card_attribs, env, current_id
+          card.send method_name
         end
       end
 

data/lib/card/set/format.rb

@@ -21,6 +21,7 @@ class Card
     #
     module Format
       def format *format_names, &block
+        format_names.compact!
         if format_names.empty?
           format_names = [:base]
         elsif format_names.first == :all

data/lib/card/set/inheritance.rb

@@ -4,12 +4,37 @@ class Card
     module Inheritance
       # include a set module and all its format modules
       # @param [Module] set
-      # @param [Hash] opts choose the formats you want to include
+      # @param [Hash] opts choose the formats you want to include. You can also
+      #    pass arbitrary options to the included set. The option is saved
+      #    in the including set. To use the option you need a `included` method
+      #    in the included set to fetch the option.
       # @option opts [Symbol, Array<Symbol>] :only include only these formats
       # @option opts [Symbol, Array<Symbol>] :except don't include these formats
-      # #@example
-      # include_set Type::Basic, except: :css
+      # @example
+      #   include_set Type::Basic, except: :css
+      # @example pass an option
+      #   include_set Type::Name, default_name: "Luke"
+      #   default_name           # => "Luke"
+      #
+      #   def introduce_yourself
+      #     puts my_name_is      # => "Luke"
+      #   end
+      #
+      #   # in Type::Name
+      #   def self.included host_class
+      #     host_class.class_eval do
+      #       define_method :my_name_is do |name=nil|
+      #         name || host_class.default_name
+      #       end
+      #     end
+      #   end
+      #
       def include_set set, opts={}
+        opts.each do |key, value|
+          cattr_accessor key
+          send "#{key}=", value
+        end
+
         set_type = set.abstract_set? ? :abstract : :nonbase
         add_set_modules Card::Set.modules[set_type][set.shortname]
         include_set_formats set, opts
@@ -20,8 +45,8 @@ class Card
       # @param [Hash] opts choose the formats you want to include
       # @option opts [Symbol, Array<Symbol>] :only include only these formats
       # @option opts [Symbol, Array<Symbol>] :except don't include these formats
-      # #@example
-      # include_set Type::Basic, except: :css
+      # @example
+      #   include_set_formats Type::Basic, except: :css
       def include_set_formats set, opts={}
         each_format set do |format, format_mods|
           format_sym = Card::Format.format_sym format

data/lib/card/set/loader.rb

@@ -52,15 +52,36 @@ class Card
       end
 
       def tmp_file_template pattern, modules, content_path
+        content = File.read(content_path)
+        wrapped_content = tmp_file_wrapped_content content_path, content
+
+        # TODO: load directly without tmp file
+        return wrapped_content if content =~ /\A#!\s?simple load/
+
         submodules = modules.map { |m| "module #{m};" }
+        if content =~ /\A#!\s?not? set module/
+          submodules.pop
+        else
+          submodules[-1] += " extend Card::Set"
+        end
+        tmp_file_frame pattern, submodules, wrapped_content
+      end
+
+      def tmp_file_frame pattern, submodules, content
 <<-RUBY
 # -*- encoding : utf-8 -*-
-class Card; module Set; class #{pattern}; #{submodules * ' '} extend Card::Set
+class Card; module Set; class #{pattern}; #{submodules.join ' '}
+#{content}
+end;end;end;#{'end;' * submodules.size}
+RUBY
+      end
+
+      def tmp_file_wrapped_content content_path, content
+<<-RUBY
 # ~~ above autogenerated; below pulled from #{content_path} ~~
-#{File.read content_path}
+#{content}
 
 # ~~ below autogenerated; above pulled from #{content_path} ~~
-end;end;end;#{'end;' * submodules.size}
 RUBY
       end
 

data/mod/account/set/self/account_links.rb

@@ -11,36 +11,60 @@ format :html do
   end
 
   view :sign_up, perms: ->(r) { r.show_signup_link? },
-                 denial: :blank do |_args|
-    # 'Sign up'
-    link_to(I18n.t(:sign_up, scope: "mod.standard.set.self.account_links"),
-            card_path("account/signup"), id: "signup-link")
+                 denial: :blank do |args|
+    link_to_card :signup, args[:link_text], args[:link_opts]
   end
 
   view :sign_in, perms: ->(_r) { !Auth.signed_in? },
-                 denial: :blank do |_args|
-    # 'Sign in'
-    link_to(I18n.t(:sign_in, scope: "mod.standard.set.self.account_links"),
-            card_path(":signin"), id: "signin-link")
+                 denial: :blank do |args|
+    link_to_card :signin, args[:link_text], args[:link_opts]
   end
 
-  view :invite, perms: ->(r) { r.show_invite_link? },
-                denial: :blank do |_args|
-    # 'Invite'
-    link_to(I18n.t(:invite, scope: "mod.standard.set.self.account_links"),
-            card_path("account/signup"), id: "invite-a-friend-link")
+  view :sign_out, perms: ->(_r) { Auth.signed_in? },
+                  denial: :blank do |args|
+    link_to_card :signin, args[:link_text], args[:link_opts]
   end
 
-  view :sign_out, perms: ->(_r) { Auth.signed_in? },
-                  denial: :blank do |_args|
-    # 'Sign out'
-    link_to(I18n.t(:sign_out, scope: "mod.standard.set.self.account_links"),
-            card_path("delete/:signin"), id: "signout-link")
+  view :invite, perms: ->(r) { r.show_invite_link? },
+                denial: :blank do |args|
+    link_to args[:link_text], args[:link_opts]
   end
 
   view :my_card, perms: ->(_r) { Auth.signed_in? },
                  denial: :blank do |_args|
-    card_link(Auth.current.cardname, id: "my-card-link")
+    link_to_card Auth.current.cardname, nil, id: "my-card-link"
+  end
+
+  def default_sign_up_args args
+    account_link_text :sign_up, args
+    account_link_opts "signup-link", args, action: :new, type: :signup
+  end
+
+  def default_sign_in_args args
+    account_link_text :sign_in, args
+    account_link_opts "signin-link", args
+  end
+
+  def default_invite_args args
+    account_link_text :invite, args
+    account_link_opts "invite-a-friend-link", args, action: :new, type: :signup
+  end
+
+  def default_sign_out_args args
+    account_link_text :sign_out, args
+    account_link_opts "signout-link", args, action: :delete
+  end
+
+  def account_link_text purpose, args
+    args[:link_text] =
+      args.delete(:title) ||
+      I18n.t(purpose, scope: "mod.standard.set.self.account_links")
+  end
+
+  def account_link_opts id, args, path=nil
+    args[:link_opts] ||= {}
+    args[:link_opts][:id] ||= id
+    args[:link_opts][:path] ||= path if path
   end
 
   view :raw do |args|
@@ -48,7 +72,8 @@ format :html do
   end
 
   view :core do |args|
-    content_tag :span, id: "logging" do
+    status_class = Auth.signed_in? ? "logged-in" : "logged-out"
+    content_tag :span, id: "logging", class: status_class do
       render_raw args
     end
   end
@@ -62,4 +87,3 @@ format :html do
       Card.new(type_id: Card.default_accounted_type_id).ok?(:create)
   end
 end
-