Module: CharacterSet::SharedMethods

Included in:
CharacterSet, Pure
Defined in:
lib/character_set/shared_methods.rb

Class Method Summary collapse

Class Method Details

.included(klass) ⇒ Object



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/character_set/shared_methods.rb', line 9

def self.included(klass)
  klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
    LoadError = Class.new(::LoadError)

    class << self
      def [](*args)
        new(Array(args))
      end

      def parse(string)
        codepoints = Parser.codepoints_from_bracket_expression(string)
        result = new(codepoints)
        string.start_with?('[^') ? result.inversion : result
      end

      def of_property(property_name)
        require_optional_dependency('regexp_property_values')

        property = RegexpPropertyValues[property_name.to_s]
        from_ranges(*property.matched_ranges)
      end

      def of_regexp(regexp)
        require_optional_dependency('regexp_parser')

        root = ::Regexp::Parser.parse(regexp)
        of_expression(root)
      end

      def of_expression(expression)
        ExpressionConverter.convert(expression)
      end

      def require_optional_dependency(name)
        required_optional_dependencies[name] ||= begin
          require name
          true
        rescue ::LoadError
          entry_point = caller_locations.reverse.find do |loc|
            loc.absolute_path.to_s.include?('/lib/character_set')
          end
          method = entry_point && entry_point.label
          raise LoadError, 'You must the install the optional dependency '\
                           "'\#{name}' to use the method `\#{method}'."
        end
      end

      def required_optional_dependencies
        @required_optional_dependencies ||= {}
      end
    end # class << self

    def initialize(enumerable = [])
      merge(Parser.codepoints_from_enumerable(enumerable))
    end

    def replace(enum)
      unless [Array, CharacterSet, Range].include?(enum.class)
        enum = self.class.new(enum)
      end
      clear
      merge(enum)
    end

    # stringification methods

    def to_s(opts = {}, &block)
      Writer.write(ranges, opts, &block)
    end

    def to_s_with_surrogate_alternation
      Writer.write_surrogate_alternation(bmp_part.ranges, astral_part.ranges)
    end

    def inspect
      len = length
      "#<CharacterSet: {\#{first(5) * ', '}\#{'...' if len > 5}} (size: \#{len})>"
    end

    # unicode-plane-related methods

    def bmp_part?
      !bmp_part.empty?
    end

    def astral_part?
      !astral_part.empty?
    end

    def bmp_ratio
      bmp_part.count / count.to_f
    end

    def astral_ratio
      astral_part.count / count.to_f
    end

    #
    # The following methods are here for `Set` compatibility, but they are
    # comparatively slow. Prefer others.
    #
    def map!
      block_given? or return enum_for(__method__) { size }
      arr = []
      each { |cp| arr << yield(cp) }
      replace(arr)
    end
    alias collect! map!

    def reject!(&block)
      block_given? or return enum_for(__method__) { size }
      old_size = size
      delete_if(&block)
      self if size != old_size
    end

    def select!(&block)
      block_given? or return enum_for(__method__) { size }
      old_size = size
      keep_if(&block)
      self if size != old_size
    end
    alias filter! select!

    def classify
      block_given? or return enum_for(__method__) { size }
      each_with_object({}) { |cp, h| (h[yield(cp)] ||= self.class.new).add(cp) }
    end

    def divide(&func)
      block_given? or return enum_for(__method__) { size }
      require 'set'

      if func.arity == 2
        require 'tsort'

        class << dig = {}
          include TSort

          alias tsort_each_node each_key
          def tsort_each_child(node, &block)
            fetch(node).each(&block)
          end
        end

        each do |u|
          dig[u] = a = []
          each{ |v| a << v if yield(u, v) }
        end

        set = Set.new
        dig.each_strongly_connected_component do |css|
          set.add(self.class.new(css))
        end
        set
      else
        Set.new(classify(&func).values)
      end
    end

    # C-extension adapter method. Needs overriding in pure fallback.
    # Parsing kwargs in C is slower, verbose, and kinda deprecated.
    def inversion(include_surrogates: false, upto: 0x10FFFF)
      ext_inversion(include_surrogates, upto)
    end
  RUBY
end