Metaprograming Ruby -- C10 Active Support’s Concern Module

Summary

  1. ruby can include instance methods and extend class methods, but can't do those two things together.
    Rails just want do though this together(powerful language with powerful framework ...).
  2. at first, rails use included hook,
    when a class includes the instance methods, it extend class methods by the includes hook
    so rails do those two things together.
  3. but when a module includes a module, problem happens.
    the second level module extended the first level module,
    yeah, the first level's ClassMethod's methods have became the second level's class method.
    but, the second level module's ClassMethods' methods do not have the first level's ClassMethods' methods,
    so when include the second level module in a class, the class can not get the first level's ClassMethods' methods. Because the first level module's class methods do not in the second level module's ClassMethods module
  4. rails solve this by overwriting the apppend_features
    it flatten all nest included modules with right order.
    and let the class include all those included module in the right order.

put include and extend together

includes and extend

included is a hook, when a class includes a module, this hook will be called
def self.included(base)
base.extend ClassMethods # ...
end

nested include

 Problem happens when BaseClass includes the FirstLevelModule, so the please read the comment in it and then read comment in FirstLevelModule's `included`
  module SecondLevelModule
    def self.included(base)
      base.extend ClassMethods
    end

    def second_level_instance_method; 'ok'; end

    module ClassMethods
      def second_level_class_method; 'ok'; end
    end
  end

  module FirstLevelModule
    def self.included(base)
      # called because the BaseClass me(`FirstLevelModule`)
      # I let the BaseClass extend all the methods in my ClassMethods module
      # but wait a minute, I include the SecondLevelModule,
      # and I have second_level_class_method as my class method
      # but it is not in my ClassMethods module,
      # so the BassClass dose not have second_level_class_method as its class method :(
      # include trick broken ...
      base.extend ClassMethods
    end

    def first_level_instance_method; 'ok'; end

    module ClassMethods
      def first_level_class_method; 'ok'; end
    end

    include SecondLevelModule
  end

  class BaseClass
    # the FirstLevelModule's included hook will be called
    include FirstLevelModule
  end

append_features - solving module includes module problem

the append_features is overwrote by rails

goal: never include a concern in another concern,
so just let the includer(class or module) 'includes' all concerns in the right order.

it has two part

  1. a concern includes a concern,
    checked by base.instance_variable_defined?("@_dependencies")
    it add the included concern as a dependent and add it to its @_dependencies

  2. a module includes a concern
    def append_features(base)
    # recursive
    # no need include and extend
    return false if base < self
    @_dependencies.each { |dep| base.send(:include, dep) }

        # to include class method by call original append_features
        super
        # extend class methods
        base.extend const_get("ClassMethods") if const_defined?("ClassMethods")
        base.class_eval(&@_included_block) if instance_variable_defined?("@_included_block")
      end
    
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容